VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Guia rápido/Variações e opções

Opções do produto

Lista as opções de compra de um produto (tamanho, gravação, cor da fita) com os valores de cada uma.

Uma opção é uma escolha que o cliente faz no carrinho sobre um produto: "Tamanho" (lista), "Gravação" (texto livre), "Embalagem para presente" (caixa de seleção). Cada opção tem valores (P, M, G), e cada valor pode somar preço e peso e acrescentar um sufixo ao SKU. Os valores vêm dentro de cada opção, no objeto variants.

Opções não têm estoque próprio: o estoque continua sendo o do produto. Se cada tamanho precisa de estoque, use Variações.

Listar opções

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

Listar as opções 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}/options, com ids decimais em string. Um produto sem opções ou inexistente devolve lista vazia com 200.

Parâmetros de caminho

idstringobrigatório
Id do produto (UUID; decimal em /api/products/{id}/options).

Exemplo de requisição

bash
curl "$BASE_URL/api/v1.0/products/07635228-fcac-442e-9a0c-caa7c1c89a97/options" \
  -u "$EMAIL:$API_KEY"

Resposta

200Opções do produto
json
{
  "product_id": "07635228-fcac-442e-9a0c-caa7c1c89a97",
  "total": 1,
  "options": [
    {
      "option_id": "d89e2489-1661-423e-9cda-dc2c2903fcf4",
      "product_id": "07635228-fcac-442e-9a0c-caa7c1c89a97",
      "option_name": "Tamanho da camiseta",
      "option_type": "S",
      "required": "Y",
      "position": 0,
      "variants": {
        "8770ee09-1b35-418e-bac1-60b4435ca24c": {
          "variant_id": "8770ee09-1b35-418e-bac1-60b4435ca24c",
          "variant_name": "GG",
          "modifier": "5.00",
          "modifier_type": "A",
          "weight_modifier": 50,
          "weight_modifier_type": "A",
          "sku_suffix": "-GG",
          "position": 3
        }
      }
    }
  ]
}

Campos da resposta

product_idstring
Id do produto consultado.
totalinteger
Quantidade de opções.
options[].option_typestring
SRCITF
S select (também usado para color), R radio, C checkbox, I texto, T textarea, F arquivo.
options[].requiredstring
YN
Obrigatória ou não.
options[].variantsobject
Valores, indexados pelo id do valor. modifier é string decimal; modifier_type é A (absoluto, em reais) ou P (percentual).

Erros

StatusQuandoExemplo de corpo
401Sem credenciais ou chave inválida{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}
500Id que não é UUID (/products/abc/options){"message":"Failed to retrieve product options","status":500}

Veja também

  • Variações
Anterior
Variações e opções
Próxima
Variações (produtos filhos)
Nesta página
  • Listar opções
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também