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, enabling users to manage various shipping-related resources programmatically. Specifically for the Shipment - Create operation, it allows creating new shipment records in ShipStation by sending custom JSON data describing the shipment details.

Typical use cases include automating order fulfillment workflows where shipment creation is triggered after an order is processed, or integrating ShipStation shipment creation into broader logistics automation pipelines.

For example, a user can provide shipment details such as recipient address, package dimensions, and shipping service via JSON, and this node will create the shipment in ShipStation, returning the created shipment data for further processing.

Properties

Name	Meaning
JSON Data	JSON data for the shipment resource. This should contain all necessary shipment details such as recipient info, package details, shipping service, etc.

Output

The node outputs a JSON object representing the response from the ShipStation API after creating the shipment. This typically includes the newly created shipment's details such as shipment ID, status, tracking information, and other metadata returned by ShipStation.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "shipmentId": 123456,
  "orderId": 78910,
  "carrierCode": "fedex",
  "serviceCode": "fedex_ground",
  "packageCode": "package",
  "confirmation": "delivery",
  "shipDate": "2024-06-01T12:00:00Z",
  "trackingNumber": "1234567890",
  "shipmentStatus": "shipped",
  ...
}

Dependencies

Requires an API key credential for authenticating with the ShipStation API.
The node depends on the ShipStation API service endpoint /v2/shipments for creating shipments.
Proper network connectivity to ShipStation API endpoints is required.

Troubleshooting

Common issues:
- Invalid or incomplete JSON data in the "JSON Data" property may cause API errors.
- Missing or incorrect API credentials will result in authentication failures.
- Network issues or ShipStation API downtime can cause request failures.
Error messages:
- Errors returned from the ShipStation API are handled and surfaced by the node. For example, if required fields are missing in the JSON data, the API might return validation errors.
- If an error occurs, the node throws an error unless "Continue On Fail" is enabled, in which case the error message is included in the output JSON under an error field.
Resolution tips:
- Validate the JSON data against ShipStation's shipment creation requirements before running the node.
- Ensure API credentials are correctly configured in n8n.
- Check network connectivity and ShipStation service status if requests fail unexpectedly.