To fully automate the import and updating of the branch data, it is necessary to configure the uploading of data from your database in json format.
Attention!
-
The file should be accessible at the specified URL in the application/JSON format.
-
Data from the feed will be updated once a day. In case of changes in the data about the branch, updates will be sent to the catalogs automatically.
An example file can be viewed at the link https://go.brandwizard.io/company/validate by clicking on the "BrandWizard JSON Schema". More information can be found here.
The import validator is located here. On this page, you can enter the URL and check company data.
More detailed information on the feed fields is presented in the table.
Obligatory fields in the table are marked with (*).
| Field | Field type | Description |
|
brand* |
string |
Brand name in text format |
|
name* |
string |
The minimum number of characters is 2, the maximum number is 50. The name requirements can be viewed here. |
| name_en |
string |
Company name in English. The minimum number of characters is 2, the maximum number is 50. Cyrillic is not allowed. |
|
closed |
logical: true, false |
Information about the closure of the company. We will send information to the catalogs that this company has closed. |
|
temporary_closed
|
logical: true, false |
Information about the temporary closure of the company. We will send information to the catalogs that this company is temporarily out of business. |
|
active |
logical: true, false |
The company is active. |
|
code |
string |
Internal unique code of the branch.Must be permanent for one company. |
|
gallery |
arrays of strings |
Direct link to each image for the gallery. As a cloud for storing photos, you can use the free service https://cloudinary.com/. Format: JPG, JPEG, PNG.Size: from 5 KB to 10 MB. Minimum size: 720 x 720 pixels. Maximum size: 3000 x 3000 pixels. Attention! Only links of the https://static.tildacdn.com/tild3862-3732-4134-b134-313631313637/photo.svg form are accepted. The image format must be specified at the end of the link: jpg, jpeg, png. |
|
socials* |
arrays of strings |
List of links to pages on social networks |
|
address |
Object with branch address |
|
|
country |
string |
Country code ISO 3166 format. Example: PL, AE, GB |
|
region |
string |
The name of the region or state, for instance, Masovian Voivodeship. |
|
city |
string |
The name of the city. For instance, Warsaw, Berlin... |
|
street |
string |
The name of the street with the type: for instance, Independence Avenue, etc. |
|
housenumber |
string |
House number and building. For instance, 78, 3c3, 5k2, etc. The maximum number of characters should not exceed 16. |
|
postalcode |
string |
Postal code |
|
lat |
floating-point number e.g. 123.345 |
Latitude coordinate. |
|
lon |
floating point number e.g. 123.345 |
Longitude coordinate A dot is used as the separator of the integer and fractional parts. The coordinates must be accurate. |
|
address_language
|
string |
The address language is specified in two-letter format, currently supported: English: en, Russian: ru, Spanish: es, Lithuanian: lt, Polish: pl, Ukrainian: uk. By default, Russian: ru is used. This is used to search for fakes and duplicates, as well as to transfer data to Yandex. |
|
description |
string |
Additional information on the location, for example, 2nd floor |
|
details |
Company description |
|
|
working_hours |
Working hours. An object consisting of the ordinal numbers of the days of the week as a key and the working hours. For instance, if you need to specify a break in work on Monday: 1: ["08:00 -13:00, "14:00-18:00" Attention! So that the work time does not overlap with the work schedule of the next day. For instance, the location works according to the following schedule: Mon-Thu: 08:00-01:00, Fri-Sat: around the clock (in this case, Thursday's work time affects Friday's work time). Correct format: 1: ["00:00-01:00, 08:00-23:59 (or until 00:00)"], 2: ["00:00 -01:00, 08:00-23:59 (or until 00:00)"], 3: ["00:00-01:00, 08:00-23:59 (or until 00:00)"], 4: ["08:00-23:59 (or until 00:00) "], 5: ["00:00-23:59 (or until 00:00)"], 6: ["00:00 -23:59 (or until 00:00)"], Important! Do not specify a null value for the weekend. If there is a day off on some day, then this day is not indicated in the feed. |
|
|
special_schedules
|
array of objects |
Conveying temporary operating hours in Google and Yandex. Dates can not overlap. An array of objects consisting of a start date, end date, an is holiday flag, and time ranges. For instance, [ { "start_date": "2020-01-03" , (mandatory, cannot be less than end_date) "end_date": "2020-01-03", (mandatory, can't be more than start_date) "time_ranges": [["9:00", "18:00"]], (optional, can be empty only if is_holiday takes the false value) "is_holiday": false (optional, cannot take the true value if time_ranges contains values) }, { "start_date": "2020-01-01", (mandatory, cannot be less than end_date) "end_date": "2020-01-01", (mandatory, can't be more than start_date) "time_ranges": [], (optional, can be empty only if is_holiday takes the false value) "is_holiday": true (optional, cannot take the true value if time_ranges contains values) }, { "start_date": "2020-01-05", (mandatory, cannot be less than end_date) "end_date": "2020-01-06", (mandatory, can't be more than start_date) "time_ranges": [["9:00","18:00"], ["18:00", "22:00"]], (optional, can be empty only if is_holiday takes the false value) "is_holiday": false (optional, cannot take the true value if time_ranges contains values) } ] Attention! If the feed for the temporary company operating mode specifies a value of 00:00-24:00, then after uploading to the personal account, it will be displayed as 00:00-23:59. |
|
|
string |
Branch email that customers may use as a contact |
|
website |
string |
Link to the branch’s website. Links with the presence of domains are prohibited: yandex, google.com , facebook.com , 2gis.com , 2gis.ru , 2gis.biz . The maximum number of characters is 1024. |
|
workday_additional_notes |
string |
Additional information on working hours. For instance, every first Monday of the month is a sanitary day |
|
short_description |
string |
Short company description up to 200 symbols, you can't add links |
|
long_description |
string |
Extended company description up to 500 symbols, you can't add links |
|
payment_methods |
an array of integers from 1 to 6 |
List of available payment methods at the branch: 1) Cash 2) Non-cash payment 3) Payment via bank 4) Credit cards 5) Payment via internet 6) Cryptocurrency |
|
phones |
List of branch phone numbers in the form of a list of objects |
|
|
phone* |
string |
Phone number in international format. For example, +48990000000 If the phone number contains an extension number, then it should be specified as follows: +48990000000 ext. 520526 |
|
is_main |
logical: true, false |
The main phone number is a logical field. Accepts true or false. There should be only 1 phone with the value set to true. |
| List of branch categories |
||
|
brandwizard_categories* |
array of integers |
You can view the list of category IDs here. |
|
legal |
The object of information about the legal entity of the branch |
|
|
form |
string |
Form of ownership in text format.
LLC, Ltd, LLP, PLC, Corp. |
|
name |
string |
The legal name of the branch without a form of ownership. The maximum number of characters is 300. For example BRANDWIZARD |
|
year_founded |
number |
Year of the foundation of a legal entity |
|
images |
Object with links to images about branches |
|
|
logo |
Link to the company logo. The image should be square. As a cloud for storing photos, you can use the free service https://cloudinary.com/. minimum resolution: 300 × 300 pixels, maximum resolution: 3000 × 3000 pixels, maximum image size: 10 MB, format: png, jpg, jpeg, gif.
Attention! Only links of the https://static.tildacdn.com/tild3862-3732-4134-b134-313631313637/photo.png form are accepted. The image format must be specified at the end of the link: jpg, jpeg, png, gif. |
|
|
cover |
Link to the cover of the company. As a cloud for storing photos, you can use the free service https://cloudinary.com/. minimum resolution: 1366 × 768 pixels, maximum resolution: 6830 × 3840 pixels, (aspect ratio 16 by 9), maximum image size: 10 MB, format: png, jpg, jpeg. Attention! Only links of the https://static.tildacdn.com/tild3862-3732-4134-b134-313631313637/photo.png form are accepted. The image format must be specified at the end of the link: jpg, jpeg, png. |
|
| Yandex | Object with fields for Yandex | Some data can be redefined for Yandex. The table below describes these fields. |
|
2gis (URBI) |
Object with fields for 2gis (URBI) |
Some data can be redefined for 2gis (URBI). The table below describes these fields. |
|
|
Object with fields for google |
Some data can be redefined for google. The table below describes these fields. |
|
osm
|
Object with fields for osm |
Some data can be redefined for osm. The table below describes these fields. |
|
facebook
|
Object with fields for facebook |
Some data can be redefined for facebook. The table below describes these fields. |
Attention! If points with the same data are transmitted to the same address (for instance, ATMs), different coordinates must be indicated with differences in the sixth digit after the decimal point..
You can specify which fields need to be erased. To do this, specify the name of the fields to be cleared in the clear_fields field. Currently, the following fields are being erased: logo, cover, email, gallery, social_networks. It is also impossible to simultaneously specify a field for cleaning and a non-empty value in the field itself.
| Field | Type | Description |
|
clear_fields
|
array of strings
|
The names of the fields to be cleared are indicated. |
The data that can be redefined for Google, Yandex, 2gis (URBI), OpenStreetMap are listed in the table below.
If not all data has been specified for this catalog, then the value of this field will be taken from the main structure. For instance, if you define only the phones field for Google, and leave details blank, then when updating the company in Google, the website will be taken from the main field (upper table).
|
Field |
Type |
Description |
|
brand |
string |
Brand name in text format |
|
name |
string |
Name of company, branch |
| short_name | string | Short company name in text format. Short names can only be entered for the Yandex catalog. |
| short_name_en | string | Short company name in English. Short names can only be entered in the Yandex catalog section. |
|
details |
Object with fields |
|
|
website |
string |
Link to the branch website |
|
phones |
array of objects |
|
|
phone |
string |
Phone number in international format. For example, +48990000000 |
|
is_main |
logical: true, false |
The main phone number is a logical field. Takes the true or false values |
| gallery |
array of strings |
Direct link to each image for the gallery. For catalogs that do not support the gallery, we ignore it. |
How to upload Yandex category features via a JSON feed?
You can upload Yandex category features via a feed (section Features on the Create Company page in the Personal Account. More details can be found here).
Examples are provided below.
Example 1:
{
"feature_type": "feature-in-units-single",
"name": "business lunch price",
"value": "15",
"unit": "money",
"unit_value": "rub",
"value_from": null,
"value_to": null
}
The corresponding field in the personal account: