# Attributes
GET /GetProductConfigurationAttributes
[
{
"InputWidth": 0,
"InputHeight": 0,
"ValueIsTranslatable": true,
"UseRichText": false,
"TranslatedUnit": {
"LocalizedValues": [
{
"LanguageId": 1,
"LocalizedVal": "String"
},
{
"LanguageId": 2,
"LocalizedVal": "String"
}
]
},
"UnitIsTranslatable": false,
"Uid": "9f100999-1c4a-451c-96d6-24d9e1f2abbc",
"Alias": "String",
"BackofficeName": "String",
"BackofficeDescription": "",
"Name": {
"LocalizedValues": [
{
"LanguageId": 1,
"LocalizedVal": "String"
},
{
"LanguageId": 2,
"LocalizedVal": "String"
}
]
},
"Description": {
"LocalizedValues": [
{
"LanguageId": 1,
"LocalizedVal": "String"
},
{
"LanguageId": 2,
"LocalizedVal": "String"
}
]
},
"WhichIsBetter": 5,
"Affiliation": 1,
"AttributeType": "TextAttribute",
"ShowIfEmpty": true
}
]
Request
Parameters: none
Response status OK (200)
Return value: Attribute[]
Attribute | ||
---|---|---|
Property name | Type | Description |
Uid | Guid | Unique identifier of attribute |
AttributeGroupId | int | Id of attribute group for attribute |
Alias | string | Alias of attribute |
BackofficeName | string | Name used in Umbraco backoffice for attribute |
BackofficeDescription | string | Description used in Umbraco backoffice for attribute |
Name | TranslatedValue | Translated values of attribute name |
Description | TranslatedValue | Translated values of attribute Description |
WhichIsBetter | int | Derived from enum value |
AttributeType | string | The attribute type |
TranslatedValue | ||
Property name | Type | Description |
LocalizedValues | LocalizedValue[] | List of translated names with language ids |
LocalizedValue | ||
Property name | Type | Description |
LanguageId | int | Unique id of language |
LocalizedVal | string | Value of variable type |
GET /GetAttributeGroups
[
{
"Id": 1,
"Alias": "String",
"Name": {
"LocalizedValues": [
{
"LanguageId": 1,
"LocalizedVal": "String"
},
{
"LanguageId": 2,
"LocalizedVal": "String"
}
]
},
"SortOrder": 0
}
]
Request
Parameters: none
Response status OK (200)
Return value: AttributeGroup[]
AttributeGroup | ||
---|---|---|
Property name | Type | Description |
Id | int | Unique id of attribute group |
Alias | string | Alias of attribute group |
Name | TranslatedValue | Translated values of attribute group name |
SortOrder | int | Sort order for attribute group |
TranslatedValue | ||
Property name | Type | Description |
LocalizedValues | LocalizedValue[] | List of translated names with language ids |
LocalizedValue | ||
Property name | Type | Description |
LanguageId | int | Unique id of language |
LocalizedVal | string | Value of variable type |
GET /GetSpecificationAttributes
[
{
"SubAttributes": [
{
"ValueIsTranslatable": false,
"UseRichText": false,
"TranslatedUnit": {
"LocalizedValues": [
{
"LanguageId": 1,
"LocalizedVal": "String"
},
{
"LanguageId": 2,
"LocalizedVal": "String"
}
]
},
"UnitIsTranslatable": false,
"Uid": "e27f762c-bc25-406b-8e1d-b2cf054c9559",
"Alias": "String",
"BackofficeName": "String",
"Name": {
"LocalizedValues": [
{
"LanguageId": 1,
"LocalizedVal": "String"
},
{
"LanguageId": 2,
"LocalizedVal": "String"
}
]
},
"Description": {
"LocalizedValues": [
{
"LanguageId": 1
},
{
"LanguageId": 2
}
]
},
"WhichIsBetter": 5,
"Affiliation": 0,
"AttributeType": "TextAttribute",
"ShowIfEmpty": true
},
{
"GlobalListId": 268,
"AllowMultipleValues": true,
"EnableTableView": false,
"ReferencedAttribute": {
"ValueIsTranslatable": false,
"UseRichText": false,
"TranslatedUnit": {
"LocalizedValues": [
{
"LanguageId": 1
},
{
"LanguageId": 2
}
]
},
"UnitIsTranslatable": false,
"Uid": "caf96248-edd6-4c05-8dd5-cd568ab3258d",
"Alias": "String",
"BackofficeName": "String",
"Name": {
"LocalizedValues": [
{
"LanguageId": 1,
"LocalizedVal": "String"
},
{
"LanguageId": 2,
"LocalizedVal": "String"
}
]
},
"Description": {
"LocalizedValues": [
{
"LanguageId": 1
},
{
"LanguageId": 2
}
]
},
"WhichIsBetter": 5,
"Affiliation": 2,
"AttributeType": "TextAttribute",
"ShowIfEmpty": true
},
"Uid": "ebf70993-4ad7-4719-96eb-61d3beaebb55",
"Alias": "String",
"BackofficeName": "String",
"Name": {
"LocalizedValues": [
{
"LanguageId": 1,
"LocalizedVal": "String"
},
{
"LanguageId": 2,
"LocalizedVal": "String"
}
]
},
"Description": {
"LocalizedValues": [
{
"LanguageId": 1
},
{
"LanguageId": 2
}
]
},
"WhichIsBetter": 5,
"Affiliation": 0,
"AttributeType": "FixedListAttribute",
"ShowIfEmpty": true
}
],
"AllowMultipleRows": false,
"UidToIdMap": {
"e27f762c-bc25-406b-8e1d-b2cf054c9559": 0,
"ebf70993-4ad7-4719-96eb-61d3beaebb55": 1
},
"ShowIfEmpty": true,
"Uid": "2ded43d5-68d5-4200-87f1-012ad97cddca",
"Alias": "String",
"BackofficeName": "String",
"Name": {
"LocalizedValues": [
{
"LanguageId": 1,
"LocalizedVal": "String"
},
{
"LanguageId": 2,
"LocalizedVal": "String"
}
]
},
"WhichIsBetter": 5,
"AttributeGroupId": 96,
"Affiliation": 0,
"AttributeType": "ComplexAttribute"
}
]
Request
Parameters: none
Response status OK (200)
Return value: Attribute[]
Attribute | ||
---|---|---|
Property name | Type | Description |
Uid | Guid | Unique identifier of attribute |
AttributeGroupId | int | Id of attribute group for attribute |
Alias | string | Alias of attribute |
BackofficeName | string | Name used in Umbraco backoffice for attribute |
BackofficeDescription | string | Description used in Umbraco backoffice for attribute |
Name | TranslatedValue | Translated values of attribute name |
Description | TranslatedValue | Translated values of attribute Description |
WhichIsBetter | int | Derived from enum value |
AttributeType | string | The attribute type |
TranslatedValue | ||
Property name | Type | Description |
LocalizedValues | LocalizedValue[] | List of translated names with language ids |
LocalizedValue | ||
Property name | Type | Description |
LanguageId | int | Unique id of language |
LocalizedVal | string | Value of variable type |
GET /GetProductGroupAttributes
[
{
"ValueIsTranslatable": false,
"AllowMultiselect": false,
"AllowedSelectionTypes": [
"image"
],
"Uid": "392608cc-eff4-43d4-bfc5-0f4f12ec00f5",
"Alias": "String",
"BackofficeName": "String",
"BackofficeDescription": "",
"Name": {
"LocalizedValues": [
{
"LanguageId": 1,
"LocalizedVal": "String"
},
{
"LanguageId": 2,
"LocalizedVal": "String"
}
]
},
"Description": {
"LocalizedValues": [
{
"LanguageId": 1
},
{
"LanguageId": 2
}
]
},
"WhichIsBetter": 5,
"Affiliation": 3,
"AttributeType": "MediaAttribute",
"ShowIfEmpty": true
}
]
Request
Parameters: none
Response status OK (200)
Return value: Attribute[]
Attribute | ||
---|---|---|
Property name | Type | Description |
Uid | Guid | Unique identifier of attribute |
AttributeGroupId | int | Id of attribute group for attribute |
Alias | string | Alias of attribute |
BackofficeName | string | Name used in Umbraco backoffice for attribute |
BackofficeDescription | string | Description used in Umbraco backoffice for attribute |
Name | TranslatedValue | Translated values of attribute name |
Description | TranslatedValue | Translated values of attribute Description |
WhichIsBetter | int | Derived from enum value |
AttributeType | string | The attribute type |
TranslatedValue | ||
Property name | Type | Description |
LocalizedValues | LocalizedValue[] | List of translated names with language ids |
LocalizedValue | ||
Property name | Type | Description |
LanguageId | int | Unique id of language |
LocalizedVal | string | Value of variable type |
GET /GetGlobalListAttributes
{
"68": {
"SubAttributes": [
{
"ValueIsTranslatable": false,
"UseRichText": false,
"TranslatedUnit": {
"LocalizedValues": [
{
"LanguageId": 1
},
{
"LanguageId": 2
}
]
},
"UnitIsTranslatable": false,
"Uid": "369c968a-5176-4a1a-8dea-994b2238de7f",
"Alias": "String",
"BackofficeName": "String",
"BackofficeDescription": "String",
"Name": {
"LocalizedValues": [
{
"LanguageId": 1,
"LocalizedVal": "String"
},
{
"LanguageId": 2,
"LocalizedVal": "String"
}
]
},
"Description": {
"LocalizedValues": [
{
"LanguageId": 1
},
{
"LanguageId": 2
}
]
},
"WhichIsBetter": 5,
"AttributeType": "TextAttribute"
},
{
"ValueIsTranslatable": true,
"UseRichText": false,
"TranslatedUnit": {
"LocalizedValues": [
{
"LanguageId": 1
},
{
"LanguageId": 2
}
]
},
"UnitIsTranslatable": false,
"Uid": "6b84839b-50d5-4c96-9b78-9b05cadd0b31",
"Alias": "String",
"BackofficeName": "String",
"BackofficeDescription": "String",
"Name": {
"LocalizedValues": [
{
"LanguageId": 1,
"LocalizedVal": "String"
},
{
"LanguageId": 2,
"LocalizedVal": "String"
}
]
},
"Description": {
"LocalizedValues": [
{
"LanguageId": 1
},
{
"LanguageId": 2
}
]
},
"WhichIsBetter": 5,
"AttributeType": "TextAttribute"
}
],
"AllowMultipleRows": false,
"Uid": "6c0be1ff-35fc-4bb9-b0fc-13e0d8270380",
"Alias": "String",
"BackofficeName": "String",
"BackofficeDescription": "String",
"Name": {
"LocalizedValues": [
{
"LanguageId": 1,
"LocalizedVal": "String"
},
{
"LanguageId": 2,
"LocalizedVal": "String"
}
]
},
"Description": {
"LocalizedValues": [
{
"LanguageId": 1,
"LocalizedVal": "String"
},
{
"LanguageId": 2,
"LocalizedVal": "String"
}
]
},
"WhichIsBetter": 5,
"AttributeType": "ComplexAttribute"
}
}
Request
Parameters: none
Response status OK (200)
Return value: AttributebyId[]
AttributebyId | ||
---|---|---|
Property name | Type | Description |
Id | int | Unique identifier for attribute |
Attribute | Attribute | |
Attribute | ||
Property name | Type | Description |
Uid | Guid | Unique identifier of attribute |
AttributeGroupId | int | Id of attribute group for attribute |
Alias | string | Alias of attribute |
BackofficeName | string | Name used in Umbraco backoffice for attribute |
BackofficeDescription | string | Description used in Umbraco backoffice for attribute |
Name | TranslatedValue | Translated values of attribute name |
Description | TranslatedValue | Translated values of attribute Description |
WhichIsBetter | int | Derived from enum value |
AttributeType | string | The attribute type |
TranslatedValue | ||
Property name | Type | Description |
LocalizedValues | LocalizedValue[] | List of translated names with language ids |
LocalizedValue | ||
Property name | Type | Description |
LanguageId | int | Unique id of language |
LocalizedVal | string | Value of variable type |
POST /CreateAttributes
{
"Attributes": [
{
"Uid": "00000000-0000-0000-0000-000000000000",
"Alias": "string",
"BackofficeName": "string",
"BackofficeDescription": "string",
"Name": {
"LocalizedValues": [
{
"LanguageId": 0,
"LocalizedVal": "string"
}
]
},
"Description": {
"LocalizedValues": [
{
"LanguageId": 0,
"LocalizedVal": "string"
}
]
},
"WhichIsBetter": 0,
"AttributeGroupId": 0,
"Affiliation": 0,
"AttributeType": "string",
"ShowIfEmpty": true
}
],
"Affiliation": 0
}
Request
Body parameters: AttributeCreateUpdateModel
AttributeCreateUpdateModel | ||
---|---|---|
Property name | Type | Description |
Attributes | Attribute[] | Attributes to be created |
Affiliation | int | Derived from enum [0, 1, 2, 3] |
Attribute | ||
Property name | Type | Description |
Uid | Guid | Unique identifier of attribute |
AttributeGroupId | int | Id of attribute group for attribute |
Alias | string | Alias of attribute |
BackofficeName | string | Name used in Umbraco backoffice for attribute |
BackofficeDescription | string | Description used in Umbraco backoffice for attribute |
Name | TranslatedValue | Translated values of attribute name |
Description | TranslatedValue | Translated values of attribute Description |
WhichIsBetter | int | Derived from enum value |
AttributeType | string | The attribute type |
TranslatedValue | ||
Property name | Type | Description |
LocalizedValues | LocalizedValue[] | List of translated names with language ids |
LocalizedValues | ||
Property name | Type | Description |
LanguageId | int | Unique id of language |
LocalizedVal | string | Value of variable type |
Response status OK (200)
Return value: none
POST /UpdateAttributes
[
{
"Uid": "00000000-0000-0000-0000-000000000000",
"Alias": "string",
"BackofficeName": "string",
"BackofficeDescription": "string",
"Name": {
"LocalizedValues": [
{
"LanguageId": 0,
"LocalizedVal": "string"
}
]
},
"Description": {
"LocalizedValues": [
{
"LanguageId": 0,
"LocalizedVal": "string"
}
]
},
"WhichIsBetter": 0,
"AttributeGroupId": 0,
"Affiliation": 0,
"AttributeType": "string",
"ShowIfEmpty": true
}
]
Request
Body parameters: Attribute[]
Attribute | ||
---|---|---|
Property name | Type | Description |
Uid | Guid | Unique identifier of attribute |
AttributeGroupId | int | Id of attribute group for attribute |
Alias | string | Alias of attribute |
BackofficeName | string | Name used in Umbraco backoffice for attribute |
BackofficeDescription | string | Description used in Umbraco backoffice for attribute |
Name | TranslatedValue | Translated values of attribute name |
Description | TranslatedValue | Translated values of attribute Description |
WhichIsBetter | int | Derived from enum value |
AttributeType | string | The attribute type |
TranslatedValue | ||
Property name | Type | Description |
LocalizedValues | LocalizedValue[] | List of translated names with language ids |
LocalizedValues | ||
Property name | Type | Description |
LanguageId | int | Unique id of language |
LocalizedVal | string | Value of variable type |
Response status OK (200)
Return value: none
POST /DeleteAttributes
[
"a8e43b9f-f32f-4b00-aff1-bf1ca2aebec2",
"57418466-bf8a-4673-8a02-2f139047791d",
"694b788d-a695-4f27-8407-f725963b1551"
]
Request
Body parameters: Uids[]
Property name | Type | Description |
---|---|---|
uids | string[] | Array of attributeuids to delete |
Response status OK (200)
Return value: none
POST /CreateAttributeGroups
[
{
"Id": 0,
"Alias": "string",
"Name": {
"LocalizedValues": [
{
"LanguageId": 0,
"LocalizedVal": "string"
}
]
},
"SortOrder": 0
}
]
Request
Body parameters: AttributeGroup[]
AttributeGroup | ||
---|---|---|
Property name | Type | Description |
Id | int | Unique id of attribute group |
Alias | string | Alias of attribute group |
Name | TranslatedValue | Translated values of attribute group name |
SortOrder | int | Sort order for attribute group |
TranslatedValue | ||
Property name | Type | Description |
LocalizedValues | LocalizedValue[] | List of translated names with language ids |
LocalizedValues | ||
Property name | Type | Description |
LanguageId | int | Unique id of language |
LocalizedVal | string | Value of variable type |
Response status OK (200)
Return value: none
POST / UpdateAttributeGroups
[
{
"Id": 0,
"Alias": "string",
"Name": {
"LocalizedValues": [
{
"LanguageId": 0,
"LocalizedVal": "string"
}
]
},
"SortOrder": 0
}
]
Request
Body parameters: AttributeGroup[]
AttributeGroup | ||
---|---|---|
Property name | Type | Description |
Id | int | Unique id of attribute group |
Alias | string | Alias of attribute group |
Name | TranslatedValue | Translated values of attribute group name |
SortOrder | int | Sort order for attribute group |
TranslatedValue | ||
Property name | Type | Description |
LocalizedValues | LocalizedValue[] | List of translated names with language ids |
LocalizedValues | ||
Property name | Type | Description |
LanguageId | int | Unique id of language |
LocalizedVal | string | Value of variable type |
Response status OK (200)
Return value: none
POST /DeleteAttributeGroups
[
"a8e43b9f-f32f-4b00-aff1-bf1ca2aebec2",
"57418466-bf8a-4673-8a02-2f139047791d",
"694b788d-a695-4f27-8407-f725963b1551"
]
Request
Body parameters: AttributeGroupIds
Property name | Type | Description |
---|---|---|
AttributeGroupIds | int[] | Array of attribute group Ids to delete |
Response status OK (200)
Return value: none
Previous
Next article