/products
GET {{baseUrl}}/products?embed=<string>&fields=<string>&sort=<string>&active=<integer>&count=<integer>&offset=<integer>
Returns all products. by default the first 50 products (both active and inactive) are returned, sorted by creation date
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
embed | string | Comma seperated list of properties to embed | |
fields | string | Comma seperated list of properties to include | |
sort | string | If not included, results are sorted by creation date | |
active | string | Indicates whether to return active or inactive products (1, 0 respectively). If not included, active and inactive products are returned | |
count | string | The maximum number of results to be returned | |
offset | string | The starting position for the returned values |
RESPONSES
status: OK
[{"id":"\u003cinteger\u003e","title":"\u003cstring\u003e","description":"\u003cstring\u003e","description2":"\u003cstring\u003e","description3":"\u003cstring\u003e","description4":"\u003cstring\u003e","description5":"\u003cstring\u003e","active":"\u003cboolean\u003e","deliveryPrice":"\u003cnumber\u003e","singleDeliveryPrice":"\u003cboolean\u003e","weight":"\u003cnumber\u003e","metaTitle":"\u003cstring\u003e","metaDescription":"\u003cstring\u003e","metaKeywords":"\u003cstring\u003e","url":"\u003cstring\u003e","videoCode":"\u003cstring\u003e","sku":"\u003cstring\u003e","stock":"\u003cinteger\u003e","comparePrice":"\u003cnumber\u003e","gtin":"\u003cstring\u003e","mpn":"\u003cstring\u003e","new":"\u003cboolean\u003e","twoForOne":"\u003cboolean\u003e","vatExclusive":"\u003cboolean\u003e","vatRelief":"\u003cboolean\u003e","warehouseNotes":"\u003cstring\u003e","price":"\u003cnumber\u003e","salePrice":"\u003cnumber\u003e","excludedFromTradeDiscounts":"\u003cboolean\u003e","searchKeywords":"\u003cstring\u003e","images":[{"id":"\u003cinteger\u003e","url":"\u003cstring\u003e","description":"\u003cstring\u003e","sortOrder":"\u003cinteger\u003e"},{"id":"\u003cinteger\u003e","url":"\u003cstring\u003e","description":"\u003cstring\u003e","sortOrder":"\u003cinteger\u003e"}],"brand":"\u003cinteger\u003e","googleCategory":"\u003cinteger\u003e","googleCondition":"\u003cstring\u003e","googleIsBundle":"\u003cboolean\u003e","googleNoIdentifierExists":"\u003cboolean\u003e","eBayCategory":"\u003cinteger\u003e","eBayBestOffer":"\u003cboolean\u003e","eBayShippingRates":["\u003cinteger\u003e","\u003cinteger\u003e"],"categories":[{"id":"\u003cinteger\u003e","title":"\u003cstring\u003e","description":"\u003cstring\u003e","url":"\u003cstring\u003e","active":"\u003cboolean\u003e","metaTitle":"\u003cstring\u003e","metaKeywords":"\u003cstring\u003e","metaDescription":"\u003cstring\u003e","image":{"url":"\u003cstring\u003e"}},{"id":"\u003cinteger\u003e","title":"\u003cstring\u003e","description":"\u003cstring\u003e","url":"\u003cstring\u003e","active":"\u003cboolean\u003e","metaTitle":"\u003cstring\u003e","metaKeywords":"\u003cstring\u003e","metaDescription":"\u003cstring\u003e","image":{"url":"\u003cstring\u003e"}}],"related":["\u003cinteger\u003e","\u003cinteger\u003e"],"extras":[{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","price":"\u003cnumber\u003e"},{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","price":"\u003cnumber\u003e"}],"ebayCondition":"\u003cnumber\u003e","variations":[{"id":"\u003cinteger\u003e","price":"\u003cnumber\u003e","costPrice":"\u003cnumber\u003e","rewardPoints":"\u003cinteger\u003e","sku":"\u003cstring\u003e","weight":"\u003cnumber\u003e","stock":"\u003cinteger\u003e","image":"\u003cinteger\u003e","values":[{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","option":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e"}},{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","option":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e"}}]},{"id":"\u003cinteger\u003e","price":"\u003cnumber\u003e","costPrice":"\u003cnumber\u003e","rewardPoints":"\u003cinteger\u003e","sku":"\u003cstring\u003e","weight":"\u003cnumber\u003e","stock":"\u003cinteger\u003e","image":"\u003cinteger\u003e","values":[{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","option":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e"}},{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","option":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e"}}]}],"choices":[{"id":"\u003cinteger\u003e","set":{"id":"\u003cinteger\u003e"},"value":{"id":"\u003cinteger\u003e"},"customPrice":"\u003cnumber\u003e"},{"id":"\u003cinteger\u003e","set":{"id":"\u003cinteger\u003e"},"value":{"id":"\u003cinteger\u003e"},"customPrice":"\u003cnumber\u003e"}],"customizationFields":[{"id":"\u003cinteger\u003e","label":"\u003cstring\u003e","type":"\u003cinteger\u003e"},{"id":"\u003cinteger\u003e","label":"\u003cstring\u003e","type":"\u003cinteger\u003e"}],"filters":{"1":["\u003cstring\u003e","\u003cstring\u003e"]},"fileUploadsAllowed":"\u003cinteger\u003e","rewardPoints":"\u003cinteger\u003e","preOrder":"\u003cboolean\u003e","customFields":{"custom_field_name_is_key":"\u003cstring\u003e"},"hsCode":"\u003cstring\u003e","options":[{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e"},{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e"}],"digitalFiles":[{"id":"\u003cinteger\u003e"},{"id":"\u003cinteger\u003e"}],"slug":"\u003cstring\u003e"},{"id":"\u003cinteger\u003e","title":"\u003cstring\u003e","description":"\u003cstring\u003e","description2":"\u003cstring\u003e","description3":"\u003cstring\u003e","description4":"\u003cstring\u003e","description5":"\u003cstring\u003e","active":"\u003cboolean\u003e","deliveryPrice":"\u003cnumber\u003e","singleDeliveryPrice":"\u003cboolean\u003e","weight":"\u003cnumber\u003e","metaTitle":"\u003cstring\u003e","metaDescription":"\u003cstring\u003e","metaKeywords":"\u003cstring\u003e","url":"\u003cstring\u003e","videoCode":"\u003cstring\u003e","sku":"\u003cstring\u003e","stock":"\u003cinteger\u003e","comparePrice":"\u003cnumber\u003e","gtin":"\u003cstring\u003e","mpn":"\u003cstring\u003e","new":"\u003cboolean\u003e","twoForOne":"\u003cboolean\u003e","vatExclusive":"\u003cboolean\u003e","vatRelief":"\u003cboolean\u003e","warehouseNotes":"\u003cstring\u003e","price":"\u003cnumber\u003e","salePrice":"\u003cnumber\u003e","excludedFromTradeDiscounts":"\u003cboolean\u003e","searchKeywords":"\u003cstring\u003e","images":[{"id":"\u003cinteger\u003e","url":"\u003cstring\u003e","description":"\u003cstring\u003e","sortOrder":"\u003cinteger\u003e"},{"id":"\u003cinteger\u003e","url":"\u003cstring\u003e","description":"\u003cstring\u003e","sortOrder":"\u003cinteger\u003e"}],"brand":"\u003cinteger\u003e","googleCategory":"\u003cinteger\u003e","googleCondition":"\u003cstring\u003e","googleIsBundle":"\u003cboolean\u003e","googleNoIdentifierExists":"\u003cboolean\u003e","eBayCategory":"\u003cinteger\u003e","eBayBestOffer":"\u003cboolean\u003e","eBayShippingRates":["\u003cinteger\u003e","\u003cinteger\u003e"],"categories":[{"id":"\u003cinteger\u003e","title":"\u003cstring\u003e","description":"\u003cstring\u003e","url":"\u003cstring\u003e","active":"\u003cboolean\u003e","metaTitle":"\u003cstring\u003e","metaKeywords":"\u003cstring\u003e","metaDescription":"\u003cstring\u003e","image":{"url":"\u003cstring\u003e"}},{"id":"\u003cinteger\u003e","title":"\u003cstring\u003e","description":"\u003cstring\u003e","url":"\u003cstring\u003e","active":"\u003cboolean\u003e","metaTitle":"\u003cstring\u003e","metaKeywords":"\u003cstring\u003e","metaDescription":"\u003cstring\u003e","image":{"url":"\u003cstring\u003e"}}],"related":["\u003cinteger\u003e","\u003cinteger\u003e"],"extras":[{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","price":"\u003cnumber\u003e"},{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","price":"\u003cnumber\u003e"}],"ebayCondition":"\u003cnumber\u003e","variations":[{"id":"\u003cinteger\u003e","price":"\u003cnumber\u003e","costPrice":"\u003cnumber\u003e","rewardPoints":"\u003cinteger\u003e","sku":"\u003cstring\u003e","weight":"\u003cnumber\u003e","stock":"\u003cinteger\u003e","image":"\u003cinteger\u003e","values":[{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","option":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e"}},{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","option":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e"}}]},{"id":"\u003cinteger\u003e","price":"\u003cnumber\u003e","costPrice":"\u003cnumber\u003e","rewardPoints":"\u003cinteger\u003e","sku":"\u003cstring\u003e","weight":"\u003cnumber\u003e","stock":"\u003cinteger\u003e","image":"\u003cinteger\u003e","values":[{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","option":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e"}},{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","option":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e"}}]}],"choices":[{"id":"\u003cinteger\u003e","set":{"id":"\u003cinteger\u003e"},"value":{"id":"\u003cinteger\u003e"},"customPrice":"\u003cnumber\u003e"},{"id":"\u003cinteger\u003e","set":{"id":"\u003cinteger\u003e"},"value":{"id":"\u003cinteger\u003e"},"customPrice":"\u003cnumber\u003e"}],"customizationFields":[{"id":"\u003cinteger\u003e","label":"\u003cstring\u003e","type":"\u003cinteger\u003e"},{"id":"\u003cinteger\u003e","label":"\u003cstring\u003e","type":"\u003cinteger\u003e"}],"filters":{"1":["\u003cstring\u003e","\u003cstring\u003e"]},"fileUploadsAllowed":"\u003cinteger\u003e","rewardPoints":"\u003cinteger\u003e","preOrder":"\u003cboolean\u003e","customFields":{"custom_field_name_is_key":"\u003cstring\u003e"},"hsCode":"\u003cstring\u003e","options":[{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e"},{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e"}],"digitalFiles":[{"id":"\u003cinteger\u003e"},{"id":"\u003cinteger\u003e"}],"slug":"\u003cstring\u003e"}]