Atualizar grupo de complementos

curl --request PUT \
  --url https://integracao.sandbox.cardapioweb.com/api/partner/v1/catalog/option_groups/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Tamanho da pizza",
  "maximum_quantity": 3
}
'

{
  "id": 123,
  "name": "<string>",
  "minimum_quantity": 1,
  "maximum_quantity": 2,
  "options": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "external_code": "<string>",
      "image": {
        "image_url": "<string>",
        "thumbnail_url": "<string>"
      },
      "cost_price": 1,
      "active_stock_control": true,
      "stock": 123,
      "index": 123,
      "max_quantity": 123,
      "price": 1
    }
  ]
}

{
  "code": 4001,
  "message": "Requisição inválida.",
  "errors": {
    "name": [
      "não pode ficar em branco",
      "é muito curto (mínimo: 1 caractere)"
    ],
    "price": [
      "não é um número"
    ]
  }
}

{
  "code": 4010,
  "message": "Token inválido."
}

{
  "code": 4041,
  "message": "Recurso não encontrado."
}

This response has no body data.

PUT

api

partner

catalog

option_groups

{id}

curl --request PUT \
  --url https://integracao.sandbox.cardapioweb.com/api/partner/v1/catalog/option_groups/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Tamanho da pizza",
  "maximum_quantity": 3
}
'

{
  "id": 123,
  "name": "<string>",
  "minimum_quantity": 1,
  "maximum_quantity": 2,
  "options": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "external_code": "<string>",
      "image": {
        "image_url": "<string>",
        "thumbnail_url": "<string>"
      },
      "cost_price": 1,
      "active_stock_control": true,
      "stock": 123,
      "index": 123,
      "max_quantity": 123,
      "price": 1
    }
  ]
}

{
  "code": 4001,
  "message": "Requisição inválida.",
  "errors": {
    "name": [
      "não pode ficar em branco",
      "é muito curto (mínimo: 1 caractere)"
    ],
    "price": [
      "não é um número"
    ]
  }
}

{
  "code": 4010,
  "message": "Token inválido."
}

{
  "code": 4041,
  "message": "Recurso não encontrado."
}

This response has no body data.

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

integer

obrigatório

ID do grupo de complementos.

Corpo

application/json

name

string

Nome do grupo de complementos.

Required string length: 1 - 100

status

enum<string>

padrão:ACTIVE

Status do grupo de complementos.

ACTIVE: grupo ativo e visível.
INACTIVE: grupo oculto.
MISSING: grupo em falta.

Opções disponíveis:

ACTIVE,

INACTIVE,

MISSING

choice_type

enum<string>

padrão:SINGLE

Regra de escolha das opções no grupo.

SINGLE: apenas uma opção pode ser escolhida.
MULTIPLE: mais de uma opção pode ser escolhida, sem repetição.
SUMMABLE: mais de uma opção pode ser escolhida, com repetição permitida.

Opções disponíveis:

SINGLE,

MULTIPLE,

SUMMABLE

price_calculation_type

enum<string>

padrão:SUM

Regra de cálculo do preço quando múltiplas opções são selecionadas.

SUM: soma dos preços das opções selecionadas.
MEAN: média dos preços das opções selecionadas.
MAX: preço da opção mais cara entre as selecionadas.
MIN: preço da opção mais barata entre as selecionadas.

Opções disponíveis:

SUM,

MEAN,

MAX,

MIN

minimum_quantity

integer

Quantidade mínima de opções.

Intervalo obrigatório: x >= 0

maximum_quantity

integer

Quantidade máxima de opções. Deve ser >= minimum_quantity.

Intervalo obrigatório: x >= 1

options

object[]

Opções a associar/atualizar/remover no grupo.

Show child attributes

Resposta

Grupo de complementos atualizado com sucesso.

Grupo de complementos reutilizável que pode ser associado a múltiplos itens.

integer

Identificador único do grupo de complementos.

name

string

Nome do grupo de complementos.

status

enum<string>

Status do grupo de complementos.

ACTIVE: grupo ativo e visível.
INACTIVE: grupo oculto.
MISSING: grupo em falta.

Opções disponíveis:

ACTIVE,

INACTIVE,

MISSING

choice_type

enum<string>

Regra de escolha das opções no grupo.

SINGLE: apenas uma opção pode ser escolhida.
MULTIPLE: mais de uma opção pode ser escolhida, sem repetição.
SUMMABLE: mais de uma opção pode ser escolhida, com repetição permitida.

Opções disponíveis:

SINGLE,

MULTIPLE,

SUMMABLE

price_calculation_type

enum<string>

Regra de cálculo do preço quando múltiplas opções são selecionadas.

SUM: soma dos preços das opções selecionadas.
MEAN: média dos preços das opções selecionadas.
MAX: preço da opção mais cara entre as selecionadas.
MIN: preço da opção mais barata entre as selecionadas.

Opções disponíveis:

SUM,

MEAN,

MAX,

MIN

minimum_quantity

integer

Quantidade mínima de opções que devem ser selecionadas.

Intervalo obrigatório: x >= 0

maximum_quantity

integer

Quantidade máxima de opções que podem ser selecionadas.

Intervalo obrigatório: x >= 1

options

Opção (no grupo de complemento) · object[]

Lista das opções do grupo, com seus preços e configurações dentro do grupo.

Show child attributes

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

⌘I

API Autenticação

API Loja

API Catálogo

API Pedidos

Atualizar grupo de complementos

Autorizações

Parâmetros de caminho

Corpo

Resposta