Shippo icon

Shippo

Interact with Shippo API

Actions68

Overview

This node integrates with the Shippo API to create a new carrier account. It is useful for users who want to programmatically add and manage shipping carrier accounts within their logistics or e-commerce workflows. For example, an online store could automate adding multiple carrier accounts to Shippo for different shipping providers, enabling streamlined label creation and shipment tracking.

Properties

Name Meaning
SHIPPO API VERSION Optional string to specify a non-default Shippo API version to use. Useful if you need features or behavior from a specific API version.
Account Id The unique identifier of the account under which the carrier account will be created.
Active Boolean flag indicating whether the carrier account should be active immediately upon creation.
Carrier The name of the shipping carrier (e.g., USPS, FedEx) for which the account is being created.
Metadata Optional string field for additional metadata related to the carrier account.
Parameters A JSON string representing an array of additional parameters required by the carrier account, such as passwords or tokens. This field is masked in API responses for security reasons. See Shippo's carrier accounts guide for details.
Test Boolean flag indicating whether the carrier account is a test account.

Output

The node outputs JSON data representing the newly created carrier account as returned by the Shippo API. This typically includes details such as the carrier account ID, status, carrier name, and any metadata or parameters associated with it. The output does not include binary data.

Dependencies

  • Requires an API key credential for authenticating with the Shippo API.
  • The node sends HTTP requests to https://api.goshippo.com.
  • Optionally supports specifying a custom API version via the SHIPPO API VERSION header.

Troubleshooting

  • Invalid Credentials: If the API key is missing or invalid, the request will fail authentication. Ensure the API key credential is correctly configured.
  • Malformed Parameters: The Parameters property must be a valid JSON string representing an array of key-value pairs. Invalid JSON will cause errors.
  • Carrier Not Supported: Providing an unsupported carrier name may result in API errors. Verify supported carriers in Shippo's documentation.
  • API Version Issues: Specifying an incorrect or unsupported API version in SHIPPO API VERSION can lead to unexpected errors. Use only documented versions.
  • Network Issues: Connectivity problems to the Shippo API endpoint will cause request failures. Check network access and proxy settings if applicable.

Links and References

Discussion