Skip to content
Stella ConnectDocs
Commerce

List company locations

GET{baseUrl}/v1.0/commerce/company-locations

Returns all active locations. Use the returned Key values as CompanyLocationKey path parameters in downstream contact and product endpoints.

Authx-api-key

Status
When
200

Success

400

Validation failed or the request was malformed.

401

Unauthorized

403

Forbidden

500

An unexpected error occurred on the server.

Field
Type
Required
Description
dataobject | nullNo
data.locations[]object[]No
data.locations[].keyuuidNo

Unique identifier for the company location

data.locations[].namestringNo

Display name of the location

data.locations[].aliasstringNo

Short alias or code for the location

data.locations[].isPrimarybooleanNo

Whether this is the primary location for the company

data.locations[].phoneNumberstringNo

Phone number for this location

data.locations[].addressLine1stringNo

Street address line 1

data.locations[].addressLine2string | nullNo

Street address line 2, if provided

data.locations[].localitystringNo

City or locality

data.locations[].stateOrProvincestringNo

State or province

data.locations[].postalCodestringNo

Postal or ZIP code

data.locations[].countrystringNo

Country code

errors[]object[] | nullNo

One or more errors describing why the request failed. Absent (null) on success.

errors[].descriptionstring | nullNo

Human-readable explanation of the error. Intended for display to end users or logs. Wording is not stable and should not be branched on.

errors[].errorIdstring | nullNo

Machine-readable, stable error identifier. Consumers should branch on this value rather than on Description. See ConnectErrorIds for the catalog.

pagingobject | nullNo

Paging metadata for list endpoints. Absent on single-item responses.

paging.limitintegerNo
paging.startintegerNo
paging.totalintegerNo

Example 200 response
{
  "data": {
    "locations": [
      {
        "key": "4adfe27e-63d3-45b9-8238-62b6ed6fdb5e",
        "name": "string",
        "alias": "string",
        "isPrimary": true,
        "phoneNumber": "string",
        "addressLine1": "string",
        "addressLine2": "string",
        "locality": "string",
        "stateOrProvince": "string",
        "postalCode": "string",
        "country": "string"
      }
    ]
  },
  "errors": [
    {
      "description": "string",
      "errorId": "string"
    }
  ],
  "paging": {
    "limit": 0,
    "start": 0,
    "total": 0
  }
}