'item' Element of 'upload_catalog' Request

The 'item' element of the 'upload_catalog' request consists of the following fields:

'item' element parameters

Name

Required

Type

Description

type

Yes

string

item type

If the type specified in the request does not exist in the catalog, such type will be added to the catalog.

label

Yes

string

item identifier

weight

No

int

item weight used for items sorting during cache loading. Items with greater weight are the first to be loaded in the cache.

default value: 0

fields

Yes

array

array of 'field' elements, each of which contains one of the item fields and its value

linked_items

No

array

array of 'linked_item' elements, each containing an alternative item with which the item defined in the 'item' element can be substituted and the information on such alternative item

images

No

array

array of 'image' elements, each containing a URL of the item image

  • 'field' Element of 'upload_catalog' Request

The ‘field’ element of the 'upload_catalog' request consists of the following fields:

'field' element parameters

Name

Required

Type

Description

label

Yes

string

field identifier

value

Yes

string

field value
  • 'linked_item' Element of 'upload_catalog' Request

The ‘linked item’element of the 'upload_catalog' request consists of the following fields:

'linked item' element parameters

Name

Required

Type

Description

label

Yes

string

unique linked item identifier

display_data

No

string

text comments to the linked item to be displayed in GUI
  • 'image' Element of 'upload_catalog' Request

The ‘image’ element of the 'upload_catalog' request consists of the following fields:

'image' element parameters

Name

Required

Type

Description

image_url

Yes

string

valid URL address of the image associated with the item defined in the 'item' element

Note: if the request contains several items with the same label, data of the last such item is used. If the request contains several fields with the same label, data of the last such field is used. If the request contains several linked items with the same label, data of the last such linked item is used.