OrderDesk icon

OrderDesk

Interact with OrderDesk API

Overview

The node interacts with the OrderDesk API to manage shipments related to orders. Specifically, the "Delete Shipment" operation allows users to remove a shipment record associated with a particular order. This is useful in scenarios where a shipment was created by mistake, needs to be canceled, or corrected.

Practical examples include:

  • Automatically deleting a shipment if an order is canceled in an external system.
  • Cleaning up shipment records during data synchronization between OrderDesk and other platforms.
  • Managing shipment lifecycle programmatically within automated workflows.

Properties

Name Meaning
Order ID The unique identifier of the order to which the shipment belongs. Required for this operation.
Shipment ID The unique identifier of the shipment to delete. Required to specify which shipment to remove.

Output

The node outputs JSON data representing the response from the OrderDesk API after attempting to delete the shipment. Typically, this will confirm whether the deletion was successful or provide error details if it failed.

No binary data output is involved in this operation.

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.

Troubleshooting

  • Common issues:

    • Invalid or missing Order ID or Shipment ID will cause the API call to fail.
    • Authentication errors if the API key or token is incorrect or expired.
    • Network connectivity problems preventing access to the OrderDesk API.
  • Error messages:

    • "Shipment not found" indicates the specified shipment ID does not exist under the given order.
    • "Unauthorized" or "Authentication failed" suggests issues with the provided API credentials.
    • "Bad Request" may indicate malformed input parameters.
  • Resolutions:

    • Verify that both Order ID and Shipment ID are correct and correspond to existing records.
    • Ensure API credentials are valid and have necessary permissions.
    • Check network settings and retry the request.

Links and References

Discussion