Actions16
- Orders Actions
- Shipments Actions
- Inventory Items Actions
- Move Orders Actions
Overview
The node interacts with the OrderDesk API, specifically allowing users to list orders. It sends requests to retrieve order data based on user-defined filter criteria passed as query parameters. This is useful for workflows that need to fetch and process order information dynamically, such as syncing orders with other systems, generating reports, or triggering actions based on order status.
For example, a user might want to list all orders placed within a certain date range or filter orders by their status to automate fulfillment processes.
Properties
| Name | Meaning |
|---|---|
| Type of Data | Selects the type of data to send; currently only "Query" (query parameters) is supported. |
| Filter criteria | Key/value pairs used as query parameters to filter the list of orders returned by the API. |
- Type of Data: Only "Query" is available, meaning filters are sent as URL query parameters.
- Filter criteria: Users can specify multiple key-value pairs where each key is the name of a query parameter and the value is its corresponding filter value. For example,
status=completedordate_from=2023-01-01.
Output
The node outputs JSON data representing the list of orders retrieved from the OrderDesk API. The structure typically includes an array of order objects, each containing details such as order ID, customer info, items, status, and timestamps.
If the API supports binary data in responses (not indicated here), it would be summarized accordingly, but this node primarily deals with JSON order data.
Dependencies
- Requires an API authentication token credential configured in n8n to access the OrderDesk API.
- The base URL for API requests is
https://app.orderdesk.me. - The node expects the API to respond with JSON data.
Troubleshooting
Common issues:
- Incorrect or missing API credentials will cause authentication errors.
- Invalid filter keys or values may result in empty results or API errors.
- Network connectivity problems can prevent successful API calls.
Error messages:
- Authentication failures usually indicate invalid or expired API tokens; reconfigure credentials.
- HTTP 400 errors often mean malformed query parameters; verify filter keys and values.
- HTTP 500 errors suggest server-side issues; retry later or contact OrderDesk support.
Links and References
- OrderDesk API Documentation (for detailed API endpoints and query parameters)
- n8n documentation on creating custom nodes