Attributes

Attributes are characteristics of items that can help you share additional information about an item.

Main features:

• specify additional characteristics of an item
• link items to events and conditions

Examples of attributes

Prerequisites

1. Create your Xsolla Publisher Account.
2. Open your project.

3. Open Project settings > Integration settings and make sure that the Integrate Commerce API toggle is set to On.

How to get it

1. Set up attributes.
2. Set up attribute values.
3. Set up attributes for item.

Set up attributes

Every attribute has the following parameters:

• External ID — a unique attribute identifier.
• Name (specified for every language used in a project).
• List of values.

To create and set up attributes, you can:

1. Use functionality of Publisher Account.
2. Use API calls.

Configuration via Publisher Account

1. Go to Store > Catalog management.

2. Click Configure in the Attributes section.

3. Click Create attribute.

4. Specify the External ID and name of the attribute.

5. Click Save and continue.

6. Specify all necessary values for the created attribute. For every value, specify the External ID. To add more values, click +.

7. Click Finish.

Configuration via API calls

Use API calls from the Admin subsection of the Attributes group to set up attributes:

• Create attribute
• Update attribute
• Get specified attribute
• Delete attribute
• Get the list of attributes for administration

Configure attribute values

Every attribute value has the following parameters:

• external_id of a parent attribute
• external_id of a value
• name (specified for every language used in the project)

To create and set up attribute values, you can:

1. Use functionality of Publisher Account.
2. Use API calls.

Configuration via Publisher Account

1. Go to Store > Catalog management.

2. Click Configure in the Attributes section.

3. Select a required attribute in the list of attributes.

4. Open the Values tab and click Create value.

5. Specify the External ID and name for the value.

6. Click Save changes.

Configuration via API calls

Use API calls from the Admin subsection of the Attributes group to set up attributes:

• Create attribute value
• Delete all values of attribute
• Update attribute value
• Delete attribute value

Configure attributes for item

To add attributes for items, you can:

1. Use functionality of Publisher Account.
2. Use API calls.

Configuration via Publisher Account

To add an attribute for an item:

1. Go to Store.
2. Open a section with the required item type:
   • Virtual items
   • Virtual currency
   • Game keys
   • Bundles

3. Create a new item or edit the existing one.
4. While filling in the general information about the item, select a previously created attribute in the Attribute section.

5. In the Value field that appears, select the identifier that corresponds to the required attribute value.

Configuration via API methods

Pass an array of objects with identifiers and values of attributes that you want to link to the Create virtual item or Update virtual item method.

"attributes": [
   {
     "external_id": "craft-materials",

     "values": [
       {
         "external_id": "steel",

       },
       {
         "external_id": "leather",

   },
   ...
]

Rate this page

Is there anything we can improve? Send

Don't want to answer

Thank you for your feedback!