Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
products
Criar/editar produto
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/products \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "price": 123,
  "currency": "<string>",
  "description": "<string>",
  "images": [
    {}
  ]
}
'
{
  "id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Nesse método você será capaz de cadastrar e atualizar um produto no seu catálogo.

​
Atributos

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Obrigatórios

​
name
string
obrigatório
Nome do produto
​
price
integer
obrigatório
Preço do produto
​
currency
string
obrigatório
Tipo de moeda (ex: BRL)
​
description
string
obrigatório
Descrição do produto
​
images
array
obrigatório
URLs das imagens do produto

​
Opcionais

​
isHidden
boolean
Ocultar produto no catálogo
​
salePrice
integer
Preço promocional
​
retailerId
string
ID do produto
​
url
string
URL do produto

​
Request Body

{
  "currency": "BRL",
  "description": "Uma descrição do produto",
  "images": ["https://avatars.githubusercontent.com/u/60630101?s=200&v=4"],
  "isHidden": false,
  "name": "Meu primeiro produto",
  "price": 20,
  "salePrice": 18,
  "retailerId": "002",
  "url": "https://z-api.io"
}

​
Response

​
200

​
id
string
ID do produto criado/atualizado
{
  "id": "4741575945866725"
}

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.