Documentação da API Paylog Documentação da API Paylog API pública v1
Produtos

Consultar produto

Nesta página 7
GET /api/v1/produtos/{id}

Retorna um produto somente quando ele pertence ao produtor autenticado.

Parâmetros

Caminho
id integer Obrigatório

ID interno do produto.

Respostas

200

Produto encontrado.

application/json
object
  • id integer Obrigatório

    ID interno do produto.

  • nome string Obrigatório

    Nome do produto.

  • status integer Obrigatório

    0 pendente ou 1 aprovado.

    Valores permitidos 0 1
  • estoque integer Obrigatório

    Saldo de estoque disponível.

204

Produto inexistente ou não pertencente ao produtor. A resposta não possui corpo.

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

O token é válido, mas a conta não possui a permissão necessária para esta operação. O envelope é gerado pelo tratador global de exceções e usa a chave errors (string), não message.

application/json
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.

500

Falha interna nas rotas legadas de pacotes e produtos. O corpo NÃO é JSON: os controladores devolvem o texto puro Algo deu errado!. Falhas que escapam do catch do controlador (erro fatal de PHP) caem no tratador do framework e devolvem {"message":"Server Error"} em JSON. Trate 500 pelo código HTTP, nunca pelo corpo.

text/plain
string
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.