Migrating from Platform API to Shippo API

If you already use the Shippo for Platforms API to support your merchants, you may choose to update your integration to take advantage of the Shippo API. Follow this guide to learn how.

Change your Base URL

Previously, Shippo for Platforms used the base URL https://platform-api.goshippo.com. To use the Shippo API, change your base URL to https://api.goshippo.com/.

Reference Merchants using a header, not a parameter

Previously, you referenced merchants using a parameter, for example:

curl https://platform-api.goshippo.com/merchants/{MerchantId}/addresses/

where {MerchantId} is the object ID of your merchant.

To use Managed Shippo Accounts in the Shippo API, you reference your Managed Account merchant using a header element. For example:

curl https://api.goshippo.com/addresses/ -H 'SHIPPO-ACCOUNT-ID: adcfdddf8ec64b84ad22772bce3ea37a'

where SHIPPO-ACCOUNT-ID is the object ID of your Managed Account merchant.

Renamed endpoints

The following endpoints have changed. Follow the examples in our reference documentation to update your integration.

• Merchant has been updated to Shippo Accounts .
• Carrier Own Accounts has been updated to Carrier Accounts .
• Shippo Carrier Accounts has been updated and is now part of Carrier Accounts .

Example

To list all the address stored in a merchant’s account

curl https://api.goshippo.com/addresses/ \
  -H 'Authorization: ShippoToken <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -H 'SHIPPO-API-VERSION: string' \
  -H 'SHIPPO-ACCOUNT-ID: <ShippoAccountID>'

curl https://platform-api.goshippo.com/merchants/{MerchantId}/addresses/ \
  -H 'Authorization: ShippoToken <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -H 'SHIPPO-API-VERSION: string'