🎉 ShipEngine is becoming ShipStation API 🎉

Over the next few months you'll notice the ShipEngine website, documentation portal, and dashboard being rebranded as ShipStation API. For our ShipEngine customers, you don't need to take any action or change any of your integrations in any way. All endpoints will remain the same and continue to function as they always have.

To learn more about what's coming, review our New ShipStation API page.

Get External Accounts By ID

This endpoint allows you to retrieve a specific ShipStation API account using its external_account_id, which is your own unique ID for the account. This saves you from needing to store our ShipStation API ID for each account.

Example Request & Response

GET /v1/partners/accounts/external_account_id/:external_account_id

1
2
3
GET /v1/partners/accounts/external_account_id/819748723192 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Example response:

1
2
3
4
5
6
7
8
9
10
11
12
{
  "account_id": 123456,
  "external_account_id": "819748723192",
  "created_at": "2022-12-04T23:06:39.197Z",
  "modified_at": "2022-12-04T23:06:39.197Z",
  "active": true,
  "email": "[email protected]",
  "company_name": "Acme Corp.",
  "first_name": "John",
  "last_name": "Doe",
  "origin_country_code": "US"
}