Contents

BrandResponse

The Get Brand by ID endpoint returns this response object.

Declaration

object BrandResponse

Properties

NameTypeDescription
resultBrand

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

errorError

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

Discussion

The Get Brand by ID returns BrandResponse as the top-level envelope. On success, result contains a single Brand object. 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": "9151314442816847872",
    "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"
  }
}

See Also