OrderDesk icon

OrderDesk

Interact with OrderDesk API

Actions16

Overview

The node integrates with the OrderDesk API to manage shipments related to orders. Specifically, the "Create Shipment" operation allows users to create a new shipment record for a specified order by sending detailed shipment data in JSON format. This is useful in e-commerce workflows where automated shipment creation is needed after an order is processed, enabling seamless logistics and tracking updates.

Practical examples include:

  • Automatically creating shipment entries when an order is fulfilled.
  • Integrating with third-party shipping services by pushing shipment details into OrderDesk.
  • Managing multiple shipments per order programmatically within an automation workflow.

Properties

Name Meaning
Order ID The unique identifier of the order for which the shipment is being created.
Post Data The shipment details in JSON format. This data varies depending on the shipment specifics required by the OrderDesk API. It typically includes carrier information, tracking numbers, shipment items, and other relevant metadata.

Output

The node outputs JSON data representing the response from the OrderDesk API after attempting to create the shipment. This JSON typically contains confirmation details about the newly created shipment, such as shipment ID, status, and any metadata returned by the API.

If the API supports it, binary data output is not indicated or expected for 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.
  • The node sends HTTP requests with headers specifying JSON content type and acceptance.

Troubleshooting

  • Invalid Order ID: If the provided Order ID does not exist or is incorrect, the API will likely return an error indicating the order was not found. Verify the Order ID before running the node.
  • Malformed JSON in Post Data: Since shipment details must be provided in JSON format, invalid JSON syntax will cause request failures. Use proper JSON formatting and validate the payload.
  • Authentication Errors: Missing or invalid API credentials will result in authorization errors. Ensure that the API key/token is correctly set up in n8n credentials.
  • API Rate Limits or Downtime: If the API service is temporarily unavailable or rate-limited, requests may fail. Implement retry logic or check API status if persistent issues occur.

Links and References

Discussion