Pular para o conteúdo principal
GET
/
api
/
partner
/
v1
/
catalog
/
categories
/
{id}
Consultar categoria
curl --request GET \
  --url https://integracao.sandbox.cardapioweb.com/api/partner/v1/catalog/categories/{id} \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-PARTNER-KEY: <api-key>'
{
  "id": 123,
  "name": "<string>",
  "description": "<string>",
  "index": 123,
  "image": {
    "image_url": "<string>",
    "thumbnail_url": "<string>"
  },
  "allowed_times": [
    {
      "start_at": "18:00",
      "end_at": "23:00"
    }
  ],
  "items": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "image": {
        "image_url": "<string>",
        "thumbnail_url": "<string>"
      },
      "highlighted": true,
      "external_code": "<string>",
      "price": 1,
      "cost_price": 1,
      "stock": 1,
      "active_stock_control": true,
      "index": 123,
      "available_for": [],
      "hide_observation_field": true,
      "adults_only": true,
      "promotional_price_active": true,
      "promotional_price": 1,
      "promotional_price_schedules": [
        {
          "start": "18:00",
          "end": "23:00"
        }
      ],
      "unit_type": "UN",
      "allowed_times": [
        {
          "start_at": "18:00",
          "end_at": "23:00"
        }
      ],
      "extra_images": [
        {
          "image_url": "<string>",
          "thumbnail_url": "<string>"
        }
      ],
      "option_groups": [
        {
          "id": 123,
          "name": "<string>",
          "minimum_quantity": 1,
          "maximum_quantity": 2,
          "index": 123,
          "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
            }
          ]
        }
      ],
      "combo_steps": [
        {
          "id": 123,
          "name": "<string>",
          "price": 1,
          "remove_add_on_prices": true,
          "index": 123,
          "combo_step_items": [
            {
              "item_id": 123,
              "index": 123,
              "additional_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.

Parâmetros de caminho

id
integer
obrigatório

ID da categoria.

Resposta

Categoria retornada 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

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