Payt - Shipping

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

Eventos Disponíveis

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

Estrutura do Payload

{
  "event": "shipping.delivered",
  "cart_id": "CART-123456",
  "transaction_id": "TXN-123456",
  "status": "delivered",
  "started_at": 1705319000,
  "updated_at": 1705400000,
  "customer": {
    "code": "CUST-001",
    "name": "João Silva",
    "doc": "12345678900",
    "email": "[email protected]",
    "phone": "11999999999"
  },
  "shipping": {
    "status": "delivered",
    "price": 1500,
    "service": "Correios",
    "tracking_code": "AB123456789BR",
    "tracking_url": "https://correios.com.br/rastreio/AB123456789BR"
  }
}

---

Componentes do Payload

Customer

Campo	Tipo	Descrição
id	string | null	Código do cliente
name	string | null	Nome do cliente
document	string | null	Número do documento (CPF/CNPJ)
email	string | null	Email do cliente
phoneNumbers	Collection	Coleção de telefones
address	EmptyAddress	Endereço (sempre vazio)

Subcomponentes

Campo	Tipo	Descrição
street	null	Sempre null
number	null	Sempre null
complement	null	Sempre null
neighborhood	null	Sempre null
city	null	Sempre null
state	null	Sempre null
country	null	Sempre null
postal_code	null	Sempre null

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

---

Telefones

Campo	Tipo	Descrição
formattedPhone	PhoneFactory | null	Telefone formatado
type	null	Sempre null
rawNumber	string | null	Número bruto
areaCode	null	Sempre null
internationalDialingCode	null	Sempre null

---

Shipping

Campo	Tipo	Descrição
carrier	string | null	Nome da transportadora
totalValue	int | null	Valor do frete
trackingUrl	string | null	URL de rastreamento
trackingCode	string | null	Código de rastreamento
method	null	Sempre null
deliveryAddress	EmptyAddress	Endereço de entrega (sempre vazio)
estimatedDeliveryDate	null	Sempre null
estimatedDeliveryTimeInDays	null	Sempre null
status	ShippingStatus | null	Status normalizado do envio

Status Normalizados (ShippingStatus)

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

Valor	Descrição
fulfilled	Encomenda separada para envio
delivered	Entregue
out_for_delivery	Saiu para entrega
in_transit	Em trânsito
delayed	Atrasado
failed	Falha na entrega
waiting_postage	Aguardando postagem
withdrawal_available	Disponível para retirada

Campo	Tipo	Descrição
street	null	Sempre null
number	null	Sempre null
complement	null	Sempre null
neighborhood	null	Sempre null
city	null	Sempre null
state	null	Sempre null
country	null	Sempre null
postal_code	null	Sempre null

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

---

Checkout

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

---

LeadTracking

Campo	Tipo	Descrição
src	string | null	Fonte do tráfego
sck	null	Sempre null
utmSource	string | null	Fonte UTM
utmCampaign	string | null	Campanha UTM
utmMedium	string | null	Meio UTM
utmContent	string | null	Conteúdo UTM
utmTerm	string | null	Termo UTM
utmId	null	Sempre null
metaFbp	null	Sempre null
googleGaId	null	Sempre null
googleGclid	string | null	Google GCLID
googleGclsrc	null	Sempre null
googleDclid	null	Sempre null
googleGbraid	null	Sempre null
googleWbraid	null	Sempre null
tiktokTtlid	null	Sempre null
ip	null	Sempre null

---

Voltar para visão geral da integração