Actions16
- Orders Actions
- Shipments Actions
- Inventory Items Actions
- Move Orders Actions
Overview
The node integrates with the OrderDesk API to retrieve shipment information related to orders. Specifically, for the "Shipments" resource and the "Get Order Shipments" operation, it fetches all shipment details associated with a given order ID. This is useful in scenarios where users want to track or manage shipments linked to specific orders within their workflows.
Practical examples include:
- Automatically retrieving shipment statuses after an order is placed.
- Synchronizing shipment data from OrderDesk into other systems like CRMs or inventory management tools.
- Triggering notifications or updates based on shipment information.
Properties
| Name | Meaning |
|---|---|
| Order ID | The unique identifier of the order for which to retrieve shipment details. Must be provided as a string. |
Output
The node outputs JSON data containing the shipment details for the specified order. The structure typically includes shipment identifiers, tracking numbers, carrier information, shipment status, and timestamps related to the shipments.
If the node supports binary data output (not explicitly shown in the provided code), it would represent any files or documents related to shipments, such as shipping labels or invoices.
Dependencies
- Requires an active connection to the OrderDesk API.
- Needs an API authentication token or key configured in the node's credentials to authorize requests.
- The base URL for API requests is
https://app.orderdesk.me.
Troubleshooting
- Missing or invalid Order ID: Ensure that the "Order ID" property is correctly set and corresponds to an existing order in OrderDesk.
- Authentication errors: Verify that the API credentials are correctly configured and have sufficient permissions.
- Network issues: Check connectivity to the OrderDesk API endpoint.
- Unexpected API responses: Confirm that the OrderDesk API has not changed its response format or endpoint URLs.
Common error messages might include authorization failures or "order not found" errors. Resolving these typically involves checking credentials and verifying the order ID.
Links and References
- OrderDesk API Documentation (general reference for API endpoints and usage)
- n8n documentation on creating custom nodes