List Products & SKUs

Retrieve all products for a site. Use limit and offset to page through all products with subsequent requests. All SKUs for each product will also be fetched and returned. The count, limit and offset and total values represent Products only and do not include any SKUs.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

site_idstringRequiredformat: "uuid"
Unique identifier for a Site

Headers

Accept-VersionstringOptional
The API version

Query parameters

offsetintegerOptional
Offset used for pagination if the results have more than limit records
limitintegerOptional

Maximum number of records to be returned (max limit: 100)

Response

Request was successful
itemslist of objects
List of Item objects within the Collection. Contains product and skus keys
countinteger
Number of items returned
limitintegerDefaults to 100
The limit specified in the request
offsetintegerDefaults to 0
The offset specified for pagination
totalinteger
Total number of items in the collection

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error