GetProducts You can retrieve all or a variety of products; you can use the "filter," "SkuSellerList," or "limit" fields to filter the products.
Some response fields provided by this API are detailed in the following table:
Name | Type | Description |
|---|---|---|
SellerSku | String | Unique identifier of the seller |
ShopSku | String | Unique identifier of the shop |
Name | String | Product name |
Brand | String | Product brand |
Description | String | Product description |
TaxClass | String | Tax class applied to the product |
Variation | String | Product variation
|
BusinessUnits.Stock | Integer | The sellable stock in the seller's warehouse. This field does not include stock reserved for ongoing orders. |
Price | Decimal | Regular price of the product |
SalePrice | Decimal | Special sale price of the product |
SaleStartDate | DateTime | Start date of the special offer |
SaleEndDate | DateTime | End date of the special offer |
Status | Integer | Product status: 'active,' 'inactive,' or 'deleted' |
ProductId | String | EAN / UPC / ISBN of the product, if available |
Url | String | Link to the product on the company's website |
MainImage | String | Link to the main image of the product |
FobPrice | Decimal | Regular FOB (Free On Board) price of the product, before conversion
|
FobSalePrice | Decimal | FOB (Free On Board) sale price of the product, before conversion.
|
Images | Multiple Image Elements | All images of the product (including the main image) |
PrimaryCategory | String | The primary category of the product |
Categories | String | Additional categories of the product (comma-separated) |
ProductData | Multiple Attribute Elements | Attributes of the product, each of which is a separate child element |
QCStatus | String | The QC (Quality Control) status of the product at the time of the call. |
isPublished | Integer | Product publication approval status. |
BusinessUnit | String | The BU where the product needs to be published. |
OperatorCode | String | The code of the shop where the product will be published. |
It is important to remember that attributes may change between categories; therefore, the response when querying a product may vary. Remember that you can query the attributes of a category using the API GetCategoryAttributes.
Errors
| Error Code | Message |
|---|---|
| 17 | E017: "%s" Invalid Date Format (Invalid date format) |
| 19 | E019: "%s" Invalid Limit (Invalid limit) |
| 14 | E014: "%s" Invalid Offset (Invalid offset) |
| 36 | E036: Invalid status filter (Invalid status filter) |
| 70 | E070: You have corrupt data in your sku seller list (You have corrupt data in your sku seller list) |
Not transactional
The product list may change while you navigate through it using multiple calls with a changing Offset parameter.