orders

Get a list of filtered orders. This query allows you to retrieve a list of orders based on various filters.

Filters

Filter	Description	Type	Required
brand_ids	Filter orders by brand IDs.	Array of Integers	No
keyword	Search orders by keyword.	String	No
start_date	Filter orders created after this date.	String (YYYY-MM-DD)	No
end_date	Filter orders created before this date.	String (YYYY-MM-DD)	No
status	Filter orders by status.	Array of Strings	No
sales_channel_ids	Filter orders by sales channel IDs.	Array of Integers	No
fulfillable	Filter orders by fulfillability.	Boolean	No
created_by_id	Filter orders by the ID of the user who created them.	Integer	No
responsible_id	Filter orders by the ID of the responsible user.	Integer	No
sort_field	Field to sort the orders by.	String	No
sort_type	Type of sort (ASC or DESC).	String	No

Returns

Returns a list of orders that match the provided filters. Each order includes its associated data.

Errors

• BrandNotSelectedError: Raised when no brand is specified and the current user is not a super admin.
• BadRequest: Raised when the provided filters are not valid.

orders(
  after: String
  before: String
  filters: OrderFilterInput
  first: Int
  last: Int
): OrderConnection

Arguments

orders.after ● String scalar

Returns the elements in the list that come after the specified cursor.

orders.before ● String scalar

Returns the elements in the list that come before the specified cursor.

orders.filters ● OrderFilterInput input

Filtering options for orders.

orders.first ● Int scalar

Returns the first _n_ elements from the list.

orders.last ● Int scalar

Returns the last _n_ elements from the list.

Type

OrderConnection object

The connection type for Order.