get_all_orders
Retrieve and filter orders from BigCommerce stores using various criteria like customer ID, date ranges, order status, payment methods, and sorting options for comprehensive order management.
Instructions
Get all orders from the BigCommerce API. Can filter by customer_id to get products associated with specific customers through their order history. Store hash is automatically retrieved from environment variables.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cart_id | No | Filter orders by cart ID. | |
| channel_id | No | Filter orders by channel ID. | |
| customer_id | No | Filter orders by specific customer ID to get products associated with that customer. | |
| No | Filter orders by customer email address. | ||
| external_order_id | No | Filter orders by external order ID. | |
| limit | No | Number of results to return (default: 50, max: 250). | |
| max_date_created | No | Maximum date created for filtering (ISO 8601 format, e.g., 2023-12-31T23:59:59Z). | |
| max_date_modified | No | Maximum date modified for filtering (ISO 8601 format, e.g., 2023-12-31T23:59:59Z). | |
| max_id | No | Maximum order ID for filtering. | |
| max_total | No | Maximum order total amount for filtering. | |
| min_date_created | No | Minimum date created for filtering (ISO 8601 format, e.g., 2023-01-01T00:00:00Z). | |
| min_date_modified | No | Minimum date modified for filtering (ISO 8601 format, e.g., 2023-01-01T00:00:00Z). | |
| min_id | No | Minimum order ID for filtering. | |
| min_total | No | Minimum order total amount for filtering. | |
| page | No | Page number to return (default: 1). | |
| payment_method | No | Filter orders by payment method (e.g., credit_card, paypal, manual). | |
| sort | No | Sort field and direction (e.g., date_created:desc, id:asc, total:desc). | |
| status_id | No | Filter orders by status ID (e.g., 1=Pending, 7=Awaiting Payment, 11=Awaiting Fulfillment). | |
| store_Hash | No | Optional store hash. If not provided, uses BIGCOMMERCE_STORE_HASH from environment variables. |