List Orders

get

https://api.fera.ai/v3/private/orders

Retrieve a list of orders.

Query Params

page

int32

≥ 1

Current page number, if pagination used.

page_size

int32

≥ 1

Number of items per page.

limit

int32

1 to 100

Maximum number of items retrieved.

offset

int32

≥ 0

Starting position of items request query.

customer.external_id

string

External customer ID (usually the Wix, Shopify or other eCommerce platform customer ID).

customer_id

string

Filter by Fera customer ID or external customer ID.

external_id

string

External order ID (usually the Wix, Shopify or other eCommerce platform order ID).

external_ids

string

Comma-separated list of external order ID (usually the Wix, Shopify or other eCommerce platform order IDs).

string

Search by any of the following columns: number, line_items, platform_data, platform_order_id, platform_customer_id, customer.id, customer.external_id, customer.email, customer.name, etc

sort_by

string

enum

Sort (order) the response results by the given attribute.

Add :desc to sort in descending order, or :asc to sort in ascending order.

For example: created_at:desc would get you created_at in descending order.

Allowed:

Responses

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response

400Bad request