How to update chain information with an XML file

If you have more than 30 branches in your chain, we recommend updating chain information in Yango for Business using XML files.

Data about your branches will be updated based on the information in the XML file. New branches will be added to the database and shown in services with their attributes. Branch cards whose details weren't added to the XML file will be closed.

Step 1. Prepare an XML file

File requirements

  1. The XML file must be UTF-8 encoded.

  2. The standard XML header must start from the first line, from the zero character.

    For example:

    <?xml version="1.0" encoding="UTF-8"?>
    
  3. To describe branches, use a set of mandatory and additional attributes. Each branch property should be wrapped in a separate attribute (see Sample file). If a property has multiple values (for example, phone numbers), pass multiple attributes with the same name.

  4. All data in an XML file must be in the same language. Multilingual attributes are an exception (see Attribute description).

    A multilingual attribute is an attribute in an XML file with values in several languages.

    The language is defined by the lang attribute. For each new language, create an item with the corresponding lang attribute in a separate row.

    Example
    <address lang="en">87-135 Brompton Road, London SW1X 7XL England</address>
    <address lang="es">Paseo del Prado s/n, 28014 Madrid España</address>
    

    You can find the current lang values in the XML schema. To add other languages, contact support.

  5. The data can't contain HTML attributes. The XML standard doesn't allow ASCII characters in the value range from 0 to 31 in text fields. The exceptions are values 9 (tab), 10 (newline), and 13 (carriage return). The XML standard requires using &amp; instead of &.

Attribute description

Attribute

Description

Multilingual element

Required field

companies

Root attribute.

Not applicable

Yes

company

Branch description. Nested in the root attribute. There can be any number of company attributes.

Not applicable

Yes

company-id

Permanent unique ID of the branch (assigned by the chain owner). Can contain any set of numbers and Latin letters.

No

Yes

name

Name of the branch. Specified without quotation marks, case-sensitive.

Yes

Yes

shortname

Short name of the branch to be displayed next to placemarks on Yango Maps, up to 25 characters. Specified without quotation marks, case-sensitive.

Yes

No

name-other

Alternative name of the branch (if there are multiple names, each one is listed in a separate element). Specified without quotation marks, case-sensitive.

Yes

No

address

The branch address (on one line). Multilingual element. If the element contains only the street name and house number, use the locality‑name element specifying the locality.

Yes

Yes

country

Country. Specified in full, without abbreviations.

Yes

No

address-add

Additional address information that doesn't apply to other elements (shopping center/shopping and entertainment complex/shopping and entertainment center, floor, office, premises, boutique, entrance). For example, Roza shopping center, floor 2, office 203. Doesn't include a detailed description of the route to the address (100 meters from the metro station to the north, the blue building to the right of Pushkinsky Public Garden). Don't use brackets or quotation marks.

Yes

No

phone

Compound element. Phone number (if there are several phone numbers, specify each one in a separate element).

No

Yes

Elements nested in phone

number

The landline or mobile phone number. The format is [country code] ([city code]) [phone number].

ext

Extension, without comments, words, or delimiters.

info

Information about the phone number, such as "director" or "reception". This element shouldn't contain information about the phone type.

type

Phone type. Acceptable values:

  • phone: Phone number.
  • fax: Fax number.
  • phone‑fax: Phone/fax number.

email

Email address (if there are multiple addresses, specify each one in a separate element).

No

No

url

The chain's main website. Specified in lowercase, in full, including http:// or https://.

No

Yes

add-url

Additional website of the chain (such as links to social media pages). The URL of the page with branch information on the chain website is specified in the info‑page element.

No

No

info-page

URL of the page with branch information on the chain website. The address must contain the domain name of the chain website. Specified in lowercase, in full, including http:// or https://.

No

No

working-time

Opening hours. Days off and non-working days aren't specified.

Yes

Yes

rubric-id

The ID of the business category this branch belongs to. Branches can have up to three business categories, but at least one of them should match the chain category. If a branch has multiple business categories, specify each one in a separate element.

No

Yes

actualization-date

Date updated. Corresponds to the time of the last update. Used to avoid downloading information received during the previous check. The content can be specified in the following format:

  • DD.MM.YYYY;
  • UNIX-time: specified in milliseconds from 00:00:00.000 01.01.1970.

No

Yes

coordinates

Compound element. Coordinates (latitude and longitude).

No

Yes (if the address is inaccurate)

Elements nested in coordinates

lon

Longitude. Use the dot as as the decimal separator.

lat

Latitude. Use the dot as as the decimal separator.

photos

A link to the gallery or a page on the chain site with all photos. If there are multiple photos, each one is in a separate photo element. It can contain the following attributes:

  • alt: Text description of the photo in free form.
  • type: Photo type. Can take a single value: interior.

No

No

Elements nested in photos

tag

Photo tag. Set inside the photos element. Acceptable values:

  • INTERIOR: Interior.
  • EXTERIOR: Exterior.
  • ENTER: Entrance.
  • LOGO: Logo.
  • FOOD: Food, drinks.
  • GOODS: Goods.
  • MENU: Cafe or restaurant menu.
  • ACCESSIBILITY: Ramps, lifts for people with disabilities, and more.
  • DEVICES: Electronic devices.
  • SERVICES: Services.

feature-boolean

Branch property. If there are multiple properties, each one is specified in a separate element. Acceptable values:

  • 0: No.
  • 1: Yes.

No

No

feature-enum-single

Branch property.

No

No

feature-enum-multiple

Branch property. If there are multiple properties, each one is specified in a separate element.

No

No

feature-numeric-single

A branch property with a numeric value.

No

No

feature-numeric-multiple

A branch property with a numeric value. If there are multiple properties, each one is specified in a separate element.

No

No

feature-in-units-single

A branch property whose value is defined in units.

No

No

feature-in-units-multiple

A branch property whose value is defined in units. If there are multiple properties, each one is specified in a separate element.

No

No

feature-range-single

A branch property that has a range value.

No

No

feature-range-in-units-single

A branch property that has a range value in units.

No

No

feature-range-in-units-multiple

A branch property that has a range value in units. If there are multiple properties, each one is specified in a separate element.

No

No

feature-text-single

A branch property in text format.

No

No

Additional attributes

You can pass additional parameters for your chain or branch in an XML file. For example, you can show if there is parking available near your shopping center or which currency can be withdrawn from your ATM.

To get an XML file with a list of possible attributes for your business category:

  1. On the chain page, go to Branches.
  2. Under Branch management, choose File.
  3. Click Export dataDownload features.

If you have questions about downloading the file with additional parameters, contact us.

Sample file

Note

To open the description of an attribute from a sample file, click any highlighted attribute.

<?xml version="1.0" encoding="UTF-8"?> 
<companies>
  <company>
    <company-id>770704034</company-id>
    <name lang="en">Anchor</name>
    <shortname lang="en">Anchor</shortname>
    <address lang="en">101-A, Baker Street, London</address>
    <country lang="en">United Kingdom</country>
    <address-add lang="en">Rosa Mall, Floor 2, Room 203</address-add>
    <phone>
      <number>020 1234 5678</number>
      <ext>555</ext>
      <info>secretary</info>
      <type>phone</type>
    </phone>
    <phone>
      <type>phone</type>
      <number>034 2202 3303</number>
      <info/>
    </phone>
    <email>info@anchor.com</email>
    <url>http://www.anchor.com</url>
    <add-url>http://www.anchor.com</add-url>
    <info-page>http://www.test.com/anchor</info-page>
    <working-time lang="en">every day, 10:00-21:00</working-time>
    <rubric-id>184106414</rubric-id>
    <rubric-id>184106394</rubric-id>
    <actualization-date>1511724300</actualization-date>
    <photos gallery-url="http://test.com/anchor/gallery">
      <photo url="http://test.com/anchor/11_b.jpg" alt="Hotel restaurant" 
      type="interior"></photo>
      <photo url="http://test.com/anchor/19_b.jpg">
        <tag>EXTERIOR</tag>
      </photo>
      <photo url="http://test.com/anchor/25_b.jpg"></photo>
      <photo url="http://test.com/anchor/26_b.jpg"></photo>
      <photo url="http://test.com/anchor/17_b.jpg"></photo>
      <photo url="http://test.com/anchor/drink1.jpg" alt="A cocktail at the hotel bar">
        <tag>FOOD</tag>
      </photo>
    </photos>
    <feature-boolean name="internet" value="1"/>
    <feature-enum-single name="star" value="five"/>
    <feature-numeric-single name="room_number" value="15"/>
    <feature-enum-multiple name="hotel_type" value="art_hotel"/>
    <feature-numeric-multiple name="license_number" value="004555"/>
    <feature-in-units-single name="minimum_order" unit="money" unit-value="gbp" value="30"/>
    <feature-in-units-multiple name="ats_by_type" unit="apartment_type" unit-value="single" value="200"/>
    <feature-range-single name="number_seats_banquet_hall" from="15" to="20"/>
    <feature-range-in-units-single name="tickets" unit="money" unit-value="gbp" from="10" to="15"/>
    <feature-range-in-units-single name="price_1_min" unit="money" unit-value="gbp" from="7" to="10"/>
    <feature-range-in-units-multiple name="tea" unit="money" unit-value="gbp" from="100" to="300"/>
    <feature-text-single value="Anchor_free_wi-fi" name="ssid"/>
  </company>
  <company>
    <company-id>7707040070</company-id>
    <name lang="en">Anchor Bank</name>
    <shortname lang="en">Anchor Bank</shortname>
    <name-other lang="en">Branch 2</name-other>
    <address lang="en">46 Mathew Street, Liverpool, Merseyside County, United Kingdom</address>
    <phone>
      <ext/><type>phone</type>
      <number>040 9988 7444</number>
      <info/>
    </phone>
    <url>http://www.anchorbank.com/</url>
    <working-time lang="en">weekdays 8:30-18:00, Sat 9:00-14:30</working-time>
    <rubric-id>184106974</rubric-id>
    <actualization-date>23.09.2019</actualization-date>
    <coordinates>
      <lon>48.295532</lon>
      <lat>55.616051</lat>
    </coordinates>
  </company>
</companies>

The file can be checked manually on your computer using the schema (XML Schema Definition).

Step 2. Upload the file to your website

Upload the file to your website using an updatable link. The data should be accessible via HTTP or HTTPS.

Step 3. Add a link to the file in Yango for Business

  1. On the chain page, go to Branches.

  2. Under Branch management, choose File.

  3. Add a link to the file, select the XML type, and click Check. Checking the file may take several hours.

  4. If the file is verified successfully, click Publish. In the window that opens, check the changes in the branches. The map can show up to 50 branches with changes. Click Yes, start the upload. The file data will be moderated and uploaded to the Yango for Business database. If the file is large, the data upload may take several days.

    If errors are found when checking the file, you'll see an error message. Fix the errors and re-submit the file for review.

To view the branch changes uploaded to the Yango for Business database from the file, click Upload history. The button will be available 24 hours after the first upload.

Yango Maps will show new branches and other changes in a few days.

Contact support
  • Data about your branches will always be up-to-date in all Yango services and mobile applications. Your potential customers will be able to easily find the nearest branch using Yango Maps.
  • You can fully automate the transfer of data about branches by configuring exports from ERP (SAP, Axapta), or other systems.
  • You can provide all the information about branches, including photos and additional parameters, in XML files.

Alternative name of the branch (if there are multiple names, each one is listed in a separate element). Specified without quotation marks, case-sensitive.

Root attribute.

Branch description Nested in the root attribute. There can be any number of company attributes.

Permanent unique ID of the branch (assigned by the chain owner). Can contain any set of numbers and Latin letters.

Name of the branch. Specified without quotation marks, case-sensitive.

Short name of the branch to be displayed next to placemarks on Yango Maps, up to 25 characters. Specified without quotation marks, case-sensitive.

The branch address (on one line). Multilingual element. If the element contains only the street name and house number, use the locality‑name element specifying the locality.

Country. Specified in full, without abbreviations.

Additional address information that doesn't apply to other elements (shopping center/shopping and entertainment complex/shopping and entertainment center, floor, office, premises, boutique, entrance). For example, Romashka shopping center, floor 2, office 203. Doesn't include a detailed description of the route to the address (100 meters from the metro station to the north, the blue building to the right of Pushkinsky Public Garden). Don't use brackets or quotation marks.

Compound element. Phone number (if there are several phone numbers, specify each one in a separate element).

The landline or mobile phone number. The format is [country code] ([city code]) [phone number].

Extension, without comments, words, or delimiters.

Information about the phone number, such as "director" or "reception". This element shouldn't contain information about the phone type.

Phone type. Acceptable values:

  • phone: Phone number.
  • fax: Fax number.
  • phone‑fax: Phone/fax number.

Email address (if there are multiple addresses, specify each one in a separate element).

The chain's main website. Specified in lowercase, in full, including http:// or https://.

Additional website of the chain (such as links to social media pages). The URL of the page with branch information on the chain website is specified in the info‑page element.

URL of the page with branch information on the chain website. The address must contain the domain name of the chain website. Specified in lowercase, in full, including http:// or https://.

Opening hours. Days off and non-working days aren't specified.

The ID of the business category this branch belongs to. Branches can have up to three business categories, but at least one of them should match the chain category. If a branch has multiple business categories, specify each one in a separate element.

Date updated. Corresponds to the time of the last update. Used to avoid downloading information received during the previous check. The content can be specified in the following format:

  • DD.MM.YYYY;
  • UNIX-time: specified in milliseconds from 00:00:00.000 01.01.1970.

A link to the gallery or a page on the chain site with all photos. If there are multiple photos, each one is in a separate photo element. It can contain the following attributes:

  • alt: Text description of the photo in free form.
  • type: Photo type. Can take a single value: interior.

Photo tag. Set inside the photos element. Acceptable values:

  • INTERIOR: Interior.
  • EXTERIOR: Exterior.
  • ENTER: Entrance.
  • LOGO: Logo.
  • FOOD: Food, drinks.
  • GOODS: Goods.
  • MENU: Cafe or restaurant menu.
  • ACCESSIBILITY: Ramps, lifts for people with disabilities, and more.
  • DEVICES: Electronic devices.
  • SERVICES: Services.

Branch property. If there are multiple properties, each one is specified in a separate element. Acceptable values:

  • 0: No;
  • 1: Yes.

Branch property.

A branch property with a numeric value.

Branch property. If there are multiple properties, each one is specified in a separate element.

A branch property whose value is defined in units. If there are multiple properties, each one is specified in a separate element.

A branch property whose value is defined in units.

A branch property whose value is defined in units. If there are multiple properties, each one is specified in a separate element.

A branch property that has a range value.

A branch property that has a range value in units.

A branch property that has a range value in units. If there are multiple properties, each one is specified in a separate element.

A branch property in text format.

Compound element. Coordinates (latitude and longitude).

Longitude. Use the dot as as the decimal separator.

Latitude. Use the dot as as the decimal separator.