Channel for receiving shipment tracking update eventsTracking Events

Method: CHANNEL
Version: 3.1.0
License: Proprietary

## Servers

### production
Customer-provided webhook endpoint for production tracking events
Host: {customer-webhook-url}
Protocol: https

### test
Customer-provided webhook endpoint for test tracking events
Host: {customer-webhook-url}
Protocol: https

## Messages

### Tracking Update Event
Shipment tracking status update

#### Payload Schema

- **event** (string, required)
  Event type identifier
  Enum: tracking_update

- **event_id** (string, required)
  Unique identifier for this webhook event

- **is_tracking_first_tag** (boolean, required)
  Indicates if this is the first tracking event for this shipment

- **msg** (object, required)
  Detailed tracking information for the shipment

- **active** (boolean)
  Whether tracking is currently active for this shipment

- **aftership_estimated_delivery_date** (object)
  AfterShip estimated delivery date information

- **estimated_delivery_date** (string)
  Primary estimated delivery date

- **confidence_score** (number)
  Confidence score for the estimate

- **estimated_delivery_date_min** (string)
  Minimum estimated delivery date

- **estimated_delivery_date_max** (string)
  Maximum estimated delivery date

- **android** (array)
  Android push notification identifiers

- **checkpoints** (array)
  Array of tracking checkpoint events

- **checkpoint_time** (string)
  Timestamp of the checkpoint event

- **city** (string)
  City where checkpoint occurred

- **coordinates** (array)
  Geographic coordinates of checkpoint

- **country_iso3** (string)
  Country ISO3 code

- **country_name** (string)
  Country name

- **created_at** (string)
  When this checkpoint was created in the system

- **location** (string)
  Full location string

- **message** (string)
  Carrier-provided checkpoint message

- **raw_tag** (string)
  Raw carrier status code

- **slug** (string)
  Carrier slug identifier

- **state** (string)
  State/province code

- **subtag** (string)
  Normalized subtag

- **subtag_message** (string)
  Human-readable subtag message

- **tag** (string)
  Normalized tracking status tag
  Enum: Pending, InfoReceived, InTransit, OutForDelivery, AttemptFail, Delivered, AvailableForPickup, Exception, Expired

- **zip** (string)
  ZIP/postal code

- **courier_connection_id** (string)
  Connection identifier for the courier

- **courier_destination_country_iso3** (string)
  Destination country ISO3 code

- **courier_redirect_link** (string)
  URL to redirect to carrier tracking page

- **courier_tracking_link** (string)
  Direct link to carrier tracking information

- **created_at** (string)
  When this tracking record was created

- **custom_estimated_delivery_date** (string)
  Customer-specified estimated delivery date

- **custom_fields** (object)
  Custom metadata fields specific to the shipment

- **contents** (string)
  Detailed contents of the shipment

- **contents_collateral_units** (string)
  Number of collateral units

- **contents_merch_units** (string)
  Number of merchandise units

- **contents_product_units** (string)
  Number of product units

- **date_dc** (string)
  Distribution center date

- **date_input** (string)
  Input date

- **date_packed** (string)
  When the shipment was packed

- **dc_cid** (string)
  Distribution center container ID

- **dc_oid** (string)
  Distribution center order ID

- **dc_pool** (string)
  Distribution center pool designation

- **dc_ship_confirm** (string)
  Distribution center ship confirmation timestamp

- **dc_ver** (string)
  Distribution center API version

- **final_mile** (string)
  Final mile carrier

- **oms_contents** (string)
  Order management system contents

- **regulatory_attributes** (string)
  Regulatory compliance attributes

- **rsd** (string)
  Requested ship date

- **seller_name** (string)
  Name of the seller/winery

- **seller_number** (string)
  Seller account number

- **shipfrom_dc** (string)
  Shipping distribution center code

- **special_attributes** (string)
  Special handling attributes

- **special_instructions** (string)
  Special delivery instructions

- **transmission_id** (string)
  Transmission identifier

- **transport_zone** (string)
  Transport zone

- **tref** (string)
  Transaction reference

- **customer_name** (string)
  Recipient customer name

- **delivery_time** (integer)
  Delivery time in days

- **delivery_type** (string)
  Type of delivery service

- **destination_city** (string)
  Destination city name

- **destination_country_iso3** (string)
  Destination country ISO3 code

- **destination_postal_code** (string)
  Destination postal/ZIP code

- **destination_raw_location** (string)
  Full destination address

- **destination_state** (string)
  Destination state/province code

- **emails** (array)
  Email addresses for notifications

- **expected_delivery** (string)
  Expected delivery date

- **first_attempted_at** (string)
  Timestamp of first delivery attempt

- **first_estimated_delivery** (object)
  Estimated delivery information

- **source** (string)
  Source of the estimate

- **datetime** (string)
  Estimated delivery date

- **type** (string)
  Type of estimate
  Enum: specific, range

- **datetime_min** (string)
  Minimum estimated delivery datetime

- **datetime_max** (string)
  Maximum estimated delivery datetime

- **id** (string)
  Unique tracking record identifier

- **ios** (array)
  iOS push notification identifiers

- **language** (string)
  Language code for notifications

- **last_mile_tracking_supported** (boolean)
  Whether last-mile tracking is supported

- **last_updated_at** (string)
  When this tracking record was last updated

- **latest_estimated_delivery** (object)
  Estimated delivery information

- **next_couriers** (array)
  Next carriers in multi-carrier shipments

- **note** (string)
  Additional notes about the shipment

- **on_time_difference** (integer)
  Number of days difference from expected delivery

- **on_time_status** (string)
  On-time delivery status
  Enum: early, on_time, late

- **order_date** (string)
  Date the order was placed

- **order_id** (string)
  Order identifier

- **order_id_path** (string)
  Order ID path for hierarchical orders

- **order_number** (string)
  Customer-facing order number

- **order_promised_delivery_date** (string)
  Promised delivery date from order

- **order_tags** (array)
  Tags associated with the order

- **origin_city** (string)
  Origin city name

- **origin_country_iso3** (string)
  Origin country ISO3 code

- **origin_postal_code** (string)
  Origin postal/ZIP code

- **origin_raw_location** (string)
  Full origin address

- **origin_state** (string)
  Origin state/province

- **path** (string)
  Deprecated field

- **pickup_location** (string)
  Pickup location details

- **pickup_note** (string)
  Notes about pickup

- **return_to_sender** (boolean)
  Whether package is being returned to sender

- **shipment_delivery_date** (string)
  Actual delivery timestamp

- **shipment_package_count** (integer)
  Number of packages in shipment

- **shipment_pickup_date** (string)
  When shipment was picked up

- **shipment_tags** (array)
  Tags associated with the shipment

- **shipment_type** (string)
  Type of shipment service

- **shipment_weight** (number)
  Total shipment weight

- **shipment_weight_unit** (string)
  Unit of weight measurement
  Enum: lb, kg

- **signed_by** (string)
  Name of person who signed for delivery

- **smses** (array)
  SMS phone numbers for notifications

- **source** (string)
  Source of the tracking data

- **subscribed_smses** (array)
  Subscribed SMS phone numbers

- **subscribed_emails** (array)
  Subscribed email addresses

- **subtag** (string)
  Detailed status subtag

- **tag** (string, required)
  Primary tracking status tag
  Enum: Pending, InfoReceived, InTransit, OutForDelivery, AttemptFail, Delivered, AvailableForPickup, Exception, Expired

- **title** (string)
  Tracking record title

- **tracked_count** (integer)
  Number of times this tracking has been checked

- **tracking_account_number** (string)
  Carrier account number

- **tracking_destination_country** (string)
  Tracking destination country code

- **tracking_key** (string)
  Tracking key identifier

- **tracking_number** (string, required)
  Carrier tracking number

- **tracking_origin_country** (string)
  Tracking origin country code

- **tracking_postal_code** (string)
  Tracking destination postal code

- **tracking_ship_date** (string)
  Ship date in YYYYMMDD format

- **tracking_state** (string)
  Tracking destination state

- **unique_token** (string)
  Deprecated unique token

- **updated_at** (string)
  When this tracking record was last updated

- **ts** (integer, required)
  Unix timestamp when the event was generated