Attributes

Attribute sets, groups and global catalog attributes — the structure that organizes how products receive information and how it shows up on the storefront.

Attribute Sets Groups Global attributes

Attribute structure

This section covers the attribute sets and groups structure as well as the catalog's global attributes. The separation allows reusing attributes across sets and isolating category-specific data.

Attribute Sets and Groups

Sets group attributes applicable to a product type. Groups organize attributes within a set for admin display.

POST/api2/catalog/attributeSet

Create a new Attribute Set from an existing skeleton.

{
  "attribute_set_name": "Equipamentos Odontológicos",
  "skeleton_set_id": 4
}

POST/api2/catalog/attributegroup

Create a group within an Attribute Set.

{
  "attribute_set_id": 4,
  "group_name": "Dados Técnicos"
}

PATCH/api2/catalog/attributegroup

Rename an attribute group.

{
  "attribute_set_id": 4,
  "group_name": "Dados Técnicos",
  "new_group_name": "Informações Técnicas"
}

Global attributes

Reusable attributes across multiple sets. They support different types (text, select, etc.) and options like is_filterable, used_in_product_listing and apply_to.

POST/api2/attribute

Create a global text-type attribute.

{
  "attribute_code": "codigo_fabricante",
  "frontend_input": "text",
  "frontend_label": "Manufacturer Code",
  "is_global": 1,
  "used_in_product_listing": 1,
  "apply_to": ["simple", "configurable"]
}

POST/api2/attribute

Create a select attribute with options.

{
  "attribute_code": "tipo_material",
  "frontend_input": "select",
  "frontend_label": "Material Type",
  "options": [
    {"admin": "Resina", "position": 0, "default": 1},
    {"admin": "Cerâmica", "position": 1}
  ]
}

PATCH/api2/attribute

Update attribute settings or options.

{
  "attribute_code": "tipo_material",
  "is_required": 0,
  "is_filterable": 0
}

DELETE/api2/attribute

Delete a global attribute.

{
  "attribute_code": "tipo_material"
}