Sign in

v1

latestOpenAPI 3.1.02026-07-1270243932.3 KB
Carrier Accounts

Add a Shippo carrier account

Adds a Shippo carrier account

post/carrier_accounts/register/new

Headers

SHIPPO-API-VERSIONstring
Example:2018-02-08

Optional string used to pick a non-default API version to use. See our <a href="https://docs.goshippo.com/docs/api_concepts/apiversioning/">API version</a> guide.

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "parameters": {
    "company": "Shippo",
    "email": "hippo@shippo.com",
    "full_name": "Shippo Meister",
    "phone": "1112223333"
  }
}

Response

Carrier account

account_idstring required

Unique identifier of the account. Please check the <a href="https://docs.goshippo.com/docs/carriers/carrieraccounts/">carrier accounts tutorial</a> page for the account_id per carrier.<br> To protect account information, this field will be masked in any API response.

activeboolean

Determines whether the account is active. When creating a shipment, if no carrier_accounts are explicitly passed Shippo will query all carrier accounts that have this field set. By default, this is set to True.

carrierstring required

Carrier token, see <a href="/shippoapi/public-api/carriers">Carriers</a><br> Please check the <a href="https://docs.goshippo.com/docs/carriers/carrieraccounts/">carrier accounts tutorial</a> page for all supported carriers.

carrier_namestring

Carrier name, see <a href="/shippoapi/public-api/carriers">Carriers</a><br>

is_shippo_accountboolean
metadatastring
object_idstring

Unique identifier of the carrier account object.

object_ownerstring

Username of the user who created the carrier account object.

testboolean

Indicates whether the object has been created in test mode.

Example response

{
  "account_id": "****",
  "carrier": "usps",
  "parameters": {
    "verification_invoice_amount": "340",
    "verification_invoice_date": "2024-03-09",
    "verification_invoice_currency": "USD"
  },
  "carrier_name": "USPS",
  "object_id": "6aa34d5f6865448fbb1ee93636e98999",
  "object_owner": "bob+22@gmail.com",
  "service_levels": [
    {
      "name": "Priority Mail Express",
      "token": "usps_priority_express",
      "supports_return_labels": true
    }
  ]
}