Connect an existing carrier account using OAuth 2.0

Used by client applications to setup or reconnect an existing carrier account with carriers that support OAuth 2.0

SecurityAPIKeyHeader
Request
path Parameters
CarrierAccountObjectId
required
string

The carrier account ID (UUID) to start a signin process.

query Parameters
redirect_uri
required
string <uri>

Callback URL. The URL that tells the authorization server where to send the user back to after they approve the request.

state
string

A random string generated by the consuming application and included in the request to prevent CSRF attacks. The consuming application checks that the same value is returned after the user authorizes Shippo.

header Parameters
SHIPPO-API-VERSION
string

String used to pick a non-default API version to use

Example: 2018-02-08
Responses
302

Redirects the browser to the carrier login page, with the needed parameters

400

Invalid parameters provided by the user

401

Invalid ShippoToken or unsupported carrier account provided by the user

404

Invalid carrier account provided by the user

get/carrier_accounts/{CarrierAccountObjectId}/signin/initiate
Request samples 
curl "https://api.goshippo.com/carrier_accounts/2ccf5af209bb484cb20190d9cadbb61c/signin/initiate?redirect_uri=https://client.example.com/cb&state=SplxlOBeZQQYbYS6WxSbIA" \
-H "Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396"
Response samples
application/json
{
  • "title": "Missing required parameter",
  • "detail": "redirect_uri"
}