BigCommerce - Update Order
Description
Section titled “Description”This module allows modifying existing orders in BigCommerce: change status, add notes, update billing address, and create shipments with tracking information.
Configuration
Section titled “Configuration”Required Credentials
Section titled “Required Credentials”- Store Hash: Unique hash of your BigCommerce store
- Access Token: API V2 access token
Parameters
Section titled “Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
| credentials_id | credential | Yes | BigCommerce credentials |
| order_id | string | Yes | Order ID to update |
| status_id | select | No | New order status |
| staff_notes | string | No | Internal staff notes |
| customer_message | string | No | Customer message |
| billing_first_name | string | No | Billing first name |
| billing_last_name | string | No | Billing last name |
| billing_street | string | No | Billing address |
| billing_street2 | string | No | Billing address line 2 |
| billing_city | string | No | Billing city |
| billing_state | string | No | Billing state/province |
| billing_zip | string | No | Billing postal code |
| billing_country | string | No | Billing country |
| billing_email | string | No | Billing email |
| billing_phone | string | No | Billing phone |
| tracking_number | string | No | Tracking number (creates shipment) |
| shipping_provider | string | No | Shipping provider |
| tracking_carrier | string | No | Carrier |
Order Statuses
Section titled “Order Statuses”| ID | Status |
|---|---|
| 0 | Incomplete |
| 1 | Pending |
| 2 | Shipped |
| 3 | Partially Shipped |
| 4 | Refunded |
| 5 | Cancelled |
| 6 | Declined |
| 7 | Awaiting Payment |
| 8 | Awaiting Pickup |
| 9 | Awaiting Shipment |
| 10 | Completed |
| 11 | On Hold |
| 12 | Disputed |
Output
Section titled “Output”{ "success": true, "order": {...}, "order_id": 12345, "status_id": 2, "status": "Shipped", "fields_updated": ["status_id", "shipment_created"], "shipment": {...}, "message": "Order 12345 updated successfully"}Usage Example
Section titled “Usage Example”Change status to shipped
Section titled “Change status to shipped”{ "order_id": "12345", "status_id": "2"}Add internal notes
Section titled “Add internal notes”{ "order_id": "12345", "staff_notes": "VIP customer - High priority"}Create shipment with tracking
Section titled “Create shipment with tracking”{ "order_id": "12345", "status_id": "2", "tracking_number": "1Z999AA10123456784", "shipping_provider": "ups", "tracking_carrier": "UPS"}Update billing address
Section titled “Update billing address”{ "order_id": "12345", "billing_first_name": "Juan", "billing_last_name": "Perez", "billing_street": "Calle Nueva 456", "billing_city": "Madrid", "billing_zip": "28002", "billing_country": "Spain"}API Used
Section titled “API Used”- Endpoint:
PUT /stores/{store_hash}/v2/orders/{id} - Shipment Endpoint:
POST /stores/{store_hash}/v2/orders/{id}/shipments - Documentation: BigCommerce Orders API
- Uses the BigCommerce V2 API for orders
- If tracking is provided, a shipment is automatically created
- The shipment includes all products from the order
- At least one existing shipping address is required to create the shipment
- The
fields_updatedfield indicates what was modified shipment_createdappears if a new shipment was created
Related Nodes
Section titled “Related Nodes”- BigcommerceGetOrders - Get orders
- BigcommerceGetCustomers - Get customers
- BigcommerceGetProducts - Get products