Pular para o conteúdo principal
GET
/
api
/
partner
/
v1
/
catalog
/
options
Listar opções
curl --request GET \
  --url https://integracao.sandbox.cardapioweb.com/api/partner/v1/catalog/options \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-PARTNER-KEY: <api-key>'
{
  "options": [
    {
      "id": 2883,
      "name": "Pequena",
      "description": null,
      "external_code": null,
      "status": "ACTIVE",
      "image": null,
      "cost_price": null,
      "active_stock_control": false,
      "stock": 0
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 30,
    "total": 1,
    "total_pages": 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.

Parâmetros de consulta

page
integer
padrão:1

Número da página.

Intervalo obrigatório: x >= 1
per_page
integer

Quantidade de itens por página.

Intervalo obrigatório: 1 <= x <= 100

Resposta

Lista de opções retornada com sucesso.

options
Opção · object[]
meta
PaginationMeta · object

Metadados de paginação.

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