Documentation for the API
Below we describe which fields are necessary for the integration to be carried out successfully. The field names don't necessarily have to be the same, but it's important that the api returns all or most of them.
Category/Product List
As seen on the previous page, the ideal is for the API to have as many filtering and sorting options as possible, so that you will have more flexibility to build your store in the most customizable way possible.
However, here are the mandatory filters for the integration to work.
Request Params:
| Property | Format | Details |
|---|---|---|
| text | Optional User search text. Example White T-shirt Syntax String | A text search, this search can be done by any field. Ideally by name or sku. This text will be typed by the user in the live. |
| categoryId | Required Product's category unique identifier. Example 1000049 Syntax String | This field can be overridden or added to any other major filter such as brand, price range or collections. At least one filter is mandatory, to prevent the live from having only one category with all products. |
| page | Required List pagination. Example 0 Syntax Numeric | Your api can have any kind of pagination, but it's mandatory. |
Response body:
| Property | Format | Details |
|---|---|---|
| id | Required Your product’s unique identifier Example C8DAF871-7E4D-460E-8D7F-DB39A1861635 Syntax Max 50 characters | Use a unique value for each product Use only valid unicode characters. Avoid invalid characters like control, function, or private area characters |
| sku | Required Product’s unique identifier Example 0000000 Syntax Max 50 characters | Use product's SKU where possible, or use a unique value for each product and variation Use only valid unicode characters. Avoid invalid characters like control, function, or private area characters |
| name | Required Your product’s name Example Mens Pique Polo Shirt Syntax Max 150 characters | Accurately describe your product Don’t include promotional text like "free shipping," all capital letters, or gimmicky foreign |
| price | Required Your product’s price Example 15.00 Syntax Numeric | Accurately submit the product's price and currency, and match with the price from your landing page and at checkout Make sure that your checkout pages include the price in the currency of the country of sale prominently |
| salePrice | Optional Your product's sale price Example 15.00 Syntax Numeric | Meet the requirements for the price attribute Submit the salePrice in addition to the price attribute with the non-sale price |
| images | images Required The URL of your product’s image list Example [http://www.example.com/image1.jpg] Syntax Array of strings | For the image URL: Link to the main image of your product Start with http or https Use an encoded URL that complies with RFC 2396 or RFC 1738. For example, a comma would be represented as "%2C" For the image: Accurately display the product you're selling Use an accepted format: JPEG (.jpg/.jpeg), WebP (.webp), PNG (.png), non-animated GIF (.gif), BMP (.bmp), and TIFF (.tif/.tiff) Use an image of at least 150 x 150 pixels Don't submit a file larger than 2MB Don't scale up an image or submit a thumbnail Don't include promotional text, watermarks, or borders |
| availableQuantity | Optional Your product’s avalable quantity Example 10 Syntax Numeric | If value is null, the shop will make this product available. |