Get your Carrier Account Details

There are two ways to use a carrier account with Shippo.

The first is to use Shippo's account with your preferred carrier to create shipping labels. Using Shippo's account makes it easier to get started and means you benefit from the shipping discounts that Shippo has negotiated with the carrier.

The second way is to use your own account with your preferred carrier and share your account details with Shippo. This is useful if you have negotiated your own shipping discounts with your preferred carrier. You can still use all the supported Shippo features.

Use the Shippo carrier account

To use the Shippo, Colissimo account, you must retrieve the carrier account object_id. This step should only be completed once. In future transactions, you can use the carrier object_id to reference your carrier.

HTTP Method

GET

URL

Copy

Copied

https://api.goshippo.com/carrier_accounts/

Example

Request Sample

Copy

Copied

  curl --location --request GET 'https://api.goshippo.com/carrier_accounts?carrier=colissimo' \
  --header 'Authorization: ShippoToken shippo_live_******' \
  --header 'Content-Type: application/json'

Response Sample

Copy

Copied

{
  "carrier": "colissimo",
  "object_id": "4a4dfb5425ea41b6be2e851306284bf5",
  "object_owner": "test-user@shippo.com",
  "account_id": "shippo_colissimo_account",
  "parameters": {},
  "test": false,
  "active": true,
  "is_shippo_account": true,
  "metadata": "",
  "carrier_name": "Colissimo",
  "carrier_images": {
    "75": "https://shippo-static.s3.amazonaws.com/providers/75/colissimo.png",
    "200": "https://shippo-static.s3.amazonaws.com/providers/200/colissimo.png"
  }
}

Note: If you did not receive a response like this, the carrier may not have been enabled for your account. Contact Shippo support for more infomation.

Once you have retrieved the object_id for your carrier, proceed to Step 2: Create shipment.

Use your own carrier account

If you want to use your own Colissimo account, follow this guide to add your Colissimo account to Shippo. After adding your account, Shippo can use your account details for generating shipping rates and creating labels. This step requires you to have your Colissimo account id and password.

This step should only be completed once. When you have created your carrier account, you can use the carrier object_id to reference your carrier.

HTTP Method

POST

URL

Copy

Copied

https://api.goshippo.com/carrier_accounts/

Request Payload

Parameter	Description
carrier*	`colissimo`
account_id*	A unique identifier for the account which cannot be changed later. This should be a username provided by Colissimo
parameters*	parameters is an array of additional parameters for the account, such as password or token. Check Colissimo parameters for more details
active	Set to `true` to enable account. Set to `false` to disable account.
test	Set to `true` if you want to set the account in test mode. Using test mode you can generate test labels without incurring a charge

Copy

Copied

Note: Parameters with an * are mandatory

Colissimo Account Parameters

Parameter	Description
password*	Password to access the API. Password and account_id are tied together and should be provided by Colissimo

Response Code

201

Example

Request Sample

Copy

Copied

curl --location --request POST 'https://api.goshippo.com/carrier_accounts/' \
--header 'Authorization: ShippoToken shippo_live_******' \
--header 'Content-Type: application/json' \
--data-raw '{
   "carrier": "colissimo",
   "account_id": "collisimo_account",
   "parameters": {
       "password": "EXAMPLE_PASSWORD",
   },
   "active": true,
   "test": true
}'

Response Sample

Copy

Copied

{
    "carrier": "colissimo",
    "object_id": "4a4dfb5425ea41b6be2e851306284bf5",
    "object_owner": "test-user@shippo.com",
    "account_id": "******",
    "parameters": {
        "password": "******"
    },
    "test": true,
    "active": true,
    "is_shippo_account": false,
    "metadata": "",
    "carrier_name": "Colissimo",
    "carrier_images": {
        "200": "https://dev-qa-static-shippodev-com.s3.amazonaws.com/providers/200/colissimo.png",
        "75": "https://dev-qa-static-shippodev-com.s3.amazonaws.com/providers/75/colissimo.png"
    }
}

Once you have retrieved the object_id for your carrier, proceed to Step 2: Create shipment.