For the complete documentation index, see llms.txt. This page is also available as Markdown.

Attribute

Attribute sets and configuration groups

Retrieve attribute set configuration

get

Returns configuration details for an attribute set, including variant attribute definitions.

Attribute Sets: An attribute set defines the schema for products, specifying:

  • Which attributes a product can have

  • Which attributes define variants (e.g., size, color)

  • Which variant attributes should appear in listings

Response Includes:

  • variant_attributes: Attribute keys that define unique variants

  • variant_listable_attributes: Attributes shown in product listings for variant differentiation

Path parameters
pkintegerRequired

Unique identifier of the attribute set.

Example: 15
Responses
200

Attribute set retrieved successfully

application/json

Attribute set configuration defining product attribute schema.

pkintegerRequired

Attribute set identifier

Example: 15
variant_attributesstring[]Required

List of attribute keys that define product variants.

Products with different values for these attributes are considered separate variants (e.g., size, color).

Example: ["size","color"]
variant_listable_attributesstring[]Required

Subset of variant attributes shown in product listings.

These attributes help customers distinguish between variants in list views.

Example: ["color"]
get/attribute_set/{pk}/
GET /attribute_set/{pk}/ HTTP/1.1
Host: sandbox.akinon.com
Accept: */*
{
  "pk": 15,
  "variant_attributes": [
    "size",
    "color"
  ],
  "variant_listable_attributes": [
    "color"
  ]
}

Retrieve attribute configuration groups

get

Returns grouped attribute configurations for an attribute set.

Attribute Config Groups: Organizes product attributes into logical display groups for:

  • Product detail page attribute sections

  • Specification tables

  • Comparison matrices

Group Structure: Each group contains related attributes with their display configurations, ordering, and formatting rules.

Path parameters
pkintegerRequired

Unique identifier of the attribute set.

Example: 15
Responses
200

Attribute configuration groups retrieved successfully

application/json

Response containing grouped attribute configurations.

get/attribute_set/{pk}/attribute_config_groups/
GET /attribute_set/{pk}/attribute_config_groups/ HTTP/1.1
Host: sandbox.akinon.com
Accept: */*
{
  "attribute_config_groups": [
    {
      "name": "Technical Specifications",
      "order": 1,
      "attributes": [
        {
          "key": "material",
          "label": "Material",
          "order": 1
        }
      ]
    }
  ]
}

Last updated

Was this helpful?