API legada/Guia rápido/Variações e opções

Variações (produtos filhos)

Lista os produtos filhos de um produto pai, cada um com código, preço e estoque próprios.

Uma variação é um produto filho: um produto completo (com SKU, preço, estoque, imagens e página próprios) ligado a um produto pai. É o modelo certo quando cada tamanho ou cor precisa de controle de estoque e de código próprios, por exemplo porque o ERP trata cada combinação como um item.

Para entender quando usar variações em vez de opções ou variações unificadas, leia a visão geral. Esta página mostra como ler os filhos de um produto pai.

Listar variações

GET/api/v1.0/products/{id}/variationsAdmin

Listar as variações filhas de um produto

Autenticação: HTTP Basic (e-mail:chave_de_api) de um administrador, ou Authorization: Bearer <JWT>. Também responde em /api/products/{id}/variations (ids decimais em string). Cada item tem o mesmo formato de um produto desta API (preço em string decimal, status em letra). Produto sem filhos, ou inexistente, devolve lista vazia com 200.

Parâmetros de caminho

idstringobrigatório

Id do produto pai (UUID; decimal em /api/products/...).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1.0/products/$PARENT_ID/variations" -u "$EMAIL:$API_KEY"

Resposta

200Um filho, resumido

json

{
  "product_id": "3cbd86fd-0e6c-404f-8264-c99438a28ce0",
  "total": 3,
  "variations": [
    {
      "product_id": "c922028b-e2e5-44b3-b7f3-93e7feef8949",
      "product": "ZZ Var Camiseta Pai - M",
      "price": "49.90",
      "amount": 0,
      "status": "A",
      "seo_name": "zz-var-camiseta-pai-m",
      "company_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
      "product_features": [
        {
          "feature_id": "a827c238-e0ce-4ff3-9655-478b5e3adf1b",
          "variant_id": "177db45a-f708-4564-af8f-604b3053c5a1",
          "value": "M"
        }
      ]
    }
  ]
}

Campos da resposta

product_idstring

Id do produto pai consultado.

totalinteger

Quantidade de filhos.

variationsarray

Filhos. Cada item é um produto no formato de Consultar produto, em versão resumida.

variations[].product_idstring

Id do filho.

variations[].product_featuresarray

Valor do filho em cada eixo, em lista: [{"feature_id","variant_id","value"}].

Erros

Status	Quando	Exemplo de corpo
401	Sem credenciais ou chave inválida	`{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}`
500	Falha ao ler os filhos (por exemplo, id que não é UUID)	`{"message":"Failed to retrieve product variations","status":500}`

Veja também

Atualizar produto

Variações (produtos filhos)

Lista os produtos filhos de um produto pai, cada um com código, preço e estoque próprios.

Para entender quando usar variações em vez de opções ou variações unificadas, leia a visão geral. Esta página mostra como ler os filhos de um produto pai.

Listar variações

GET/api/v1.0/products/{id}/variationsAdmin

Listar as variações filhas de um produto

Parâmetros de caminho

idstringobrigatório

Id do produto pai (UUID; decimal em /api/products/...).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1.0/products/$PARENT_ID/variations" -u "$EMAIL:$API_KEY"

Resposta

200Um filho, resumido

json

{
  "product_id": "3cbd86fd-0e6c-404f-8264-c99438a28ce0",
  "total": 3,
  "variations": [
    {
      "product_id": "c922028b-e2e5-44b3-b7f3-93e7feef8949",
      "product": "ZZ Var Camiseta Pai - M",
      "price": "49.90",
      "amount": 0,
      "status": "A",
      "seo_name": "zz-var-camiseta-pai-m",
      "company_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
      "product_features": [
        {
          "feature_id": "a827c238-e0ce-4ff3-9655-478b5e3adf1b",
          "variant_id": "177db45a-f708-4564-af8f-604b3053c5a1",
          "value": "M"
        }
      ]
    }
  ]
}

Campos da resposta

product_idstring

Id do produto pai consultado.

totalinteger

Quantidade de filhos.

variationsarray

Filhos. Cada item é um produto no formato de Consultar produto, em versão resumida.

variations[].product_idstring

Id do filho.

variations[].product_featuresarray

Valor do filho em cada eixo, em lista: [{"feature_id","variant_id","value"}].

Erros

Status	Quando	Exemplo de corpo
401	Sem credenciais ou chave inválida	`{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}`
500	Falha ao ler os filhos (por exemplo, id que não é UUID)	`{"message":"Failed to retrieve product variations","status":500}`

Veja também

Atualizar produto