API legada/Referência completa/Combinações de opções

Listar combinações de opções

Retorna todas as combinações de opções de um produto, com códigos, hashes, ajuste de preço e estoque.

Este endpoint retorna todas as combinações de opções de um produto específico. As combinações definem as diferentes variantes possíveis de um produto com base nas opções configuráveis dele. Use-o para montar uma página de produto personalizada com seleção de variante, para conferir o estoque de todas as variantes ou para alimentar relatórios.

Se uma camiseta vem em 3 cores e 5 tamanhos, existem 15 combinações possíveis (3 x 5). Cada combinação pode ter o seu próprio preço, estoque, código de produto e assim por diante.

GET/api/combinationsAdmin

Listar as combinações de opções de um produto

Parâmetros de consulta

product_idintegerobrigatório

O identificador único do produto.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/combinations/?product_id=12"

Resposta

200Combinações de opções do produto

json

[
  {
    "combination_id": "128",
    "product_id": "12",
    "product_code": "T-SHIRT-BLK-S",
    "combination_hash": "3_12-4_17",
    "combination": {
      "3": "12",
      "4": "17"
    },
    "amount": "0.000",
    "stock": "25",
    "position": "0"
  },
  {
    "combination_id": "129",
    "product_id": "12",
    "product_code": "T-SHIRT-BLK-M",
    "combination_hash": "3_13-4_17",
    "combination": {
      "3": "13",
      "4": "17"
    },
    "amount": "0.000",
    "stock": "30",
    "position": "0"
  }
]

Campos da resposta

combination_idstring

Identificador único da combinação.

product_idstring

ID do produto ao qual esta combinação pertence.

product_codestring

SKU ou código de produto específico desta combinação.

combination_hashstring

Um hash único que representa esta combinação, no formato "option_id_variant_id-option_id_variant_id".

combinationobject

Objeto que representa a combinação das opções do produto. As chaves são IDs de opção e os valores são IDs de variante.

amountstring

Ajuste de preço desta combinação (somado ao preço base do produto).

stockstring

Nível de estoque desta combinação específica.

positionstring

Posição de exibição desta combinação.

Entendendo os valores da combinação

No exemplo acima:

A primeira combinação representa uma camiseta preta (variante 17 da opção 4) de tamanho pequeno (variante 12 da opção 3).
A segunda combinação representa uma camiseta preta (variante 17 da opção 4) de tamanho médio (variante 13 da opção 3).

Casos de uso comuns

Montar uma página de produto personalizada com seleção de variante.
Controlar o estoque de todas as variantes do produto.
Criar regras de preço personalizadas para combinações específicas.
Gerar relatórios sobre a popularidade das variantes.

Veja também