snapcasterDevelopers

    API reference · Types

    OrderDispatchOverdueEvent

    Part of the payload of order.dispatch_overdue.

    Type: object

    Example

    Schema example: from the order.dispatch_overdue payload
    {
  "event_id": "evt_sandbox_01K4B2M7Q9T3V6X8Z1C4E7G0JN",
  "type": "order.dispatch_overdue",
  "created_at": "2026-09-11T05:00:00.000Z",
  "data": {
    "order_id": "ord_sandbox_01K4A8Y6D4QJH2N3P5R7S9T0VW",
    "seller_id": 42,
    "deadline_at": "2026-09-11T03:59:59.999Z",
    "overdue_at": "2026-09-11T05:00:00.000Z",
    "payout_paused": true
  },
  "api_version": "2026-10"
}

    Fields

    event_id string required

    A globally unique event id that stays the same across retries. Use it to deduplicate deliveries (STABLE).

    Example evt_sandbox_01K4B2M7Q9T3V6X8Z1C4E7G0JN

    type string required

    The event type (STABLE).

    Constraints: allowed values: order.dispatch_overdue Example order.dispatch_overdue

    created_at string required

    ISO-8601 UTC instant of the change the event reports; unchanged across retries (STABLE).

    Example 2026-09-11T05:00:00.000Z

    data DispatchOverdueEventData required

    The operation or event payload.

    Show child fieldsHide child fields
    data.order_id string required

    The order that missed its ship-by deadline (STABLE).

    Example ord_sandbox_01K4A8Y6D4QJH2N3P5R7S9T0VW

    data.seller_id integer required

    The seller that owns the order. Use this id to route the event to the right store (STABLE).

    Example 42

    data.deadline_at string required

    The ship-by deadline the order missed, the order read’s dispatch.deadline_at (STABLE).

    Constraints: format: date-time Example 2026-09-11T03:59:59.999Z

    data.overdue_at string required

    When Snapcaster marked the order overdue (STABLE).

    Constraints: format: date-time Example 2026-09-11T05:00:00.000Z

    data.payout_paused boolean required

    True while the seller payout for this order is paused. An overdue dispatch pauses it, and so can a Snapcaster review of the order; shipping does not lift it, only Snapcaster releasing the payout does (STABLE).

    Constraints: allowed values: true Example true

    api_version string required

    The dated API version used for this payload, frozen when Snapcaster queued the delivery. Changing the platform pin does not change queued events or retries; they keep the same version. See https://developers.snapcaster.ca/guide/api-versioning (STABLE).

    Constraints: allowed values: 2026-10 Example 2026-10

    Used by