Skip to content
Webhooks
///
receiveTrackingUpdate

Wineshipping Tracking Events 3.1.0

Webhook-based event tracking system for shipment status updates.

Send an email to api@wineshipping.com to enable your webhook to receive tracking events for your account.

You provide the webhook URL and Wineshipping will send trcking events to the provided URL via HTTP POST method in JSON format.

Download AsyncAPI description
asyncapi.json
asyncapi.yaml
Overview
Wineshipping API Support
api@wineshipping.com
License
Proprietary
Servers
production
{customer-webhook-url}
More details
test
{customer-webhook-url}
More details
Channel

/

name: /

Tracking Events

Channel for receiving shipment tracking update events

Messages

Accepts the following message:

Shipment tracking status update

Payloadapplication/json

eventstring or nullrequired

Event type identifier

Value"tracking_update"
Example: "tracking_update"
event_idstring or null(uuid)required

Unique identifier for this webhook event

Example: "555e9daa-f6ca-48a2-b30c-48e23cd0d0d6"
is_tracking_first_tagbooleanrequired

Indicates if this is the first tracking event for this shipment

Example: true
msgobjectrequired

Detailed tracking information for the shipment

msg.​activeboolean

Whether tracking is currently active for this shipment

msg.​aftership_estimated_delivery_dateobject

AfterShip estimated delivery date information

msg.​androidArray of strings or null

Android push notification identifiers

msg.​checkpointsArray of objects

Array of tracking checkpoint events

msg.​courier_connection_idstring or null

Connection identifier for the courier

msg.​courier_destination_country_iso3string or null

Destination country ISO3 code

Example: "USA"
msg.​courier_redirect_linkstring or null(uri)

URL to redirect to carrier tracking page

msg.​courier_tracking_linkstring or null(uri)

Direct link to carrier tracking information

msg.​created_atstring or null(date-time)

When this tracking record was created

msg.​custom_estimated_delivery_datestring or null(date)

Customer-specified estimated delivery date

msg.​custom_fieldsobject

Custom metadata fields specific to the shipment

msg.​customer_namestring or null

Recipient customer name

msg.​delivery_timeinteger

Delivery time in days

msg.​delivery_typestring or null

Type of delivery service

msg.​destination_citystring or null

Destination city name

msg.​destination_country_iso3string or null

Destination country ISO3 code

msg.​destination_postal_codestring or null

Destination postal/ZIP code

msg.​destination_raw_locationstring or null

Full destination address

msg.​destination_statestring or null

Destination state/province code

msg.​emailsArray of strings or null(email)

Email addresses for notifications

msg.​expected_deliverystring or null(date)

Expected delivery date

msg.​first_attempted_atstring or null(date-time)

Timestamp of first delivery attempt

msg.​first_estimated_deliveryobject

Estimated delivery information

msg.​idstring or null

Unique tracking record identifier

msg.​iosArray of strings or null

iOS push notification identifiers

msg.​languagestring or null

Language code for notifications

Example: "en"
msg.​last_mile_tracking_supportedboolean

Whether last-mile tracking is supported

msg.​last_updated_atstring or null(date-time)

When this tracking record was last updated

msg.​latest_estimated_deliveryobject

Estimated delivery information

msg.​next_couriersArray of objects

Next carriers in multi-carrier shipments

msg.​notestring or null

Additional notes about the shipment

msg.​on_time_differenceinteger

Number of days difference from expected delivery

msg.​on_time_statusstring or null

On-time delivery status

Enum"early""on_time""late"
msg.​order_datestring or null(date-time)

Date the order was placed

msg.​order_idstring or null

Order identifier

msg.​order_id_pathstring or null

Order ID path for hierarchical orders

msg.​order_numberstring or null

Customer-facing order number

msg.​order_promised_delivery_datestring or null(date)

Promised delivery date from order

msg.​order_tagsArray of strings or null

Tags associated with the order

msg.​origin_citystring or null

Origin city name

msg.​origin_country_iso3string or null

Origin country ISO3 code

msg.​origin_postal_codestring or null

Origin postal/ZIP code

msg.​origin_raw_locationstring or null

Full origin address

msg.​origin_statestring or null

Origin state/province

msg.​pickup_locationstring or null

Pickup location details

msg.​pickup_notestring or null

Notes about pickup

msg.​return_to_senderboolean

Whether package is being returned to sender

msg.​shipment_delivery_datestring or null(date-time)

Actual delivery timestamp

msg.​shipment_package_countinteger

Number of packages in shipment

msg.​shipment_pickup_datestring or null(date-time)

When shipment was picked up

msg.​shipment_tagsArray of strings or null

Tags associated with the shipment

msg.​shipment_typestring or null

Type of shipment service

Example: "UPS Ground"
msg.​shipment_weightnumber

Total shipment weight

Example: 34.6
msg.​shipment_weight_unitstring or null

Unit of weight measurement

Enum"lb""kg"
msg.​signed_bystring or null

Name of person who signed for delivery

msg.​slugstring or nullrequired

Carrier slug identifier

Example: "ups"
msg.​smsesArray of strings or null

SMS phone numbers for notifications

msg.​sourcestring or null

Source of the tracking data

Example: "api"
msg.​subscribed_smsesArray of strings or null

Subscribed SMS phone numbers

msg.​subscribed_emailsArray of strings or null(email)

Subscribed email addresses

msg.​subtagstring or null

Detailed status subtag

Example: "Delivered_001"
msg.​subtag_messagestring or null

Human-readable subtag message

Example: "Delivered"
msg.​tagstring or nullrequired

Primary tracking status tag

Enum"Pending""InfoReceived""InTransit""OutForDelivery""AttemptFail""Delivered""AvailableForPickup""Exception""Expired"
Example: "Delivered"
msg.​titlestring or null

Tracking record title

msg.​tracked_countinteger

Number of times this tracking has been checked

msg.​tracking_account_numberstring or null

Carrier account number

msg.​tracking_destination_countrystring or null

Tracking destination country code

msg.​tracking_keystring or null

Tracking key identifier

msg.​tracking_numberstring or nullrequired

Carrier tracking number

Example: "1Z59E877A871526000"
msg.​tracking_origin_countrystring or null

Tracking origin country code

msg.​tracking_postal_codestring or null

Tracking destination postal code

msg.​tracking_ship_datestring or null

Ship date in YYYYMMDD format

Example: "20230720"
msg.​tracking_statestring or null

Tracking destination state

msg.​updated_atstring or null(date-time)

When this tracking record was last updated

msg.​pathstring or nullDeprecated

Deprecated field

msg.​unique_tokenstring or nullDeprecated

Deprecated unique token

tsintegerrequired

Unix timestamp when the event was generated

Example: 1690038623
Payload
{
  "event": "tracking_update",
  "event_id": "555e9daa-f6ca-48a2-b30c-48e23cd0d0d6",
  "is_tracking_first_tag": true,
  "ts": 1690038623,
  "msg": {
    "tag": "Delivered",
    "subtag": "Delivered_001",
    "subtag_message": "Delivered",
    "tracking_number": "1Z59E877A871526000",
    "slug": "ups",
    "active": true,
    "title": "33516482",
    "order_id": "CONT-013922021",
    "order_number": "33516482",
    "customer_name": "Jane D.",
    "destination_city": "Belleair",
    "destination_state": "FL",
    "destination_postal_code": "33756-1925",
    "destination_country_iso3": "USA",
    "shipment_delivery_date": "2026-07-22T11:08:44-04:00",
    "last_updated_at": "2026-07-22T15:10:23+00:00"
  }
}

Receive

Receive

receiveTrackingUpdate

Receive tracking update events

Your webhook endpoint will receive HTTP POST requests containing tracking update events.

Your endpoint must respond with HTTP status code 200-299 to acknowledge successful receipt. Non-successful responses will trigger the retry mechanism.

Messages

Tracking Update Event