Retrieve a product list
Retrieve a product list.
Authorizations:Token, JWT
Query Parameters
| page | integerDefault: 1The collection page number |
| itemsPerPage | integer>= 0Default: 30The number of items per page |
| filter.products | stringFilter for "products" field |
| filter.categories | stringFilter for "categories" field |
| filter.outOfStock | booleanFilter for "outOfStock" field |
| filter.bestsellers | booleanFilter for "bestsellers" field |
| filter.participateSale | booleanFilter for "participateSale" field |
| filter.newArrivals | booleanFilter for "newArrivals" field |
| filter.comingSoon | booleanFilter for "comingSoon" field |
| filter.substring | stringFilter for "substring" field |
| order_by.name | stringEnum: "asc""desc" |
| order_by.price | stringEnum: "asc""desc" |
| order_by.arrivalDate | stringEnum: "asc""desc" |
| order_by.sales | stringEnum: "asc""desc" |
| filter.levelId | integer>= 1Filter for "levelId" field |
| filter.brandId | integer>= 1Filter for "brandId" field |
Responses
200Product Compact collection
Response schema:
Product Compact collection Array
| sku | string | ||||||||
| name | string | ||||||||
| cleanUrl | string | ||||||||
| briefDescription | string | ||||||||
| price | number | ||||||||
| requiresShipping | boolean | ||||||||
| arrivalDate | integer | ||||||||
| amount | integer | ||||||||
| images | Array of objects | ||||||||
Array
| |||||||||
| stickers | Array of objects | ||||||||
Array
| |||||||||
| canBeBackordered | boolean | ||||||||
| backorderQtyLabel | string | ||||||||
| isLimitedBackorder | boolean | ||||||||
| backorderLimit | integer | ||||||||
| participateSale | boolean | ||||||||
| discountType | stringEnum: "sale_price""sale_percent" | ||||||||
| saleValue | number | ||||||||
| salePrice | number | ||||||||
| marketPrice | number | ||||||||
| minPurchaseQuantity | integer | ||||||||
| brandName | string | ||||||||
| id | integer>= 0 | ||||||||
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 |