v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Orders::Invoices::Restock

List Restocks

List Restocks

get/workspaces/{workspace_id}/orders/invoices/restocks

Path parameters

workspace_idinteger required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Response

OK

idinteger

Restock ID

public_idstring nullable

Public Restock ID

workspace_idinteger

Workspace ID

contact_idinteger

Contact ID

status'cancelled' | 'restocked'

Status

created_atstring date-time nullable

Created At Date

updated_atstring date-time nullable

Updated At Date

Example response

[
  {
    "id": 1,
    "public_id": "lDUzwt",
    "workspace_id": 42,
    "contact_id": 6,
    "status": "restocked",
    "created_at": "2024-02-07T13:24:59.204Z",
    "updated_at": "2024-02-07T13:24:59.204Z",
    "included_invoices_line_items": [
      {
        "id": 1,
        "public_id": "BegDsZ",
        "fulfillment_id": 1,
        "quantity": 1,
        "invoices_line_item_id": 2
      }
    ]
  }
]