E-commerce
Produtos, carrinho e pedidos de cada contato.
A loja dentro da conversa: os produtos do E-commerce (Ferramentas › Ecommerce), o carrinho de cada contato e os pedidos. Cuidado com os centavos: os valores do carrinho e do pedido (total, subtotal, coupon_discount) e o amount_received vão em centavos (8082 = R$ 80,82), mas o price do produto e o de cada item do carrinho não (49.9 = R$ 49,90). Veja o guia Carrinho, pedidos e produtos e Carrinho e pedidos na conversa.
Endpoints
/products/{product_id}POSTAtualizar produto/products/{product_id}POSTEnviar produtos ao contato/contacts/{contact_id}/send/productsGETConsultar carrinho/contacts/{contact_id}/cartDELETEEsvaziar carrinho/contacts/{contact_id}/cartPOSTAdicionar produto ao carrinho/contacts/{contact_id}/cart/{product_id}DELETERemover produto do carrinho/contacts/{contact_id}/cart/{product_id}GETConsultar pedido/contacts/{contact_id}/order/{order_id}POSTAlterar pedido/contacts/{contact_id}/order/{order_id}POSTMarcar pedido como pago/contacts/{contact_id}/pay/{order_id}O objeto: Carrinho
O carrinho de um contato. A consulta de pedido devolve o mesmo formato. Os valores de dinheiro vão em centavos, menos o price de cada item.
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).
{
"order_id": "PED-1001",
"page_id": 123456,
"user_id": 123456789,
"currency": "BRL",
"total": 8082,
"subtotal": 8980,
"total_items": 2,
"coupon_discount": 898,
"coupon": "BEMVINDO10",
"line_items": [
{
"id": 6001,
"name": "Camiseta Básica Preta",
"img": "https://exemplo.com.br/produtos/camiseta-preta.jpg",
"price": 49.9,
"amount": 1,
"descr_min": "Camiseta 100% algodão, gola redonda.",
"manufacturer": 0,
"variant": "M",
"user_msg": ""
},
{
"id": 6002,
"name": "Boné Aba Curva",
"img": "https://exemplo.com.br/produtos/bone.jpg",
"price": 39.9,
"amount": 1,
"descr_min": "Boné ajustável de algodão.",
"manufacturer": 0,
"variant": "",
"user_msg": "Embrulhar para presente."
}
],
"contact": {
"id": 123456789,
"page_id": 123456,
"first_name": "Ana",
"last_name": "Souza",
"channel": 5,
"profile_pic": "https://exemplo.com.br/fotos/ana.jpg",
"locale": "pt_BR",
"gender": 0,
"timezone": -3,
"last_sent": 1792933200000,
"last_delivered": 1792933202000,
"last_seen": 1792933500000,
"last_interaction": 1792933560000,
"subscribed_date": "2026-03-10 14:22:00",
"subscribed": 1,
"tags": [
{
"id": 2001,
"name": "cliente-vip"
}
],
"custom_fields": [
{
"id": 3001,
"name": "cidade",
"type": 0,
"value": "São Paulo"
}
]
}
}