List Location Codes
GET/api/spscommerce/:integrationInstance/location-codes
List the connection's location directory: the name and address behind each trading partner's location (store / DC) code. When a purchase order names its ship-to only by a code, the address is filled from here.
integrations:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Filters:
- filter[search]: exact id, or partial trading partner, location code, DC code, name, address line 1, city or ZIP
- filter[<column>] / filter[<column>.<operator>] on id (numeric); trading_partner_id, location_code, distribution_center_code, name, address1, city, state, zip, country (text); created_at, updated_at (datetime)
- filter_groups: an AND/OR tree of conditions on the same columns
Allowed sorts: id, trading_partner_id, location_code, distribution_center_code, name, address1, city, state, zip, country, created_at, updated_at (prefix with - for descending; default trading_partner_id, location_code).
Pagination: page, per_page (default 10, max 100).
The response also carries unfiltered_total: every row of the connection, whatever the filters.
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.