Retrieve a list of products
Retrieve a list of products.
Authorizations:Token, JWT
Query Parameters
page | integerDefault: 1 The collection page number |
order[name] | stringEnum: "asc" "desc" |
order[price] | stringEnum: "asc" "desc" |
order[arrivalDate] | stringEnum: "asc" "desc" |
vendor.profile_id | integer |
vendor.profile_id[] | Array of integers |
exists[vendor] | boolean |
Responses
200Product collection
Response schema:
Product collection Array
og_meta_tags | string | ||||||||||||
market_price | number | ||||||||||||
pin_codes_enabled | boolean | ||||||||||||
auto_pin_codes | boolean | ||||||||||||
participate_sale | boolean | ||||||||||||
discount_type | stringDefault: "sale_percent" Enum: "sale_price" "sale_percent" | ||||||||||||
sale_price_value | number | ||||||||||||
apply_sale_to_wholesale | boolean | ||||||||||||
available_for_backorder | boolean | ||||||||||||
backorder_limit | integer | ||||||||||||
cost_price | number | ||||||||||||
stickers | Array of integers | ||||||||||||
facebook_marketing_enabled | boolean | ||||||||||||
google_feed_enabled | boolean | ||||||||||||
vendor_id | integer | ||||||||||||
tags | Array of objects | ||||||||||||
Array
| |||||||||||||
id | integer | ||||||||||||
sku | string | ||||||||||||
name | string | ||||||||||||
description | string | ||||||||||||
brief_description | string | ||||||||||||
meta_tags | string | ||||||||||||
meta_description | string | ||||||||||||
meta_title | string | ||||||||||||
price | number | ||||||||||||
enabled | boolean | ||||||||||||
weight | number | ||||||||||||
separate_box | boolean | ||||||||||||
width | number | ||||||||||||
length | number | ||||||||||||
height | number | ||||||||||||
free_shipping | boolean | ||||||||||||
taxable | boolean | ||||||||||||
create_date | string | ||||||||||||
update_date | string | ||||||||||||
arrival_date | string | ||||||||||||
inventory_traceable | boolean | ||||||||||||
amount | integer | ||||||||||||
product_class | object or null | ||||||||||||
| |||||||||||||
tax_class | object or null | ||||||||||||
| |||||||||||||
memberships | Array of objects | ||||||||||||
Array
| |||||||||||||
clean_url | string | ||||||||||||
images | Array of objects | ||||||||||||
Array
|
401Unauthorized
Response schema:
Unauthorized type | string |
title | string |
detail | string or null |
instance | string or null |
500Internal error
Response schema:
Internal error type | string |
title | string |
detail | string or null |
instance | string or null |