Shopify - Shipping

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

Veja também Estrutura geral dos eventos Shipping para referência completa.

Eventos Disponíveis

shipping.waiting_postage
shipping.fulfilled
shipping.delayed
shipping.in_transit
shipping.out_for_delivery
shipping.withdrawal_available
shipping.delivered
shipping.failed
shipping.canceled

Estrutura do Payload

{
  "customer": {
    "id": "123456789",
    "name": "João Silva",
    "email": "[email protected]",
    "document": null,
    "phone": "+5511999999999",
    "address": {
      "street": "Rua Principal",
      "number": "123",
      "complement": null,
      "neighborhood": null,
      "city": "São Paulo",
      "state": "SP",
      "country": "BR",
      "postal_code": "01000-000"
    }
  },
  "order": {
    "id": "123456789",
    "status": "finalized",
    "raw_status": "finalized",
    "created_at": 1705319000,
    "paid_at": null,
    "updated_at": 1705319100,
    "warranty_until": null,
    "canceled_at": null,
    "refunded_at": null
  },
  "checkout": {
    "id": null,
    "url": null
  },
  "payment": {
    "currency": "BRL",
    "total": 29990,
    "discount_value": 0,
    "shipping_value": 1500,
    "total_products_value": 28490,
    "payment_method": null,
    "coupons": []
  },
  "shipping": {
    "carrier": "Correios",
    "total_value": 1500,
    "tracking_url": "https://rastreamento.correios.com.br/...",
    "tracking_code": "BR123456789BR",
    "method": "PAC",
    "delivery_address": {
      "street": "Rua Principal",
      "number": "123",
      "complement": null,
      "city": "São Paulo",
      "state": "SP",
      "postal_code": "01000-000"
    },
    "estimated_delivery_date": null,
    "estimated_delivery_time_in_days": null,
    "status": "delivered",
    "raw_status": "delivered"
  },
  "products": [
    {
      "id": "987654321",
      "name": "Produto Shopify",
      "type": "product",
      "offer_type": "main",
      "quantity": 1,
      "unit_value": 28490,
      "total_value": 28490,
      "image_url": "https://cdn.shopify.com/..."
    }
  ],
  "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

Informações do cliente.

Campo	Tipo	Descricao
`id`	string	ID do cliente na Shopify
`name`	string \| null	Nome completo (first_name + last_name)
`email`	string \| null	E-mail do cliente
`document`	null	Sempre `null` - Shopify nao coleta CPF
`phone_numbers`	Phone[] \| null	Colecao de telefones do cliente
`address`	Address	Veja Address abaixo

Address

Endereco do cliente.

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

Phone

Telefone do cliente.

Campo	Tipo	Descrição
`formatted_phone`	string \| null	Telefone formatado em E.164
`type`	null	Sempre `null`
`raw_number`	string \| null	Número sem formatação
`area_code`	null	Sempre `null`
`international_dialing_code`	null	Sempre `null`

Order

Dados do pedido.

Campo	Tipo	Descrição
`id`	string \| null	ID do pedido na Shopify
`status`	string	Status normalizado
`raw_status`	string \| null	Status original do Shopify
`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)

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

Valor	Descrição
`waiting_payment`	Aguardando pagamento
`paid`	Pago
`canceled`	Cancelado
`refunded`	Reembolsado
`expired`	Expirado
`failed`	Falhou
`waiting_fulfillment`	Aguardando separação/envio

Checkout

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

Payment

Dados financeiros.

Campo	Tipo	Descrição
`currency`	string \| null	Moeda em formato ISO 4217 (ex: BRL, USD)
`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	Array de cupons

Shipping

Informações de envio/entrega.

Informações de envio.

Campo	Tipo	Descrição
`carrier`	string \| null	Transportadora
`total_value`	integer \| null	Valor do frete em centavos
`tracking_code`	string \| null	Código de rastreamento
`method`	string \| null	Método de envio
`delivery_address`	object	Endereço de entrega
`estimated_delivery_date`	integer \| null	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

Delivery Address

Endereço de entrega.

Campo	Tipo	Descrição
`street`	string \| null	Logradouro
`number`	string \| null	Número
`complement`	string \| null	Complemento
`city`	string	Cidade
`state`	string	Estado/UF
`postal_code`	string \| null	CEP

Product

Produtos incluídos no envio (array).

Produtos incluídos no pedido (array).

Campo	Tipo	Descrição
`id`	string \| null	ID do produto
`name`	string \| null	Nome do produto
`type`	string	Tipo: `product`
`offer_type`	string	Tipo de oferta: `main`, `order_bump`
`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

LeadTracking

Dados de rastreamento de marketing.

Campo	Tipo	Descrição
`src`	string \| null	Fonte genérica
`sck`	string \| null	Código de rastreamento interno
`utm_source`	string \| null	UTM Source
`utm_campaign`	string \| null	UTM Campaign
`utm_medium`	string \| null	UTM Medium
`utm_content`	string \| null	UTM Content
`utm_term`	string \| null	UTM Term
`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 GCL Source
`google_dclid`	string \| null	Google Display Click ID
`google_gbraid`	string \| null	Google Budget ROAS ID
`google_wbraid`	string \| null	Google Web View Conversion
`tiktok_ttlid`	string \| null	TikTok Click ID
`ip`	string \| null	Endereço IP do cliente

Voltar para visão geral da integração