Logo da Plataforma Yep
API REST · Plataforma Yep Documentação técnica para integrações homologadas

Opções customizadas

Opções personalizadas de produto: campos de texto (como gravação), listas de escolha e precificação variável por opção.

Field Drop-down Precificação

Visão geral

Criação, atualização, consulta e remoção de opções personalizadas de produto. Cada opção aceita configurações específicas como preço fixo ou percentual, tamanho máximo e SKU derivado.

POST/api2/products/customOption

Criar opção personalizada do tipo campo (field).

{
  "sku": "PRODUTO-001",
  "title": "Nome para gravação",
  "type": "field",
  "is_require": 1,
  "config": {
    "price": 5,
    "price_type": "fixed",
    "sku": "GRAVACAO",
    "max_characters": 30
  }
}
POST/api2/products/customOption

Criar opção personalizada do tipo lista (drop-down).

{
  "sku": "PRODUTO-001",
  "title": "Escolha o Tamanho",
  "type": "drop_down",
  "is_require": 1,
  "values": [
    {"title": "Pequeno", "price": 0, "price_type": "fixed", "sku": "TAM-P"},
    {"title": "Médio", "price": 10, "price_type": "fixed", "sku": "TAM-M"}
  ]
}
PATCH/api2/products/customOption

Atualizar metadados da opção personalizada.

{
  "option_id": 18,
  "title": "Novo Título",
  "is_require": 0,
  "sort_order": 2
}
GET/api2/products/customOption?option_id=19

Consultar opção personalizada por ID.

DELETE/api2/products/customOption

Excluir opção personalizada do produto.

{
  "option_id": 19
}