VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Guia rápido/Clientes

Cliente por CNPJ (modo específico)

As rotas GET, PUT e DELETE em /customer e /customers, que só existem num modo de compatibilidade específico.

O caminho /api/v1.0/customers (e o singular /api/v1.0/customer) tem em lojas comuns uma única operação: o POST de Sincronização por CNPJ. Os métodos GET, PUT e DELETE do mesmo caminho fazem parte do contrato da Venddor 1.0 e só são ligados em lojas com um modo de compatibilidade específico.

Em lojas comuns, 404

Quem chama estas rotas numa loja comum recebe 404 com o texto 404 page not found. Para listar ou consultar clientes use Listar clientes e Consultar cliente; para alterar, Atualizar cliente; para excluir, Excluir cliente.

GET/api/v1.0/customerAdmin

Consultar cliente (indisponível)

Rota do contrato da Venddor 1.0 que só existe em lojas com um modo de compatibilidade específico ligado. Nas demais, responde 404 com o texto 404 page not found, como qualquer rota que não existe.

PUT/api/v1.0/customerAdmin

Atualizar cliente (indisponível)

Rota do contrato da Venddor 1.0 que só existe em lojas com um modo de compatibilidade específico ligado. Nas demais, responde 404 com o texto 404 page not found, como qualquer rota que não existe.

DELETE/api/v1.0/customerAdmin

Excluir cliente (indisponível)

Rota do contrato da Venddor 1.0 que só existe em lojas com um modo de compatibilidade específico ligado. Nas demais, responde 404 com o texto 404 page not found, como qualquer rota que não existe.

GET/api/v1.0/customersAdmin

Consultar cliente (indisponível)

Rota do contrato da Venddor 1.0 que só existe em lojas com um modo de compatibilidade específico ligado. Nas demais, responde 404 com o texto 404 page not found, como qualquer rota que não existe.

PUT/api/v1.0/customersAdmin

Atualizar cliente (indisponível)

Rota do contrato da Venddor 1.0 que só existe em lojas com um modo de compatibilidade específico ligado. Nas demais, responde 404 com o texto 404 page not found, como qualquer rota que não existe.

DELETE/api/v1.0/customersAdmin

Excluir cliente (indisponível)

Rota do contrato da Venddor 1.0 que só existe em lojas com um modo de compatibilidade específico ligado. Nas demais, responde 404 com o texto 404 page not found, como qualquer rota que não existe.

Erros

StatusQuandoCorpo de exemplo
401Sem credencial, com o modo ligado.{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}
403Credencial de quem não é administrador, com o modo ligado.{"message":"Forbidden: admin scope required","status":403}
404Loja sem o modo de compatibilidade.404 page not found

Veja também

  • Sincronização por CNPJ
  • Listar clientes
  • Atualizar cliente
Anterior
Clientes por token de app
Próxima
Rotas sem versão
Nesta página
  • Erros
  • Veja também