ShipStation

Interact with ShipStation API v2

Actions32

Batch Actions
Carrier Actions
- Get
- List
Inventory Actions
- List
- Update
Label Actions
- Create
- Get
- List
- Void
Product Actions
Shipment Actions
Tag Actions
Warehouse Actions

Overview

This node integrates with the ShipStation API v2, allowing users to manage various shipping-related resources such as shipments, labels, products, carriers, warehouses, and more. Specifically, for the Carrier resource with the Get operation, the node retrieves detailed information about a specific carrier by its ID.

Common scenarios where this node is beneficial include:

Fetching carrier details to verify shipping options or track carrier-specific information.
Integrating shipping workflows where carrier data is needed dynamically.
Automating logistics processes by retrieving carrier metadata programmatically.

Practical example:

A user wants to get detailed information about a particular shipping carrier (e.g., USPS, FedEx) by providing its unique ID to display or use in further shipment processing steps.

Properties

Name	Meaning
ID	The unique identifier of the carrier resource to retrieve. This is required for the Get operation.

Output

The output is a JSON object representing the carrier's data as returned by the ShipStation API. It contains all relevant fields describing the carrier, such as name, code, and other metadata provided by ShipStation.

Example structure (simplified):

{
  "carrierId": "string",
  "name": "string",
  "code": "string",
  "phone": "string",
  "accountNumber": "string",
  ...
}

No binary data output is produced by this operation.

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 API endpoints.
Proper configuration of the ShipStation API credentials in n8n is necessary.

Troubleshooting

Error: Unknown operation — This occurs if an unsupported operation is specified. Ensure that the operation is set to "Get" for the Carrier resource.
API errors — If the ShipStation API returns an error (e.g., invalid ID, authentication failure), the node will throw an error with the message from the API. Verify that the carrier ID exists and the API credentials are valid.
Missing ID property — The ID field is required; omitting it will cause the node to fail. Always provide a valid carrier ID.