Shippo icon

Shippo

Interact with Shippo API

Actions68

Overview

This node operation allows you to remove shipments from a specific batch in the Shippo system. It is useful when you need to update or correct the contents of a batch by excluding certain shipments that were previously added. For example, if some shipments were mistakenly included in a batch for processing or shipping, this operation helps to clean up the batch without deleting the entire batch.

Properties

Name Meaning
Batch Id The unique identifier (Object ID) of the batch from which shipments will be removed.
SHIPPO API VERSION Optional header to specify a non-default version of the Shippo API to use for this request.
Body JSON string representing the request body, typically containing details about which shipments to remove.

Output

The output will contain the JSON response from the Shippo API after attempting to remove shipments from the specified batch. This usually includes confirmation of the updated batch state or error information if the removal failed. The node does not explicitly handle binary data output.

Dependencies

  • Requires an active connection to the Shippo API.
  • Needs an API key credential configured in n8n for authenticating requests to Shippo.
  • Optionally supports specifying the API version via a custom header.

Troubleshooting

  • Invalid Batch Id: If the provided batch ID does not exist or is malformed, the API will return an error. Verify the batch ID before running the node.
  • Malformed Body JSON: The "Body" property must be valid JSON. Errors parsing this input will cause the request to fail.
  • API Version Issues: Specifying an unsupported API version may lead to unexpected errors. Use the default or verify supported versions in Shippo documentation.
  • Authentication Failures: Ensure the API key credential is correctly set and has sufficient permissions.

Links and References

Discussion