Pular para o conteúdo principal
GET
/
api
/
partner
/
v1
/
catalog
/
options
/
{id}
Consultar opção
curl --request GET \
  --url https://integracao.sandbox.cardapioweb.com/api/partner/v1/catalog/options/{id} \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-PARTNER-KEY: <api-key>'
{
  "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
}

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.

Parâmetros de caminho

​
id
integer
obrigatório

ID da opção.

Resposta

Opção retornada 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

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 27 de junho de 2026