Attributes

List attributes with pagination and filters.

Paginated listing

GET /api2/attribute
Authorization: Bearer {{token}}
Content-Type: application/json

{
  "page": 1,
  "limit": 20,
  "include_pagination": true,
  "frontend_input": ["select", "multiselect"],
  "store_id": 0
}

Fetch a single attribute by code or by ID.

By code

{
  "attribute_code": "tipo_material",
  "store_id": 0
}

By ID

{
  "id": 123,
  "store_id": 0
}

Create a text-type global attribute.

{
  "attribute_code": "codigo_fabricante",
  "frontend_input": "text",
  "frontend_label": "Manufacturer Code",
  "is_global": 1,
  "is_required": 0,
  "is_unique": 0,
  "default_value": null,
  "position": 0,
  "is_searchable": 1,
  "is_visible": 1,
  "is_visible_on_front": 1,
  "is_visible_in_advanced_search": 0,
  "is_comparable": 0,
  "is_filterable": 0,
  "is_filterable_in_search": 0,
  "is_used_for_promo_rules": 0,
  "used_in_product_listing": 1,
  "used_for_sort_by": 0,
  "is_html_allowed_on_front": 0,
  "is_wysiwyg_enabled": 0,
  "apply_to": ["simple", "configurable"]
}

Create a select attribute with an initial list of options. Each option accepts admin (label), position and default.

{
  "attribute_code": "tipo_material",
  "frontend_input": "select",
  "frontend_label": "Material Type",
  "is_global": 1,
  "is_required": 1,
  "is_configurable": 1,
  "is_filterable": 1,
  "is_searchable": 1,
  "used_in_product_listing": 1,
  "options": [
    {"admin": "Resina", "position": 0, "default": 1},
    {"admin": "Cerâmica", "position": 1},
    {"admin": "Zircônia", "position": 2}
  ]
}

Update attribute settings (flags, position, scope). Send only the fields that changed.

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

Sync the full list of options of the attribute. Options missing from the payload may be removed. To change a single option in isolation, use the Pointwise options block.

{
  "attribute_code": "tipo_material",
  "options": [
    {"admin": "Resina", "position": 0},
    {"admin": "Cerâmica Premium", "position": 1, "default": 1}
  ]
}

Delete a global attribute.

{
  "attribute_code": "tipo_material"
}

Add an option to the attribute. Returns 409 if an option with the same label (case-sensitive) already exists on the attribute.

Request

{
  "attribute_code": "tipo_material",
  "admin": "Zircônia",
  "position": 2,
  "default": false
}

Response

{
  "success": true,
  "option": {
    "option_id": 12345,
    "value": "12345",
    "label": "Zircônia",
    "sort_order": 2,
    "is_default": false
  }
}

Update label, position or default flag of an option. The option_id must belong to the given attribute.

{
  "attribute_code": "tipo_material",
  "option_id": 12345,
  "admin": "Zircônia Premium",
  "position": 3,
  "default": true
}

Remove an option. Blocks the removal if the option is in use by products — in that case it returns 409 and the products remain unchanged.

{
  "attribute_code": "tipo_material",
  "option_id": 12345
}

Response

{
  "success": true,
  "message": "Option removed successfully."
}

Create a new Attribute Set from a skeleton.

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

Remove an Attribute Set. Use force_products_remove carefully — when true, linked products are removed alongside.

{
  "attribute_set_name": "Equipamentos Odontológicos",
  "force_products_remove": true
}

Create a group within an Attribute Set.

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

Rename a group. Identify by the current name (group_name) and inform new_group_name.

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

Remove a group. System groups (created when the set is installed) may not be removable.

{
  "attribute_set_id": 10,
  "group_name": "Informações Técnicas"
}

Link an attribute to a group inside a set.

{
  "attribute_code": "codigo_fabricante",
  "attribute_set_id": 10,
  "attribute_group_name": "Informações Técnicas",
  "sort_order": 10
}

Unlink an attribute from a set. The global attribute still exists; only the link to the set is removed.

{
  "attribute_code": "codigo_fabricante",
  "attribute_set_id": 10
}