Retrieve a list of draft orders. The draft orders can be filtered by fields such as id. The draft orders can also be sorted or paginated.
Request Request Example
JavaScript
Shell
Java
Swift
curl--location-g--request GET '{{BASE_URL}}/admin/draft-orders'
Response Response Example
200 - Example 1
Request
Authorization
or
or
or
Query Params
fields
string
fields
optional
Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.
offset
number
offset
optional
The number of items to skip when retrieving a list.
limit
number
limit
optional
Limit the number of items returned in the list.
order
string
order
optional
The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.
id
optional
One of
Filter by a draft order's ID.
status
optional
One of
Filter by a draft order's status.
$and
array [object]
$and
optional
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
Example:
["",""]
$or
array [object]
$or
optional
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
Example:
["",""]
sales_channel_id
array[string]
optional
Filter by the associated sales channels to retrieve its draft orders.
region_id
optional
Filter by region IDs to retrieve their associated draft orders.
One of
The draft order's region id.
q
string
q
optional
Search term to filter the order's searchable properties.
$ne
array[string]
optional
Filter by values not equal to this parameter.
Example:
["",""]
$gt
array[string]
optional
Filter by values greater than this parameter. Useful for numbers and dates only.
Example:
["",""]
$gte
array[string]
optional
Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
Example:
["",""]
$lt
array[string]
optional
Filter by values less than this parameter. Useful for numbers and dates only.
Example:
["",""]
$lte
array[string]
optional
Filter by values less than or equal to this parameter. Useful for numbers and dates only.
Example:
["",""]
$like
array[string]
optional
Apply a like filter. Useful for strings only.
Example:
["",""]
$re
array[string]
optional
Apply a regex filter. Useful for strings only.
Example:
["",""]
$ilike
array[string]
optional
Apply a case-insensitive like filter. Useful for strings only.
Example:
["",""]
$fulltext
array[string]
optional
Filter to apply on full-text properties.
Example:
["",""]
$exists
array[string]
optional
Filter by whether a value for this parameter exists (not null).
Example:
["",""]
$in
array[string]
optional
Filter by values in this array.
Example:
["",""]
$nin
array[string]
optional
Filter by values not in this array.
Example:
["",""]
$overlap
array[string]
optional
Filter arrays that have overlapping values with this parameter.
Example:
["",""]
$contains
array[string]
optional
Filter arrays that contain some of the values of this parameter.
Example:
["",""]
$contained
array[string]
optional
Filter arrays that contain all values of this parameter.
Example:
["",""]
$eq
array[string]
optional
Example:
["",""]
$not
array[string]
optional
Example:
["",""]
customer_id
optional
One of
The draft order's customer id.
Responses
🟢200OK
application/json
OK
Body
The list of draft orders with pagination fields.
limit
number
limit
required
The maximum number of items retrieved.
offset
number
offset
required
The number of items skipped before retrieving the returned items.
count
number
count
required
The total count of items available.
draft_orders
array[object (AdminDraftOrder) {48}]
required
The list of draft orders.
sales_channel
object(AdminSalesChannel)
optional
The sales channel's details.
customer
object(AdminCustomer)
optional
The customer's details.
shipping_address
object(AdminOrderAddress)
optional
An order address.
billing_address
object(AdminOrderAddress)
optional
An order address.
summary
object(BaseOrderSummary)
required
The order's summary details.
region
object(AdminRegion)
optional
The region's details.
payment_collections
array[object (AdminPaymentCollection) {14}]
required
The draft order's payment collections.
fulfillments
array[object (AdminOrderFulfillment) {13}]
optional
The draft order's fulfillments.
items
array[object (AdminOrderLineItem) {44}]
required
The draft order's items.
shipping_methods
array[object (AdminOrderShippingMethod) {22}]
required
The draft order's shipping methods.
status
string
status
required
The draft order's status.
currency_code
string
currency_code
required
The draft order's currency code.
Example:
usd
id
string
id
required
The draft order's ID.
version
number
version
required
The draft order's version.
region_id
string
region_id
required
The ID of the region associated with the draft order.
customer_id
string
customer_id
required
The ID of the customer that the draft order belongs to.
sales_channel_id
string
sales_channel_id
required
The ID of the sales channel that the draft order is placed in.
email
string<email>
email
required
The customer email associated with the draft order.
display_id
number
display_id
optional
The draft order's display ID.
transactions
array[object (BaseOrderTransaction) {9}]
optional
The draft order's transactions.
metadata
object
optional
The draft order's metadata, can hold custom key-value pairs.
created_at
string<date-time>
created_at
required
The date the draft order was created.
updated_at
string<date-time>
updated_at
required
The date the draft order was updated.
original_item_total
number
original_item_total
required
The total of the draft order's items including taxes, excluding promotions.
original_item_subtotal
number
original_item_subtotal
required
The total of the draft order's items excluding taxes, including promotions.
original_item_tax_total
number
original_item_tax_total
required
The tax total of the draft order's items excluding promotions.
item_total
number
item_total
required
The total of the draft order's items including taxes and promotions.
item_subtotal
number
item_subtotal
required
The total of the draft order's items excluding taxes, including promotions.
item_tax_total
number
item_tax_total
required
The tax total of the draft order's items including promotions.
original_total
number
original_total
required
The draft order's total excluding promotions, including taxes.
original_subtotal
number
original_subtotal
required
The draft order's total excluding taxes, including promotions.
original_tax_total
number
original_tax_total
required
The draft order's tax total, excluding promotions.
total
number
total
required
The draft order's total including taxes and promotions.
subtotal
number
subtotal
required
The draft order's total excluding taxes, including promotions.
tax_total
number
tax_total
required
The draft order's tax total including promotions.
discount_total
number
discount_total
required
The draft order's discount or promotions total.
discount_tax_total
number
discount_tax_total
required
The tax total of draft order's discount or promotion.
gift_card_total
number
gift_card_total
required
The draft order's gift card total.
gift_card_tax_total
number
gift_card_tax_total
required
The tax total of the draft order's gift card.
shipping_total
number
shipping_total
required
The draft order's shipping total including taxes and promotions.
shipping_subtotal
number
shipping_subtotal
required
The draft order's shipping total excluding taxes, including promotions.
shipping_tax_total
number
shipping_tax_total
required
The tax total of the draft order's shipping.
original_shipping_total
number
original_shipping_total
required
The draft order's shipping total including taxes, excluding promotions.
original_shipping_subtotal
number
original_shipping_subtotal
required
The draft order's shipping total excluding taxes, including promotions.
original_shipping_tax_total
number
original_shipping_tax_total
required
The tax total of the draft order's shipping excluding promotions.
