Unidades de Medida

Criação de Unidade de Medida

Este endpoint é utilizado para criar novas unidades de medida para serem associadas aos itens de catálogo da loja (Ex: gramas, quilogramas, litros).

POST

/catalog/{store_id}/sizes

Payload Criação de Unidade de Medida

{
  "name": "grama",
  "reference": "g",
  "status": true,
  "menu_category_ids": []
}

Detalhamento do Payload

Campo	Obrigatório	Descrição
name	✅	Nome da Unidade de Medida. O nome completo que descreve a unidade (Ex: "Grama", "Litro", "Unidade").
reference	✅	Referência/Símbolo da Unidade. A abreviação ou símbolo curto da unidade (Ex: "g" para Grama, "ml" para Mililitro). Regra de Visibilidade: Este é o símbolo (ou abreviação) da unidade que o cliente verá no produto.
status	❌	Status da Unidade. Indica se a unidade de medida estará ativa (true) ou inativa (false). Regra: Se não for enviado, a unidade é criada com o status ativada (true).
menu_category_ids	❌	IDs de Categoria de Menu. Permite configurar um tamanho para toda a categoria.

Atualização de Unidade de Medida

Este endpoint é utilizado para modificar os detalhes de uma unidade de medida existente no catálogo da loja, como seu nome, símbolo de referência ou status de ativação. A requisição pode ser feita utilizando PUT ou PATCH.

PUT

/catalog/{store_id}/sizes/{id}

PATCH

/catalog/{store_id}/sizes/{id}

Payload Atualização de Unidade de Medida

A atualização é realizada no corpo da requisição (payload), sendo possível enviar apenas o campo que se deseja alterar (atualização parcial).

Campo	Obrigatório	Descrição
id (na URL)	✅	O ID único da unidade de medida a ser atualizada.
name	❌	Nome da Unidade de Medida. O nome completo (Ex: "Grama", "Litro").
reference	❌	Referência/Símbolo da Unidade. O símbolo que o cliente verá no produto (Ex: "g", "ml").
status	❌	Status da Unidade. Define se a unidade estará ativa (true) ou inativa (false).

Consulta de Unidades de Medida

Este endpoint é utilizado para consultar todas as unidades de medida (sizes) cadastradas e disponíveis para serem associadas aos itens de catálogo da loja.

GET

/catalog/{store_id}/sizes

Retorno de Sucesso (Status Code 200)

O retorno é um objeto contendo um array na chave data com a lista de unidades de medida.

Campo	Descrição
data	Array principal contendo os objetos de unidades de medida.
data[].id	ID único da unidade de medida.
data[].name	Nome completo da unidade (Ex: "grama", "litro").
data[].reference	Símbolo ou abreviação da unidade que o cliente verá no produto (Ex: "g", "ml").
data[].status	Status da unidade: true (ativa) ou false (inativa).
data[].blocked_until_tomorrow	Flag que indica se a unidade está bloqueada para alterações até o dia seguinte (true ou false).