Requests allow you to retrieve up-to-date product data from an online store. Please refer to this documentation for proper handling of requests from us.

HTTP POST request

Request header:

Authorization: Bearer {your unique token},
Content-Type: application/json,

Request getProducts example:

{
    "method": "getProducts",
    "details": 0,
    "offset": null,
    "count": 10
}

Request fields description

Name	Type	Value	Remarks
method	String	getProduct
details	Integer/Boolean	false or 0: request basic data true or 1: request detailed product information	Detailed information is requested for new product import or when product data has been changed (identified by updated field of response message). For existing products only basic info is requested such as price and availability.
offset	Null/Integer/String	LastId value from response message or null on first request	Used to continue listing from last known position
count	Integer		Number of products to provide

Request getProductsBySku example:

{
   "method": "getProductsBySku",
   "details": 1,
   "sku": [
        "12312321",
        "21312312",
        "12321321"
   ]
}

Name	Type	Value	Remarks
method	String	getProductsBySku
details	Integer/Boolean	false or 0: request basic data true or 1: request detailed product information	Detailed information is requested for new product import or when product data has been changed (identified by updated field of response message). For existing products only basic info is requested such as price and availability.
sku	Array	SKU list	Array of strings with SKU list to provide

Response example:

{
   "prods": [
       {
           "sku": 12345678,
           "url": "https://example.com",
           "manufacturer": "Example Manufacturer",
           "model": "Example Model",
           "ean": "1234567890123",
           "price": 9.99,
           "availability": "InStock",
           "itemsAvailable": 42,
           "updated": "2020-02-20 15:44:49"
       }
   ],
   "lastId": 1234
}

Response with details flag set example:

{
   "prods": [
       {
           "sku": "12345678",
           "url": "https://example.com",
           "manufacturer": "Example Manufacturer",
           "model": "Example Model",
           "ean": "1234567890123",
           "price": 9.99,
           "availability": "InStock",
           "itemsAvailable": 42,
           "itemCondition": "NewCondition",
           "category": "Example Category",
           "name": "Example Product",
           "description": "Example Product Description",
           "updated": "2020-02-20 15:44:49",
           "delivery": [
               {
                   "country": [
                       "BE",
                       "DE"
                   ],
                   "carriers": [
                       {
                           "name": "UPS",
                           "shippingRate": 9.99,
                           "deliveryDays": 3
                       },
                       {
                           "name": "PickupInStore",
                           "shippingRate": 0,
                           "deliveryDays": 0,
                           "inStore": 1
                       }
                   ]
               },
               {
                   "country": "PL",
                   "carriers": [
                       {
                           "shippingRate": 5,
                           "name": "UPS",
                           "deliveryDays": 3
                       },
                       {
                           "shippingRate": 9.99,
                           "name": "UPS",
                           "deliveryDays": 2
                       }
                   ]
               }
           ],
           "images": [
                   "https://example.com/image1.jpg",
                   "https://example.com/image2.jpg",
                   "https://example.com/image3.jpg"
           ]
       }
   ],
   "lastId": 1234
}

Response fields description:

Name	Type	Maximal Length	Requirement	Description
sku	Integer/String	100 symbols	Mandatory	Unique store product identifier
url	String	2048 symbols	Mandatory	URL to product page
manufacturer	String	256 symbols	Conditional	Product manufacturer
model	String	256 symbols	Conditional	Product model (manufacturer code or mpn)
ean	String/Array	255 symbols each ean	Conditional	Product EAN-13 code(s)
price	Float	10 digits	Mandatory	Product price including VAT
availability	String	-	Mandatory	ItemAvailability per schema.org enumeration
itemsAvailable	Integer	-	Optional	Number of products in stock available for purchase
itemCondition	String	-	Mandatory[0]	OfferItemCondition per schema.org enumeration
name	String	512 symbols	Mandatory[0]	Product name
category	String	256 symbols	Mandatory[0]	Product category
description	String	65535 symbols	Optional[0]	Product short description
updated	String	-	Mandatory	Product details modification date in format “YYYY-MM-DD hh:mm:ss”
delivery	Array	-	Mandatory[0]	Product delivery options (check array description below)
images	Array	1024 symbols each image	Optional[0]	Product image list
lastId	Integer/String	-	Mandatory	Unique record identifier of last product. This value is used as offset in getProducts request to continue product list

[0] - Field required when request flag is true or 1

Delivery array description:

Name	Type	Requirement	Description
country	String/Array	Mandatory	Country code in ISO 3166 where the store is able to deliver. For countries with the same shipping rates and delivery times an array of country codes can be provided
carriers	Array	Mandatory	Carriers array (check array description below)

Carriers array description:

Name	Type	Requirement	Description
name	String	Mandatory	Carrier name
shippingRate	Float	Mandatory	Shipping costs for the product. Default value: 0
deliveryDays	Integer	Mandatory	Estimated delivery time in days. Default value: 0
inStore	Integer/Boolean	Optional	If true or 1, indicates that product can be picked up from store without delivery Default: false