Get Products

GetProducts opilotAquí tienes una traducción clara y natural: “You get all or a variety of products, and you can use fields like filter, SkuSellerList, or limit to apply a filter to the products.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

The values included in the response will vary depending on the product’s attributes and the category it belongs to.
The following table details some of the fields that this API may return in the response:


NameTypeDescription
SellerSkuStringSeller's unique identifier
ShopSkuStringStore's unique identifier
NameStringProduct name
BrandStringProduct brand
DescriptionStringProduct description
TaxClassStringTax class applied to the product
VariationStringName of the photo group, for categories without variation
BusinessUnit.StockIntegerSellable stock in the seller's warehouse (does not include reserved stock)
BusinessUnit.PriceDecimalRegular product price
BusinessUnit.SalePriceDecimalSpecial sale price
BusinessUnit.SaleStartDateDateTimeStart date of the special offer
BusinessUnit.SaleEndDateDateTimeEnd date of the special offer
BusinessUnit.StatusIntegerProduct status: 'active', 'inactive', or 'deleted'
ProductIdStringEAN / UPC / ISBN of the product, if available
UrlStringLink to the product on the company's website
MainImageStringLink to the main product image
ImagesMultiple Image ElementsAll product images (including the main image)
PrimaryCategoryStringMain product category
CategoriesStringAdditional product categories (comma-separated)
ProductDataMultiple Attribute ElementsProduct attributes
QCStatusStringProduct QC (Quality Control) status at the time of the call: "pending", "approved", "rejected"
isPublishedIntegerPublication approval status: 0 - not approved, 1 - approved
BusinessUnit.OperatorCodeStringStore code where the product will be published: facl = Chile, fape = Peru, FACO = Colombia
ContentScoreIntegerProduct score

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 CodeMessage
17E017: "%s" Invalid Date Format (Invalid date format)
19E019: "%s" Invalid Limit (Invalid limit)
14E014: "%s" Invalid Offset (Invalid offset)
36E036: Invalid status filter (Invalid status filter)
70E070: You have corrupt data in your sku seller list (You have corrupt data in your sku seller list)

🚧

Important

You can use Offset and Limit to iterate through the entire product list in case you have more products than the maximum returned by the API

Query Params
string
Defaults to GetProducts

Name of the function to be called. Required and must be 'GetBrands' in this case. If omitted, an error 'E001: Parameter Action is mandatory' is returned. If an unknown function string is provided, an error message 'E008: Invalid Action' is returned.

string
Defaults to XML

If provided, it must be 'JSON' or 'XML'. If not provided, 'XML' is assumed.

date

The current time in ISO8601 format relative to UTC (e.g., Timestamp = 2015-04-01T10:00:00+02:00 for Berlin), so that calls cannot be replayed by a third party intercepting them (i.e., calls too far in the past or future will produce an error message). Required. If not provided, the error message 'E001: Parameter Timestamp is mandatory' appears. If the timestamp is too old or in the future, an error message "E003: Timestamp has expired" is returned.

string

The ID of the user making the call. The list of authorized users is maintained in the Seller Center web interface under General Settings / Manage Users.

string

The API version against which this call will be executed, in major-dot-minor format. It must currently be 1.0, although the actual API version is 2.6.20. If omitted, an error message "E001: Parameter Version is mandatory" is returned.

string

The cryptographic signature that authenticates the request. A caller must create this value by calculating the SHA256 hash of the request, using the API key of the user specified in the UserID parameter. Required. If omitted, an error message "E001: Parameter Signature is mandatory" is returned. If the signature is incorrect, an 'E007: Login failed' error message for signature mismatch is returned.

date

Limits the list of products returned to those created on or after a specific date, provided in ISO 8601 date format. Optional.

date

Limits the list of products returned to those created on or before a specific date, provided in ISO 8601 date format. Optional.

string

Returns products where the search string is contained in the product name and/or SKU.

string
Defaults to all

Returns only those products whose status matches this parameter. Possible values are all, live, inactive, deleted, image-missing, pending, rejected, sold-out. Required.

int32
Defaults to 1000

The maximum number of products to be returned. If this parameter is omitted, the default value of 1000 is used. The maximum number of products that can be requested in a single call is 1000 (this is the strict default limit, which can be changed per instance). If you need to retrieve more products than that, you must paginate through the result set using the Offset parameter.

int32

The number of products to skip (i.e., an offset in the result set; along with the Limit parameter, simple pagination of the result set is possible; when paginating through the results, keep in mind that the product list may change during pagination).

SkuSellerList
array of strings

Only products whose SKU is included in this list will be returned. It can be a JSON array (e.g., ["E213", "KI21", "HT0"]) or a serialized PHP array (e.g., a:3:{i:0;s:4:"E213";i:1;s:4:"KI21";i:2;s:3:"HT0";}).

SkuSellerList
date

Limits the list of products returned to those updated on or after a specific date, provided in ISO 8601 date format. Optional.

date

Limits the list of products returned to those updated on or before a specific date, provided in ISO 8601 date format. Optional.

int32
Defaults to 0

If set to 1, Brand, PrimaryCategory, Categories, and all attributes in ProductData will be returned with global identifiers.

Response

Language
LoadingLoading…
Response
Choose an example:
text/xml