snapcasterDevelopers

    API reference · Types

    CancellationRequestResponse

    Part of the response of POST /orders/{orderId}/cancellation-requests/{requestId}/decline and POST /sandbox/orders/{orderId}/cancellation-requests.

    Type: object

    Example

    Schema example: from the POST /orders/{orderId}/cancellation-requests/{requestId}/decline response
    {
  "success": true,
  "data": {
    "id": "cnr_8d3f2a61b0c94e7f9a15c2d48e6b7031",
    "order_id": "ord_sandbox_01K4A8Y6D4QJH2N3P5R7S9T0VW",
    "status": "declined",
    "reason": "Ordered the wrong printing",
    "resolution_note": "Already packed and handed to Canada Post",
    "created_at": "2026-09-04T19:01:12.000Z",
    "resolved_at": "2026-09-04T19:20:41.000Z",
    "lines": [
      {
        "line_ref": "oln_1f0c8a4d7e2b45c9a1d6f3b8e07c9241",
        "sku_id": 14602,
        "quantity": 1
      }
    ]
  }
}

    Fields

    success boolean required

    Whether the operation completed as requested.

    Constraints: allowed values: true Example true

    data CancellationRequest required

    The operation or event payload.

    Show child fieldsHide child fields
    data.id string required

    The cancellation request id (cnr_…), stable for the life of the request (STABLE).

    Example cnr_8d3f2a61b0c94e7f9a15c2d48e6b7031

    data.order_id string required

    The order the buyer asked to cancel (STABLE).

    Example ord_sandbox_01K4A8Y6D4QJH2N3P5R7S9T0VW

    data.status string required

    pending until it is answered. honored: a cancellation covered it. declined: the seller refused it, with resolution_note. withdrawn: the buyer took it back (STABLE).

    Constraints: allowed values: pending, honored, declined, withdrawn Example declined

    data.reason string or null required

    The buyer's own words, or null when they gave none (STABLE).

    Example Ordered the wrong printing

    data.resolution_note string or null required

    The decline reason the buyer is shown. Null unless status is declined (STABLE).

    Example Already packed and handed to Canada Post

    data.created_at string required

    When the buyer opened the request (STABLE).

    Constraints: format: date-time Example 2026-09-04T19:01:12.000Z

    data.resolved_at string or null required

    When the request was honored, declined or withdrawn. Null while it is pending (STABLE).

    Constraints: format: date-time Example 2026-09-04T19:20:41.000Z

    data.lines array of object or null required

    The lines the buyer asked to cancel, or null when they asked to cancel the whole order (STABLE).

    Show child fieldsHide child fields
    data.lines[].line_ref string or null required

    The purchase line the buyer asked to cancel, the same line_ref the order carries. Null only on a request recorded before line refs existed.

    Example oln_1f0c8a4d7e2b45c9a1d6f3b8e07c9241

    data.lines[].sku_id integer required

    The SKU now on that line (STABLE).

    Example 14602

    data.lines[].quantity integer

    How many units the buyer asked to cancel. Omitted means the whole line (STABLE).

    Constraints: exclusive minimum: 0 Example 1

    Used by