Início > Integração
Versão: 2.0
Pedidos externos
Endpoints responsáveis pelo envio dos pedidos do fornecedor efetuados em outras plataformas para a Yandeh
Endpoint responsável pelo envio dos pedidos do fornecedor efetuados em outras plataformas para o repositório Yandeh.
Endpoint POST
URL:
Sintaxe da Requisição
-
Tipo de requisição: POST .
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
Corpo da requisição:
-
Envio do JSON como exemplo abaixo:
{
"condicao_pagamento": "7",
"cnpj_cliente": "02493388000135",
"data_pedido": "2024-01-01 20:00:00",
"total": 10,
"numero_pedido": "123",
"razao_social": "Minha razão social",
"descontos": 29.9,
"acrescimos": 100,
"prazo_entrega": "2024-01-01 20:00:00",
"observacao": "Observações do pedido",
"itens": [
{
"ean_ou_dun": "27817289127891",
"preco_faturado": 10,
"preco_unitario": 10,
"quantidade_solicitada": 10,
"quantidade_faturado": 10,
"tipo_embalagem": "CAIXA",
"descricao": "Descrição",
"quantidade_devolvida": 10,
"tamanho_embalagem": 10
}
],
"status": [
{
"data": "2024-01-01 20:00:00",
"status": "faturado",
"total": 100,
"descontos": 100,
"acrescimos": 100,
"quantidade_itens": 10
}
],
"notas_fiscais": [
{
"tipo": "venda",
"data": "2024-01-01 00:00:00",
"chave": "212981738921739872198379821739821",
"serie": "7281729873981729839821819828371982739821",
"valor": 18.99,
"numero": "10000000"
}
],
"historico_transportes": [
{
"data": "2024-01-01 00:00:00",
"descricao": "Transportado hoje",
"comentario": "Comentado"
}
],
"arquivos": [
{
"tipo": "nota_fiscal",
"descricao": "Minha descrição",
"arquivo": "BASE_64_FILE"
}
]
}
Elementos da Requisição
condicao_pagamento : Código da condição de pagamento.
Campo obrigatório.
Tipo: String
cnpj_cliente : CNPJ do cliente.
Campo obrigatório.
Tipo: String
data_pedido : Data da criação do pedido.
Campo obrigatório.
Tipo: Datetime
total :Valor total do pedido.
Campo obrigatório.
Tipo: Float
numero_pedido : Número do pedido.
Campo obrigatório.
Tipo: String
razao_social: Razão social do cliente.
Tipo: String.
descontos: Descontos aplicados no pedido.
Tipo: Float.
acrescimos: Acréscimos aplicados no pedido.
Tipo: Float.
prazo_entrega: Data provável da entrega no cliente.
Campo obrigatório.
Tipo: Datetime.
observacao: Observações do pedido.
Tipo: String.
ean_ou_dun : Ean ou Dun do produto.
Campo obrigatório.
Tipo: String.
preco_faturado: Preço faturado por embalagem do produto.
Campo obrigatório.
Tipo: Float.
preco_unitario : Preço unitário por embalagem do produto.
Campo obrigatório.
Tipo: Float.
quantidade_faturado: Quantidade faturada do produto.
Tipo: Float.
tipo_embalagem : Tipo da embalagem do produto.
Campo obrigatório.
Exemplo: CAIXA, DISPLAY, UNIDADE.
Tipo: String.
tamanho_embalagem: Quantidade de itens por embalagem do produto
Tipo: Integer.
descricao: Descrição do produto
Campo obrigatório.
Tipo: String.
quantidade_devolvida: Quantidade por embalagem devolvida.
Campos destinado a pedidos com devolução.
Tipo: Integer.
status : Status do pedido.
Campo obrigatório.
Caso seja possível, informar os status Yandeh (processando, faturado,finalizado, cancelado, devolucao_total, finalizado_devolucao_parcial).
Tipo: String.
Nota fiscais:
tipo : Tipo da nota fiscal ( venda / devolucao)
Campo obrigatório.
Tipo: String.
data : Data de emissão da nota fiscal.
Campo obrigatório.
Tipo: Datetime.
chave: Chave da nota fiscal
Tipo: String.
serie: Série da nota fiscal
Tipo: String.
valor: Valor da nota fiscal
Tipo: Float.
numero: Número da nota fiscal
Tipo: Integer.
historico_transportes :
data : Data da ocorrência
Campo obrigatório caso informado o historico de transportes.
Tipo: Datetime.
comentario: Comentários.
Tipo: String.
arquivos:
tipo: Tipo do arquivo (nota fiscal, boleto, etc)
Tipo: String.
descricao: Descrição do arquivo.
Tipo: String.
arquivo : Arquivo a ser enviado
Tipo: Base64.
Sintaxe da Resposta
Se a requisição for bem-sucedida, será retornado o status code 200, acompanhado da seguinte resposta:
{
"detail": {
"success": true,
"message": "(OK) Envio de Pedido externo realizado com sucesso!"
},
"data": {
"status": "ok",
"message": "Pedido foi cadastrado com sucesso!"
}
}
Respostas para erros
400 Bad Request
Campos obrigatórios não informados
{
"detail": {
"success": false,
"message": "Erro na validação do payload enviado. ERROR_MSG: \"condicao_pagamento\" is required"
},
"data": "Erro na validação do payload enviado. ERROR_MSG: \"condicao_pagamento\" is required"
}
POST Pedidos externos
POST Pedido externo fornecedor
Endpoint responsável por enviar os pedidos de fornecedores, originados em outras plataformas, para exibição nos aplicativos da Yandeh."
Endpoint POST
URL:
Sintaxe da Requisição
-
Tipo de requisição: POST .
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Corpo da requisição:
Envio do JSON como exemplo abaixo:
{
"pedidos": [
{
"created_by": "john.doe@email.com.br",
"created_at": "2025-03-17T13:00:00.242220",
"modified_by": "john.doe@email.com.br",
"modified_at": "2025-03-17T13:15:00.123456",
"itens": [
{
"ean_ou_dun": "7506339394535",
"pallet_multiplo_dun": 1,
"preco_unitario": 12.5,
"quantidade": 10,
"alcada_percentual_aplicada": 0.1,
"alcada_percentual_sugerida": 0.1,
"alteracao_preco_alcada_impostos": 5.09,
"impostos": {
"st": {
"total": 1.62,
"aliquota": 0,
"total_unitario": 4.27
},
"ipi": {
"total": 0,
"aliquota": 0,
"total_unitario": 0
},
"pis": {
"total": 0,
"aliquota": 0,
"total_unitario": 0
},
"icms": {
"total": 10.85,
"aliquota": 0.12,
"total_unitario": 1.81
},
"cofins": {
"total": 0,
"aliquota": 0,
"total_unitario": 0
},
"fcp_st": {
"total": 0,
"aliquota": 0,
"total_unitario": 0
},
"fcp_icms": {
"total": 0,
"aliquota": 0,
"total_unitario": 0
}
}
}
],
"status": [
{
"data": "2025-03-17T13:00:00.123456",
"status": "processando"
}
],
"arquivos": [
{
"nome": "boleto.pdf",
"base64": "JVBERi0xLjcKJ..."
}
],
"total_liquido": 3750,
"notas_fiscais": [
{
"nome": "nota_fiscal.pdf",
"base64": "JVBERi0xLjcKJYGB...",
"numero_da_nota_fiscal": "35240504820606000124550010002662571396243021"
}
],
"cliente": "12345678901234",
"observacao": "Observações adicionais sobre o pedido.",
"prazo_entrega": "2025-04-05T13:00:00.242220",
"numero_pedido_fornecedor": "123456",
"numero_pedido_cliente": "78910",
"closed_by": null,
"closed_at": null,
"pedidos_relacionados": [
"987654"
],
"ultimo_status": "processando",
"data_ultimo_status": "2025-03-17T13:15:00.123456",
"origem": "JDE_Forca_Venda",
"ocorrencias_da_entrega": [
{
"codigo_ocorrencia": "00000",
"descricao": "RECEBIMENTO DE NF"
},
{
"codigo_ocorrencia": "00001",
"descricao": "ENTREGA REALIZADA NORMALMENTE"
}
],
"instrucoes_entrega": [
"Mercadoria frágil",
"Entrar pela esquerda do mercado"
],
"data_faturamento": "2025-03-17T13:15:00.123456",
"condicao_pagamento": "7"
}
]
}
Elementos da Requisição
Pedidos: Lista de pedidos.
created_at: Data de criação do pedido no ERP.
Campo obrigatório.
Tipo: Datetime
created_by: E-mail do usuário que criou o pedido no ERP.
Campo obrigatório.
Tipo: String
modified_at: Data de modificação do pedido.
Tipo: Datetime
modified_by: E-mail do usuário que criou o pedido.
Tipo: String
itens: Lista dos itens do pedido.
ean_ou_dun: Código ean ou dun do produto.
Campo obrigatório.
Tipo: String.
pallet_multiplo_dun: Múltiplo de venda para comercialização da embalagem.
Para DUNs que não serão comercializados em múltiplos, informe o valor 0.
Da mesma forma, para EANs vendidos de forma unitária (sem múltiplo), também deve ser informado o valor 0.
Campo obrigatório.
Tipo: Integer.
preco_unitario: Preço unitário do produto
Campo obrigatório.
Tipo: Integer.
quantidade: Número de unidades vendidas do produto.
Campo obrigatório.
Tipo: Integer.
alcada_percentual_aplicada: Valor em percentual de desconto aplicado sobre o produto.
Tipo: Float.
alcada_percentual_sugerida: Valor em percentual de desconto sugerida sobre o produto.
Tipo: Float.
alteracao_preco_alcada_impostos : Valor aplicado de imposto sobre o produto.
Tipo: Float.
impostos: Informações dos impostos sobre o produto.
st: Imposto Substituição tributária
total: Total do imposto ST para o produto.
Tipo: Float.
aliquota: Percentual do imposto ST sobre o item.Float
Tipo: Float.
total_unitario: Valor do imposto ST sobre a unidade do produto.
Tipo: Float.
ipi: Imposto sobre produtos industrializados.
total: Total do imposto IPI para o produto.
Tipo: Float.
aliquota: Percentual do imposto IPI sobre o item.Float
Tipo: Float.
total_unitario: Valor do imposto IPI sobre a unidade do produto.
Tipo: Float.
pis: Imposto Programa de Integração Social.
total: Total do imposto PIS para o produto.
Tipo: Float.
aliquota: Percentual do imposto PIS sobre o item.Float
Tipo: Float.
total_unitario: Valor do imposto PIS sobre a unidade do produto.
Tipo: Float.
icms: Imposto sobre Circulação de Mercadorias e Serviços.
total: Total do imposto ICMS para o produto.
Tipo: Float.
aliquota: Percentual do imposto ICMS sobre o item.Float
Tipo: Float.
total_unitario: Valor do imposto ICMS sobre a unidade do produto.
Tipo: Float.
cofins: Imposto Contribuição para o financiamento da seguridade social.
total: Total do imposto COFINS para o produto.
Tipo: Float.
aliquota: Percentual do imposto COFINS sobre o item.Float
Tipo: Float.
total_unitario: Valor do imposto COFINS sobre a unidade do produto.
Tipo: Float.
fcp_st: Imposto Fundo de Combate à Pobreza - Substituição Tributárial.
total: Total do imposto FCP ST para o produto.
Tipo: Float.
aliquota: Percentual do imposto FCP ST sobre o item.Float
Tipo: Float.
total_unitario: Valor do imposto FCP ST sobre a unidade do produto.
Tipo: Float.
fcp_icms : Imposto Fundo de Combate à Pobreza - ICMS.
total: Total do imposto FCP ICMS para o produto.
Tipo: Float.
aliquota: Percentual do imposto FCP ICMS sobre o item.Float
Tipo: Float.
total_unitario: Valor do imposto FCP ICMS sobre a unidade do produto.
Tipo: Float.
status: Status ds pedidos.
Data: Data da inclusão do status.
Campo obrigatório.
Tipo: Datetime.
status : Status do pedido.
Campo obrigatório.
Tipo: String.
*Status permitidos: aguardando_revisao, pendente, processando, faturado, enviado, finalizado, finalizado_devolucao_parcial, devolucao_total, cancelado, cancelado_solicitacao_cliente, cancelado_solicitacao_fornecedor e cancelado_reprovado_financeiro.
total_liquido: Total líquido do pedido.
Campo obrigatório.
Tipo: Float.
arquivos: Arquivos do pedido.
Nome: Nome do arquivo a ser enviado.
Tipo: String.
base64: Arquivo a ser enviado.
Tipo: base64.
notas_fiscais: Informações da nota fiscal.
nome: Nome do arquivo a ser enviado.
Tipo: String.
base64: Danfe ou Xml a ser enviado.
Tipo: base64.
numero_da_nota_fiscal: Número da nota fiscal.
Tipo: String.
cliente: CNPJ do cliente.
Campo obrigatório.
Tipo: String.
observacao: Observações do pedido.
Tipo: String.
prazo_entrega: Data da previsão de entrega do pedido.
Tipo: Datetime.
numero_pedido_fornecedor: Número do pedido no fornecedor.
Campo obrigatório.
Tipo: String.
numero_pedido_cliente: Número do pedido do cliente.
Campo não obrigatório.
*Em conjunto com o CNPJ do cliente, o campo forma a chave que identifica se o pedido é novo ou se trata de uma atualização de um pedido existente.
Tipo: String.
closed_by: Email do usuário que finalizou o pedido.
Campo obrigatório.
Tipo: String.
closed_at : Data do fechamento do pedido.
Tipo: Datetime.
pedidos_relacionados: Lista de pedidos associados a este pedido.
Tipo: Array de String.
ultimo_status: Último status atualizado para o pedido.
Campo obrigatório.
*Status permitidos: aguardando_revisao, pendente, processando, faturado, enviado, finalizado, finalizado_devolucao_parcial, devolucao_total, cancelado, cancelado_solicitacao_cliente, cancelado_solicitacao_fornecedor e cancelado_reprovado_financeiro.
Tipo: String.
data_ultimo_status: Data da última atualização de status.
Campo obrigatório.
Tipo: Datetime.
origem: Fonte ou sistema de onde o pedido foi gerado.
Campo obrigatório.
*Origens padrão disponíveis: APP_Forca_Venda, Ecommerce e ERP_Forca_Venda.
Caso o fornecedor possua uma origem própria que deseja utilizar, é necessário informar o time da Yandeh para que seja realizado o cadastro.
Tipo: String.
ocorrencias_da_entrega: Informações de ocorrências de transporte do pedido.
codigo_ocorrencia : Código da ocorrência logística.
Tipo: String.
descricao: Descrição da ocorrência logística.
Tipo: String.
instrucoes_entrega: Instruções da entrega.
Aceito 02 instruções.
Tipo: Array de String.
data_faturamento: Data do faturamento.
Campo obrigatório.
Tipo: Datetime.
condicao_pagamento: Código da condição de pagamento do pedido.
Campo obrigatório.
Tipo: String.
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará sucesso com status code 200.
Exemplo de retorno:
{
"detail": {
"success": true,
"message": "Pedidos salvos com sucesso."
},
"data": {
"pedidos_criados": [
42736
],
"pedidos_atualizados": []
}
}
Respostas para erros
Status code 207: Multi status
Caso a requisição contenha pedidos válidos e inválidos, os pedidos válidos serão processados normalmente, enquanto os inválidos serão retornados para ajuste.
Exemplo de payload:
{
"detail": {
"success": true,
"message": "Pedidos válidos criados com sucesso."
},
"data": {
"pedidos_criados": [
12345
],
"pedidos_atualizados": [
56789
],
"pedidos_invalidos": [
{
"index": 1,
"erros": [
{
"mensagem": "O campo \"cliente\" deve ser um CNPJ válido.",
"detalhe": "Valor recebido: 123456789"
}
]
}
]
}
}
Status code 400: Bad Request
Caso algum campo seja enviado de forma incorreta, será retornada uma mensagem de erro contendo:
-
O índice (index) do pedido com problema.
-
A descrição do erro.
-
No campo detalhe, o valor recebido, para facilitar a correção.
{
"detail": {
"success": false,
"message": "Todos os pedidos são inválidos"
},
"data": [
{
"index": 0,
"erros": [
{
"mensagem": "O campo \"status\" deve ter um dos valores permitidos: aguardando_revisao, pendente, processando, faturado, enviado, finalizado, finalizado_devolucao_parcial, devolucao_total, cancelado, cancelado_solicitacao_cliente, cancelado_solicitacao_fornecedor ou cancelado_reprovado_financeiro",
"detalhe": "testando status fake"
}
]
}
]
}
detalhe
Observação sobre o erro.
Tipo: String.
POST Pedido Externo Bruto
Última Atualização: 20/03/2025
Este endpoint recebe pedidos brutos enviados pelo fornecedor. As informações do sistema do fornecedor não precisam corresponder exatamente aos dados cadastrados na Yandeh.
Se for necessário alterar um pedido, nosso sistema o identificará pelo campo "numero_pedido_fornecedor". Nesse caso, basta enviar apenas os campos que precisam ser modificados.
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:
Elementos da Requisição
created_at*
Data de criação do pedido no sistema interno do fornecedor.
Tipo: Datetime.
created_by*
E-mail do usuário que criou o pedido no sistema interno do fornecedor.
Tipo: String.
modified_at
Data de modificação do pedido no sistema interno do fornecedor.
Tipo: Datetime.
modified_by
E-mail do usuário que modificou o pedido no sistema interno do fornecedor.
Tipo: Data no formato ISO 8601.
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.
pallet_multiplo_dun*
Campo para informar o múltiplo mínimo de vendas, caso utilizem o formato de quantidade mínimas por produto.
Tipo: Integer.
preco_unitario*
Valor unitário do item.
Tipo: Float.
quantidade*
Quantidade de produtos no estoque.
Tipo: Integer.
alcada_percentual_aplicada
Campo da alçada percentual aplicada.
Tipo: Float.
alcada_percentual_sugerida
Campo da alçada percentual sugerida.
Tipo: Float.
alteracao_preco_alcada_impostos
Campo da alçada percentual impostos.
Tipo: Float.
impostos
Total da soma dos impostos.
Tipo: Float.
st
(Substituição Tributária): Imposto que transfere a responsabilidade de pagamento para um único contribuinte na cadeia de comercialização.
Tipo: Objeto.
total
Valor total do imposto devido.
Tipo: Float.
aliquota
Percentual do imposto sobre a base de cálculo.
Tipo: Float.
total_unitario
Valor do imposto por unidade
Tipo: Float.
ipi
(Imposto sobre Produtos Industrializados): Imposto sobre produtos industrializados, cobrando na produção ou importação.
Tipo: Objeto.
total
Valor total do imposto devido.
Tipo: Float.
aliquota
Percentual do imposto sobre a base de cálculo.
Tipo: Float.
total_unitario
Valor do imposto por unidade
Tipo: Float.
pis
(Programa de Integração Social): Contribuição social sobre a receita bruta das empresas, destinada ao financiamento da seguridade social.
Tipo: Objeto.
total
Valor total do imposto devido.
Tipo: Float.
aliquota
Percentual do imposto sobre a base de cálculo.
Tipo: Float.
total_unitario
Valor do imposto por unidade
Tipo: Float.
icms
(Imposto sobre Circulação de Mercadorias e Serviços): Imposto sobre a circulação de mercadorias e serviços, cobrado pelos estados.
Tipo: Objeto.
total
Valor total do imposto devido.
Tipo: Float.
aliquota
Percentual do imposto sobre a base de cálculo.
Tipo: Float.
total_unitario
Valor do imposto por unidade
Tipo: Float.
cofins
(Contribuição para o Financiamento da Seguridade Social): Contribuição social sobre a receita bruta, usada para financiar a seguridade social.
Tipo: Objeto.
total
Valor total do imposto devido.
Tipo: Float.
aliquota
Percentual do imposto sobre a base de cálculo.
Tipo: Float.
total_unitario
Valor do imposto por unidade
Tipo: Float.
fcp_st
(Fundo de Combate à Pobreza - Substituição Tributária): Adicional
do ICMS-ST destinado ao combate à pobreza nos estados.
Tipo: Objeto.
total
Valor total do imposto devido.
Tipo: Float.
aliquota
Percentual do imposto sobre a base de cálculo.
Tipo: Float.
total_unitario
Valor do imposto por unidade
Tipo: Float.
fcp_icms
(Fundo de Combate à Pobreza - ICMS): Adicional do ICMS para financiar programas de combate à pobreza.
Tipo: Objeto.
total
Valor total do imposto devido.
Tipo: Float.
aliquota
Percentual do imposto sobre a base de cálculo.
Tipo: Float.
total_unitario
Valor do imposto por unidade
Tipo: Float.
pedidos
Lista de pedidos
Tipo: Lista de objeto.
status*
Dados do status do pedido.
Tipo: Array de Objeto.
data*
Data da criação dos status.
Tipo: Datetime.
status *
Status do pedido. Os status permitidos são: aguardando_revisao, pendente, processando, faturado, enviado, finalizado, finalizado_devolucao_parcial, devolucao_total, cancelado, cancelado_solicitacao_cliente, cancelado_solicitacao_fornecedor e cancelado_reprovado_financeiro.
Obs.: caso o campo "origem" seja derivado do JDE, use o status "processando" ao invés de "pendente".
Tipo: String.
arquivos
Arquivos do pedido.
Tipo: Array de Objeto.
nome
Nome do arquivo com extensão.
Tipo: String.
base64
Arquivo em base64
Tipo: String.
total_liquido*
Total líquido do pedido.
Tipo: Float.
notas_fiscais
Notas fiscais do pedido.
Tipo: Array de Objeto.
nome
Nome do arquivo com extensão.
Tipo: String.
base64
Arquivo em base64
Tipo: String.
cliente*
CNPJ do cliente.
Tipo: String.
observacao
Observação do pedido
Tipo: String.
prazo_entrega
Data do prazo de entrega.
Tipo: Datetime.
numero_pedido_fornecedor*
Número do pedido no sistema do fornecedor.
Tipo: String.
numero_pedido_cliente
Número do pedido no sistema do cliente.
Tipo: String.
closed_by
E-mail do usuário que fechou o pedido.
Tipo: String.
closed_at
Data de fechamento do pedido.
Tipo: Datetime.
pedidos_relacionados
Lista de pedidos relacionados. Deve conter o número do pedido pai se aplicável.
Tipo: Array de String.
ultimo_status*
Última atualização de status do pedido.
Status do pedido. Os status permitidos são: aguardando_revisao, pendente, processando, faturado, enviado, finalizado, finalizado_devolucao_parcial, devolucao_total, cancelado, cancelado_solicitacao_cliente, cancelado_solicitacao_fornecedor e cancelado_reprovado_financeiro.
Obs.: caso o campo "origem" seja derivado do JDE, use o status "processando" ao invés de "pendente".
Tipo: String
data_ultimo_status*
Data e hora da última atualização de status.
Tipo: Datetime.
origem*
Origem do pedido. Valores possíveis: "JDE_Forca_Venda", "JDE_EDI", "EDIM", "ERP_Forca_Venda", "ERP_EDI", "JDE_Manual", "AFV" ou "EDI".
Tipo: String.
ocorrencias_da_entrega
Lista de ocorrências do pedido.
Obs.: Sempre mandar todas as ocorrências no payload.
Tipo: Array de Objeto.
codigo_ocorrencia
Código interno do fornecedor para fazer o vínculo com a ocorrência.
Tipo: String.
descricao
Descrição da ocorrência.
Tipo: String.
instrucoes_entrega
Instrução de entrega 1 e instrução de entrega 2.
Obs.: Somente posições 0 e 1 serão consideradas.
Tipo: Array de String.
data_faturamento*
Data e hora do faturamento
Tipo: Datetime.
condicao_pagamento
ID da condição de pagamento da Yandeh ou o código da condição de pagamento externo.
Tipo: ID ou String.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
400 Bad Request
Caso os campos sejam enviados de forma inadequada, apresentaremos erros com o índice (index) do pedido que deu erro e a sequência de erros, para que possa ser corrigido:
detail
Dados de retorno da requisição.
Tipo: JSON.
success
Identificador de sucesso da requisição.
Tipo: Boolean.
message
Mensagem de retorno da requisição.
Tipo: String.
data
Detalhes da requisição.
Tipo: Array de objeto.
index
Posição do pedido no payload de pedidos
Tipo: Inteiro.
erros
Descrição dos erros.
Tipo: Array de objeto.
mensagem
Motivo do erro.
Tipo: String.
detalhe
Observação sobre o erro.
Tipo: String.
Sintaxe da Resposta
201 Created
Caso tudo esteja de acordo, será retornado o seguinte o payload:
detail
Dados de retorno da requisição.
Tipo: JSON.
status
Status code da requisição.
Tipo: Number.
message
Mensagem de retorno da requisição.
Tipo: String.
data
Detalhes da requisição.
Tipo: JSON.
pedidos_criados
Tipo: Array de Inteiros.
pedidos_atualizados
IDs dos pedidos atualizados.
Tipo: Array de Inteiros.
IDs dos pedidos criados
207 Multi-Status
Caso tenha pedidos válidos e inválidos na mesma requisição, os pedidos válidos serão processados normalmente e os inválidos serão retornados para ajustar. Exemplo de payload:
detail
Dados de retorno da requisição.
Tipo: JSON.
status
Status code da requisição.
Tipo: Number.
message
Mensagem de retorno da requisição.
Tipo: String.
data
Detalhes da requisição.
Tipo: JSON.
pedidos_criados
Tipo: Array de Inteiros.
IDs dos pedidos atualizados.
pedidos_atualizados
IDs dos pedidos atualizados.
Tipo: Array de Inteiros.
pedidos_invalidos
Detalhes dos pedidos inválidos.
Tipo: Array de Objeto.
index
Posição do pedido no payload de pedidos
Tipo: Inteiro.
erros
Descrição dos erros.
Tipo: Array de objeto.
mensagem
Motivo do erro.
Tipo: String.
detalhe
Observação sobre o erro.
Tipo: String.