Atualizar produto

PATCH /api/v1/produtos/{id}

Atualiza somente os campos enviados de um produto do produtor autenticado. Exige a permissão criar_produtos_api. Todos os campos são opcionais, mas ao menos um precisa ser enviado — um corpo vazio retorna 422. codigo_plataforma, status, user_id, estoque e as chaves fiscais (tipo_emissao, notazz_product_code, emite_nota_fiscal, nicho_id) são imutáveis aqui e recusados com 422. A edição de peso e dimensões é permitida mesmo em produto já aprovado: corrigir um peso enviado em gramas é um fluxo esperado. Um produto inexistente ou de outro produtor recebe a MESMA resposta 404, sem revelar a existência.

PATCH Requisição

bash

curl -X PATCH "https://ev.paylog.cash/api/v1/produtos/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "nome": "string",
    "tipo_produto": 1,
    "peso_unitario": 0,
    "comprimento": 0,
    "largura": 0,
    "altura": 0,
    "gtin": "string",
    "ean": "string",
    "product_barcode": "string",
    "site_oficial": "https://example.com"
  }'

php

use Illuminate\Support\Facades\Http;

$response = Http::withToken('YOUR_TOKEN')
    ->acceptJson()
    ->patch('https://ev.paylog.cash/api/v1/produtos/{id}', [
    'nome' => 'string',
    'tipo_produto' => 1,
    'peso_unitario' => 0,
    'comprimento' => 0,
    'largura' => 0,
    'altura' => 0,
    'gtin' => 'string',
    'ean' => 'string',
    'product_barcode' => 'string',
    'site_oficial' => 'https://example.com'
  ]);

javascript

const response = await fetch("https://ev.paylog.cash/api/v1/produtos/{id}", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "nome": "string",
    "tipo_produto": 1,
    "peso_unitario": 0,
    "comprimento": 0,
    "largura": 0,
    "altura": 0,
    "gtin": "string",
    "ean": "string",
    "product_barcode": "string",
    "site_oficial": "https://example.com"
  }),
});

python

import requests

response = requests.patch(
    "https://ev.paylog.cash/api/v1/produtos/{id}",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
    "nome": "string",
    "tipo_produto": 1,
    "peso_unitario": 0,
    "comprimento": 0,
    "largura": 0,
    "altura": 0,
    "gtin": "string",
    "ean": "string",
    "product_barcode": "string",
    "site_oficial": "https://example.com"
  },
)

ruby

require "net/http"
require "json"
require "uri"

uri = URI("https://ev.paylog.cash/api/v1/produtos/{id}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer YOUR_TOKEN"
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = {
  "nome" => "string",
  "tipo_produto" => 1,
  "peso_unitario" => 0,
  "comprimento" => 0,
  "largura" => 0,
  "altura" => 0,
  "gtin" => "string",
  "ean" => "string",
  "product_barcode" => "string",
  "site_oficial" => "https://example.com"
}.to_json

response = http.request(request)

200 Resposta

json

{
  "code": 0,
  "message": "string",
  "produto": {
    "id": 0,
    "nome": "string",
    "codigo_plataforma": "string",
    "tipo_produto": 1,
    "peso_unitario": 0,
    "comprimento": 0,
    "largura": 0,
    "altura": 0,
    "gtin": "string",
    "ean": "string",
    "product_barcode": "string",
    "site_oficial": "string",
    "status": 0,
    "status_label": "Pendente",
    "created_at": "2024-01-01T00:00:00Z"
  }
}

Parâmetros

Caminho

id integer Obrigatório: ID interno do produto.

Corpo da requisição

application/json

object

Atualização parcial. Todos os campos são opcionais, mas ao menos um precisa ser enviado. codigo_plataforma, status, user_id, estoque e as chaves fiscais são imutáveis aqui e recusados com 422. Peso e dimensões podem ser corrigidos mesmo em produto já aprovado.

nome string

Opcional. Nome do produto.
tipo_produto integer

Opcional. Código do tipo do produto.

Valores permitidos 1 2 3 5 6 7 8 9 10 11 12
peso_unitario number

Opcional. Peso de uma unidade em quilogramas, de 0.001 a 30.
comprimento number

Opcional. Comprimento em centímetros.
largura number

Opcional. Largura em centímetros.
altura number

Opcional. Altura em centímetros.
gtin string aceita nulo

Opcional. GTIN do produto.
ean string aceita nulo

Opcional. EAN do produto.
product_barcode string aceita nulo

Opcional. Código de barras interno.
site_oficial string uri aceita nulo

Opcional. URL válida da página do produto.

Respostas

200

Produto atualizado.

application/json

object

Envelope de PATCH /api/v1/produtos/{id}.

code integer Obrigatório
message string Obrigatório
produto object Obrigatório
Produto devolvido por POST /api/v1/produtos e PATCH /api/v1/produtos/{id}, dentro da chave produto. Não inclui estoque, preço nem campos fiscais.
- id integer Obrigatório
  
  ID interno do produto.
- nome string Obrigatório
  
  Nome do produto.
- codigo_plataforma string Obrigatório
  
  SKU do produto, único por produtor.
- tipo_produto integer Obrigatório
  
  Código do tipo do produto.
  
  Valores permitidos 1 2 3 5 6 7 8 9 10 11 12
- peso_unitario number Obrigatório
  
  Peso de uma unidade em quilogramas.
- comprimento number Obrigatório
  
  Comprimento da embalagem em centímetros.
- largura number Obrigatório
  
  Largura da embalagem em centímetros.
- altura number Obrigatório
  
  Altura da embalagem em centímetros.
- gtin string aceita nulo Obrigatório
  
  GTIN quando informado.
- ean string aceita nulo Obrigatório
  
  EAN quando informado.
- product_barcode string aceita nulo Obrigatório
  
  Código de barras interno quando informado.
- site_oficial string aceita nulo Obrigatório
  
  URL da página do produto quando informada.
- status integer Obrigatório
  
  0 pendente, 1 aprovado ou 2 desabilitado. Definido pela Paylog.
  
  Valores permitidos 0 1 2
- status_label string Obrigatório
  
  Rótulo legível do status.
  
  Valores permitidos Pendente Aprovado Desabilitado
- created_at string date-time Obrigatório
  
  Data e hora da criação, em ISO 8601.

401

Token Bearer ausente ou inválido.

application/json

object

Mensagem de erro ou informação. Alguns erros legados omitem code.

code integer

Código numérico quando fornecido pelo endpoint.
message string

Mensagem legível.

403

Duas causas distintas com o mesmo status. Token sem a permissão criar_produtos_api usa o envelope do tratador global (errors + code). Token válido e com a permissão, mas de uma conta que não é um produtor ativo, usa o envelope da FormRequest (message).

application/json

mixed

Uma das opções

object

Envelope produzido pelo tratador global de exceções para falhas HTTP que não são geradas pelos controladores — principalmente 403 (permissão ausente) e 405 (verbo não suportado). Difere dos erros dos controladores por usar errors no lugar de message.

errors string Obrigatório

Mensagem da exceção HTTP.
code integer Obrigatório

Código HTTP repetido no corpo.

object

Mensagem de erro ou informação. Alguns erros legados omitem code.

code integer

Código numérico quando fornecido pelo endpoint.
message string

Mensagem legível.

404

Produto inexistente ou pertencente a outro produtor. A resposta é a MESMA nos dois casos — a existência do produto em outra conta nunca é revelada.

application/json

object

Mensagem de erro ou informação. Alguns erros legados omitem code.

code integer

Código numérico quando fornecido pelo endpoint.
message string

Mensagem legível.

422

Campo obrigatório ausente, valor fora das faixas, tipo_produto inexistente, chave recusada (status, user_id, estoque ou chave fiscal) ou corpo vazio no PATCH — neste último caso o erro vem na chave produto, não em um campo.

application/json

object

code integer

Código legado do erro, normalmente 400.
message string Obrigatório

Resumo do erro de validação.
erros object

Erros por campo retornados pelos endpoints legados.
errors object

Erros por campo retornados por validadores no formato atual.

500

Falha inesperada ao atualizar o produto.

application/json

object

Mensagem de erro ou informação. Alguns erros legados omitem code.

code integer

Código numérico quando fornecido pelo endpoint.
message string

Mensagem legível.