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

Criar uma combinação de opções

Cria uma nova combinação de opções para um produto e devolve o hash dela.

As combinações de opções permitem controlar o estoque de combinações específicas das opções de um produto. Este endpoint cria uma nova combinação para um produto específico. Em caso de sucesso, ele devolve o combination_hash, que você usa depois para atualizar, ler ou excluir a combinação.

POST/api/combinationsAdmin

Criar uma nova combinação de opções para um produto

Envie os parâmetros no corpo da requisição HTTP, de acordo com o Content-Type que você informar.

Corpo da requisição

product_idintegerobrigatório

O identificador único do produto ao qual a combinação está associada.

amountinteger

Quantos itens desta combinação estão em estoque. Só aparece no painel de administração se o produto for controlado por opções.

positioninteger

Quanto menor este número, mais acima a combinação aparece na lista do painel de administração.

combinationobject

As opções e variantes que formam a combinação. As chaves do objeto são IDs de opção e os valores são IDs de variante.

Exemplo de requisição

bash

curl -X POST -u "$EMAIL:$API_KEY" "$BASE_URL/api/combinations/" \
  -H "Content-Type: application/json" \
  -d '{
  "product_id": "4",
  "combination": {
    "24": "74",
    "25": "80",
    "26": "86"
  },
  "amount": "34",
  "position": "10"
}'

Esta requisição cria uma nova combinação para o produto com product_id=4. A combinação é formada pela variante 74 da opção 24, pela variante 80 da opção 25 e pela variante 86 da opção 26. Há 34 itens dessa combinação em estoque, e ela aparece na posição 10 da lista do painel de administração.

Resposta

201Criada

json

{
  "combination_hash": "2822626827"
}

Erros

Status	Quando
400 Bad Request	A combinação não pôde ser criada por parâmetros inválidos ou outros problemas.

Notas de implementação

Garanta que todas as opções da combinação pertençam ao produto informado.
Confirme que cada opção usada em combinações tem inventory=Y nas configurações.
Guarde o hash da combinação devolvido na resposta para atualizações futuras.
Depois de criar a combinação, considere usar um PUT para adicionar imagens ou um código de produto.
Mantenha a contagem de estoque de cada combinação correta para evitar vender além do disponível.

Veja também