GET:orders/page.json

Description

Get all existing orders.

See also: Pagination.

Permission bit: "orders.read"

Topic: Orders

Query Parameters

cart: Boolean

Include only cart orders or otherwise only full orders

Example: ?cart=true

created_at_max: String

Filter output by creation date, upper boundary

Example: ?created_at_max=2014-09-04T12:23:34Z

Timestamp (RFC 3339)

created_at_min: String

Filter output by creation date, lower boundary

Example: ?created_at_min=2014-09-04T12:23:34Z

Timestamp (RFC 3339)

customer_id: String

Filter output by customer

Example: ?customer_id=str

last_key: String

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

Example: ?last_key=str

limit: Int

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

Example: ?limit=5

offset: Int

Skip N entries (pagination). See also: Pagination

Example: ?offset=5

paid_at_max: String

Filter output by payment date, upper boundary

Example: ?paid_at_max=2014-09-04T12:23:34Z

Timestamp (RFC 3339)

paid_at_min: String

Filter output by payment date, lower boundary

Example: ?paid_at_min=2014-09-04T12:23:34Z

Timestamp (RFC 3339)

sales_channel_id: String

Filter output by sales channel

Example: ?sales_channel_id=str

shop_id: String, required

Unique shop identifier. See also: Unique Identifiers

Example: ?shop_id=sh_EQzGqWoY

sort_by: OrdersPageSortBy

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

Example: ?sort_by=created_at

sort_desc: Boolean

Whether to use descending sort order. See also: Pagination

Example: ?sort_desc=true

subscription_id: String

Filter output by subscription

Example: ?subscription_id=str

type: OrderType

Filter output by order type

Example: ?type=abandoned

updated_at_max: String

Filter output by last update date, upper boundary

Example: ?updated_at_max=2014-09-04T12:23:34Z

Timestamp (RFC 3339)

updated_at_min: String

Filter output by last update date, lower boundary

Example: ?updated_at_min=2014-09-04T12:23:34Z

Timestamp (RFC 3339)

Response Body

OrderPage

Response Body Type

Loading module