Início > Integração
Versão: 2.0
Pedidos externos
Última Atualização: 17/09/2024
Este serviço permite que seja cadastrado o histórico de pedidos realizados fora do MarketPlace.
Sintaxe da Requisição
Para que a requisição do método Post seja bem-sucedida, é necessário que
seja passado os seguintes valores dentro de um JSON:
Elementos da Requisição
condicao_de_pagamento *
ID da condição de pagamento da Yandeh ou o código da condição de pagamento externo.
Tipo: String.
cnpj_cliente *
CNPJ do cliente.
Tipo: String.
data_pedido *
Data em que o pedido foi processado.
Tipo: Datetime.
total *
Valor total do pedido.
Tipo: Boolean.
numero_pedido *
Número do pedido.
Tipo: String.
razao_social
Razão social do cliente.
Tipo: String.
descontos
Descontos aplicaos ao pedido.
Tipo: Float.
acrescimos
Acrescimos aplicados ao pedido.
Tipo: Float.
prazo_entrega *
Data de prazo para a entrega.
Tipo: Datetime.
observacao
Observações para o pedido.
Tipo: String.
itens *
Lista de itens do pedido.
Tipo: Lista de JSON.
ean_ou_dun *
Código ean ou dun conforme o que foi disponibilizado para venda.
Tipo: String.
preco_faturado*
Valor do item faturados.
Tipo: Float.
preco_unitario *
Valor unitário do item.
Tipo: Float.
quantidade_faturado
Quantidade de itens faturados.
Tipo: Float.
tipo_embalagem *
Tipo de embalagem do produto.
Tipo: String.
descricao *
Descrição do produto.
Tipo: String.
quantidade_devolvida
Quantidade de itens devolvidos, apenas em caso de devoluções.
Tipo: Integer.
tamanho_embalagem
Tamanho da embalagem.
Tipo: Integer.
status *
Dados do status do pedido.
Tipo: Array de JSON.
data *
Data da criação dos status.
Tipo: Datetime.
status *
Status do pedido.
Obs: Este é um campo livre, mas é orientado que seja seguido o padrão de status: processando, faturado, finalizado, cancelado, devolucao_total e devolucao_parcial.
Fluxo de status: processando > faturado > finalizado.
Tipo: Float.
total *
Valor total o pedido.
Tipo: Float.
descontos
Descontos aplicados ao pedido.
Tipo: Float.
acrescimos
Valor do acrescimo do pedido.
Tipo: Float.
quantidade_itens *
Quantidade de items do pedido.
Tipo: Integer.
notas_fiscais
Dados de nostas fiscais.
Tipo: Array.
tipo *
Tipo de nota.
Tipo: String.
data *
Data de emissão da Nfe.
Tipo: Datetime.
chave
Chave da NFe.
Tipo: String.
serie
Número de série da NFe.
Tipo: Integer.
valor
Valor da NFe.
Tipo: Float.
numero
Número da NFe.
Tipo: Integer.
historico_transportes
Histórico de transportes do pedido.
Tipo: Array de JSON.
data *
Data do transporte.
Tipo: Datetime.
descricao
Descrição do transporte.
Tipo: String.
comentario
Comentário.
Tipo: String.
arquivos
Arquivos do pedido.
Tipo: Array de JSON.
tipo
Tipo de arquivo.
Tipo: String.
descricao
Descrição do arquivo.
Tipo: String.
arquivo
Arquivo em base 64.
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á:
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.
success
Identificador booleano de sucesso da ação.
Tipo: Boolean.
message
Mensagem retornada pela api.
Tipo: String.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
400 Bad Request
Caso não sejam enviados campos obrigatórios (cenário omitindo o campo "condicao_pagamento").
POST Pedidos externos
Última Atualização: 17/09/2024
Endpoint responsável pelo envio do histórico de pedidos.