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. Some example URIs:
/AttributeSets/7033d0cb-999d-4ea9-b5f4-23481006f5f0 - Returns details of a particular attribute set.
/AttributeSets/Page/1 - Returns the first page of 200 attribute sets.
/AttributeSets/1 - Returns the first page of 200 attribute sets.

Note: This endpoint can only be used for Products.

The full range of URIs and HTTP Verbs supported are:

Operation	HTTP Action
List all attribute sets.	GET `/AttributeSets`
List the attribute sets for a specific guid.	GET `/AttributeSets/{Guid}`
Create a new attribute set.	POST `/AttributeSets/{id}`

GET AttributeSets

Available Fields for AttributeSets:

Property	Type	Length	Required	Notes
Guid		Guid	Yes	Unique identifier. Can only be set when adding a record.
LastModifiedOn	Nullable DateTime
SetName	String	500
Type	Product		Yes	The Type value must be Product.
Attributes	Attribute Collection

Available Fields for Attribute:

Property	Type	Length	Required	Notes
Guid		Guid	Yes	Unique identifier. Can only be set when adding a record.
Name	String	500
Value	String	500		Returns the default value assigned to the attribute.
IsRequired	Boolean	`true`,`false`

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>
<AttributeSets>
    <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>
    </AttributeSet>
    <AttributeSet>
        <Guid>d912e8c7-2854-43ca-a5e9-12a383879014</Guid>
        <SetName>Electronics</SetName>
        <Type>Product</Type>
        <Attribute>
            <Guid>d912e8c7-2854-43ca-a5e9-12a383879015</Guid>
            <Name>Brand</Name>
            <Value>Samsung</Value>
            <IsRequired>True</IsRequired>
        </Attribute>
        <Attribute>
            <Guid>d912e8c7-2854-43ca-a5e9-12a383879016</Guid>
            <Name>Year</Name>
            <Value>2013</Value>
            <IsRequired>False</IsRequired>
        </Attribute>
    </AttributeSet>
    <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>
</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": "anu@unleashedsoftware.com",
      "CreatedOn": "/Date(1491947887476)/",
      "LastModifiedBy": "anu@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

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>
    </AttributeSet>

show json example

    "AttributeSets": [{
        "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"
        }],

Attribute Sets

The full range of URIs and HTTP Verbs supported are:

GET AttributeSets

Available Fields for AttributeSets:

Available Fields for Attribute:

Examples for Response GET /AttributeSets

POST AttributeSets

Examples for Request POST /AttributeSets/

Examples for Response POST /AttributeSets/

Examples for Response GET `/AttributeSets`

Examples for Request POST `/AttributeSets/`

Examples for Response POST `/AttributeSets/`