API: Módulo Pedidos (orders)

Consultar pedidos (PF/PJ com CNPJ para NFe), listar por data ou documento e adicionar código de rastreio via API.

Publicado em 04/08/2026
Atualizado em 08/10/2026
Equipe do Interago

O módulo orders consulta pedidos e registra código de rastreio. Ideal para ERPs e hubs logísticos (incluindo emissão de NFe com dados de PJ).

⚠️ A API precisa estar habilitada para utilizá-la. Veja o passo a passo em API - Como habilitar.

Endpoint: https://app.interago.com.br/App/Api/index.php

Todas as chamadas são POST com:

Cabeçalho Authorization: Bearer SEU_TOKEN
websiteId no corpo
module e method identificando o recurso

Ative a API e gere o token em #api.main?general (veja API - Como habilitar). Limite: 60 requisições autenticadas por minuto por website. Trate o token como senha.

No painel, o testador e a documentação do método ficam em #api.main?{módulo}&{método}.

Métodos principais

Método	Para que serve
`getOrder`	Detalhe completo do pedido por `orderId` (cliente PF/PJ, itens, frete, pagamento, rastreio).
`listOrders`	Lista paginada por intervalo de datas e status (padrão 3–6).
`listOrdersByDocument`	Lista pedidos de um CPF/CNPJ no intervalo informado.
`addTrackingCodeToOrder`	Grava rastreio, promove para Enviado (6) e tenta notificar o cliente.

Cliente PF e PJ em `getOrder`

O objeto order.customer traz sempre os mesmos campos. Em compra pessoa jurídica, use os campos corporative* para NFe/ERP:

document — CPF do contato (quando houver). Se o pedido só tiver CNPJ, cai no CNPJ.
type — individual (PF) ou corporate (PJ).
corporativeName — razão social.
corporativeFantasyName — nome fantasia.
corporativeDocument — CNPJ.
corporativeIE — inscrição estadual (ou vazio / ISENTO).

Em pedido PF, os campos corporative* vêm como string vazia.

curl -X POST 'https://app.interago.com.br/App/Api/index.php' \ -H 'Authorization: Bearer SEU_TOKEN' \ -H 'Content-Type: application/x-www-form-urlencoded' \ -d 'websiteId=SEU_WEBSITE_ID&module=orders&method=getOrder&orderId=12345'

Exemplo de customer em pedido PJ:

{
  "name": "Maria Silva",
  "email": "maria@empresa.com.br",
  "phone": "(11) 98888-7777",
  "document": "123.456.789-09",
  "type": "corporate",
  "corporativeName": "Empresa Exemplo LTDA",
  "corporativeFantasyName": "Empresa Exemplo",
  "corporativeDocument": "12.345.678/0001-90",
  "corporativeIE": "123.456.789.012"
}

Rastreio em um pedido

Informe trackingCode e apenas um entre orderId ou document. Pedidos elegíveis: status 3 (Autorizado), 4 (Pago) ou 5 (Preparado).

Por documento: se houver vários elegíveis, a API retorna MULTIPLE_ELIGIBLE_ORDERS — repita com o orderId.

Há um tutorial detalhado deste método na Central de Ajuda: API : Adicionando código de rastreio a um pedido via Curl.

Listagem

dateFrom e dateTo são obrigatórios em listOrders / listOrdersByDocument. Use page e pageSize (máx. 50). Status pode ser CSV, por exemplo 3,4,5,6.

Este artigo foi útil?