Location brand validation rules for brand ID resolution and country code matching
Brand ID
| Precondition applicable to all listed validations |
|---|
brandId is present |
BrandIdMustNotBeEmpty
| Definition | Severity | API | Sample | Mode |
|---|---|---|---|---|
Validate that brandId is not an empty string |
BrandIdMustBeResolvable
| Definition | Severity | API | Sample | Mode |
|---|---|---|---|---|
Validate that brandId is resolvable to an Apple-generated brand ID |
BrandReferencedByLocationRequiresReview
| Definition | Severity | API | Sample | Mode |
|---|---|---|---|---|
| Validate that the referenced brand is expected to be associated with a location |
Example Validation Report
{
"code": "VALIDATION__BrandReferencedByLocationRequiresReview",
"severity": "WARNING",
"message": "Brand ID '{{brandId}}' referenced by location requires review",
"context": {
"brandId": "9467895078742656755"
}
}
LocationMustHaveBrandId
| Preconditions |
|---|
orgId resolves to organization that is location owner |
| Definition | Severity | API | Sample | Mode |
|---|---|---|---|---|
Validate that brandId is present |
Example Validation Report
{
"code": "VALIDATION__LocationMustHaveBrandId",
"severity": "VIOLATION",
"message": "'{{field}}' must be present",
"context": {
"field": "brandId"
},
"details": {
"compared": [],
"expected": [
{
"field": "$.locationDetails.brandId"
}
],
"submitted": [],
"createdDate": "2026-03-03T13:58:43.946Z"
}
}
Cross-feature
CountryCodeMustMatchBrandCountryCodes
| Preconditions |
|---|
structuredAddress is present |
| Definition | Severity | API | Sample | Mode |
|---|---|---|---|---|
Validate that countryCode matches at least one (1) of the brand's listed countryCodes |