List all cycles
Returns a list of cycles given parameters. Used by merchants to see cycles due for dispatch, return etc.
For incremental sync, use the updated filter together with the updatedAt field on each cycle so you only fetch or process cycles that changed since your last request.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.
x <= 100Cursor token to fetch next page of results.
Filter cycles by Shopify Order ID
Filter cycles by customer ID
Filter by item ID
Filter by shopify variant ID
Filter by shopify line item ID
Filter by return order status. Can be a comma-separated list of statuses.
"requested,expected,received,in_progress,completed,cancelled"
When true, filter cycles to show only unfulfilled ones
Filter cycles by created at datetime (ISO 8601), using gt, lt, gte, lte operators which may be combined.
Filter cycles by when they were last updated (ISO 8601), using gt, lt, gte, lte; operators may be combined. For incremental sync, use gte (on or after) with the time you last pulled data.
Filter cycles by cycle start date (ISO 8601), using gt, lt, gte, lte operators which may be combined.
Filter cycles by scheduled receive date (ISO 8601), using gt, lt, gte, lte operators which may be combined.
Filter cycles by when they were received back from the customer (ISO 8601), using gt, lt, gte, lte operators which may be combined.
Filter cycles by when they were fulfilled (ISO 8601), using gt, lt, gte, lte operators which may be combined.
Filter cycles by fulfillment status, can be a comma-separated list of statuses. Use "overdue" to find cycles whose fulfill date has passed but have not yet been fulfilled.
due, scheduled, overdue, complete Filter cycles by receival status, can be a comma-separated list of statuses. Use "overdue" to find cycles whose return date has passed but have not yet been received back.
due, scheduled, overdue, complete Filter cycles by titles and customer text
When true, omit cycles that have been cancelled (cancelledAt set). Defaults to false so cancelled cycles are included for incremental sync and external dashboards.
Comma-separated list of relations to include (e.g., item)
"item"
Filter by custom field values, keyed by the definition's key, for definitions with "Filter in the table and the API" turned on.
Each key takes an object of operators, which may be combined: eq, notEq, in, notIn (comma-separated values, or item keys for a Choice list), gt, gte, lt, lte, contains, blank, present, withinDays (a date within the next N days, or the last N when negative) and olderThanMonths (a date more than N months ago).
Numbers, dates and booleans compare by type; money is in cents; Choice list values are item keys.
Example: customFields[battery][in]=full,medium&customFields[serviced_on][olderThanMonths]=6.
A definition that is unknown, archived or not enabled for filtering is refused with a 422.