API atual/Referência completa/Catálogo: variações, tags e filtros

Grupos de variação

Lê um grupo de variação do modelo de produtos filhos, com o produto pai, os eixos de variação e todos os filhos.

No modelo de produtos filhos, cada variação (a camiseta vermelha M, a azul G) é um produto completo, com SKU, preço e estoque próprios, ligado a um produto pai por um identificador de grupo (variation_group_id). Os eixos do grupo são as características que diferenciam os filhos (cor, tamanho).

Esta rota lê o grupo inteiro de uma vez: o pai, os eixos e os filhos. É a forma de montar uma tela de "todas as variações deste produto" com uma chamada só.

Ler um grupo

GET/api/v1/admin/variation-groups/{id}Admin

Ler um grupo de variação com pai, eixos e filhos

Devolve o grupo identificado por id, que é o variation_group_id dos produtos (um UUID), não o id do produto pai. Para descobrir o grupo de um produto, leia o produto e use o campo variation_group_id.

Parâmetros de caminho

iduuidobrigatório

Id do grupo (variation_group_id).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/variation-groups/0c7e5a9b-41d2-4f38-b6a0-92e1d8c3f705" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Grupo encontrado

Os itens de products têm o mesmo formato da resposta de detalhe de produto; aqui estão reduzidos.

json

{
  "group_id": "0c7e5a9b-41d2-4f38-b6a0-92e1d8c3f705",
  "parent_id": "d8a6c5e7-8e44-4055-a0e2-49014f5d17f6",
  "features": [
    {
      "id": "a41f0b2c-8d5e-4c19-9f60-7e3b2d1c8a94",
      "group_id": "0c7e5a9b-41d2-4f38-b6a0-92e1d8c3f705",
      "feature_id": "dfae5ba1-09d3-41c1-85dc-be137fb5b61c",
      "purpose": "group_variation_catalog_item"
    }
  ],
  "products": [
    {
      "id": "5f1c3e8a-7b26-4d90-a4e1-c8d2b6f09e37",
      "name": "Camiseta Básica Vermelha M",
      "sku": "CAM-VERM-M",
      "price": 4990,
      "quantity": 25
    }
  ]
}

Campos da resposta

group_iduuid

Id do grupo.

parent_iduuid

Id do produto pai.

featuresarray

Eixos do grupo.

features[].iduuid

Id do vínculo do eixo com o grupo.

features[].group_iduuid

Id do grupo.

features[].feature_iduuid

Id da característica usada como eixo (cor, tamanho). Ausente em eixos do modelo antigo, que trazem option_id.

features[].option_iduuid

Eixo do modelo antigo de opções. Ausente nos grupos novos.

features[].purposestring

group_catalog_itemgroup_variation_catalog_item

Papel da característica no grupo, herdado da plataforma antiga.

productsarray

Os produtos filhos do pai, no formato de produto completo (preço em centavos, estoque, imagens...).

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token expirado.	`{"error":"invalid or expired token"}`
403	Token que não é de administrador.	`{"error":"admin access required"}`
404	Nenhum produto pai tem esse `variation_group_id`.	`{"error":"variation group not found"}`
500	`{id}` que não é um UUID.	`{"error":"failed to get variation group","detail":"o valor \"abc\" não é um uuid válido. Envie o identificador completo..."}`

Veja também

Grupos de variação

Lê um grupo de variação do modelo de produtos filhos, com o produto pai, os eixos de variação e todos os filhos.

Esta rota lê o grupo inteiro de uma vez: o pai, os eixos e os filhos. É a forma de montar uma tela de "todas as variações deste produto" com uma chamada só.

Ler um grupo

GET/api/v1/admin/variation-groups/{id}Admin

Ler um grupo de variação com pai, eixos e filhos

Parâmetros de caminho

iduuidobrigatório

Id do grupo (variation_group_id).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/variation-groups/0c7e5a9b-41d2-4f38-b6a0-92e1d8c3f705" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Grupo encontrado

Os itens de products têm o mesmo formato da resposta de detalhe de produto; aqui estão reduzidos.

json

{
  "group_id": "0c7e5a9b-41d2-4f38-b6a0-92e1d8c3f705",
  "parent_id": "d8a6c5e7-8e44-4055-a0e2-49014f5d17f6",
  "features": [
    {
      "id": "a41f0b2c-8d5e-4c19-9f60-7e3b2d1c8a94",
      "group_id": "0c7e5a9b-41d2-4f38-b6a0-92e1d8c3f705",
      "feature_id": "dfae5ba1-09d3-41c1-85dc-be137fb5b61c",
      "purpose": "group_variation_catalog_item"
    }
  ],
  "products": [
    {
      "id": "5f1c3e8a-7b26-4d90-a4e1-c8d2b6f09e37",
      "name": "Camiseta Básica Vermelha M",
      "sku": "CAM-VERM-M",
      "price": 4990,
      "quantity": 25
    }
  ]
}

Campos da resposta

group_iduuid

Id do grupo.

parent_iduuid

Id do produto pai.

featuresarray

Eixos do grupo.

features[].iduuid

Id do vínculo do eixo com o grupo.

features[].group_iduuid

Id do grupo.

features[].feature_iduuid

Id da característica usada como eixo (cor, tamanho). Ausente em eixos do modelo antigo, que trazem option_id.

features[].option_iduuid

Eixo do modelo antigo de opções. Ausente nos grupos novos.

features[].purposestring

group_catalog_itemgroup_variation_catalog_item

Papel da característica no grupo, herdado da plataforma antiga.

productsarray

Os produtos filhos do pai, no formato de produto completo (preço em centavos, estoque, imagens...).

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token expirado.	`{"error":"invalid or expired token"}`
403	Token que não é de administrador.	`{"error":"admin access required"}`
404	Nenhum produto pai tem esse `variation_group_id`.	`{"error":"variation group not found"}`
500	`{id}` que não é um UUID.	`{"error":"failed to get variation group","detail":"o valor \"abc\" não é um uuid válido. Envie o identificador completo..."}`