Qodex.ai

Get all products

GET https://api.ecartapi.com/api/v2/products

Request used to obtain all the products in a store catalog.

Find a general representation of all the filters and information EcartAPI can abet.

For more detailed information please refer to our Supported Requests By Cart folder and find the eCommerce of your choice.

Request Params

KeyDatatypeRequiredDescription
limitstringDefault 50. Quantity of documents to be returned in the response.
pagestringAllows iteration through the results
sortstringDefault desc. Order of the results returned.
sortBystringDefault createdAt. The response will be sorted based on the key chosen.
idsstringSend a list of id's separated by commas.
skustringFilter results by sku.
sinceIdstringFilter results to be returned only after certain ID.
namestringFilter results based of the item's name.
productTypestringFilter results based of the product's type.
categoryIdstringFilter results based of the category they are in.
createdAt[from]stringFilter items by date of creation.
createdAt[to]stringFilter items between their creation date range. createdAt[from]Required
updatedAt[from]stringFilter items by date last update.
updatedAt[to]stringFilter items between a date range. updatedAt[from]Required
status[visibility]stringFilter items by their visibility status.
status[active]stringFilter items by their inventory availability status.
status[status]stringFilter items by the current status of the product.
price[min]stringFilter items based on the minimum price.
price[max]stringFilter items based on the max price.
searchTypestringGeneral search on the resource.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"success":true,"products":[{"id":"7096605671601","sku":"SKU002","name":"Ecartapi shirt","subName":null,"upc":null,"description":"Update test for v3","currency":"MXN","productType":null,"quantity":"92","price":"100.00","cost":null,"discount":null,"dimensions":{"width":null,"height":null,"length":null,"weight":"1"},"units":{"width":null,"height":null,"length":null,"weight":"kg"},"category":{"id":null,"name":null,"all":[]},"tags":[],"status":{"id":null,"visibility":"web","active":"true","status":"active","ecartapiId":"1","ecartapi":"active"},"variants":[{"id":"41293246628017","productId":"7096605671601","barcode":null,"name":"Default Title","price":"100.00","currency":null,"sku":"SKU002","fulfillmentService":"manual","option1":"Default Title","option2":null,"option3":null,"dimensions":{"width":null,"height":null,"length":null,"weight":"1"},"units":{"width":null,"height":null,"length":null,"weight":"kg"},"inventory":{"itemId":"43384579915953","quantity":"92"},"requireShipping":"true","bundled":"false","imageId":null,"dates":{"createdAt":"2022-01-13T13:22:39-05:00","updatedAt":"2022-07-28T12:49:25-04:00"},"ecartapiUrl":"https://api.ecartapi.com/api/v2/products/7096605671601/variants/41293246628017","countryCodeOrigin":null,"provinceCodeOrigin":null,"harmonizedSystemCode":null,"countryHarmonizedSystemCode":null}],"options":[{"id":"9099588370609","name":"Title","values":["Default Title"]}],"associatedItems":[],"images":[],"imageUrl":null,"condition":null,"link":"https://ecart-test1.myshopify.com/products/api-testing-product","dates":{"createdAt":"2022-01-13T13:22:39-05:00","updatedAt":"2022-07-28T12:50:43-04:00"},"vendor":"ecart-test1","sellOutStock":null},{"id":"5848116723889","sku":"kikud-11111","name":"Hola","subName":null,"upc":null,"description":"Hello","currency":"MXN","productType":null,"quantity":"1797","price":"299.00","cost":null,"discount":null,"dimensions":{"width":null,"height":null,"length":null,"weight":"2"},"units":{"width":null,"height":null,"length":null,"weight":"kg"},"category":{"id":null,"name":null,"all":[]},"tags":[],"status":{"id":null,"visibility":"web","active":"true","status":"active","ecartapiId":"1","ecartapi":"active"},"variants":[{"id":"36947703955633","productId":"5848116723889","barcode":null,"name":"S / RED","price":"299.00","currency":null,"sku":"kikud-11111","fulfillmentService":"manual","option1":"S","option2":"RED","option3":null,"dimensions":{"width":null,"height":null,"length":null,"weight":"2"},"units":{"width":null,"height":null,"length":null,"weight":"kg"},"inventory":{"itemId":"39040493224113","quantity":"999"},"requireShipping":"true","bundled":"false","imageId":"20805579243697","dates":{"createdAt":"2020-10-09T19:26:28-04:00","updatedAt":"2022-08-02T18:20:47-04:00"},"ecartapiUrl":"https://api.ecartapi.com/api/v2/products/5848116723889/variants/36947703955633","countryCodeOrigin":null,"provinceCodeOrigin":null,"harmonizedSystemCode":null,"countryHarmonizedSystemCode":null},{"id":"36947703988401","productId":"5848116723889","barcode":null,"name":"S / BLUE","price":"300.00","currency":null,"sku":"kikud-2","fulfillmentService":"manual","option1":"S","option2":"BLUE","option3":null,"dimensions":{"width":null,"height":null,"length":null,"weight":"2"},"units":{"width":null,"height":null,"length":null,"weight":"kg"},"inventory":{"itemId":"39040493256881","quantity":"598"},"requireShipping":"true","bundled":"false","imageId":"20805579145393","dates":{"createdAt":"2020-10-09T19:26:28-04:00","updatedAt":"2021-08-25T20:45:01-04:00"},"ecartapiUrl":"https://api.ecartapi.com/api/v2/products/5848116723889/variants/36947703988401","countryCodeOrigin":null,"provinceCodeOrigin":null,"harmonizedSystemCode":null,"countryHarmonizedSystemCode":null},{"id":"36947704021169","productId":"5848116723889","barcode":null,"name":"M / RED","price":"400.00","currency":null,"sku":"kikud-3","fulfillmentService":"manual","option1":"M","option2":"RED","option3":null,"dimensions":{"width":null,"height":null,"length":null,"weight":"2"},"units":{"width":null,"height":null,"length":null,"weight":"kg"},"inventory":{"itemId":"39040493289649","quantity":"100"},"requireShipping":"true","bundled":"false","imageId":"20805579178161","dates":{"createdAt":"2020-10-09T19:26:28-04:00","updatedAt":"2021-02-02T13:48:26-05:00"},"ecartapiUrl":"https://api.ecartapi.com/api/v2/products/5848116723889/variants/36947704021169","countryCodeOrigin":null,"provinceCodeOrigin":null,"harmonizedSystemCode":null,"countryHarmonizedSystemCode":null},{"id":"36947704053937","productId":"5848116723889","barcode":null,"name":"M / BLUE","price":"200.00","currency":null,"sku":"kikud-4","fulfillmentService":"manual","option1":"M","option2":"BLUE","option3":null,"dimensions":{"width":null,"height":null,"length":null,"weight":"2"},"units":{"width":null,"height":null,"length":null,"weight":"kg"},"inventory":{"itemId":"39040493322417","quantity":"100"},"requireShipping":"true","bundled":"false","imageId":"20805579210929","dates":{"createdAt":"2020-10-09T19:26:28-04:00","updatedAt":"2021-02-02T13:48:25-05:00"},"ecartapiUrl":"https://api.ecartapi.com/api/v2/products/5848116723889/variants/36947704053937","countryCodeOrigin":null,"provinceCodeOrigin":null,"harmonizedSystemCode":null,"countryHarmonizedSystemCode":null}],"options":[{"id":"7427346989233","name":"Size","values":["S","M"]},{"id":"7427347022001","name":"Color","values":["RED","BLUE"]}],"associatedItems":[],"images":[{"id":"20805579145393","url":"https://cdn.shopify.com/s/files/1/0469/3694/8913/products/300_250_b_esp.gif?v=1602286008","variantIds":[36947703988401],"ecartapiUrl":"https://api.ecartapi.com/api/v2/products/5848116723889/images/20805579145393"},{"id":"20805579178161","url":"https://cdn.shopify.com/s/files/1/0469/3694/8913/products/300_250_c_esp.gif?v=1602286008","variantIds":[36947704021169],"ecartapiUrl":"https://api.ecartapi.com/api/v2/products/5848116723889/images/20805579178161"},{"id":"20805579210929","url":"https://cdn.shopify.com/s/files/1/0469/3694/8913/products/300x250_mx.gif?v=1602286017","variantIds":[36947704053937],"ecartapiUrl":"https://api.ecartapi.com/api/v2/products/5848116723889/images/20805579210929"},{"id":"20805579243697","url":"https://cdn.shopify.com/s/files/1/0469/3694/8913/products/930X180.gif?v=1602286028","variantIds":[36947703955633],"ecartapiUrl":"https://api.ecartapi.com/api/v2/products/5848116723889/images/20805579243697"}],"imageUrl":"https://cdn.shopify.com/s/files/1/0469/3694/8913/products/300_250_b_esp.gif?v=1602286008","condition":null,"link":"https://ecart-test1.myshopify.com/products/hola","dates":{"createdAt":"2020-10-09T19:26:27-04:00","updatedAt":"2022-08-02T18:20:47-04:00"},"vendor":"ecart-test1","sellOutStock":null}],"page":{"next":"eyJwdWJsaXNoZWRfc3RhdHVzIjoiYW55IiwibGFzdF9pZCI6NTg0ODExNjcyMzg4OSwibGFzdF92YWx1ZSI6IkhvbGEiLCJkaXJlY3Rpb24iOiJuZXh0In0","previous":null}}