Sign in

v1

latestOpenAPI 3.1.02026-07-2277219695.0 KB
Carrier Accounts

Update a carrier account

Updates an existing carrier account object. The account_id and carrier can't be updated. This is because they form the unique identifier together.

put/carrier_accounts/{CarrierAccountId}

Path parameters

CarrierAccountIdstring required

Object ID of the carrier account

Headers

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

Optional string used to pick a non-default API version to use. See our API version guide.

Request body

account_idstring required

Unique identifier of the account. Please check the carrier accounts tutorial page for the account_id per carrier. 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 Carriers Please check the carrier accounts tutorial page for all supported carriers.

Example request

{
  "account_id": "****",
  "carrier": "usps",
  "parameters": {
    "verification_invoice_amount": "340",
    "verification_invoice_date": "2024-03-09",
    "verification_invoice_currency": "USD"
  }
}

Response

Carrier account

account_idstring required

Unique identifier of the account. Please check the carrier accounts tutorial page for the account_id per carrier. 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 Carriers Please check the carrier accounts tutorial page for all supported carriers.

carrier_namestring

Carrier name, see Carriers

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
    }
  ]
}