Description

Get all existing orders.

See also: Pagination.

Topic: Orders

Arguments

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)

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

shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"

sort_by: StorefrontOrdersPageSortBy

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

sort_desc: Boolean

Whether to use descending sort order. See also: Pagination

Result

StorefrontOrderPage

Preview (typescript)

function storefrontOrdersPage(
created_at_max?: string
created_at_min?: string
last_key?: string
limit?: number
offset?: number
shop_id: string
sort_by?: StorefrontOrdersPageSortBy | null
sort_desc?: boolean
): StorefrontOrderPage | null