Get Location Group

Gets a location group by code.

GET /commerce/admin/locationGroups/{locationGroupCode}

Error

A valid request URL is required to generate request examples

200

{
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "locationCodes": [
    "<string>"
  ],
  "locationGroupCode": "<string>",
  "locationGroupId": 123,
  "name": "<string>",
  "siteIds": [
    123
  ]
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

locationGroupCode · string · required

Query Parameters

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

Success

auditInfo · object

Show child attributes

locationCodes · string[] | null

locationGroupCode · string | null

locationGroupId · integer<int32>

name · string | null

siteIds · integer<int32>[] | null