Consultar pedido
/contacts/{contact_id}/order/{order_id}Devolve um pedido do contato, no mesmo formato do carrinho: os itens, o cupom e os totais em centavos (menos o price de cada item). Veja Pedidos, cupons e vendedores.
curl "https://app.nextagsai.com.br/api/contacts/123456789/order/PED-1001" \
-H "X-ACCESS-TOKEN: $NEXTAGS_API_KEY"const resposta = await fetch('https://app.nextagsai.com.br/api/contacts/123456789/order/PED-1001', {
headers: {
'X-ACCESS-TOKEN': process.env.NEXTAGS_API_KEY,
},
});
const dados = await resposta.json();
console.log(resposta.status, dados);import os
import requests
resposta = requests.get(
"https://app.nextagsai.com.br/api/contacts/123456789/order/PED-1001",
headers={"X-ACCESS-TOKEN": os.environ["NEXTAGS_API_KEY"]},
timeout=30,
)
print(resposta.status_code, resposta.json())<?php
$ch = curl_init('https://app.nextagsai.com.br/api/contacts/123456789/order/PED-1001');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'X-ACCESS-TOKEN: ' . getenv('NEXTAGS_API_KEY'),
],
]);
$dados = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($dados);Autenticação
Mande a chave de API da conta no cabeçalho X-ACCESS-TOKEN de cada chamada. Veja Autenticação com a chave de API.
Parâmetros de caminho
contact_idintegerobrigatórioO ID do contato.
order_idstringobrigatórioO ID do pedido (texto). Ele vem em order_id, no carrinho e no pedido.
Respostas
O pedido.
Ver os 43 campos
order_idstringO ID do pedido (texto).
page_idintegerO ID da conta.
user_idintegerO ID do contato.
currencystringA moeda da loja, como BRL.
totalintegerO total, em centavos.
subtotalintegerA soma dos itens, em centavos.
total_itemsintegerQuantos itens o carrinho tem.
coupon_discountintegerO desconto do cupom, em centavos.
couponstringO código do cupom aplicado (o Código de desconto da aba Cupons).
line_itemsarray de objeto Item do carrinhoOs itens do carrinho.
line_items[].idintegerO ID do produto.
line_items[].namestringO nome do produto.
line_items[].imgstringO endereço da imagem do produto.
line_items[].pricenumberO preço de uma unidade, na moeda da loja. Não é em centavos: 49.9 = R$ 49,90.
line_items[].amountintegerA quantidade.
line_items[].descr_minstringA descrição curta do produto.
line_items[].manufacturerintegerO ID do vendedor do produto (aba Vendedores).
line_items[].variantstringA variante escolhida, como o tamanho ou a cor.
line_items[].user_msgstringO pedido especial que o contato anotou no item, quando o produto permite anexar notas.
contactobjeto ContatoO contato dono do carrinho.
contact.idintegerO ID do contato: o contact_id das outras chamadas.
contact.page_idintegerO ID da conta.
contact.first_namestringO nome.
contact.last_namestringO sobrenome.
contact.channelintegerO canal atual do contato: 0 Messenger, 5 WhatsApp, 8 Telegram, 9 Webchat, 10 Instagram, 17 TikTok.
contact.profile_picstringO endereço da foto de perfil.
contact.localestringO idioma do contato, como pt_BR.
contact.genderintegerO gênero: 0 feminino, 1 masculino, 2 desconhecido.
contact.timezoneintegerO fuso horário do contato, em horas em relação ao UTC (-3 em Brasília).
contact.last_sentintegerQuando a última mensagem foi enviada ao contato, em Unix timestamp em milissegundos.
contact.last_deliveredintegerQuando a última mensagem foi entregue ao contato, em Unix timestamp em milissegundos.
contact.last_seenintegerQuando o contato foi visto pela última vez (Visto pela última vez, no app), em Unix timestamp em milissegundos.
contact.last_interactionintegerQuando o contato interagiu com a conta pela última vez, em Unix timestamp em milissegundos.
contact.subscribed_datestringQuando o contato entrou na conta, em UTC, no formato 2026-10-12 14:40:00.
contact.subscribedinteger1 inscrito; 2 inscrição cancelada (o contato saiu das transmissões e não recebe Broadcasts). Veja Contatos que pediram para sair das transmissões.
contact.tagsarray de objeto EtiquetaAs etiquetas do contato.
contact.tags[].idintegerO ID da etiqueta.
contact.tags[].namestringO nome da etiqueta.
contact.custom_fieldsarray de objeto Campo personalizadoOs campos personalizados do contato, com o valor de cada um.
contact.custom_fields[].idintegerO ID do campo.
contact.custom_fields[].namestringO nome do campo.
contact.custom_fields[].typeintegerO tipo: 0 texto, 1 número, 2 data, 3 data e hora, 4 sim/não, 5 texto longo, 6 seleção única, 7 seleção múltipla.
Valores: 0 1 2 3 4 5 6 7
contact.custom_fields[].valuestring ou numberO valor do contato, no formato do tipo: texto nos campos de texto e de texto longo; número nos de número, de data e de data e hora (Unix timestamp, em segundos) e de sim/não (1 ou 0).
A chave de API não veio no cabeçalho ou não vale (foi excluída ou está incompleta). Veja Autenticação.
Relacionados
Limites, erros e boas práticas
Guia que usa este endpointCarrinho, pedidos e produtos
Guia que usa este endpointPedidos, cupons e vendedores
Tutorial da Central de AjudaConsultar produto
GET /products/{product_id}Atualizar produto
POST /products/{product_id}Enviar produtos ao contato
POST /contacts/{contact_id}/send/productsEste conteúdo ajudou?
Obrigado! Sua resposta ajuda a melhorar a central.