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 batches, shipments, labels, products, and more. Specifically, for the Batch - Get operation, it retrieves detailed information about a specific batch by its ID.

Typical use cases include:

  • Fetching the status and details of a particular batch of shipments or orders.
  • Monitoring batch processing progress.
  • Integrating batch data into workflows for reporting or further automation.

For example, a user might want to get the details of a batch to verify which shipments are included before processing or to audit batch statuses in an automated logistics workflow.

Properties

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

Output

The node outputs a JSON object representing the batch resource retrieved from ShipStation. The structure corresponds directly to the ShipStation API response for a batch, typically including fields such as batch ID, status, creation date, list of shipments in the batch, and other metadata.

Example output (simplified):

{
  "batchId": "12345",
  "status": "created",
  "shipments": [...],
  "createdDate": "2024-01-01T12:00:00Z",
  ...
}

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 service and standard n8n environment.

Troubleshooting

  • Common issues:

    • Invalid or missing batch ID: The node requires a valid batch ID; ensure the ID is correct and exists in your ShipStation account.
    • Authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
    • Network or API downtime: Temporary connectivity issues can cause failures; retry after some time.

  • Error messages:

    • Errors returned from the ShipStation API are handled and surfaced. For example, if the batch ID does not exist, the API may return a 404 error, which will be shown in the node's output.
    • If the node throws an "Unknown operation" error, it indicates a misconfiguration of the operation parameter.

To resolve errors:

  • Double-check the batch ID input.
  • Confirm API credentials.
  • Review ShipStation API status and limits.

Links and References

Discussion