Pular para o conteúdo principal
GET
/
api
/
partner
/
v1
/
catalog
/
items
Listar itens
curl --request GET \
  --url https://integracao.sandbox.cardapioweb.com/api/partner/v1/catalog/items \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-PARTNER-KEY: <api-key>'
{
  "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
            }
          ]
        }
      ]
    }
  ],
  "meta": {
    "page": 123,
    "per_page": 123,
    "total": 123,
    "total_pages": 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 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 itens retornada com sucesso.

items
Item · object[]
meta
PaginationMeta · object

Metadados de paginação.

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