Início > Integração
Versão: 2.0
Sugestão de pedidos
Última Atualização: 23/09/2024
Esta integração possibilita que o fornecedor gerencie sugestões de pedidos.
GET Sugestão de pedidos
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.
message
Mensagem de sucesso ou falha da requisição.
Tipo: String.
data
Dados de retorno da requisição.
Tipo: JSON.
pedidosSugeridos
Pedidos sugeridos cadastrados.
Tipo: Array de JSON.
id
Id do pedido.
Tipo: Integer.
created_by
Id do criador.
Tipo: Integer.
modified_by
Id do modificador.
Tipo: Integer.
created_at
Data de criação.
Tipo: DateTime.
cliente
Id do cliente.
Tipo: Integer.
fornecedor
Id do fornecedor.
Tipo: Integer.
data_inicio
Data de início que a sugestão ficará vigente.
Tipo: DateTime.
data_fim
Data fim do pedido sugerido.
Tipo: DateTime.
id_geracao
Id geracao.
Tipo: Integer.
deleted
Indicador booleano se a sugestão de pedido foi deletada.
Tipo: Boolean.
tipo
Tipo de sugestão.
Tipo: String.
smart_list
Id smart_list.
Tipo: Integer.
produto
Id produto.
Tipo: Integer.
embalagem
Id embalagem.
Tipo: Integer.
categoria
Categoria da sugestão.
Tipo: String.
relevancia
Nível de relevância.
Tipo: Integer.
media_compra
Media compra.
Tipo: Integer.
media_valor
Media valor.
Tipo: Integer.
quantidade_sugerida
Quantidade de itens que serão sugeridos.
Tipo: Integer.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
500 Internal Server Error
Caso ocorra algum erro interno na API:
Última Atualização: 23/09/2024
Este endpoint possibilita que o fornecedor realize o envio de sugestões de pedidos.
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:
Sugestão de um produto novo
Elementos da Requisição
O corpo desta requisição consiste em um Array contendo as sugestões em formato JSON.
cliente*
CNPJ do cliente.
Tipo: String.
data_inicio*
Data de início que a sugestão ficará vigente.
Tipo: DateTime.
data_fim*
Data fim que a sugestão ficará vigente.
Tipo: DateTime.
recomendacao*
Dados das recomendações separado por produtos.
Tipo: JSON.
(código ean ou dun)*
Código ean ou dun do produto.
Tipo: JSON.
mais_info*
Este campo se refere a adção de novos produtos.
Tipo: Integer.
novo
Este campo se refere a adção de novos produtos.
Tipo: JSON.
score*
Ordem de exibição na lista.
Tipo: Integer.
ean_dun*
Código ean ou dun do produto.
Tipo: String.
media_compra*
Média da quantidade adquirida pelos clientes.
Tipo: Integer.
media_valor*
Média de preço adquirido pelos clientes.
Tipo: Float.
quantidade_sugerida*
Quantidade sugerida do item.
Tipo: String.
Sugestão de um produto que o cliente já comprou (abastecimento)
Elementos da Requisição
O corpo desta requisição consiste em um Array contendo as sugestões em formato JSON.
cliente*
CNPJ do cliente.
Tipo: String.
data_inicio*
Data de início que a sugestão ficará vigente.
Tipo: DateTime.
data_fim*
Data fim que a sugestão ficará vigente.
Tipo: DateTime.
recomendacao*
Dados das recomendações separado por produtos.
Tipo: JSON.
(código ean ou dun)
Código ean ou dun do produto.
Tipo: JSON.
mais_info*
Este campo se refere a adção de novos produtos.
Tipo: Integer.
abastecimento
Este campo indica que será utilizado um produto que o cliente já comprou.
Tipo: JSON.
score*
Ordem de exibição na lista.
Tipo: Integer.
ean_dun*
Código ean ou dun do produto.
Tipo: String.
pedidos
Pedidos que vão receber a sugestão
Tipo: Array de JSON.
data*
Data do pedido.
Tipo: DateTime.
numero*
Número do pedido.
Tipo: String.
quantidade*
Quantidade sugerida.
Tipo: String.
quantidade_sugerida*
Embalagem do produto.
Tipo: String.
media_compra*
Média da quantidade adquirida pelos clientes.
Tipo: Integer.
quantidade_sugerida*
Quantidade sugerida do item.
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á:
Retorno para a sugestão de novos produtos
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.
id
Id.
Tipo: Integer.
operacao
Tipo de operação realizada.
Tipo: String.
msg
Mensagem retornada.
Tipo: String.
smartList
Dados do smart list.
Tipo: JSON.
smartListId
Id do smart list.
Tipo: Integer.
operacao
Tipo de operação realizada.
Tipo: String.
success
Operações que ocorreram com sucesso.
Tipo: Array de JSON.
novo
Operações de abastecimento.
Tipo: JSON.
pedido_sugerido_id
Id o pedido sugerido.
Tipo: Integer.
produto_id
Id o produto
Tipo: integer.
embalagem_id
Id da embalagem.
ean_ou_dun
Tipo: Integer.
Código ean ou dun do produto.
Tipo: String.
success
Operações que ocorreram com sucesso.
Tipo: Array de JSON.
failed
Pedidos sugeridos que tiveram falha.
Tipo: Array.
failed
Falhas da operação.
Tipo: Array.
Retorno para a sugestão de um produto que o cliente já comprou (abastecimento)
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.
id
Id.
Tipo: Integer.
operacao
Tipo de operação realizada.
Tipo: String.
msg
Mensagem retornada.
Tipo: String.
smartList
Dados do smart list.
Tipo: JSON.
smartListId
Id do smart list.
Tipo: Integer.
Tipo de operação realizada.
Tipo: String.
success
Operações que ocorreram com sucesso.
Tipo: Array de JSON.
abastecimento
Operações de abastecimento.
Tipo: JSON.
pedido_sugerido_id
Id o pedido sugerido.
Tipo: Integer.
produto_id
Id o produto
Tipo: integer.
embalagem_id
Id da embalagem.
ean_ou_dun
Tipo: Integer.
Código ean ou dun do produto.
Tipo: String.
success
Operações que ocorreram com sucesso.
Tipo: Array de JSON.
referencia_pedido
Referencia do pedido.
Tipo: JSON.
referencia_pedido_id
Id da referencia.
Tipo: Integer.
data
Data da referencia.
Tipo: DateTime.
numero
Numero da referencia.
Tipo: String.
quantidade
Quantidade de items.
Tipo: Integer.
pedido_nb2b
Indicador se o pedido é do marketplace.
Tipo: Boolean.
pedido_sugerido_id
Id do pedido sugerido.
failed
Tipo: Integer.
Pedidos sugeridos que tiveram falha.
Tipo: Array.
failed
Falhas da operação.
Tipo: Array.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
400 Bad Request
Se algum campo obrigatório for omitido, a mensagem de erro indicará o campo ausente.
500 Internal Server Error
Caso ocorra algum erro interno na API:
POST Sugestão de pedidos
Última Atualização: 23/09/2024
Este endpoint víncula um cliente a uma opção de entrega.
Endpoint POST
DELETE Sugestão de pedidos
Última Atualização: 23/09/2024
Este endpoint possibilita que o fornecedor realize o envio de sugestões de pedidos.
Endpoint DELETE
Parâmetros da requisição
smartListId: Integer
Ex: 1234
pedidoSugeridoId: Integer
Ex: 32145
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.
message
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 o parâmetro pedidoSugeridoId não referencie um pedido sugerido válido.
Caso o parâmetro smartListId não referencie uma smartList vália.