Skip to main content

Retrieve a list of products

Retrieve a list of products.

Authorizations:Token
Query Parameters
pageintegerDefault: 1The collection page number
itemsPerPageinteger>= 0Default: 30The number of items per page
order[name]stringEnum: "asc""desc"
order[price]stringEnum: "asc""desc"
order[arrivalDate]stringEnum: "asc""desc"

Responses

200Product collection
Response schema:
Product collection
Array
og_meta_tagsstring
market_pricenumber
pin_codes_enabledboolean
auto_pin_codesboolean
participate_saleboolean
discount_typestringDefault: "sale_percent"
sale_price_valuenumber
apply_sale_to_wholesaleboolean
available_for_backorderboolean
backorder_limitinteger
cost_pricenumber
fitment_typestringDefault: "regular"
fitmentsArray of strings
stickersArray of integers
facebook_marketing_enabledboolean
google_feed_enabledboolean
tagsArray of objects
Array
idinteger
namestring
idinteger
skustring
namestring
descriptionstring
brief_descriptionstring
meta_tagsstring
meta_descriptionstring
meta_titlestring
pricenumber
enabledboolean
weightnumber
free_shippingboolean
taxableboolean
create_datestring
update_datestring
arrival_datestring
inventory_traceableboolean
amountinteger
product_classobject or null
  • object
idinteger
namestring
tax_classobject or null
  • object
idinteger
namestring
membershipsArray of objects
Array
idinteger
namestring
enabledboolean
clean_urlstring
imagesArray of objects
Array
idinteger
positioninteger
altstring
urlstring
widthinteger
heightinteger