Introduction
The Appmiral Vendor Importer allows you to import vendor information from other systems into Appmiral and keep them in sync. This importer expects 1 URL: one for vendors and their descriptions. This URL can be a static .json files hosted online or a public API endpoint.
Every 15 minutes, the importer will perform a request to the URL and sync the contents to the Appmiral database as Vendors. This means that when somerhing is changed in the origin system, it takes a maximum of 15 minutes before those changes are reflected in the Appmiral CMS and the app.
Translatable Fields
Fields that are translatable are always of type string or can optionally be an object containing a string for each language.
- If a translatable field contains a string, it will set that value for the default language only.
- If a translatable field contains an object, it will set each value for the specified languages. In this case the default language should always be present! The key is the short locale of the language!
In the below example, the field name is translatable but is identical in all languages. In that case it is possible to have the name field be a string.
{
"name": "Fresh Pizzas & Pasta"
}
In the next example, the field name is translatable but different in English and Dutch. If English is the default language, then "en" should always be included.
{
"name": {
"en": "Fresh Pizzas & Pasta",
"nl": "Verse Pizza's & Pasta"
}
}
Currently, Appmiral supports the following languages and locales: English (en), Arabic (ar), Czech (cs), Danish (da), Dutch (nl), Finnish (fi), French (fr), Galician (gl), German (de), Greenlandic (kl), Hebrew (he), Italian (it), Norwegian (nb), Polish (pl), Romanian (ro), Spanish (es), Swedish (sv), Thai (th).
Note: To know which language(s) are configured for your application, please see the Appmiral CMS or reach out to us.
Vendors
Vendor Model
| Field | Required | Type | Description |
| id | Yes | string | The ID of the vendor. It has to be unique for each vendor and can never be changed. (Max. 500 characters) |
| name | Yes | string / object | The name of the vendor. Translatable. |
| priority | No | integer | The priority of the vendor. This determines the position of the artist on various screens in the app. Default is 100. |
| description | No | string / object | The description for the vendor. Can contain HTML. Use this to include items sold. Translatable. |
| image | No | string / object | A URL to an image of the vendor. Must be JPG or PNG. Should be at least 1500x1500. Translatable. |
| tags | No | array of strings | A list of tags to link to the vendor. Tags are slugs which should be lowercase and can contain a-z, 0-9 and - |
| website | No | string / object | A URL to the website of the vendor. Translatable. |
| No | string | A URL to the Facebook page of the vendor. | |
| No | string | A URL to the Twitter page of the vendor. | |
| No | string | A URL to the LinkedIn page of the vendor. | |
| No | string | A URL to the Instagram profile of the vendor. | |
| tiktok | No | string | A URL to the TikTok profile of the vendor. |
| youtube | No | string | A URL to the Youtube channel of the vendor. |
Note: if a vendor image gets changed, make sure to adjust the URL as well. If the URL remains the same, the image will not be adjusted in the next import.
Vendors JSON Example
The example below contains an artist without translated fields and an artist with translated fields:
{
"vendors": [
{
"id": "1",
"name": "Fresh Pizzas & Pasta",
"priority": 1,
"description": "<p>Fresh Pizzas & Pasta is a family-run Italian food stand serving hand-tossed pizzas and homemade pasta dishes using organic, locally-sourced ingredients. Known for their Truffle Mushroom Tagliatelle and wood-fired Margherita pizza, they bring authentic Naples flavor to every bite. Vegan and gluten-free options available.</p>",
"image": "https://images.unsplash.com/photo-1600891964599-f61ba0e24092",
"tags": [
{
"slug": "food-italian",
"name": {
"en": "Italian",
"nl": "Italiaans"
},
"color": "#FF5733",
"text_color": "#FFFFFF"
}
],
"website": "https://freshpizzaspasta.com",
"facebook": "https://www.facebook.com/freshpizzaspasta",
"twitter": null,
"linkedin": null,
"instagram": "https://www.instagram.com/freshpizzaspasta",
"tiktok": "https://www.tiktok.com/@freshpizzaspasta",
"youtube": null
},
{
"id": "taco-fuego",
"name": {
"en": "Taco Fuego",
"nl": "Taco Fuego"
},
"priority": 2,
"description": {
"en": "Taco Fuego brings the heat with bold Mexican street food. Their signature Firecracker Tacos, loaded nachos, and house-made salsas make them a crowd favorite at every festival. Don't miss their limited-edition ghost pepper sauce — if you dare.",
"nl": "Taco Fuego serveert vurige Mexicaanse streetfood, bekend om hun Firecracker Tacos, loaded nacho's en huisgemaakte salsa's. Een hit op elk festival! Probeer vooral hun speciale ghost pepper saus (alleen voor waaghalzen)."
},
"image": {
"en": "https://images.unsplash.com/photo-1600891964929-d993d92949a6",
"nl": "https://images.unsplash.com/photo-1600891974837-80f2b5c96e79"
},
"tags": [
"food-mexican",
"food-spicy-level-ma",
"food-vegan-option"
],
"website": {
"en": "https://www.tacofuego.com",
"nl": "https://www.tacofuego.nl"
},
"facebook": "https://www.facebook.com/tacofuego",
"twitter": null,
"linkedin": null,
"instagram": "https://www.instagram.com/tacofuego",
"tiktok": "https://www.tiktok.com/@tacofuego",
"youtube": null
}
]
}