FindMyPack - Order

Eventos da família order.* na integração FindMyPack.

Eventos Disponíveis

order.canceled
order.customs_inspection_completed
order.delayed
order.delivered
order.failed
order.fulfilled
order.in_destination_analysis
order.in_transit
order.lost
order.misplaced
order.not_delivered
order.object_destroyed
order.out_for_delivery
order.out_for_delivery_to_sender
order.refused
order.returned
order.stopped_in_inspection
order.withdrawal_available

Estrutura do Payload

{
  "customer": {
    "id": null,
    "name": "João Silva",
    "email": "[email protected]",
    "document": null,
    "phone_numbers": [
      {
        "formatted_phone": "+5511999999999",
        "type": null,
        "raw_number": "5511999999999",
        "area_code": null,
        "international_dialing_code": null
      }
    ],
    "address": null
  },
  "shipping": {
    "carrier": "Correios",
    "total_value": null,
    "tracking_url": null,
    "tracking_code": "ABC123456789",
    "method": "PAC",
    "delivery_address": {
      "street": null,
      "number": null,
      "complement": null,
      "neighborhood": null,
      "city": null,
      "state": null,
      "country": null,
      "postal_code": null
    },
    "estimated_delivery_date": 1705481000,
    "estimated_delivery_time_in_days": null,
    "status": "in_transit",
    "raw_status": "1"
  }
}

Componentes do Payload

Customer

Campo	Tipo	Descrição
`id`	null	Sempre `null`
`name`	string \| null	Nome do destinatário
`email`	string \| null	E-mail do destinatário
`document`	null	Sempre `null`
`phone_numbers`	Phone[] \| null	Coleção de telefones do destinatário
`address`	null	Sempre `null` (FindMyPack não fornece endereço)

Phone

Telefone do destinatário.

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`

Shipping

Campo	Tipo	Descrição
`carrier`	string \| null	Nome da transportadora
`total_value`	null	Sempre `null`
`tracking_url`	null	Sempre `null`
`tracking_code`	string \| null	Código de rastreamento
`method`	string \| null	Nome do serviço de envio
`delivery_address`	[Address]	Endereço de entrega (vazio)
`estimated_delivery_date`	integer \| null	Timestamp da previsão de entrega
`estimated_delivery_time_in_days`	null	Sempre `null`
`status`	string \| null	Status normalizado do envio
`raw_status`	string \| null	Status original do provider

Status Normalizados (ShippingStatus)

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

Valor	Descrição
`delivered`	Objeto entregue
`out_for_delivery`	Objeto saiu para entrega
`delayed`	Objeto atrasado
`fulfilled`	Objeto postado/fulfillment completo
`in_transit`	Objeto em trânsito
`stopped_in_inspection`	Objeto parado em inspeção
`in_destination_analysis`	Em análise de destino
`customs_inspection_completed`	Inspeção aduaneira concluída
`withdrawal_available`	Objeto disponível para retirada
`returned`	Objeto devolvido
`refused`	Objeto recusado
`object_destroyed`	Objeto destruído
`lost`	Objeto perdido
`misplaced`	Objeto extraviado
`canceled`	Objeto cancelado
`not_delivered`	Objeto não entregue
`failed`	Objeto com falha

Address

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] A FindMyPack não fornece informações detalhadas de endereço.

Voltar para visão geral da integração