Skip to main content

Get products

Method#

/catalogs#

GET https://api.z-api.io/instances/{{instanceId}}/token/{{instanceToken}}/catalogs

Header#

KeyValue
Client-TokenACCOUNT SECURITY TOKEN

Concept#

With this method you will be able to get the products from a Whatsapp Business catalag

Response#

200#

AttributesTypeDescription
cartEnabledbooleanAttribute to know if your cart is active
availabilitystringAttribute to know product availability
idstringProduct ID
retailerIdbooleanRetailer ID
pricestringProduct price
currencystringCurrency type
namestringProduct type
quantitybooleanProduct quantity attribute
imagesstringProduct image link

Example

{
"cartEnabled": true,
"products": [
{
"availability": "in stock",
"id": "999999999999999",
"retailerId": null,
"price": "100000",
"currency": "BRL",
"name": "Mouse",
"quantity": null,
"images": ["https://"]
}
]
}

405#

In this case certify that you are sending the correct specification of the method. This means, verify if you sent a POST or GET as specified at the beginning of this topic.

415#

In case you receive 415 error, make sure to add the “Content-Type” of the object you are sending in the request headers, mostly “application/json”


Code#