Preorders

List preorders

Returns a cursor-paginated list of the caller-owned, paid preorders, newest first. Filter by status and reservation-fee date.

get/preorders

Query parameters

limitinteger

Page size, 1 to 100.

Example:20

Page size, 1 to 100.

starting_afterstring

Return the page after this resource id (newest first).

Return the page after this resource id (newest first).

status'pending_invitation' | 'awaiting_checkout' | 'idle' | 'converted' | 'canceled'

Filter to a single preorder status.

Filter to a single preorder status.

created[gte]integer nullable

Only preorders paid at or after this epoch ms.

Only preorders paid at or after this epoch ms.

created[lte]integer nullable

Only preorders paid at or before this epoch ms.

Only preorders paid at or before this epoch ms.

expand[]string[]

Repeatable. Expand buyer to include the buyer (with PII).

Repeatable. Expand buyer to include the buyer (with PII).

Response

A page of preorders.

has_moreboolean required

True when another page follows the returned one.

next_cursorstring nullable required

Pass as starting_after to fetch the next page; null when has_more is false.

Example response

{
  "data": [
    {
      "id": "m3Vt8sQjRk2dLw9pXb4C"
    }
  ]
}

Changes