ShipTown icon

ShipTown

Consume ShipTown API
Join our community

Actions20

Overview

This node integrates with the ShipTown API to retrieve inventory data. Specifically, the "Inventory" resource with the "Get All" operation fetches a list of all inventory items available in the ShipTown system. It supports limiting the number of results or returning all available records.

Typical use cases include:

  • Synchronizing inventory data from ShipTown into another system.
  • Monitoring stock levels across warehouses.
  • Generating reports based on current inventory status.

For example, you might use this node to pull all inventory items and then filter or process them downstream in your workflow.

Properties

Name Meaning
Limit Maximum number of inventory records to return. Must be at least 1.
Return All Whether to ignore the limit and return all inventory records available from the API.

Output

The node outputs an array of JSON objects representing inventory items retrieved from ShipTown. Each object corresponds to one inventory record as returned by the ShipTown API's /api/inventory endpoint.

The output does not include binary data; it is purely JSON structured data describing inventory details such as quantities, product references, warehouse locations, etc., depending on the ShipTown API response schema.

Dependencies

  • Requires an API key credential for authenticating with the ShipTown API.
  • The base URL for the API is configured via credentials.
  • The node uses HTTP GET requests to the /api/inventory endpoint.
  • Proper network access to the ShipTown API is necessary.

Troubleshooting

  • Common issues:

    • Authentication failures if the API key or domain is misconfigured.
    • Network errors if the ShipTown API is unreachable.
    • Rate limiting or pagination issues if requesting too many records without using "Return All".

  • Error messages:

    • Errors from the API will be surfaced as error messages in the node output.
    • If "Continue On Fail" is enabled, errors for individual items will be included in the output JSON with an error field.

  • Resolutions:

    • Verify API credentials and domain configuration.
    • Use the "Limit" property to restrict the number of records if encountering timeouts.
    • Enable "Return All" only when expecting manageable data volumes.

Links and References

Discussion