top of page

Início > Opção de entrega - Associação cliente

Versão: 2.0

Opção de entrega - Associação cliente

Última Atualização: 20/05/2024

Esta integração cria uma associação entre os clientes e as opções de entrega, criando um vínculo entre eles para que os clientes possam ter opções de entrega.

Sintaxe da Resposta

Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:

Elementos da Resposta

detail

Detalhes da requisição.

Tipo: JSON.

success

Identificador booleano de sucesso da requisição.

Tipo: Boolean.

mensagem

Mensagem de sucesso ou falha da requisição.

Tipo: String.

data

Detalhes da requisição.

Tipo: JSON.

cnpj

CNPJ do cliente.

Tipo: String.

Grupo de entrega

Nome do grupo de entrega.

Tipo: String.

Codigo no fornecedor

Código da opção de entrega no fornecedor.

Tipo: Integer.

GET Opção de entrega - Associação Cliente

Última Atualização: 14/05/2024

Este endpoint irá exibir a opções de entrega que estão sendo utilizadas pelo fornecedor.

Endpoint GET

Sintaxe da Requisição

Para que a requisição do método Post seja bem-sucedida, é necessário que

seja enviado os seguintes valores dentro de um JSON:

Elementos da Requisição

cnpj_cliente*

CNPJ do cliente.

Tipo: String.

codigo_no_fornecedor*

Código da opção de entrega no fornecedor.

Tipo: String.

Sintaxe da Resposta

Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:

Elementos da Resposta

detail

Detalhes da requisição.

Tipo: JSON.

success

Identificador booleano de sucesso da requisição.

Tipo: Boolean.

mensagem

Mensagem de sucesso ou falha da requisição.

Tipo: String.

data

Dados de retorno da requisição.

Tipo: JSON.

Respostas para erros

Caso ocorra algum erro durante a requisição, os possíveis erros são:

500 Internal Server Error

Caso seja adicionado um cliente não cadastrado ou Json invalido.

500 Internal Server Error

Caso seja passado algum código fornecedor inexistente

POST Opção de entrega - Associação Cliente

Última Atualização: 14/05/2024

Este endpoint víncula um cliente a uma opção de entrega.

Endpoint POST

DELETE Opção de entrega - Associação Cliente

Última Atualização: 14/05/2024

Este endpoint irá remover vínculos entre clientes e opções de entrega.

Endpoint DELETE

Sintaxe da Requisição

Para que a requisição do método Delete seja bem-sucedida, é necessário que

seja enviado os seguintes valores dentro de um JSON:

Elementos da Requisição

cnpj_cliente*

CNPJ do cliente.

Tipo: String.

codigo_no_fornecedor*

Código da opção de entrega no fornecedor.

Tipo: String.

Sintaxe da Resposta

Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:

Elementos da Resposta

detail

Detalhes da requisição.

Tipo: JSON.

success

Identificador booleano de sucesso da requisição.

Tipo: Boolean.

mensagem

Mensagem de sucesso ou falha da requisição.

Tipo: String.

data

Dados de retorno da requisição.

Tipo: JSON.

Respostas para erros

Caso ocorra algum erro durante a requisição, os possíveis erros são:

404 Not Found

Caso seja informado um código inválido:

422 Validation Error

bottom of page