asyncapi: 3.0.0
info:
  title: Wineshipping Tracking Events
  version: 3.1.0
  description: >
    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.
  contact:
    name: Wineshipping API Support
    email: api@wineshipping.com
  license:
    name: Proprietary
    url: https://www.wineshipping.com
servers:
  production:
    host: '{customer-webhook-url}'
    protocol: https
    description: Customer-provided webhook endpoint for production tracking events
    variables:
      customer-webhook-url:
        description: The webhook URL provided by the customer during setup
  test:
    host: '{customer-webhook-url}'
    protocol: https
    description: Customer-provided webhook endpoint for test tracking events
    variables:
      customer-webhook-url:
        description: The webhook URL provided by the customer during setup
channels:
  trackingUpdates:
    summary: Tracking Events
    address: /
    messages:
      trackingUpdate:
        name: TrackingUpdate
        title: Tracking Update Event
        summary: Shipment tracking status update
        contentType: application/json
        payload:
          type: object
          description: Root payload for tracking update webhook events
          required:
            - event
            - event_id
            - is_tracking_first_tag
            - msg
            - ts
          properties:
            event:
              type:
                - string
                - 'null'
              description: Event type identifier
              enum:
                - tracking_update
              example: tracking_update
            event_id:
              type:
                - string
                - 'null'
              format: uuid
              description: Unique identifier for this webhook event
              example: 555e9daa-f6ca-48a2-b30c-48e23cd0d0d6
            is_tracking_first_tag:
              type: boolean
              description: Indicates if this is the first tracking event for this shipment
              example: true
            msg:
              type: object
              description: Detailed tracking information for the shipment
              required:
                - tag
                - tracking_number
                - slug
              properties:
                active:
                  type: boolean
                  description: Whether tracking is currently active for this shipment
                aftership_estimated_delivery_date:
                  type: object
                  description: AfterShip estimated delivery date information
                  properties:
                    estimated_delivery_date:
                      type:
                        - string
                        - 'null'
                      format: date
                      description: Primary estimated delivery date
                    confidence_score:
                      type: number
                      description: Confidence score for the estimate
                    estimated_delivery_date_min:
                      type:
                        - string
                        - 'null'
                      format: date
                      description: Minimum estimated delivery date
                    estimated_delivery_date_max:
                      type:
                        - string
                        - 'null'
                      format: date
                      description: Maximum estimated delivery date
                android:
                  type: array
                  description: Android push notification identifiers
                  items:
                    type:
                      - string
                      - 'null'
                checkpoints:
                  type: array
                  description: Array of tracking checkpoint events
                  items:
                    type: object
                    description: Individual tracking checkpoint event from carrier
                    properties:
                      checkpoint_time:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        description: Timestamp of the checkpoint event
                        example: '2026-07-22T11:08:44-04:00'
                      city:
                        type:
                          - string
                          - 'null'
                        description: City where checkpoint occurred
                      coordinates:
                        type: array
                        description: Geographic coordinates of checkpoint
                        items:
                          type: number
                      country_iso3:
                        type:
                          - string
                          - 'null'
                        description: Country ISO3 code
                        example: USA
                      country_name:
                        type:
                          - string
                          - 'null'
                        description: Country name
                        example: United States
                      created_at:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        description: When this checkpoint was created in the system
                      location:
                        type:
                          - string
                          - 'null'
                        description: Full location string
                        example: BELLEAIR, FL, 33756, US, United States
                      message:
                        type:
                          - string
                          - 'null'
                        description: Carrier-provided checkpoint message
                        example: Delivered
                      raw_tag:
                        type:
                          - string
                          - 'null'
                        description: Raw carrier status code
                        example: KB
                      slug:
                        type:
                          - string
                          - 'null'
                        description: Carrier slug identifier
                        example: ups
                      state:
                        type:
                          - string
                          - 'null'
                        description: State/province code
                      subtag:
                        type:
                          - string
                          - 'null'
                        description: Normalized subtag
                        example: Delivered_001
                      subtag_message:
                        type:
                          - string
                          - 'null'
                        description: Human-readable subtag message
                        example: Delivered
                      tag:
                        type:
                          - string
                          - 'null'
                        description: Normalized tracking status tag
                        enum:
                          - Pending
                          - InfoReceived
                          - InTransit
                          - OutForDelivery
                          - AttemptFail
                          - Delivered
                          - AvailableForPickup
                          - Exception
                          - Expired
                        example: Delivered
                      zip:
                        type:
                          - string
                          - 'null'
                        description: ZIP/postal code
                courier_connection_id:
                  type:
                    - string
                    - 'null'
                  description: Connection identifier for the courier
                courier_destination_country_iso3:
                  type:
                    - string
                    - 'null'
                  description: Destination country ISO3 code
                  example: USA
                courier_redirect_link:
                  type:
                    - string
                    - 'null'
                  format: uri
                  description: URL to redirect to carrier tracking page
                courier_tracking_link:
                  type:
                    - string
                    - 'null'
                  format: uri
                  description: Direct link to carrier tracking information
                created_at:
                  type:
                    - string
                    - 'null'
                  format: date-time
                  description: When this tracking record was created
                custom_estimated_delivery_date:
                  type:
                    - string
                    - 'null'
                  format: date
                  description: Customer-specified estimated delivery date
                custom_fields:
                  type: object
                  description: Custom metadata fields specific to the shipment
                  additionalProperties: true
                  properties:
                    contents:
                      type:
                        - string
                        - 'null'
                      description: Detailed contents of the shipment
                    contents_collateral_units:
                      type:
                        - string
                        - 'null'
                      description: Number of collateral units
                    contents_merch_units:
                      type:
                        - string
                        - 'null'
                      description: Number of merchandise units
                    contents_product_units:
                      type:
                        - string
                        - 'null'
                      description: Number of product units
                    date_dc:
                      type:
                        - string
                        - 'null'
                      description: Distribution center date
                    date_input:
                      type:
                        - string
                        - 'null'
                      format: date
                      description: Input date
                    date_packed:
                      type:
                        - string
                        - 'null'
                      format: date-time
                      description: When the shipment was packed
                    dc_cid:
                      type:
                        - string
                        - 'null'
                      description: Distribution center container ID
                    dc_oid:
                      type:
                        - string
                        - 'null'
                      description: Distribution center order ID
                    dc_pool:
                      type:
                        - string
                        - 'null'
                      description: Distribution center pool designation
                    dc_ship_confirm:
                      type:
                        - string
                        - 'null'
                      format: date-time
                      description: Distribution center ship confirmation timestamp
                    dc_ver:
                      type:
                        - string
                        - 'null'
                      description: Distribution center API version
                    final_mile:
                      type:
                        - string
                        - 'null'
                      description: Final mile carrier
                    oms_contents:
                      type:
                        - string
                        - 'null'
                      description: Order management system contents
                    regulatory_attributes:
                      type:
                        - string
                        - 'null'
                      description: Regulatory compliance attributes
                    rsd:
                      type:
                        - string
                        - 'null'
                      format: date
                      description: Requested ship date
                    seller_name:
                      type:
                        - string
                        - 'null'
                      description: Name of the seller/winery
                    seller_number:
                      type:
                        - string
                        - 'null'
                      description: Seller account number
                    shipfrom_dc:
                      type:
                        - string
                        - 'null'
                      description: Shipping distribution center code
                    special_attributes:
                      type:
                        - string
                        - 'null'
                      description: Special handling attributes
                    special_instructions:
                      type:
                        - string
                        - 'null'
                      description: Special delivery instructions
                    transmission_id:
                      type:
                        - string
                        - 'null'
                      description: Transmission identifier
                    transport_zone:
                      type:
                        - string
                        - 'null'
                      description: Transport zone
                    tref:
                      type:
                        - string
                        - 'null'
                      format: uuid
                      description: Transaction reference
                customer_name:
                  type:
                    - string
                    - 'null'
                  description: Recipient customer name
                delivery_time:
                  type: integer
                  description: Delivery time in days
                delivery_type:
                  type:
                    - string
                    - 'null'
                  description: Type of delivery service
                destination_city:
                  type:
                    - string
                    - 'null'
                  description: Destination city name
                destination_country_iso3:
                  type:
                    - string
                    - 'null'
                  description: Destination country ISO3 code
                destination_postal_code:
                  type:
                    - string
                    - 'null'
                  description: Destination postal/ZIP code
                destination_raw_location:
                  type:
                    - string
                    - 'null'
                  description: Full destination address
                destination_state:
                  type:
                    - string
                    - 'null'
                  description: Destination state/province code
                emails:
                  type: array
                  description: Email addresses for notifications
                  items:
                    type:
                      - string
                      - 'null'
                    format: email
                expected_delivery:
                  type:
                    - string
                    - 'null'
                  format: date
                  description: Expected delivery date
                first_attempted_at:
                  type:
                    - string
                    - 'null'
                  format: date-time
                  description: Timestamp of first delivery attempt
                first_estimated_delivery:
                  type: object
                  description: Estimated delivery information
                  properties:
                    source:
                      type:
                        - string
                        - 'null'
                      description: Source of the estimate
                      example: Carrier EDD
                    datetime:
                      type:
                        - string
                        - 'null'
                      format: date
                      description: Estimated delivery date
                    type:
                      type:
                        - string
                        - 'null'
                      description: Type of estimate
                      enum:
                        - specific
                        - range
                    datetime_min:
                      type:
                        - string
                        - 'null'
                      format: date
                      description: Minimum estimated delivery datetime
                    datetime_max:
                      type:
                        - string
                        - 'null'
                      format: date
                      description: Maximum estimated delivery datetime
                id:
                  type:
                    - string
                    - 'null'
                  description: Unique tracking record identifier
                ios:
                  type: array
                  description: iOS push notification identifiers
                  items:
                    type:
                      - string
                      - 'null'
                language:
                  type:
                    - string
                    - 'null'
                  description: Language code for notifications
                  example: en
                last_mile_tracking_supported:
                  type: boolean
                  description: Whether last-mile tracking is supported
                last_updated_at:
                  type:
                    - string
                    - 'null'
                  format: date-time
                  description: When this tracking record was last updated
                latest_estimated_delivery:
                  type: object
                  description: Estimated delivery information
                  properties:
                    source:
                      type:
                        - string
                        - 'null'
                      description: Source of the estimate
                      example: Carrier EDD
                    datetime:
                      type:
                        - string
                        - 'null'
                      format: date
                      description: Estimated delivery date
                    type:
                      type:
                        - string
                        - 'null'
                      description: Type of estimate
                      enum:
                        - specific
                        - range
                    datetime_min:
                      type:
                        - string
                        - 'null'
                      format: date
                      description: Minimum estimated delivery datetime
                    datetime_max:
                      type:
                        - string
                        - 'null'
                      format: date
                      description: Maximum estimated delivery datetime
                next_couriers:
                  type: array
                  description: Next carriers in multi-carrier shipments
                  items:
                    type: object
                note:
                  type:
                    - string
                    - 'null'
                  description: Additional notes about the shipment
                on_time_difference:
                  type: integer
                  description: Number of days difference from expected delivery
                on_time_status:
                  type:
                    - string
                    - 'null'
                  description: On-time delivery status
                  enum:
                    - early
                    - on_time
                    - late
                order_date:
                  type:
                    - string
                    - 'null'
                  format: date-time
                  description: Date the order was placed
                order_id:
                  type:
                    - string
                    - 'null'
                  description: Order identifier
                order_id_path:
                  type:
                    - string
                    - 'null'
                  description: Order ID path for hierarchical orders
                order_number:
                  type:
                    - string
                    - 'null'
                  description: Customer-facing order number
                order_promised_delivery_date:
                  type:
                    - string
                    - 'null'
                  format: date
                  description: Promised delivery date from order
                order_tags:
                  type: array
                  description: Tags associated with the order
                  items:
                    type:
                      - string
                      - 'null'
                origin_city:
                  type:
                    - string
                    - 'null'
                  description: Origin city name
                origin_country_iso3:
                  type:
                    - string
                    - 'null'
                  description: Origin country ISO3 code
                origin_postal_code:
                  type:
                    - string
                    - 'null'
                  description: Origin postal/ZIP code
                origin_raw_location:
                  type:
                    - string
                    - 'null'
                  description: Full origin address
                origin_state:
                  type:
                    - string
                    - 'null'
                  description: Origin state/province
                path:
                  type:
                    - string
                    - 'null'
                  deprecated: true
                  description: Deprecated field
                pickup_location:
                  type:
                    - string
                    - 'null'
                  description: Pickup location details
                pickup_note:
                  type:
                    - string
                    - 'null'
                  description: Notes about pickup
                return_to_sender:
                  type: boolean
                  description: Whether package is being returned to sender
                shipment_delivery_date:
                  type:
                    - string
                    - 'null'
                  format: date-time
                  description: Actual delivery timestamp
                shipment_package_count:
                  type: integer
                  description: Number of packages in shipment
                shipment_pickup_date:
                  type:
                    - string
                    - 'null'
                  format: date-time
                  description: When shipment was picked up
                shipment_tags:
                  type: array
                  description: Tags associated with the shipment
                  items:
                    type:
                      - string
                      - 'null'
                shipment_type:
                  type:
                    - string
                    - 'null'
                  description: Type of shipment service
                  example: UPS Ground
                shipment_weight:
                  type: number
                  description: Total shipment weight
                  example: 34.6
                shipment_weight_unit:
                  type:
                    - string
                    - 'null'
                  description: Unit of weight measurement
                  enum:
                    - lb
                    - kg
                signed_by:
                  type:
                    - string
                    - 'null'
                  description: Name of person who signed for delivery
                slug:
                  type:
                    - string
                    - 'null'
                  description: Carrier slug identifier
                  example: ups
                smses:
                  type: array
                  description: SMS phone numbers for notifications
                  items:
                    type:
                      - string
                      - 'null'
                source:
                  type:
                    - string
                    - 'null'
                  description: Source of the tracking data
                  example: api
                subscribed_smses:
                  type: array
                  description: Subscribed SMS phone numbers
                  items:
                    type:
                      - string
                      - 'null'
                subscribed_emails:
                  type: array
                  description: Subscribed email addresses
                  items:
                    type:
                      - string
                      - 'null'
                    format: email
                subtag:
                  type:
                    - string
                    - 'null'
                  description: Detailed status subtag
                  example: Delivered_001
                subtag_message:
                  type:
                    - string
                    - 'null'
                  description: Human-readable subtag message
                  example: Delivered
                tag:
                  type:
                    - string
                    - 'null'
                  description: Primary tracking status tag
                  enum:
                    - Pending
                    - InfoReceived
                    - InTransit
                    - OutForDelivery
                    - AttemptFail
                    - Delivered
                    - AvailableForPickup
                    - Exception
                    - Expired
                  example: Delivered
                title:
                  type:
                    - string
                    - 'null'
                  description: Tracking record title
                tracked_count:
                  type: integer
                  description: Number of times this tracking has been checked
                tracking_account_number:
                  type:
                    - string
                    - 'null'
                  description: Carrier account number
                tracking_destination_country:
                  type:
                    - string
                    - 'null'
                  description: Tracking destination country code
                tracking_key:
                  type:
                    - string
                    - 'null'
                  description: Tracking key identifier
                tracking_number:
                  type:
                    - string
                    - 'null'
                  description: Carrier tracking number
                  example: 1Z59E877A871526000
                tracking_origin_country:
                  type:
                    - string
                    - 'null'
                  description: Tracking origin country code
                tracking_postal_code:
                  type:
                    - string
                    - 'null'
                  description: Tracking destination postal code
                tracking_ship_date:
                  type:
                    - string
                    - 'null'
                  description: Ship date in YYYYMMDD format
                  example: '20230720'
                tracking_state:
                  type:
                    - string
                    - 'null'
                  description: Tracking destination state
                unique_token:
                  type:
                    - string
                    - 'null'
                  deprecated: true
                  description: Deprecated unique token
                updated_at:
                  type:
                    - string
                    - 'null'
                  format: date-time
                  description: When this tracking record was last updated
            ts:
              type: integer
              description: Unix timestamp when the event was generated
              example: 1690038623
        examples:
          - name: DeliveredEvent
            summary: Package delivered successfully
            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'
    description: Channel for receiving shipment tracking update events
operations:
  receiveTrackingUpdate:
    action: receive
    channel:
      summary: Tracking Events
      address: /
      messages:
        trackingUpdate:
          name: TrackingUpdate
          title: Tracking Update Event
          summary: Shipment tracking status update
          contentType: application/json
          payload:
            type: object
            description: Root payload for tracking update webhook events
            required:
              - event
              - event_id
              - is_tracking_first_tag
              - msg
              - ts
            properties:
              event:
                type:
                  - string
                  - 'null'
                description: Event type identifier
                enum:
                  - tracking_update
                example: tracking_update
              event_id:
                type:
                  - string
                  - 'null'
                format: uuid
                description: Unique identifier for this webhook event
                example: 555e9daa-f6ca-48a2-b30c-48e23cd0d0d6
              is_tracking_first_tag:
                type: boolean
                description: >-
                  Indicates if this is the first tracking event for this
                  shipment
                example: true
              msg:
                type: object
                description: Detailed tracking information for the shipment
                required:
                  - tag
                  - tracking_number
                  - slug
                properties:
                  active:
                    type: boolean
                    description: Whether tracking is currently active for this shipment
                  aftership_estimated_delivery_date:
                    type: object
                    description: AfterShip estimated delivery date information
                    properties:
                      estimated_delivery_date:
                        type:
                          - string
                          - 'null'
                        format: date
                        description: Primary estimated delivery date
                      confidence_score:
                        type: number
                        description: Confidence score for the estimate
                      estimated_delivery_date_min:
                        type:
                          - string
                          - 'null'
                        format: date
                        description: Minimum estimated delivery date
                      estimated_delivery_date_max:
                        type:
                          - string
                          - 'null'
                        format: date
                        description: Maximum estimated delivery date
                  android:
                    type: array
                    description: Android push notification identifiers
                    items:
                      type:
                        - string
                        - 'null'
                  checkpoints:
                    type: array
                    description: Array of tracking checkpoint events
                    items:
                      type: object
                      description: Individual tracking checkpoint event from carrier
                      properties:
                        checkpoint_time:
                          type:
                            - string
                            - 'null'
                          format: date-time
                          description: Timestamp of the checkpoint event
                          example: '2026-07-22T11:08:44-04:00'
                        city:
                          type:
                            - string
                            - 'null'
                          description: City where checkpoint occurred
                        coordinates:
                          type: array
                          description: Geographic coordinates of checkpoint
                          items:
                            type: number
                        country_iso3:
                          type:
                            - string
                            - 'null'
                          description: Country ISO3 code
                          example: USA
                        country_name:
                          type:
                            - string
                            - 'null'
                          description: Country name
                          example: United States
                        created_at:
                          type:
                            - string
                            - 'null'
                          format: date-time
                          description: When this checkpoint was created in the system
                        location:
                          type:
                            - string
                            - 'null'
                          description: Full location string
                          example: BELLEAIR, FL, 33756, US, United States
                        message:
                          type:
                            - string
                            - 'null'
                          description: Carrier-provided checkpoint message
                          example: Delivered
                        raw_tag:
                          type:
                            - string
                            - 'null'
                          description: Raw carrier status code
                          example: KB
                        slug:
                          type:
                            - string
                            - 'null'
                          description: Carrier slug identifier
                          example: ups
                        state:
                          type:
                            - string
                            - 'null'
                          description: State/province code
                        subtag:
                          type:
                            - string
                            - 'null'
                          description: Normalized subtag
                          example: Delivered_001
                        subtag_message:
                          type:
                            - string
                            - 'null'
                          description: Human-readable subtag message
                          example: Delivered
                        tag:
                          type:
                            - string
                            - 'null'
                          description: Normalized tracking status tag
                          enum:
                            - Pending
                            - InfoReceived
                            - InTransit
                            - OutForDelivery
                            - AttemptFail
                            - Delivered
                            - AvailableForPickup
                            - Exception
                            - Expired
                          example: Delivered
                        zip:
                          type:
                            - string
                            - 'null'
                          description: ZIP/postal code
                  courier_connection_id:
                    type:
                      - string
                      - 'null'
                    description: Connection identifier for the courier
                  courier_destination_country_iso3:
                    type:
                      - string
                      - 'null'
                    description: Destination country ISO3 code
                    example: USA
                  courier_redirect_link:
                    type:
                      - string
                      - 'null'
                    format: uri
                    description: URL to redirect to carrier tracking page
                  courier_tracking_link:
                    type:
                      - string
                      - 'null'
                    format: uri
                    description: Direct link to carrier tracking information
                  created_at:
                    type:
                      - string
                      - 'null'
                    format: date-time
                    description: When this tracking record was created
                  custom_estimated_delivery_date:
                    type:
                      - string
                      - 'null'
                    format: date
                    description: Customer-specified estimated delivery date
                  custom_fields:
                    type: object
                    description: Custom metadata fields specific to the shipment
                    additionalProperties: true
                    properties:
                      contents:
                        type:
                          - string
                          - 'null'
                        description: Detailed contents of the shipment
                      contents_collateral_units:
                        type:
                          - string
                          - 'null'
                        description: Number of collateral units
                      contents_merch_units:
                        type:
                          - string
                          - 'null'
                        description: Number of merchandise units
                      contents_product_units:
                        type:
                          - string
                          - 'null'
                        description: Number of product units
                      date_dc:
                        type:
                          - string
                          - 'null'
                        description: Distribution center date
                      date_input:
                        type:
                          - string
                          - 'null'
                        format: date
                        description: Input date
                      date_packed:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        description: When the shipment was packed
                      dc_cid:
                        type:
                          - string
                          - 'null'
                        description: Distribution center container ID
                      dc_oid:
                        type:
                          - string
                          - 'null'
                        description: Distribution center order ID
                      dc_pool:
                        type:
                          - string
                          - 'null'
                        description: Distribution center pool designation
                      dc_ship_confirm:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        description: Distribution center ship confirmation timestamp
                      dc_ver:
                        type:
                          - string
                          - 'null'
                        description: Distribution center API version
                      final_mile:
                        type:
                          - string
                          - 'null'
                        description: Final mile carrier
                      oms_contents:
                        type:
                          - string
                          - 'null'
                        description: Order management system contents
                      regulatory_attributes:
                        type:
                          - string
                          - 'null'
                        description: Regulatory compliance attributes
                      rsd:
                        type:
                          - string
                          - 'null'
                        format: date
                        description: Requested ship date
                      seller_name:
                        type:
                          - string
                          - 'null'
                        description: Name of the seller/winery
                      seller_number:
                        type:
                          - string
                          - 'null'
                        description: Seller account number
                      shipfrom_dc:
                        type:
                          - string
                          - 'null'
                        description: Shipping distribution center code
                      special_attributes:
                        type:
                          - string
                          - 'null'
                        description: Special handling attributes
                      special_instructions:
                        type:
                          - string
                          - 'null'
                        description: Special delivery instructions
                      transmission_id:
                        type:
                          - string
                          - 'null'
                        description: Transmission identifier
                      transport_zone:
                        type:
                          - string
                          - 'null'
                        description: Transport zone
                      tref:
                        type:
                          - string
                          - 'null'
                        format: uuid
                        description: Transaction reference
                  customer_name:
                    type:
                      - string
                      - 'null'
                    description: Recipient customer name
                  delivery_time:
                    type: integer
                    description: Delivery time in days
                  delivery_type:
                    type:
                      - string
                      - 'null'
                    description: Type of delivery service
                  destination_city:
                    type:
                      - string
                      - 'null'
                    description: Destination city name
                  destination_country_iso3:
                    type:
                      - string
                      - 'null'
                    description: Destination country ISO3 code
                  destination_postal_code:
                    type:
                      - string
                      - 'null'
                    description: Destination postal/ZIP code
                  destination_raw_location:
                    type:
                      - string
                      - 'null'
                    description: Full destination address
                  destination_state:
                    type:
                      - string
                      - 'null'
                    description: Destination state/province code
                  emails:
                    type: array
                    description: Email addresses for notifications
                    items:
                      type:
                        - string
                        - 'null'
                      format: email
                  expected_delivery:
                    type:
                      - string
                      - 'null'
                    format: date
                    description: Expected delivery date
                  first_attempted_at:
                    type:
                      - string
                      - 'null'
                    format: date-time
                    description: Timestamp of first delivery attempt
                  first_estimated_delivery:
                    type: object
                    description: Estimated delivery information
                    properties:
                      source:
                        type:
                          - string
                          - 'null'
                        description: Source of the estimate
                        example: Carrier EDD
                      datetime:
                        type:
                          - string
                          - 'null'
                        format: date
                        description: Estimated delivery date
                      type:
                        type:
                          - string
                          - 'null'
                        description: Type of estimate
                        enum:
                          - specific
                          - range
                      datetime_min:
                        type:
                          - string
                          - 'null'
                        format: date
                        description: Minimum estimated delivery datetime
                      datetime_max:
                        type:
                          - string
                          - 'null'
                        format: date
                        description: Maximum estimated delivery datetime
                  id:
                    type:
                      - string
                      - 'null'
                    description: Unique tracking record identifier
                  ios:
                    type: array
                    description: iOS push notification identifiers
                    items:
                      type:
                        - string
                        - 'null'
                  language:
                    type:
                      - string
                      - 'null'
                    description: Language code for notifications
                    example: en
                  last_mile_tracking_supported:
                    type: boolean
                    description: Whether last-mile tracking is supported
                  last_updated_at:
                    type:
                      - string
                      - 'null'
                    format: date-time
                    description: When this tracking record was last updated
                  latest_estimated_delivery:
                    type: object
                    description: Estimated delivery information
                    properties:
                      source:
                        type:
                          - string
                          - 'null'
                        description: Source of the estimate
                        example: Carrier EDD
                      datetime:
                        type:
                          - string
                          - 'null'
                        format: date
                        description: Estimated delivery date
                      type:
                        type:
                          - string
                          - 'null'
                        description: Type of estimate
                        enum:
                          - specific
                          - range
                      datetime_min:
                        type:
                          - string
                          - 'null'
                        format: date
                        description: Minimum estimated delivery datetime
                      datetime_max:
                        type:
                          - string
                          - 'null'
                        format: date
                        description: Maximum estimated delivery datetime
                  next_couriers:
                    type: array
                    description: Next carriers in multi-carrier shipments
                    items:
                      type: object
                  note:
                    type:
                      - string
                      - 'null'
                    description: Additional notes about the shipment
                  on_time_difference:
                    type: integer
                    description: Number of days difference from expected delivery
                  on_time_status:
                    type:
                      - string
                      - 'null'
                    description: On-time delivery status
                    enum:
                      - early
                      - on_time
                      - late
                  order_date:
                    type:
                      - string
                      - 'null'
                    format: date-time
                    description: Date the order was placed
                  order_id:
                    type:
                      - string
                      - 'null'
                    description: Order identifier
                  order_id_path:
                    type:
                      - string
                      - 'null'
                    description: Order ID path for hierarchical orders
                  order_number:
                    type:
                      - string
                      - 'null'
                    description: Customer-facing order number
                  order_promised_delivery_date:
                    type:
                      - string
                      - 'null'
                    format: date
                    description: Promised delivery date from order
                  order_tags:
                    type: array
                    description: Tags associated with the order
                    items:
                      type:
                        - string
                        - 'null'
                  origin_city:
                    type:
                      - string
                      - 'null'
                    description: Origin city name
                  origin_country_iso3:
                    type:
                      - string
                      - 'null'
                    description: Origin country ISO3 code
                  origin_postal_code:
                    type:
                      - string
                      - 'null'
                    description: Origin postal/ZIP code
                  origin_raw_location:
                    type:
                      - string
                      - 'null'
                    description: Full origin address
                  origin_state:
                    type:
                      - string
                      - 'null'
                    description: Origin state/province
                  path:
                    type:
                      - string
                      - 'null'
                    deprecated: true
                    description: Deprecated field
                  pickup_location:
                    type:
                      - string
                      - 'null'
                    description: Pickup location details
                  pickup_note:
                    type:
                      - string
                      - 'null'
                    description: Notes about pickup
                  return_to_sender:
                    type: boolean
                    description: Whether package is being returned to sender
                  shipment_delivery_date:
                    type:
                      - string
                      - 'null'
                    format: date-time
                    description: Actual delivery timestamp
                  shipment_package_count:
                    type: integer
                    description: Number of packages in shipment
                  shipment_pickup_date:
                    type:
                      - string
                      - 'null'
                    format: date-time
                    description: When shipment was picked up
                  shipment_tags:
                    type: array
                    description: Tags associated with the shipment
                    items:
                      type:
                        - string
                        - 'null'
                  shipment_type:
                    type:
                      - string
                      - 'null'
                    description: Type of shipment service
                    example: UPS Ground
                  shipment_weight:
                    type: number
                    description: Total shipment weight
                    example: 34.6
                  shipment_weight_unit:
                    type:
                      - string
                      - 'null'
                    description: Unit of weight measurement
                    enum:
                      - lb
                      - kg
                  signed_by:
                    type:
                      - string
                      - 'null'
                    description: Name of person who signed for delivery
                  slug:
                    type:
                      - string
                      - 'null'
                    description: Carrier slug identifier
                    example: ups
                  smses:
                    type: array
                    description: SMS phone numbers for notifications
                    items:
                      type:
                        - string
                        - 'null'
                  source:
                    type:
                      - string
                      - 'null'
                    description: Source of the tracking data
                    example: api
                  subscribed_smses:
                    type: array
                    description: Subscribed SMS phone numbers
                    items:
                      type:
                        - string
                        - 'null'
                  subscribed_emails:
                    type: array
                    description: Subscribed email addresses
                    items:
                      type:
                        - string
                        - 'null'
                      format: email
                  subtag:
                    type:
                      - string
                      - 'null'
                    description: Detailed status subtag
                    example: Delivered_001
                  subtag_message:
                    type:
                      - string
                      - 'null'
                    description: Human-readable subtag message
                    example: Delivered
                  tag:
                    type:
                      - string
                      - 'null'
                    description: Primary tracking status tag
                    enum:
                      - Pending
                      - InfoReceived
                      - InTransit
                      - OutForDelivery
                      - AttemptFail
                      - Delivered
                      - AvailableForPickup
                      - Exception
                      - Expired
                    example: Delivered
                  title:
                    type:
                      - string
                      - 'null'
                    description: Tracking record title
                  tracked_count:
                    type: integer
                    description: Number of times this tracking has been checked
                  tracking_account_number:
                    type:
                      - string
                      - 'null'
                    description: Carrier account number
                  tracking_destination_country:
                    type:
                      - string
                      - 'null'
                    description: Tracking destination country code
                  tracking_key:
                    type:
                      - string
                      - 'null'
                    description: Tracking key identifier
                  tracking_number:
                    type:
                      - string
                      - 'null'
                    description: Carrier tracking number
                    example: 1Z59E877A871526000
                  tracking_origin_country:
                    type:
                      - string
                      - 'null'
                    description: Tracking origin country code
                  tracking_postal_code:
                    type:
                      - string
                      - 'null'
                    description: Tracking destination postal code
                  tracking_ship_date:
                    type:
                      - string
                      - 'null'
                    description: Ship date in YYYYMMDD format
                    example: '20230720'
                  tracking_state:
                    type:
                      - string
                      - 'null'
                    description: Tracking destination state
                  unique_token:
                    type:
                      - string
                      - 'null'
                    deprecated: true
                    description: Deprecated unique token
                  updated_at:
                    type:
                      - string
                      - 'null'
                    format: date-time
                    description: When this tracking record was last updated
              ts:
                type: integer
                description: Unix timestamp when the event was generated
                example: 1690038623
          examples:
            - name: DeliveredEvent
              summary: Package delivered successfully
              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'
      description: Channel for receiving shipment tracking update events
    summary: Receive tracking update events
    description: >
      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:
      - name: TrackingUpdate
        title: Tracking Update Event
        summary: Shipment tracking status update
        contentType: application/json
        payload:
          type: object
          description: Root payload for tracking update webhook events
          required:
            - event
            - event_id
            - is_tracking_first_tag
            - msg
            - ts
          properties:
            event:
              type:
                - string
                - 'null'
              description: Event type identifier
              enum:
                - tracking_update
              example: tracking_update
            event_id:
              type:
                - string
                - 'null'
              format: uuid
              description: Unique identifier for this webhook event
              example: 555e9daa-f6ca-48a2-b30c-48e23cd0d0d6
            is_tracking_first_tag:
              type: boolean
              description: Indicates if this is the first tracking event for this shipment
              example: true
            msg:
              type: object
              description: Detailed tracking information for the shipment
              required:
                - tag
                - tracking_number
                - slug
              properties:
                active:
                  type: boolean
                  description: Whether tracking is currently active for this shipment
                aftership_estimated_delivery_date:
                  type: object
                  description: AfterShip estimated delivery date information
                  properties:
                    estimated_delivery_date:
                      type:
                        - string
                        - 'null'
                      format: date
                      description: Primary estimated delivery date
                    confidence_score:
                      type: number
                      description: Confidence score for the estimate
                    estimated_delivery_date_min:
                      type:
                        - string
                        - 'null'
                      format: date
                      description: Minimum estimated delivery date
                    estimated_delivery_date_max:
                      type:
                        - string
                        - 'null'
                      format: date
                      description: Maximum estimated delivery date
                android:
                  type: array
                  description: Android push notification identifiers
                  items:
                    type:
                      - string
                      - 'null'
                checkpoints:
                  type: array
                  description: Array of tracking checkpoint events
                  items:
                    type: object
                    description: Individual tracking checkpoint event from carrier
                    properties:
                      checkpoint_time:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        description: Timestamp of the checkpoint event
                        example: '2026-07-22T11:08:44-04:00'
                      city:
                        type:
                          - string
                          - 'null'
                        description: City where checkpoint occurred
                      coordinates:
                        type: array
                        description: Geographic coordinates of checkpoint
                        items:
                          type: number
                      country_iso3:
                        type:
                          - string
                          - 'null'
                        description: Country ISO3 code
                        example: USA
                      country_name:
                        type:
                          - string
                          - 'null'
                        description: Country name
                        example: United States
                      created_at:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        description: When this checkpoint was created in the system
                      location:
                        type:
                          - string
                          - 'null'
                        description: Full location string
                        example: BELLEAIR, FL, 33756, US, United States
                      message:
                        type:
                          - string
                          - 'null'
                        description: Carrier-provided checkpoint message
                        example: Delivered
                      raw_tag:
                        type:
                          - string
                          - 'null'
                        description: Raw carrier status code
                        example: KB
                      slug:
                        type:
                          - string
                          - 'null'
                        description: Carrier slug identifier
                        example: ups
                      state:
                        type:
                          - string
                          - 'null'
                        description: State/province code
                      subtag:
                        type:
                          - string
                          - 'null'
                        description: Normalized subtag
                        example: Delivered_001
                      subtag_message:
                        type:
                          - string
                          - 'null'
                        description: Human-readable subtag message
                        example: Delivered
                      tag:
                        type:
                          - string
                          - 'null'
                        description: Normalized tracking status tag
                        enum:
                          - Pending
                          - InfoReceived
                          - InTransit
                          - OutForDelivery
                          - AttemptFail
                          - Delivered
                          - AvailableForPickup
                          - Exception
                          - Expired
                        example: Delivered
                      zip:
                        type:
                          - string
                          - 'null'
                        description: ZIP/postal code
                courier_connection_id:
                  type:
                    - string
                    - 'null'
                  description: Connection identifier for the courier
                courier_destination_country_iso3:
                  type:
                    - string
                    - 'null'
                  description: Destination country ISO3 code
                  example: USA
                courier_redirect_link:
                  type:
                    - string
                    - 'null'
                  format: uri
                  description: URL to redirect to carrier tracking page
                courier_tracking_link:
                  type:
                    - string
                    - 'null'
                  format: uri
                  description: Direct link to carrier tracking information
                created_at:
                  type:
                    - string
                    - 'null'
                  format: date-time
                  description: When this tracking record was created
                custom_estimated_delivery_date:
                  type:
                    - string
                    - 'null'
                  format: date
                  description: Customer-specified estimated delivery date
                custom_fields:
                  type: object
                  description: Custom metadata fields specific to the shipment
                  additionalProperties: true
                  properties:
                    contents:
                      type:
                        - string
                        - 'null'
                      description: Detailed contents of the shipment
                    contents_collateral_units:
                      type:
                        - string
                        - 'null'
                      description: Number of collateral units
                    contents_merch_units:
                      type:
                        - string
                        - 'null'
                      description: Number of merchandise units
                    contents_product_units:
                      type:
                        - string
                        - 'null'
                      description: Number of product units
                    date_dc:
                      type:
                        - string
                        - 'null'
                      description: Distribution center date
                    date_input:
                      type:
                        - string
                        - 'null'
                      format: date
                      description: Input date
                    date_packed:
                      type:
                        - string
                        - 'null'
                      format: date-time
                      description: When the shipment was packed
                    dc_cid:
                      type:
                        - string
                        - 'null'
                      description: Distribution center container ID
                    dc_oid:
                      type:
                        - string
                        - 'null'
                      description: Distribution center order ID
                    dc_pool:
                      type:
                        - string
                        - 'null'
                      description: Distribution center pool designation
                    dc_ship_confirm:
                      type:
                        - string
                        - 'null'
                      format: date-time
                      description: Distribution center ship confirmation timestamp
                    dc_ver:
                      type:
                        - string
                        - 'null'
                      description: Distribution center API version
                    final_mile:
                      type:
                        - string
                        - 'null'
                      description: Final mile carrier
                    oms_contents:
                      type:
                        - string
                        - 'null'
                      description: Order management system contents
                    regulatory_attributes:
                      type:
                        - string
                        - 'null'
                      description: Regulatory compliance attributes
                    rsd:
                      type:
                        - string
                        - 'null'
                      format: date
                      description: Requested ship date
                    seller_name:
                      type:
                        - string
                        - 'null'
                      description: Name of the seller/winery
                    seller_number:
                      type:
                        - string
                        - 'null'
                      description: Seller account number
                    shipfrom_dc:
                      type:
                        - string
                        - 'null'
                      description: Shipping distribution center code
                    special_attributes:
                      type:
                        - string
                        - 'null'
                      description: Special handling attributes
                    special_instructions:
                      type:
                        - string
                        - 'null'
                      description: Special delivery instructions
                    transmission_id:
                      type:
                        - string
                        - 'null'
                      description: Transmission identifier
                    transport_zone:
                      type:
                        - string
                        - 'null'
                      description: Transport zone
                    tref:
                      type:
                        - string
                        - 'null'
                      format: uuid
                      description: Transaction reference
                customer_name:
                  type:
                    - string
                    - 'null'
                  description: Recipient customer name
                delivery_time:
                  type: integer
                  description: Delivery time in days
                delivery_type:
                  type:
                    - string
                    - 'null'
                  description: Type of delivery service
                destination_city:
                  type:
                    - string
                    - 'null'
                  description: Destination city name
                destination_country_iso3:
                  type:
                    - string
                    - 'null'
                  description: Destination country ISO3 code
                destination_postal_code:
                  type:
                    - string
                    - 'null'
                  description: Destination postal/ZIP code
                destination_raw_location:
                  type:
                    - string
                    - 'null'
                  description: Full destination address
                destination_state:
                  type:
                    - string
                    - 'null'
                  description: Destination state/province code
                emails:
                  type: array
                  description: Email addresses for notifications
                  items:
                    type:
                      - string
                      - 'null'
                    format: email
                expected_delivery:
                  type:
                    - string
                    - 'null'
                  format: date
                  description: Expected delivery date
                first_attempted_at:
                  type:
                    - string
                    - 'null'
                  format: date-time
                  description: Timestamp of first delivery attempt
                first_estimated_delivery:
                  type: object
                  description: Estimated delivery information
                  properties:
                    source:
                      type:
                        - string
                        - 'null'
                      description: Source of the estimate
                      example: Carrier EDD
                    datetime:
                      type:
                        - string
                        - 'null'
                      format: date
                      description: Estimated delivery date
                    type:
                      type:
                        - string
                        - 'null'
                      description: Type of estimate
                      enum:
                        - specific
                        - range
                    datetime_min:
                      type:
                        - string
                        - 'null'
                      format: date
                      description: Minimum estimated delivery datetime
                    datetime_max:
                      type:
                        - string
                        - 'null'
                      format: date
                      description: Maximum estimated delivery datetime
                id:
                  type:
                    - string
                    - 'null'
                  description: Unique tracking record identifier
                ios:
                  type: array
                  description: iOS push notification identifiers
                  items:
                    type:
                      - string
                      - 'null'
                language:
                  type:
                    - string
                    - 'null'
                  description: Language code for notifications
                  example: en
                last_mile_tracking_supported:
                  type: boolean
                  description: Whether last-mile tracking is supported
                last_updated_at:
                  type:
                    - string
                    - 'null'
                  format: date-time
                  description: When this tracking record was last updated
                latest_estimated_delivery:
                  type: object
                  description: Estimated delivery information
                  properties:
                    source:
                      type:
                        - string
                        - 'null'
                      description: Source of the estimate
                      example: Carrier EDD
                    datetime:
                      type:
                        - string
                        - 'null'
                      format: date
                      description: Estimated delivery date
                    type:
                      type:
                        - string
                        - 'null'
                      description: Type of estimate
                      enum:
                        - specific
                        - range
                    datetime_min:
                      type:
                        - string
                        - 'null'
                      format: date
                      description: Minimum estimated delivery datetime
                    datetime_max:
                      type:
                        - string
                        - 'null'
                      format: date
                      description: Maximum estimated delivery datetime
                next_couriers:
                  type: array
                  description: Next carriers in multi-carrier shipments
                  items:
                    type: object
                note:
                  type:
                    - string
                    - 'null'
                  description: Additional notes about the shipment
                on_time_difference:
                  type: integer
                  description: Number of days difference from expected delivery
                on_time_status:
                  type:
                    - string
                    - 'null'
                  description: On-time delivery status
                  enum:
                    - early
                    - on_time
                    - late
                order_date:
                  type:
                    - string
                    - 'null'
                  format: date-time
                  description: Date the order was placed
                order_id:
                  type:
                    - string
                    - 'null'
                  description: Order identifier
                order_id_path:
                  type:
                    - string
                    - 'null'
                  description: Order ID path for hierarchical orders
                order_number:
                  type:
                    - string
                    - 'null'
                  description: Customer-facing order number
                order_promised_delivery_date:
                  type:
                    - string
                    - 'null'
                  format: date
                  description: Promised delivery date from order
                order_tags:
                  type: array
                  description: Tags associated with the order
                  items:
                    type:
                      - string
                      - 'null'
                origin_city:
                  type:
                    - string
                    - 'null'
                  description: Origin city name
                origin_country_iso3:
                  type:
                    - string
                    - 'null'
                  description: Origin country ISO3 code
                origin_postal_code:
                  type:
                    - string
                    - 'null'
                  description: Origin postal/ZIP code
                origin_raw_location:
                  type:
                    - string
                    - 'null'
                  description: Full origin address
                origin_state:
                  type:
                    - string
                    - 'null'
                  description: Origin state/province
                path:
                  type:
                    - string
                    - 'null'
                  deprecated: true
                  description: Deprecated field
                pickup_location:
                  type:
                    - string
                    - 'null'
                  description: Pickup location details
                pickup_note:
                  type:
                    - string
                    - 'null'
                  description: Notes about pickup
                return_to_sender:
                  type: boolean
                  description: Whether package is being returned to sender
                shipment_delivery_date:
                  type:
                    - string
                    - 'null'
                  format: date-time
                  description: Actual delivery timestamp
                shipment_package_count:
                  type: integer
                  description: Number of packages in shipment
                shipment_pickup_date:
                  type:
                    - string
                    - 'null'
                  format: date-time
                  description: When shipment was picked up
                shipment_tags:
                  type: array
                  description: Tags associated with the shipment
                  items:
                    type:
                      - string
                      - 'null'
                shipment_type:
                  type:
                    - string
                    - 'null'
                  description: Type of shipment service
                  example: UPS Ground
                shipment_weight:
                  type: number
                  description: Total shipment weight
                  example: 34.6
                shipment_weight_unit:
                  type:
                    - string
                    - 'null'
                  description: Unit of weight measurement
                  enum:
                    - lb
                    - kg
                signed_by:
                  type:
                    - string
                    - 'null'
                  description: Name of person who signed for delivery
                slug:
                  type:
                    - string
                    - 'null'
                  description: Carrier slug identifier
                  example: ups
                smses:
                  type: array
                  description: SMS phone numbers for notifications
                  items:
                    type:
                      - string
                      - 'null'
                source:
                  type:
                    - string
                    - 'null'
                  description: Source of the tracking data
                  example: api
                subscribed_smses:
                  type: array
                  description: Subscribed SMS phone numbers
                  items:
                    type:
                      - string
                      - 'null'
                subscribed_emails:
                  type: array
                  description: Subscribed email addresses
                  items:
                    type:
                      - string
                      - 'null'
                    format: email
                subtag:
                  type:
                    - string
                    - 'null'
                  description: Detailed status subtag
                  example: Delivered_001
                subtag_message:
                  type:
                    - string
                    - 'null'
                  description: Human-readable subtag message
                  example: Delivered
                tag:
                  type:
                    - string
                    - 'null'
                  description: Primary tracking status tag
                  enum:
                    - Pending
                    - InfoReceived
                    - InTransit
                    - OutForDelivery
                    - AttemptFail
                    - Delivered
                    - AvailableForPickup
                    - Exception
                    - Expired
                  example: Delivered
                title:
                  type:
                    - string
                    - 'null'
                  description: Tracking record title
                tracked_count:
                  type: integer
                  description: Number of times this tracking has been checked
                tracking_account_number:
                  type:
                    - string
                    - 'null'
                  description: Carrier account number
                tracking_destination_country:
                  type:
                    - string
                    - 'null'
                  description: Tracking destination country code
                tracking_key:
                  type:
                    - string
                    - 'null'
                  description: Tracking key identifier
                tracking_number:
                  type:
                    - string
                    - 'null'
                  description: Carrier tracking number
                  example: 1Z59E877A871526000
                tracking_origin_country:
                  type:
                    - string
                    - 'null'
                  description: Tracking origin country code
                tracking_postal_code:
                  type:
                    - string
                    - 'null'
                  description: Tracking destination postal code
                tracking_ship_date:
                  type:
                    - string
                    - 'null'
                  description: Ship date in YYYYMMDD format
                  example: '20230720'
                tracking_state:
                  type:
                    - string
                    - 'null'
                  description: Tracking destination state
                unique_token:
                  type:
                    - string
                    - 'null'
                  deprecated: true
                  description: Deprecated unique token
                updated_at:
                  type:
                    - string
                    - 'null'
                  format: date-time
                  description: When this tracking record was last updated
            ts:
              type: integer
              description: Unix timestamp when the event was generated
              example: 1690038623
        examples:
          - name: DeliveredEvent
            summary: Package delivered successfully
            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'
components:
  messages:
    TrackingUpdate:
      name: TrackingUpdate
      title: Tracking Update Event
      summary: Shipment tracking status update
      contentType: application/json
      payload:
        type: object
        description: Root payload for tracking update webhook events
        required:
          - event
          - event_id
          - is_tracking_first_tag
          - msg
          - ts
        properties:
          event:
            type:
              - string
              - 'null'
            description: Event type identifier
            enum:
              - tracking_update
            example: tracking_update
          event_id:
            type:
              - string
              - 'null'
            format: uuid
            description: Unique identifier for this webhook event
            example: 555e9daa-f6ca-48a2-b30c-48e23cd0d0d6
          is_tracking_first_tag:
            type: boolean
            description: Indicates if this is the first tracking event for this shipment
            example: true
          msg:
            type: object
            description: Detailed tracking information for the shipment
            required:
              - tag
              - tracking_number
              - slug
            properties:
              active:
                type: boolean
                description: Whether tracking is currently active for this shipment
              aftership_estimated_delivery_date:
                type: object
                description: AfterShip estimated delivery date information
                properties:
                  estimated_delivery_date:
                    type:
                      - string
                      - 'null'
                    format: date
                    description: Primary estimated delivery date
                  confidence_score:
                    type: number
                    description: Confidence score for the estimate
                  estimated_delivery_date_min:
                    type:
                      - string
                      - 'null'
                    format: date
                    description: Minimum estimated delivery date
                  estimated_delivery_date_max:
                    type:
                      - string
                      - 'null'
                    format: date
                    description: Maximum estimated delivery date
              android:
                type: array
                description: Android push notification identifiers
                items:
                  type:
                    - string
                    - 'null'
              checkpoints:
                type: array
                description: Array of tracking checkpoint events
                items:
                  type: object
                  description: Individual tracking checkpoint event from carrier
                  properties:
                    checkpoint_time:
                      type:
                        - string
                        - 'null'
                      format: date-time
                      description: Timestamp of the checkpoint event
                      example: '2026-07-22T11:08:44-04:00'
                    city:
                      type:
                        - string
                        - 'null'
                      description: City where checkpoint occurred
                    coordinates:
                      type: array
                      description: Geographic coordinates of checkpoint
                      items:
                        type: number
                    country_iso3:
                      type:
                        - string
                        - 'null'
                      description: Country ISO3 code
                      example: USA
                    country_name:
                      type:
                        - string
                        - 'null'
                      description: Country name
                      example: United States
                    created_at:
                      type:
                        - string
                        - 'null'
                      format: date-time
                      description: When this checkpoint was created in the system
                    location:
                      type:
                        - string
                        - 'null'
                      description: Full location string
                      example: BELLEAIR, FL, 33756, US, United States
                    message:
                      type:
                        - string
                        - 'null'
                      description: Carrier-provided checkpoint message
                      example: Delivered
                    raw_tag:
                      type:
                        - string
                        - 'null'
                      description: Raw carrier status code
                      example: KB
                    slug:
                      type:
                        - string
                        - 'null'
                      description: Carrier slug identifier
                      example: ups
                    state:
                      type:
                        - string
                        - 'null'
                      description: State/province code
                    subtag:
                      type:
                        - string
                        - 'null'
                      description: Normalized subtag
                      example: Delivered_001
                    subtag_message:
                      type:
                        - string
                        - 'null'
                      description: Human-readable subtag message
                      example: Delivered
                    tag:
                      type:
                        - string
                        - 'null'
                      description: Normalized tracking status tag
                      enum:
                        - Pending
                        - InfoReceived
                        - InTransit
                        - OutForDelivery
                        - AttemptFail
                        - Delivered
                        - AvailableForPickup
                        - Exception
                        - Expired
                      example: Delivered
                    zip:
                      type:
                        - string
                        - 'null'
                      description: ZIP/postal code
              courier_connection_id:
                type:
                  - string
                  - 'null'
                description: Connection identifier for the courier
              courier_destination_country_iso3:
                type:
                  - string
                  - 'null'
                description: Destination country ISO3 code
                example: USA
              courier_redirect_link:
                type:
                  - string
                  - 'null'
                format: uri
                description: URL to redirect to carrier tracking page
              courier_tracking_link:
                type:
                  - string
                  - 'null'
                format: uri
                description: Direct link to carrier tracking information
              created_at:
                type:
                  - string
                  - 'null'
                format: date-time
                description: When this tracking record was created
              custom_estimated_delivery_date:
                type:
                  - string
                  - 'null'
                format: date
                description: Customer-specified estimated delivery date
              custom_fields:
                type: object
                description: Custom metadata fields specific to the shipment
                additionalProperties: true
                properties:
                  contents:
                    type:
                      - string
                      - 'null'
                    description: Detailed contents of the shipment
                  contents_collateral_units:
                    type:
                      - string
                      - 'null'
                    description: Number of collateral units
                  contents_merch_units:
                    type:
                      - string
                      - 'null'
                    description: Number of merchandise units
                  contents_product_units:
                    type:
                      - string
                      - 'null'
                    description: Number of product units
                  date_dc:
                    type:
                      - string
                      - 'null'
                    description: Distribution center date
                  date_input:
                    type:
                      - string
                      - 'null'
                    format: date
                    description: Input date
                  date_packed:
                    type:
                      - string
                      - 'null'
                    format: date-time
                    description: When the shipment was packed
                  dc_cid:
                    type:
                      - string
                      - 'null'
                    description: Distribution center container ID
                  dc_oid:
                    type:
                      - string
                      - 'null'
                    description: Distribution center order ID
                  dc_pool:
                    type:
                      - string
                      - 'null'
                    description: Distribution center pool designation
                  dc_ship_confirm:
                    type:
                      - string
                      - 'null'
                    format: date-time
                    description: Distribution center ship confirmation timestamp
                  dc_ver:
                    type:
                      - string
                      - 'null'
                    description: Distribution center API version
                  final_mile:
                    type:
                      - string
                      - 'null'
                    description: Final mile carrier
                  oms_contents:
                    type:
                      - string
                      - 'null'
                    description: Order management system contents
                  regulatory_attributes:
                    type:
                      - string
                      - 'null'
                    description: Regulatory compliance attributes
                  rsd:
                    type:
                      - string
                      - 'null'
                    format: date
                    description: Requested ship date
                  seller_name:
                    type:
                      - string
                      - 'null'
                    description: Name of the seller/winery
                  seller_number:
                    type:
                      - string
                      - 'null'
                    description: Seller account number
                  shipfrom_dc:
                    type:
                      - string
                      - 'null'
                    description: Shipping distribution center code
                  special_attributes:
                    type:
                      - string
                      - 'null'
                    description: Special handling attributes
                  special_instructions:
                    type:
                      - string
                      - 'null'
                    description: Special delivery instructions
                  transmission_id:
                    type:
                      - string
                      - 'null'
                    description: Transmission identifier
                  transport_zone:
                    type:
                      - string
                      - 'null'
                    description: Transport zone
                  tref:
                    type:
                      - string
                      - 'null'
                    format: uuid
                    description: Transaction reference
              customer_name:
                type:
                  - string
                  - 'null'
                description: Recipient customer name
              delivery_time:
                type: integer
                description: Delivery time in days
              delivery_type:
                type:
                  - string
                  - 'null'
                description: Type of delivery service
              destination_city:
                type:
                  - string
                  - 'null'
                description: Destination city name
              destination_country_iso3:
                type:
                  - string
                  - 'null'
                description: Destination country ISO3 code
              destination_postal_code:
                type:
                  - string
                  - 'null'
                description: Destination postal/ZIP code
              destination_raw_location:
                type:
                  - string
                  - 'null'
                description: Full destination address
              destination_state:
                type:
                  - string
                  - 'null'
                description: Destination state/province code
              emails:
                type: array
                description: Email addresses for notifications
                items:
                  type:
                    - string
                    - 'null'
                  format: email
              expected_delivery:
                type:
                  - string
                  - 'null'
                format: date
                description: Expected delivery date
              first_attempted_at:
                type:
                  - string
                  - 'null'
                format: date-time
                description: Timestamp of first delivery attempt
              first_estimated_delivery:
                type: object
                description: Estimated delivery information
                properties:
                  source:
                    type:
                      - string
                      - 'null'
                    description: Source of the estimate
                    example: Carrier EDD
                  datetime:
                    type:
                      - string
                      - 'null'
                    format: date
                    description: Estimated delivery date
                  type:
                    type:
                      - string
                      - 'null'
                    description: Type of estimate
                    enum:
                      - specific
                      - range
                  datetime_min:
                    type:
                      - string
                      - 'null'
                    format: date
                    description: Minimum estimated delivery datetime
                  datetime_max:
                    type:
                      - string
                      - 'null'
                    format: date
                    description: Maximum estimated delivery datetime
              id:
                type:
                  - string
                  - 'null'
                description: Unique tracking record identifier
              ios:
                type: array
                description: iOS push notification identifiers
                items:
                  type:
                    - string
                    - 'null'
              language:
                type:
                  - string
                  - 'null'
                description: Language code for notifications
                example: en
              last_mile_tracking_supported:
                type: boolean
                description: Whether last-mile tracking is supported
              last_updated_at:
                type:
                  - string
                  - 'null'
                format: date-time
                description: When this tracking record was last updated
              latest_estimated_delivery:
                type: object
                description: Estimated delivery information
                properties:
                  source:
                    type:
                      - string
                      - 'null'
                    description: Source of the estimate
                    example: Carrier EDD
                  datetime:
                    type:
                      - string
                      - 'null'
                    format: date
                    description: Estimated delivery date
                  type:
                    type:
                      - string
                      - 'null'
                    description: Type of estimate
                    enum:
                      - specific
                      - range
                  datetime_min:
                    type:
                      - string
                      - 'null'
                    format: date
                    description: Minimum estimated delivery datetime
                  datetime_max:
                    type:
                      - string
                      - 'null'
                    format: date
                    description: Maximum estimated delivery datetime
              next_couriers:
                type: array
                description: Next carriers in multi-carrier shipments
                items:
                  type: object
              note:
                type:
                  - string
                  - 'null'
                description: Additional notes about the shipment
              on_time_difference:
                type: integer
                description: Number of days difference from expected delivery
              on_time_status:
                type:
                  - string
                  - 'null'
                description: On-time delivery status
                enum:
                  - early
                  - on_time
                  - late
              order_date:
                type:
                  - string
                  - 'null'
                format: date-time
                description: Date the order was placed
              order_id:
                type:
                  - string
                  - 'null'
                description: Order identifier
              order_id_path:
                type:
                  - string
                  - 'null'
                description: Order ID path for hierarchical orders
              order_number:
                type:
                  - string
                  - 'null'
                description: Customer-facing order number
              order_promised_delivery_date:
                type:
                  - string
                  - 'null'
                format: date
                description: Promised delivery date from order
              order_tags:
                type: array
                description: Tags associated with the order
                items:
                  type:
                    - string
                    - 'null'
              origin_city:
                type:
                  - string
                  - 'null'
                description: Origin city name
              origin_country_iso3:
                type:
                  - string
                  - 'null'
                description: Origin country ISO3 code
              origin_postal_code:
                type:
                  - string
                  - 'null'
                description: Origin postal/ZIP code
              origin_raw_location:
                type:
                  - string
                  - 'null'
                description: Full origin address
              origin_state:
                type:
                  - string
                  - 'null'
                description: Origin state/province
              path:
                type:
                  - string
                  - 'null'
                deprecated: true
                description: Deprecated field
              pickup_location:
                type:
                  - string
                  - 'null'
                description: Pickup location details
              pickup_note:
                type:
                  - string
                  - 'null'
                description: Notes about pickup
              return_to_sender:
                type: boolean
                description: Whether package is being returned to sender
              shipment_delivery_date:
                type:
                  - string
                  - 'null'
                format: date-time
                description: Actual delivery timestamp
              shipment_package_count:
                type: integer
                description: Number of packages in shipment
              shipment_pickup_date:
                type:
                  - string
                  - 'null'
                format: date-time
                description: When shipment was picked up
              shipment_tags:
                type: array
                description: Tags associated with the shipment
                items:
                  type:
                    - string
                    - 'null'
              shipment_type:
                type:
                  - string
                  - 'null'
                description: Type of shipment service
                example: UPS Ground
              shipment_weight:
                type: number
                description: Total shipment weight
                example: 34.6
              shipment_weight_unit:
                type:
                  - string
                  - 'null'
                description: Unit of weight measurement
                enum:
                  - lb
                  - kg
              signed_by:
                type:
                  - string
                  - 'null'
                description: Name of person who signed for delivery
              slug:
                type:
                  - string
                  - 'null'
                description: Carrier slug identifier
                example: ups
              smses:
                type: array
                description: SMS phone numbers for notifications
                items:
                  type:
                    - string
                    - 'null'
              source:
                type:
                  - string
                  - 'null'
                description: Source of the tracking data
                example: api
              subscribed_smses:
                type: array
                description: Subscribed SMS phone numbers
                items:
                  type:
                    - string
                    - 'null'
              subscribed_emails:
                type: array
                description: Subscribed email addresses
                items:
                  type:
                    - string
                    - 'null'
                  format: email
              subtag:
                type:
                  - string
                  - 'null'
                description: Detailed status subtag
                example: Delivered_001
              subtag_message:
                type:
                  - string
                  - 'null'
                description: Human-readable subtag message
                example: Delivered
              tag:
                type:
                  - string
                  - 'null'
                description: Primary tracking status tag
                enum:
                  - Pending
                  - InfoReceived
                  - InTransit
                  - OutForDelivery
                  - AttemptFail
                  - Delivered
                  - AvailableForPickup
                  - Exception
                  - Expired
                example: Delivered
              title:
                type:
                  - string
                  - 'null'
                description: Tracking record title
              tracked_count:
                type: integer
                description: Number of times this tracking has been checked
              tracking_account_number:
                type:
                  - string
                  - 'null'
                description: Carrier account number
              tracking_destination_country:
                type:
                  - string
                  - 'null'
                description: Tracking destination country code
              tracking_key:
                type:
                  - string
                  - 'null'
                description: Tracking key identifier
              tracking_number:
                type:
                  - string
                  - 'null'
                description: Carrier tracking number
                example: 1Z59E877A871526000
              tracking_origin_country:
                type:
                  - string
                  - 'null'
                description: Tracking origin country code
              tracking_postal_code:
                type:
                  - string
                  - 'null'
                description: Tracking destination postal code
              tracking_ship_date:
                type:
                  - string
                  - 'null'
                description: Ship date in YYYYMMDD format
                example: '20230720'
              tracking_state:
                type:
                  - string
                  - 'null'
                description: Tracking destination state
              unique_token:
                type:
                  - string
                  - 'null'
                deprecated: true
                description: Deprecated unique token
              updated_at:
                type:
                  - string
                  - 'null'
                format: date-time
                description: When this tracking record was last updated
          ts:
            type: integer
            description: Unix timestamp when the event was generated
            example: 1690038623
      examples:
        - name: DeliveredEvent
          summary: Package delivered successfully
          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'
  schemas:
    TrackingUpdatePayload:
      type: object
      description: Root payload for tracking update webhook events
      required:
        - event
        - event_id
        - is_tracking_first_tag
        - msg
        - ts
      properties:
        event:
          type:
            - string
            - 'null'
          description: Event type identifier
          enum:
            - tracking_update
          example: tracking_update
        event_id:
          type:
            - string
            - 'null'
          format: uuid
          description: Unique identifier for this webhook event
          example: 555e9daa-f6ca-48a2-b30c-48e23cd0d0d6
        is_tracking_first_tag:
          type: boolean
          description: Indicates if this is the first tracking event for this shipment
          example: true
        msg:
          type: object
          description: Detailed tracking information for the shipment
          required:
            - tag
            - tracking_number
            - slug
          properties:
            active:
              type: boolean
              description: Whether tracking is currently active for this shipment
            aftership_estimated_delivery_date:
              type: object
              description: AfterShip estimated delivery date information
              properties:
                estimated_delivery_date:
                  type:
                    - string
                    - 'null'
                  format: date
                  description: Primary estimated delivery date
                confidence_score:
                  type: number
                  description: Confidence score for the estimate
                estimated_delivery_date_min:
                  type:
                    - string
                    - 'null'
                  format: date
                  description: Minimum estimated delivery date
                estimated_delivery_date_max:
                  type:
                    - string
                    - 'null'
                  format: date
                  description: Maximum estimated delivery date
            android:
              type: array
              description: Android push notification identifiers
              items:
                type:
                  - string
                  - 'null'
            checkpoints:
              type: array
              description: Array of tracking checkpoint events
              items:
                type: object
                description: Individual tracking checkpoint event from carrier
                properties:
                  checkpoint_time:
                    type:
                      - string
                      - 'null'
                    format: date-time
                    description: Timestamp of the checkpoint event
                    example: '2026-07-22T11:08:44-04:00'
                  city:
                    type:
                      - string
                      - 'null'
                    description: City where checkpoint occurred
                  coordinates:
                    type: array
                    description: Geographic coordinates of checkpoint
                    items:
                      type: number
                  country_iso3:
                    type:
                      - string
                      - 'null'
                    description: Country ISO3 code
                    example: USA
                  country_name:
                    type:
                      - string
                      - 'null'
                    description: Country name
                    example: United States
                  created_at:
                    type:
                      - string
                      - 'null'
                    format: date-time
                    description: When this checkpoint was created in the system
                  location:
                    type:
                      - string
                      - 'null'
                    description: Full location string
                    example: BELLEAIR, FL, 33756, US, United States
                  message:
                    type:
                      - string
                      - 'null'
                    description: Carrier-provided checkpoint message
                    example: Delivered
                  raw_tag:
                    type:
                      - string
                      - 'null'
                    description: Raw carrier status code
                    example: KB
                  slug:
                    type:
                      - string
                      - 'null'
                    description: Carrier slug identifier
                    example: ups
                  state:
                    type:
                      - string
                      - 'null'
                    description: State/province code
                  subtag:
                    type:
                      - string
                      - 'null'
                    description: Normalized subtag
                    example: Delivered_001
                  subtag_message:
                    type:
                      - string
                      - 'null'
                    description: Human-readable subtag message
                    example: Delivered
                  tag:
                    type:
                      - string
                      - 'null'
                    description: Normalized tracking status tag
                    enum:
                      - Pending
                      - InfoReceived
                      - InTransit
                      - OutForDelivery
                      - AttemptFail
                      - Delivered
                      - AvailableForPickup
                      - Exception
                      - Expired
                    example: Delivered
                  zip:
                    type:
                      - string
                      - 'null'
                    description: ZIP/postal code
            courier_connection_id:
              type:
                - string
                - 'null'
              description: Connection identifier for the courier
            courier_destination_country_iso3:
              type:
                - string
                - 'null'
              description: Destination country ISO3 code
              example: USA
            courier_redirect_link:
              type:
                - string
                - 'null'
              format: uri
              description: URL to redirect to carrier tracking page
            courier_tracking_link:
              type:
                - string
                - 'null'
              format: uri
              description: Direct link to carrier tracking information
            created_at:
              type:
                - string
                - 'null'
              format: date-time
              description: When this tracking record was created
            custom_estimated_delivery_date:
              type:
                - string
                - 'null'
              format: date
              description: Customer-specified estimated delivery date
            custom_fields:
              type: object
              description: Custom metadata fields specific to the shipment
              additionalProperties: true
              properties:
                contents:
                  type:
                    - string
                    - 'null'
                  description: Detailed contents of the shipment
                contents_collateral_units:
                  type:
                    - string
                    - 'null'
                  description: Number of collateral units
                contents_merch_units:
                  type:
                    - string
                    - 'null'
                  description: Number of merchandise units
                contents_product_units:
                  type:
                    - string
                    - 'null'
                  description: Number of product units
                date_dc:
                  type:
                    - string
                    - 'null'
                  description: Distribution center date
                date_input:
                  type:
                    - string
                    - 'null'
                  format: date
                  description: Input date
                date_packed:
                  type:
                    - string
                    - 'null'
                  format: date-time
                  description: When the shipment was packed
                dc_cid:
                  type:
                    - string
                    - 'null'
                  description: Distribution center container ID
                dc_oid:
                  type:
                    - string
                    - 'null'
                  description: Distribution center order ID
                dc_pool:
                  type:
                    - string
                    - 'null'
                  description: Distribution center pool designation
                dc_ship_confirm:
                  type:
                    - string
                    - 'null'
                  format: date-time
                  description: Distribution center ship confirmation timestamp
                dc_ver:
                  type:
                    - string
                    - 'null'
                  description: Distribution center API version
                final_mile:
                  type:
                    - string
                    - 'null'
                  description: Final mile carrier
                oms_contents:
                  type:
                    - string
                    - 'null'
                  description: Order management system contents
                regulatory_attributes:
                  type:
                    - string
                    - 'null'
                  description: Regulatory compliance attributes
                rsd:
                  type:
                    - string
                    - 'null'
                  format: date
                  description: Requested ship date
                seller_name:
                  type:
                    - string
                    - 'null'
                  description: Name of the seller/winery
                seller_number:
                  type:
                    - string
                    - 'null'
                  description: Seller account number
                shipfrom_dc:
                  type:
                    - string
                    - 'null'
                  description: Shipping distribution center code
                special_attributes:
                  type:
                    - string
                    - 'null'
                  description: Special handling attributes
                special_instructions:
                  type:
                    - string
                    - 'null'
                  description: Special delivery instructions
                transmission_id:
                  type:
                    - string
                    - 'null'
                  description: Transmission identifier
                transport_zone:
                  type:
                    - string
                    - 'null'
                  description: Transport zone
                tref:
                  type:
                    - string
                    - 'null'
                  format: uuid
                  description: Transaction reference
            customer_name:
              type:
                - string
                - 'null'
              description: Recipient customer name
            delivery_time:
              type: integer
              description: Delivery time in days
            delivery_type:
              type:
                - string
                - 'null'
              description: Type of delivery service
            destination_city:
              type:
                - string
                - 'null'
              description: Destination city name
            destination_country_iso3:
              type:
                - string
                - 'null'
              description: Destination country ISO3 code
            destination_postal_code:
              type:
                - string
                - 'null'
              description: Destination postal/ZIP code
            destination_raw_location:
              type:
                - string
                - 'null'
              description: Full destination address
            destination_state:
              type:
                - string
                - 'null'
              description: Destination state/province code
            emails:
              type: array
              description: Email addresses for notifications
              items:
                type:
                  - string
                  - 'null'
                format: email
            expected_delivery:
              type:
                - string
                - 'null'
              format: date
              description: Expected delivery date
            first_attempted_at:
              type:
                - string
                - 'null'
              format: date-time
              description: Timestamp of first delivery attempt
            first_estimated_delivery:
              type: object
              description: Estimated delivery information
              properties:
                source:
                  type:
                    - string
                    - 'null'
                  description: Source of the estimate
                  example: Carrier EDD
                datetime:
                  type:
                    - string
                    - 'null'
                  format: date
                  description: Estimated delivery date
                type:
                  type:
                    - string
                    - 'null'
                  description: Type of estimate
                  enum:
                    - specific
                    - range
                datetime_min:
                  type:
                    - string
                    - 'null'
                  format: date
                  description: Minimum estimated delivery datetime
                datetime_max:
                  type:
                    - string
                    - 'null'
                  format: date
                  description: Maximum estimated delivery datetime
            id:
              type:
                - string
                - 'null'
              description: Unique tracking record identifier
            ios:
              type: array
              description: iOS push notification identifiers
              items:
                type:
                  - string
                  - 'null'
            language:
              type:
                - string
                - 'null'
              description: Language code for notifications
              example: en
            last_mile_tracking_supported:
              type: boolean
              description: Whether last-mile tracking is supported
            last_updated_at:
              type:
                - string
                - 'null'
              format: date-time
              description: When this tracking record was last updated
            latest_estimated_delivery:
              type: object
              description: Estimated delivery information
              properties:
                source:
                  type:
                    - string
                    - 'null'
                  description: Source of the estimate
                  example: Carrier EDD
                datetime:
                  type:
                    - string
                    - 'null'
                  format: date
                  description: Estimated delivery date
                type:
                  type:
                    - string
                    - 'null'
                  description: Type of estimate
                  enum:
                    - specific
                    - range
                datetime_min:
                  type:
                    - string
                    - 'null'
                  format: date
                  description: Minimum estimated delivery datetime
                datetime_max:
                  type:
                    - string
                    - 'null'
                  format: date
                  description: Maximum estimated delivery datetime
            next_couriers:
              type: array
              description: Next carriers in multi-carrier shipments
              items:
                type: object
            note:
              type:
                - string
                - 'null'
              description: Additional notes about the shipment
            on_time_difference:
              type: integer
              description: Number of days difference from expected delivery
            on_time_status:
              type:
                - string
                - 'null'
              description: On-time delivery status
              enum:
                - early
                - on_time
                - late
            order_date:
              type:
                - string
                - 'null'
              format: date-time
              description: Date the order was placed
            order_id:
              type:
                - string
                - 'null'
              description: Order identifier
            order_id_path:
              type:
                - string
                - 'null'
              description: Order ID path for hierarchical orders
            order_number:
              type:
                - string
                - 'null'
              description: Customer-facing order number
            order_promised_delivery_date:
              type:
                - string
                - 'null'
              format: date
              description: Promised delivery date from order
            order_tags:
              type: array
              description: Tags associated with the order
              items:
                type:
                  - string
                  - 'null'
            origin_city:
              type:
                - string
                - 'null'
              description: Origin city name
            origin_country_iso3:
              type:
                - string
                - 'null'
              description: Origin country ISO3 code
            origin_postal_code:
              type:
                - string
                - 'null'
              description: Origin postal/ZIP code
            origin_raw_location:
              type:
                - string
                - 'null'
              description: Full origin address
            origin_state:
              type:
                - string
                - 'null'
              description: Origin state/province
            path:
              type:
                - string
                - 'null'
              deprecated: true
              description: Deprecated field
            pickup_location:
              type:
                - string
                - 'null'
              description: Pickup location details
            pickup_note:
              type:
                - string
                - 'null'
              description: Notes about pickup
            return_to_sender:
              type: boolean
              description: Whether package is being returned to sender
            shipment_delivery_date:
              type:
                - string
                - 'null'
              format: date-time
              description: Actual delivery timestamp
            shipment_package_count:
              type: integer
              description: Number of packages in shipment
            shipment_pickup_date:
              type:
                - string
                - 'null'
              format: date-time
              description: When shipment was picked up
            shipment_tags:
              type: array
              description: Tags associated with the shipment
              items:
                type:
                  - string
                  - 'null'
            shipment_type:
              type:
                - string
                - 'null'
              description: Type of shipment service
              example: UPS Ground
            shipment_weight:
              type: number
              description: Total shipment weight
              example: 34.6
            shipment_weight_unit:
              type:
                - string
                - 'null'
              description: Unit of weight measurement
              enum:
                - lb
                - kg
            signed_by:
              type:
                - string
                - 'null'
              description: Name of person who signed for delivery
            slug:
              type:
                - string
                - 'null'
              description: Carrier slug identifier
              example: ups
            smses:
              type: array
              description: SMS phone numbers for notifications
              items:
                type:
                  - string
                  - 'null'
            source:
              type:
                - string
                - 'null'
              description: Source of the tracking data
              example: api
            subscribed_smses:
              type: array
              description: Subscribed SMS phone numbers
              items:
                type:
                  - string
                  - 'null'
            subscribed_emails:
              type: array
              description: Subscribed email addresses
              items:
                type:
                  - string
                  - 'null'
                format: email
            subtag:
              type:
                - string
                - 'null'
              description: Detailed status subtag
              example: Delivered_001
            subtag_message:
              type:
                - string
                - 'null'
              description: Human-readable subtag message
              example: Delivered
            tag:
              type:
                - string
                - 'null'
              description: Primary tracking status tag
              enum:
                - Pending
                - InfoReceived
                - InTransit
                - OutForDelivery
                - AttemptFail
                - Delivered
                - AvailableForPickup
                - Exception
                - Expired
              example: Delivered
            title:
              type:
                - string
                - 'null'
              description: Tracking record title
            tracked_count:
              type: integer
              description: Number of times this tracking has been checked
            tracking_account_number:
              type:
                - string
                - 'null'
              description: Carrier account number
            tracking_destination_country:
              type:
                - string
                - 'null'
              description: Tracking destination country code
            tracking_key:
              type:
                - string
                - 'null'
              description: Tracking key identifier
            tracking_number:
              type:
                - string
                - 'null'
              description: Carrier tracking number
              example: 1Z59E877A871526000
            tracking_origin_country:
              type:
                - string
                - 'null'
              description: Tracking origin country code
            tracking_postal_code:
              type:
                - string
                - 'null'
              description: Tracking destination postal code
            tracking_ship_date:
              type:
                - string
                - 'null'
              description: Ship date in YYYYMMDD format
              example: '20230720'
            tracking_state:
              type:
                - string
                - 'null'
              description: Tracking destination state
            unique_token:
              type:
                - string
                - 'null'
              deprecated: true
              description: Deprecated unique token
            updated_at:
              type:
                - string
                - 'null'
              format: date-time
              description: When this tracking record was last updated
        ts:
          type: integer
          description: Unix timestamp when the event was generated
          example: 1690038623
    TrackingMessage:
      type: object
      description: Detailed tracking information for the shipment
      required:
        - tag
        - tracking_number
        - slug
      properties:
        active:
          type: boolean
          description: Whether tracking is currently active for this shipment
        aftership_estimated_delivery_date:
          type: object
          description: AfterShip estimated delivery date information
          properties:
            estimated_delivery_date:
              type:
                - string
                - 'null'
              format: date
              description: Primary estimated delivery date
            confidence_score:
              type: number
              description: Confidence score for the estimate
            estimated_delivery_date_min:
              type:
                - string
                - 'null'
              format: date
              description: Minimum estimated delivery date
            estimated_delivery_date_max:
              type:
                - string
                - 'null'
              format: date
              description: Maximum estimated delivery date
        android:
          type: array
          description: Android push notification identifiers
          items:
            type:
              - string
              - 'null'
        checkpoints:
          type: array
          description: Array of tracking checkpoint events
          items:
            type: object
            description: Individual tracking checkpoint event from carrier
            properties:
              checkpoint_time:
                type:
                  - string
                  - 'null'
                format: date-time
                description: Timestamp of the checkpoint event
                example: '2026-07-22T11:08:44-04:00'
              city:
                type:
                  - string
                  - 'null'
                description: City where checkpoint occurred
              coordinates:
                type: array
                description: Geographic coordinates of checkpoint
                items:
                  type: number
              country_iso3:
                type:
                  - string
                  - 'null'
                description: Country ISO3 code
                example: USA
              country_name:
                type:
                  - string
                  - 'null'
                description: Country name
                example: United States
              created_at:
                type:
                  - string
                  - 'null'
                format: date-time
                description: When this checkpoint was created in the system
              location:
                type:
                  - string
                  - 'null'
                description: Full location string
                example: BELLEAIR, FL, 33756, US, United States
              message:
                type:
                  - string
                  - 'null'
                description: Carrier-provided checkpoint message
                example: Delivered
              raw_tag:
                type:
                  - string
                  - 'null'
                description: Raw carrier status code
                example: KB
              slug:
                type:
                  - string
                  - 'null'
                description: Carrier slug identifier
                example: ups
              state:
                type:
                  - string
                  - 'null'
                description: State/province code
              subtag:
                type:
                  - string
                  - 'null'
                description: Normalized subtag
                example: Delivered_001
              subtag_message:
                type:
                  - string
                  - 'null'
                description: Human-readable subtag message
                example: Delivered
              tag:
                type:
                  - string
                  - 'null'
                description: Normalized tracking status tag
                enum:
                  - Pending
                  - InfoReceived
                  - InTransit
                  - OutForDelivery
                  - AttemptFail
                  - Delivered
                  - AvailableForPickup
                  - Exception
                  - Expired
                example: Delivered
              zip:
                type:
                  - string
                  - 'null'
                description: ZIP/postal code
        courier_connection_id:
          type:
            - string
            - 'null'
          description: Connection identifier for the courier
        courier_destination_country_iso3:
          type:
            - string
            - 'null'
          description: Destination country ISO3 code
          example: USA
        courier_redirect_link:
          type:
            - string
            - 'null'
          format: uri
          description: URL to redirect to carrier tracking page
        courier_tracking_link:
          type:
            - string
            - 'null'
          format: uri
          description: Direct link to carrier tracking information
        created_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When this tracking record was created
        custom_estimated_delivery_date:
          type:
            - string
            - 'null'
          format: date
          description: Customer-specified estimated delivery date
        custom_fields:
          type: object
          description: Custom metadata fields specific to the shipment
          additionalProperties: true
          properties:
            contents:
              type:
                - string
                - 'null'
              description: Detailed contents of the shipment
            contents_collateral_units:
              type:
                - string
                - 'null'
              description: Number of collateral units
            contents_merch_units:
              type:
                - string
                - 'null'
              description: Number of merchandise units
            contents_product_units:
              type:
                - string
                - 'null'
              description: Number of product units
            date_dc:
              type:
                - string
                - 'null'
              description: Distribution center date
            date_input:
              type:
                - string
                - 'null'
              format: date
              description: Input date
            date_packed:
              type:
                - string
                - 'null'
              format: date-time
              description: When the shipment was packed
            dc_cid:
              type:
                - string
                - 'null'
              description: Distribution center container ID
            dc_oid:
              type:
                - string
                - 'null'
              description: Distribution center order ID
            dc_pool:
              type:
                - string
                - 'null'
              description: Distribution center pool designation
            dc_ship_confirm:
              type:
                - string
                - 'null'
              format: date-time
              description: Distribution center ship confirmation timestamp
            dc_ver:
              type:
                - string
                - 'null'
              description: Distribution center API version
            final_mile:
              type:
                - string
                - 'null'
              description: Final mile carrier
            oms_contents:
              type:
                - string
                - 'null'
              description: Order management system contents
            regulatory_attributes:
              type:
                - string
                - 'null'
              description: Regulatory compliance attributes
            rsd:
              type:
                - string
                - 'null'
              format: date
              description: Requested ship date
            seller_name:
              type:
                - string
                - 'null'
              description: Name of the seller/winery
            seller_number:
              type:
                - string
                - 'null'
              description: Seller account number
            shipfrom_dc:
              type:
                - string
                - 'null'
              description: Shipping distribution center code
            special_attributes:
              type:
                - string
                - 'null'
              description: Special handling attributes
            special_instructions:
              type:
                - string
                - 'null'
              description: Special delivery instructions
            transmission_id:
              type:
                - string
                - 'null'
              description: Transmission identifier
            transport_zone:
              type:
                - string
                - 'null'
              description: Transport zone
            tref:
              type:
                - string
                - 'null'
              format: uuid
              description: Transaction reference
        customer_name:
          type:
            - string
            - 'null'
          description: Recipient customer name
        delivery_time:
          type: integer
          description: Delivery time in days
        delivery_type:
          type:
            - string
            - 'null'
          description: Type of delivery service
        destination_city:
          type:
            - string
            - 'null'
          description: Destination city name
        destination_country_iso3:
          type:
            - string
            - 'null'
          description: Destination country ISO3 code
        destination_postal_code:
          type:
            - string
            - 'null'
          description: Destination postal/ZIP code
        destination_raw_location:
          type:
            - string
            - 'null'
          description: Full destination address
        destination_state:
          type:
            - string
            - 'null'
          description: Destination state/province code
        emails:
          type: array
          description: Email addresses for notifications
          items:
            type:
              - string
              - 'null'
            format: email
        expected_delivery:
          type:
            - string
            - 'null'
          format: date
          description: Expected delivery date
        first_attempted_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Timestamp of first delivery attempt
        first_estimated_delivery:
          type: object
          description: Estimated delivery information
          properties:
            source:
              type:
                - string
                - 'null'
              description: Source of the estimate
              example: Carrier EDD
            datetime:
              type:
                - string
                - 'null'
              format: date
              description: Estimated delivery date
            type:
              type:
                - string
                - 'null'
              description: Type of estimate
              enum:
                - specific
                - range
            datetime_min:
              type:
                - string
                - 'null'
              format: date
              description: Minimum estimated delivery datetime
            datetime_max:
              type:
                - string
                - 'null'
              format: date
              description: Maximum estimated delivery datetime
        id:
          type:
            - string
            - 'null'
          description: Unique tracking record identifier
        ios:
          type: array
          description: iOS push notification identifiers
          items:
            type:
              - string
              - 'null'
        language:
          type:
            - string
            - 'null'
          description: Language code for notifications
          example: en
        last_mile_tracking_supported:
          type: boolean
          description: Whether last-mile tracking is supported
        last_updated_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When this tracking record was last updated
        latest_estimated_delivery:
          type: object
          description: Estimated delivery information
          properties:
            source:
              type:
                - string
                - 'null'
              description: Source of the estimate
              example: Carrier EDD
            datetime:
              type:
                - string
                - 'null'
              format: date
              description: Estimated delivery date
            type:
              type:
                - string
                - 'null'
              description: Type of estimate
              enum:
                - specific
                - range
            datetime_min:
              type:
                - string
                - 'null'
              format: date
              description: Minimum estimated delivery datetime
            datetime_max:
              type:
                - string
                - 'null'
              format: date
              description: Maximum estimated delivery datetime
        next_couriers:
          type: array
          description: Next carriers in multi-carrier shipments
          items:
            type: object
        note:
          type:
            - string
            - 'null'
          description: Additional notes about the shipment
        on_time_difference:
          type: integer
          description: Number of days difference from expected delivery
        on_time_status:
          type:
            - string
            - 'null'
          description: On-time delivery status
          enum:
            - early
            - on_time
            - late
        order_date:
          type:
            - string
            - 'null'
          format: date-time
          description: Date the order was placed
        order_id:
          type:
            - string
            - 'null'
          description: Order identifier
        order_id_path:
          type:
            - string
            - 'null'
          description: Order ID path for hierarchical orders
        order_number:
          type:
            - string
            - 'null'
          description: Customer-facing order number
        order_promised_delivery_date:
          type:
            - string
            - 'null'
          format: date
          description: Promised delivery date from order
        order_tags:
          type: array
          description: Tags associated with the order
          items:
            type:
              - string
              - 'null'
        origin_city:
          type:
            - string
            - 'null'
          description: Origin city name
        origin_country_iso3:
          type:
            - string
            - 'null'
          description: Origin country ISO3 code
        origin_postal_code:
          type:
            - string
            - 'null'
          description: Origin postal/ZIP code
        origin_raw_location:
          type:
            - string
            - 'null'
          description: Full origin address
        origin_state:
          type:
            - string
            - 'null'
          description: Origin state/province
        path:
          type:
            - string
            - 'null'
          deprecated: true
          description: Deprecated field
        pickup_location:
          type:
            - string
            - 'null'
          description: Pickup location details
        pickup_note:
          type:
            - string
            - 'null'
          description: Notes about pickup
        return_to_sender:
          type: boolean
          description: Whether package is being returned to sender
        shipment_delivery_date:
          type:
            - string
            - 'null'
          format: date-time
          description: Actual delivery timestamp
        shipment_package_count:
          type: integer
          description: Number of packages in shipment
        shipment_pickup_date:
          type:
            - string
            - 'null'
          format: date-time
          description: When shipment was picked up
        shipment_tags:
          type: array
          description: Tags associated with the shipment
          items:
            type:
              - string
              - 'null'
        shipment_type:
          type:
            - string
            - 'null'
          description: Type of shipment service
          example: UPS Ground
        shipment_weight:
          type: number
          description: Total shipment weight
          example: 34.6
        shipment_weight_unit:
          type:
            - string
            - 'null'
          description: Unit of weight measurement
          enum:
            - lb
            - kg
        signed_by:
          type:
            - string
            - 'null'
          description: Name of person who signed for delivery
        slug:
          type:
            - string
            - 'null'
          description: Carrier slug identifier
          example: ups
        smses:
          type: array
          description: SMS phone numbers for notifications
          items:
            type:
              - string
              - 'null'
        source:
          type:
            - string
            - 'null'
          description: Source of the tracking data
          example: api
        subscribed_smses:
          type: array
          description: Subscribed SMS phone numbers
          items:
            type:
              - string
              - 'null'
        subscribed_emails:
          type: array
          description: Subscribed email addresses
          items:
            type:
              - string
              - 'null'
            format: email
        subtag:
          type:
            - string
            - 'null'
          description: Detailed status subtag
          example: Delivered_001
        subtag_message:
          type:
            - string
            - 'null'
          description: Human-readable subtag message
          example: Delivered
        tag:
          type:
            - string
            - 'null'
          description: Primary tracking status tag
          enum:
            - Pending
            - InfoReceived
            - InTransit
            - OutForDelivery
            - AttemptFail
            - Delivered
            - AvailableForPickup
            - Exception
            - Expired
          example: Delivered
        title:
          type:
            - string
            - 'null'
          description: Tracking record title
        tracked_count:
          type: integer
          description: Number of times this tracking has been checked
        tracking_account_number:
          type:
            - string
            - 'null'
          description: Carrier account number
        tracking_destination_country:
          type:
            - string
            - 'null'
          description: Tracking destination country code
        tracking_key:
          type:
            - string
            - 'null'
          description: Tracking key identifier
        tracking_number:
          type:
            - string
            - 'null'
          description: Carrier tracking number
          example: 1Z59E877A871526000
        tracking_origin_country:
          type:
            - string
            - 'null'
          description: Tracking origin country code
        tracking_postal_code:
          type:
            - string
            - 'null'
          description: Tracking destination postal code
        tracking_ship_date:
          type:
            - string
            - 'null'
          description: Ship date in YYYYMMDD format
          example: '20230720'
        tracking_state:
          type:
            - string
            - 'null'
          description: Tracking destination state
        unique_token:
          type:
            - string
            - 'null'
          deprecated: true
          description: Deprecated unique token
        updated_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When this tracking record was last updated
    Checkpoint:
      type: object
      description: Individual tracking checkpoint event from carrier
      properties:
        checkpoint_time:
          type:
            - string
            - 'null'
          format: date-time
          description: Timestamp of the checkpoint event
          example: '2026-07-22T11:08:44-04:00'
        city:
          type:
            - string
            - 'null'
          description: City where checkpoint occurred
        coordinates:
          type: array
          description: Geographic coordinates of checkpoint
          items:
            type: number
        country_iso3:
          type:
            - string
            - 'null'
          description: Country ISO3 code
          example: USA
        country_name:
          type:
            - string
            - 'null'
          description: Country name
          example: United States
        created_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When this checkpoint was created in the system
        location:
          type:
            - string
            - 'null'
          description: Full location string
          example: BELLEAIR, FL, 33756, US, United States
        message:
          type:
            - string
            - 'null'
          description: Carrier-provided checkpoint message
          example: Delivered
        raw_tag:
          type:
            - string
            - 'null'
          description: Raw carrier status code
          example: KB
        slug:
          type:
            - string
            - 'null'
          description: Carrier slug identifier
          example: ups
        state:
          type:
            - string
            - 'null'
          description: State/province code
        subtag:
          type:
            - string
            - 'null'
          description: Normalized subtag
          example: Delivered_001
        subtag_message:
          type:
            - string
            - 'null'
          description: Human-readable subtag message
          example: Delivered
        tag:
          type:
            - string
            - 'null'
          description: Normalized tracking status tag
          enum:
            - Pending
            - InfoReceived
            - InTransit
            - OutForDelivery
            - AttemptFail
            - Delivered
            - AvailableForPickup
            - Exception
            - Expired
          example: Delivered
        zip:
          type:
            - string
            - 'null'
          description: ZIP/postal code
    EstimatedDeliveryDate:
      type: object
      description: AfterShip estimated delivery date information
      properties:
        estimated_delivery_date:
          type:
            - string
            - 'null'
          format: date
          description: Primary estimated delivery date
        confidence_score:
          type: number
          description: Confidence score for the estimate
        estimated_delivery_date_min:
          type:
            - string
            - 'null'
          format: date
          description: Minimum estimated delivery date
        estimated_delivery_date_max:
          type:
            - string
            - 'null'
          format: date
          description: Maximum estimated delivery date
    EstimatedDelivery:
      type: object
      description: Estimated delivery information
      properties:
        source:
          type:
            - string
            - 'null'
          description: Source of the estimate
          example: Carrier EDD
        datetime:
          type:
            - string
            - 'null'
          format: date
          description: Estimated delivery date
        type:
          type:
            - string
            - 'null'
          description: Type of estimate
          enum:
            - specific
            - range
        datetime_min:
          type:
            - string
            - 'null'
          format: date
          description: Minimum estimated delivery datetime
        datetime_max:
          type:
            - string
            - 'null'
          format: date
          description: Maximum estimated delivery datetime
  securitySchemes:
    webhookSignature:
      type: httpApiKey
      name: X-Webhook-Signature
      in: header
      description: >-
        Optional webhook signature for verifying request authenticity (contact
        api@wineshipping.com for implementation details)
