Skip to content
Stella ConnectDocs
Commerce

List contact locations

GET{baseUrl}/v1.0/commerce/contact-locations/{ContactCompanyKey}

Returns all locations for a contact company. Pass ContactCompanyLocationKey from these results to ListContacts.

Authx-api-key

Field
Type
Required
ContactCompanyKeyuuidYes

Status
When
200

Success

400

Validation failed or the request was malformed.

401

Unauthorized

500

An unexpected error occurred on the server.

Field
Type
Required
Description
dataobject | nullNo
data.items[]object[]No
data.items[].contactCompanyLocationKeyuuidNo

Unique identifier for this contact company location

data.items[].namestringNo

Display name for this location

data.items[].isTaxExemptbooleanNo

Whether this location is exempt from tax calculations

data.items[].paymentTermKeyuuidNo

Identifier for the payment terms applied to this location

data.items[].priceTierKeyuuid | nullNo

Identifier for the price tier applied to this location, or null if using default pricing

data.items[].isLinkedToStellaCompanybooleanNo

Whether this contact location is linked to a supplier company in Stella

data.items[].locationobjectNo

Physical address details for this location

data.items[].location.addressLine1stringNo

Street address line 1

data.items[].location.addressLine2string | nullNo

Street address line 2, if provided

data.items[].location.localitystringNo

City or locality

data.items[].location.stateOrProvincestringNo

State or province

data.items[].location.postalCodestringNo

Postal or ZIP code

data.items[].location.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": {
    "items": [
      {
        "contactCompanyLocationKey": "fc0f0a87-2a40-49cb-9ccc-ca8f9afb1895",
        "name": "string",
        "isTaxExempt": true,
        "paymentTermKey": "397609a9-09e3-43d8-becb-25d341403943",
        "priceTierKey": "ef468774-cfd9-4c52-8876-5ff48279511d",
        "isLinkedToStellaCompany": true,
        "location": {
          "addressLine1": "string",
          "addressLine2": "string",
          "locality": "string",
          "stateOrProvince": "string",
          "postalCode": "string",
          "country": "string"
        }
      }
    ]
  },
  "errors": [
    {
      "description": "string",
      "errorId": "string"
    }
  ],
  "paging": {
    "limit": 0,
    "start": 0,
    "total": 0
  }
}