Home > @vsf-enterprise/bigcommerce-api > GetOrdersParameters
# GetOrdersParameters interface
Necessary and optional parameters to get orders.
Signature:
export interface GetOrdersParameters
# Properties
| Property | Type | Description |
|---|---|---|
| cart_id? | string | (Optional) The cart ID of the order. |
| channel_id? | number | (Optional) The Channel ID of the Order. |
| customer_id? | number | (Optional) Customer ID |
| email? | string | (Optional) The email of the customer. |
| is_deleted? | boolean | (Optional) If the order was deleted or archived. |
| limit? | number | (Optional) Number of results to return. |
| max_date_created? | string | (Optional) 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? | string | (Optional) 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? | number | (Optional) The maximum order ID. |
| max_total? | number | (Optional) The maximum order total in float format. eg. 12.50 |
| min_date_created? | string | (Optional) 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? | string | (Optional) 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? | number | (Optional) The minimum order ID. |
| min_total? | number | (Optional) The minimum order total in float format. eg. 12.50 |
| page? | number | (Optional) The page to return in the response. |
| payment_method? | string | (Optional) The payment method used on the order. |
| sort? | string | (Optional) 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? | number | (Optional) The staus ID of the order. You can get the status id from the /orders endpoints. |