List Customer Accounts
GET/api/shiphero/integration-instances/:integrationInstance/customer-accounts
List the client (customer) accounts the connection's ShipHero login can see, read live from ShipHero.
integrations:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Requires the integrations.show permission.
A 3PL-level login (is_three_pl: true) can see all of its clients; pick one as integration_settings.asn.customer_account_id (the account id) so purchase orders are filed under that client. A brand login returns is_three_pl: false and no accounts, and needs no customer account.
Accounts are sorted by name (name is the ShipHero username, falling back to the email). When ShipHero can't be reached, the response is still 200 with is_three_pl: null, no accounts, and a ShipheroUnreachable warning under warnings.customer_accounts.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.