Contents

BrandQueryResponse

The Query Brands endpoint returns this response object.

Declaration

object BrandQueryResponse

Properties

NameTypeDescription
result[Brand]

Array of Brand objects matching the query. Empty array if no brands 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 Query Brands returns BrandQueryResponse as the top-level envelope. The result array contains all Brand objects that match the supplied filters, subject to pagination. To page through large result sets, use pagination.totalCount and pagination.offset.

Example

{
  "result": [
    {
      "id": "123456789",
      "name": "AwayFinder",
      "countryOrRegion": "US",
      "categories": [
        "shopping.retail",
        "dining.restaurant"
      ],
      "eligibility": {
        "status": "ELIGIBLE",
        "blockedGroups": [],
        "allowedGroups": [],
        "modificationTime": "2025-01-10T08:00:00.000"
      },
      "creationTime": "2025-01-10T08:00:00.000",
      "modificationTime": "2025-01-10T08:00:00.000"
    }
  ],
  "pagination": {
    "offset": 0,
    "pageSize": 20,
    "totalCount": 1
  }
}

See Also