Skip to main content

Endpoint

Parâmetros

Estrutura de Campos

Dados Gerais do Pedido

Cliente

Endereço de Entrega (Opcional, se diferente do cliente)

Itens do Pedido

Marcadores

Informações de Pagamento

Parcelas

Transportadora e Frete

Descontos e Despesas

Observações

Vendedor

Campos Tributários

Intermediador (Opcional)

Pagamentos Integrados (Opcional)

Retorno

Exemplo de Parâmetro XML Simplificado

Exemplo de Parâmetro JSON Simplificado

Exemplo de Parâmetro XML Completo

Exemplo de Parâmetro JSON Completo

Exemplo de Chamada com XML

Exemplo de Chamada REST com JSON

Exemplos de Retorno

Sucesso

Erro - Validação (campo obrigatório faltando)

Erro - Cliente não encontrado

Erro - Produto sem estoque

Erro - Autenticação

Erro - Registro duplicado

Notas Importantes

  • Separador decimal: Use ponto (.) para valores decimais, por exemplo “5.25”
  • Formato de data: dd/mm/aaaa, por exemplo “20/05/2024”
  • Comportamento de busca: Campos de código buscam registros existentes; registros encontrados carregam dados adicionais do banco
  • Atualização de cliente: Por padrão, os dados do cliente são atualizados (atualizar_cliente = “S”)
  • Validação de vendedor: Vendedores não existentes geram erro
  • Tratamento de marcadores: Marcadores não encontrados são criados automaticamente