Atributos

Listar atributos com paginação e filtros.

Listagem paginada

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

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

Obter um atributo específico por código ou por ID.

Por código

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

Por ID

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

Criar atributo global do tipo texto.

{
  "attribute_code": "codigo_fabricante",
  "frontend_input": "text",
  "frontend_label": "Código do Fabricante",
  "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"]
}

Criar atributo select com lista inicial de opções. Cada opção aceita admin (label), position e default.

{
  "attribute_code": "tipo_material",
  "frontend_input": "select",
  "frontend_label": "Tipo de Material",
  "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}
  ]
}

Atualizar configurações do atributo (flags, posição, escopo). Envie só os campos que mudaram.

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

Sincronizar a lista completa de opções do atributo. Opções ausentes no payload podem ser removidas. Para mexer em uma opção isolada, use o bloco Opções pontuais.

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

Excluir atributo global.

{
  "attribute_code": "tipo_material"
}

Adicionar uma opção ao atributo. Retorna 409 se já existir opção com o mesmo label (case-sensitive) no atributo.

Request

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

Resposta

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

Atualizar label, posição ou flag de default de uma opção. O option_id precisa pertencer ao atributo informado.

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

Remover uma opção. Bloqueia a remoção se a opção estiver em uso por produtos — nesse caso retorna 409 e os produtos permanecem inalterados.

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

Resposta

{
  "success": true,
  "message": "Opção removida com sucesso."
}

Criar novo Attribute Set a partir de um skeleton.

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

Remover Attribute Set. Use force_products_remove com cautela — quando true, os produtos vinculados são removidos junto.

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

Criar grupo dentro de um Attribute Set.

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

Renomear grupo. Identifique pelo nome atual (group_name) e informe o new_group_name.

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

Remover grupo. Grupos do sistema (criados na instalação do set) podem não ser removíveis.

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

Vincular atributo a um grupo dentro de um set.

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

Desvincular atributo de um set. O atributo global continua existindo; só o vínculo com o set é removido.

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