Pular para o conteúdo principal

Criar/editar Produto

Método#

/products#

POST https://api.z-api.io/instances/{{instanceId}}/token/{{instanceToken}}/products

Header#

KeyValue
Client-TokenTOKEN DE SEGURANÇA DA CONTA

Conceituação#

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


Atributos#

Obrigatórios#

AtributosTipoDescrição
currencystringTipo da Moeda
descriptionstringDescrição do produto
imagesstringUrl da imagem do produto
isHiddenbooleanAtributo para "esconder" o produto no catálogo
namestringNome do produto
priceintegerPreço do produto
retailerIdstringId do produto
urlstringUrl da rota do z-api

Request Body#

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

Response#

200#

AtributosTipoDescrição
idstringId do produto

Exemplo

{
"id": "4741575945866725"
}

405#

Neste caso certifique que esteja enviando o corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no inicio 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"


Webhook Response#

Link para a response do webhook (ao receber)

Webhook


Code#