ShipStation icon

ShipStation

Interact with ShipStation API v2

Actions32

Overview

This node integrates with the ShipStation API v2, allowing users to manage various shipping-related resources such as shipments, labels, products, inventory, rates, batches, carriers, warehouses, and tags. Specifically for the Label - Create operation, it enables creating a new shipping label by sending custom JSON data to the ShipStation service.

Typical use cases include automating label creation for orders in e-commerce workflows, generating shipping labels programmatically based on order details, or integrating label creation into larger fulfillment pipelines.

Example scenario: After an order is processed and shipment details are finalized, this node can be used to create a shipping label automatically by providing the required label data in JSON format.

Properties

Name Meaning
JSON Data JSON data representing the label to be created. This should contain all necessary fields as per ShipStation's label creation API requirements.

Output

The node outputs a JSON object containing the response from the ShipStation API after creating the label. The structure corresponds to the label resource returned by ShipStation, typically including label details such as label ID, shipment info, tracking number, label URL, and status.

If the API returns an error, the node will throw an error unless "Continue On Fail" is enabled, in which case the error message will be included in the output JSON under an error field.

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 ShipStation API v2 endpoints.
  • No additional external dependencies beyond the ShipStation API and n8n's credential management.

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 connectivity issues can prevent communication with the ShipStation API.
  • Error messages:

    • Errors returned by the ShipStation API are caught and rethrown with descriptive messages.
    • If the node throws an error about an unknown operation, verify that the Resource is set to "Label" and Operation to "Create".
    • JSON parsing errors indicate malformed JSON input; ensure the JSON data is valid.
  • Resolutions:

    • Validate JSON input before running the node.
    • Confirm API credentials are correctly configured and have sufficient permissions.
    • Enable "Continue On Fail" to handle errors gracefully in workflows.

Links and References

Discussion