Skip to main content

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
DefinitionSeverityAPISampleMode
Validate that a new brand does not exactly match any existing brand
VIOLATION
POST_AND_PUT
S

Configuration

FeaturePropertyAdditional Match Constraints
countryCodesN/AMatches at least one comma-separated value
displayNamesnameprimary = 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​

DefinitionSeverityAPISampleMode
Validate that the count of brands does not exceed threshold for the organization type
VIOLATION
POST_AND_PUT
S
Organization TypeMaximum
Agency (Undelegated third-party partner)10,000
Owner (Organization brand and location owner)1,000

Brand Details​

BrandDetailsMustBePresent​

DefinitionSeverityAPISampleMode
Validate that brandDetails is present
VIOLATION
POST_AND_PUT
S

Ownership Type​

OwnershipTypeMustBePresent​

Preconditions
Organization is location owner
DefinitionSeverityAPISampleMode
Validate that ownershipType is not an empty string
VIOLATION
POST_AND_PUT
S

OwnershipTypeMustBeValid​

DefinitionSeverityAPISampleMode
Validate that ownershipType is valid
VIOLATION
POST_AND_PUT
Link
S

OwnershipTypeMustNotBeEmpty​

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

Partners Brand ID​

PartnersBrandIdAlreadyExists​

DefinitionSeverityAPISampleMode
Validate that partnersBrandId is not associated with another brand
WARNING
POST_AND_PUT
S

PartnersBrandIdMustNotBeEmpty​

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