Get Domains

Prev Next
Get
/amazeApiRest/rest/v1/catalogs/1/domains

The GET Domains API retrieves the list of domains configured in Product Content Cloud, including their attributes, records, relationships, digital assets, and metadata. This endpoint is used to view domain structures and current domain content, supporting validation, synchronization, UI rendering, and downstream integrations that rely on domain-based data models. 

Header parameters
X-Access-Token
string
ExampleAHiWIfzgk1agkj29iosfL47m1ZEE30lEXbZksjCF7BhZTh1pQz220S70
X-Customer-Code
string
ExampleAPITST
X-Oauth-Provider
string
ExampleCODIFYD
Content-Type
string
Exampleapplication/json
X-Requested-With
string
ExampleXMLHttpRequest
x-authorization-mode
string
Examplepassword
X-Client-Secret
string
Example6CHewppLoyVJIVwDAkwEG9J1SRySiISh
Responses
200

Successful response

Response Parameters

domainNameBaseLocale (string)

Name of the domain (“Brands”, "Manufacturers").
Domains often represent custom business-specific classification. 


domainNameBaseLocale (string) 

Language/locale code for the domain name.
Example: 
"en_us"


isRestrictedValueList (string) 

Whether domain attributes must use predefined values from a list of values (LOV).

  • "true" → attributes must use values defined in attributeListOfValues.


product360DisplayLocation (string) 

Indicates to the PCC system in which section or tab of the Product360 screen should show the attributes and records belonging to this domain. 
Examples: 
"Individual Tab".


PCCKeyDomainIdentifier 

Internal unique domain identifier used in PCC (Product Content Cloud).

Domain Attribute Definition Parameters

Each entry inside domainAttributes describes the schema of an attribute.

attributeName (string) 

Name of the attribute (e.g., “brand impression”, “Tag line”).


attributeDataType

Expected datatype.
Examples:

  • "String"

  • "DateTime"


attributeConstraintIsRequired (string)

Whether this attribute is mandatory.


attributeConstraintEnforceDataType (string) 

Whether the system enforces that the value matches the datatype.


attributeConstraintAllowMultivalue (string) 

Specifies whether a single record is allowed to store more than one value for this attribute.

If this setting is enabled, the attribute can behave like a multi-select field, allowing the record to hold multiple entries of the same attribute instead of being limited to just one. 


attributeConstraintEnforceListOfValue (string) 

Whether values must be chosen from the list of values (LOV).


attributeListOfValues (string) 

Predefined allowed values for this attribute.
Each LOV entry includes:

  • displayOrder – ordering in dropdown.

  • valueInList – allowed value (sometimes missing, meaning the LOV is defined but empty).

Domain Record-Level Parameters

Domain records represent actual data entries for the domain.

domainRecord (string) 

Primary identifier for the record (e.g., "Adidas", "Nike").


recordAttributes (string) 

Field values stored for that record.
Each item includes:

  • attributeNamewhich attribute this value belongs to

  • attributeData – the actual value assigned
     Because multivalue is allowed, you may see the same attribute repeated with different values.


recordDigitalAssets (string)

Assets attached to this specific record (images, videos, etc.).

Digital Asset Parameters

Whether at domain-level or record-level, digital assets follow the same structure:

digitalAssetName (string) 

Name of the file.

digitalAssetType (string) 

Type/category of digital asset.
Examples: 
"Photo".

digitalAssetPublicUrl

Fully accessible public URL to the asset.

digitalAssetThumbnailPublicURL

URL of the thumbnail version of the asset.

isPrimary

Whether this is the primary (featured) asset.

Meta Fields

Domains can include metadata for categorization or rules.

domainMetaTags

Tags attached to the domain.
Each includes:

  • name – tag name

  • description – what the tag means


domainMetaAttributes

Attributes that provide metadata about the entire domain.
Each includes:

  • domainMetaAttributeName

  • domainMetaAttributeDescription

  • domainMetaAttributeValue


domainDigitalAssets

Digital assets attached to the domain as a whole (not record-specific).