ShipStation icon

ShipStation

Interact with ShipStation API v2

Actions32

Overview

This node interacts with the ShipStation API v2 to manage shipping-related resources. Specifically, for the Label resource with the List operation, it retrieves a list of shipping labels from ShipStation.

Common scenarios where this node is beneficial include:

  • Fetching all shipping labels for reporting or auditing purposes.
  • Integrating label data into workflows for further processing or notifications.
  • Paginating through large sets of labels to handle them in batches.

Practical example:

  • A user wants to retrieve all shipping labels created in their ShipStation account to generate a consolidated report or to trigger downstream automation based on label status.

Properties

Name Meaning
Options Collection of options to control pagination and result size:
- Page Page number to retrieve (used when not returning all results).
- Page Size Number of items per page (used when not returning all results).
- Return All Boolean flag to return all results across all pages instead of a single page.

Output

The output is an array of JSON objects representing shipping labels retrieved from ShipStation. Each item corresponds to one label's data as returned by the ShipStation API.

The structure of each label object includes various properties related to the label, such as shipment details, carrier information, tracking numbers, and label URLs, depending on the API response.

No binary data output is produced by this operation.

Example output snippet (simplified):

[
  {
    "labelId": "123456",
    "shipmentId": "78910",
    "carrierCode": "fedex",
    "trackingNumber": "999999999999",
    "labelUrl": "https://shipstation.com/label/123456"
  },
  ...
]

Dependencies

  • Requires an API key credential for authenticating with the ShipStation API.
  • The node uses internal services for API requests, error handling, and pagination.
  • No additional external dependencies are required beyond the ShipStation API access.

Troubleshooting

  • Common issues:

    • API authentication failures due to invalid or missing API credentials.
    • Rate limiting or pagination errors if requesting too many records at once.
    • Network connectivity issues preventing API calls.

  • Error messages:

    • Errors returned from the ShipStation API are caught and handled; they typically include descriptive messages.
    • If an unknown operation or resource is specified, the node throws an error indicating the unsupported action.
    • Pagination parameters out of range may cause empty or partial results.

  • Resolutions:

    • Verify that the API key credential is correctly configured and has necessary permissions.
    • Use the "Return All" option carefully to avoid excessive data loads; consider using paging instead.
    • Check network connectivity and retry failed requests.
    • Ensure correct resource and operation names are selected.

Links and References

Discussion