Skip to main content

Retrieve a list of products

Retrieve a list of products

Authorizations:Token, JWT
Query Parameters
pageintegerDefault: 1The collection page number
itemsPerPageinteger[0 .. 100]Default: 30The number of items per page
paginationbooleanEnable or disable pagination
filter.updateDate.rangeobject (Range filter for "updateDate" field)Range filter for "updateDate" field
beginstring or null
endstring or null
order_by.namestringEnum: "asc""desc"Order rule for "name" field
order_by.pricestringEnum: "asc""desc"Order rule for "price" field
order_by.arrivalDatestringEnum: "asc""desc"Order rule for "arrivalDate" field

Responses

200Product collection
Response schema:
Product collection
Array
skustring[1 .. 32] characters
namestring[1 .. 255] characters
descriptionstring
brief_descriptionstring
meta_tagsstring
meta_descriptionstring
meta_titlestring
pricenumber
manualPricenumber
enabledbooleanDefault: true
weightnumber
separate_boxboolean
widthnumber
lengthnumber
heightnumber
shippablebooleanDefault: true
taxablebooleanDefault: true
create_dateobject or null
  • object
  • null
update_dateobject or null
  • object
  • null
arrival_dateobject or null
  • object
  • null
inventory_traceablebooleanDefault: true
amountinteger
availableAmountinteger
clean_urlstring
membershipsArray of integers
tax_classinteger
product_classinteger
imagesArray of objects
Array
positioninteger
altstring
urlstring
widthinteger
heightinteger
idinteger>= 1
facebook_marketing_enabledbooleanDefault: true
fitment_typestringEnum: "regular""universal""specific"
fitmentsArray of objects
Array
level1string
level2string
level3string
level4string
notesstring
costPricenumber
minPurchaseQuantityinteger
applySaleToWholesaleboolean
wholesalePricesArray of objects
Array
quantityRangeBegininteger
quantityRangeEndinteger
typestringEnum: "price""percent"
valuenumber
upcstring
mnfstring
stickersArray of objects
Array
labelstring
textColorstring
bgColorstring
market_pricenumber
tagsArray of objects
Array
idinteger
namestring
google_feed_enabledbooleanDefault: true
participate_saleboolean
discount_typestringDefault: "sale_percent"Enum: "sale_price""sale_percent"
sale_price_valuenumber
variation_basesArray of objects
Array
namestring
isDefaultboolean
mainVariationPositioninteger
idinteger>= 1
og_meta_tagsstring
useCustomOGboolean
idinteger>= 1
401Unauthorized
Response schema:
Unauthorized
typestringExample: "https://tools.ietf.org/html/rfc2616#section-10"
titlestringExample: "An error occurred"
detailstring or nullExample: "Cannot find entity"
instancestring or null
500Internal error
Response schema:
Internal error
typestringExample: "https://tools.ietf.org/html/rfc2616#section-10"
titlestringExample: "An error occurred"
detailstring or nullExample: "Cannot find entity"
instancestring or null