Skip to main content
PUT
Atualizar categoria

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

id
integer
obrigatório

ID da categoria.

Corpo

application/json
name
string

Nome da categoria. Deve ser único no estabelecimento.

Required string length: 1 - 200
description
string | null

Descrição da categoria.

Maximum string length: 1000
index
integer | null

Índice de exibição da categoria no cardápio.

Intervalo obrigatório: x >= 0
status
enum<string>
padrão:ACTIVE

Status da categoria.

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

Resposta

Categoria atualizada com sucesso.

Categoria do cardápio que agrupa itens relacionados.

id
integer

Identificador único da categoria.

name
string

Nome da categoria.

description
null | string

Descrição da categoria.

index
integer | null

Índice de exibição da categoria.

status
enum<string>

Status da categoria.

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

Imagem da categoria.

allowed_times
AllowedTimes · object[]

Horários de disponibilidade da categoria. Array vazio significa sempre disponível.

items
Item · object[]

Lista de itens da categoria.

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