AdminGetDraftOrdersParams
Parameters used to filter and configure the pagination of the retrieved draft orders.
Properties
qstringSearch term to search draft orders by their display IDs and emails.
expandstringComma-separated relations that should be expanded in the returned data.
fieldsstringLimit the number of items returned in the list.
Default: 50
statusDraftOrderStatusValue[]Statuses to filter draft orders by.
created_atDateComparisonOperatorDate filters to apply on the draft orders' created_at date.
created_atDateComparisonOperatorcreated_at date.updated_atDateComparisonOperatorDate filters to apply on the draft orders' updated_at date.
updated_atDateComparisonOperatorupdated_at date.offsetnumberThe number of items to skip when retrieving a list.
Default: 0
limitnumberLimit the number of items returned in the list.
Default: 20
orderstringThe field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with
-.Was this section helpful?