Shipping

Eventos da família shipping.* notificam mudanças no status de entrega de pedidos.

Eventos Disponíveis

shipping.waiting_postage - Aguardando postagem
shipping.fulfilled - Pedido separado/enviado
shipping.delay - Entrega atrasada
shipping.in_transit - Em trânsito
shipping.stopped_in_inspection - Retido em fiscalização
shipping.in_destination_analysis - Em análise no destino
shipping.customs_inspection_completed - Fiscalização aduaneira concluída
shipping.out_for_delivery - Saiu para entrega
shipping.out_for_delivery_to_sender - Saiu para entrega ao remetente
shipping.returned - Devolvido
shipping.refused - Recusado
shipping.object_destroyed - Objeto destruído
shipping.lost - Extraviado
shipping.misplaced - Desviado
shipping.withdrawal_available - Disponível para retirada
shipping.failed - Falha na entrega
shipping.not_delivered - Não entregue
shipping.canceled - Cancelado
shipping.delivered - 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": "11",
        "international_dialing_code": "55"
      }
    ],
    "address": {
      "street": "Rua Principal",
      "number": "123",
      "complement": "Apto 45",
      "neighborhood": "Centro",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR",
      "postal_code": "01000-000"
    }
  },
  "order": {
    "id": "order_456",
    "status": "waiting_delivery",
    "raw_status": "waiting_delivery",
    "created_at": 1705319000,
    "paid_at": 1705319100,
    "updated_at": 1705319100,
    "warranty_until": null,
    "canceled_at": null,
    "refunded_at": null
  },
  "checkout": {
    "id": "checkout_789",
    "url": "https://checkout.example.com/..."
  },
  "payment": {
    "currency": "BRL",
    "total": 29990,
    "discount_value": 0,
    "shipping_value": 1500,
    "total_products_value": 28490,
    "payment_method": {
      "type": "credit_card",
      "brand": "visa",
      "last_digits": "1234",
      "expiration_month": "12",
      "expiration_year": "2028"
    },
    "coupons": []
  },
  "shipping": {
    "carrier": "Correios",
    "total_value": 1500,
    "tracking_url": "https://rastreamento.correios.com.br/BR123456789BR",
    "tracking_code": "BR123456789BR",
    "method": "PAC",
    "delivery_address": {
      "street": "Rua Principal",
      "number": "123",
      "complement": "Apto 45",
      "neighborhood": "Centro",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR",
      "postal_code": "01000-000"
    },
    "estimated_delivery_date": 1705923900,
    "estimated_delivery_time_in_days": 7,
    "status": "in_transit",
    "raw_status": "Objeto em trânsito"
  },
  "products": [
    {
      "id": "prod_789",
      "name": "Produto Exemplo",
      "type": "product",
      "quantity": 1,
      "unit_value": 28490,
      "total_value": 28490,
      "image_url": "https://example.com/product.jpg",
      "offer_type": "main"
    }
  ],
  "lead_tracking": {
    "src": "facebook_ads",
    "sck": null,
    "utm_source": "facebook",
    "utm_campaign": "black_friday",
    "utm_medium": "cpc",
    "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`	string \| null	ID único do cliente
`name`	string \| null	Nome completo
`email`	string \| null	E-mail
`document`	string \| null	Documento (CPF/CNPJ) apenas números
`phone_numbers`	array	Lista de telefones
`address`	object	Endereço

Phone Numbers

Campo	Tipo	Descrição
`formatted_phone`	string \| null	Telefone formatado em E.164
`type`	string \| null	Tipo do telefone
`raw_number`	string \| null	Número sem formatação
`area_code`	string \| null	Código de área (DDD)
`international_dialing_code`	string \| null	Código discagem internacional

Address

Campo	Tipo	Descrição
`street`	string \| null	Nome da rua
`number`	string \| null	Número
`complement`	string \| null	Complemento
`neighborhood`	string \| null	Bairro
`city`	string \| null	Cidade
`state`	string \| null	Estado (sigla)
`country`	string \| null	Código ISO 3166-1 alpha-2
`postal_code`	string \| null	CEP

Order

Campo	Tipo	Descrição
`id`	string \| null	ID único do pedido
`status`	string \| null	Status normalizado
`raw_status`	string \| null	Status original do provedor
`created_at`	integer \| null	Timestamp de criação
`paid_at`	integer \| null	Timestamp do pagamento
`updated_at`	integer \| null	Timestamp da última atualização
`warranty_until`	integer \| null	Timestamp de expiração da garantia
`canceled_at`	integer \| null	Timestamp do cancelamento
`refunded_at`	integer \| null	Timestamp do reembolso

Status Normalizados (OrderStatus)

Valor	Descrição
`draft`	Rascunho
`open`	Aberto
`abandoned`	Abandonado
`waiting_payment`	Aguardando pagamento
`payment_processing`	Processando pagamento
`handling`	Em separação
`waiting_fulfillment`	Aguardando separação/envio
`waiting_delivery`	Aguardando entrega
`paid`	Pago
`partially_paid`	Parcialmente pago
`partially_refunded`	Parcialmente reembolsado
`completed`	Completo (ciclo completo ou garantia expirada)
`refunded`	Reembolsado
`disputed`	Em disputa (chargeback)
`expired`	Expirado
`canceled`	Cancelado
`failed`	Falhou
`scheduled`	Agendado

Checkout

Campo	Tipo	Descrição
`id`	string \| null	ID único do checkout
`url`	string \| null	URL do checkout

Payment

Campo	Tipo	Descrição
`currency`	string \| null	Código ISO 4217 da moeda
`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`	object \| null	Método de pagamento
`coupons`	array	Lista de cupons aplicados

Coupon

Campo	Tipo	Descrição
`id`	string \| null	ID do cupom
`code`	string \| null	Código do cupom
`value`	integer \| null	Valor do desconto em centavos
`percentage`	float \| null	Percentual do desconto
`incidence`	string \| null	Incidência do cupom
`incidence_type`	string \| null	Tipo de incidência
`expiration_date`	integer \| null	Timestamp de expiração

Incidence (CouponIncidence)

Valor	Descrição
`total`	Incide sobre o total
`products`	Incide sobre os produtos
`shipping`	Incide sobre o frete

Incidence Type (CouponIncidenceType)

Valor	Descrição
`value`	Desconto em valor fixo
`percentage`	Desconto em percentual

Shipping

Campo	Tipo	Descrição
`carrier`	string \| null	Nome da transportadora
`total_value`	integer \| null	Valor do frete em centavos
`tracking_url`	string \| null	URL de rastreamento
`tracking_code`	string \| null	Código de rastreamento
`method`	string \| null	Método de envio (ex: PAC, SEDEX)
`delivery_address`	object	Endereço de entrega
`estimated_delivery_date`	integer \| null	Timestamp da data estimada de entrega
`estimated_delivery_time_in_days`	integer \| null	Tempo estimado em dias
`status`	string \| null	Status normalizado
`raw_status`	string \| null	Status original da transportadora

Delivery Address

Campo	Tipo	Descrição
`street`	string \| null	Nome da rua
`number`	string \| null	Número
`complement`	string \| null	Complemento
`neighborhood`	string \| null	Bairro
`city`	string \| null	Cidade
`state`	string \| null	Estado (sigla)
`country`	string \| null	Código ISO 3166-1 alpha-2
`postal_code`	string \| null	CEP

Status Normalizados (ShippingStatus)

Valor	Descrição
`waiting_postage`	Aguardando postagem
`waiting_tracking_code`	Aguardando código de rastreamento
`fulfilled`	Pedido separado/enviado
`in_transit`	Em trânsito
`out_for_delivery`	Saiu para entrega
`delivered`	Entregue
`withdrawal_available`	Disponível para retirada
`delayed`	Atrasado
`failed`	Falha na entrega
`not_delivered`	Não entregue
`refused`	Recusado
`returned`	Devolvido
`lost`	Extraviado
`misplaced`	Desviado
`canceled`	Cancelado
`stopped_in_inspection`	Retido em fiscalização
`in_destination_analysis`	Em análise no destino
`customs_inspection_completed`	Fiscalização aduaneira concluída
`object_destroyed`	Objeto destruído

Product

Campo	Tipo	Descrição
`id`	string \| null	ID do produto
`name`	string \| null	Nome do produto
`type`	string	Tipo 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`	string \| null	URL da imagem
`offer_type`	string	Tipo de oferta

Product Type (ProductType)

Valor	Descrição
`product`	Produto físico ou digital
`subscription_plan`	Plano de assinatura

Offer Type (OfferType)

Valor	Descrição
`main`	Oferta principal
`order_bump`	Order bump (complemento)

LeadTracking

Campo	Tipo	Descrição
`src`	string \| null	Fonte original
`sck`	string \| null	Parâmetro SCK
`utm_source`	string \| null	UTM Fonte
`utm_campaign`	string \| null	UTM Campanha
`utm_medium`	string \| null	UTM Mídia
`utm_content`	string \| null	UTM Conteúdo
`utm_term`	string \| null	UTM Termo
`utm_id`	string \| null	UTM ID
`meta_fbp`	string \| null	Facebook Browser ID
`google_ga_id`	string \| null	Google Analytics ID
`google_gclid`	string \| null	Google Click ID
`google_gclsrc`	string \| null	Google GCLSRC
`google_dclid`	string \| null	Google Display Click ID
`google_gbraid`	string \| null	Google GBRAID
`google_wbraid`	string \| null	Google WBRAID
`tiktok_ttlid`	string \| null	TikTok TTLID
`ip`	string \| null	Endereço IP

Observações

Timestamps são em segundos Unix (epoch)
Valores monetários são sempre em centavos