Retrieve a list of products

Retrieve a list of products

Authorizations:Token, JWT

Query Parameters

page	integerDefault: 1The collection page number
itemsPerPage	integer[0 .. 100]Default: 30The number of items per page
pagination	booleanEnable or disable pagination
filter.updateDate.range	object (Range filter for "updateDate" field)Range filter for "updateDate" field
begin string or null end string or null
order_by.name	stringEnum: "asc""desc"Order rule for "name" field
order_by.price	stringEnum: "asc""desc"Order rule for "price" field
order_by.arrivalDate	stringEnum: "asc""desc"Order rule for "arrivalDate" field

Responses

200Product collection

Response schema: application/jsonapplication/ld+json

Product collection

Array

sku	string[1 .. 32] characters
name	string[1 .. 255] characters
description	string
brief_description	string
meta_tags	string
meta_description	string
meta_title	string
price	number
manualPrice	number
enabled	booleanDefault: true
weight	number
separate_box	boolean
width	number
length	number
height	number
shippable	booleanDefault: true
taxable	booleanDefault: true
create_date	object or null
object null
update_date	object or null
object null
arrival_date	object or null
object null
inventory_traceable	booleanDefault: true
amount	integer
availableAmount	integer
clean_url	string
memberships	Array of integers
tax_class	integer
product_class	integer
images	Array of objects
Array position integer alt string url string width integer height integer id integer>= 1
facebook_marketing_enabled	booleanDefault: true
fitment_type	stringEnum: "regular""universal""specific"
fitments	Array of objects
Array level1 string level2 string level3 string level4 string notes string
costPrice	number
minPurchaseQuantity	integer
applySaleToWholesale	boolean
wholesalePrices	Array of objects
Array quantityRangeBegin integer quantityRangeEnd integer type stringEnum: "price""percent" value number
upc	string
mnf	string
stickers	Array of objects
Array label string textColor string bgColor string
market_price	number
tags	Array of objects
Array id integer name string
google_feed_enabled	booleanDefault: true
participate_sale	boolean
discount_type	stringDefault: "sale_percent"Enum: "sale_price""sale_percent"
sale_price_value	number
variation_bases	Array of objects
Array name string isDefault boolean mainVariationPosition integer id integer>= 1
og_meta_tags	string
useCustomOG	boolean
id	integer>= 1

401Unauthorized

Response schema: application/jsonapplication/ld+jsonapplication/vnd.api+jsontext/html

Unauthorized

type	stringExample: "https://tools.ietf.org/html/rfc2616#section-10"
title	stringExample: "An error occurred"
detail	string or nullExample: "Cannot find entity"
instance	string or null

500Internal error

Response schema: application/jsonapplication/ld+jsonapplication/vnd.api+jsontext/html

Internal error

type	stringExample: "https://tools.ietf.org/html/rfc2616#section-10"
title	stringExample: "An error occurred"
detail	string or nullExample: "Cannot find entity"
instance	string or null