OrderDesk icon

OrderDesk

Interact with OrderDesk API

Actions16

Overview

The "Update Shipment" operation in the OrderDesk node allows users to modify details of an existing shipment associated with a specific order. This is useful for scenarios where shipment information needs correction or updating after creation, such as changing tracking numbers, carrier details, or shipment status.

Practical examples include:

  • Updating the tracking number once it becomes available.
  • Changing the shipping carrier if the original one was incorrect.
  • Modifying shipment metadata or notes related to the delivery.

This operation requires specifying both the Order ID and the Shipment ID to identify the exact shipment to update, along with the data payload describing the changes.

Properties

Name Meaning
Order ID The unique identifier of the order to which the shipment belongs. Required to locate the shipment.
Shipment ID The unique identifier of the shipment to be updated. Required to specify which shipment to modify.
Post Data JSON-formatted data containing the fields and values to update on the shipment. The structure varies depending on the API's expected shipment update schema.

Output

The node outputs JSON data representing the updated shipment object as returned by the OrderDesk API. This typically includes all shipment details reflecting the applied updates, such as updated tracking info, carrier, status, and timestamps.

If the API supports binary data for shipments (e.g., labels), this node would handle it accordingly, but based on the provided code and properties, the output focuses on JSON data.

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 permissions on the API key to update shipments are necessary.

Troubleshooting

  • Missing or invalid Order ID or Shipment ID: The API will reject requests without valid identifiers. Ensure these IDs are correct and exist in your OrderDesk account.
  • Malformed JSON in Post Data: The postData must be valid JSON matching the API's expected format. Invalid JSON will cause request failures.
  • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • API rate limits or downtime: If requests fail unexpectedly, check for API service status or rate limiting issues.
  • Error messages from API: Typically include HTTP status codes and error messages indicating what went wrong (e.g., 404 for not found, 400 for bad request). Use these to adjust input parameters accordingly.

Links and References

Discussion