Monetizze - Order

Eventos da família order.* na integração Monetizze.

Eventos Disponíveis

• order.paid
• order.finalized
• order.refunded
• order.canceled
• order.waiting_payment

Estrutura do Payload

{
  "customer": {
    "id": null,
    "name": "João Silva",
    "email": "[email protected]",
    "document": "12345678900",
    "phone_numbers": [
      {
        "formatted_phone": "+5511999999999",
        "type": null,
        "raw_number": "5511999999999",
        "area_code": null,
        "international_dialing_code": null
      }
    ],
    "address": {
      "street": null,
      "number": null,
      "complement": null,
      "neighborhood": null,
      "city": null,
      "state": null,
      "country": null,
      "postal_code": null
    }
  },
  "order": {
    "id": "12345",
    "status": "paid",
    "raw_status": "2",
    "created_at": 1705319000,
    "updated_at": null,
    "paid_at": 1705319100,
    "warranty_until": null,
    "canceled_at": null,
    "refunded_at": null
  },
  "checkout": {
    "id": null,
    "url": null
  },
  "payment": {
    "currency": "BRL",
    "total": 9970,
    "discount_value": null,
    "shipping_value": null,
    "total_products_value": 9970,
    "payment_method": {
      "type": "pix",
      "brand": null,
      "last_digits": null,
      "expiration_month": null,
      "expiration_year": null,
      "qrcode_url": null,
      "qrcode_signature": null,
      "expiration_date": null,
      "pix_key": null,
      "pix_key_type": null,
      "digitable_line": null,
      "url": null
    },
    "coupons": [
      {
        "code": "DESCONTO10",
        "value": 1000
      }
    ]
  },
  "shipping": {
    "carrier": null,
    "total_value": null,
    "tracking_url": null,
    "tracking_code": null,
    "method": null,
    "delivery_address": null,
    "estimated_delivery_date": null,
    "estimated_delivery_time_in_days": null,
    "status": null,
    "raw_status": null
  },
  "products": [
    {
      "id": "PROD-001",
      "name": "Produto Exemplo",
      "type": "product",
      "offer_type": "main",
      "quantity": 1,
      "unit_value": 9970,
      "total_value": 9970,
      "image_url": null
    }
  ],
  "lead_tracking": {
    "src": null,
    "sck": null,
    "utm_source": null,
    "utm_campaign": null,
    "utm_medium": null,
    "utm_content": null,
    "utm_term": null,
    "utm_id": null,
    "meta_fbp": null,
    "google_ga_id": null,
    "google_gclid": null,
    "google_gclsrc": null,
    "google_dclid": null,
    "google_gbraid": null,
    "google_wbraid": null,
    "tiktok_ttlid": null,
    "ip": null
  }
}

---

Componentes do Payload

Customer

Campo	Tipo	Descrição
id	null	Sempre null
name	string | null	Nome do comprador
email	string | null	E-mail do comprador
document	string | null	CPF ou CNPJ
phone_numbers	Collection	Coleção de telefones
address	Address	Endereço do comprador

Telefone

Campo	Tipo	Descrição
formatted_phone	string | null	Telefone formatado
type	null	Sempre null
raw_number	string | null	Número bruto
area_code	null	Sempre null
international_dialing_code	null	Sempre null

Endereço

Campo	Tipo	Descrição
street	string | null	Rua
number	string | null	Número
complement	string | null	Complemento
neighborhood	string | null	Bairro
city	string | null	Cidade
state	string | null	Estado
country	string | null	País
postal_code	string | null	CEP

---

Order

Campo	Tipo	Descrição
id	string | null	ID da venda
status	string	Status normalizado do pedido
created_at	integer | null	Timestamp de início da venda
updated_at	null	Sempre null
paid_at	integer | null	Timestamp de finalização da venda
warranty_until	null	Sempre null
canceled_at	null	Sempre null
refunded_at	null	Sempre null
raw_status	string | null	Status original do provider

Status Normalizados (OrderStatus)

A Monetizze retorna os seguintes valores normalizados para o status do pedido:

Valor	Descrição
paid	Pago
completed	Completo
waiting_payment	Aguardando pagamento
canceled	Cancelado
refunded	Reembolsado

---

Payment

Campo	Tipo	Descrição
currency	string	Sempre BRL
total	integer | null	Valor total (em centavos)
discount_value	integer | null	Valor do desconto (em centavos)
shipping_value	integer | null	Valor do frete (em centavos)
total_products_value	integer | null	Valor total dos produtos (em centavos)
payment_method	PaymentMethod	Método de pagamento
coupons	Collection	Coleção de cupons

Cupom

Campo	Tipo	Descrição
id	null	Sempre null
code	string | null	Código do cupom
value	integer | null	Valor do desconto (em centavos)
percentage	null	Sempre null
incidence	string	Sempre products
incidence_type	string	Sempre value
expiration_date	null	Sempre null

Métodos de Pagamento (PaymentMethod)

A Monetizze retorna os seguintes métodos de pagamento:

Valor	Descrição
credit_card	Cartão de Crédito
pix	PIX
boleto	Boleto Bancário

---

Product

Campo	Tipo	Descrição
id	string | null	ID do produto
name	string | null	Nome do produto
quantity	integer | null	Quantidade
unit_value	integer | null	Valor unitário (em centavos)
total_value	integer | null	Valor total (em centavos)
image_url	null	Sempre null
type	string	Tipo do produto (product ou subscription_plan)
offer_type	string	Tipo de oferta (main ou order_bump)

---

Checkout

Campo	Tipo	Descrição
id	string | null	ID do checkout
url	string | null	URL de recuperação do checkout

---

Lead Tracking (vazio)

Este componente nunca possui dados úteis na Monetizze. Todos os campos retornam null.

Campo	Tipo	Descrição
src	null	Sempre null
sck	null	Sempre null
utm_source	null	Sempre null
utm_campaign	null	Sempre null
utm_medium	null	Sempre null
utm_content	null	Sempre null
utm_term	null	Sempre null
utm_id	null	Sempre null
meta_fbp	null	Sempre null
google_ga_id	null	Sempre null
google_gclid	null	Sempre null
google_gclsrc	null	Sempre null
google_dclid	null	Sempre null
google_gbraid	null	Sempre null
google_wbraid	null	Sempre null
tiktok_ttlid	null	Sempre null
ip	null	Sempre null

[!NOTE] Essa integração não disponibiliza informações de lead tracking.

---

Shipping

Campo	Tipo	Descrição
carrier	string | null	Nome da transportadora
total_value	integer | null	Valor do frete (em centavos)
tracking_url	null	Sempre null
tracking_code	string | null	Código de rastreamento
method	null	Sempre null
delivery_address	Address	Endereço de entrega
estimated_delivery_date	null	Sempre null
estimated_delivery_time_in_days	null	Sempre null
raw_status	string | null	Status original do provider
status	string | null	Status normalizado do envio

Status Normalizados (ShippingStatus)

A Monetizze retorna os seguintes valores normalizados para o status do envio:

Valor	Descrição
fulfilled	Despachado
out_for_delivery	Saiu para entrega
delivered	Entregue
failed	Falhou na entrega
lost	Objeto perdido
returned	Devolvido
withdrawal_available	Disponível para retirada
in_transit	Em trânsito

Endereço de Entrega

Campo	Tipo	Descrição
street	string | null	Rua
number	string | null	Número
complement	string | null	Complemento
neighborhood	string | null	Bairro
city	string | null	Cidade
state	string | null	Estado
country	string | null	País
postal_code	string | null	CEP

---

Voltar para visão geral da integração