Início > Opção de entrega
Versão: 2.0
Opção de entrega
Última Atualização: 10/05/2024
A integração de opção de entrega tem como objetivo disponibilizar o cadastro, atualização e remoção de prazos de entrega por cliente.Desta forma, cada cliente pode ter um prazo ou data fixa de entrega personalizada.
Parâmetros da requisição
codigo_no_fornecedor*: Integer. Código da opção de entrega no fornecedor.
Ex: 1
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.
id
Id da opção de entrega.
Tipo: Integer.
created_by
Id do criador da opção de entrega.
Tipo: Integer.
modified_by
Id do responsável pela última alteração na opção de entrega.
Tipo: String.
created_at
Data de criação.
Tipo: Datetime.
modified_at
Data da última alteração.
Tipo: Datetime.
nome
Nome da opção de pagamento.
Tipo: String.
tipo
Tipo de opção de pagamento, podendo ser "prazo" ou "data_fixa"
Tipo: String.
prazo_entrega
Prazo de entrega em dias (Apenas para opções de entrega do tipo prazo).
Tipo: Integer.
dias_corte
Dias que receberão o prazo com o horário.
Tipo: Lista de JSON.
horario
Horário da entrega.
Tipo: String.
nome_dia
Nome do dia da semana.
Tipo: String.
numero_dia
Numero do dia.
Tipo: Integer.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
422 Validation Error
Caso seja adicionado algum caracteres inválidos (testado com um nome invalido "exemplo~"). Ex: "~", ".".
400 Bad Request
GET Opção de entrega
Última Atualização: 10/05/2024
Este endpoint irá exibir as opções de entrega do fornecedor.
Endpoint GET
Para que a requisição do método Post seja bem-sucedida, é necessário que
seja enviado os seguintes valores dentro de um JSON:
Opção de entrega do tipo prazo
Opção de entrega do tipo data_fixa (não contem o campo prazo_entrega)
Elementos da Requisição
tipo
Tipo da opção de entrega. Campos aceitos: prazo e data_fixa
Tipo: String.
dias_corte
Informação dos dias e horários de corte.
Tipo: Array de JSON.
horario
Horário de corte. Pedidos fechados após esse horário será contabilizado no prazo de entrega o próximo dia.
Tipo: String.
nome_dia
Dia da semana do corte. Pedidos fechados nos dias não informados será contabilizado o prazo de entrega considerando o próximo dia informado. Valores aceitos: seg, ter, qua, qui, sex, sab, dom.
Tipo: String.
numero_dia
numero_dia: número do dia da semana . Seguir o padrão 1 para seg, 2 para ter, 3 para qua, 4 para qui, 5 para sex, 6 para sab e 7 para dom
Tipo: Integer.
nome
Nome da opção de entrega.
Tipo: String.
codigo_no_fornecedor
Código da opção de entrega no fornecedor
Tipo: Integer.
prazo_entrega
Prazo em dias da entrega a partir do fechamento do pedido . Campo será informado somente para o tipo prazo
Tipo: Integer.
janela
Manter este campo com o valor fixo "false".
Tipo: Boolean.
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:
400 Bad Request
Caso seja adicionado uma opção com um código já existente.
422 Validation Error
Caso seja adicionado algum caracteres inválidos (testado com um nome invalido "exemplo~"). Ex: "~", ".".
422 Validation Error
Caso seja adicionado esquecido algum campo (no exemplo o campo "janela")
POST Opção de entrega
Última Atualização: 10/05/2024
Este endpoint irá criar novas opções de entrega.
Endpoint POST
Sintaxe da Requisição
Parâmetros da requisição
codigo_no_fornecedor*: Integer. Código da opção de entrega no fornecedor.
Ex: 1
Para que a requisição do método Put seja bem-sucedida, é necessário que
seja enviado os seguintes valores dentro de um JSON:
Opção de entrega do tipo prazo
Opção de entrega do tipo data_fixa (não contem o campo prazo_entrega)
Elementos da Requisição
tipo
Tipo da opção de entrega. Campos aceitos: prazo e data_fixa
Tipo: String.
dias_corte
Informação dos dias e horários de corte.
Tipo: Array de JSON.
horario
Horário de corte. Pedidos fechados após esse horário será contabilizado no prazo de entrega o próximo dia.
Tipo: String.
nome_dia
Dia da semana do corte. Pedidos fechados nos dias não informados será contabilizado o prazo de entrega considerando o próximo dia informado. Valores aceitos: seg, ter, qua, qui, sex, sab, dom.
Tipo: String.
numero_dia
numero_dia: número do dia da semana . Seguir o padrão 1 para seg, 2 para ter, 3 para qua, 4 para qui, 5 para sex, 6 para sab e 7 para dom
Tipo: Integer.
nome
Nome da opção de entrega.
Tipo: String.
codigo_no_fornecedor
Código da opção de entrega no fornecedor
Tipo: Integer.
prazo_entrega
Prazo em dias da entrega a partir do fechamento do pedido . Campo será informado somente para o tipo prazo
Tipo: Integer.
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.
422 Validation Error
Caso ocorra algum erro durante a requisição, os possíveis erros são:
500 Internal Server Error
PUT Opção de entrega
Última Atualização: 10/05/2024
Este endpoint irá atualizar opções de entrega do fornecedor.
Endpoint PUT
Sintaxe da Requisição
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
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
Parâmetros da requisição
codigo_no_fornecedor*: Integer. Código da opção de entrega no fornecedor.
Ex: 1.
Sintaxe da Resposta
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.
Caso seja informado um código inválido:
422 Validation Error
DELETE Opção de entrega
Última Atualização: 10/05/2024
Este endpoint irá remover opções de entrega a partir do campo "codigo_no_fornecedor".
Endpoint DELETE
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
404 Not Found
´