Get all products
GET https://api.ecartapi.com/api/v2/products
Returns a list of Products. Optional filter parameters can be passed in.
More information about the ecommerce's resource.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
sku | string | The product sku to return. | |
limit | string | Default value: 50. The maximum number of products returned in the response | |
page | string | Index of page of results to be returned. | |
productType | string | The type of product you want to search for. | |
searchType | string | Keyword to filter products by. | |
createdAt[from] | string | Filter orders by range. Requires createdAt[to]. Set the lower treshold. | |
createdAt[to] | string | Filter orders by range. Requires createdAt[from]. Set the upper treshold. | |
status[visibility] | string | Product visibility status. | |
sort | string | Default: desc. Sort direction. Acceptable values: asc or desc | |
sortBy | string | Value that will be sorted. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"success":true,"products":[{"id":"315","sku":"Green","name":"Green","subName":null,"upc":null,"description":"\u003cp\u003e\u003cspan style=\"text-align: inherit; font-size: 18px;\"\u003e\u003cfont color=\"#262626\"\u003eProduct description.\u003c/font\u003e\u003c/span\u003e\u003cbr\u003e\u003c/p\u003e","currency":"AED","productType":"physical","quantity":null,"price":"549","cost":null,"discount":null,"dimensions":{"width":null,"height":null,"length":null,"weight":null},"units":{"width":"cm","height":"cm","length":"cm","weight":"kg"},"category":{"id":"27","name":null,"all":[{"id":"27"}]},"tags":[],"status":{"id":null,"visibility":"true","active":null,"status":"available","ecartapiId":"1","ecartapi":"active"},"variants":[],"options":[],"associatedItems":[],"images":[],"imageUrl":null,"condition":"New","link":"https://store_url.me/products/green","dates":{"createdAt":"2022-08-24T06:48:09+00:00","updatedAt":"2022-09-10T09:36:39+00:00"},"vendor":null,"sellOutStock":null,"internationalShipment":null},{"id":"314","sku":"Blue","name":"Blue","subName":null,"upc":null,"description":"\u003cp\u003e\u003cspan style=\"text-align: inherit; font-size: 18px;\"\u003e\u003cfont color=\"#262626\"\u003eDescription of product\u003c/font\u003e\u003c/span\u003e\u003cbr\u003e\u003c/p\u003e","currency":"AED","productType":"physical","quantity":null,"price":"549","cost":null,"discount":null,"dimensions":{"width":null,"height":null,"length":null,"weight":null},"units":{"width":"cm","height":"cm","length":"cm","weight":"kg"},"category":{"id":"27","name":null,"all":[{"id":"27"}]},"tags":[],"status":{"id":null,"visibility":"true","active":null,"status":"available","ecartapiId":"1","ecartapi":"active"},"variants":[],"options":[],"associatedItems":[],"images":[],"imageUrl":null,"condition":"New","link":"https://store_url.me/products/blue","dates":{"createdAt":"2022-08-24T06:47:39+00:00","updatedAt":"2022-09-13T07:42:11+00:00"},"vendor":null,"sellOutStock":null,"internationalShipment":null}]}