ShipStation icon

ShipStation

Interact with ShipStation API v2

Actions32

Overview

This node integrates with the ShipStation API v2 to manage inventory data. Specifically, the Inventory - List operation retrieves inventory levels from ShipStation. It supports pagination and can either return a single page of results or all available inventory items.

Typical use cases include:

  • Synchronizing inventory levels from ShipStation into other systems.
  • Monitoring stock availability across warehouses.
  • Automating inventory reporting workflows.

For example, you might use this node to fetch all inventory items to update your e-commerce platform's stock counts or to trigger reorder processes when stock is low.

Properties

Name Meaning
Options Collection of options to control the listing behavior:
  Page Page number to retrieve (default: 1)
  Page Size Number of items per page (default: 50)
  Return All Boolean flag to return all results by automatically paginating through all pages

Output

The node outputs an array of JSON objects representing inventory items. Each item corresponds to an inventory record retrieved from ShipStation.

The output JSON structure contains fields as returned by the ShipStation API under the /v2/inventory endpoint. The exact fields depend on ShipStation's API response but typically include details such as SKU, quantity on hand, warehouse location, and other inventory metadata.

No binary data is produced by this operation.

Example output snippet (simplified):

[
  {
    "sku": "ABC123",
    "quantityOnHand": 100,
    "warehouseId": 1,
    "productId": 456,
    ...
  },
  {
    "sku": "XYZ789",
    "quantityOnHand": 50,
    "warehouseId": 2,
    "productId": 789,
    ...
  }
]

Dependencies

  • Requires an API key credential for authenticating with the ShipStation API.
  • The node uses the ShipStation API v2 endpoints.
  • Pagination is handled internally by the node using a helper service.
  • No additional external dependencies are required beyond the configured ShipStation API credentials.

Troubleshooting

  • API Errors: If the ShipStation API returns an error (e.g., invalid credentials, rate limits, or malformed requests), the node will throw an error with details. Ensure that the API key is valid and has sufficient permissions.
  • Pagination Limits: When Return All is enabled, the node fetches all pages automatically. For very large inventories, this may take time or hit API rate limits. Consider using page and page size options to limit data volume.
  • Invalid JSON Data: Although not applicable for the list operation, other operations accept JSON input. Make sure JSON inputs are well-formed to avoid parsing errors.
  • Unknown Operation: If an unsupported operation is selected, the node throws an error indicating the unknown operation.

Links and References

Discussion