Convertize - Shipping

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

Eventos Disponíveis

Evento	Descrição
shipping.fulfilled	Pedido separado
shipping.delivered	Entregue
shipping.withdrawal_available	Disponível para retirada
shipping.out_for_delivery	Saiu para entrega
shipping.not_delivered	Não entregue

Estrutura do Payload

{
  "customer": {
    "id": "123456",
    "name": "João Silva",
    "email": "[email protected]",
    "document": "12345678900",
    "phone_numbers": [
      {
        "formatted_phone": "+5511999999999",
        "type": null,
        "raw_number": "999999999",
        "area_code": null,
        "international_dialing_code": null
      }
    ],
    "address": {
      "street": "Rua Principal",
      "number": "123",
      "complement": "Apto 45",
      "neighborhood": "Centro",
      "city": "São Paulo",
      "state": "SP",
      "country": null,
      "postal_code": "01000-000"
    }
  },
  "order": {
    "id": "789012",
    "status": "paid",
    "raw_status": "CEP",
    "created_at": 1705319000,
    "updated_at": 1705319100,
    "paid_at": null,
    "warranty_until": null,
    "canceled_at": null,
    "refunded_at": null
  },
  "checkout": {
    "id": null,
    "url": null
  },
  "shipping": {
    "carrier": "Correios",
    "currency": "BRL",
    "total_value": 2000,
    "tracking_url": "https://rastreio.correios.com.br/...",
    "tracking_code": "AB123456789CD",
    "method": "PAC",
    "delivery_address": {
      "street": "Rua Principal",
      "number": "123",
      "complement": "Apto 45",
      "neighborhood": "Centro",
      "city": "São Paulo",
      "state": "SP",
      "country": null,
      "postal_code": "01000-000"
    },
    "estimated_delivery_date": 1705916400,
    "estimated_delivery_time_in_days": null,
    "status": "delivered",
    "raw_status": "PECS"
  },
  "products": [
    {
      "id": "prod_456",
      "name": "Produto Exemplo",
      "type": "product",
      "quantity": 1,
      "unit_value": 27900,
      "total_value": 27900,
      "image_url": "https://example.com/product.jpg",
      "offer_type": "main"
    }
  ],
  "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

Shipping

Campo	Tipo	Descricao
carrier	string | null	Transportadora
currency	BRL	Moeda (sempre BRL)
total_value	int | null	Valor do frete
tracking_url	string | null	URL de rastreio
tracking_code	string | null	Codigo de rastreio
method	string | null	Metodo de envio
delivery_address	[DeliveryAddress]	Endereco de entrega
estimated_delivery_date	Carbon | null	Data estimada de entrega
estimated_delivery_time_in_days	null	Sempre null
status	string | null	Status normalizado do envio
raw_status	string | null	Status de rastreio original

Status Normalizados (ShippingStatus)

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

Valor	Descricao
fulfilled	Pedido separado
delivered	Entregue
withdrawal_available	Disponivel para retirada
out_for_delivery	Saiu para entrega
not_delivered	Não entregue

DeliveryAddress

Campo	Tipo	Descricao
street	string | null	Logradouro
number	string | null	Numero
complement	string | null	Complemento
neighborhood	string | null	Bairro
city	string | null	Cidade
state	string | null	Estado/UF
country	null	Sempre null
postal_code	string | null	CEP

---

Customer

Campo	Tipo	Descricao
id	string | null	ID do cliente
name	string | null	Nome completo
email	string | null	E-mail do cliente
document	string | null	CPF ou CNPJ
phone_numbers	Phone[] | null	Colecao de telefones do cliente
address	Address	Endereco do cliente

Phone

Campo	Tipo	Descricao
formatted_phone	PhoneFactory | null	Telefone formatado
type	null	Sempre null
raw_number	string | null	Numero bruto
area_code	null	Sempre null
international_dialing_code	null	Sempre null

Address

Campo	Tipo	Descricao
street	string | null	Logradouro
number	string | null	Numero
complement	string | null	Complemento
neighborhood	string | null	Bairro
city	string | null	Cidade
state	string | null	Estado/UF
country	null	Sempre null
postal_code	string | null	CEP

---

Product

Campo	Tipo	Descricao
id	string | null	ID ou SKU do produto
name	string | null	Nome do produto
quantity	int | null	Quantidade no pedido
currency	string	Sempre BRL
type	string	Sempre product
offer_type	string	Sempre main

---

Checkout (Vazio)

Campo	Tipo	Descrição
id	null	Sempre null
url	null	Sempre null

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

---

LeadTracking (Vazio)

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.

---

Voltar para visão geral da integração