Retrieve a list of products
Retrieve a list of products
Authorizations:Token, JWT
Query Parameters
page | integerDefault: 1 The collection page number | ||||
itemsPerPage | integer[0 .. 100]Default: 30 The number of items per page | ||||
pagination | booleanEnable or disable pagination | ||||
filter.updateDate.range | object (Range filter for "updateDate" field)Range filter for "updateDate" field | ||||
| |||||
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:
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 | ||||||||||||
| |||||||||||||
update_date | object or null | ||||||||||||
| |||||||||||||
arrival_date | object or 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
| |||||||||||||
facebook_marketing_enabled | booleanDefault: true | ||||||||||||
fitment_type | stringEnum: "regular" "universal" "specific" | ||||||||||||
fitments | Array of objects | ||||||||||||
Array
| |||||||||||||
costPrice | number | ||||||||||||
minPurchaseQuantity | integer | ||||||||||||
applySaleToWholesale | boolean | ||||||||||||
wholesalePrices | Array of objects | ||||||||||||
Array
| |||||||||||||
upc | string | ||||||||||||
mnf | string | ||||||||||||
stickers | Array of objects | ||||||||||||
Array
| |||||||||||||
market_price | number | ||||||||||||
tags | Array of objects | ||||||||||||
Array
| |||||||||||||
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
| |||||||||||||
og_meta_tags | string | ||||||||||||
useCustomOG | boolean | ||||||||||||
id | integer>= 1 |
401Unauthorized
Response schema:
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:
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 |