draftOrders

Query

Retrieves draft orders data.

Arguments

after String: Returns the elements in the list that come after the specified cursor.
before String: Returns the elements in the list that come before the specified cursor.
first Int: Returns the first n elements from the list.
last Int: Returns the last n elements from the list.
query String: Matches draft orders whose customer email contains the supplied text.
Available filters1
defaultstring
Performs a case-insensitive contains match on the customer email.
Examplesbuyer@example.com@example.com
sortDirection SortDirection: The direction used to order the returned resources.
Possible enum values
ASC
Orders values from lowest to highest or alphabetically from A to Z.
DESC
Orders values from highest to lowest or alphabetically from Z to A.
sortKey DraftOrderSortKeys: The field used to order the returned resources.
Possible enum values
CREATED_AT
Orders drafts by when they were created.
TOTAL
Orders drafts by their total monetary value.
UPDATED_AT
Orders drafts by when they were last updated.