Contents

LocationGroupQueryResponse

The response object returned by the Query Location Groups endpoint.

Declaration

object LocationGroupQueryResponse

Properties

NameTypeDescription
result[LocationGroup]

Array of LocationGroup objects matching the query. Empty array if none match. Read-only.

paginationQueryPaginationResult

Pagination metadata for the result set. See QueryPaginationResult. Read-only.

errorError

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

Discussion

The LocationGroupQueryResponse object is the top-level envelope returned by Query Location Groups. The result array contains all LocationGroup objects that match the supplied filters, subject to pagination. Use pagination.totalCount and pagination.offset to page through large result sets.

Example

{
  "result": [
    {
      "id": "5764607523034238976",
      "name": "AwayFinder West Coast Stores",
      "brandId": "9151314442816847872",
      "groupType": "DYNAMIC",
      "systemStatus": "VALID",
      "groupTotal": 42,
      "isAllLocationsGroup": false,
      "eligibility": {
        "status": "ELIGIBLE"
      },
      "creationTime": "2025-02-01T09:00:00.000",
      "modificationTime": "2025-03-25T16:00:00.000"
    }
  ],
  "pagination": {
    "totalCount": 1,
    "offset": 0,
    "pageSize": 100
  }
}

See Also