top of page

Endpoints responsáveis  pelos pedidos efetuados na plataforma Yandeh

Início > Pedidos

Versão: 2.0

Pedidos

GET Pedidos

Endpoint GET

Endpoint para consulta dos pedidos efetuados na plataforma Yandeh

URL:

Parâmetros da requisição

Informe os parâmetros abaixo para realizar a consulta dos pedidos.​

​

pagina: Página a ser exibida.​​

  • Página inicial 1

  • Parâmetro não obrigatório.

quantidade_pagina: Quantidade de registros a serem exibidas por página. 

  • Default 100 registros por página.

  • Parâmetro não obrigatório.

status: Status dos pedidos a ser retornados.

  • Parâmetro não obrigatório.

  • Default status pendente.

  • Status disponíveis: aguardando_aprovacao, aguardando_revisao, pendente, processando, faturado, enviado, finalizado, finalizado_devolucao_parcial, finalizado_devolucao_total, cancelado.

start_date: Data de início do período de consulta dos pedidos.

  • Caso a data de início não seja informada, serão retornados os pedidos atualizados nos últimos 7 dias.

  • Parâmetro não obrigatório​

pedidos_ids: Número dos pedidos Yandeh a serem retornados.

  • Parâmetro não obrigatório​

Exemplo:

Sintaxe da Resposta

Se os parâmetros forem informados corretamente, o endpoint retornará os pedidos com status code 200.
Exemplo de retorno:

{
    "items": [
        {
            "id": 507310,
            "cod_grupo_produto": null,
            "sync_id": null,
            "itens": [
                {
                    "nome_produto": "APARELHO BARBEAR BIC COMFORT 3 ",
                    "produto_padrao": "1486810",
                    "ean_ou_dun": "070330717541",
                    "quantidade_por_embalagem": 12,
                    "codigo_no_fornecedor": "871310",
                    "quantidade": 1,
                    "pallet_multiplo_dun": 1,
                    "quantidade_faturada": 1,
                    "quantidade_devolvida": 0,
                    "quantidade_unitaria_faturada": null,
                    "quantidade_unitaria_devolvida": null,
                    "preco_item_faturado_corrigido": null,
                    "preco_embalagem": 46.8275,
                    "preco_embalagem_faturado": 47.0616,
                    "tipo_embalagem": "CAIXA",
                    "acao_venda": 56789,

                    "tipo_acao_venda": "tabloide",

                    "origem_verba_acao_venda": "2134A",
                    "alteracao_preco_acao_venda": 0,
                    "alteracao_preco_condicao_pagamento": 0.23413750000000277,

                   "alteracao_preco_negociacao_especial": -1.7899999999999991,

                    "justificativa_negociacao_especial": " Compra de 150 caixas",
                    "alteracao_preco_alcada_impostos": null,
                    "alteracao_preco_verba_flex": 0,
                    "alcada_percentual_sugerida": null,
                    "alcada_percentual_aplicada": null,
                    "impostos": null
                }
            ],
            "modified_at": "2025-05-30T19:39:04.505483",
            "frete": 0,
            "status": "processando",
            "extra_fields": null,
            "numero_pedido_fornecedor": "11343800",
            "status_fornecedor": "Analise Crédito",
            "prazo_entrega": "2025-06-02T18:36:18.893000",
            "created_at": "2025-05-30T19:36:18.915235",
            "cliente": "04133712000100",
            "cliente_nome": "SUPERMERCADO A",
            "cliente_endereco": {
                "logradouro": "RUA A",
                "numero": "20",
                "complemento": "",
                "bairro": "JARDIM",
                "cidade": "SAO PAULO",
                "estado": "SP",
                "CEP": "06700000"
            },
            "codigo_estoque": "001",
            "fornecedor": "06239190000000",
            "desconto_logistico_monetario": 0,
            "creditos_parceiros": 0,
            "total_sem_desconto_logistico": 47.06,
            "total": 47.06,
            "total_faturado": 47.06,
            "desconto_comercial": 0,
            "ocorrencias_logisticas": [],
            "condicao_pagamento": {
                "meio_pagamento": "Boleto 7 dias",
                "condicao": "7",
                "codigo_alpe": null,
                "codigo_meio_pagamento": null,
                "codigo_condicao_pagamento": "4",
                "taxa": 0.005
            },
            "observacao": "",
            "arquivos": {},
            "notas_fiscais": {
                "venda": null,
                "devolucao": null
            },
            "origem": "Smartplace",
            "origem_pedido": null,
            "numero_pedido_cliente": null,

            "pedido_vinculado": null,

            "negociacao_especial": true,
            "comprador": {
                "nome": "João",
                "email": "joao10@gmail.com",
                "cod_vendedor": null
            },
            "multiplos_arquivos": null,
            "qtd_itens": 1
        }
    ],
    "restantes": 146,
    "pagina_atual": 1,
    "total_paginas": 147,
    "total": 147
}

Elementos da Resposta

items: Lista de pedidos.
  Tipo: Array de JSON.
id: Id do pedido na Yandeh.
  Tipo: Integer
cod_grupo_produto: ID do grupo de produto (para os fornecedores que trabalham com grupos de produtos)
  Tipo: Integer ou null
sync_id:código interno da Yandeh
  Tipo: Integer
itens : Lista de produtos do pedido.
  Tipo: Array de JSON.
nome_produto: Descrição do produto.
  Tipo: String.
produto_padrao: código interno do produto na Yandeh.
  Tipo: String.
ean_ou_dun: Código do GTIN do produto cadastrado no estoque do fornecedor.
  Tipo: String.
quantidade_por_embalagem: Quantidade de itens da embalagem vendida.
  Tipo: Integer.
codigo_no_fornecedor: Código do produto no fornecedor cadastrado no estoque.
  Tipo: String.
quantidade : Quantidade vendida do produto.
  Tipo: Integer.
quantidade_faturada: Quantidade faturada do produto (caso esteja em um status anterior a faturado irá repetir o mesmo valor do campo quantidade).
  Tipo: Integer.
quantidade_devolvida: Quantidade de itens devolvidos.(Para os pedidos no status de devolução)
  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 com  descontos, acréscimos e negociações.
  Tipo: float.
Tipo_embalagem:   Tipo da embalagem do produto.
  Tipo: float.
acao_venda: Código interno da ação de venda na Yandeh. Preenchido apenas quando o produto foi adquirido por meio de uma campanha.
  Tipo: String.

tipo_acao_venda: Categoria da ação de venda. Preenchido apenas quando o produto foi adquirido por meio de uma campanha.

  Tipo: String.

origem_verba_acao_venda: Código interno da campanha no fornecedor. Preenchido apenas quando o produto foi adquirido por meio de uma campanha.

 Tipo: String.
alteracao_preco_acao_venda: Valor de desconto aplicado no item devido a campanha
  Tipo: Float.
alteracao_preco_condicao_pagamento: Valor do acréscimo ou desconto aplicado no item devido taxas na condição de pagamento 
  Tipo: Float.

alteracao_preco_negociacao_especial: Diferença entre o valor original da embalagem e o valor negociado.
Campo destinado aos usuários do aplicativo Smartforce que realizam negociações com valores diferentes do preço padrão de venda do produto.

 Tipo: Float.

justificativa_negociacao_especial: Campo destinado aos usuários do aplicativo Smartforce para descrever os motivos que justificam a aplicação da condição especial de negociação.

 Tipo: String.
preco_item_faturado_corrigido : Preço do produto faturado (Caso no faturamento o fornecedor tenha enviado um preço diferente)
  Tipo: Float.
modified_at: Data da última atualização do pedido (Considerar -03:00 devido ao horário UTC)
  Tipo: String.
status: Status do pedido
  Tipo: String.
status_fornecedor: Status do pedido no fornecedor.
  Tipo: String.
created_at: Data de criação do pedido.(Considerar -03:00 devido ao horário UTC)
  Tipo: String.
cliente: CNPJ do cliente.
  Tipo: String.
cliente_endereco: Endereço do cliente.
  Tipo: Json.
logradouro: Endereço do cliente
  Tipo: String.
numero:Número
  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 do estoque dos produtos (Cadastrado no estoque do fornecedor)
  Tipo: String.
fornecedor:CNPJ fornecedor.
  Tipo: Json.
desconto_logistico_monetario: Desconto logístico monetário.
  Tipo: Integer.
total_sem_desconto_logistico: Total do pedido sem desconto logistico.
  Tipo: Float.
total: Total do pedido com desconto logistico.
  Tipo: Float.
total_faturado: Valor total do pedido faturado (caso esteja em um status anterior a faturado irá repetir o mesmo valor do campo total).
  Tipo: Float.
desconto_comercial: Desconto comercial.
  Tipo: Integer.
ocorrencias_logisticas: Lista de ocorrências logisticas.
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.
meio_pagamento: Meio de pagamento do pedido.
  Tipo: String.
condicao: Condição de pagamento em dias. 
  Tipo: String.
codigo_alpe: Código interno em caso de Boleto Yandeh.
  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 descontos da condição de pagamento.
  Tipo: Integer.
arquivos :Arquivos do pedido
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.
venda: Dados da venda.
  Tipo: JSON.
data: Data de emissão da nota fiscal.
  Tipo: Datetime.
chave: Chave da nota fiscal.
  Tipo: String.
serie: Número de série da nota fiscal
  Tipo: Integer.
valor: Valor da nota fiscal.
  Tipo: Float.
numero: Número da nota fiscal.
  Tipo: Integer.
devolucao: Dados da nota fiscal de devolução.
data: Data da devolução.
  Tipo: Datetime.
chave: Chave da nota fiscal de devolução.
  Tipo: String.
serie: Número de série da nota fiscal.
  Tipo: Integer.
valor: Valor da nota fiscal.
  Tipo: Float.
numero: Número da nota fiscal
  Tipo: Integer.
valor_devolucao: Valor da devolução
  Tipo: Float.
origem : Origem do pedido
  Tipo: String.
comprador: Dados do vendedor.
nome: Nome do usuário que fechou o pedido.
  Tipo: String.
email: Email do usuário que fechou o pedido.
  Tipo: String.
cod_vendedor: Código do vendedor que fechou o pedido.
  Tipo: String.

pedido_vinculado: ID do pedido de venda vinculado
Campo utilizado por usuários do aplicativo Smartforce para associar pedidos bonificados ao respectivo pedido de venda original.

   Tipo: Integer.

negociacao_especial: Indica se o pedido teve condições especiais de preço nos produtos.
Campo utilizado por usuários do aplicativo Smartforce. Valores possíveis: true (sim) ou false (não).

 Tipo: Booleano
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

401Unauthorized: Erro na validação do token

{
  "reason": "Could not validate the token"
}

 406 Not Acceptable: Erro por informar somente o parâmetro da página ou a paginação

{

"message": "Para utilizar paginação, ambos campos 'pagina' e 'quantidade_pagina' devem ser preenchidos simultaneamente."

}

PATCH Pedidos

Endpoint para atualização dos pedidos efetuados na plataforma Yandeh

Endpoint PATCH

URL:

Sintaxe da requisição

  1. Tipo de requisição: PATCH.

  2. URL: O parâmetro {pedido_id} representa o identificador único do pedido que você deseja  atualizar o status. Ele deve ser substituído pelo ID real do pedido que foi previamente registrado na Yandeh

  3. Cabeçalho (Headers):

    • Content-Type: application/json

    • Authorization: Bearer <token>

  4. Corpo da requisição :

    Envio do  JSON de acordo com a atualização de cada status:

Exemplo da URL:

​Corpo da requisição - Payload para cada status

​

Os pedidos seguem um fluxo que contempla a coleta pelo fornecedor, faturamento e entrega ao cliente.

Para que esse processo seja corretamente refletido na plataforma, é essencial que os status dos pedidos sejam atualizados de forma adequada.

​

Status disponíveis:

aguardando_aprovacao: Status inicial atribuído ao pedido realizado no aplicativo Smartforce quando há negociações de preços pendentes de aprovação.
aguardando_revisao: Status inicial atribuído quando o cliente realiza um pedido sem possuir limite de crédito disponível.

pendente: Status inicial atribuído quando o cliente realiza um pedido com limite de crédito disponível.

processando:  Status atribuído quando o fornecedor captura e registra o pedido em seu sistema (ERP).

faturado: Status atribuído ao pedido após a confirmação do faturamento.

enviado: Status atribuído após o envio da mercadoria para o cliente.​

finalizado: Status atribuído quando o pedido foi entregue ao cliente.

finalizado_devolucao_parcial: Status atribuído  quando, após a entrega, parte dos produtos do pedido foi devolvida

devolucao_total: Status atribuído  quando, após a entrega, todos os produtos do pedido foi devolvido

cancelado: Pedido cancelado. 

cancelado_solicitacao_cliente: Status atribuído quando o cliente solicita o cancelamento do pedido.

cancelado_solicitacao_fornecedor: Status atribuído quando o fornecedor cancela o pedido. 

cancelado_reprovado_financeiro:Status atribuído quando o pedido tem reprovação financeira.

​

Exemplo de fluxos de status:

​

Fluxo padrão: 
pendente → processando → faturado → enviado → finalizado

 Fluxo com devolução parcial:
pendente → processando → faturado → enviado → finalizado_devolucao_parcial

 Fluxo com devolução total:
pendente → processando → faturado → enviado → devolucao_total

Fluxo de cancelamentos:

pendente → processando → cancelado 

pendente → processando → cancelado_solicitacao_cliente 

pendente → processando → cancelado_solicitacao_fornecedor ​​​

Processando:

{
"status": "processando",
"status_fornecedor": "Em andamento"

"numero_pedido_fornecedor": "11518824"
}

status: Status do pedido Yandeh.

  • Campo Obrigatório

status_fornecedor: Status do pedido no fornecedor. 

  • Campo não obrigatório

numero_pedido_fornecedor: Número  do pedido no fornecedor. 

  • Campo não obrigatório

Cancelado:

{
"status": "cancelado",
"status_fornecedor": "cancelado fornecedor"
}

status: Status do pedido Yandeh.

  • Campo Obrigatório

status_fornecedor: Status do pedido no fornecedor. 

  • Campo não obrigatório

Outras opções de status cancelado:

  • cancelado_solicitacao_cliente 

  • cancelado_solicitacao_fornecedor

  • cancelado_reprovado_financeiro

Faturado:

{
"status": "faturado",
"status_fornecedor": "faturado",
"itens": [
{
"ean_ou_dun": "7898598186730",
"quantidade_faturada": 2,
"quantidade_devolvida": 0,
"preco_item_faturado_corrigido": 10.5
},
{
"ean_ou_dun": "7898598186732",
"quantidade_unitaria_faturada": 2,
"quantidade_devolvida": 0
}
],
"nota_fiscal": {
"venda": {
"data": "2023-07-11T00:00:00",
"chave": "11111111111111111111111111111111111111111111",
"serie": 1,
"valor": 80,
"numero": 1212
}
},
"arquivos": {
"boleto": "base64",
"nota_fiscal": "base64"
}
}

status: Status do pedido Yandeh.

  • Campo Obrigatório

status_fornecedor: Status do pedido no fornecedor. 

  • Campo não obrigatório

Items: Para o status faturado deve ser enviado todos os itens do pedido com as quantidades faturadas dos produtos.​

ean_ou_dun: Ean ou Dun do produto

  • Campo obrigatório

quantidade_faturada: Quantidade do produto faturado por embalagem.​

quantidade_devolvida: Quantidade do produto devolvido. 

  • Campo obrigatório.

  • Para essa fase do status faturado enviar sempre 0.

preco_item_faturado_corrigido: Valor unitário da embalagem do produto. 

  • Campo não obrigatório

  • Campo é utilizado para quando no faturamento o valor do produto seja diferente do valor no pedido original.

nota_fiscal - venda: Informações da nota fiscal de venda.​

data: Data de emissão da nota fiscal

chave: Chave da nota fiscal

serie: série da nota fiscal

valor: Valor faturado da nota fiscal

numero: Número da nota fiscal

  • Para fornecedores que utilizam o Boleto Yandeh, o envio das informações da nota fiscal é obrigatório.

  • Para fornecedores com pagamento próprio, o envio das informações não é obrigatório. No entanto, quando possível, é recomendado para que o faturamento fique completo na plataforma.

arquivos: Arquivos do faturamento

boleto: PDF do boleto + Danfe em formato base 64.

nota_fiscal: XML da nota fiscal em formato base 64.

  • Fornecedores que utilizam o pagamento via Boleto Yandeh podem enviar apenas o PDF da DANFE, sem a necessidade de incluir o boleto. 

  • Embora não sejam obrigatórias, as informações do PDF do boleto e da DANFE são importantes para que o cliente possa visualizá-las e fazer o download pela plataforma. 

​

Enviado:

{
    "status": "enviado",

    "status_fornecedor": "em trânsito",
    "ocorrencias_logisticas": [
{
    "data": "2024-09-14T07:00:38",
    "descricao": "Saiu para entrega",
    "comentario": "Saiu para entrega"
}
]
}

Finalizado:

status: Status do pedido Yandeh.

  • Campo Obrigatório

status_fornecedor: Status do pedido no fornecedor. 

  • Campo não obrigatório

ocorrencias_logisticas: Informações as ocorrências logísticas (entrega) do fornecedor.​

data: Data da ocorrência

​descricao: Descrição da ocorrência

comentário: Observações da ocorrência

  • Informações das ocorrências não obrigatórias.

​

​​

{
"status": "finalizado",
"status_fornecedor": "finalizado"
}

status: Status do pedido Yandeh.

  • Campo Obrigatório

status_fornecedor: Status do pedido no fornecedor. 

  • Campo não obrigatório

Devolução parcial ou total:

{
"status": "finalizado_devolucao_parcial",
"status_fornecedor": "Devolução parcial",
"itens": [
{
"ean_ou_dun": "7898598186730",
"quantidade_faturada": 2,
"quantidade_devolvida": 1
},
{
"ean_ou_dun": "7898598186732",
"quantidade_faturada": 2,
"quantidade_devolvida": 1
}
],
"nota_fiscal": {
"devolucao": {
"numero": 456,
"serie": 852,
"data": "2024-09-14T18:45:38",
"chave": "35250504820606000124550010004269841390005697",
"valor": 50,
"valor_devolucao": 15.7,
"boleto_devolucao": "120005"
}
},
"arquivos": {
"nota_fiscal_devolucao": "base64"
}
}

status: Status do pedido Yandeh.

  • Nome do status para devolução parcial: finalizado_devolucao_parcial

  • Nome do status para devolução total: devolucao_total

  • Campo Obrigatório

status_fornecedor: Status do pedido no fornecedor. 

  • Campo não obrigatório

Items: Para o status de devolução deve ser enviado todos os itens do pedido com as quantidades devolvidas dos produtos.​

ean_ou_dun: Ean ou Dun do produto

  • Campo obrigatório

quantidade_faturada: Quantidade do produto faturado por embalagem.

quantidade_devolvida: Quantidade do produto devolvido por embalagem. 

nota_fiscal - devolucao: Informações da nota fiscal de devolução.​

data: Data de emissão da nota fiscal

chave: Chave da nota fiscal

serie: série da nota fiscal

valor: Valor da nota fiscal de devolução

valor_devolucao: Valor da devolução

boleto_devolucao: Número do boleto (nosso numero)

numero: Número da nota fiscal

  • Para fornecedores que utilizam o Boleto Yandeh, o envio do valor_devolucao e boleto_devolucao são obrigatórias para solicitarmos o abatimento do boleto.

arquivos: Arquivos da devolução

nota_fiscal: XML da nota fiscal em formato base 64.

  • Informação não obrigatória.

​

Exemplo:

curl --location --request PATCH 'https://yandeh-seller-integration.yandeh.com.br/v2/pedidos/455660/status' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
  "itens": [
    {
      "ean_ou_dun": "17896524726515",
      "quantidade_faturada": 4,
      "quantidade_devolvida": 0
    },
        {
      "ean_ou_dun": "27896098902046",
      "quantidade_faturada": 1,
      "quantidade_devolvida": 0
    },
        {
      "ean_ou_dun": "47896098900213",
      "quantidade_faturada": 1,
      "quantidade_devolvida": 0
    }
  ],
  "status": "faturado",
  "nota_fiscal": {
    "venda": {
      "data": "2025-05-26T11:06:15",
      "chave": "35250504820606000124550010004269841390025237",
      "serie": 1,
      "valor": 1911.5400,
      "numero": 426984
    }
  }
}'

Sintaxe da Resposta

Se os parâmetros forem informados corretamente, o endpoint retornará o status code 200.
Exemplo de retorno:

{

"status": true

}

Respostas para erros

Status code 207:

Nos status de devolução, caso apresente erro ao solicitar o abatimento do boleto pelo número do boleto_devolucao informado,  irá alterar o status do pedido porém o boleto não irá atualizar. deve ser acionado a yandeh.

{

"detail": "Erro ao atualizar as informações do boleto no financeiro...",

"status": false

}

Nos status de devolução, caso não tenha as informações do boleto para solicitar o abatimento,  irá alterar o status do pedido porém o boleto não irá atualizar. Deve ser enviado a informação da nota fiscal - devolucao - valor_devolucao e boleto_devolucao.

{

"detail": [

"Campo 'devolucao' nao encontrado no payload..."

],

"status": true

}

{

"detail": [

"Campo 'nota_fiscal' nao encontrado no payload..."

],

"status": true

}

{

"detail": [

"Para atualizar é necessário ter o campo \"boleto_devolucao\""

],

"status": false

}

Status code 400:​

Para o status faturado e devolução, envio de itens que não constam no pedido original

{

"detail": "[{\"error\":\"item-extra\",\"data\":{\"ean_ou_dun_nao_encontrado\":[\"27232\""]},\"readable_message\":\"Pelo menos um item fornecido não existe neste pedido\"}]"

}

​Para o status faturado e devolução, um ou mais itens do pedido original não foi informado

{

"detail": "[{\"error\":\"item-faltante\",\"data\":{\"ean_ou_dun_encontrados\":[\"17896524726515"]},\"readable_message\":\"Todos os itens do pedido precisam ser atualizados\"}]"

}

Status code 422:​

Tentativa de atualização de status fora da sequência correta.

Exemplo do envio processando:

{
  "detail": "Invalid status. Possible next status: enviado, devolucao_total, finalizado_devolucao_parcial, finalizado, cancelado, cancelado_reprovado_financeiro, cancelado_solicitacao_cliente, cancelado_solicitacao_fornecedor.",
  "status_atual": "faturado"
}

No status faturado, informar os campos quantidade_faturada e quantidade_unitaria_faturada para o mesmo item

{
  "detail": [
    {
      "loc": [
        "body",
        "itens",
        0,
        "quantidade_unitaria_faturada"
      ],
      "msg": "Não é permitido adicionar os dois campos no mesmo envio de itens: ['quantidade_faturada', 'quantidade_unitaria_faturada'].",
      "type": "value_error"
    }
  ]
}

DELETE Arquivos pedido

Endpoint para remoção dos arquivos dos pedidos

Endpoint DELETE

URL:

Sintaxe da requisição

  1. Tipo de requisição: DELETE.

  2. URL: O parâmetro {pedido_id} representa o identificador único do pedido que você deseja  atualizar. Ele deve ser substituído pelo ID real do pedido que foi previamente registrado na Yandeh

  3. Cabeçalho (Headers):

    • Content-Type: application/json

    • Authorization: Bearer <token>

  4. Corpo da requisição :

    Envio do  JSON como exemplo abaixo com os arquivos que desejam remover:

  [
      {
        "chave": "34191790010104351004791020150008890570000012345",
        "arquivos": [
          "nota_fiscal",
          "boleto",
          "nota_devolucao"
        ]
      }
    ]

Elementos da Requisição

chave: Chave da NFe do pedido.

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".

Deleção da chave e arquivos relacionados

   [
      {
        "chave": "34191790010104351004791020150008890570000012345"
      }
    ]

Ao enviar apenas a chave da nota fiscal, ela será removida do pedido assim como todos os arquivos vinculados a nota.

Sintaxe da Resposta

Se os parâmetros forem informados corretamente, o endpoint retornará o status code 200.

Exemplo de retorno:

 {
      "detail": {
        "success": true,
        "message": {
          "success": [
            {
              "chave": "35172415012345678000123550001000000012345678901235",
              "message": "Arquivos removidos com sucesso",
              "arquivos": [
                "nota_devolucao"
              ]
            }
          ],
          "error": []
        }
      },
      "data": {}
    }

Respostas para erros

400 Bad Request : Chave inválida.

​

   {
      "detail": {
        "success": false,
        "message": "Falha ao deletar arquivos do pedido."
      },
      "data": [
        {
          "chave": "35172415012345678000123550001000000012345678901236",
          "message": "Chave do registro não encontrado"
        }
      ]
    }

400 Bad Request: Arquivo inexistente no pedido.


No exemplo, o campo de arquivos foi enviado com o valor "boleto".

    {
      "detail": {
        "success": false,
        "message": "Falha ao deletar arquivos do pedido."
      },
      "data": [
        {
          "chave": "35172415012345678000123550001000000012345678901235",
          "message": "Campo de arquivo não encontrado"
        }
      ]
    }

POST Pedidos - Replicar

Este endpoint permite replicar pedidos existentes, criando novos pedidos com os
mesmos dados e cancelando os pedidos originais.

Endpoint POST

URL:

Sintaxe da requisição

  1. Tipo de requisição: POST.

  2. URL: O parâmetro {pedido_id} representa o identificador único do pedido que você deseja  atualizar. Ele deve ser substituído pelo ID real do pedido que foi previamente registrado na Yandeh

  3. Cabeçalho (Headers):

    • Content-Type: application/json

    • Authorization: Bearer <token>

  4. Corpo da requisição :

    Envio do  JSON como exemplo abaixo com os arquivos que desejam remover:

{
   "pedidos": [112]
}

Elementos da Requisição

pedidos: Lista de números dos pedidos.

  • Parâmetro  não obrigatório.​

Sintaxe da Resposta

Se os parâmetros forem informados corretamente, o endpoint retornará o status code 200.

Exemplo de retorno:

{
  "success": true,
  "message": "Todos os pedidos foram replicados com sucesso",
  "data": {
    "total_processados": 3,
    "total_sucesso": 3,
    "total_erros": 0,
    "sucesso": [
      {
        "pedido_antigo": 71,
        "pedido_novo": 232
      },
      {
        "pedido_antigo": 113,
        "pedido_novo": 233
      },
      {
        "pedido_antigo": 126,
        "pedido_novo": 234
      }
    ],
    "erros": []
  }
}

Caso o sucesso seja parcial, será retornado o status code 207.

Exemplo de retorno:

{
  "success": true,
  "message": "2 de 3 pedidos replicados com sucesso, 1 pedidos não foram replicados",
  "data": {
    "total_processados": 3,
    "total_sucesso": 2,
    "total_erros": 1,
    "sucesso": [
      {
       "pedido_antigo": 71,
       "pedido_novo": 232
     },
     {
       "pedido_antigo": 113,
       "pedido_novo": 233
     },
    ],
    "erros": [
      {
        "pedido_antigo": 999999,
        "motivo": "Pedido não encontrado ou não pertence ao fornecedor"
      }
    ]
  }
}

Respostas para erros

400 Bad Request : Caso o número do pedido seja inválido.

{
  "success": true,
  "message": "Verifique os erros e tente novamente",
  "data": {
    "total_processados": 3,
    "total_sucesso": 2,
    "total_erros": 1,
    "sucesso": [],
    "erros": [
      {
        "pedido_antigo": 999999,
        "motivo": "Pedido não encontrado ou não pertence ao fornecedor"
      }
    ]
  }
}

bottom of page