@ deliverart/ sdk-js- 菜单
交付艺术JavaScript SDK的菜单管理软件包. 提供菜单版本,菜单项目,类别,修饰符,和价格超标的管理方法.
安装
npm install @deliverart/sdk-js-menu @deliverart/sdk-js-core
# or
pnpm add @deliverart/sdk-js-menu @deliverart/sdk-js-core
# or
yarn add @deliverart/sdk-js-menu @deliverart/sdk-js-core
特征
- 菜单版本: 获取菜单版本及其细节
- 菜单项目: 菜单项的完整 CRUD 操作
- 菜单项目类别: 管理菜单项类别
- 菜单项目修改器: 获取菜单项目修改器及其细节
- 菜单项目价格覆盖: 管理菜单项的价格覆盖
使用量
菜单版本
获取菜单版本
import { GetMenuVersions } from '@deliverart/sdk-js-menu'
const menuVersions = await client.call(new GetMenuVersions({
query: {
page: 1,
itemsPerPage: 20,
}
}))
获取菜单版本细节
import { GetMenuVersionDetails } from '@deliverart/sdk-js-menu'
const menuVersion = await client.call(new GetMenuVersionDetails('menu-version-id'))
MenuItemDto.compositions 包含可移动基底的菜单项 id
成份/成份。 创建命令清除时, 请参考其中之一 ids
在可写入命令的项目中 removals 阵列.
菜单项目
获取菜单项目
import { GetMenuItems } from '@deliverart/sdk-js-menu'
const menuItems = await client.call(new GetMenuItems({
query: {
page: 1,
itemsPerPage: 20,
}
}))
获取菜单项目细节
import { GetMenuItemDetails } from '@deliverart/sdk-js-menu'
const menuItem = await client.call(new GetMenuItemDetails('menu-item-id'))
创建菜单项目
import { CreateMenuItem } from '@deliverart/sdk-js-menu'
const newMenuItem = await client.call(new CreateMenuItem({
name: [
{ locale: 'en', value: 'Margherita Pizza' },
{ locale: 'it', value: 'Pizza Margherita' }
],
description: [
{ locale: 'en', value: 'Classic tomato and mozzarella' },
{ locale: 'it', value: 'Classica pomodoro e mozzarella' }
],
price: 12.99,
category: '/api/menu-item-categories/123',
// ... other fields
}))
更新菜单项目
import { UpdateMenuItem } from '@deliverart/sdk-js-menu'
const updated = await client.call(new UpdateMenuItem('menu-item-id', {
price: 13.99,
}))
删除菜单项目
import { DeleteMenuItem } from '@deliverart/sdk-js-menu'
await client.call(new DeleteMenuItem('menu-item-id'))
菜单项目类别
获取菜单项目类别
import { GetMenuItemCategories } from '@deliverart/sdk-js-menu'
const categories = await client.call(new GetMenuItemCategories({
query: {
page: 1,
itemsPerPage: 20,
}
}))
获取菜单项目分类细节
import { GetMenuItemCategoryDetails } from '@deliverart/sdk-js-menu'
const category = await client.call(new GetMenuItemCategoryDetails('category-id'))
创建菜单项目类别
import { CreateMenuItemCategory } from '@deliverart/sdk-js-menu'
const newCategory = await client.call(new CreateMenuItemCategory({
name: [
{ locale: 'en', text: 'Pizzas' },
{ locale: 'it', text: 'Pizze' }
],
pointOfSale: '/point_of_sales/123e4567-e89b-12d3-a456-426614174000',
// ... other fields
}))
更新菜单项目类别
import { UpdateMenuItemCategory } from '@deliverart/sdk-js-menu'
const updated = await client.call(new UpdateMenuItemCategory('category-id', {
name: [
{ locale: 'en', value: 'Updated Category' }
]
}))
删除菜单项目类别
import { DeleteMenuItemCategory } from '@deliverart/sdk-js-menu'
await client.call(new DeleteMenuItemCategory('category-id'))
菜单项目修改器
获取菜单项目修改器
import { GetMenuItemModifiers } from '@deliverart/sdk-js-menu'
const modifiers = await client.call(new GetMenuItemModifiers({
query: {
page: 1,
itemsPerPage: 20,
}
}))
获取菜单项目修改细节
import { GetMenuItemModifierDetails } from '@deliverart/sdk-js-menu'
const modifier = await client.call(new GetMenuItemModifierDetails('modifier-id'))
菜单项目价格覆盖
管理特定菜单项、销售点或时间段的价格超标.
import {
GetMenuItemPriceOverrides,
GetMenuItemPriceOverrideDetails,
CreateMenuItemPriceOverride,
UpdateMenuItemPriceOverride,
DeleteMenuItemPriceOverride
} from '@deliverart/sdk-js-menu'
// Get price overrides
const overrides = await client.call(new GetMenuItemPriceOverrides({
query: {
page: 1,
itemsPerPage: 20,
}
}))
// Create a price override
const override = await client.call(new CreateMenuItemPriceOverride({
menuItem: '/api/menu-items/123',
price: 15.99,
pointOfSale: '/api/point-of-sales/456',
// ... other fields
}))
许可证
麻省理工学院
搜索菜单名称
所有项目(包括 ITEM, (中文(简体) ), CHOICE 财务报告和审定财务报表 BUNDLE页:1
请求接受 query.name。它匹配任意一个对大小写不敏感的子字符串
译名. 空间、口音和发音都保留下来了, % 财务报告和审定财务报表 _
是字面字符,空白输入则被忽略。 现有 nameSort 过滤器
为兼容起见,保留项目/类别.
const products = await client.call(new GetMenuItemsFromPointOfSale(posId, {
query: { name: 'Pizza Margherita', type: 'ITEM', page: 1 },
}))
const modifiers = await client.call(new GetMenuItemModifiersFromPointOfSale(posId, {
query: { name: 'Extra cheese', scope: 'global', page: 1 },
}))
在 Hub 中使用 POS 扫描请求并保留活动类型/ 镜像和其他 更改搜索时过滤。 更改过滤器后将页面重置为 1 .
价格超标的背景增值税
价格覆盖读取,嵌入式本地变体和 MenuPriceOverrideDto 曝光
taxRate: number | null。 。 。 . null 继承引用菜单项的增值税; a
明确 0 绝对是零。 值从0到100不等. 旧字段缺失
读取有效载荷 null。 。 。 .
创建和提供 PATCH 投入 taxRate。仅在编辑时省略
a 价格: API 保留现有的上下文率。 发送 null 仅在
明确恢复遗产。 更新覆盖不更改
引用菜单项目的全球增值税.