Monetizze - Shipping

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

Eventos Disponíveis

• shipping.delivered
• shipping.fulfilled
• shipping.in_transit
• shipping.out_for_delivery
• shipping.failed
• shipping.lost
• shipping.returned
• shipping.withdrawal_available

Estrutura do Payload

{
  "codigo_venda": "12345",
  "postback_evento": "120",
  "tipoEvento": {
    "codigo": "120"
  },
  "comprador": {
    "nome": "João Silva",
    "email": "[email protected]",
    "cnpj_cpf": "12345678900",
    "telefone": "5511999999999"
  },
  "venda": {
    "codigo": "12345",
    "status": "6",
    "dataInicio": 1705319000,
    "dataFinalizada": 1705319100,
    "valor": 9970,
    "frete": 1500,
    "quantidade": 1
  },
  "ecommerce_dados": {
    "valor_total": 11470,
    "valor_soma_produtos": 9970,
    "valor_desconto": 0,
    "valor_frete": 1500,
    "dados_comprador": {
      "endereco_entrega": {
        "cep": "01000-000",
        "endereco": "Rua Principal",
        "numero": "123",
        "complemento": "Apto 45",
        "bairro": "Centro",
        "cidade": "São Paulo",
        "estado": "SP",
        "pais": "BR"
      }
    }
  },
  "rastreio": {
    "codigo": "AB123456789CD",
    "status": "3",
    "descricao": "Objeto entregue ao destinatário"
  }
}

---

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