ShipStation icon

ShipStation

Interact with ShipStation API v2

Actions33

Inventory → List

AI-generated

Overview

This node interacts with the ShipStation API to list inventory levels. It supports pagination and can either return all inventory items or a limited set based on user-defined page and page size options. This is useful for scenarios where users need to retrieve and manage inventory data from ShipStation, such as syncing inventory levels with other systems or monitoring stock.

Use Case Examples

  1. Retrieve all inventory items from ShipStation to update a local database.
  2. Fetch a specific page of inventory items to display in a dashboard with pagination controls.

Properties

Name Meaning
Options Collection of options to control the listing behavior, including pagination and whether to return all results.

Output

JSON

  • json - The inventory items retrieved from ShipStation, each item representing an inventory record.

Dependencies

  • ShipStation API service accessed via an API key credential

Troubleshooting

  • If no data is received from the ShipStation API, the node throws an error indicating no data was returned; ensure the API credentials and permissions are correct.
  • API errors from ShipStation are handled and surfaced; check the error messages for issues like invalid parameters or rate limits.
  • When 'Return All' is enabled, large data sets are paginated internally; if the process is slow, consider limiting the page size or disabling 'Return All'.

Discussion