API Methods
API Call Limit
Every application has a specific API call limit (usually 500 calls per five minute period). The five-minute period begins at the moment of the first call in the series.
The number of calls made in the current series is shown in the HTTP header API-Usage-Limit in the API response (ex: API-Usage-Limit: 1/500).
If the application exceeds the limit, the API will become unavailable until the end of the five-minute period. In such instances, the server will return a 429 response code, and the HTTP header Retry-After will show the number of seconds until access is granted again.
Universal Request Parameters
| Parameter | Mandatory | Default Value | Description |
|---|---|---|---|
apikey |
yes | A parameter needed for authorizing and completing API requests. Provided at setup. |
|
format |
no | "json" |
Response output format. Possible values: “json,” “xml” |
HTTP ETag (Version Control)
The header “Entity Tag” (or “ETag”) is used to assign a hash to page content. If a page has been changed, then the page’s hash will also change. By comparing the client-side hash to the server-side hash we generate, the cache can determine if the page has been changed and needs to be renewed. This is used with the following methods: product, categories, brands.
When a request is made, the server returns the resource with the corresponding ETag value, which is found in the HTTP header in the ETag field:
ETag: "686897696a7c876b7e"
Then, the resource and its ETag can be cached. Later, when retrieving the same page, a previously saved ETag value can be sent in the If-None-Match field, along with the request.
If-None-Match: "686897696a7c876b7e"
With this request, the server compares the client’s ETag with the ETag of the current version of the resource. If the ETag values match, this means the resources has not been modified, and the server returns a very short response with the HTTP status 304 Not Modified. Status 304 signifies that the cache version is still up-to-date and it is not necessary to refresh the data.
However, if the ETag values do not match, that means the resource has been changed, and the server will return a full response. In this case, the resource’s cache and its ETag can be refreshed.
Calls made using ETag that receive a 304 Not Modified status in the response do not count towards the API limit.
An ETag value length depends on quantity of products in response to product API call. 4Kb is a maximum value.
Sample header with an ETag value:
Content-type: application/json; charset=utf-8
API-Usage-Limit: 1/500
Etag: "38fho43p543re634c993ec28581d867"
Status Code: 200
Sample response with a 304 status:
Content-type: application/json; charset=utf-8
Status Code: 304
Request for missing goods
When using the product method with gtin, supplier_id, party_id (optional product_name, cat_id) parameters, if the product is not in the database (404 api answer), the product will be searched from the vendor and digitized according to the rules.
https://api.contentbank.eu/v3/product?apikey=XXX>in=6114300162475&supplier_id&party_id=7&product_name=Cake with apple jam&cat_id=3423
Response Codes
200— Ok304— The page has not been changed400— Error in request parameters401— Authorization fails or apikey is missing in request403— Access denied404— Requested information not found423— Reached limit download content of goods429— API call limit has been exceeded. The HTTP header Retry-After will show the number of seconds until access is granted again500— Internal Server Error501— Method does not exist503— Service unavailable because of maintenance. Try again later
The Attributes Method
A list of both public and private attributes is returned for the account sending the request.
Sample Request
https://api.contentbank.eu/v3/attributes?apikey=XXX&cat_id=2&attr_type=m
Request Parameters
- cat_id — (optional, mandatory if attr_type are specified) identifier of the category the to which the attributes belong. If not specified, a complete list of available attributes is returned for the account sending the request.
- attr_type — (optional) possible parameter values:
- a — (default) return all attributes
- m — return only mandatory attributes
- r — return only recommended attributes
- o — return only optional attributes
Response Parameters
- attr_id - attribute identifier
- attr_name - attribute name
- attr_group_name - name of the group the attribute is in
- attr_group_id - identifier of the group the attribute is in
- attr_value_types - set of possible values of types an attribute
- attr_preset - set of possible values of an attribute
- attr_type - attribute type; will be indicated only if cat_id is specified in the request
JSON
Content-type: application/json; charset=utf-8
API-Usage-Limit: 1/500
Status Code: 200
{
"apiversion": 3,
"result": [
{
"attr_id": 1,
"attr_name": "Gum content",
"attr_group_name": "Other",
"attr_group_id": 26
},
{
"attr_id": 42,
"attr_name": "Flavor",
"attr_group_name": "Basic qualities",
"attr_group_id": 11,
"attr_value_types": [ "Fruit", "Vegetables"],
"attr_preset": [ "Apricot", "Raspberry", "Apple" ],
"attr_type": "m"
}
...
]
}
XML
Content-type: application/xml; charset=utf-8
API-Usage-Limit: 1/500
Status Code: 200
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiversion>3</apiversion>
<result>
<item>
<attr_id>1</attr_id>
<attr_name>Gum content</attr_name>
<attr_group_name>Other</attr_group_name>
<attr_group_id>26</attr_group_id>
<attr_value_types/>
<attr_preset/>
</item>
<item>
<attr_id>42</attr_id>
<attr_name>Flavor</attr_name>
<attr_group_name>ОBasic qualities</attr_group_name>
<attr_group_id>11</attr_group_id>
<attr_value_types>
<value>Fruit</value>
<value>Vegetables</value>
</attr_value_types>
<attr_preset>
<value>Apricot</value>
<value>Raspberry</value>
<value>Apple</value>
</attr_preset>
<attr_type>m</attr_type>
</item>
</result>
</root>
The Brands Method
This method is used to get a list of brand names.
Sample Request
https://api.contentbank.eu/v3/brands?apikey=XXX
Request Parameters
- party_id — merchant identifier (optional)
Response Parameters
- party_brand_id — brand identifier for merchant (only for the merchant owner, if party_id is specified in the request)
- brand_id - brand identifier
- brand_name - brand name
JSON
Content-type: application/json; charset=utf-8
API-Usage-Limit: 1/500
Etag: "38fho43p543re634c993ec28581d867"
Status Code: 200
{
"apiversion": 3,
"result": [
{
"brand_id": 8117,
"brand_name": "Bic"
},
{
"brand_id": 6262,
"brand_name": "Nike"
},
{
"party_brand_id": "12345",
"brand_id": 7105,
"brand_name": "Roshen"
},
{
"brand_id": 6035,
"brand_name": "1000 Secrets"
}...
]
}
XML
Content-type: application/xml; charset=utf-8
API-Usage-Limit: 1/500
Etag: "38fho43p543re634c993ec28581d867"
Status Code: 200
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiversion>3</apiversion>
<result>
<item>
<brand_id>8117</brand_id>
<brand_name>Bic</brand_name>
</item>
<item>
<brand_id>6262</brand_id>
<brand_name>Nike</brand_name>
</item>
<item>
<party_brand_id>12345</party_brand_id>
<brand_id>7105</brand_id>
<brand_name>Roshen</brand_name>
</item>
<item>
<brand_id>6035</brand_id>
<brand_name>1000 Secrets</brand_name>
</item>
...
</result>
</root>
The Categories Method
This method is used to receive a Listex category tree.
Sample Request
https://api.contentbank.eu/v3/categories?apikey=XXX
Request Parameters
None.
Response Parameters
- cat_id - category identifier
- cat_name - category name
- cat_parent_id - parent category identifier
- cat_level - level in the category tree (1 is the highest level, 2 is next, and so on)
JSON
Content-type: application/json; charset=utf-8
API-Usage-Limit: 1/500
Etag: "38fho43p543re634c993ec28581d867"
Status Code: 200
{
"apiversion": 3,
"result": [
{
"cat_id": 14001,
"cat_name": "Food",
"cat_parent_id": 14000,
"cat_level": "1"
},
{
"cat_id": 14002,
"cat_name": "Drinks",
"cat_parent_id": 14001,
"cat_level": 2
}
...
]
}
XML
Content-type: application/xml; charset=utf-8
API-Usage-Limit: 1/500
Etag: "38fho43p543re634c993ec28581d867"
Status Code: 200
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiversion>3</apiversion>
<result>
<item>
<cat_id>14002</cat_id>
<cat_name>Drinks</cat_name>
<cat_parent_id>14000</cat_parent_id>
<cat_level>2</cat_level>
</item>
<item>
<cat_id>14001</cat_id>
<cat_name>Food</cat_name>
<cat_parent_id>14000</cat_parent_id>
<cat_level>2</cat_level>
</item>
</result>
</root>
The Product Method
This method returns a summary or full details about a product. When using this method, one of the following parameters must be specified: good_id, GTIN, LTIN, or SKU, specifying the merchant ID referring to the account in question.
If more than one of the these parameters is specified, then a sample result will be returned, according to the given algorithm:
- good_id - when specified, the product with the corresponding ID is returned, or a 404 error. In this case, GTIN, LTIN and SKU are ignored.
- gtin - when specified, the product with the corresponding GTIN is returned, or a 404 error. In this case, LTIN and SKU are ignored.
- ltin - when specified, the product with the corresponding LTIN is returned, or a 404 error. In this case, SKU is ignored.
- sku - when specified, the product with the corresponding SKU is returned, or a 404 error.
- supplier_id — vendor identifier (optional, used when requesting a product search: identification number or registration number or tax number)
- product_name — the name of the product (optional, used when searching for a missing item)
- cat_id — category identifier (optional, used when searching for a missing item)
Sample Request
https://api.contentbank.eu/v3/product?apikey=XXX>in=6411300162475
Request Parameters
- good_id — product identifier in the Listex catalogue (mandatory if there is no gtin, ltin, or sku)
- gtin — universal product code, Global Trade Item Number (GTIN) (mandatory if there is no good_id, ltin, or sku)
- ltin — local product code, Local Trade Item Number (LTIN) (for example, *) (mandatory if there is no good_id, gtin, or sku)
- sku — local identifier of a product (Stock Keeping Unit) (mandatory if there is no good_id, gtin, ltin)
- party_id — merchant identifier (mandatory if ltin and sku are specified)
Response Parameters
- identified_by — set containing information about product codes (only the LTIN/SKU codes belonging to the party whose apikey is used will be returned)
- value — product code or local identifier
- type — type of barcode
- gtin — Global Trade Item Number (GTIN)
- ltin — Local Trade Item Number (LTIN), for ex.: price embedded barcode
- sku — Local identifier of a product (Stock Keeping Unit)
- barcode — Item Number Barcode (with wrong control digit)
- party_id — merchant identifier; returned only when “type” parameter has the value “ltin”, “sku” or "barcode"
- multiplier — number of items in a package; default value: 1
- level — package level
- trade-unit
- box
- layer
- pallet
- metro-unit
- show-pack
- multi-pack
- good_id — product identifier
- good_name — product name
- good_img — product image
- categories — set of categories
- cat_id — identifier of the category the product belongs to
- cat_name — name of the category the product belongs to
- party_cat_id — identifier of the category from merchant (only for the merchant owner, if party_id is specified in the request)
- party_cat_name — name of the category from merchant (only for the merchant owner, if party_id is specified in the request)
- party_brand_id — brand identifier for merchant (only for the merchant owner, if party_id is specified in the request)
- brand_id — brand identifier
- brand_name — brand name
- brand_name_transliterations — array of brand name transliterations (optional)
- ua — ukrainian transliteration (optional)
- ru — russian transliteration (optional)
- en — english transliteration (optional)
- de — german transliteration (optional)
- good_rating — product rating
- good_avg_price — average price
- good_avg_price_currency — currency type (compliant with ISO 4217)
- good_images — set of images of the product
- photo_type — image type
- default — default image (front view)
- facing-front, facing-left, facing-right, facing-back, facing-top, facing-bottom, facing-show-box-front, facing-show-box-left, facing-show-box-right, facing-show-box-back, facing-show-box-top, facing-show-box-bottom — cropped image for planograms (cropped along the product’s outline)
- left — picture of the product from the left
- right — picture of the product from the right
- back — picture of the product from the back
- 3ds — series of 3D images
- marketing — commercial photography of product
- ecommerce — e-commerce photo
- undef — single shot; picture of the product from an undefined angle
- cubi — (optional) VGH photo
- photo_date — image create date in UTC
- photo_url — URL of medium-sized image
- barcode — (optional) barcode or article for the product from which the photo is taken
- good_attrs — set of attributes (only private attributes belonging to the account whose apikey is used will be given)
- attr_id — attribute identifier
- attr_name — attribute name
- attr_value_id — attribute value identifier (only for attributes 2502, 2503)
- attr_value — attribute value
- attr_value_type — type of attribute value
- attr_group_id — attribute group identifier
- attr_group_name — attribute group name
- measure_date — the date when the attribute is received (UTC), (optional)
- published_date — the date of publication of the attribute (UTC), (optional)
- effective_date — the date with which the attribute value is valid (UTC), (optional)
- expired_date — the date with which the value of the attribute is expired (UTC), (optional)
- location_id — Identifier of the location in which the attribute was measured (optional)
- party_location_id — Internal location identifier for the company in which the measurement was conducted (optional, only displayed to this company)
- level — package level (optional)
- gtin — barcode (optional)
- multiplier — multiplier (optional)
- translations — array of attribute translations (optional)
- account_attr_id — identifier of attribute translation (optional)
- account_attr_name — name of attribute translation (optional)
- account_attr_value_id — identifier of attribute value in the account dictionary (optional)
- account_attr_value — attribute value in the account dictionary (optional)
- account_attr_type — attribute type in the account dictionary (optional)
- transliterations — array of transliterations of attribute value (optional)
- ua — ukrainian transliteration (optional)
- ru — russian transliteration (optional)
- en — english transliteration (optional)
- de — german transliteration (optional)
- good_reviews — set of product reviews
- review_id — review identifier
- review_author — author (first name, last name, username)
- review_rating — review rating
- review_text — text of the review
- review_date — date the review was written, in UTC
- review_author_img — URL of a picture of the author
- review_replies — set of reviews; this value is returned if a review has responses (reviews with a review_parent_id value equal to the identifier of the given/parent review)
- review_id — response review identifier
- review_author — author (first name, last name, username)
- review_rating — rating of the response review
- review_text — text of the response review
- review_date — date the review was written, in UTC
- review_author_img — URL of a picture of the author
- good_reviews_count — number of reviews
- good_prices — set of the product’s prices from merchants of the given account:
- good_price — product price (if this value is not given, or if it is 0.00, then a blank line is outputted)
- good_price_currency — currency type (compliant with ISO 4217)
- party_id — merchant identifier
- address — location
- country — country name (compliant with ISO 3166-2)
- city — city name
- street — street name and building number
- location — location coordinates
- lat — latitude
- lon — longitude
and/or
JSON
Content-type: application/json; charset=utf-8
API-Usage-Limit: 1/500
Etag: "38fho43p543re634c993ec28581d867"
Status Code: 200
{
"apiversion": 3,
"result": [
{
"good_id": 672136,
"identified_by": [
{
"value": "11033",
"type": "sku",
"multiplier": 1,
"level": "trade-unit"
},
{
"value": "24823002000164",
"type": "ltin",
"multiplier": 12,
"level": "box"
}
],
"good_name": "Tide Original Scent Liquid Laundry Detergent",
"good_url": "https://contentbank.eu/product/Tide-Original-Scent-Liquid-Laundry-Detergent",
"good_img": "https://img.contentbank.eu/med/63d3beae-b0be-db33-f86b-65a0e37da584.jpg",
"categories": [
{
"cat_id": 14786,
"cat_name": "Detergent"
},
{
"party_cat_id": 241000,
"party_cat_name": "Detergent"
}
],
"brand_id": null,
"brand_name": null,
"good_rating": 4.33333,
"good_avg_price": null,
"good_avg_price_currency": null,
"good_images": [
{
"photo_type": "default",
"photo_date": "2016-07-20T16:26:30+00:00",
"photo_url": "https://img.contentbank.eu/med/63d3beae-b0be-db33-f86b-65a0e37da584.jpg",
"barcode": "6437005056338"
},
{
"photo_type": "3ds",
"photo_date": "2016-07-20T16:26:30+00:00",
"photo_url": [
"https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.0.jpg",
"https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.1.jpg",
"https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.2.jpg",
"https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.3.jpg",
"https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.4.jpg",
"https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.5.jpg",
"https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.6.jpg",
"https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.7.jpg",
"https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.8.jpg",
"https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.9.jpg",
"https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.10.jpg",
"https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.11.jpg",
"https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.12.jpg",
"https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.13.jpg",
"https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.14.jpg",
"https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.15.jpg",
"https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.16.jpg",
"https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.17.jpg",
"https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.18.jpg",
"https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.19.jpg",
"https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.20.jpg",
"https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.21.jpg",
"https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.22.jpg",
"https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.23.jpg"
],
"barcode": "6437005056338"
},
{
"photo_type": "left",
"photo_date": "2016-07-20T16:26:30+00:00",
"photo_url": "https://img.contentbank.eu/med/63d3beae-b0be-db33-f86b-65a0e37da584.6.jpg",
"barcode": "6437005056338"
},
{
"photo_type": "right",
"photo_date": "2016-07-20T16:26:30+00:00",
"photo_url": "https://img.contentbank.eu/med/63d3beae-b0be-db33-f86b-65a0e37da584.18.jpg",
"barcode": "6437005056338"
},
{
"photo_type": "back",
"photo_date": "2016-07-20T16:26:30+00:00",
"photo_url": "https://img.contentbank.eu/med/63d3beae-b0be-db33-f86b-65a0e37da584.12.jpg",
"barcode": "6437005056338"
}
],
"good_attrs": [
{
"attr_id": 18,
"attr_name": "Вес брутто",
"attr_value": "1.506",
"attr_value_type": "кг",
"attr_group_id": 19,
"attr_group_name": "Cubiscan-атрибуты",
"measure_date": "2018-02-01T16:39:04+00:00",
"published_date": "2018-02-03T13:22:11+00:00",
"effective_date": "2018-02-05T16:39:04+00:00",
"expired_date": "2018-08-05T16:39:04+00:00",
"location_id": "532",
"party_location_id": "Store #53",
"level": "trade-unit",
"gtin": "4011200255905",
"multiplier": 1.00,
"translations": [
{
"account_attr_id": 103,
"account_attr_name": "Translation 1",
"account_attr_value_id": 8583,
"account_attr_value": 9603210000,
"account_attr_type": "kilogram"
},
{
"account_attr_id": 104,
"account_attr_name": "Перевод 2",
"account_attr_value_id": 8583,
"account_attr_value": 9603210000,
"account_attr_type": "килограмм"
}
]
},
{
"attr_id": 19,
"attr_name": "Высота",
"attr_value": "29.2",
"attr_value_type": "см",
"attr_group_id": 19,
"attr_group_name": "Cubiscan-атрибуты",
"measure_date": "2018-02-01T16:39:04+00:00",
"published_date": "2018-02-03T13:22:11+00:00",
"effective_date": "2018-02-05T16:39:04+00:00",
"expired_date": "2018-08-05T16:39:04+00:00",
"location_id": "532",
"party_location_id": "Store #53",
"level": "trade-unit",
"gtin": "4011200255905",
"multiplier": 1.00
},
{
"attr_id": 20,
"attr_name": "Глубина",
"attr_value": "",
"attr_value_type": "см",
"attr_group_id": 19,
"attr_group_name": "Cubiscan-атрибуты",
"measure_date": "2018-02-01T16:39:04+00:00",
"published_date": "2018-02-03T13:22:11+00:00",
"effective_date": "2018-02-05T16:39:04+00:00",
"expired_date": "2018-08-05T16:39:04+00:00",
"location_id": "532",
"party_location_id": "Store #53",
"level": "trade-unit",
"gtin": "4011200255905",
"multiplier": 1.00
},
{
"attr_id": 21,
"attr_name": "Ширина",
"attr_value": "20.7",
"attr_value_type": "см",
"attr_group_id": 19,
"attr_group_name": "Cubiscan-атрибуты",
"measure_date": "2018-02-01T16:39:04+00:00",
"published_date": "2018-02-03T13:22:11+00:00",
"effective_date": "2018-02-05T16:39:04+00:00",
"expired_date": "2018-08-05T16:39:04+00:00",
"location_id": "532",
"party_location_id": "Store #53",
"level": "trade-unit",
"gtin": "4011200255905",
"multiplier": 1.00
},
{
"attr_id": 2503,
"attr_name": "Manufacturer",
"attr_value_id": 3408,
"attr_value": "Table inc.",
"attr_value_type": "",
"attr_group_id": 25,
"attr_group_name": "Стороны",
"published_date": "2017-12-10 15:35:08",
"location_id": "532",
"party_location_id": "Store #53",
"transliterations": [
{
"ru": "Тейбл инк.",
"en": "Table inc."
}
]
}
],
"good_reviews": [
{
"review_id": 286,
"review_author": "TestUserReviewName",
"review_rating": 4,
"review_text": "Good!",
"review_date": "2016-11-28T09:31:54+00:00",
"review_author_img": "https://lh5.googleusercontent.com/-F0rhYj_uC6o/AAAAAAAAAAI/AAAAAAAAFUs/_nuL7XLXK88/photo.jpg?sz=50",
"review_replies": [
{
"review_id": 288,
"review_author": "TestUserReviewReplyName",
"review_rating": 4,
"review_text": "Perfect!!!",
"review_date": "2016-11-28T09:49:39+00:00",
"review_author_img": "https://lh5.googleusercontent.com/-F0rhYj_uC6o/AAAAAAAAAAI/AAAAAAAAFUs/_nuL7XLXK88/photo.jpg?sz=50"
}
]
},
{
"review_id": 282,
"review_author": "Maria Moryakina",
"review_rating": 5,
"review_text": "Nice one",
"review_date": "2016-11-17T11:19:48+00:00",
"review_author_img": "https://scontent.xx.fbcdn.net/v/t1.0-1/c0.17.100.100/p100x100/14102384_286143021757109_2710809744588865430_n.jpg?oh=2eb1e9f751c01e58c7b9fdc76dc7153b&oe=58F8B7F4"
}
],
"good_reviews_count": 3,
"good_prices": []
}
]
}
XML
Content-type: application/xml; charset=utf-8
API-Usage-Limit: 1/500
Etag: "38fho43p543re634c993ec28581d867"
Status Code: 200
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiversion>3</apiversion>
<result>
<item>
<good_id>672136</good_id>
<identified_by>
<item>
<value>11033</value>
<type>sku</type>
<multiplier>1</multiplier>
<good_id>672136</good_id>
<level>trade-unit</level>
</item>
<item>
<value>24823002000164</value>
<type>ltin</type>
<multiplier>12</multiplier>
<good_id>672136</good_id>
<level>box</level>
</item>
</identified_by>
<good_name>Tide Original Scent Liquid Laundry Detergent</good_name>
<good_url>https://contentbank.eu/product/Tide-Original-Scent-Liquid-Laundry-Detergent</good_url>
<good_img>https://img.contentbank.eu/med/63d3beae-b0be-db33-f86b-65a0e37da584.jpg</good_img>
<categories>
<item>
<cat_id>14786</cat_id>
<cat_name>Detergent</cat_name>
</item>
<item>
<party_cat_id>241000</party_cat_id>
<party_cat_name>Detergent</party_cat_name>
</item>
</categories>
<brand_id></brand_id>
<brand_name></brand_name>
<good_rating>4,33333</good_rating>
<good_avg_price></good_avg_price>
<good_avg_price_currency></good_avg_price_currency>
<good_images>
<item>
<photo_type>default</photo_type>
<photo_date>2016-07-20T16:26:30+00:00</photo_date>
<photo_url>https://img.contentbank.eu/med/63d3beae-b0be-db33-f86b-65a0e37da584.jpg</photo_url>
<barcode>6437005056338</barcode>
</item>
<item>
<photo_type>3ds</photo_type>
<photo_date>2016-07-20T16:26:30+00:00</photo_date>
<photo_url>
<item>https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.0.jpg</item>
<item>https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.1.jpg</item>
<item>https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.2.jpg</item>
<item>https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.3.jpg</item>
<item>https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.4.jpg</item>
<item>https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.5.jpg</item>
<item>https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.6.jpg</item>
<item>https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.7.jpg</item>
<item>https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.8.jpg</item>
<item>https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.9.jpg</item>
<item>https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.10.jpg</item>
<item>https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.11.jpg</item>
<item>https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.12.jpg</item>
<item>https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.13.jpg</item>
<item>https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.14.jpg</item>
<item>https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.15.jpg</item>
<item>https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.16.jpg</item>
<item>https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.17.jpg</item>
<item>https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.18.jpg</item>
<item>https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.19.jpg</item>
<item>https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.20.jpg</item>
<item>https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.21.jpg</item>
<item>https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.22.jpg</item>
<item>https://img.contentbank.eu/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.23.jpg</item>
</photo_url>
<barcode>6437005056338</barcode>
</item>
<item>
<photo_type>left</photo_type>
<photo_date>2016-07-20T16:26:30+00:00</photo_date>
<photo_url>https://img.contentbank.eu/med/63d3beae-b0be-db33-f86b-65a0e37da584.6.jpg</photo_url>
<barcode>6437005056338</barcode>
</item>
<item>
<photo_type>right</photo_type>
<photo_date>2016-07-20T16:26:30+00:00</photo_date>
<photo_url>https://img.contentbank.eu/med/63d3beae-b0be-db33-f86b-65a0e37da584.18.jpg</photo_url>
<barcode>6437005056338</barcode>
</item>
<item>
<photo_type>back</photo_type>
<photo_date>2016-07-20T16:26:30+00:00</photo_date>
<photo_url>https://img.contentbank.eu/med/63d3beae-b0be-db33-f86b-65a0e37da584.12.jpg</photo_url>
<barcode>6437005056338</barcode>
</item>
</good_images>
<good_attrs>
<item>
<attr_id>18</attr_id>
<attr_name>Weight</attr_name>
<attr_value>1.506</attr_value>
<attr_value_type>кг</attr_value_type>
<attr_group_id>19</attr_group_id>
<attr_group_name>Specifications</attr_group_name>
<measure_date>2018-02-01T16:39:04+00:00</measure_date>
<published_date>2018-02-03T13:22:11+00:00</published_date>
<effective_date>2018-02-05T16:39:04+00:00</effective_date>
<expired_date>2018-08-05T16:39:04+00:00</expired_date>
<location_id>532</location_id>
<party_location_id>Store #53</party_location_id>
<level>trade-unit</level>
<gtin>4011200255905</gtin>
<multiplier>1.00</multiplier>
<translations>
<item>
<account_attr_id>103</account_attr_id>
<account_attr_name>Translation 1</account_attr_name>
<account_attr_value_id>8583</account_attr_value_id>
<account_attr_value>9603210000</account_attr_value>
<account_attr_type>kilogram</account_attr_type>
</item>
<item>
<account_attr_id>104</account_attr_id>
<account_attr_name>Перевод 2</account_attr_name>
<account_attr_value_id>8583</account_attr_value_id>
<account_attr_value>9603210000</account_attr_value>
<account_attr_type>килограмм</account_attr_type>
</item>
</translations>
</item>
<item>
<attr_id>19</attr_id>
<attr_name>Height</attr_name>
<attr_value>29.2</attr_value>
<attr_value_type>sm</attr_value_type>
<attr_group_id>19</attr_group_id>
<attr_group_name>Specifications</attr_group_name>
<measure_date>2018-02-01T16:39:04+00:00</measure_date>
<published_date>2018-02-03T13:22:11+00:00</published_date>
<effective_date>2018-02-05T16:39:04+00:00</effective_date>
<expired_date>2018-08-05T16:39:04+00:00</expired_date>
<location_id>532</location_id>
<party_location_id>Store #53</party_location_id>
<level>trade-unit</level>
<gtin>4011200255905</gtin>
<multiplier>1.00</multiplier>
</item>
<item>
<attr_id>20</attr_id>
<attr_name>Depth</attr_name>
<attr_value></attr_value>
<attr_value_type>sm</attr_value_type>
<attr_group_id>19</attr_group_id>
<attr_group_name>Specifications</attr_group_name>
<measure_date>2018-02-01T16:39:04+00:00</measure_date>
<published_date>2018-02-03T13:22:11+00:00</published_date>
<effective_date>2018-02-05T16:39:04+00:00</effective_date>
<expired_date>2018-08-05T16:39:04+00:00</expired_date>
<location_id>532</location_id>
<party_location_id>Store #53</party_location_id>
<level>trade-unit</level>
<gtin>4011200255905</gtin>
<multiplier>1.00</multiplier>
</item>
<item>
<attr_id>21</attr_id>
<attr_name>Width</attr_name>
<attr_value>20.7</attr_value>
<attr_value_type>sm</attr_value_type>
<attr_group_id>19</attr_group_id>
<attr_group_name>Specifications</attr_group_name>
<measure_date>2018-02-01T16:39:04+00:00</measure_date>
<published_date>2018-02-03T13:22:11+00:00</published_date>
<effective_date>2018-02-05T16:39:04+00:00</effective_date>
<expired_date>2018-08-05T16:39:04+00:00</expired_date>
<location_id>532</location_id>
<party_location_id>Store #53</party_location_id>
<level>trade-unit</level>
<gtin>4011200255905</gtin>
<multiplier>1.00</multiplier>
</item>
<item>
<attr_id>2503</attr_id>
<attr_name>Manufacturer</attr_name>
<attr_value_id>3408</attr_value>
<attr_value>Table inc.</attr_value>
<attr_value_type></attr_value_type>
<attr_group_id>25</attr_group_id>
<attr_group_name>Sides</attr_group_name>
<published_date>2017-12-10 15:35:08</published_date>
<location_id>532</location_id>
<party_location_id>Store #53</party_location_id>
<transliterations>
<ru>Тейбл инк.</ru>
<en>Table inc.</en>
</transliterations>
</item>
</good_attrs>
<good_reviews>
<item>
<review_id>286</review_id>
<review_author>TestUserReviewName</review_author>
<review_rating>4</review_rating>
<review_text>Nice!</review_text>
<review_date>2016-11-28T09:31:54+00:00</review_date>
<review_author_img>https://lh5.googleusercontent.com/-F0rhYj_uC6o/AAAAAAAAAAI/AAAAAAAAFUs/_nuL7XLXK88/photo.jpg?sz=50</review_author_img>
<review_replies>
<item>
<review_id>288</review_id>
<review_author>TestUserReviewReplyName</review_author>
<review_rating>4</review_rating>
<review_text>Perfect!!!</review_text>
<review_date>2016-11-28T09:49:39+00:00</review_date>
<review_author_img>https://lh5.googleusercontent.com/-F0rhYj_uC6o/AAAAAAAAAAI/AAAAAAAAFUs/_nuL7XLXK88/photo.jpg?sz=50</review_author_img>
</item>
</review_replies>
</item>
<item>
<review_id>282</review_id>
<review_author>Maria Moryakina</review_author>
<review_rating>5</review_rating>
<review_text>Nice one</review_text>
<review_date>2016-11-17T11:19:48+00:00</review_date>
<review_author_img>https://scontent.xx.fbcdn.net/v/t1.0-1/c0.17.100.100/p100x100/14102384_286143021757109_2710809744588865430_n.jpg?oh=2eb1e9f751c01e58c7b9fdc76dc7153b&oe=58F8B7F4</review_author_img>
</item>
</good_reviews>
<good_reviews_count>3</good_reviews_count>
<good_prices/>
</item>
</result>
</root>
The Etagslist Method
Method returns list of merchant's products with current content entity tag (see more at version control) and list of known SKU. By comparing the local stored Etag to the server-side Etag, the cache can determine if the product information has been changed and needs to be renewed.
Sample Request
https://api.contentbank.eu/v3/etagslist?apikey=XXX&party_id=YYY
Request Parameters
- party_id — merchant identifier (mandatory)
Reponse Parameters
- good_id — product identifier
- etag — version control hash
- sku — list of product SKU
- item — SKU
JSON
Content-type: application/json; charset=utf-8
API-Usage-Limit: 1/500
Status Code: 200
{
"apiversion":3,
"result": [
{
"good_id":59363,
"etag":"e90d02cd2ee1344c",
"sku": [
"112629"
]
},
{
"good_id":18407,
"etag":"96f5d483b11a7b21",
"sku": [
"112606"
]
},
{
"good_id":10869,
"etag":"0195473cf6b9a2be",
"sku": [
"112612"
]
}
]
}
XML
Content-type: application/xml; charset=utf-8
API-Usage-Limit: 1/500
Status Code: 200
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiversion>3</apiversion>
<result>
<item>
<good_id>59363</good_id>
<etag>e90d02cd2ee1344c</etag>
<sku>
<item>112629</item>
</sku>
</item>
<item>
<good_id>18407</good_id>
<etag>96f5d483b11a7b21</etag>
<sku>
<item>112606</item>
</sku>
</item>
<item>
<good_id>10869</good_id>
<etag>0195473cf6b9a2be</etag>
<sku>
<item>112612</item>
</sku>
</item>
</result>
</root>
The Suggestions Method
This method returns a list of items according to a product name.
Sample Request
https://api.contentbank.eu/v3/suggestions?apikey=XXX&q=Soa
Request Parameters
- q — (mandatory) string with the product name (more than 2 symbols) to be searched for
Response Parameters
- brand_name — brand name
- good_id — product identifier
- good_name — product name
- good_img — default product image (300x200px)
JSON
Content-type: application/json; charset=utf-8
API-Usage-Limit: 1/500
Status Code: 200
{
"apiversion": 3,
"result": [
{
"brand_name": "Irish Spring",
"good_id": "319932",
"good_name": "Irish Spring Bath Bar Soap, Aloe, 12 Count (Pack of 6)",
"good_img": "https://img.contentbank.eu/e6104f.jpg"
},
{
"brand_name": "Basics",
"good_id": "319933",
"good_name": "Dial Bar Soap, Hypoallergenic, 9.6 Ounce",
"good_img": "https://img.contentbank.eu/aabac1c6.jpg"
}
...
]
}
XML
Content-type: application/xml; charset=utf-8
API-Usage-Limit: 1/500
Status Code: 200
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiversion>3</apiversion>
<result>
<item>
<brand_name>Irish Spring</brand_name>
<good_id>319932</good_id>
<good_name>Irish Spring Bath Bar Soap, Aloe, 12 Count (Pack of 6)</good_name>
<good_img>https://img.contentbank.eu/e6104f.jpg</good_img>
</item>
<item>
<brand_name>Basics</brand_name>
<good_id>319933</good_id>
<good_name>Dial Bar Soap, Hypoallergenic, 9.6 Ounce</good_name>
<good_img>https://img.contentbank.eu/aabac1c6.jpg</good_img>
</item>
...
</result>
</root>
The AddReview Method
This method allows you to add a review or respond to an existing review in one of the specified entities: brand, merchant, product. Comments are published after moderator approval. If a comment is successfully published, confirmation will be sent with publication information.
Sample Request
https://api.contentbank.eu/v3/addreview?apikey=XXX&review_parent_id=174or
https://api.contentbank.eu/v3/addreview?apikey=XXX&good_id=62433
| POST-parameter | Parameter values |
|---|---|
review_text |
"Excellent tool!" |
social_type |
"gp" |
social_id |
"120076146314" |
review_author |
"Jack Sparrow" |
review_rating |
4 |
Request Parameters
GET-parameters:
- review_parent_id — parent review identifier (when a parent review identifier is specified, it is not necessary to specify an entity identifier, since it will be ignored)
- brand_id — brand identifier (not mandatory if review_parent, party_id, and good_id are not given)
- party_id — merchant identifier (not mandatory if review_parent, brand_id, and good_id are not given)
- good_id — product identifier (not mandatory if review_parent, party_id, and brand_id are not given)
POST-parameters:
- review_text — (mandatory) text of the review
- social_type — (mandatory) service used for authorization; possible values:
- gp — Google plus
- fb — Facebook
- tw — Twitter
- vk — VK
- social_id — (mandatory) user identifier for the authorization service specified in social_type
- review_author — (mandatory) author of the review (first name, last name, username)
- review_rating — (mandatory) rating given by the author of the review (0 to 5)
Response Parameters
- review_id — review identifier
- review_parent_id — parent review identifier
- brand_id — brand identifier, if the review is for this entity
- good_id — product identifier, if the review is for this entity
- party_id — merchant identifier, if the review is for this entity
- review_rating — rating given by the author (0 to 5)
- review_text — text of the review
- review_date — date the review was written, UTC
- review_author — author of the review (first name, last name, username)
- review_author_img — link to the author’s picture
JSON
Content-type: application/json; charset=utf-8
API-Usage-Limit: 1/500
Status Code: 200
{
"apiversion": 3,
"result": {
"review_id": 181,
"good_id": 62084,
"review_author": "Jack Sparrow",
"review_rating": 4,
"review_text": "Excellent tool!",
"review_date": "2016-10-21 10:17:13",
"review_author_img": "https://plus.google.com/petro.jpg"
}
}
XML
Content-type: application/xml; charset=utf-8
API-Usage-Limit: 1/500
Status Code: 200
<?xml version="1.0" encoding="UTF-8"?>
<root>
<apiversion>3</apiversion>
<result>
<review_id>181</review_id>
<good_id>62084</good_id>
<review_author>Jack Sparrow</review_author>
<review_rating>4</review_rating>
<review_text>Excellent tool!</review_text>
<review_date>2016-10-21 10:17:13</review_date>
<review_author_img>https://plus.googl.jpg</review_author_img>
</result>
</root>
The Image Method
The method proportionally resize an image. The method accepts and returns a JPEG format.
Sample Request
https://api.contentbank.eu/v3/image?apikey=XXX&name=https://img.contentbank.eu/300x200/5a7eb614-13d3-69ed-caf7-420624d1bdd3.jpg&width=300&height=400
Request Parameters
GET-параметры:
- name — fill image URL
- width — new width (within 100-1000 px)
- height — new height (within 100-1000 px)
- no_background — the missing space will be filled with white, 1 space will not be filled
Response
This method generates JPEG image with new width and height as a response.The Locations Method
Returns a list of locations for the requesting account or specific merchant network.
Sample Request
https://api.contentbank.eu/v3/locations?apikey=XXXor
https://api.contentbank.eu/v3/locations?apikey=XXX&party_id=123
Request Parameters
- party_id — merchant identifier (optional)
Response Parameters
- location_id — location identifier.
- party_id — merchant identifier.
- party_location_id — location identifier in merchant
- location_name — locations name.
-
status — location status:
- O — open
- C — closed
- U — under construction
- R — reconstruction
- services — available services
- schedule — work time
-
address — location
- country — country name (compliant with ISO 3166-1 alpha-2)
- region — название региона
- city — city name
- street — street name and building number
- location — location coordinates
- lat — latitude
- lon — longitude
JSON
Content-type: application/json; charset=utf-8
API-Usage-Limit: 1/500
Status Code: 200{
"apiversion": 3,
"result": [
{
"location_id": 15175,
"party_id": 1927,
"party_location_id": "161253",
"location_name": "Lewiatan 161253",
"status": "O",
"services": "",
"schedule": "",
"address": {
"country": "PL",
"region": "Mazowieckie",
"city": "Piaseczno",
"street": "Wojska Polskiego, 8B",
"location": {
"lat": "52.07831830",
"lon": "21.02361020"
}
}
},
{
"location_id": 15180,
"party_id": 1927,
"party_location_id": "162911",
"location_name": "Lewiatan 162911",
"status": "O",
"services": "",
"schedule": "",
"address": {
"country": "PL",
"region": "Mazowieckie"
"city": "Nowa Wola",
"street": "Ignacego Krasickiego",
"location": {
"lat": "52.09380300",
"lon": "20.96701410"
}
}
},
{
"location_id": 15184,
"party_id": 1927,
"party_location_id": "165806",
"location_name": "Lewiatan 165806",
"status": "O",
"services": "",
"schedule": "",
"address": {
"country": "PL",
"city": "Konstancin-Jeziorna",
"street": "Warszawska",
"location": {
"lat": "52.09249020",
"lon": "21.11843973"
}
}
}
]
}XML
Content-type: application/xml; charset=utf-8
API-Usage-Limit: 1/500
Status Code: 200<root>
<apiversion>3</apiversion>
<result>
<item>
<location_id>15175</location_id>
<party_id>1927</party_id>
<party_location_id>161253</party_location_id>
<location_name>Lewiatan 161253</location_name>
<status>O</status>
<services/>
<schedule/>
<address>
<country>PL</country>
<region>Mazowieckie</region>
<city>Piaseczno</city>
<street>Wojska Polskiego, 8B</street>
<location>
<lat>52.07831830</lat>
<lon>21.02361020</lon>
</location>
</address>
</item>
<item>
<location_id>15180</location_id>
<party_id>1927</party_id>
<party_location_id>162911</party_location_id>
<location_name>Lewiatan 162911</location_name>
<status>O</status>
<services/>
<schedule/>
<address>
<country>PL</country>
<region>Mazowieckie</region>
<city>Nowa Wola</city>
<street>Ignacego Krasickiego</street>
<location>
<lat>52.09380300</lat>
<lon>20.96701410</lon>
</location>
</address>
</item>
<item>
<location_id>15184</location_id>
<party_id>1927</party_id>
<party_location_id>165806</party_location_id>
<location_name>Lewiatan 165806</location_name>
<status>O</status>
<services/>
<schedule/>
<address>
<country>PL</country>
<city>Konstancin-Jeziorna</city>
<street>Warszawska</street>
<location>
<lat>52.09249020</lat>
<lon>21.11843973</lon>
</location>
</address>
</item>
</result>
</root>