# Attributes

GET /GetProductConfigurationAttributes

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

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

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

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

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

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

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

Request

Body parameters: Uids[]
Property name Type Description
uids string[] Array of attributeuids to delete

Response status OK (200)

Return value: none

POST /CreateAttributeGroups

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

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

Request

Body parameters: AttributeGroupIds
Property name Type Description
AttributeGroupIds int[] Array of attribute group Ids to delete

Response status OK (200)

Return value: none


© 2024 Struct - All rights reserved.