Pular para o conteúdo principal
POST
/
api
/
partner
/
v1
/
catalog
/
option_groups
Criar grupo de complementos
curl --request POST \
  --url https://integracao.sandbox.cardapioweb.com/api/partner/v1/catalog/option_groups \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-PARTNER-KEY: <api-key>' \
  --data '
{
  "name": "Tamanho",
  "status": "ACTIVE",
  "choice_type": "SINGLE",
  "price_calculation_type": "SUM",
  "minimum_quantity": 1,
  "maximum_quantity": 1,
  "options": [
    {
      "option_id": 2883,
      "price": 10,
      "index": 1
    },
    {
      "option_id": 2884,
      "price": 15,
      "index": 2
    },
    {
      "option_id": 2885,
      "price": 20,
      "index": 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
    }
  ]
}

Autorizações

​
X-PARTNER-KEY
string
header
obrigatório

Token de autenticação da integradora. Para ter esse token, a integradora precisa estar previamente cadastrada em nosso sistema. Deve ser enviado no header X-PARTNER-KEY.

​
X-API-KEY
string
header
obrigatório

Token de autenticação da API. Deve ser enviado no header X-API-KEY.

Corpo

application/json
​
name
string
obrigatório

Nome do grupo de complementos.

Required string length: 1 - 100
​
status
enum<string>
padrão:ACTIVE
obrigatório

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
obrigatório

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
obrigatório

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
obrigatório

Quantidade mínima de opções.

Intervalo obrigatório: x >= 0
​
maximum_quantity
integer
obrigatório

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

Intervalo obrigatório: x >= 1
​
options
object[]

Opções a associar ao grupo.

Resposta

Grupo de complementos criado com sucesso.

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

​
id
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.

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