Actions16
- Orders Actions
- Shipments Actions
- Inventory Items Actions
- Move Orders Actions
Overview
The node interacts with the OrderDesk API to manage shipments related to orders. Specifically, the "Get Order Shipment" operation retrieves detailed information about a particular shipment associated with a given order. This is useful in scenarios where you need to track or verify shipment details programmatically within an automation workflow, such as confirming shipment status, tracking numbers, or delivery dates.
Practical examples include:
- Automatically fetching shipment details after an order is placed to update a CRM or notify customers.
- Integrating shipment data into inventory or logistics systems for real-time tracking.
- Auditing or reporting on shipments for specific orders within a business process.
Properties
| Name | Meaning |
|---|---|
| Order ID | The unique identifier of the order for which the shipment information is requested. |
| Shipment ID | The unique identifier of the shipment to retrieve details for, linked to the specified order. |
Output
The node outputs JSON data containing the shipment details for the specified order and shipment IDs. This typically includes fields such as shipment status, tracking number, carrier information, shipping date, and any other metadata provided by the OrderDesk API about that shipment.
If the node supports binary data output (not explicitly shown here), it would represent shipment-related files or documents (e.g., shipping labels or invoices). However, based on the provided code and properties, the primary output is structured JSON data describing the shipment.
Dependencies
- Requires an active connection to the OrderDesk API.
- Needs an API authentication token or key configured in n8n credentials to authorize requests.
- The base URL for API requests is
https://app.orderdesk.me. - Proper configuration of the "OrderDesk" credential in n8n is mandatory.
Troubleshooting
- Missing or invalid Order ID or Shipment ID: Ensure both IDs are correctly provided and correspond to existing records in OrderDesk; otherwise, the API will return errors or empty results.
- Authentication errors: Verify that the API key or token used in the credentials is valid and has sufficient permissions.
- Network or connectivity issues: Confirm that n8n can reach
https://app.orderdesk.mewithout firewall or proxy restrictions. - API rate limits or quota exceeded: If many requests are made in a short time, the API might throttle calls; handle retries or backoff accordingly.
- Unexpected response structure: If the API changes, the node's output format may differ; review API documentation for updates.
Links and References
- OrderDesk API Documentation — Official API reference for endpoints, parameters, and responses.
- n8n Documentation — General guidance on setting up credentials and using HTTP-based nodes.