Description

Get all existing orders.

See also: Pagination.

Permission bit: "orders.read"

Topic: Orders

Arguments

cart: Boolean

Include only cart orders or otherwise only full orders

created_at_max: String

Filter output by creation date, upper boundary

Timestamp (RFC 3339)

created_at_min: String

Filter output by creation date, lower boundary

Timestamp (RFC 3339)

customer_id: String

Filter output by customer

last_key: String

Key of the last item from previous page. See also: Pagination

limit: Int

Return up to N entries (pagination). See also: Pagination

offset: Int

Skip N entries (pagination). See also: Pagination

paid_at_max: String

Filter output by payment date, upper boundary

Timestamp (RFC 3339)

paid_at_min: String

Filter output by payment date, lower boundary

Timestamp (RFC 3339)

sales_channel_id: String

Filter output by sales channel

shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"

sort_by: OrdersPageSortBy

Whether to sort output in some specific way. See also: Pagination

sort_desc: Boolean

Whether to use descending sort order. See also: Pagination

subscription_id: String

Filter output by subscription

type: OrderType

Filter output by order type

updated_at_max: String

Filter output by last update date, upper boundary

Timestamp (RFC 3339)

updated_at_min: String

Filter output by last update date, lower boundary

Timestamp (RFC 3339)

Result

OrderPage

Preview (typescript)

Loading module