Validation rules for brand metadata including matching, count limits, ownership types, and partner brand IDs
Brand
BrandIsMatched
| Preconditions |
|---|
partnersBrandId and partnersBrandVersion excluded from match process |
| Definition | Severity | API | Sample | Mode |
|---|---|---|---|---|
| Validate that a new brand does not exactly match any existing brand |
Configuration
| Feature | Property | Additional Match Constraints |
|---|---|---|
countryCodes | N/A | Matches at least one comma-separated value |
displayNames | name | primary = true |
Example Validation Report
{
"code": "VALIDATION__BrandIsMatched",
"severity": "VIOLATION",
"message": "Primary Display Name and country matches another brand",
"details": {
"createdDate": "2026-11-10T11:36:02.00Z",
"compared": [
{
"field": "$.id",
"value": "9467895078742654921"
},
{
"field": "$.id",
"value": "1514799944190787298"
}
],
"expected": [],
"submitted": []
}
}
CountOfBrandsMustNotExceedMaximum
| Definition | Severity | API | Sample | Mode |
|---|---|---|---|---|
| Validate that the count of brands does not exceed threshold for the organization type |
| Organization Type | Maximum |
|---|---|
| Agency (Undelegated third-party partner) | 10,000 |
| Owner (Organization brand and location owner) | 1,000 |
Brand Details
BrandDetailsMustBePresent
| Definition | Severity | API | Sample | Mode |
|---|---|---|---|---|
Validate that brandDetails is present |
Ownership Type
OwnershipTypeMustBePresent
| Preconditions |
|---|
| Organization is location owner |
| Definition | Severity | API | Sample | Mode |
|---|---|---|---|---|
Validate that ownershipType is not an empty string |
OwnershipTypeMustBeValid
| Definition | Severity | API | Sample | Mode |
|---|---|---|---|---|
Validate that ownershipType is valid | Link |
OwnershipTypeMustNotBeEmpty
| Definition | Severity | API | Sample | Mode |
|---|---|---|---|---|
Validate that ownershipType is not an empty string |
Partners Brand ID
PartnersBrandIdAlreadyExists
| Definition | Severity | API | Sample | Mode |
|---|---|---|---|---|
Validate that partnersBrandId is not associated with another brand |
PartnersBrandIdMustNotBeEmpty
| Definition | Severity | API | Sample | Mode |
|---|---|---|---|---|
Validate that partnersBrandId is not an empty string |