ShipStation icon

ShipStation

Interact with ShipStation API v2

Actions33

Batch → List

AI-generated

Overview

This node interacts with the ShipStation API to list batches. It supports pagination and can either return all batches or a limited number based on user-defined options. This is useful for users who want to retrieve batch information from their ShipStation account, such as for inventory management or order processing.

Use Case Examples

  1. Retrieve the first page of batches with a default page size.
  2. Retrieve all batches without pagination limits.

Properties

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

Output

JSON

  • json - The batch data returned from the ShipStation API, structured as an array of batch objects or a single batch object depending on the response.

Dependencies

  • ShipStation API service for making API requests.
  • Error handling service for managing API errors.
  • Pagination service for handling pagination parameters.

Troubleshooting

  • Common issues include API errors such as authentication failures or rate limits, which will be thrown as errors and can be handled by the node's error handling mechanism.
  • If no data is received from the API, the node throws an error indicating no data was returned, which may require checking API connectivity or permissions.
  • Incorrect pagination parameters may result in incomplete data retrieval; ensure page and page size values are valid.

Discussion