Atualizar item

curl --request PUT \
  --url https://integracao.sandbox.cardapioweb.com/api/partner/v1/catalog/items/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Margherita Especial",
  "price": 35,
  "status": "ACTIVE"
}
'

{
  "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
        }
      ]
    }
  ]
}

{
  "code": 4001,
  "message": "Requisição inválida.",
  "errors": {
    "name": [
      "não pode ficar em branco",
      "é muito curto (mínimo: 1 caractere)"
    ],
    "price": [
      "não é um número"
    ]
  }
}

{
  "code": 4010,
  "message": "Token inválido."
}

{
  "code": 4041,
  "message": "Recurso não encontrado."
}

This response has no body data.

PUT

api

partner

catalog

items

{id}

curl --request PUT \
  --url https://integracao.sandbox.cardapioweb.com/api/partner/v1/catalog/items/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Margherita Especial",
  "price": 35,
  "status": "ACTIVE"
}
'

{
  "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
        }
      ]
    }
  ]
}

{
  "code": 4001,
  "message": "Requisição inválida.",
  "errors": {
    "name": [
      "não pode ficar em branco",
      "é muito curto (mínimo: 1 caractere)"
    ],
    "price": [
      "não é um número"
    ]
  }
}

{
  "code": 4010,
  "message": "Token inválido."
}

{
  "code": 4041,
  "message": "Recurso não encontrado."
}

This response has no body data.

Autorizações

Authorization

string

header

obrigatório

Access token OAuth 2.0 de app instalado na CW App Store. Escopo: catalog.

Parâmetros de caminho

integer

obrigatório

ID do item.

Corpo

application/json

name

string

Nome do item. Deve ser único no estabelecimento.

Required string length: 1 - 500

description

string | null

Descrição do item. Suporta formatação: negrito (*texto*), itálico (_texto_) ou riscado (~texto~).

Maximum string length: 5000

category_id

integer

ID da categoria à qual o item pertence.

highlighted

boolean

Define se o item aparece em destaque.

external_code

string | null

Código externo do item.

Maximum string length: 50

price

number

Preço base do item. Deve ter no máximo 2 casas decimais.

Intervalo obrigatório: x >= 0

cost_price

number

Preço de custo do item. Deve ter no máximo 2 casas decimais.

Intervalo obrigatório: x >= 0

status

enum<string>

padrão:ACTIVE

Status do item.

ACTIVE: item ativo e visível.
INACTIVE: item oculto.
MISSING: item em falta.

Opções disponíveis:

ACTIVE,

INACTIVE,

MISSING

index

integer | null

Índice de exibição do item dentro da categoria.

Intervalo obrigatório: x >= 0

unit_type

enum<string>

padrão:UN

Unidade de medida do item.

UN: unidade (padrão).
KG: quilograma.
L: litro.

Opções disponíveis:

UN,

KG,

L

badge

enum<string> | null

Badge de destaque do item.

best_seller: mais vendido.
new_item: novidade.
recommended: recomendado.
limited_edition: edição limitada.

Opções disponíveis:

best_seller,

new_item,

recommended,

limited_edition

hide_observation_field

boolean

Define se o campo de observações deve ser escondido.

adults_only

boolean

Define se o item é apenas para maiores de 18 anos.

promotional_price

number | null

Preço promocional. Obrigatório quando promotional_price_active é true. Deve ser menor que price e ter no máximo 2 casas decimais.

Intervalo obrigatório: x >= 0

promotional_price_active

boolean

Ativa ou desativa o preço promocional.

promotional_price_schedules

PromotionalPriceSchedule · object[] | null

Define os dias e horários em que o preço promocional é aplicado.

Show child attributes

option_groups

object[]

Grupos de complementos a associar/desassociar do item.

Para atualizar o index de um grupo existente: envie option_group_id e o novo index.
Para remover um groupo do item: envie option_group_id e _destroy: true.

Show child attributes

Resposta

Item atualizado com sucesso.

Produto do cardápio que pode ser item regular ou combo.

integer

Identificador único do item.

name

string

Nome do item.

description

string | null

Descrição do item. Suporta formatação: negrito (*texto*), itálico (_texto_) ou riscado (~texto~).

image

Image · object | null

Imagem principal do item.

Show child attributes

highlighted

boolean

Indica se o item deve aparecer em destaque no site.

external_code

string | null

Código externo do item.

price

number

Preço base do item. Deve ser um número positivo com no máximo 2 casas decimais.

Intervalo obrigatório: x >= 0

cost_price

number

Preço de custo do item. Deve ser um número positivo com no máximo 2 casas decimais.

Intervalo obrigatório: x >= 0

stock

number

Quantidade disponível em estoque.

Intervalo obrigatório: x >= 0

active_stock_control

boolean

Indica se o controle de estoque está ativo.

index

integer | null

Índice de exibição do item dentro da categoria.

available_for

enum<string>[]

Locais onde o item está disponível.

delivery: cardápio digital de delivery e retirada.
internal_table: pedido de mesa pelo portal.
table: pedido de mesa pelo cardápio digital.
service_desk: cardápio digital de balcão e portal.
view_only: cardápio digital de visualização.

Opções disponíveis:

delivery,

table,

service_desk,

view_only,

internal_table

hide_observation_field

boolean

Indica se o campo de observações deve ser escondido.

adults_only

boolean

Indica se o item é apenas para maiores de 18 anos.

promotional_price_active

boolean

Indica se o preço promocional está ativo.

promotional_price

number | null

Preço promocional do item. Deve ser menor que price quando ativo. É obrigatório se promotional_price_active for true.

Intervalo obrigatório: x >= 0

promotional_price_schedules

PromotionalPriceSchedule · object[] | null

Horários em que o preço promocional é aplicado. Se promotional_price_active for true, define os dias e horários da promoção.

Show child attributes

status

enum<string>

Status do item.

ACTIVE: item ativo e visível.
INACTIVE: item oculto.
MISSING: item em falta.

Opções disponíveis:

ACTIVE,

INACTIVE,

MISSING

unit_type

enum<string>

padrão:UN

Unidade de medida do item.

UN: unidade (padrão).
KG: quilograma.
L: litro.

Opções disponíveis:

UN,

KG,

L

badge

enum<string> | null

Badge de destaque do item.

best_seller: mais vendido.
new_item: novidade.
recommended: recomendado.
limited_edition: edição limitada.

Opções disponíveis:

best_seller,

new_item,

recommended,

limited_edition

kind

enum<string>

Tipo do item.

regular_item: item normal.
combo: combo.

Opções disponíveis:

regular_item,

combo

allowed_times

AllowedTimes · object[]

Horários de disponibilidade do item. Array vazio significa sempre disponível.

Show child attributes

extra_images

(Image · object | null)[]

Imagens extras do item.

Imagem associada a um recurso (categoria, item ou opção).

Show child attributes

option_groups

Grupo de complementos (no item) · object[]

Grupos de complementos associados ao item. Disponível quando kind é regular_item.

Show child attributes

combo_steps

ComboStep · object[]

Etapas do combo. Disponível quando kind é combo.

Show child attributes

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

⌘I

API Autenticação

API Loja

API Catálogo

API Pedidos

Autorizações

Parâmetros de caminho

Corpo

Resposta