Skip to main content
POST
Criar opção

Autorizações

Authorization
string
header
obrigatório

Access token OAuth 2.0 de app instalado na CW App Store. Escopo: catalog.

Corpo

application/json
name
string
obrigatório

Nome da opção. Deve ser único no estabelecimento.

Required string length: 1 - 500
description
string | null

Descrição da opção.

Maximum string length: 1000
cost_price
number

Preço de custo da opção. Deve ser um número positivo com no máximo 2 casas decimais.

Intervalo obrigatório: x >= 0
external_code
string | null

Código externo da opção.

Maximum string length: 50
status
enum<string>
padrão:ACTIVE

Status da opção.

  • ACTIVE: opção ativa e visível.
  • INACTIVE: opção oculta.
  • MISSING: opção em falta.
Opções disponíveis:
ACTIVE,
INACTIVE,
MISSING

Resposta

Opção criada com sucesso.

Opção que pode ser associada a múltiplos grupos de complementos.

id
integer

Identificador único da opção.

name
string

Nome da opção.

description
null | string

Descrição da opção.

external_code
null | string

Código externo da opção.

status
enum<string>

Status da opção.

  • ACTIVE: opção ativa e visível.
  • INACTIVE: opção oculta.
  • MISSING: opção em falta.
Opções disponíveis:
ACTIVE,
INACTIVE,
MISSING
image
Image · object | null

Imagem da opção.

cost_price
number | null

Preço de custo da opção.

Intervalo obrigatório: x >= 0
active_stock_control
boolean

Indica se o controle de estoque está ativo.

stock
number | null

Quantidade disponível em estoque.

Última modificação em 30 de junho de 2026