Logo da Plataforma Yep
API REST · Plataforma Yep Documentação técnica para integrações homologadas

Atributos

Attribute sets, grupos e atributos globais do catálogo — estrutura que organiza como os produtos recebem informações e como elas aparecem na loja.

Attribute Sets Groups Atributos globais

Estrutura de atributos

Esta seção reúne tanto a estrutura de attribute sets e groups quanto os atributos globais do catálogo. A separação permite reutilizar atributos em múltiplos sets e isolar dados específicos por categoria de produto.

Attribute Sets e Groups

Sets agrupam atributos aplicáveis a um tipo de produto. Groups organizam os atributos dentro de um set para exibição no admin.

POST/api2/catalog/attributeSet

Criar novo Attribute Set a partir de um skeleton existente.

{
  "attribute_set_name": "Equipamentos Odontológicos",
  "skeleton_set_id": 4
}
POST/api2/catalog/attributegroup

Criar grupo dentro de um Attribute Set.

{
  "attribute_set_id": 4,
  "group_name": "Dados Técnicos"
}
PATCH/api2/catalog/attributegroup

Renomear grupo de atributos.

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

Atributos globais

Atributos reutilizáveis em múltiplos sets. Suportam tipos diferentes (texto, select, etc.) e configurações como is_filterable, used_in_product_listing e apply_to.

POST/api2/attribute

Criar atributo global do tipo texto.

{
  "attribute_code": "codigo_fabricante",
  "frontend_input": "text",
  "frontend_label": "Código do Fabricante",
  "is_global": 1,
  "used_in_product_listing": 1,
  "apply_to": ["simple", "configurable"]
}
POST/api2/attribute

Criar atributo select com opções.

{
  "attribute_code": "tipo_material",
  "frontend_input": "select",
  "frontend_label": "Tipo de Material",
  "options": [
    {"admin": "Resina", "position": 0, "default": 1},
    {"admin": "Cerâmica", "position": 1}
  ]
}
PATCH/api2/attribute

Atualizar configurações ou opções do atributo.

{
  "attribute_code": "tipo_material",
  "is_required": 0,
  "is_filterable": 0
}
DELETE/api2/attribute

Excluir atributo global.

{
  "attribute_code": "tipo_material"
}