Skip to main content

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.

Required scope: integrations:read

Grant 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​

OK

Response Headers
    Content-Type