Actions68
- Parcels Actions
- Shipments Actions
- Rates Actions
- Transactions Actions
- Customs Items Actions
- Tracking Status Actions
- Batches Actions
- Orders Actions
- Pickups Actions
- Service Groups Actions
- Customs Declarations Actions
- Refunds Actions
- Manifests Actions
- Carrier Accounts Actions
- Webhooks Actions
- Carrier Parcel Templates Actions
- User Parcel Templates Actions
- Rates At Checkout Actions
- Shippo Accounts Actions
- Addresses Actions
Overview
This node operation initiates the OAuth 2.0 sign-in process for a specified carrier account within the Shippo platform. It is designed to start the authorization flow by redirecting the user to the carrier's authentication page, allowing them to grant access to their carrier account data securely.
Common scenarios where this node is beneficial include:
- Integrating third-party carrier accounts into your shipping workflow.
- Automating the connection and authorization of carrier services without manual intervention.
- Managing multiple carrier accounts that require OAuth-based authentication.
For example, if you want to connect a new carrier account to your Shippo integration, you would use this node to generate the authorization URL and handle the initial OAuth handshake.
Properties
| Name | Meaning |
|---|---|
| Carrier Account Object Id | The unique identifier (UUID) of the carrier account for which the OAuth 2.0 sign-in process will be initiated. This tells the system which carrier account to authenticate. |
| Redirect Uri | The callback URL where the authorization server will send the user after they approve or deny the authorization request. This URL must be able to handle the response from the OAuth server. |
| State | An optional random string generated by your application to prevent Cross-Site Request Forgery (CSRF) attacks. This value is sent with the request and should be verified upon receiving the response to ensure security. |
| SHIPPO API VERSION | Optional header to specify a non-default version of the Shippo API to use for this request. Useful if you need features or behavior from a specific API version. |
Output
The node outputs JSON data representing the response from the Shippo API when initiating the OAuth 2.0 sign-in process. This typically includes information such as the authorization URL or any tokens/parameters needed to continue the OAuth flow.
If the node supports binary data output, it would generally relate to downloadable content or files returned by the API, but in this case, the output is purely JSON related to OAuth initiation.
Dependencies
- Requires an active Shippo API key credential configured in n8n to authenticate requests.
- Depends on the Shippo API endpoint
https://api.goshippo.comfor initiating OAuth flows. - The node uses standard HTTP headers including
Accept: application/jsonandContent-Type: application/json. - Optionally supports specifying the Shippo API version via a custom header.
Troubleshooting
- Missing or invalid Carrier Account Object Id: Ensure the UUID provided is correct and corresponds to an existing carrier account in Shippo.
- Invalid Redirect URI: The redirect URI must exactly match one registered with the carrier or Shippo; otherwise, the OAuth server may reject the request.
- State mismatch errors: If using the state parameter, verify that the returned state matches the one sent to prevent CSRF issues.
- API version conflicts: Specifying an unsupported or deprecated API version may cause errors; check Shippo’s API version documentation.
- Authentication failures: Confirm that the API key credential is valid and has sufficient permissions.