Contents

LocationGroupResponse

The response object returned by the Get Location Group endpoint.

Declaration

object LocationGroupResponse

Properties

NameTypeDescription
resultLocationGroup

The retrieved LocationGroup object. Omitted from the response entirely if no location group was found (see the 404 case above), rather than being present as null. Read-only.

errorError

Error details if the request failed. Absent on success. See Error. Read-only.

Discussion

The LocationGroupResponse object is the top-level envelope returned by Get Location Group. On success, result contains a single LocationGroup. On failure (for example, 404 Not Found), the response contains only the error object. The response omits the result key entirely rather than setting it to null.

Example

{
  "result": {
    "id": "5764607523034238976",
    "name": "AwayFinder West Coast Stores",
    "brandId": "9151314442816847872",
    "adAccountId": "293897290",
    "groupType": "DYNAMIC",
    "systemStatus": "VALID",
    "rules": [
      {
        "field": "adminArea",
        "operator": "IN",
        "value": [
          "California",
          "Oregon",
          "Washington"
        ]
      }
    ],
    "groupTotal": 42,
    "isAllLocationsGroup": false,
    "description": "All AwayFinder locations on the West Coast",
    "creationTime": "2026-02-01T09:00:00Z",
    "modificationTime": "2026-03-25T16:00:00Z",
    "eligibility": {
      "status": "ELIGIBLE"
    }
  }
}

See Also