Skip to main content

Validation rules for brand display names including locale, name content, primary flags, and uniqueness constraints

Display Names

DisplayNamesMustBePresent

DefinitionSeverityAPISampleMode
Validate that displayNames are present
VIOLATION
POST_AND_PUT
Link
S
Example Validation Report
{
"code": "VALIDATION__DisplayNamesMustBePresent",
"severity": "VIOLATION",
"message": "Field '{{field}}' must be present",
"context": {
"field": "displayNames"
}
}

Locale

DisplayNamesLocaleMustBePresent

DefinitionSeverityAPISampleMode
Validate that locale is present
VIOLATION
POST_AND_PUT
Link
S
Example Validation Report
{
"code": "VALIDATION__DisplayNamesLocaleMustBePresent",
"severity": "VIOLATION",
"message": "Field '{{field}}' must be present",
"context": {
"field": "locale"
},
"details": {
"createdDate": "2026-02-10T11:36:02.00Z",
"submitted": [
{
"field": "$.brandDetails.displayNames[0]"
}
],
"compared": [],
"expected": []
}
}

DisplayNamesLocaleMustBeValid

DefinitionSeverityAPISampleMode
Validate that locale is valid
VIOLATION
POST_AND_PUT
Link
S

DisplayNamesLocaleMustNotBeEmpty

DefinitionSeverityAPISampleMode
Validate that locale is not an empty string
VIOLATION
POST_AND_PUT
S
Example Validation Report
{
"code": "VALIDATION__DisplayNamesLocaleMustNotBeEmpty",
"severity": "VIOLATION",
"message": "'locale' must not be empty string"
}

Name

DisplayNamesNameMustBePresent

DefinitionSeverityAPISampleMode
Validate that name is present
VIOLATION
POST_AND_PUT
Link
S
Example Validation Report
{
"code": "VALIDATION__DisplayNamesNameMustBePresent",
"severity": "VIOLATION",
"message": "Field '{{field}}' must be present",
"context": {
"field": "name"
},
"details": {
"createdDate": "2026-02-10T11:36:02.00Z",
"submitted": [
{
"field": "$.brandDetails.displayNames[0]"
}
],
"compared": [],
"expected": []
}
}

DisplayNamesNameMustNotBeDummyCharacters

DefinitionSeverityAPISampleMode
Validate that name is not dummy characters
VIOLATION
POST_AND_PUT
Link
S
Example Validation Report
{
"code": "VALIDATION__DisplayNamesNameMustNotBeDummyCharacters",
"severity": "VIOLATION",
"message": "'{{value}}' in '{{field}}' is dummy characters",
"context": {
"field": "name",
"value": "No value"
},
"details": {
"createdDate": "2026-02-10T11:36:02.00Z",
"submitted": [
{
"field": "$.brandDetails.displayNames[0].name",
"value": "No value"
}
],
"compared": [],
"expected": []
}
}

DisplayNamesNameMustNotBeEmpty

DefinitionSeverityAPISampleMode
Validate that name is not an empty string
VIOLATION
POST_AND_PUT
Link
S
Example Validation Report
{
"code": "VALIDATION__DisplayNamesNameMustNotBeEmpty",
"severity": "VIOLATION",
"message": "'name' must not be empty"
}

DisplayNamesNameHasUnsupportedCharacter

DefinitionSeverityAPISampleMode
Validate that name does not include an unsupported character
VIOLATION
POST_AND_PUT
Link
S
Example Validation Report
{
"code": "VALIDATION__DisplayNamesNameHasUnsupportedCharacter",
"severity": "VIOLATION",
"message": "'{{field}}' has unsupported character",
"context": {
"field": "name"
},
"details": {
"createdDate": "2026-02-10T11:36:02.00Z",
"submitted": [
{
"field": "$.brandDetails.displayNames[0].name",
"value": "Bob's Burgers\n"
}
],
"compared": [],
"expected": []
}
}

DisplayNamesNameMustNotIncludeURL

DefinitionSeverityAPISampleMode
Validate that name does not include a URL
VIOLATION
POST_AND_PUT
Link
S
Example Validation Report
{
"code": "VALIDATION__DisplayNamesNameMustNotIncludeURL",
"severity": "VIOLATION",
"message": "'{{field}}' is '{{value}}' and includes URL",
"context": {
"field": "name",
"value": "Walmart (https://www.walmart.com)"
},
"details": {
"createdDate": "2026-02-10T11:36:02.00Z",
"submitted": [
{
"field": "$.brandDetails.displayNames[0].name",
"value": "Walmart (https://www.walmart.com)"
}
],
"compared": [],
"expected": []
}
}

DisplayNamesNameMustNotIncludeVulgarWord

DefinitionSeverityAPISampleMode
Validate that name does not include a vulgar word
VIOLATION
POST_AND_PUT
A

DisplayNamesNameLengthMustNotExceedMaximum

DefinitionSeverityAPISampleMode
Validate that name length does not exceed a maximum value (255)
VIOLATION
POST_AND_PUT
Link
S

DisplayNamesNameMustNotMatchBrandInSameCountry

DefinitionSeverityAPISampleMode
Validate that each primary name (distinct locale) does not match any other Brand's name with the same countryCodes value
VIOLATION
POST_AND_PUT
Link
S

Primary Flag

AtLeastOnePrimaryNameMustBePresent

DefinitionSeverityAPISampleMode
Validate that at least one (1) primary is present
VIOLATION
POST_AND_PUT
S

DisplayNamesPrimaryMustBePresent

DefinitionSeverityAPISampleMode
Validate that primary is present
VIOLATION
POST_AND_PUT
Link
S

MustHaveOnlyOnePrimaryNamePerLocale

DefinitionSeverityAPISampleMode
Validate that no more than one (1) locale is primary
VIOLATION
POST_AND_PUT
S