Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{instanceToken}
/
catalogs
/
{phone}
Listar catálogo por número
curl --request GET \
  --url https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/catalogs/{phone} \
  --header 'Client-Token: <api-key>'
[
  {
    "availability": "in stock",
    "id": "4741575945866725",
    "retailerId": "SKU-002",
    "description": "Meu primeiro produto",
    "price": "2000",
    "salePrice": "1800",
    "currency": "BRL",
    "name": "Produto exemplo",
    "quantity": null,
    "images": [
      "https://cdn.example.com/product.png"
    ]
  }
]
Lista os produtos do catálogo de uma conta Business específica.
Aliases consolidados da collection: Pegar produtos pelo telefone.

Authorizations

Client-Token
string
header
required

Path Parameters

instanceId
string
required

Identificador único da instância.

Example:

"abc1234567890"

instanceToken
string
required

Token privado da instância retornado na criação.

Example:

"tok_a1b2c3d4e5f6"

phone
string
required

Número no formato internacional, sem +, espaços ou pontuação.

Example:

"5511999999999"

Response

Resposta de sucesso.

availability
string
required
Example:

"in stock"

id
string
required
Example:

"4741575945866725"

retailerId
string
required
Example:

"SKU-002"

description
string
required
Example:

"Meu primeiro produto"

price
string
required
Example:

"2000"

salePrice
string
required
Example:

"1800"

currency
string
required
Example:

"BRL"

name
string
required
Example:

"Produto exemplo"

quantity
unknown
required
images
string[]
required
Example:
["https://cdn.example.com/product.png"]
Example:
[
{
"availability": "in stock",
"id": "4741575945866725",
"retailerId": "SKU-002",
"description": "Meu primeiro produto",
"price": "2000",
"salePrice": "1800",
"currency": "BRL",
"name": "Produto exemplo",
"quantity": null,
"images": ["https://cdn.example.com/product.png"]
}
]