ShipTown icon

ShipTown

Consume ShipTown API

Actions20

Overview

This node integrates with the ShipTown API to manage orders and other related resources such as activities, products, inventory, warehouses, and users. Specifically for the Order - Get operation, it retrieves detailed information about a single order by its ID. This is useful in scenarios where you need to fetch the current status, details, or metadata of a specific order within your workflow.

Practical examples include:

  • Fetching an order's details after receiving an order ID from a previous step.
  • Validating order information before processing shipment or payment.
  • Integrating order data into reporting or notification systems.

Properties

Name Meaning
Order ID The unique numeric identifier of the order to retrieve.

Output

The node outputs the JSON representation of the requested order as returned by the ShipTown API. This typically includes all order details such as customer info, items, status, shipping details, and timestamps.

The output is structured as an array of JSON objects (usually one object per input item), each containing the full order data under the json field.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the ShipTown API via an API key credential.
  • The node expects the ShipTown API base URL and authentication credentials to be configured in n8n.
  • Network access to the ShipTown service endpoint is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Order ID: The node requires a valid numeric order ID; ensure this is provided and correct.
    • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
    • Network or API downtime: Check connectivity and ShipTown service status if requests fail.
  • Error messages:

    • "404 Not Found": The specified order ID does not exist. Confirm the order ID is correct.
    • "401 Unauthorized" or "403 Forbidden": Authentication failed or insufficient permissions. Recheck API credentials.
    • Timeout or network errors: Ensure stable internet connection and that the ShipTown API endpoint is reachable.

Links and References

Discussion