Shippo icon

Shippo

Interact with Shippo API

Actions68

Overview

This node interacts with the Shippo API to retrieve the registration status of a carrier account. Specifically, it allows users to query the current registration state for a selected shipping carrier such as UPS, USPS, or Canada Post. This is useful in scenarios where you need to verify if your account with a particular carrier is active and properly registered before initiating shipments or other carrier-specific operations.

Practical examples include:

  • Checking if your UPS account is registered and ready to use before creating shipment labels.
  • Validating USPS account status programmatically as part of an automated shipping workflow.
  • Monitoring carrier account statuses across multiple carriers to ensure smooth logistics operations.

Properties

Name Meaning
Carrier Select the specific carrier to check the registration status for. Options: Ups, Usps, Canada Post
SHIPPO API VERSION Optional header to specify a non-default version of the Shippo API to use for this request

Output

The node outputs JSON data representing the registration status of the specified carrier account. The structure typically includes details about whether the carrier account is registered, any relevant status messages, and possibly metadata related to the carrier account.

If the node supports binary data output (not indicated here), it would generally relate to documents or files returned by the API, but this node focuses on JSON responses about carrier registration status.

Dependencies

  • Requires an API key credential for authenticating with the Shippo API.
  • The node sends requests to https://api.goshippo.com.
  • Optionally supports specifying the Shippo API version via a custom header.
  • No additional external dependencies beyond the Shippo API and n8n's HTTP request capabilities.

Troubleshooting

  • Common issues:

    • Invalid or missing API key will cause authentication errors.
    • Selecting a carrier not supported or misspelling the carrier name may result in errors or empty responses.
    • Using an unsupported or incorrect API version string could lead to unexpected API errors.
  • Error messages:

    • Authentication failures: Check that the API key credential is correctly configured and has necessary permissions.
    • "Carrier not found" or similar: Verify the carrier property value matches one of the allowed options exactly.
    • API version errors: Ensure the SHIPPO API VERSION property is either left blank or set to a valid version string per Shippo’s documentation.

Links and References

Discussion