Модификаторы и налоги

Эта страница покрывает две группы эндпоинтов:

• Модификаторы продуктов (ProductModifiers) — опции и добавки к блюдам (например, степень прожарки, размер порции, дополнительные ингредиенты).
• Налоги продуктов (ProductTaxes) — справочник налоговых ставок, которые привязываются к продуктам.

Все запросы — под Bearer-токеном (см. Аутентификация). restaurantId — числовой path-параметр. Общие соглашения и ошибки — в разделах Соглашения и Ошибки. Каталог продуктов и групп описан в Меню: Каталог.

Базовый путь: /api/core/admin/restaurants/{restaurantId}.

Модификаторы продуктов

Модификатор (VendorProductModifier) — группа вариантов выбора для блюда. Каждый вариант (VendorAdditionValue) может нести собственную цену и налог. Модификатор задаёт правила выбора (одиночный/множественный, минимум/максимум) и может быть привязан к конкретным продуктам или целым группам продуктов.

Поля VendorProductModifier

Поля VendorAdditionValue (вариант выбора)

Цены вариантов. price каждого варианта — от нуля, не больше двух знаков после запятой и не больше 21474836.47; пустой price допустим. Создание или изменение с вариантом вне этих правил отклоняется с 400 и кодом invalid_price, в сообщении назван вариант:

{ "message": "The price of option 'Extra sauce' must not be below zero: -5.", "code": "invalid_price" }

Список

GET /modifiers

Возвращает массив VendorProductModifier.

curl -G https://api.hostmeapp.com/api/core/admin/restaurants/123/modifiers \
  -H "Authorization: Bearer $TOKEN"

Создать модификатор

POST /modifiers

Тело — VendorProductModifier. Ответ — созданный модификатор.

curl -X POST https://api.hostmeapp.com/api/core/admin/restaurants/123/modifiers \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "doneness",
    "displayName": "Степень прожарки",
    "multiselect": false,
    "minSelectedAmount": 1,
    "maxSelectedAmount": 1,
    "values": [
      { "name": "Medium", "price": 0, "default": true },
      { "name": "Well done", "price": 0 }
    ],
    "productIds": ["PRODUCT_ID"],
    "visible": true
  }'

Изменить модификатор

PUT /modifiers/{modifierId}

Тело — VendorProductModifier. Ответ — обновлённый модификатор.

Удалить модификатор

DELETE /modifiers/{modifierId}

curl -X DELETE https://api.hostmeapp.com/api/core/admin/restaurants/123/modifiers/MODIFIER_ID \
  -H "Authorization: Bearer $TOKEN"

Модификаторы конкретного меню. Помимо глобального справочника модификаторов есть эндпоинты для модификаторов в рамках одного меню: GET и PUT /menu/{menuId}/modifiers (объект VendorMenuModifier — те же поля, что у VendorProductModifier, но без productGroupIds/productIds). См. Меню: Каталог.

Налоги продуктов

Налог (VendorTax) — это ставка, которую можно применить к продуктам. Налог может быть включён в цену (vatInclusive) или начисляться сверху, может быть глобально включён/выключен и привязан к набору продуктов.

Поля VendorTax

Список

GET /taxes

Возвращает массив VendorTax.

curl -G https://api.hostmeapp.com/api/core/admin/restaurants/123/taxes \
  -H "Authorization: Bearer $TOKEN"

Создать налог

POST /taxes

Тело — VendorTax. Ответ — созданный налог.

curl -X POST https://api.hostmeapp.com/api/core/admin/restaurants/123/taxes \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "НДС 20%",
    "vatInclusive": true,
    "percentage": 20,
    "enabled": true,
    "productIds": ["PRODUCT_ID"]
  }'

Изменить налог

PUT /taxes/{taxId}

Тело — VendorTax. Ответ — обновлённый налог.

Удалить налог

DELETE /taxes/{taxId}

curl -X DELETE https://api.hostmeapp.com/api/core/admin/restaurants/123/taxes/TAX_ID \
  -H "Authorization: Bearer $TOKEN"

Связь с продуктом. У продукта есть массив taxIds (см. Меню: Каталог) — в нём перечислены ID применённых к нему налогов. Привязку можно задавать с обеих сторон: через productIds у налога и через taxIds у продукта.