Attribute Sets
The AttributeSets resource allows attributes to be listed, created, and updated. An individual attribute set details can be viewed or updated by appending its identifier (a GUID formatted as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX) to the URI.
Note: This endpoint can only be used for Products.
The full range of URIs and HTTP Verbs supported are:
Operation
HTTP Action
List a page of attribute sets.
GET /AttributeSets
List the attribute sets for a specific guid.
GET /AttributeSets/{guid}
Create a new attribute set.
POST /AttributeSets/{id}
GET Attribute Sets
Available Fields for GET Attribute Sets
Property
Type
Length
Notes
Attributes
Attribute Collection
CreatedBy
Nullable String
CreatedOn
Nullable DateTime
Guid
Guid
Unique identifier. Can only be set when adding a record.
LastModifiedBy
Nullable String
50
LastModifiedOn
Nullable DateTime
SetName
String
50
Type
String
The Type value must be Product.
Available Fields for Attribute
Property
Type
Length
Notes
Guid
Guid
Unique identifier. Can only be set when adding a record.
IsRequired
Boolean
true,false
Name
String
50
Value
String
50
The default value assigned to the attribute.
Examples for Response GET /AttributeSets
show xml example
<?xml version="1.0"?>
<AttributeSets xmlns:xsd:= "http://www.w3.org/2001/XMLSchema" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xmlns= "http://api.unleashedsoftware.com/version/1" >
<Pagination>
<NumberOfItems> 1</NumberOfItems>
<PageSize> 1</PageSize>
<PageNumber> 1</PageNumber>
<NumberOfPages> 1</NumberOfPages>
</Pagination>
<AttributeSet>
<Guid> d912e8c7-2854-43ca-a5e9-12a383879011</Guid>
<SetName> Jewellery</SetName>
<Type> Product</Type>
<Attributes>
<Attribute>
<Guid> d912e8c7-2854-43ca-a5e9-12a383879012</Guid>
<Name> Type</Name>
<Value> Necklace</Value>
<IsRequired> True</IsRequired>
</Attribute>
<Attribute>
<Guid> d912e8c7-2854-43ca-a5e9-12a383879013</Guid>
<Name> Color</Name>
<Value> Blue</Value>
<IsRequired> False</IsRequired>
</Attribute>
</Attributes>
<CreatedBy> user@unleashedsoftware.com</CreatedBy>
<CreatedOn> 2016-03-20T02:32:20.84</CreatedOn>
<LastModifiedBy> user@unleashedsoftware.com</LastModifiedBy>
<LastModifiedOn> 2016-11-29T02:32:20.84</LastModifiedOn>
</AttributeSet>
</AttributeSets> show json example
{
"Pagination" : {
"NumberOfItems" : 2 ,
"PageSize" : 200 ,
"PageNumber" : 1 ,
"NumberOfPages" : 1
},
"Items" : [
{
"Guid" : "8c68191d-9518-4a3b-bfc5-b416a9d55af4" ,
"SetName" : "Television" ,
"Type" : "Product" ,
"Attributes" : [
{
"Guid" : "f45c77a6-e3f1-4f2b-8254-91b6c07ed313" ,
"Name" : "Model" ,
"Value" : null ,
"IsRequired" : false
},
{
"Guid" : "00fa523d-5af7-420a-87a1-8d9b40657c48" ,
"Name" : "Country Of Origin" ,
"Value" : null ,
"IsRequired" : false
},
{
"Guid" : "ec9d53bc-4670-4bbf-826e-4d0c8aa4e73a" ,
"Name" : "Tariff Code" ,
"Value" : null ,
"IsRequired" : false
}
],
"CreatedBy" : "user@unleashedsoftware.com" ,
"CreatedOn" : "/Date(1491947887476)/" ,
"LastModifiedBy" : "user@unleashedsoftware.com" ,
"LastModifiedOn" : "/Date(1502152583569)/"
},
{
"Guid" : "2a0d1cf3-fc5b-4ba4-af5e-15d4a7e74152" ,
"SetName" : "Test" ,
"Type" : "Product" ,
"Attributes" : [
{
"Guid" : "4286293f-98a6-48d4-af80-cb84641d71d7" ,
"Name" : "Type" ,
"Value" : null ,
"IsRequired" : true
},
{
"Guid" : "33347f40-ea87-4526-bf9f-03ec2671324b" ,
"Name" : "Color" ,
"Value" : null ,
"IsRequired" : false
}
],
"CreatedBy" : "user@unleashedsoftware.com" ,
"CreatedOn" : "/Date(1502157008219)/" ,
"LastModifiedBy" : "user@unleashedsoftware.com" ,
"LastModifiedOn" : "/Date(1502157008765)/"
}
]
} POST AttributeSets
Available Fields for POST Attribute Sets
Property
Type
Length
Required
Notes
Attributes
Attribute Collection
Guid
Guid
Yes for updating
Unique identifier. Can only be set when adding a record.
SetName
String
50
Yes
Type
String
Yes
The Type value must be Product.
Available Fields for Attribute
Property
Type
Length
Required
Notes
Guid
Guid
Yes for updating
Unique identifier. Can only be set when adding a record.
IsRequired
Boolean
true,false
Name
String
50
Yes
Must be unique.
Value
String
50
The default value assigned to the attribute.
Examples for Request POST /AttributeSets
show xml example
<?xml version="1.0"?>
<AttributeSet xmlns:xsd= "http://www.w3.org/2001/XMLSchema" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xmlns= "http://api.unleashedsoftware.com/version/1" >
<SetName> xmltest</SetName>
<Type> Product</Type>
<Attributes>
<Attribute>
<Name> Type</Name>
<Value> Necklace</Value>
<IsRequired> true</IsRequired>
</Attribute>
<Attribute>
<Name> Color</Name>
<IsRequired> false</IsRequired>
</Attribute>
</Attributes>
</AttributeSet> show json example
{
"SetName" : "Jewellery" ,
"Type" : "Product" ,
"Attributes" : [
{
"Name" : "Type" ,
"Value" : "Necklace" ,
"IsRequired" : "true"
},
{
"Name" : "Color" ,
"Value" : "Blue" ,
"IsRequired" : "false"
}
]
} Examples for Response POST /AttributeSets
show xml example
<AttributeSet>
<Guid> d912e8c7-2854-43ca-a5e9-12a383879011</Guid>
<SetName> Jewellery</SetName>
<Type> Product</Type>
<Attributes>
<Attribute>
<Guid> d912e8c7-2854-43ca-a5e9-12a383879012</Guid>
<Name> Type</Name>
<Value> Necklace</Value>
<IsRequired> true</IsRequired>
</Attribute>
<Attribute>
<Guid> d912e8c7-2854-43ca-a5e9-12a383879013</Guid>
<Name> Color</Name>
<Value> Blue</Value>
<IsRequired> false</IsRequired>
</Attribute>
</Attributes>
<CreatedBy> user@theaccessgroup.com</CreatedBy>
<CreatedOn> 2024-06-09T23:15:15.0119914</CreatedOn>
<LastModifiedBy> user@theaccessgroup.com</LastModifiedBy>
<LastModifiedOn> 2024-08-08T04:16:44.5822494</LastModifiedOn>
</AttributeSet> show json example
{
"Guid" : "d912e8c7-2854-43ca-a5e9-12a383879011" ,
"SetName" : "Jewellery" ,
"Type" : "Product" ,
"Attributes" : [
{
"Guid" : "d912e8c7-2854-43ca-a5e9-12a383879012" ,
"Name" : "Type" ,
"Value" : "Necklace" ,
"IsRequired" : "true"
},
{
"Guid" : "d912e8c7-2854-43ca-a5e9-12a383879013" ,
"Name" : "Color" ,
"Value" : "Blue" ,
"IsRequired" : "false"
}
],
"CreatedBy" : "user@theaccessgroup.com" ,
"CreatedOn" : "/Date(1723090959064)/" ,
"LastModifiedBy" : "user@theaccessgroup.com" ,
"LastModifiedOn" : "/Date(1723090959064)/"
}
