ShipStation icon

ShipStation

Interact with ShipStation API v2

Actions32

Overview

This node integrates with the ShipStation API v2 to manage shipping-related resources. Specifically, for the Label resource with the Get operation, it retrieves detailed information about a specific shipping label by its ID. This is useful in scenarios where you need to fetch label details such as tracking numbers, shipment status, or label metadata after creating or listing labels.

Practical examples include:

  • Retrieving label details to display or log them in your workflow.
  • Verifying label status before proceeding with shipment processing.
  • Fetching label data to trigger further automation steps like notifications or printing.

Properties

Name Meaning
ID The unique identifier of the label resource to retrieve. This is required to specify which label's details to fetch.

Output

The node outputs a JSON object containing the full details of the requested label as returned by the ShipStation API. The structure typically includes fields such as label ID, shipment info, carrier details, tracking number, label URL, and other metadata related to the label.

No binary data output is produced by this operation.

Example output snippet (simplified):

{
  "labelId": "123456",
  "shipmentId": "78910",
  "carrierCode": "fedex",
  "trackingNumber": "1234567890",
  "labelUrl": "https://shipstation.com/label/123456.pdf",
  ...
}

Dependencies

  • Requires an API key credential for authenticating with the ShipStation API.
  • The node uses the ShipStationApiService internally to make HTTP requests to the ShipStation endpoints.
  • No additional environment variables are needed beyond the configured API credentials.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent label ID will result in an error from the ShipStation API.
    • Network connectivity problems can cause request failures.
    • Missing or incorrect API credentials will prevent successful authentication.

  • Error messages:

    • Errors returned by the ShipStation API are handled and surfaced by the node. For example, if the label ID does not exist, the API might return a 404 error with a message indicating the resource was not found.
    • If the node throws an "Unknown operation" error, ensure that the Resource is set to "Label" and Operation to "Get".

  • Resolution tips:

    • Verify the label ID is correct and exists in your ShipStation account.
    • Check that the API credentials are valid and have sufficient permissions.
    • Ensure network access to the ShipStation API endpoint is available.

Links and References

Discussion