Actions25
- Coupon Actions
- Customer Actions
- Customer Form Field Values Actions
- Customer Address Actions
- Customer Group Actions
- Line Items Actions
- Order Actions
- Order Shipping Address Actions
- Order Shipment Actions
- Product Actions
- Refunds Actions
- Subscriber Actions
- Variant Actions
Order → Get All
AI-generatedOverview
This node interacts with the BigCommerce API to retrieve all orders based on specified parameters such as page number and limit. It is useful for scenarios where users need to fetch multiple orders for processing, reporting, or integration with other systems. For example, an e-commerce manager might use this node to pull all recent orders for analysis or to sync order data with a CRM system.
Use Case Examples
- Fetch all orders from page 1 with a limit of 25 orders per request.
- Retrieve orders with custom properties to include additional order details as per BigCommerce API documentation.
Properties
| Name | Meaning |
|---|---|
| Page | Specifies the page number of the order data to retrieve, allowing pagination through the orders. |
| Limit | Limits the number of orders returned in a single request, with a minimum of 25 and a maximum of 250. |
| Custom Properties | Allows adding custom properties to the request, enabling users to specify additional fields or filters based on the BigCommerce API documentation. |
Output
JSON
orderId- Unique identifier of the order.customerId- Identifier of the customer who placed the order.status- Current status of the order.totalPrice- Total price of the order.createdAt- Timestamp when the order was created.customProperties- Any additional custom properties included in the order data.
Dependencies
- BigCommerce API credentials required for authentication.
Troubleshooting
- Ensure the BigCommerce API credentials are correctly configured and have the necessary permissions to access order data.
- Check that the page and limit values are within the allowed ranges to avoid request errors.
- If custom properties are used, verify that the property names and values conform to the BigCommerce API specifications to prevent request failures.
Links
- BigCommerce Orders API Documentation - Official documentation for retrieving orders from the BigCommerce API, useful for understanding available parameters and response structure.