List Orders

GET/store/customers/me/orders

Retrieve a list of the logged-in Customer's Orders. The orders can be filtered by fields such as status or fulfillment_status. The orders can also be paginated.

Request

Query Params

string

optional

term to search orders' display ID, email, shipping address's first name, customer's first name, customer's last name, and customer's phone number.

string

optional

Filter by ID.

status

array[string]

optional

Filter by status.

fulfillment_status

array[string]

optional

Fulfillment status to search for.

payment_status

array[string]

optional

Payment status to search for.

display_id

string

optional

Filter by display ID.

cart_id

string

optional

Filter by cart ID.

string

optional

Filter by email.

region_id

string

optional

Filter by region ID.

currency_code

string

optional

Filter by the 3 character ISO currency code of the order.

tax_rate

string

optional

Filter by tax rate.

array[string]

optional

filter by dates less than this date

Example:

["","",""]

array[string]

optional

filter by dates greater than this date

Example:

["","",""]

lte

array[string]

optional

filter by dates less than or equal to this date

Example:

["","",""]

gte

array[string]

optional

filter by dates greater than or equal to this date

Example:

["","",""]

limit

integer

optional

Limit the number of orders returned.

offset

integer

optional

The number of orders to skip when retrieving the orders.

expand

string

optional

Comma-separated relations that should be expanded in the returned orders.

fields

string

optional

Comma-separated fields that should be included in the returned orders.

Request samples

Responses

OK(200)

Client Error or Multiple Errors(400)

User is not authorized. Must log in first(401)

Not Found Error(404)

Invalid State Error(409)

Invalid Request Error(422)

Server Error(500)

HTTP Code: 200

Content Type : JSONapplication/json

No schema defined

Not configured

Last modified: a year ago