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 programmatically. Specifically for the Batch - Create operation, it enables creating a new batch in ShipStation by sending custom JSON data describing the batch details.

Typical use cases include automating batch creation workflows in e-commerce or logistics platforms where multiple shipments or orders need to be grouped and processed together. For example, a user might create batches of shipments to streamline label printing or carrier processing.

Properties

Name Meaning
JSON Data JSON-formatted data representing the batch details to create. This should conform to the expected structure required by ShipStation's batch creation API endpoint.

Output

The node outputs a JSON object representing the newly created batch as returned by the ShipStation API. The output is accessible under the json field of the item. It contains all relevant batch information such as batch ID, status, and any other metadata provided by the API response.

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 environment variables are explicitly required beyond the API credentials.

Troubleshooting

  • Invalid JSON Data: If the JSON Data input is malformed or does not match the expected schema, the API will return an error. Ensure the JSON is valid and structured according to ShipStation's batch creation requirements.
  • Authentication Errors: Missing or invalid API credentials will cause authentication failures. Verify that the API key credential is correctly configured.
  • API Rate Limits or Server Errors: The ShipStation API may throttle requests or return server errors. Implement retry logic or check ShipStation's service status if issues persist.
  • Unknown Operation Error: If the operation parameter is incorrectly set or unsupported, the node throws an "Unknown operation" error. Confirm that the operation is set to "create" for batch resource.

Links and References

Discussion