Skip to main content

Location brand validation rules for brand ID resolution and country code matching

Brand ID

Precondition applicable to all listed validations
brandId is present

BrandIdMustNotBeEmpty

DefinitionSeverityAPISampleMode
Validate that brandId is not an empty string
VIOLATION
POST_AND_PUT
S

BrandIdMustBeResolvable

DefinitionSeverityAPISampleMode
Validate that brandId is resolvable to an Apple-generated brand ID
VIOLATION
POST_AND_PUT
S

BrandReferencedByLocationRequiresReview

DefinitionSeverityAPISampleMode
Validate that the referenced brand is expected to be associated with a location
WARNING
POST_AND_PUT
S
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
DefinitionSeverityAPISampleMode
Validate that brandId is present
VIOLATION
POST_AND_PUT
S
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
DefinitionSeverityAPISampleMode
Validate that countryCode matches at least one (1) of the brand's listed countryCodes
VIOLATION
POST_AND_PUT
S