ShipTown icon

ShipTown

Consume ShipTown API

Actions20

Overview

This node integrates with the ShipTown API to manage orders and other resources such as activities, products, inventory, warehouses, and users. Specifically for the Order Delete operation, it allows users to delete an existing order by its ID. This is useful in scenarios where orders need to be removed from the system due to cancellations, errors, or data cleanup.

Practical examples:

  • Automatically deleting orders that have been canceled in an external system.
  • Cleaning up test or duplicate orders in bulk workflows.
  • Integrating with other systems to synchronize order deletions.

Properties

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

Output

The output is a JSON object representing the response from the ShipTown API after attempting to delete the specified order. Typically, this will confirm whether the deletion was successful or provide error details if it failed.

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the ShipTown API.
  • The node expects the ShipTown API base URL to be configured via credentials.
  • Network access to the ShipTown API endpoint is necessary.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Order ID will likely result in an error response from the API.
    • Missing or incorrect API authentication credentials will cause authentication failures.
    • Network connectivity problems can prevent the request from completing.
  • Common error messages:

    • "404 Not Found": The specified order ID does not exist. Verify the order ID is correct.
    • "401 Unauthorized" or "403 Forbidden": Authentication failed. Check API credentials.
    • "400 Bad Request": The request parameters are invalid. Ensure the Order ID is a valid number.

To resolve these errors, verify the input parameters, ensure valid API credentials are set up in n8n, and confirm network connectivity.

Links and References

Discussion