Início > Pedidos
Versão: 2.0
Pedidos
Última Atualização: 27/11/2024
A integração de pedidos possibilita coletar os pedidos realizados nas plataformas Yandeh e atualiza-los até o momento de sua entrega.
Parâmetros da requisição
pagina: Integer
Ex: 1
quantidade_pagina: Integer
Ex: 1
status: String
Ex: "faturado"
start_date: String
Ex: 2024-01-01
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
items
Lista de pedidos.
Tipo: Array de JSON.
id
Id do pedido.
Tipo: Integer
cod_grupo_produto
ID do grupo de produto, quando há divisão de itens por pedidos.
Tipo: Integer ou null
sync_id
Id do pedido.
Tipo: Integer
itens
Lista de produtos do pedido.
Tipo: Array de JSON.
nome_produto
Descrição do produto.
Tipo: String.
produto_padrao
Código do produto criado na base de cadastro da Yandeh.
Tipo: String.
ean_ou_dun
Código ean ou dun conforme o que foi disponibilizado para venda.
Tipo: String.
quantidade_por_embalagem
Quantidade de itens da embalagem vendida.
Tipo: Integer.
codigo_no_fornecedor
Código do produto no fornecedor caso tenha sido enviado na integração de produto.
Tipo: String.
quantidade
Quantidade de embalagens vendidas.
Tipo: Integer.
quantidade_faturada
Quantidade de itens faturados.
Tipo: Integer.
quantidade_devolvida
Quantidade de itens devolvidos.
Tipo: Integer.
preco_embalagem
Preço da embalagem somando todas as unidades, sem desconto ou acréscimo.
Tipo: Integer.
preco_embalagem_faturado
Preço da embalagem somando todas as unidades da embalagem somando os descontos e acréscimos.
Tipo: float.
tipo_embalagem
Tipo da embalagem do produto.
Tipo: float.
acao_venda
Caso o item tenha sido vendido em uma campanha informamos o código da campanha na Yandeh.
Tipo: String.
codigo_campanha_fornecedor
Código de campanha gerado pelo fornecedor para identificação interna, no momento do cadastro da campanha.
Tipo: String.
alteracao_preco_acao_venda
Valor total que foi aplicado de desconto de uma campanha sobre a embalagem.
Tipo: Float.
alteracao_preco_condicao_pagamento
Se teve alteração de preço por conta de condição de pagamento: Desconto ou acréscimo, o valor será informado nesse campo. Sendo informado o valor total que foi aplicado sobre a embalagem.
Tipo: Float.
quantidade_unitaria_devolvida
Quantidade em unidades do produto devolvido.
Tipo: Integer.
quantidade_unitaria_faturada
Quantidade em unidades do produto faturado.
Tipo: Integer.
preco_item_faturado_corrigido
Campo para informar o novo preço do produto caso tenha mudado no faturamento.
Tipo: Float.
modified_at
Última vez que o pedido foi alterado.
Tipo: String.
status
Status de logística do pedido.
Tipo: String.
status_fornecedor
Status do pedido no fornecedor.
Tipo: String.
created_at
Data de criação do pedido.
Tipo: String.
cliente
CNPJ do cliente.
Tipo: String.
cliente_endereco
Endereço do cliente.
Tipo: Json.
logradouro
Logradouro do endereço. Avenida, Rua, lote, etc.
Tipo: String.
numero
Número da residência.
Tipo: String.
complemento
Informação complementar para o endereço.
Tipo: String.
bairro
Bairro.
Tipo: String.
cidade
Cidade.
Tipo: String.
estado
Estado.
Tipo: String.
CEP
Cep.
Tipo: String.
codigo_estoque
Código estoque do pedido.
Tipo: String.
fornecedor
CNPJ fornecedor.
Tipo: Json.
desconto_logistico_monetario
Desconto logístico monetário.
Tipo: Integer.
total_sem_desconto_logistico
Total sem desconto logistico.
Tipo: Float.
total
Total sem desconto logistico.
Tipo: Float.
total_faturado
Valor total faturado.
Tipo: Float.
desconto_comercial
Desconto comercial.
Tipo: Integer.
ocorrencias_logisticas
Lista de ocorrências logisticas.
Tipo: Array.
data
Data da ocorrência.
Tipo: Datetime.
descricao
Descrição da ocorrência.
Tipo: String.
comentario
Comentário da ocorrência.
Tipo: String.
condicao_pagamento
Condição de pagamento.
Tipo: JSON.
meio_pagamento
Meio de pagamento.
Tipo: String.
condicao
Condição de pagamento em dias.
Tipo: String.
codigo_alpe
Código Alpe.
Tipo: String.
codigo_meio_pagamento
Código do meio de pagamento.
Tipo: String.
codigo_condicao_pagamento
Código da condiçao de pagamento no fornecedor.
Tipo: String.
taxa
Taxa de juros ou desconto da condição de pagamento.
Tipo: Integer.
arquivos
Arquivos envolvidos no pedido.
Tipo: JSON.
boleto
PDF da danfe NF + boleto em Base64.
Tipo: String.
nota_fiscal
XML da nota fiscal .
Tipo: String.
nota_fiscal_devolucao
XML da nota fiscal de devolução.
Tipo: String.
nota_fiscal
Dados da nota fiscal.
Tipo: JSON.
venda
Dados da venda.
Tipo: JSON.
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.
devolucao
Dados da devolução.
Tipo: JSON.
data
Data da devolução.
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.
valor_devolucao
Valor da devolução
Tipo: Float.
boleto_devolucao
Número do boleto.
Tipo: String.
origem
Origem do pedido : Smartforce ou Smartplace
Tipo: String.
comprador
Dados do comprador.
nome
Tipo: JSON.
Nome do usuário que fechou o pedido.
Tipo: String.
Email do usuário que fechou o pedido.
Tipo: String.
cod_vendedor
Código do vendedor que fechou o pedido.
Obs: No caso de pedidos finalizados por vendedores e não loja.
Tipo: String.
qtd_itens
Quantidade de itens do pedido.
Tipo: Integer.
total_paginas
Número total de páginas.
Tipo: Integer.
restantes
Quantidade de pedidos restantes que não foram incluídos nessa paginação.
Tipo: Integer.
pagina_atual
Número da página atual.
Tipo: Integer.
total
Total de pedidos coletados.
Tipo: Integer.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
422 Validation Error
GET Pedidos
Última Atualização: 27/11/2024
Este endpoint irá retornar os pedidos feitos na plataforma do Abastece Shop.
Endpoint GET
Parâmetros da requisição
pedido_id: Integer
Ex: 1
Os elementos que podem ser adicionados ao payload são:
Elementos da Requisição
itens*
Informações referentes aos itens que compõe o pedido. Item esse que pode ser um produto ou uma caixa de um produto.
Tipo: Lista de JSON.
ean_ou_dun*
Código do produto, podendo variar entre ean e dun.
Tipo: String.
quantidade_faturada*
Quantidade do produto em embalagens faturada.
Tipo: Integer.
quantidade_devolvida*
Quantidade do produto em embalagens devolvida.
Tipo: Integer.
quantidade_unitaria_devolvida
Quantidade em unidades do produto devolvido.
Tipo: Integer.
quantidade_unitaria_faturada
Quantidade em unidades do produto faturado.
Tipo: Integer.
preco_item_faturado_corrigido
Preço do produto faturado.
Obs: Pode ser informado somente se o preço tiver alguma alteração durante o faturamento.
Tipo: Float.
status*
Status do pedido..
Tipo: String.
status_fornecedor
Status do fornecedor para o pedido.
Tipo: String.
ocorrencias_logisticas
São os status referentes ao tracking de entrega. Não obrigatório.
Tipo: JSON.
data
Data da ocorrência.
Tipo: Datetime.
descricao
Descrição da ocorrência.
Tipo: String.
comentario
Descrição da ocorrência.
Tipo: String.
arquivos
Documentações e arquivos referentes ao pedido.
Tipo: JSON.
boleto
PDF da danfe NF + boleto. Caso não seja possível unir boleto e danfe, pode ser enviado apenas o danfe.
Tipo: Base64.
nota_fiscal
XML da nota fiscal. Opicional.
Tipo: Base64.
nota_fiscal_devolucao
XML da nota fiscal de devolução.
Tipo: Base64.
nota_fiscal
Dados da nota fiscal.
Tipo: JSON.
venda
Dados da venda.
Tipo: JSON.
data
Data de venda.
Tipo: Datetime.
chave
Chave de acesso 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.
devolucao
Dados de devoluções.
Tipo: JSON.
data
Data da devolução.
Tipo: Datetime.
chave
Chave de acesso 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.
valor_devolucao
Valor devolvido.
Obs: Campo Obrigatório caso o pagamento for Yandeh.
Tipo: Float.
boleto_devolucao
Número do boleto.
Obs: Campo obrigatório caso o pagamento for Yandeh.
Tipo: String.
multiplos_arquivos
Dados dos arquivos múltiplos do pedido.
Tipo: Lista de JSON.
vendas
Arquivos de vendas
Tipo: JSON.
data
Data de venda.
Tipo: Datetime.
chave
Chave de acesso 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.
arquivos
Arquivos do pedido.
Tipo: JSON.
boleto
Caminho do boleto no S3.
Tipo: String.
nota_fiscal
Caminho da nota fiscal no S3.
Tipo: String.
nota_devolucao
Caminho da nota fiscal de devolução no S3.
Tipo: String.
devolucoes
Arquivos de devolução.
Tipo: JSON.
data
Data de venda.
Tipo: Datetime.
chave
Chave de acesso 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.
arquivos
Arquivos do pedido.
Tipo: JSON.
boleto
Caminho do boleto no S3.
Tipo: String.
nota_fiscal
Caminho da nota fiscal no S3.
Tipo: String.
nota_devolucao
Caminho da nota fiscal de devolução no S3.
Tipo: String.
numero_pedido_fornecedor
Número do pedido no fornecedor.
Tipo: String.
Atualização de status
Os pedidos seguem o fluxo de faturamento e entrega aos clientes. Para que esse fluxo possa ser atualizado na plataforma é necessário que as informações de status do pedido sejam atualizadas.
Ao realizar a atualização dos status dos pedidos na plataforma, devem ser seguidos alguns padrões, fornecendo os dados necessários para a atualização correta dos status.
Os status possíveis para o pedido são: aguardando_revisao, pendente, processando, faturado, enviado, finalizado, finalizado_devolucao_parcial, devolucao_total, cancelado, cancelado_solicitacao_cliente, cancelado_solicitacao_fornecedor, cancelado_reprovado_financeiro.
Fluxo normal do pedido:
pendente > processando > faturado > enviado > finalizado
Fluxos de devolução parcial do pedido:
pendente > processando > faturado > enviado > finalizado_devolucao_parcial
Fluxos de devolução total do pedido:
pendente > processando > faturado > enviado > devolucao_total
Exemplo de payload a serem atualizados de acordo com cada status:
Processando
Após captura do pedido pendente com sucesso, o mesmo deverá ser atualizado para o status processando.
A fase do status processando não é obrigatório, porém é importante para ter o controle dos pedidos já gravados no ERP com os pedidos já capturados (em fase de processando e análise).
Status faturado
Após o faturamento do pedido no fornecedor, ele deverá ter os status atualizados para faturado. Esta fase é obrigatória.
Status cancelado
Os status disponíveis para cancelamento são:
cancelado, cancelado_solicitacao_cliente, cancelado_solicitacao_fornecedor, cancelado_reprovado_financeiro.
O pedido pode ser atualizado para os status de cancelamento quando o mesmo estiver em qualquer fase até o faturamento. Após passar para o status enviado, os status pode ser atualizado para finalizado e suas devoluções.
Status enviado
Após faturamento, caso o fornecedor tenha informações do tracking logístico, poderá atualizar o pedido para o status enviado, acrescentando ocorrências caso ocorra.
As ocorrências logísticas podem ser atualizadas separadamente caso desejem ser adicionadas apenas ocorrências logisticas.
Status finalizado
Após entrega, o pedido deverá ser atualizado para finalizado.
Status de devoluções
Devolução Parcial
Caso o cliente realize uma devolução parcial dos produtos, o pedido deverá ser atualizado para finalizado_devolucao_parcial.
Devolução total
Caso o cliente realize uma devolução total dos produtos, os status do pedido deveram ser atualizados para devolucao_total.
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
status
Status do pedido na plataforma.
Tipo: String.
erro
Erro ocorrido.
Tipo: String.
motivo
Motivo do erro.
Tipo: String.
solicitação
Solicitação.
Tipo: String.
PATCH pedidos
Última Atualização: 19/06/2024
Endpoint responsável por atualizar dados dos pedidos.
Endpoint PATCH
https://yandeh-seller-integration.yandeh.com.br/v2/pedidos/{pedido_id}/status
Sintaxe da Requisição
DELETE Arquivos pedido
Última Atualização: 03/03/2025
Este endpoint tem o objetivo de deletar arquivos do pedido.
Endpoint POST
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:
Deleção de multiplos arquivos
Elementos da Requisição
chave
Chave da NFe do pedido.
Tipo: String.
arquivos
Arquivos que serão excluídos do pedido. Neste campo podem ser adicionados um ou mais arquivos para que possam ser deletados.
Opções: "nota_fiscal", "boleto" e "nota_devolucao".
Tipo: String.
Deleção da chave e arquivos relacionados
Ao enviar apenas a chave da nota fiscal, ela será removida do pedido assim como todos os arquivos atrelados a nota.
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, os pedidos entrarão na fila de processamento e essa será a resposta que você receberá:
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
Chave inválida.
400 Bad Request
Arquivo não existente no pedido.
No exemplo, o campo de arquivos foi enviado com o valor "boleto".