ShipStation icon

ShipStation

Interact with ShipStation API v2

Actions33

Shipment → List

AI-generated

Overview

This node interacts with the ShipStation API to list shipments. It supports pagination and can either return a specific page of shipments or all shipments by iterating through pages. This is useful for users who want to retrieve shipment data from their ShipStation account for processing, reporting, or integration with other systems.

Use Case Examples

  1. Retrieve the first page of shipments with a default page size.
  2. Retrieve all shipments without limiting the number of results, useful for full data synchronization.

Properties

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

Output

JSON

  • json - Each item contains shipment data returned from the ShipStation API
  • pairedItem
    • item - Index of the input item that produced this output

Dependencies

  • ShipStation API service for making authenticated requests to the ShipStation API

Troubleshooting

  • Common issues include API errors such as authentication failures or rate limits, which are handled and reported as errors.
  • If no data is received from the API, the node throws an error indicating this issue.
  • Users should ensure correct API credentials and valid pagination parameters to avoid errors.

Discussion