VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/Combinações de opções

Detalhes da combinação de opções

Referência de todos os campos de uma combinação de opções, com um objeto de exemplo e os endpoints baseados no produto.

As combinações de opções permitem gerenciar variações de produto com base em diferentes seleções de opções. Por exemplo, uma camiseta pode ter combinações de tamanho e cor (como "Pequeno/Vermelho" e "Médio/Azul"). Esta página descreve os campos e as propriedades das combinações de opções na REST API da Venddor.

Nota

A REST API da Venddor sempre aceita e devolve os dados como strings e arrays/objetos. Os tipos de dado mostrados abaixo para cada campo indicam o tipo lógico do campo, não o formato em que ele é transmitido.

Campos da combinação de opções

Campos da combinação de opções

product_idinteger
O identificador único do produto ao qual a combinação está associada.
product_codestring
O código de produto da combinação. Pode ser usado como SKU (Stock Keeping Unit) para controle de estoque.
combination_hashstring
O hash da combinação, que funciona como identificador único da combinação específica de variantes de opções.
combinationobject
As opções e variantes que formam a combinação. Este objeto contém pares chave-valor em que a chave é o option_id e o valor é o variant_id.
amountinteger
Define quantos itens desta combinação estão em estoque. Este campo é usado no controle de estoque.
positioninteger
Quanto menor este número, mais acima a combinação aparece na lista do painel de administração.
image_pairsobject
As informações das imagens associadas à combinação. Isso permite ter imagens de produto diferentes conforme a combinação selecionada (por exemplo, imagens diferentes para cada variante de cor).
Dica

Usar valores de product_code exclusivos para cada combinação facilita muito o controle de estoque e o atendimento dos pedidos, principalmente em produtos com muitas variações.

Exemplo de objeto de combinação

json
{
  "product_id": "101",
  "product_code": "TSH-BLK-M",
  "combination_hash": "842135592",
  "combination": {
    "12": "35",  // Size (option_id: 12) = Medium (variant_id: 35)
    "14": "41"   // Color (option_id: 14) = Black (variant_id: 41)
  },
  "amount": "25",
  "position": "20",
  "image_pairs": {
    "pair_id": "123",
    "image_id": "456",
    "detailed_id": "789",
    "position": "0",
    "detailed": {
      "image_path": "http://example.com/images/detailed/0/tshirt_black_m.jpg",
      "alt": "Black T-shirt Medium Size",
      "image_x": "800",
      "image_y": "1200",
      "http_image_path": "http://example.com/images/detailed/0/tshirt_black_m.jpg",
      "https_image_path": "https://example.com/images/detailed/0/tshirt_black_m.jpg"
    },
    "icon": {
      "image_path": "http://example.com/images/thumbnails/0/tshirt_black_m_thumb.jpg",
      "alt": "Black T-shirt Medium Size",
      "image_x": "200",
      "image_y": "300",
      "http_image_path": "http://example.com/images/thumbnails/0/tshirt_black_m_thumb.jpg",
      "https_image_path": "https://example.com/images/thumbnails/0/tshirt_black_m_thumb.jpg"
    }
  }
}

Trabalhando com estoque

As combinações são especialmente importantes para o controle de estoque. Quando um produto tem várias opções (como tamanho e cor), cada combinação única pode ter o seu próprio nível de estoque. Para o controle de estoque funcionar com combinações, garanta que:

  • O produto tenha o recurso de controle de estoque habilitado.
  • As opções relevantes tenham a configuração inventory="Y".
  • Cada combinação desejada tenha um valor de amount definido.

Endpoints

Listar as combinações de um produto

GET/api/products/{product_id}/option_combinationsAdmin

Retornar todas as combinações de opções de um produto

Parâmetros de caminho

product_idintegerobrigatório
O identificador único do produto.

Obter uma combinação específica

GET/api/option_combinations/{combination_hash}Admin

Retornar os detalhes de uma combinação de opções específica

Parâmetros de caminho

combination_hashstringobrigatório
O hash único da combinação de opções.

Criar uma combinação

POST/api/products/{product_id}/option_combinationsAdmin

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

Parâmetros de caminho

product_idintegerobrigatório
O identificador único do produto.

Corpo da requisição

product_codestring
O código de produto desta combinação específica.
combinationobjectobrigatório
As opções e variantes que formam a combinação.
amountinteger
A quantidade em estoque desta combinação.
positioninteger
A posição desta combinação na lista.
Atenção

Ao criar combinações, garanta que todos os IDs de opção e de variante informados no objeto combination existam e estejam associados ao produto indicado. IDs de opção ou de variante inválidos resultam em erro.

Veja também

  • Combinações de opções
  • Obter uma combinação de opções
  • Criar uma combinação de opções
Anterior
Obter uma combinação de opções
Próxima
Criar uma combinação de opções
Nesta página
  • Campos da combinação de opções
  • Exemplo de objeto de combinação
  • Trabalhando com estoque
  • Endpoints
  • Listar as combinações de um produto
  • Obter uma combinação específica
  • Criar uma combinação
  • Veja também