API reference
- Getting Started with Your API
- SDKs and Toolkits
- Catalog Administration Overview
- GETGet Product Properties
- POSTAdd Product Property
- GETGet Product Property
- PUTUpdate Product Property
- DELDelete Product Property
- GETGet Product Property Localized Contents
- PUTUpdate Product Property Localized Content
- POSTAdd Product Property Localized Content
- GETGet Product Property Localized Content by Locale
- PUTUpdate Product Property Localized Content by Locale
- DELDelete Product Property Localized Content by Locale
- GET
A valid request URL is required to generate request examples{
"attributeFQN": "<string>",
"values": [
{
"value": "<unknown>",
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"attributeVocabularyValueDetail": {
"valueSequence": 123,
"value": "<unknown>",
"mappedGenericValues": [
"<unknown>"
],
"productName": "<string>",
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"displayOrder": 123
}
}
],
"forceOrder": true
}Add Product Property
Add a property to a product. This current version of the Products API includes localizedContent to support multi-locale catalogs, which was not present in the previous API model. If you were a client prior to May 2024 and have upgraded your implementation to support this feature, you can still access product data that has not yet been rewritten to the new model by providing an x-api-version header set to “1”.
A valid request URL is required to generate request examples{
"attributeFQN": "<string>",
"values": [
{
"value": "<unknown>",
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"attributeVocabularyValueDetail": {
"valueSequence": 123,
"value": "<unknown>",
"mappedGenericValues": [
"<unknown>"
],
"productName": "<string>",
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"displayOrder": 123
}
}
],
"forceOrder": true
}Authorizations
JWT Authorization header using the Bearer scheme.
Path Parameters
Query Parameters
limits which fields are returned in the response body
Body
Product options for configurable or stand-alone products. A configurable option is one that the shopper chooses when ordering, for example, the color of a T-shirt. A stand-alone option is independent of the product and can be added to the product order. For example, a monogram.
Response
Success
Product options for configurable or stand-alone products. A configurable option is one that the shopper chooses when ordering, for example, the color of a T-shirt. A stand-alone option is independent of the product and can be added to the product order. For example, a monogram.