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 → Archive
AI-generatedOverview
This node integrates with the BigCommerce API to perform various operations on different resources, including orders. Specifically, the 'Archive' operation for the 'Order' resource allows users to archive an order by providing the order ID. This is useful for managing order lifecycle and keeping the order data organized by archiving orders that are no longer active or needed in the main workflow.
Use Case Examples
- Archiving an order after it has been fulfilled to keep the order list clean.
- Automating order management by archiving orders based on certain criteria in a workflow.
Properties
| Name | Meaning |
|---|---|
| Order Id | The unique identifier of the order to be archived. |
Output
JSON
order- The response data from the BigCommerce API after archiving the order, typically including confirmation of the archive action and order details.
Dependencies
- BigCommerce API with appropriate API key credentials
Troubleshooting
- Ensure the provided Order Id is valid and exists in the BigCommerce store; otherwise, the API will return an error.
- Check that the API credentials have sufficient permissions to archive orders.
- Common error messages may include authorization errors if credentials are invalid or permission errors if the API user lacks rights to modify orders.
Links
- BigCommerce API - Archive Order - Official BigCommerce API documentation for archiving an order.