# Webhook de Pedido Este webhook é enviado sempre que ocorre uma operação relacionada a um pedido na plataforma. Ele é disparado automaticamente a cada evento associado ao ciclo de vida do pedido, permitindo que sistemas integrados acompanhem e processem alterações de status em tempo real. ### Eventos * order.canceled * order.expired * order.completed ### Payload de exemplo {% code title="payload.json" %} ```json { "company": { "id": "7268299385367167832", "name": "company", "email": "company.test@email.com", "phone": "+55 11999999999", "document_type": "cnpj", "document_number": "00000000000000", "owner": { "id": "7268299385346197469", "name": "Lucas da Silva", "email": "lucas@company.com", "phone": "+5511999999999", "document_type": "cpf", "document_number": "00000000000" } }, "payload": { "object": "order", "event": "order.completed", "created_at": "2026-01-07 15:08:42", "data": { "customer": { "id": "7407269030890449654", "name": "João da Silva", "email": "joao@example.com", "phone_country": null, "phone": "+55 11999999999", "document_type": "cpf", "document_number": "00000000000" }, "main_product": { "id": 7338938162967740000, "title": "Produto 1", "price": 10000 }, "order_bump": [ { "product_id": 7338938162967740000, "title": "Produto 1", "price": 10000, "order_bump": true } ], "transactions": [ { "payment_method": "credit_card", "instalments": 1, "currency": "BRL", "value": 11400, "status": "approved", "credit_card": { "instalments": 1, "brand": "VISA", "last_digit": "1234" } } ], "utms": [] } } } ``` {% endcode %} ### Detalhes | Campo | Tipo | Descrição | | ------- | ------ | --------------------------------------------- | | company | object | Informações da empresa responsável pela venda | | payload | object | Dados do evento disparado | #### 🏢 company Dados da empresa (organização) proprietária do pedido. | Campo | Tipo | Obrigatório | Descrição | | ---------------- | -------------- | ----------- | -------------------------------- | | id | string | Sim | Id da empresa | | name | string | Sim | Nome da empresa | | email | string \| null | Não | Email principal da empresa | | phone | string \| null | Não | Telefone de contato | | document\_type | string | Sim | Tipo de documento (cnpj ou cpf) | | document\_number | string | Sim | Número do documento | | owner | object | Sim | Dados do proprietário da empresa | #### 👤 company.owner Dados do proprietário (responsável legal). | Campo | Tipo | Obrigatório | Descrição | | ---------------- | -------------- | ----------- | ------------------------------- | | id | string | Sim | Id do proprietário | | name | string | Sim | Nome completo | | email | string | Sim | Email de contato | | phone | string \| null | Não | Telefone | | document\_type | string | Sim | Tipo de documento (cpf ou cnpj) | | document\_number | string | Sim | Número do documento | #### 📦 payload Informações do evento disparado. | Campo | Tipo | Obrigatório | Descrição | | ----------- | ------ | ----------- | -------------------------------------------- | | object | string | Sim | Tipo do objeto relacionado ao evento (order) | | event | string | Sim | Nome do evento (order.completed) | | created\_at | string | Sim | Data e hora de criação do evento (UTC) | | data | object | Sim | Dados específicos do pedido | #### 🧾 payload.data Dados detalhados do pedido. | Campo | Tipo | Obrigatório | Descrição | | ------------- | ------ | ----------- | ----------------------------------------------------- | | customer | object | Sim | Informações do comprador. | | main\_product | object | Sim | Produto principal do pedido. | | order\_bump | object | Sim | Lista de produtos adicionais (order bump). | | transactions | object | Sim | Lista de transações financeiras associadas ao pedido. | | utms | array | Sim | Informações de UTM para rastreamento de campanha. | #### 👤 payload.data.customer Informações do comprador. | Campo | Tipo | Obrigatório | Descrição | | ---------------- | -------------- | ----------- | ----------------------------- | | id | string | Sim | Id do cliente | | name | string | Sim | Nome completo | | email | string | Sim | Email do cliente | | phone\_country | string \| null | Não | Código do país do telefone | | phone | string \| null | Não | Telefone do cliente | | document\_type | string \| null | Não | Tipo de documento (cpf, cnpj) | | document\_number | string \| null | Não | Número do documento | #### 📦 payload.data.main\_product Produto principal do pedido. | Campo | Tipo | Obrigatório | Descrição | | ----- | ------- | ----------- | ---------------------------- | | id | number | Sim | Id do produto | | title | string | Sim | Nome do produto | | price | integer | Sim | Preço do produto em centavos | #### ➕ payload.data.order\_bump Lista de produtos adicionais (order bump). | Campo | Tipo | Obrigatório | Descrição | | ----------- | ------- | ----------- | ------------------------- | | product\_id | number | Sim | Id do produto | | title | string | Sim | Nome do produto | | price | number | Sim | Preço em centavos | | order\_bump | boolean | Sim | Indica se é um order bump | {% hint style="info" %} Pode ser um array vazio caso não existam produtos adicionais. {% endhint %} #### 💳 payload.data.transactions Lista de transações financeiras associadas ao pedido. | Campo | Tipo | Obrigatório | Descrição | | --------------- | ------ | ----------- | ----------------------------------------------- | | payment\_method | string | Sim | Método de pagamento (credit\_card, pix, boleto) | | instalments | number | Sim | Número de parcelas | | currency | string | Sim | Moeda da transação (BRL) | | value | number | Sim | Valor total pago em centavos | | status | string | Sim | Status da transação (approved, failed, etc.) | | credit\_card | object | Condicional | Dados do cartão (apenas se método for cartão) | | pix | object | Condicional | Dados do pix (apenas se método for pix) | | boleto | object | Condicional | Dados do boleto (apenas se método for boleto) | #### 💳 payload.data.transactions.credit\_card Detalhes do cartão de crédito. | Campo | Tipo | Obrigatório | Descrição | | ----------- | ------ | ----------- | --------------------------- | | instalments | number | Sim | Número de parcelas | | brand | string | Sim | Bandeira do cartão | | last\_digit | string | Sim | Últimos 4 dígitos do cartão | #### 💰 payload.data.transactions.pix Informações do pix. | Campo | Tipo | Obrigatório | Descrição | | ------------ | ------ | ----------- | ------------------------------- | | qrcode\_url | string | Sim | url do com o pix para pagamento | | qrcode\_data | string | Sim | código do pix copia e cola | | expiration | number | Sim | data de expiração | #### 🧾 payload.data.transactions.boleto Informações do boleto. | Campo | Tipo | Obrigatório | Descrição | | ------------- | ------ | ----------- | ------------------------------- | | barcode\_url | string | Sim | url do boleto para impressao | | barcode\_data | string | Sim | código de barras para pagamento | | expiration | string | Sim | data de expiração | #### 📊 payload.data.utms Informações de UTM para rastreamento de campanha. | Campo | Tipo | Obrigatório | Descrição | | ----- | ----- | ----------- | ---------------------------------------- | | utms | array | Não | Lista de parâmetros UTM (pode ser vazio) |