GetOrdersParameters
Necessary and optional parameters to get orders.
interface GetOrdersParameters {
cart_id?: string;
channel_id?: number;
customer_id?: number;
email?: string;
is_deleted?: boolean;
limit?: number;
max_date_created?: string;
max_date_modified?: string;
max_id?: number;
max_total?: number;
min_date_created?: string;
min_date_modified?: string;
min_id?: number;
min_total?: number;
page?: number;
payment_method?: string;
sort?: string;
status_id?: number;
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
cart_id | Optional | string | The cart ID of the order. |
channel_id | Optional | number | The Channel ID of the Order. |
customer_id | Optional | number | Customer ID |
email | Optional | string | The email of the customer. |
is_deleted | Optional | boolean | If the order was deleted or archived. |
limit | Optional | number | Number of results to return. |
max_date_created | Optional | string | Maximum date the order was created in RFC-2822 or ISO-8601. RFC-2822: Thu, 20 Apr 2017 11:32:00 -0400 ISO-8601: 2017-04-20T11:32:00.000-04:00 |
max_date_modified | Optional | string | Maximum date the order was modified in RFC-2822 or ISO-8601. RFC-2822: Thu, 20 Apr 2017 11:32:00 -0400 ISO-8601: 2017-04-20T11:32:00.000-04:00 |
max_id | Optional | number | The maximum order ID. |
max_total | Optional | number | The maximum order total in float format. eg. 12.50 |
min_date_created | Optional | string | Minimum date the order was created in RFC-2822 or ISO-8601. RFC-2822: Thu, 20 Apr 2017 11:32:00 -0400 ISO-8601: 2017-04-20T11:32:00.000-04:00 |
min_date_modified | Optional | string | Minimum date the order was modified in RFC-2822 or ISO-8601. RFC-2822: Thu, 20 Apr 2017 11:32:00 -0400 ISO-8601: 2017-04-20T11:32:00.000-04:00 |
min_id | Optional | number | The minimum order ID. |
min_total | Optional | number | The minimum order total in float format. eg. 12.50 |
page | Optional | number | The page to return in the response. |
payment_method | Optional | string | The payment method used on the order. |
sort | Optional | string | Field and direction to sort orders. To specify the direction, add :asc or :desc to the end of the query parameter. E.g. sort=date_created:desc. |
status_id | Optional | number | The staus ID of the order. You can get the status id from the /orders endpoints. |