snapcasterDevelopers

    API reference · Types

    DispatchOverdueEventData

    Part of the payload of order.dispatch_overdue.

    Type: object

    Example

    Schema example: from the order.dispatch_overdue payload
    {
  "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
}

    Fields

    order_id string required

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

    Example ord_sandbox_01K4A8Y6D4QJH2N3P5R7S9T0VW

    seller_id integer required

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

    Example 42

    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

    overdue_at string required

    When Snapcaster marked the order overdue (STABLE).

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

    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

    Used by