Exemplo do pedido enviado pelo Octalog

POST

https://seu.endpoint.com.br

Abaixo está um exemplo do payload que será enviado pelo Octalog para o seu endpoint.
Crie seu endpoint e envie por email para [email protected] para ser configurado

Informações importantes:

A API deve estar disponível em um ambiente HTTPS.

É possível enviar parâmetros personalizados no cabeçalho (headers) da requisição. Caso sejam necessários, informe-os juntamente com a URL do endpoint.

O campo IDPrazoEntrega pode ser obtido por meio do endpoint: https://api.octalog.com.br/prazo-entrega

Tracking dos pedidos

O identificador de rastreamento (tracking) será composto pela combinação do Pedido e do Volume. Portanto, ao integrar o pedido, é imprescindível armazenar e considerar o campo TotalVolumes (e a identificação de cada volume), pois essa informação será utilizada posteriormente para a atualização do status de rastreamento de cada volume.

Requisição

Parâmetros Bodyapplication/jsonNecessário

Exemplo

{
  "Pedido": "PED-20260728-0001",
  "DataVenda": "2026-07-28T09:30:00",
  "DataFaturamento": "2026-07-28T10:15:00",
  "DataPromessaCliente": "2026-07-30T18:00:00",
  "IDPrazoEntrega": 3,
  "TotalVolumes": 2,
  "DadosFiscais": {
    "ChaveNotaFiscal": "35260712345678000123550010000012341000012345",
    "NumeroNotaFiscal": "1234",
    "SerieNotaFiscal": "1",
    "ValorTotalReais": 1599.90
  },
  "Remetente": {
    "RazaoSocial": "Empresa Exemplo LTDA",
    "CNPJ": "12345678000195",
    "InscricaoEstadual": "123456789",
    "Endereco": "Av. Paulista",
    "Numero": "1000",
    "Bairro": "Bela Vista",
    "Cidade": "São Paulo",
    "UF": "SP",
    "CEP": "01310000"
  },
  "Destinatario": {
    "Nome": "João da Silva",
    "Documento": "12345678901",
    "InscricaoEstadual": "",
    "Endereco": "Rua das Flores",
    "Numero": "250",
    "Bairro": "Centro",
    "Cidade": "Campinas",
    "UF": "SP",
    "CEP": "13010000",
    "Complemento": "Apto 42",
    "PontoReferencia": "Próximo ao supermercado",
    "Telefone": "11999998888"
  }
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://seu.endpoint.com.br' \
--header 'Content-Type: application/json' \
--data '{
  "Pedido": "PED-20260728-0001",
  "DataVenda": "2026-07-28T09:30:00",
  "DataFaturamento": "2026-07-28T10:15:00",
  "DataPromessaCliente": "2026-07-30T18:00:00",
  "IDPrazoEntrega": 3,
  "TotalVolumes": 2,
  "DadosFiscais": {
    "ChaveNotaFiscal": "35260712345678000123550010000012341000012345",
    "NumeroNotaFiscal": "1234",
    "SerieNotaFiscal": "1",
    "ValorTotalReais": 1599.90
  },
  "Remetente": {
    "RazaoSocial": "Empresa Exemplo LTDA",
    "CNPJ": "12345678000195",
    "InscricaoEstadual": "123456789",
    "Endereco": "Av. Paulista",
    "Numero": "1000",
    "Bairro": "Bela Vista",
    "Cidade": "São Paulo",
    "UF": "SP",
    "CEP": "01310000"
  },
  "Destinatario": {
    "Nome": "João da Silva",
    "Documento": "12345678901",
    "InscricaoEstadual": "",
    "Endereco": "Rua das Flores",
    "Numero": "250",
    "Bairro": "Centro",
    "Cidade": "Campinas",
    "UF": "SP",
    "CEP": "13010000",
    "Complemento": "Apto 42",
    "PontoReferencia": "Próximo ao supermercado",
    "Telefone": "11999998888"
  }
}'

Respostas

🟢200Success

application/json

Bodyapplication/json

Exemplo

[
  {
    "IDExterno": "TRK-000001",
    "Pedido": "PED-20260728-0001",
    "CNPJRemetente": "12345678000195",
    "Volume": 1
  },
  {
    "IDExterno": "TRK-000002",
    "Pedido": "PED-20260728-0001",
    "CNPJRemetente": "12345678000195",
    "Volume": 2
  },
  {
    "IDExterno": "TRK-000003",
    "Pedido": "PED-20260728-0002",
    "CNPJRemetente": "98765432000110",
    "Volume": 1
  }
]

Página anterior

🎯 Visão Geral Transportadoras e Parceiros

Próxima página

Configuração da API da Transportadora para receber pedidos