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 Shipment → Get
AI-generatedOverview
This node interacts with the BigCommerce API to perform operations related to order shipments. Specifically, the 'Get' operation for the 'Order Shipment' resource retrieves shipment details for a specified order. This is useful for e-commerce workflows where tracking or managing order shipments is required, such as fetching shipment status or details for customer service or logistics automation.
Use Case Examples
- Retrieve shipment details for a specific order to update a customer on their delivery status.
- Automate the process of fetching shipment information to integrate with a third-party shipping or tracking system.
Properties
| Name | Meaning |
|---|---|
| Order Id | The unique identifier of the order for which the shipment details are to be retrieved. |
Output
JSON
shipmentDetails- The JSON object containing the shipment information retrieved from the BigCommerce API for the specified order.
Dependencies
- Requires an API key credential for BigCommerce to authenticate requests.
Troubleshooting
- Common issues include invalid or missing Order Id, which will result in errors from the BigCommerce API indicating that the order shipment could not be found.
- Authentication errors may occur if the BigCommerce API credentials are incorrect or expired, resulting in authorization failures.
- Network or API rate limiting issues may cause request failures; ensure network connectivity and respect API usage limits.
Links
- BigCommerce API - Get an Order Shipment - Official BigCommerce API documentation for retrieving order shipment details.