开发前必读

简介

快速开始

开发者账号

开发者需要申请准入麦当劳开放平台，审核通过后分配开发者账号。
麦当劳商户平台：申请准入

接口权限

开发者为应用（AppId）申请订阅接口权限，否则无权限调用 API。

开发环境

麦当劳开放平台区分生产环境（PROD）和 测试环境（UAT）。

开发环境均开启了签名校验，调用方法参见下文。请区分环境使用对应的 MerchantId、AppId、key。

环境	域名
UAT （测试环境）	https://api-uat.open.mcdchina.net
PROD（生产环境）	https://api.open.mcd.cn

注1：原生产环境 API 域名 https://open.mcdchina.net 即将下线，请尽快切换。

注2：其他测试环境以麦当劳对接人员通知为准。

接口调用

Header 参数

header 中必需要传的参数:

参数名	示例
AppId	麦当劳商户应用ID，具体由麦中提供
MerchantId	麦当劳商户ID，具体由麦中提供
Timestamp	毫秒:System.currentTimeMillis()
Sign	签名算法获取的值，参考下文签名算法
Version	1.0

Sign 签名

Sign 签名生成代码示例：

// Java 签名代码示例
String signStr = String.format("AppId=%s&Body=%s&MerchantId=%s&Timestamp=%s&key=%s", appId, body, merchantId, timestamp, key);
return Md5Util.md5(signStr).toUpperCase();

参数说明：

AppId：麦当劳商户应用ID

Body：区分 GET、POST 请求：

GET 请求：获取请求 url 中除去请求协议和域名部分作为 Body，路径部分不支持中文，参数可以有中文。若参数包含Json字符等特殊字符的情况，对特殊参数值进行encodeURIComponent 编码请求，Sign 仍采用原始字符签名做请求。示例：Body=/cms/pages/getInfo.action?draftId=14581274&status=1

POST 请求：以 JSON 字符串形式传递, 暂不支持文件上传。示例：Body={"member_no":"12345","beat_time":1490787356,"rand_num":"1"}

MerchantId：麦当劳商户ID

Timestamp：请求方 unix 时间戳毫秒数，要求与网关时间差小于 10分钟，防止请求重放。

key：签名密钥，由麦当劳提供，与 AppId、MerchantId 对应使用。

接口文档

预付券

POST 下单发码

访问地址: /coupon/order

定义

POST /coupon/order

请求示例

curl -X POST "https://api.open.mcd.cn/coupon/order" \
  -H "accept: application/json" \
  -H "MerchantId: Lorem ipsum do" \
  -H "Content-Type: application/json" \

  -d "{\"outRequestNo\":\"Lorem ipsu\",\"orderGoods\":[{\"count\":55,\"skuId\":66}],\"customerMobileNo\":\"Lorem ipsum d\"}"

返回结果示例


{
  "orderId": "Lorem ipsum d"
}

入参说明(在HTTP头部)

名称	描述	数据类型	必填
MerchantId	必传，商户编号	string	是

入参说明(在BODY)

outRequestNo: 第三方系统订单号string必须

orderGoods: 下单商品，目前只支持传1个商品array必须
- count: 商品数量integer
- skuId: 商品编号integer

customerMobileNo: 下单手机号，AES加密string必须

返参说明

orderId: string

GET 查询订单券码

访问地址: /coupon/order/codes

定义

GET /coupon/order/codes

请求示例

curl -X GET "https://api.open.mcd.cn/coupon/order/codes?orderId=Loremipsu&outRequestNo=Loremipsumdolors" \
  -H "accept: application/json" \
  -H "MerchantId: Lorem ipsum " \

返回结果示例


{
  "total": 8,
  "size": 12,
  "coupons": [
    {
      "outRequestNo": "Lorem ipsu",
      "couponName": "Lorem ipsum dolor ",
      "orderId": "Lorem ipsum dolor s",
      "useStartTime": "Lorem ipsum dolo",
      "totalUseCount": 56,
      "bindCustomerMobileNo": "Lorem ipsum dolor",
      "useStoreCode": "Lorem ipsum dolo",
      "codeStatus": 0,
      "availableUseCount": 28,
      "useEndTime": "Lorem ipsu",
      "bindCustomerId": "Lorem ipsum dolor ",
      "bindTime": "Lorem ipsum d",
      "useTime": "Lorem ipsum dolor ",
      "couponCode": "Lorem ipsum dolor "
    }
  ],
  "pageNo": 99
}

入参说明(在HTTP头部)

名称	描述	数据类型	必填
MerchantId	必传，商户编号	string	是

入参说明(在GET)

名称	描述	数据类型	必填
orderId	orderId	string	否
outRequestNo	outRequestNo	string	否

返参说明

total: 总条数integer必须

size: 每页条数integer必须

coupons: 券列表array必须M
- outRequestNo: 第三方订单号string可选
- couponName: 卡券名称string必须
- orderId: 订单号string可选
- useStartTime: 券核销开始时间string必须
- totalUseCount: 券核销总次数integer必须
- bindCustomerMobileNo: 券绑定手机号string可选
- useStoreCode: 券核销门店codestring可选
- codeStatus: 券状态integer必须
- availableUseCount: 券剩余可核销次数integer必须
- useEndTime: 券核销结束时间string必须
- bindCustomerId: 券绑定会员IDstring可选
- bindTime: 券绑定时间string可选
- useTime: 券核销时间string可选
- couponCode: 卡券编号string必须

pageNo: 当前页码integer必须

POST 取消订单

访问地址: /coupon/order/cancel

定义

POST /coupon/order/cancel

请求示例

curl -X POST "https://api.open.mcd.cn/coupon/order/cancel" \
  -H "accept: application/json" \
  -H "MerchantId: Lorem ipsum dolor " \
  -H "Content-Type: application/json" \

  -d "{\"outRequestNo\":\"Lorem ipsum dol\",\"orderId\":\"Lorem ipsum d\"}"

返回结果示例


{
  "flag": 0,
  "refundAmount": 90
}

入参说明(在HTTP头部)

名称	描述	数据类型	必填
MerchantId	必传，商户编号	string	是

入参说明(在BODY)

outRequestNo: 第三方系统订单号string

orderId: 订单号string

返参说明

flag: 取消结果，true为成功，false为失败boolean

refundAmount: 退款金额，单位为分，成功时返回integer

非预付券

POST 领取优惠券

访问地址: /coupon/customer/bind

定义

POST /coupon/customer/bind

请求示例

curl -X POST "https://api.open.mcd.cn/coupon/customer/bind" \
  -H "accept: application/json" \
  -H "Request-System: Lorem ipsum dol" \
  -H "Sign: 0600e67a6c120bd69777450f5066adc6" \
  -H "Timestamp: 1624269530114" \
  -H "TraceId: Lorem ipsum dol" \
  -H "Version: 2.0" \
  -H "Content-Type: application/json" \

  -d "{\"tradeNo\":\"Lorem ipsum dolor\",\"coupons\":[{\"couponId\":\"Lorem ipsum dol\",\"receiveQuantity\":45}],\"customerId\":\"Lorem ipsum d\",\"tradeSystem\":\"Lorem ipsum dol\",\"receiveType\":1,\"channelCode\":\"Lorem ipsum dolor\",\"customerMobileNo\":\"Lorem ipsum\"}"

返回结果示例


{
  "msg": "Lorem ipsum dolor",
  "code": "Lorem ipsum dolor",
  "data": {
    "failNum": 21,
    "tradeNo": "Lorem ipsum dolor si",
    "coupons": [
      {
        "couponCodes": [
          {
            "couponCodeEndTime": "Lorem ipsum dolor ",
            "couponCodeStartTime": "Lorem ipsum dolor ",
            "couponId": "Lorem ipsum dolor s",
            "cardNo": "Lorem ipsu",
            "couponCode": "Lorem ipsum dolor"
          }
        ],
        "msg": "Lorem ipsum do",
        "result": "Lorem ipsu",
        "success": 1,
        "couponTradeTimeList": [
          {
            "tradeEndDate": "Lorem ipsum dolor si",
            "couponTradeTimeType": 33,
            "tradeStartDate": "Lorem ipsu"
          }
        ],
        "couponId": "Lorem ipsum dolor ",
        "campaignName": "Lorem ipsum dolor "
      }
    ],
    "successNum": 81,
    "customerId": "Lorem ipsu",
    "sign": "0600e67a6c120bd69777450f5066adc6",
    "customerMobileNo": "Lorem ipsu"
  }
}

入参说明(在HTTP头部)

名称	描述	数据类型	必填
Request-System	请求系统	string	否
Sign	签名	string	否
Timestamp	时间戳	string	否
TraceId	请求流水号	string	否
Version	接口版本号，如无特别说明，请使用 1.0	string	是

入参说明(在BODY)

tradeNo: 交易号，追溯系统间调用记录，需保证全局唯一；若领券失败，再次调用允许使用同一交易号string必须

coupons: 待领取卡券，目前仅能发单张券array必须M
- couponId: 卡券IDstring必须
- receiveQuantity: 领取数量，若不传默认为1。目前版本仅支持单张券integer可选

customerId: MeddyId，若无则customerMobileNo必传string可选

tradeSystem: 交易方: 固定值，请联系对接人员获取string必须

receiveType: 领券类型： 6.手机号领券，否则则不传integer可选

channelCode: 领取渠道：请联系对接人员获取string必须

customerMobileNo: 领取用户手机号码string可选

返参说明

msg: 状态描述string

code: 状态代码string

data: CouponReceiveResp
- failNum: integer
- tradeNo: 交易号string
- coupons: 领券结果列表array必须M
  - couponCodes: 券码列表array可选
    - couponCodeEndTime: string
    - couponCodeStartTime: string
    - couponId: string
    - cardNo: string
    - couponCode: string
  - msg: 详情描述string可选
  - result: 领取结果string可选
  - success: 领取成功boolean可选
  - couponTradeTimeList: 可核销时间段array可选
    - tradeEndDate: string
    - couponTradeTimeType: integer
    - tradeStartDate: string
  - couponId: 卡券IDstring必须
  - campaignName: 优惠券名称string可选
- successNum: integer
- customerId: 用户IDstring
- sign: 签名string
- customerMobileNo: 手机号string

GET 查询领取优惠券结果

访问地址: /coupon/customer/getable

定义

GET /coupon/customer/getable

请求示例

curl -X GET "https://api.open.mcd.cn/coupon/customer/getable?couponIds=Loremipsumdol&tradeNo=Loremipsumdol&tradeSystem=Loremipsum" \
  -H "accept: application/json" \
  -H "Request-System: Lorem ipsum d" \
  -H "Sign: 0600e67a6c120bd69777450f5066adc6" \
  -H "Timestamp: 1624269530114" \
  -H "TraceId: Lorem ipsum dolor" \
  -H "Version: 2.0" \

返回结果示例


{
  "msg": "Lorem ipsum dol",
  "code": "Lorem ipsu",
  "data": [
    {
      "couponCodeEndTime": "Lorem ipsum dolo",
      "receiveTime": "Lorem ipsu",
      "receivedId": "Lorem ipsum ",
      "totalRedeemCount": 23,
      "redeemedCount": 5,
      "couponCodeStartTime": "Lorem ipsum do",
      "couponId": "Lorem ipsum",
      "couponCode": "Lorem ipsum ",
      "codeStatus": 0
    }
  ]
}

入参说明(在HTTP头部)

名称	描述	数据类型	必填
Request-System	请求系统	string	否
Sign	签名	string	否
Timestamp	时间戳	string	否
TraceId	请求流水号	string	否
Version	接口版本号，如无特别说明，请使用 1.0	string	是

入参说明(在GET)

名称	描述	数据类型	必填
couponIds	优惠券编号	string	否
tradeNo	领券交易号	string	是
tradeSystem	交易方	string	是

返参说明

msg: 状态描述string

code: 状态代码string

data: 数据array
- couponCodeEndTime: 优惠劵码结束时间string
- receiveTime: 领取时间string
- receivedId: 领取idstring
- totalRedeemCount: 总核销次数integer
- redeemedCount: 已核销数量integer
- couponCodeStartTime: 优惠劵码开始时间string
- couponId: 卡券编号string
- couponCode: 优惠券券码string
- codeStatus: 卡券状态integer

会员账户

DELETE 删除用户配送地址

访问地址: /user/addresses

定义

DELETE /user/addresses

请求示例

curl -X DELETE "https://api.open.mcd.cn/user/addresses" \
  -H "accept: application/json" \

返回结果示例


{
  "datetime": "2021-07-23 13:53:19",
  "code": 200,
  "data": "OK",
  "success": true,
  "message": "请求成功"
}

入参说明(在PATH)

名称	描述	数据类型	必填
addressId	addressId	string	是

入参说明(在BODY)

名称	描述	数据类型	必填
root	枚举：CN,EN	string	否

返参说明

traceId: string

datetime: string

code: integer

data: string

success: boolean

message: string

POST 添加用户配送地址

访问地址: /user/addresses

定义

POST /user/addresses

请求示例

curl -X POST "https://api.open.mcd.cn/user/addresses" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" \

  -d "\"Lorem ipsum \""

返回结果示例


{
  "datetime": "2021-07-23 13:51:47",
  "code": 200,
  "data": {
    "id": "1036406410035229627208434091"
  },
  "success": true,
  "message": "请求成功"
}

入参说明(在BODY)

名称	描述	数据类型	必填
root	枚举：CN,EN	string	否

返参说明

traceId: string

datetime: string

code: integer

data: 返回地址ID
- id: 地址IDstring

success: boolean

message: string

GET 查询用户配送地址

访问地址: /user/addresses

定义

GET /user/addresses

请求示例

curl -X GET "https://api.open.mcd.cn/user/addresses?id=Loremipsumd" \
  -H "accept: application/json" \

返回结果示例


{
  "datetime": "2021-07-23 13:53:27",
  "code": 200,
  "data": [
    {
      "address": "麦当劳(中国南京研发中心)",
      "gender": 2,
      "cityCode": "320100",
      "latitude": 32.088061,
      "displayFullText": "麦当劳(中国南京研发中心)玄武大道699-22号江苏软件园9幢101室",
      "channel": "03",
      "fullName": "孙",
      "cityName": "南京市",
      "phone": "176****5367",
      "id": "1036928080029571943015907755",
      "detail": "玄武大道699-22号江苏软件园9幢101室",
      "defaultAddress": 0,
      "longitude": 118.881026
    }
  ],
  "success": true,
  "message": "请求成功"
}

入参说明(在GET)

名称	描述	数据类型	必填
id	地址ID	string	否

入参说明(在BODY)

名称	描述	数据类型	必填
root	枚举：CN,EN	string	否

返参说明

traceId: string

datetime: string

code: integer

data: array必须M
- address: POI 地址string可选
- gender: 性别: 0-未知; 1-male; 2-female;integer可选
- cityCode: 城市编码string必须
- displayFullText: 展示完整地址(非请求参数，返回体使用)string可选
- latitude: 纬度number必须
- channel: 渠道(仅创建时需要): 03-New App; 04-NewWeb; string必须
- fullName: 姓名string必须
- cityName: 城市名称string可选
- phone: 手机号码string必须
- detail: 门牌详细地址string必须
- id: 地址ID(创建时不需要)string可选
- defaultAddress: 是否设为默认地址,0-不设为默认地址;1-设为默认地址integer可选
- longitude: 经度number必须

success: boolean

message: string

PUT 更新用户配送地址

访问地址: /user/addresses

定义

PUT /user/addresses

请求示例

curl -X PUT "https://api.open.mcd.cn/user/addresses" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" \

  -d "\"Lorem ipsum dolor s\""

返回结果示例


{
  "datetime": "2021-07-23 13:51:47",
  "code": 200,
  "data": {
    "id": "1036406410035229627208434091"
  },
  "success": true,
  "message": "请求成功"
}

入参说明(在PATH)

名称	描述	数据类型	必填
addressId	地址ID	string	是

入参说明(在BODY)

名称	描述	数据类型	必填
root	枚举：CN,EN	string	否

返参说明

traceId: string

datetime: string

code: integer

data: 返回地址ID
- id: 地址IDstring

success: boolean

message: string

GET 查询用户配送地址详情

访问地址: /user/addresses/{addressId}

定义

GET /user/addresses/{addressId}

请求示例

curl -X GET "https://api.open.mcd.cn/user/addresses/Loremipsum" \
  -H "accept: application/json" \

返回结果示例


{
  "datetime": "2021-08-04 10:45:40",
  "code": 200,
  "data": {
    "address": "麦当劳(中国南京研发中心)",
    "gender": 2,
    "cityCode": "320100",
    "latitude": 32.088061,
    "displayFullText": "麦当劳(中国南京研发中心)玄武大道699-22号江苏软件园9幢101室",
    "channel": "03",
    "fullName": "孙",
    "cityName": "南京市",
    "phone": "176****1111",
    "id": "1036928080029571943015907755",
    "detail": "玄武大道699-22号江苏软件园9幢101室",
    "defaultAddress": 0,
    "longitude": 118.881026
  },
  "success": true,
  "message": "请求成功"
}

入参说明(在PATH)

名称	描述	数据类型	必填
addressId	地址ID	string	是

入参说明(在BODY)

名称	描述	数据类型	必填
root	枚举：CN,EN	string	否

返参说明

traceId: string

datetime: string

code: integer

data: 地址实体必须M
- address: POI 地址string可选
- gender: 性别: 0-未知; 1-male; 2-female;integer可选
- cityCode: 城市编码string必须
- displayFullText: 展示完整地址(非请求参数，返回体使用)string可选
- latitude: 纬度number必须
- channel: 渠道(仅创建时需要): 03-New App; 04-NewWeb; string必须
- fullName: 姓名string必须
- cityName: 城市名称string可选
- phone: 手机号码string必须
- detail: 门牌详细地址string必须
- id: 地址ID(创建时不需要)string可选
- defaultAddress: 是否设为默认地址,0-不设为默认地址;1-设为默认地址integer可选
- longitude: 经度number必须

success: boolean

message: string

餐厅菜单

GET 查询城市列表

访问地址: /cities/all

定义

GET /cities/all

请求示例

curl -X GET "https://api.open.mcd.cn/cities/all?getCurrent=Loremipsumdolors" \
  -H "accept: application/json" \

返回结果示例


{
  "datetime": "2021-07-28 09:47:16",
  "code": 200,
  "data": {
    "cities": [
      {
        "code": "310100",
        "latitude": 31.230525,
        "name": "上海市",
        "longitude": 121.473667
      }
    ],
    "currentCity": {
      "code": "320100",
      "name": "南京市"
    }
  },
  "success": true,
  "message": "请求成功"
}

入参说明(在GET)

名称	描述	数据类型	必填
getCurrent	是否获取当前城市(基于IP获取，对性能有影响)，0-不需要;1-需要;	string	否

入参说明(在BODY)

名称	描述	数据类型	必填
root	枚举：CN,EN	string	否

返参说明

traceId: string

datetime: string

code: integer

data: 所有城市
- cities: 城市列表array
  - code: 城市编码string
  - latitude: 市中心经纬度-纬度number
  - name: 城市名称string
  - longitude: 市中心经纬度-经度number
- currentCity: City_城市
  - code: 城市编码string
  - latitude: 市中心经纬度-纬度number
  - name: 城市名称string
  - longitude: 市中心经纬度-经度number

success: boolean

message: string

GET 查询附近的门店

该接口适用于根据用户的配送地址来查询附近有无配送门店。

访问地址: /stores/vicinity

定义

GET /stores/vicinity

请求示例

curl -X GET "https://api.open.mcd.cn/stores/vicinity?addressId=Loremipsumdolorsi&beType=Loremipsumdolo&cityCode=Loremipsumdolor&date=Loremipsu&distance=Loremipsum&hotTagCode=Loremipsumdolo&isCityCenter=Loremipsumdolorsi&keyword=Loremipsumdolorsi&latitude=Loremipsumdolorsi&longitude=Loremipsumdol&orderType=Loremipsumdo&showType=Loremipsumdol&time=Loremipsumdolor" \
  -H "accept: application/json" \

返回结果示例


{
  "datetime": "2021-07-22 17:49:00",
  "code": 200,
  "data": {
    "datetime": "2021-07-22 17:49:00"
  },
  "success": true,
  "message": "请求成功"
}

入参说明(在GET)

名称	描述	数据类型	必填
addressId	用户配送地址ID，传入此参数时，需要用户已登陆。若地址ID不为空，则不会使用经纬度获取门店。	string	否
beType	BE类型:1-母店;2-麦乐送;3-麦咖啡;	string	否
cityCode	城市Code，MDS菜单页推荐需要获取推荐地址时必须要传	string	否
date	MDS 配送日期，格式如 20200915，不传默认当天。若传入日期则认为是预约订单，MDS 情况下会认为是预约送达时间。	string	否
distance	距离, 单位: 米，默认 10千米。	string	否
hotTagCode	热门标签编码筛选，仅支持单个	string	否
isCityCenter	是否城市中心默认经纬度。枚举值：0-否;1-是。默认 0。	string	否
keyword	门店名称关键字筛选	string	否
latitude	经度	string	否
longitude	纬度	string	否
orderType	订单类型:1-到店自取;2-外送(即MDS); 默认为 1。	string	否
showType	展示场景，枚举值：1-推荐门店;2-所有门店。默认 1。	string	否
time	MDS 配送时间，格式如 09:05，不传默认当前时间。若传入时间则认为是预约订单，MDS 情况下会认为是预约送达时间。	string	否

入参说明(在BODY)

名称	描述	数据类型	必填
root	枚举：CN,EN	string	否

返参说明

traceId: string

datetime: string

code: integer

data: 附近的餐厅返回值StoreVicinityResponseVO
- mdsStore: Store门店实体
  - dayparts: 餐段列表array
    - daypartCode: daypart编码integer
    - daypartFlag: 是否是默认的daypartboolean
    - daypartName: daypart名称string
    - startTime: daypart开始时间string
    - endTime: daypart结束时间string
  - code: 餐厅编码string
  - deliveryTime: 预计送达时间string
  - distance: 距离, 单位: 米integer
  - cityCode: 所在城市编码string
  - estimatedDeliveryTime: 预计送达时间描述文字string
  - latitude: 纬度number
  - communityQrcode: 餐厅社区码string
  - isActive: 是否启用(客户端无需考虑，已合并进 businessStatus )boolean
  - newStore: 是否新店 0-否;1-是integer
  - duration: 送达时间，单位分钟integer
  - hotTagCodes: 热门标签编码array[string]
  - cityName: 所在城市名称string
  - distanceText: 距离展示值, 包含单位string
  - startTime: 当天开始营业时间string
  - deliveryFeeCode: 配送费编码string
  - longitude: 经度number
  - address: 地址string
  - businessStartDay: 开店时间，格式: 2004-07-30string
  - businessHours: 营业时间列表array
    - dayPartList: array
      - dayPartNameCn: string
      - businessHour: TimePeriod
        startTime: string
        endTime: string
      - dayPartNameEn: string
      - dayPartCode: integer
    - weekday: string
    - startTime: string
    - endTime: string
  - businessStatus: 当前营业状态:0-未营业;1-营业中;integer
  - telephone: 餐厅联系电话string
  - beType: 餐厅BE类型integer
  - tags: 标签信息array
    - label: 标签展示名称，如: 休息中、最近浏览、常去、去过、距离最近，未来可能支持英文string
    - value: 标签值，用于程序处理，如: resting、recently_viewed、frequent、have_been、neareststring
  - newBeEndDate: 新BE到期日，格式 2021-05-19 23:50:00 (当 Store 与 BE 缝合时使用此字段)string
  - name: 餐厅名称string
  - beCode: 餐厅BE编码string
  - endTime: 当天结束营业时间string
  - shortName: 餐厅简称string
  - newBe: 是否新BE 0-否;1-是 (当 Store 与 BE 缝合时使用此字段)integer
  - newStoreEndDate: 新店到期日，格式 2021-05-19 23:50:00string
- datetime: 服务器时间string
- stores: 附近的门店，按距离远近排序，近的在前。根据场景不同含义略有差异。array
  - dayparts: 餐段列表array
    - daypartCode: daypart编码integer
    - daypartFlag: 是否是默认的daypartboolean
    - daypartName: daypart名称string
    - startTime: daypart开始时间string
    - endTime: daypart结束时间string
  - code: 餐厅编码string
  - deliveryTime: 预计送达时间string
  - distance: 距离, 单位: 米integer
  - cityCode: 所在城市编码string
  - estimatedDeliveryTime: 预计送达时间描述文字string
  - latitude: 纬度number
  - communityQrcode: 餐厅社区码string
  - isActive: 是否启用(客户端无需考虑，已合并进 businessStatus )boolean
  - newStore: 是否新店 0-否;1-是integer
  - duration: 送达时间，单位分钟integer
  - hotTagCodes: 热门标签编码array[string]
  - cityName: 所在城市名称string
  - distanceText: 距离展示值, 包含单位string
  - startTime: 当天开始营业时间string
  - deliveryFeeCode: 配送费编码string
  - longitude: 经度number
  - address: 地址string
  - businessStartDay: 开店时间，格式: 2004-07-30string
  - businessHours: 营业时间列表array
    - dayPartList: array
      - dayPartNameCn: string
      - businessHour: TimePeriod
        startTime: string
        endTime: string
      - dayPartNameEn: string
      - dayPartCode: integer
    - weekday: string
    - startTime: string
    - endTime: string
  - businessStatus: 当前营业状态:0-未营业;1-营业中;integer
  - telephone: 餐厅联系电话string
  - beType: 餐厅BE类型integer
  - tags: 标签信息array
    - label: 标签展示名称，如: 休息中、最近浏览、常去、去过、距离最近，未来可能支持英文string
    - value: 标签值，用于程序处理，如: resting、recently_viewed、frequent、have_been、neareststring
  - newBeEndDate: 新BE到期日，格式 2021-05-19 23:50:00 (当 Store 与 BE 缝合时使用此字段)string
  - name: 餐厅名称string
  - beCode: 餐厅BE编码string
  - endTime: 当天结束营业时间string
  - shortName: 餐厅简称string
  - newBe: 是否新BE 0-否;1-是 (当 Store 与 BE 缝合时使用此字段)integer
  - newStoreEndDate: 新店到期日，格式 2021-05-19 23:50:00string
- pickupStore: Store_门店实体
  - dayparts: 餐段列表array
    - daypartCode: daypart编码integer
    - daypartFlag: 是否是默认的daypartboolean
    - daypartName: daypart名称string
    - startTime: daypart开始时间string
    - endTime: daypart结束时间string
  - code: 餐厅编码string
  - deliveryTime: 预计送达时间string
  - distance: 距离, 单位: 米integer
  - cityCode: 所在城市编码string
  - estimatedDeliveryTime: 预计送达时间描述文字string
  - latitude: 纬度number
  - communityQrcode: 餐厅社区码string
  - isActive: 是否启用(客户端无需考虑，已合并进 businessStatus )boolean
  - newStore: 是否新店 0-否;1-是integer
  - duration: 送达时间，单位分钟integer
  - hotTagCodes: 热门标签编码array[string]
  - cityName: 所在城市名称string
  - distanceText: 距离展示值, 包含单位string
  - startTime: 当天开始营业时间string
  - deliveryFeeCode: 配送费编码string
  - longitude: 经度number
  - address: 地址string
  - businessStartDay: 开店时间，格式: 2004-07-30string
  - businessHours: 营业时间列表array
    - dayPartList: array
      - dayPartNameCn: string
      - businessHour: TimePeriod
        startTime: string
        endTime: string
      - dayPartNameEn: string
      - dayPartCode: integer
    - weekday: string
    - startTime: string
    - endTime: string
  - businessStatus: 当前营业状态:0-未营业;1-营业中;integer
  - telephone: 餐厅联系电话string
  - beType: 餐厅BE类型integer
  - tags: 标签信息array
    - label: 标签展示名称，如: 休息中、最近浏览、常去、去过、距离最近，未来可能支持英文string
    - value: 标签值，用于程序处理，如: resting、recently_viewed、frequent、have_been、neareststring
  - newBeEndDate: 新BE到期日，格式 2021-05-19 23:50:00 (当 Store 与 BE 缝合时使用此字段)string
  - name: 餐厅名称string
  - beCode: 餐厅BE编码string
  - endTime: 当天结束营业时间string
  - shortName: 餐厅简称string
  - newBe: 是否新BE 0-否;1-是 (当 Store 与 BE 缝合时使用此字段)integer
  - newStoreEndDate: 新店到期日，格式 2021-05-19 23:50:00string
- recommendAddress: RecommendAddress_推荐地址必须M
  - address: POI 地址string可选
  - distance: 距离，单位米integer可选
  - gender: 性别: 0-未知; 1-male; 2-female;integer可选
  - cityCode: 城市编码string必须
  - displayFullText: 展示完整地址(非请求参数，返回体使用)string可选
  - latitude: 纬度number必须
  - channel: 渠道(仅创建时需要): 03-New App; 04-NewWeb; string必须
  - fullName: 姓名string必须
  - store: Store_门店实体可选
    - dayparts: 餐段列表array
      - daypartCode: daypart编码integer
      - daypartFlag: 是否是默认的daypartboolean
      - daypartName: daypart名称string
      - startTime: daypart开始时间string
      - endTime: daypart结束时间string
    - code: 餐厅编码string
    - deliveryTime: 预计送达时间string
    - distance: 距离, 单位: 米integer
    - cityCode: 所在城市编码string
    - estimatedDeliveryTime: 预计送达时间描述文字string
    - latitude: 纬度number
    - communityQrcode: 餐厅社区码string
    - isActive: 是否启用(客户端无需考虑，已合并进 businessStatus )boolean
    - newStore: 是否新店 0-否;1-是integer
    - duration: 送达时间，单位分钟integer
    - hotTagCodes: 热门标签编码array[string]
    - cityName: 所在城市名称string
    - distanceText: 距离展示值, 包含单位string
    - startTime: 当天开始营业时间string
    - deliveryFeeCode: 配送费编码string
    - longitude: 经度number
    - address: 地址string
    - businessStartDay: 开店时间，格式: 2004-07-30string
    - businessHours: 营业时间列表array
      - dayPartList: array
        dayPartNameCn: string
        businessHour: TimePeriod
        startTime: string
        endTime: string
        dayPartNameEn: string
        dayPartCode: integer
      - weekday: string
      - startTime: string
      - endTime: string
    - businessStatus: 当前营业状态:0-未营业;1-营业中;integer
    - telephone: 餐厅联系电话string
    - beType: 餐厅BE类型integer
    - tags: 标签信息array
      - label: 标签展示名称，如: 休息中、最近浏览、常去、去过、距离最近，未来可能支持英文string
      - value: 标签值，用于程序处理，如: resting、recently_viewed、frequent、have_been、neareststring
    - newBeEndDate: 新BE到期日，格式 2021-05-19 23:50:00 (当 Store 与 BE 缝合时使用此字段)string
    - name: 餐厅名称string
    - beCode: 餐厅BE编码string
    - endTime: 当天结束营业时间string
    - shortName: 餐厅简称string
    - newBe: 是否新BE 0-否;1-是 (当 Store 与 BE 缝合时使用此字段)integer
    - newStoreEndDate: 新店到期日，格式 2021-05-19 23:50:00string
  - cityName: 城市名称string可选
  - phone: 手机号码string必须
  - detail: 门牌详细地址string必须
  - id: 地址ID(创建时不需要)string可选
  - defaultAddress: 是否设为默认地址,0-不设为默认地址;1-设为默认地址integer可选
  - longitude: 经度number必须

success: boolean

message: string

GET 查询门店详情

访问地址: /stores/{storeCode}

定义

GET /stores/{storeCode}

请求示例

curl -X GET "https://api.open.mcd.cn/stores/Loremipsumd" \
  -H "accept: application/json" \

返回结果示例


{
  "datetime": "2021-07-22 17:52:01",
  "code": 200,
  "data": {
    "dayparts": [
      {
        "daypartCode": 1,
        "daypartFlag": false,
        "daypartName": "早餐",
        "startTime": "05:00:00",
        "endTime": "10:29:59"
      },
      {
        "daypartCode": 2,
        "daypartFlag": true,
        "daypartName": "正餐",
        "startTime": "10:30:00",
        "endTime": "23:59:59"
      }
    ],
    "code": "1990999",
    "distance": 0,
    "cityCode": "320100",
    "qrCodeTitle": "南京研发中心实验室 福利群",
    "latitude": 32.09391,
    "communityQrcode": "",
    "isActive": true,
    "newStore": 1,
    "hotTagCodes": [
      "breakfast",
      "wifi",
      "family",
      "childrenPlayground",
      "mcCafe",
      "mds",
      "DT",
      "gm"
    ],
    "datetime": "2021-07-22 17:52:01",
    "cityName": "南京市",
    "startTime": "00:00",
    "deliveryFeeCode": "7030",
    "qrCodeDescImg": "https://lego.cdn.mcdonalds.com.cn/spc/%E7%A4%BE%E5%8C%BA%E7%A0%81%E8%AF%B4%E6%98%8E.png",
    "longitude": 118.88759,
    "address": "南京研发中心实验室",
    "qrCodeDesc": "",
    "businessStartDay": "2021-05-01",
    "businessStatus": 1,
    "tags": [

    ],
    "qrCodeBadgeImg": "https://lego.cdn.mcdonalds.com.cn/spc/%E7%A4%BE%E5%8C%BA%E7%A0%81%E8%A7%92%E6%A0%87.gif",
    "name": "南京研发中心实验室",
    "endTime": "23:00",
    "shortName": "南京研发中心实验室",
    "newStoreEndDate": "2021-08-28 23:59:59"
  },
  "success": true,
  "message": "请求成功"
}

入参说明(在PATH)

名称	描述	数据类型	必填
storeCode	门店Code	string	是

入参说明(在BODY)

名称	描述	数据类型	必填
root	枚举：CN,EN	string	否

返参说明

traceId: string

datetime: string

code: integer

data: Store_门店实体_1
- dayparts: 餐段列表array
  - daypartCode: daypart编码integer
  - daypartFlag: 是否是默认的daypartboolean
  - daypartName: daypart名称string
  - startTime: daypart开始时间string
  - endTime: daypart结束时间string
- code: 餐厅编码string
- deliveryTime: 预计送达时间string
- distance: 距离, 单位: 米integer
- cityCode: 所在城市编码string
- estimatedDeliveryTime: 预计送达时间描述文字string
- qrCodeTitle: 餐厅社区码旁边的标题string
- latitude: 纬度number
- communityQrcode: 餐厅社区码string
- isActive: 是否启用(客户端无需考虑，已合并进 businessStatus )boolean
- newStore: 是否新店 0-否;1-是integer
- duration: 送达时间，单位分钟integer
- hotTagCodes: 热门标签编码array[string]
- datetime: 服务器时间，格式: yyyy-MM-dd HH:mm:ssstring
- cityName: 所在城市名称string
- distanceText: 距离展示值, 包含单位string
- startTime: 当天开始营业时间string
- deliveryFeeCode: 配送费编码string
- qrCodeDescImg: 餐厅社区码旁边的描述的图片(由于后续需要展示富文本，为方便客户端，改用图片，替代 qrCodeDesc 字段)string
- longitude: 经度number
- address: 地址string
- qrCodeDesc: 餐厅社区码旁边的描述string
- businessStartDay: 开店时间，格式: 2004-07-30string
- businessHours: 营业时间列表array
  - dayPartList: array
    - dayPartNameCn: string
    - businessHour: TimePeriod
      - startTime: string
      - endTime: string
    - dayPartNameEn: string
    - dayPartCode: integer
  - weekday: string
  - startTime: string
  - endTime: string
- businessStatus: 当前营业状态:0-未营业;1-营业中;integer
- telephone: 餐厅联系电话string
- beType: 餐厅BE类型integer
- tags: 标签信息array
  - label: 标签展示名称，如: 休息中、最近浏览、常去、去过、距离最近，未来可能支持英文string
  - value: 标签值，用于程序处理，如: resting、recently_viewed、frequent、have_been、neareststring
- qrCodeBadgeImg: 餐厅社区右下角角标string
- newBeEndDate: 新BE到期日，格式 2021-05-19 23:50:00 (当 Store 与 BE 缝合时使用此字段)string
- name: 餐厅名称string
- beCode: 餐厅BE编码string
- endTime: 当天结束营业时间string
- shortName: 餐厅简称string
- newBe: 是否新BE 0-否;1-是 (当 Store 与 BE 缝合时使用此字段)integer
- newStoreEndDate: 新店到期日，格式 2021-05-19 23:50:00string

success: boolean

message: string

GET 查询门店业务详情

访问地址: /stores/be/{beCode}

定义

GET /stores/be/{beCode}

请求示例

curl -X GET "https://api.open.mcd.cn/stores/be/Loremipsumdolor?date=Loremipsumdolor&isGroupMeal=Loremipsu&time=Loremipsumd" \
  -H "accept: application/json" \

返回结果示例


{
  "datetime": "2021-07-22 17:52:38",
  "code": 200,
  "data": {
    "qrCodeTitle": " 福利群",
    "qrCodeDescImg": "https://lego.cdn.mcdonalds.com.cn/spc/%E7%A4%BE%E5%8C%BA%E7%A0%81%E8%AF%B4%E6%98%8E.png",
    "qrCodeDesc": "会员日福利抢先领",
    "qrCodeBadgeImg": "https://lego.cdn.mcdonalds.com.cn/spc/%E7%A4%BE%E5%8C%BA%E7%A0%81%E8%A7%92%E6%A0%87.gif"
  },
  "success": true,
  "message": "请求成功"
}

入参说明(在PATH)

名称	描述	数据类型	必填
beCode	BE Code	string	是

入参说明(在GET)

名称	描述	数据类型	必填
date	MDS 配送日期，格式如 20200915，不传默认当天	string	否
isGroupMeal	团餐标志位 1:是团餐	string	否
time	MDS 配送时间，格式如 09:05，不传默认当前时间	string	否

入参说明(在BODY)

名称	描述	数据类型	必填
root	枚举：CN,EN	string	否

返参说明

traceId: string

datetime: string

code: integer

data: Store_门店实体_1
- dayparts: 餐段列表array
  - daypartCode: daypart编码integer
  - daypartFlag: 是否是默认的daypartboolean
  - daypartName: daypart名称string
  - startTime: daypart开始时间string
  - endTime: daypart结束时间string
- code: 餐厅编码string
- deliveryTime: 预计送达时间string
- distance: 距离, 单位: 米integer
- cityCode: 所在城市编码string
- estimatedDeliveryTime: 预计送达时间描述文字string
- qrCodeTitle: 餐厅社区码旁边的标题string
- latitude: 纬度number
- communityQrcode: 餐厅社区码string
- isActive: 是否启用(客户端无需考虑，已合并进 businessStatus )boolean
- newStore: 是否新店 0-否;1-是integer
- duration: 送达时间，单位分钟integer
- hotTagCodes: 热门标签编码array[string]
- datetime: 服务器时间，格式: yyyy-MM-dd HH:mm:ssstring
- cityName: 所在城市名称string
- distanceText: 距离展示值, 包含单位string
- startTime: 当天开始营业时间string
- deliveryFeeCode: 配送费编码string
- qrCodeDescImg: 餐厅社区码旁边的描述的图片(由于后续需要展示富文本，为方便客户端，改用图片，替代 qrCodeDesc 字段)string
- longitude: 经度number
- address: 地址string
- qrCodeDesc: 餐厅社区码旁边的描述string
- businessStartDay: 开店时间，格式: 2004-07-30string
- businessHours: 营业时间列表array
  - dayPartList: array
    - dayPartNameCn: string
    - businessHour: TimePeriod
      - startTime: string
      - endTime: string
    - dayPartNameEn: string
    - dayPartCode: integer
  - weekday: string
  - startTime: string
  - endTime: string
- businessStatus: 当前营业状态:0-未营业;1-营业中;integer
- telephone: 餐厅联系电话string
- beType: 餐厅BE类型integer
- tags: 标签信息array
  - label: 标签展示名称，如: 休息中、最近浏览、常去、去过、距离最近，未来可能支持英文string
  - value: 标签值，用于程序处理，如: resting、recently_viewed、frequent、have_been、neareststring
- qrCodeBadgeImg: 餐厅社区右下角角标string
- newBeEndDate: 新BE到期日，格式 2021-05-19 23:50:00 (当 Store 与 BE 缝合时使用此字段)string
- name: 餐厅名称string
- beCode: 餐厅BE编码string
- endTime: 当天结束营业时间string
- shortName: 餐厅简称string
- newBe: 是否新BE 0-否;1-是 (当 Store 与 BE 缝合时使用此字段)integer
- newStoreEndDate: 新店到期日，格式 2021-05-19 23:50:00string

success: boolean

message: string

交易订单

POST 查询餐厅的菜单餐品列表

定义

POST /products/menu

请求示例

curl -X POST "https://api.open.mcd.cn/products/menu" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" \

  -d "{\"date\":\"Lorem ipsum dolor\",\"orderType\":71,\"beCode\":\"Lorem ipsum \",\"dayPartCode\":26,\"time\":\"Lorem ipsum d\",\"isGroupMeal\":1,\"channelCode\":\"Lorem ipsum\",\"storeCode\":\"Lorem ipsum \"}"

返回结果示例


{
  "datetime": "2021-08-03 11:28:31",
  "code": 200,
  "data": {
    "menu": [
      {
        "categoryTags": [

        ],
        "image": "https://menu-img.mcdchina.net/pcm/sit/menu/20200819a0728/category/33747.png",
        "productBigBgImage": "https://menu-img.mcdchina.net/pcm/sit/menu/20200819a0728/category/bg_b.png",
        "mcCafeFlag": false,
        "categoryCode": "12345",
        "categoryName": "麦麦 \n脆汁鸡",
        "banners": [

        ],
        "productList": [
          {
            "maxPurchaseQuantity": 99,
            "productTagList": [
              "新品",
              "优惠"
            ],
            "memo": "麦麦脆汁鸡1块(含:1块鸡腿或1块鸡胸)标题",
            "groupList": [

            ],
            "saleStatus": 1,
            "productName": "麦麦脆汁鸡1块",
            "tags": [
              {
                "color": "#FF0000",
                "name": "新品",
                "style": 1
              },
              {
                "color": "#FFFF00",
                "name": "优惠",
                "style": 2
              }
            ],
            "priceInfo": {
              "eatInPriceText": "13",
              "eatInPrice": 1300,
              "priceShowStyle": 1,
              "separatePriceText": "66.66",
              "separatePrice": 6666
            },
            "productCode": "11111",
            "productImage": "https://menu-img.mcdchina.net/pcm/sit/menu/20200819a0728/product/MS_507151_320.png",
            "supportChoice": 0,
            "isChoices": 1,
            "defaultComboItemsText": "",
            "productType": 2
          },
          {
            "maxPurchaseQuantity": 99,
            "productTagList": [
              "优惠",
              "新品"
            ],
            "memo": "麦麦脆汁鸡2块(含:1块鸡胸+1块鸡腿)标题",
            "groupList": [

            ],
            "saleStatus": 1,
            "productName": "麦麦脆汁鸡2块",
            "tags": [
              {
                "color": "#FFFF00",
                "name": "优惠",
                "style": 2
              },
              {
                "color": "#FF0000",
                "name": "新品",
                "style": 1
              }
            ],
            "priceInfo": {
              "eatInPriceText": "25",
              "eatInPrice": 2500,
              "priceShowStyle": 1
            },
            "productCode": "22222",
            "productImage": "https://menu-img.mcdchina.net/pcm/sit/menu/20200819a0728/product/MS_507242_320.png",
            "supportChoice": 0,
            "isChoices": 1,
            "defaultComboItemsText": "",
            "productType": 2
          },
          {
            "maxPurchaseQuantity": 99,
            "productTagList": [
              "新品"
            ],
            "memo": "麦麦炸鸡桶标题",
            "groupList": [

            ],
            "saleStatus": 1,
            "productName": "麦麦炸鸡桶",
            "tags": [
              {
                "color": "#FF0000",
                "name": "新品",
                "style": 1
              }
            ],
            "priceInfo": {
              "eatInPriceText": "88",
              "eatInPrice": 8800,
              "priceShowStyle": 1
            },
            "productCode": "333333",
            "productImage": "https://menu-img.mcdchina.net/pcm/sit/menu/20200819a0728/product/MS_507163_320.png",
            "supportChoice": 0,
            "isChoices": 1,
            "defaultComboItemsText": "",
            "productType": 2
          },
          {
            "maxPurchaseQuantity": 99,
            "productTagList": [

            ],
            "cardType": 0,
            "memo": "麦麦脆汁鸡麦辣鸡腿汉堡套餐(含:1块鸡腿+1个麦辣鸡腿汉堡+1包薯条(中)+1杯可口可乐(中))标题",
            "groupList": [

            ],
            "saleStatus": 1,
            "couponId": "2F855C4C7CE3ABA720A212B9BFEE1CC4",
            "productName": "麦麦脆汁鸡麦辣鸡腿汉堡套餐",
            "tags": [

            ],
            "priceInfo": {
              "eatInPriceText": "27",
              "eatInPrice": 2700,
              "priceShowStyle": 1,
              "separatePriceText": "41",
              "separatePrice": 4100
            },
            "productCode": "555555",
            "productImage": "https://menu-img.mcdchina.net/pcm/sit/menu/20200819a0728/product/MS_507157_320.png",
            "supportChoice": 0,
            "cardTagImage": "https://cdn.mcd.cn/cma/withOrderCard/ohMyCard/ohMyCard_tag.png",
            "isChoices": 1,
            "cardId": "CRD0EC6AF084F5F2D491BCE8B2C1C6589B8",
            "defaultComboItemsText": "",
            "productType": 2
          },
          {
            "maxPurchaseQuantity": 99,
            "productTagList": [

            ],
            "cardType": 0,
            "memo": "麦麦脆汁鸡板烧鸡腿堡套餐(含:1块鸡腿+1个板烧鸡腿堡+1包薯条(中)+1杯可口可乐(中))标题",
            "groupList": [

            ],
            "saleStatus": 1,
            "couponId": "2F855C4C7CE3ABA720A212B9BFEE1CC4",
            "productName": "麦麦脆汁鸡板烧鸡腿堡套餐",
            "tags": [

            ],
            "priceInfo": {
              "eatInPriceText": "27",
              "eatInPrice": 2700,
              "priceShowStyle": 1,
              "separatePriceText": "43",
              "separatePrice": 4300
            },
            "productCode": "777777",
            "productImage": "https://menu-img.mcdchina.net/pcm/sit/menu/20200819a0728/product/MS_507158_320.png",
            "supportChoice": 0,
            "cardTagImage": "https://cdn.mcd.cn/cma/withOrderCard/ohMyCard/ohMyCard_tag.png",
            "isChoices": 1,
            "cardId": "CRD0EC6AF084F5F2D491BCE8B2C1C6589B8",
            "defaultComboItemsText": "",
            "productType": 2
          },
          {
            "maxPurchaseQuantity": 99,
            "productTagList": [

            ],
            "memo": "麦麦脆汁鸡1块-鸡腿标题",
            "groupList": [

            ],
            "saleStatus": 1,
            "productName": "麦麦脆汁鸡1块-鸡腿",
            "tags": [

            ],
            "priceInfo": {
              "eatInPriceText": "13",
              "eatInPrice": 1300,
              "priceShowStyle": 1
            },
            "productCode": "505416",
            "productImage": "https://menu-img.mcdchina.net/pcm/sit/menu/20200819a0728/product/MS_505416_320.png",
            "supportChoice": 0,
            "isChoices": 0,
            "productType": 1
          }
        ]
      }
    ]
  },
  "success": true,
  "message": "请求成功"
}

入参说明(在BODY)

date: 日期，默认当天，格式形如 20200808string必须

orderType: 订单类型integer必须

beCode: be编码string可选

dayPartCode: 餐段integer必须

time: 时间，不传默认当前时间, 格式为HH:mm,比如09:08string可选

isGroupMeal: 团餐标志位 1:是团餐integer可选

channelCode: 销售渠道编码string必须

storeCode: 门店编码string必须

返参说明

traceId: string

datetime: string

code: integer

data: MenuVO
- menu: array
  - categoryTags: 菜单分类小图标，比如展示在图标右上角"新"、"Hot"array[string]
  - image: 分类选中时图片string
  - productBigBgImage: 大的背景图string
  - unselectedImg: 分类未选中时图片string
  - mcCafeFlag: 是否是麦咖啡分类boolean
  - categories: 子分类array
  - categoryCode: 菜单分类编码string
  - banners: 分类bannerarray
    - redirect: 跳转string
    - image: 图片地址string
  - categoryName: 菜单分类名称string
  - productList: 菜单分类产品列表array
    - maxPurchaseQuantity: 最大可购买的数量integer
    - bigImage: 餐品大图string
    - productTagList: 产品标签（废弃）array[string]
    - cardType: 权益卡类型 0：OH麦职场卡；1：麦乐送卡；2：早餐卡；3：麦咖啡；6：宝贝卡integer
    - memo: 餐品备注string
    - groupList: 产品组列表array
      - isDefault: 是否默认 1：默认项 0：非默认项integer
      - subProductCode: 产品组内菜品编码string
      - showName: 商品组内显示的名称string
      - cardType: integer
    - saleStatus: 之前状态是否可售:0-否，不可售;1-是，可售;integer
    - couponId: 卡券idstring
    - categoryCodeList: 产品分类array[string]
    - productName: 产品名称string
    - cardTagText: 权益卡标签文字string
    - tags: 产品标签array
      - image: 标签图片string
      - color: 颜色string
      - name: 标签名称string
      - style: 标签样式integer
    - priceInfo: ProductPrice_产品价格实体
      - eatInPriceText: 堂食价格，单位元，用于展示string
      - takeOutPriceText: 外带价格，单位元，用于展示string
      - deliveryPriceText: 外送价格，单位元，用于展示string
      - eatInPrice: 堂食价格，单位分，用于计算integer
      - priceShowStyle: 价格展示样式 1：标准 2: 起价integer
      - separatePriceText: 划线价，用于展示string
      - deliveryPrice: 外送价格，单位分，用于计算integer
      - separatePrice: 划线价，用于计算integer
      - takeOutPrice: 外带价格，单位分，用于计算integer
    - productCode: 产品编码string
    - productImage: 产品图片string
    - supportChoice: 一券多商品专用，是否支持修改套餐子项integer
    - cardTagImage: 权益卡标签图片string
    - cardId: 权益卡idstring
    - isChoices: 是否可选项: 0-否;1-是;integer
    - mulSpec: 是否多规格boolean
    - defaultComboItemsText: 一券多商品专用，默认套餐组成文案string
    - productType: 产品类型 1：单品 2：套餐 3：产品组 4: 外送费integer

success: boolean

message: string

GET 查询餐厅的菜单餐品详情

访问地址: /products/detail/{code}

定义

GET /products/detail/{code}

请求示例

curl -X GET "https://api.open.mcd.cn/products/detail/Loremipsum?beCode=Loremipsumdolo&cardId=Loremipsumdolo&channelCode=Loremipsumdolo&date=Loremipsumdo&daypartCode=Loremipsumdolor&isGroupMeal=Loremipsumdolo&orderType=Loremipsum&storeCode=Loremipsum&time=Loremipsumdolor&cardDetail.cardId=Loremipsumdo&cardDetail.cardType=Loremipsumd&cardDetail.interestsList.cardCoupons[0].beTypes=Loremipsum&cardDetail.interestsList.cardCoupons[0].conditionalProductCodes=Loremipsumdolorsi&cardDetail.interestsList.cardCoupons[0].couponCardType=Loremipsumdol&cardDetail.interestsList.cardCoupons[0].couponId=Loremipsumd&cardDetail.interestsList.cardCoupons[0].couponLogoPath=Loremipsum&cardDetail.interestsList.cardCoupons[0].couponPromotionId=Loremipsumdolorsi&cardDetail.interestsList.cardCoupons[0].couponPromotionType=Loremipsum&cardDetail.interestsList.cardCoupons[0].couponSubTitle=Loremipsumdolors&cardDetail.interestsList.cardCoupons[0].couponTitle=Loremipsum&cardDetail.interestsList.cardCoupons[0].couponType=Loremipsumdolorsi&cardDetail.interestsList.cardCoupons[0].interestsId=Loremipsumd&cardDetail.interestsList.cardCoupons[0].interestsName=Loremipsum&cardDetail.interestsList.cardCoupons[0].isAllTradeTime=Loremipsu&cardDetail.interestsList.cardCoupons[0].orderFoodTypes=Loremipsumdol&cardDetail.interestsList.cardCoupons[0].primary=Loremipsumdolor&cardDetail.interestsList.cardCoupons[0].specialProductCodes=Loremipsumd&cardDetail.interestsList.cardCoupons[0].tradeEndTime=Loremipsumdolors&cardDetail.interestsList.cardCoupons[0].tradeStartTime=Loremipsumdolor&cardDetail.interestsList.cardCoupons[0].tradeTimeList[0].couponTradeTimeType=Loremipsumdolor&cardDetail.interestsList.cardCoupons[0].tradeTimeList[0].tradeEndDate=Loremipsumdolor&cardDetail.interestsList.cardCoupons[0].tradeTimeList[0].tradeStartDate=Loremipsum&cardDetail.interestsList.cardCoupons[0].tradeWeeks=Loremipsu&cardDetail.interestsList.interestsType=Loremipsumdolor&cardDetail.putChannels=Loremipsumd&cardDetail.putEndTime=Loremipsum&cardDetail.putStartTime=Loremipsu&cardDetail.redeemChannels=Loremipsu&cardDetail.redeemEndTime=Loremipsumdolorsi&cardDetail.redeemStartTime=Loremipsumdolors&cardDetail.subTitle=Loremipsum&cardDetail.title=Loremipsum&cardDetail.validateNum=Loremipsumdo&cardDetail.validateType=Loremipsumdolors" \
  -H "accept: application/json" \

返回结果示例


{
  "datetime": "2021-08-04 10:51:45",
  "code": 200,
  "data": {
    "maxPurchaseQuantity": 99,
    "product": {
      "image": "https://menu-img.mcdchina.net/pcm/sit/menu/20200819a0803/product/MS_507242_600.png",
      "code": "12345",
      "bu": 1,
      "price": 2500,
      "name": "麦麦脆汁鸡2块",
      "comboItems": [
        {
          "comboProducts": [
            {
              "image": "https://menu-img.mcdchina.net/pcm/sit/menu/20200819a0803/product/MS_505417_600.png",
              "isDefault": 1,
              "code": "6789",
              "hasCustomization": 0,
              "price": 2500,
              "name": "麦麦脆汁鸡2块装",
              "diffPrice": 0,
              "diffPriceText": "+ ¥0",
              "customizationMode": 0,
              "priceText": "25",
              "tags": [

              ]
            }
          ],
          "round": 1,
          "isChoices": 0,
          "name": "主食",
          "costInclusive": "1",
          "choicesCode": "",
          "classification": 1,
          "idx": 0
        },
        {
          "comboProducts": [
            {
              "image": "https://menu-img.mcdchina.net/pcm/sit/menu/20200819a0803/product/MS_507241_600.png",
              "isDefault": 1,
              "code": "111222",
              "hasCustomization": 0,
              "price": 0,
              "name": "不要粉包",
              "diffPrice": 0,
              "diffPriceText": "+ ¥0",
              "customizationMode": 0,
              "priceText": "0",
              "tags": [

              ]
            },
            {
              "image": "https://menu-img.mcdchina.net/pcm/sit/menu/20200819a0803/product/MS_507152_600.png",
              "isDefault": 0,
              "code": "344556",
              "hasCustomization": 0,
              "price": 100,
              "name": "九叶青花椒粉包1份",
              "diffPrice": 100,
              "diffPriceText": "+ ¥1",
              "customizationMode": 0,
              "priceText": "1",
              "tags": [

              ]
            },
            {
              "image": "https://menu-img.mcdchina.net/pcm/sit/menu/20200819a0803/product/MS_507239_600.png",
              "isDefault": 0,
              "code": "7788997",
              "hasCustomization": 0,
              "price": 200,
              "name": "九叶青花椒粉包2份",
              "diffPrice": 200,
              "diffPriceText": "+ ¥2",
              "customizationMode": 0,
              "priceText": "2",
              "tags": [

              ]
            },
            {
              "image": "https://menu-img.mcdchina.net/pcm/sit/menu/20200819a0803/product/MS_507240_600.png",
              "isDefault": 0,
              "code": "3344556",
              "hasCustomization": 0,
              "price": 300,
              "name": "九叶青花椒粉包3份",
              "diffPrice": 300,
              "diffPriceText": "+ ¥3",
              "customizationMode": 0,
              "priceText": "3",
              "tags": [

              ]
            }
          ],
          "round": 2,
          "isChoices": 1,
          "name": "选择九叶青花椒粉包",
          "costInclusive": "0",
          "choicesCode": "10000095",
          "classification": 5,
          "idx": 1
        }
      ],
      "customizationMode": 0,
      "type": 2,
      "priceText": "25",
      "tags": [

      ],
      "longName": "麦麦脆汁鸡2块(含:1块鸡胸+1块鸡腿)",
      "desc": "创新黑科技成就美式炸鸡，外皮喷香酥脆，内里鲜嫩多汁，每一口都入味，每一只都大块！一块鸡胸搭配一块大块鸡腿！每一口都满足！包含：1块鸡胸+一块鸡腿"
    }
  },
  "success": true,
  "message": "请求成功"
}

入参说明(在PATH)

名称	描述	数据类型	必填
code	code	string	是

入参说明(在GET)

名称	描述	数据类型	必填
beCode	be编码	string	否
cardId	权益卡id，如果非权益商品则不传或传null	string	否
channelCode		string	是
date	日期，默认当天，格式形如 20200808	string	否
daypartCode	餐段	string	是
isGroupMeal	团餐标志位 1:是团餐	string	否
orderType	订单类型	string	是
storeCode	门店编码	string	是
time	时间，默认当前时间, 格式为 HH:mm, 比如 09:08	string	否
cardDetail.cardId		string	否
cardDetail.cardType		string	否
cardDetail.interestsList.cardCoupons[0].beTypes		string	否
cardDetail.interestsList.cardCoupons[0].conditionalProductCodes		string	否
cardDetail.interestsList.cardCoupons[0].couponCardType		string	否
cardDetail.interestsList.cardCoupons[0].couponId		string	否
cardDetail.interestsList.cardCoupons[0].couponLogoPath		string	否
cardDetail.interestsList.cardCoupons[0].couponPromotionId		string	否
cardDetail.interestsList.cardCoupons[0].couponPromotionType		string	否
cardDetail.interestsList.cardCoupons[0].couponSubTitle		string	否
cardDetail.interestsList.cardCoupons[0].couponTitle		string	否
cardDetail.interestsList.cardCoupons[0].couponType		string	否
cardDetail.interestsList.cardCoupons[0].interestsId		string	否
cardDetail.interestsList.cardCoupons[0].interestsName		string	否
cardDetail.interestsList.cardCoupons[0].isAllTradeTime		string	否
cardDetail.interestsList.cardCoupons[0].orderFoodTypes		string	否
cardDetail.interestsList.cardCoupons[0].primary		string	否
cardDetail.interestsList.cardCoupons[0].specialProductCodes		string	否
cardDetail.interestsList.cardCoupons[0].tradeEndTime		string	否
cardDetail.interestsList.cardCoupons[0].tradeStartTime		string	否
cardDetail.interestsList.cardCoupons[0].tradeTimeList[0].couponTradeTimeType		string	否
cardDetail.interestsList.cardCoupons[0].tradeTimeList[0].tradeEndDate		string	否
cardDetail.interestsList.cardCoupons[0].tradeTimeList[0].tradeStartDate		string	否
cardDetail.interestsList.cardCoupons[0].tradeWeeks		string	否
cardDetail.interestsList.interestsType		string	否
cardDetail.putChannels		string	否
cardDetail.putEndTime		string	否
cardDetail.putStartTime		string	否
cardDetail.redeemChannels		string	否
cardDetail.redeemEndTime		string	否
cardDetail.redeemStartTime		string	否
cardDetail.subTitle		string	否
cardDetail.title		string	否
cardDetail.validateNum		string	否
cardDetail.validateType		string	否

入参说明(在BODY)

名称	描述	数据类型	必填
root	枚举：CN,EN	string	否

返参说明

traceId: string

datetime: string

code: integer

data: ProductDetailResponseVO
- maxPurchaseQuantity: 最大可购买数量integer
- product: ProductDetailVO
  - image: 餐品图片string
  - specTypes: 餐品组(规格->规格值->餐品)array
    - specs: 规格类型下规格(值)列表array
      - product: GroupProductVO
        image: 餐品图片string
        code: 餐品Codestring
        customization: 餐品特制(定制)信息
        options: 特制选项列表(是否需要类型，中台叫勾选要不要类型)array
        mode: 特制方式: 1:固定选项; 2:自定义数量integer
        image: 特制图片路径string
        code: 特制编码string
        quantity: 数量integer
        minQuantity: 特制最小可设数量integer
        maxQuantity: 特制最大可设数量integer
        price: 价格,单位分。(暂时用不到)integer
        name: 特制名称，如：冰量string
        checked: 是否选中:1-是;0-否;(默认值通常为1)integer
        isModify: 是否变更: 0-否;1-是;integer
        soldOut: 是否售罄boolean
        displayMode: 特制显示方式: 1.平铺选项, 2.勾选要不要integer
        items: 特制选项列表(单选类型，中台叫平铺选项类型)array
        mode: 特制方式: 1:固定选项; 2:自定义数量integer
        image: 特制图片路径string
        code: 特制编码string
        quantity: 特制默认数量integer
        minQuantity: 特制最小可设数量integer
        maxQuantity: 特制最大可设数量integer
        values: (单选类型)特调选项array
        image: 特制选项图片路径string
        code: 特制选项编码string
        quantity: 特制选项数量integer
        price: 特制价格，以分为单位integer
        name: 特制选项名称, 如：标准、去冰、少冰、多冰string
        selectedImage: 特调选中时的图片string
        checked: 是否选中(替代 isDefault 默认项): 1-是;0-否;integer
        unselectedImage: 特调未选中时的图片string
        isModify: 是否变更: 0-否;1-是;integer
        spread: 差价string
        name: 特制名称，如：冰量string
        isMultiple: 是否多选:0-单选;1-多选;(目前都是单选)integer
        isModify: 是否变更: 0-否;1-是;integer
        soldOut: 是否售罄boolean
        displayMode: 特制显示方式: 1.平铺选项, 2.勾选要不要integer
        comboItems: 套餐构成array
        comboProducts: 套餐组成项(可选餐品)array
        image: 餐品图片string
        code: 餐品Codestring
        hasCustomization: 是否可特制/定制: 0-否;1-是;integer
        type: 餐品类型:1-单品;2-套餐;3-商品组;integer
        tags: 商品标签列表array
        image: 标签图片string
        color: 颜色string
        name: 标签名称string
        style: 标签样式integer
        isDefault: 是否默认项: 0-否;1-是;integer
        bu: 商品所属BU:1-母店;2-麦咖啡;3-麦乐送;integer
        dayOfWeek: 每周售卖日,7位数字表示一周中每天的售卖情况:1-可售;0-不可售.例: 1111100, 表示周一到周五可售.string
        price: 餐品价格, 单位分, 用于计算(根据渠道自动判断)integer
        name: 餐品名称string
        diffPrice: 与默认项的差价，单位分，用于计算integer
        diffPriceText: 与默认项的差价，单位元，用于展示string
        customizationMode: 是否可特制:1-是;0-否;integer
        priceText: 餐品价格, 单位元, 用于展示string
        round: 轮次integer
        isChoices: 是否可选项: 0-否;1-是;integer
        name: 名称string
        choicesCode: 可选组编码string
        costInclusive: 是否包含成本: 0-否;1-是;string
        classification: 套餐构成分类: 1-主食;2-小食;3-饮料;4-玩具;5-配料;integer
        idx: 排序integer
        type: 餐品类型:1-单品;2-套餐;3-商品组;integer
        matchedSpecsCode: 匹配规格编码，如：1-1，需要根据【specsTypeCode】-【specsCode】来确定子项商品对应的规格string
        tags: 商品标签列表array
        image: 标签图片string
        color: 颜色string
        name: 标签名称string
        style: 标签样式integer
        bu: 商品所属BU:1-母店;2-麦咖啡;3-麦乐送;integer
        price: 餐品价格, 单位分, 用于计算(根据渠道自动判断)integer
        defaulted: 默认(1是0否)integer
        name: 餐品名称string
        links: 链接array
        title: string
        type: integer
        url: string
        customizationMode: 是否可特制:1-是;0-否;integer
        priceText: 餐品价格, 单位元, 用于展示string
        rightInfo: 餐品组下子项的权益信息
        specTagBgColor: 规格标签背景色string
        price: 权益价integer
        cardType: 权益卡类型integer
        banner: string
        specTagFontColor: 规格标签字体颜色string
        specTagText: 规格标签文本string
        tagImage: banner上的图片string
        desc: 描述string
        desc: 餐品描述string
      - code: 编码string
      - productCode: 规格值对应的产品codestring
      - name: 名称string
      - selectedImage: 选中图片string
      - unselectedImage: 未选中图片string
      - spread: 差价string
    - code: 规格类型编码string
    - name: 规格类型名称string
  - code: 餐品Codestring
  - customization: 餐品特制(定制)信息
    - options: 特制选项列表(是否需要类型，中台叫勾选要不要类型)array
      - mode: 特制方式: 1:固定选项; 2:自定义数量integer
      - image: 特制图片路径string
      - code: 特制编码string
      - quantity: 数量integer
      - minQuantity: 特制最小可设数量integer
      - maxQuantity: 特制最大可设数量integer
      - price: 价格,单位分。(暂时用不到)integer
      - name: 特制名称，如：冰量string
      - checked: 是否选中:1-是;0-否;(默认值通常为1)integer
      - isModify: 是否变更: 0-否;1-是;integer
      - soldOut: 是否售罄boolean
      - displayMode: 特制显示方式: 1.平铺选项, 2.勾选要不要integer
    - items: 特制选项列表(单选类型，中台叫平铺选项类型)array
      - mode: 特制方式: 1:固定选项; 2:自定义数量integer
      - image: 特制图片路径string
      - code: 特制编码string
      - quantity: 特制默认数量integer
      - minQuantity: 特制最小可设数量integer
      - maxQuantity: 特制最大可设数量integer
      - values: (单选类型)特调选项array
        image: 特制选项图片路径string
        code: 特制选项编码string
        quantity: 特制选项数量integer
        price: 特制价格，以分为单位integer
        name: 特制选项名称, 如：标准、去冰、少冰、多冰string
        selectedImage: 特调选中时的图片string
        checked: 是否选中(替代 isDefault 默认项): 1-是;0-否;integer
        unselectedImage: 特调未选中时的图片string
        isModify: 是否变更: 0-否;1-是;integer
        spread: 差价string
      - name: 特制名称，如：冰量string
      - isMultiple: 是否多选:0-单选;1-多选;(目前都是单选)integer
      - isModify: 是否变更: 0-否;1-是;integer
      - soldOut: 是否售罄boolean
      - displayMode: 特制显示方式: 1.平铺选项, 2.勾选要不要integer
  - comboItems: 套餐信息(套餐里的组成项)array
    - comboProducts: 套餐组成项(可选餐品)array
      - image: 餐品图片string
      - code: 餐品Codestring
      - hasCustomization: 是否可特制/定制: 0-否;1-是;integer
      - type: 餐品类型:1-单品;2-套餐;3-商品组;integer
      - tags: 商品标签列表array
        image: 标签图片string
        color: 颜色string
        name: 标签名称string
        style: 标签样式integer
      - isDefault: 是否默认项: 0-否;1-是;integer
      - bu: 商品所属BU:1-母店;2-麦咖啡;3-麦乐送;integer
      - dayOfWeek: 每周售卖日,7位数字表示一周中每天的售卖情况:1-可售;0-不可售.例: 1111100, 表示周一到周五可售.string
      - price: 餐品价格, 单位分, 用于计算(根据渠道自动判断)integer
      - name: 餐品名称string
      - diffPrice: 与默认项的差价，单位分，用于计算integer
      - diffPriceText: 与默认项的差价，单位元，用于展示string
      - customizationMode: 是否可特制:1-是;0-否;integer
      - priceText: 餐品价格, 单位元, 用于展示string
    - round: 轮次integer
    - isChoices: 是否可选项: 0-否;1-是;integer
    - name: 名称string
    - choicesCode: 可选组编码string
    - costInclusive: 是否包含成本: 0-否;1-是;string
    - classification: 套餐构成分类: 1-主食;2-小食;3-饮料;4-玩具;5-配料;integer
    - idx: 排序integer
  - type: 餐品类型:1-单品;2-套餐;3-商品组;integer
  - products: 规格对应商品集合array
    - image: 餐品图片string
    - code: 餐品Codestring
    - customization: 餐品特制(定制)信息
      - options: 特制选项列表(是否需要类型，中台叫勾选要不要类型)array
        mode: 特制方式: 1:固定选项; 2:自定义数量integer
        image: 特制图片路径string
        code: 特制编码string
        quantity: 数量integer
        minQuantity: 特制最小可设数量integer
        maxQuantity: 特制最大可设数量integer
        price: 价格,单位分。(暂时用不到)integer
        name: 特制名称，如：冰量string
        checked: 是否选中:1-是;0-否;(默认值通常为1)integer
        isModify: 是否变更: 0-否;1-是;integer
        soldOut: 是否售罄boolean
        displayMode: 特制显示方式: 1.平铺选项, 2.勾选要不要integer
      - items: 特制选项列表(单选类型，中台叫平铺选项类型)array
        mode: 特制方式: 1:固定选项; 2:自定义数量integer
        image: 特制图片路径string
        code: 特制编码string
        quantity: 特制默认数量integer
        minQuantity: 特制最小可设数量integer
        maxQuantity: 特制最大可设数量integer
        values: (单选类型)特调选项array
        image: 特制选项图片路径string
        code: 特制选项编码string
        quantity: 特制选项数量integer
        price: 特制价格，以分为单位integer
        name: 特制选项名称, 如：标准、去冰、少冰、多冰string
        selectedImage: 特调选中时的图片string
        checked: 是否选中(替代 isDefault 默认项): 1-是;0-否;integer
        unselectedImage: 特调未选中时的图片string
        isModify: 是否变更: 0-否;1-是;integer
        spread: 差价string
        name: 特制名称，如：冰量string
        isMultiple: 是否多选:0-单选;1-多选;(目前都是单选)integer
        isModify: 是否变更: 0-否;1-是;integer
        soldOut: 是否售罄boolean
        displayMode: 特制显示方式: 1.平铺选项, 2.勾选要不要integer
    - comboItems: 套餐构成array
      - comboProducts: 套餐组成项(可选餐品)array
        image: 餐品图片string
        code: 餐品Codestring
        hasCustomization: 是否可特制/定制: 0-否;1-是;integer
        type: 餐品类型:1-单品;2-套餐;3-商品组;integer
        tags: 商品标签列表array
        image: 标签图片string
        color: 颜色string
        name: 标签名称string
        style: 标签样式integer
        isDefault: 是否默认项: 0-否;1-是;integer
        bu: 商品所属BU:1-母店;2-麦咖啡;3-麦乐送;integer
        dayOfWeek: 每周售卖日,7位数字表示一周中每天的售卖情况:1-可售;0-不可售.例: 1111100, 表示周一到周五可售.string
        price: 餐品价格, 单位分, 用于计算(根据渠道自动判断)integer
        name: 餐品名称string
        diffPrice: 与默认项的差价，单位分，用于计算integer
        diffPriceText: 与默认项的差价，单位元，用于展示string
        customizationMode: 是否可特制:1-是;0-否;integer
        priceText: 餐品价格, 单位元, 用于展示string
      - round: 轮次integer
      - isChoices: 是否可选项: 0-否;1-是;integer
      - name: 名称string
      - choicesCode: 可选组编码string
      - costInclusive: 是否包含成本: 0-否;1-是;string
      - classification: 套餐构成分类: 1-主食;2-小食;3-饮料;4-玩具;5-配料;integer
      - idx: 排序integer
    - type: 餐品类型:1-单品;2-套餐;3-商品组;integer
    - matchedSpecsCode: 匹配规格编码，如：1-1，需要根据【specsTypeCode】-【specsCode】来确定子项商品对应的规格string
    - tags: 商品标签列表array
      - image: 标签图片string
      - color: 颜色string
      - name: 标签名称string
      - style: 标签样式integer
    - bu: 商品所属BU:1-母店;2-麦咖啡;3-麦乐送;integer
    - price: 餐品价格, 单位分, 用于计算(根据渠道自动判断)integer
    - defaulted: 默认(1是0否)integer
    - name: 餐品名称string
    - links: 链接array
      - title: string
      - type: integer
      - url: string
    - customizationMode: 是否可特制:1-是;0-否;integer
    - priceText: 餐品价格, 单位元, 用于展示string
    - rightInfo: 餐品组下子项的权益信息
      - specTagBgColor: 规格标签背景色string
      - price: 权益价integer
      - cardType: 权益卡类型integer
      - banner: string
      - specTagFontColor: 规格标签字体颜色string
      - specTagText: 规格标签文本string
      - tagImage: banner上的图片string
      - desc: 描述string
    - desc: 餐品描述string
  - tags: 商品标签列表array
    - image: 标签图片string
    - color: 颜色string
    - name: 标签名称string
    - style: 标签样式integer
  - bu: 商品所属BU:1-母店;2-麦咖啡;3-麦乐送;integer
  - price: 餐品价格, 单位分, 用于计算(根据渠道自动判断)integer
  - name: 餐品名称string
  - links: 链接array
    - title: string
    - type: integer
    - url: string
  - customizationMode: 是否可特制:1-是;0-否;integer
  - priceText: 餐品价格, 单位元, 用于展示string
  - rightInfo: 单品、套餐的权益信息
    - price: 权益价integer
    - cardType: 权益卡类型integer
    - banner: string
    - tagImage: 标签图片string
    - desc: 描述string
  - desc: 餐品描述string
  - longName: 餐品完整名称string

success: boolean

message: string

GET 搜索餐厅的菜单餐品

访问地址: /products/search

定义

GET /products/search

请求示例

curl -X GET "https://api.open.mcd.cn/products/search?beCode=Loremipsumdolor&date=Loremipsumdolor&daypartCode=Loremipsum&isGroupMeal=Loremipsum&keyword=Loremipsumdolor&orderType=Loremipsum&storeCode=Loremipsumdol&time=Loremipsu" \
  -H "accept: application/json" \

返回结果示例


{
  "datetime": "2021-08-04 10:33:48",
  "code": 200,
  "data": {
    "maxPurchaseQuantity": 99,
    "productList": [

    ]
  },
  "success": true,
  "message": "请求成功"
}

入参说明(在GET)

名称	描述	数据类型	必填
beCode	门店的becode	string	否
date	日期，默认当天，格式形如 20200808	string	否
daypartCode	售卖餐段	string	是
isGroupMeal	团餐标志位 1:是团餐	string	否
keyword	关键词	string	是
orderType	订单类型	string	是
storeCode	门店编码	string	是
time	时间，默认当前时间, 格式为 HH:mm, 比如 09:08	string	否

返参说明

maxPurchaseQuantity: 最大可购买数量integer

productList: 产品列表array
- productTagList: 产品标签列表（废弃）array[string]
- memo: 餐品备注string
- couponId: 卡券idstring
- categoryCodeList: 产品所属的分类codesarray[string]
- productName: 产品名称string
- promotionId: 促销idstring
- priceInfo: ProductPrice_产品价格实体
  - eatInPriceText: 堂食价格，单位元，用于展示string
  - takeOutPriceText: 外带价格，单位元，用于展示string
  - deliveryPriceText: 外送价格，单位元，用于展示string
  - eatInPrice: 堂食价格，单位分，用于计算integer
  - priceShowStyle: 价格展示样式 1：标准 2: 起价integer
  - separatePriceText: 划线价，用于展示string
  - discountPrice: 促销价格，用于计算integer
  - deliveryPrice: 外送价格，单位分，用于计算integer
  - discountPriceText: 促销价，用于展示string
  - separatePrice: 划线价，用于计算integer
  - takeOutPrice: 外带价格，单位分，用于计算integer
- productImage: 产品图片string
- supportChoice: 是否支持打开详情页进行更新套餐Choice:0-不打开;1-打开;integer
- isChoices: 是否可选项: 0-否;1-是;integer
- mulSpec: 是否多规格boolean
- defaultComboItemsText: 默认套餐组成文案string
- productType: 产品类型 1：单品 2：套餐 3：产品组 4: 外送费integer
- maxPurchaseQuantity: 产品编码integer
- productLongName: 产品名称string
- cardType: 权益卡类型integer
- count: 优惠券内的商品数量integer
- groupList: 产品组列表array
  - priceInfo: ProductPrice_产品价格实体
    - eatInPriceText: 堂食价格，单位元，用于展示string
    - takeOutPriceText: 外带价格，单位元，用于展示string
    - deliveryPriceText: 外送价格，单位元，用于展示string
    - eatInPrice: 堂食价格，单位分，用于计算integer
    - priceShowStyle: 价格展示样式 1：标准 2: 起价integer
    - separatePriceText: 划线价，用于展示string
    - discountPrice: 促销价格，用于计算integer
    - deliveryPrice: 外送价格，单位分，用于计算integer
    - discountPriceText: 促销价，用于展示string
    - separatePrice: 划线价，用于计算integer
    - takeOutPrice: 外带价格，单位分，用于计算integer
  - isDefault: 是否默认 1：默认项 0：非默认项integer
  - subProductCode: 产品组内菜品编码string
  - showName: 商品组内显示的名称string
  - cardType: 权益卡类型integer
- saleStatus: 之前状态是否可售:0-否，不可售;1-是，可售;integer
- cardTagText: 权益卡标签文字string
- tags: 分类的商品标签列表array
  - image: 标签图片string
  - color: 颜色string
  - name: 标签名称string
  - style: 标签样式(1:实心标签，2:线框标签，3:图片标签)integer
- productDesc: 产品描述string
- detailTags: 详情的标签列表array
  - image: 标签图片string
  - color: 颜色string
  - name: 标签名称string
  - style: 标签样式(1:实心标签，2:线框标签，3:图片标签)integer
- productCode: 产品编码string
- cardTagImage: 权益卡标签图片string
- cardId: 权益卡idstring
- couponCode: 卡券codestring

GET 查询购物车

访问地址: /carts

定义

GET /carts

请求示例

curl -X GET "https://api.open.mcd.cn/carts?beCode=Loremipsumdolors&cartType=Loremipsumdolor&date=Loremipsumd&daypartCode=Loremipsumdolors&isGroupMeal=Loremipsu&orderType=Loremipsumdolor&storeCode=Loremipsumdolor&time=Loremipsum" \
  -H "accept: application/json" \

返回结果示例


{
  "datetime": "2021-08-04 11:00:46",
  "code": 200,
  "data": {
    "localDateTime": "2021-08-04 11:00:46",
    "orderType": 1,
    "maxPurchaseQuantity": 99,
    "submit": 0,
    "totalPrice": 0,
    "productTotalPrice": 0,
    "channel": "03",
    "discountAmount": 0,
    "deliveryPrice": 0,
    "withOrderCardDiscountTips": "已帮您最优匹配OH麦卡单件权益价",
    "products": [

    ],
    "promptType": 0,
    "realTotalPrice": 0,
    "daypartCode": "2",
    "promotions": [
      {
        "image": "https://menu-img.mcdchina.net/pcm/sit/menu/20200819a0803/product/MS_507715_100.png",
        "couponName": "OH麦卡",
        "couponType": 2,
        "cardId": "CRD0EC6AF084F5F2D491BCE8B2C1C6589B8",
        "showType": 103,
        "memo": "OH麦卡职场卡仿生产",
        "used": false,
        "realPrice": 1900,
        "validateNum": 30
      }
    ],
    "realDeliveryPrice": 0,
    "cartType": 1,
    "realProductTotalPrice": 0,
    "storeCode": "123456"
  },
  "success": true,
  "message": "请求成功"
}

入参说明(在GET)

名称	描述	数据类型	必填
beCode	门店becode	string	否
cartType	购物车类型: 1-普通购物车	string	是
date	日期，默认当天，格式形如 20200808	string	否
daypartCode	餐段	string	是
isGroupMeal	团餐标志位 1:是团餐	string	否
orderType	外送类型:1-pickup;2-deliver;	string	是
storeCode	餐厅编码	string	是
time	时间，默认当前时间, 格式为 HH:mm, 比如 09:08	string	否

返参说明

localDateTime: 当前时间string必须

promptColor: 购物车底部提示信息文字颜色string可选

orderType: 外送类型: 1-pickup;2-deliver;integer可选

submit: 是否可提交结算:0-否;1-是;integer可选

totalPrice: 总金额单位分integer可选

productTotalPrice: 餐品价格单位分integer可选

channel: 渠道string可选

discountAmount: 餐品优惠金额单位分integer可选

tips: CartTips_提示信息可选
- orderCouponBalance: 订单券还差金额文字替换string
- deliveryCouponText: 运费券文案string
- orderCouponText: 订单券文案string
- deliveryCouponBalance: 运费券还差金额文字替换string
- text: 提示文案string
- type: 提示类型，1-toast提示text,2不享受员工优惠的商品提示,3主动命中券文案integer
- products: 产品列表array
  - image: 产品图片string
  - price: 产品单价integer
  - name: 产品名称string
  - subTotalPrice: 产品单价小计integer

products: 餐品array可选
- code: 产品Codestring
- isPromotion: 当前产品是否优惠商品:0-否;1-是;(任意消费享免费开始启用)integer
- customization: CartCustomization_购物车详情特调信息
  - options: 特调选项列表(是否需要类型，中台叫勾选要不要类型)array
    - displayText: 展示特调定制文本string
    - code: 特调编码string
    - quantity: 数量integer
    - checkedCode: 【前端请忽略】选中的Codestring
    - price: 价格,单位分。(暂时用不到)integer
    - name: 特调名称，如：冰量string
    - checked: 是否选择:0-否;1-是;integer
  - items: 特调选项列表(单选类型，中台叫平铺选项类型)array
    - displayText: 展示特调定制文本string
    - code: 特调编码string
    - values: 选中项(数组)array
      - code: 选项值Codestring
      - quantity: 数量integer
      - price: 价格,单位分。(暂时用不到)integer
      - name: 选项值名称string
    - name: 特调名称，如：冰量string
- invalidTime: 商品失效时间string
- originPrice: 【前端请忽略】基础价integer
- type: 产品类型:1-单品;2-套餐;integer
- subTotalPrice: 产品单价小计integer
- realPackingFeeTotalPrice: 实际商品打包费总价[单位分]integer
- bu: 商品所属BU:1-母店;2-麦咖啡;3-麦乐送;integer
- isCouponEnable: 当前优惠是否可用:0-否;1-是;integer
- price: 产品单价integer
- realSubTotalPrice: 产品优惠后单价小计integer
- packingFeePrice: 商品打包费单价[单位分]integer
- image: 产品图片string
- quantity: 数量integer
- coupon: MenuCartProductCoupon_购物车产品里的优惠券信息
  - iconText: 权益卡图标文字string
  - code: 优惠券Codestring
  - mpCouponCardType: 中台优惠券卡类型: 0-普通券; 1-员工卡券; 2-权益卡券integer
  - icon: 权益卡图标-展示在产品名称下面string
  - rightCardType: 权益卡类型：0OH麦卡,1麦乐送卡,2早餐卡,3麦咖啡月享卡integer
  - rightCardTypeText: 权益卡类型描述string
  - promotionId: 优惠IDstring
  - eligibleItemQuantity: 参与促销优惠的数量integer
  - showPmtType: 促销展示类型，1券，2促销integer
  - cardIcon: 权益卡图标-展示价格前面string
  - couponType: 优惠券类型:0-非预付券 1 预付券integer
  - cardId: 权益卡Id 随单购需求加的字段string
  - name: 优惠券名称string
  - id: 优惠券Idstring
  - rightCardName: 权益卡名称string
  - isWithOrder: 是否随单购,1是,0不是integer
- cardType: 产品所属权益卡类型integer
- comboItems: 套餐里的餐品信息array
  - comboProducts: 该轮次已选餐品array
    - image: 餐品图片string
    - bu: 商品所属BU:1-母店;2-麦咖啡;3-麦乐送;integer
    - code: 餐品编码string
    - quantity: 子项数量integer
    - customization: CartCustomization_购物车详情特调信息
      - options: 特调选项列表(是否需要类型，中台叫勾选要不要类型)array
        displayText: 展示特调定制文本string
        code: 特调编码string
        quantity: 数量integer
        checkedCode: 【前端请忽略】选中的Codestring
        price: 价格,单位分。(暂时用不到)integer
        name: 特调名称，如：冰量string
        checked: 是否选择:0-否;1-是;integer
      - items: 特调选项列表(单选类型，中台叫平铺选项类型)array
        displayText: 展示特调定制文本string
        code: 特调编码string
        values: 选中项(数组)array
        code: 选项值Codestring
        quantity: 数量integer
        price: 价格,单位分。(暂时用不到)integer
        name: 选项值名称string
        name: 特调名称，如：冰量string
    - price: 【前端请忽略】子餐品价格integer
    - name: 餐品名称string
    - onSale: 当前状态是否可售:0-否，不可售;1-是，可售;integer
    - originPrice: 【前端请忽略】子餐品基础价integer
  - quantity: 数量integer
  - round: 轮次integer
  - isChoices: 是否可选项:0-否;1-是;integer
  - choicesCode: 可选组编码string
  - costInclusive: 【前端请忽略】是否包含在套餐里string
  - classification: 套餐构成分类: 1-主食;2-小食;3-饮料;4-玩具;5-配料;integer
- saleStatus: 可售卖状态:1-正常;2-不可售卖;3-部分餐品可售(套餐,type=2才会有);integer
- belongCards: 产品所属权益卡列表array
  - cardId: 产品所属权益卡idstring
  - cardType: 产品所属权益卡类型integer
- sequence: 购物车序号integer
- couponDisableReason: 优惠券不可用原因, isCouponEnable=0 时有值string
- pmtIcons: 优惠图标列表array
  - image: 展示图标string
  - text: 展示文字string
  - type: 展示样式,1无员工优惠样式,2麦咖啡月享卡integer
- displayComboItems: 套餐里的餐品信息(用于展示，将相同的餐品合并起来，使用 quantity 字段表示数量)array
  - comboProducts: 该轮次已选餐品array
    - image: 餐品图片string
    - bu: 商品所属BU:1-母店;2-麦咖啡;3-麦乐送;integer
    - code: 餐品编码string
    - quantity: 子项数量integer
    - customization: CartCustomization_购物车详情特调信息
      - options: 特调选项列表(是否需要类型，中台叫勾选要不要类型)array
        displayText: 展示特调定制文本string
        code: 特调编码string
        quantity: 数量integer
        checkedCode: 【前端请忽略】选中的Codestring
        price: 价格,单位分。(暂时用不到)integer
        name: 特调名称，如：冰量string
        checked: 是否选择:0-否;1-是;integer
      - items: 特调选项列表(单选类型，中台叫平铺选项类型)array
        displayText: 展示特调定制文本string
        code: 特调编码string
        values: 选中项(数组)array
        code: 选项值Codestring
        quantity: 数量integer
        price: 价格,单位分。(暂时用不到)integer
        name: 选项值名称string
        name: 特调名称，如：冰量string
    - price: 【前端请忽略】子餐品价格integer
    - name: 餐品名称string
    - onSale: 当前状态是否可售:0-否，不可售;1-是，可售;integer
    - originPrice: 【前端请忽略】子餐品基础价integer
  - quantity: 数量integer
  - round: 轮次integer
  - isChoices: 是否可选项:0-否;1-是;integer
  - choicesCode: 可选组编码string
  - costInclusive: 【前端请忽略】是否包含在套餐里string
  - classification: 套餐构成分类: 1-主食;2-小食;3-饮料;4-玩具;5-配料;integer
- cardId: 产品所属权益卡idstring
- name: 产品名称string
- customizationMode: 是否可特制integer
- actions: 操作,1可删除,2可改数量,3可进产品详情array[integer]
- realPrice: 产品优惠后单价integer

promptType: 购物车底部提示信息类型。枚举值: 1-任意消费免费享错误提示(从 attrs 里取: name,image); 默认 0，即直接展示 Text。integer可选

daypartCode: 餐段string可选

realPackingFeeTotalPrice: 实际打包费总价[单位分]integer可选

realTotalPrice: 实际总金额单位分integer可选

realDeliveryPrice: 实际配送价格单位分integer可选

cartType: 购物车类型: 1-普通购物车;2-共享购物车;3-离线购物车;integer可选

promptAttrs: MenuCartPromptAttrs_购物车底部提示扩展信息可选
- image: 产品/优惠券图片string
- name: 产品名称string

promptBinds: 占位符号替换字符及颜色。(目前无需使用，后面有需求会用到。)array可选
- color: 色彩string
- text: 替换文字string

promptText: 购物车底部提示信息，格式形如: XXX{1}XXXX{2}XXX{3}XXXstring可选

maxPurchaseQuantity: 餐品最大可购买数量integer可选

deliveryPrice: 配送价格[单位分]integer可选

withOrderCardDiscountTips: 随单购权益卡优惠提示string可选

promotions: 整单的优惠array可选
- image: 图片链接string
- couponName: 优惠券名称string
- memoBinds: 优惠说明特殊处理部分绑定数据array[string]
- cardType: 权益卡类型integer
- discount: 折扣,员工卡 7.5number
- memo: 优惠说明string
- used: 是否已应用boolean
- couponId: 优惠券IDstring
- cardHas: 权益卡是否拥有了boolean
- promotionId: 促销IDstring
- validateNum: 有效时长天数,权益卡在用integer
- couponDisableReason: 优惠券不可用原因string
- couponType: 券类型:0-普通券，1-员工券，2-权益券;integer
- cardId: 权益卡Idstring
- showType: 优惠展示类型(辅助字段，与业务逻辑无关):101-员工卡;103-oh麦卡、mds卡、早餐卡;104麦咖啡月享卡integer
- couponCode: 优惠券Codestring
- realPrice: 真实价格,单位分integer

tipsList: 提示信息列表array可选
- orderCouponBalance: 订单券还差金额文字替换string
- deliveryCouponText: 运费券文案string
- orderCouponText: 订单券文案string
- deliveryCouponBalance: 运费券还差金额文字替换string
- text: 提示文案string
- type: 提示类型，1-toast提示text,2不享受员工优惠的商品提示,3主动命中券文案integer
- products: 产品列表array
  - image: 产品图片string
  - price: 产品单价integer
  - name: 产品名称string
  - subTotalPrice: 产品单价小计integer

beCode: BE编码string可选

realProductTotalPrice: 实际餐品价格单位分integer可选

storeCode: 门店编码string可选

PUT 更新购物车

餐品加购、删除等操作

访问地址: /carts

定义

PUT /carts

请求示例

curl -X PUT "https://api.open.mcd.cn/carts" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" \

  -d "{\"date\":\"Lorem ipsum dolor s\",\"daypartCode\":5,\"orderType\":87,\"cartType\":92,\"beCode\":\"Lorem ipsum \",\"time\":\"Lorem ipsum d\",\"dataSource\":11,\"isGroupMeal\":1,\"products\":[{\"image\":\"Lorem ipsu\",\"code\":\"Lorem ipsu\",\"quantity\":52,\"customization\":{\"options\":[{\"mode\":21,\"code\":\"Lorem ipsum \",\"quantity\":13,\"checked\":12,\"displayMode\":0}],\"items\":[{\"mode\":76,\"code\":\"Lorem ipsum dolor \",\"quantity\":50,\"values\":[{\"code\":\"Lorem ipsum dolor s\",\"quantity\":36,\"isModify\":0}],\"displayMode\":0}]},\"cardType\":10,\"comboItems\":[{\"comboProducts\":[{\"code\":\"Lorem ipsum dolor s\",\"customization\":{\"options\":[{\"mode\":33,\"code\":\"Lorem ipsum dol\",\"quantity\":67,\"checked\":28,\"displayMode\":1}],\"items\":[{\"mode\":4,\"code\":\"Lorem ipsum\",\"quantity\":6,\"values\":[{\"code\":\"Lorem ipsum dolor si\",\"quantity\":36,\"isModify\":0}],\"displayMode\":0}]},\"grills\":[{\"grillCode\":\"Lorem ipsum d\",\"quantity\":100,\"isModify\":\"Lorem ipsu\"}]}],\"round\":\"Lorem ipsum do\",\"isChoices\":\"Lorem ipsum dolor si\",\"choicesCode\":\"Lorem ipsum dolor s\"}],\"couponId\":\"Lorem ipsum dolo\",\"type\":\"Lorem ipsum d\",\"promotionId\":\"Lorem ipsum dolor si\",\"grills\":[{\"grillCode\":\"Lorem ipsum dol\",\"quantity\":87,\"isModify\":\"Lorem ipsum dolor\"}],\"sequence\":4,\"cardId\":\"Lorem ipsum dolor si\",\"name\":\"Lorem ipsum dolor si\",\"couponCode\":\"Lorem ipsum\"}],\"storeCode\":\"Lorem ipsum \"}"

返回结果示例


{
  "failProductStatusList": [
    {
      "image": "Lorem ipsum dol",
      "sequence": 52,
      "code": "Lorem ipsu",
      "failType": 45,
      "quantity": 27,
      "limitCount": 24,
      "couponStatus": {
        "code": "Lorem ipsum dolor si",
        "unavailableReason": "Lorem ipsum dolor",
        "cardId": "Lorem ipsum dolor ",
        "name": "Lorem ipsum ",
        "id": "Lorem ipsum dolor ",
        "promotionId": "Lorem ipsum ",
        "status": 1
      },
      "name": "Lorem ipsum dolor",
      "saleStatus": 0
    }
  ],
  "cartDetail": {
    "localDateTime": "Lorem ipsum dolor ",
    "promptColor": "Lorem ipsum dolor ",
    "orderType": 7,
    "submit": 56,
    "totalPrice": 25,
    "productTotalPrice": 18,
    "channel": "Lorem ipsum",
    "discountAmount": 0,
    "tips": {
      "orderCouponBalance": "Lorem ipsum dol",
      "deliveryCouponText": "Lorem ipsu",
      "orderCouponText": "Lorem ipsum dolor s",
      "deliveryCouponBalance": "Lorem ipsum",
      "text": "Lorem ipsum do",
      "type": 48,
      "products": [
        {
          "image": "Lorem ipsum dolor si",
          "price": 88,
          "name": "Lorem ipsum d",
          "subTotalPrice": 30
        }
      ]
    },
    "products": [
      {
        "code": "Lorem ipsum dolor si",
        "isPromotion": 1,
        "customization": {
          "options": [
            {
              "displayText": "Lorem ipsum dolor",
              "code": "Lorem ipsum dolo",
              "quantity": 51,
              "checkedCode": "Lorem ipsum dolo",
              "price": 37,
              "name": "Lorem ipsum dolor ",
              "checked": 94
            }
          ],
          "items": [
            {
              "displayText": "Lorem ipsum dolor si",
              "code": "Lorem ipsum dolor ",
              "values": [
                {
                  "code": "Lorem ipsum dolor",
                  "quantity": 90,
                  "price": 3,
                  "name": "Lorem ipsum dolor"
                }
              ],
              "name": "Lorem ipsum dolor s"
            }
          ]
        },
        "invalidTime": "Lorem ipsu",
        "originPrice": 72,
        "type": 5,
        "subTotalPrice": 96,
        "realPackingFeeTotalPrice": 52,
        "bu": 27,
        "isCouponEnable": 1,
        "price": 14,
        "realSubTotalPrice": 10,
        "packingFeePrice": 37,
        "image": "Lorem ipsum dolor ",
        "quantity": 11,
        "coupon": {
          "iconText": "Lorem ipsu",
          "code": "Lorem ipsum",
          "mpCouponCardType": 60,
          "icon": "Lorem ipsum dolor ",
          "rightCardType": 99,
          "rightCardTypeText": "Lorem ipsum dolor si",
          "promotionId": "Lorem ipsum ",
          "eligibleItemQuantity": 17,
          "showPmtType": 97,
          "cardIcon": "Lorem ipsum",
          "couponType": 12,
          "cardId": "Lorem ipsum do",
          "name": "Lorem ipsum dolo",
          "id": "Lorem ipsum dolor",
          "rightCardName": "Lorem ipsum dolor ",
          "isWithOrder": 0
        },
        "cardType": 46,
        "comboItems": [
          {
            "comboProducts": [
              {
                "image": "Lorem ipsum",
                "bu": 97,
                "code": "Lorem ipsum do",
                "quantity": 51,
                "customization": {
                  "options": [
                    {
                      "displayText": "Lorem ipsum dolor ",
                      "code": "Lorem ipsu",
                      "quantity": 75,
                      "checkedCode": "Lorem ipsum d",
                      "price": 8,
                      "name": "Lorem ipsu",
                      "checked": 40
                    }
                  ],
                  "items": [
                    {
                      "displayText": "Lorem ipsu",
                      "code": "Lorem ipsum ",
                      "values": [
                        {
                          "code": "Lorem ipsum dolor ",
                          "quantity": 66,
                          "price": 91,
                          "name": "Lorem ipsu"
                        }
                      ],
                      "name": "Lorem ipsum"
                    }
                  ]
                },
                "price": 89,
                "name": "Lorem ipsum dolor",
                "onSale": 75,
                "originPrice": 76
              }
            ],
            "quantity": 59,
            "round": 36,
            "isChoices": 1,
            "choicesCode": "Lorem ipsum d",
            "costInclusive": "Lorem ipsum",
            "classification": 83
          }
        ],
        "saleStatus": 1,
        "belongCards": [
          {
            "cardId": "Lorem ipsum ",
            "cardType": 86
          }
        ],
        "sequence": 8,
        "couponDisableReason": "Lorem ipsum ",
        "pmtIcons": [
          {
            "image": "Lorem ipsum ",
            "text": "Lorem ipsum d",
            "type": 88
          }
        ],
        "displayComboItems": [
          {
            "comboProducts": [
              {
                "image": "Lorem ipsum d",
                "bu": 64,
                "code": "Lorem ipsum dolor s",
                "quantity": 52,
                "customization": {
                  "options": [
                    {
                      "displayText": "Lorem ipsum",
                      "code": "Lorem ipsum d",
                      "quantity": 67,
                      "checkedCode": "Lorem ipsum dolor s",
                      "price": 4,
                      "name": "Lorem ipsum dol",
                      "checked": 41
                    }
                  ],
                  "items": [
                    {
                      "displayText": "Lorem ipsum do",
                      "code": "Lorem ipsum do",
                      "values": [
                        {
                          "code": "Lorem ipsum dolor s",
                          "quantity": 91,
                          "price": 23,
                          "name": "Lorem ipsum do"
                        }
                      ],
                      "name": "Lorem ipsum do"
                    }
                  ]
                },
                "price": 8,
                "name": "Lorem ipsu",
                "onSale": 42,
                "originPrice": 44
              }
            ],
            "quantity": 45,
            "round": 85,
            "isChoices": 0,
            "choicesCode": "Lorem ipsum",
            "costInclusive": "Lorem ipsum d",
            "classification": 2
          }
        ],
        "cardId": "Lorem ipsum d",
        "name": "Lorem ipsum dolo",
        "customizationMode": 27,
        "actions": [
          78
        ],
        "realPrice": 43
      }
    ],
    "promptType": 85,
    "daypartCode": "Lorem ipsu",
    "realPackingFeeTotalPrice": 35,
    "realTotalPrice": 62,
    "realDeliveryPrice": 47,
    "cartType": 91,
    "promptAttrs": {
      "image": "Lorem ipsum dolor s",
      "name": "Lorem ipsum dolor "
    },
    "promptBinds": [
      {
        "color": "Lorem ipsu",
        "text": "Lorem ipsum dolor si"
      }
    ],
    "promptText": "Lorem ipsum dol",
    "maxPurchaseQuantity": 46,
    "deliveryPrice": 18,
    "withOrderCardDiscountTips": "Lorem ipsum dolor si",
    "promotions": [
      {
        "image": "Lorem ipsum d",
        "couponName": "Lorem ipsum",
        "memoBinds": [
          "Lorem ipsum dolor "
        ],
        "cardType": 69,
        "discount": "number",
        "memo": "Lorem ipsum dolo",
        "used": 0,
        "couponId": "Lorem ipsum dolor",
        "cardHas": 0,
        "promotionId": "Lorem ipsum dolor si",
        "validateNum": 18,
        "couponDisableReason": "Lorem ipsum",
        "couponType": 66,
        "cardId": "Lorem ipsum dolo",
        "showType": 23,
        "couponCode": "Lorem ipsum dolo",
        "realPrice": 46
      }
    ],
    "tipsList": [
      {
        "orderCouponBalance": "Lorem ipsum do",
        "deliveryCouponText": "Lorem ipsum",
        "orderCouponText": "Lorem ipsum d",
        "deliveryCouponBalance": "Lorem ipsum dolor s",
        "text": "Lorem ipsum dolo",
        "type": 70,
        "products": [
          {
            "image": "Lorem ipsum do",
            "price": 49,
            "name": "Lorem ipsum do",
            "subTotalPrice": 98
          }
        ]
      }
    ],
    "beCode": "Lorem ipsum ",
    "realProductTotalPrice": 74,
    "storeCode": "Lorem ipsum d"
  },
  "conflictCoupons": {
    "coupons": [
      {
        "image": "Lorem ipsum",
        "orderType": 69,
        "cardType": 77,
        "couponId": "Lorem ipsum ",
        "todayLeftCount": 91,
        "isDisplay": 1,
        "promotionId": "Lorem ipsum",
        "totalLeftCount": 49,
        "couponType": 58,
        "cardId": "Lorem ipsum dolor ",
        "couponCode": "Lorem ipsu",
        "couponTitle": "Lorem ipsum dolor ",
        "timeRange": "Lorem ipsum dol"
      }
    ],
    "text": "Lorem ipsum dolor s",
    "cartButtonInfos": [
      {
        "text": "Lorem ipsum",
        "type": 36
      }
    ],
    "products": [
      {
        "image": "Lorem ipsu",
        "sequence": 88,
        "code": "Lorem ipsum dolor si",
        "name": "Lorem ipsum ",
        "isDisplay": 0
      }
    ]
  }
}

入参说明(在BODY)

date: 日期，默认当天，格式形如 20200808string可选

daypartCode: 餐段integer必须

orderType: 外送类型:1-pickup;2-deliver;integer必须

cartType: 购物车类型: 1-普通购物车integer必须

beCode: 门店becodestring可选

time: 时间，默认当前时间, 格式为 HH:mm, 比如 09:08string可选

dataSource: 加购的数据来源: 1.菜单 2.订单 3.优惠券integer必须

isGroupMeal: 团餐标志位 1:是团餐integer可选

products: 增删改购物车餐品的参数array必须M
- image: 产品图片string可选
- code: 商品编码string必须
- quantity: 商品变化数量：1，2，-1，-2integer必须
- customization: CartRequestCustomization_餐品特制(定制)信息可选
  - options: 特制选项列表(是否需要类型，中台叫勾选要不要类型)array
    - mode: 特制方式: 1:固定选项; 2:自定义数量integer
    - code: 特制编码string
    - quantity: 特制默认数量integer
    - checked: 是否选中 0:没有选中 1：选中integer
    - displayMode: 特制显示方式: 1.平铺选项, 2.勾选要不要integer
  - items: 特制选项列表(单选类型，中台叫平铺选项类型)array
    - mode: 特制方式: 1:固定选项; 2:自定义数量integer
    - code: 特制编码string
    - quantity: 特制默认数量integer
    - values: 特质选项array
      - code: 特制选项编码string
      - quantity: 特制选项数量integer
      - isModify: 是否变更: 0-否;1-是;integer
    - displayMode: 特制显示方式: 1.平铺选项, 2.勾选要不要integer
- cardType: 权益卡类型integer可选
- comboItems: 套餐子项array必须M
  - comboProducts: 套餐组成项(可选餐品)array必须M
    - code: 商品编码string必须
    - customization: CartRequestCustomization_餐品特制(定制)信息可选
      - options: 特制选项列表(是否需要类型，中台叫勾选要不要类型)array
        mode: 特制方式: 1:固定选项; 2:自定义数量integer
        code: 特制编码string
        quantity: 特制默认数量integer
        checked: 是否选中 0:没有选中 1：选中integer
        displayMode: 特制显示方式: 1.平铺选项, 2.勾选要不要integer
      - items: 特制选项列表(单选类型，中台叫平铺选项类型)array
        mode: 特制方式: 1:固定选项; 2:自定义数量integer
        code: 特制编码string
        quantity: 特制默认数量integer
        values: 特质选项array
        code: 特制选项编码string
        quantity: 特制选项数量integer
        isModify: 是否变更: 0-否;1-是;integer
        displayMode: 特制显示方式: 1.平铺选项, 2.勾选要不要integer
    - grills: 餐品特调信息array必须M
      - grillCode: 特调codestring必须
      - quantity: 特制子选项数量integer必须
      - isModify: 是否Modify标记 0：非Modify；1：Modifystring必须
  - round: 轮次string必须
  - isChoices: 是否可选项: 0-否;1-是;string必须
  - choicesCode: 可选组编码string可选
- couponId: 优惠券IDstring可选
- type: 商品类型string必须
- promotionId: 促销IDstring可选
- grills: 餐品特调信息array必须M
  - grillCode: 特调codestring必须
  - quantity: 特制子选项数量integer必须
  - isModify: 是否Modify标记 0：非Modify；1：Modifystring必须
- sequence: 序号integer必须
- cardId: 权益卡idstring可选
- name: 商品名称string必须
- couponCode: 优惠券券码string可选

storeCode: 餐厅编码string必须

返参说明

failProductStatusList: 购物车餐品状态:1-餐品均可售卖;2-餐品均为不可售卖;3-餐品部分不可售卖array
- image: 产品图片string
- sequence: 购物车序号integer
- code: 产品Codestring
- failType: 商品加购失败的原因类型：1-不可售卖；2-超过数量限制integer
- quantity: 产品数量integer
- limitCount: 商品加购限购的数量integer
- couponStatus: CouponStatus
  - code: 优惠券Codestring
  - unavailableReason: 券不可用的原因string
  - cardId: 权益卡idstring
  - name: 优惠券名称string
  - id: 优惠券Idstring
  - promotionId: 优惠IDstring
  - status: 状态:0-不可用;1-可用integer
- name: 产品名称string
- saleStatus: 可售卖状态:1-正常;2-不可售卖integer

cartDetail: CartDetailResponseVO_获取购物车返回必须M
- localDateTime: 当前时间string必须
- promptColor: 购物车底部提示信息文字颜色string可选
- orderType: 外送类型: 1-pickup;2-deliver;integer可选
- submit: 是否可提交结算:0-否;1-是;integer可选
- totalPrice: 总金额单位分integer可选
- productTotalPrice: 餐品价格单位分integer可选
- channel: 渠道string可选
- discountAmount: 餐品优惠金额单位分integer可选
- tips: CartTips_提示信息可选
  - orderCouponBalance: 订单券还差金额文字替换string
  - deliveryCouponText: 运费券文案string
  - orderCouponText: 订单券文案string
  - deliveryCouponBalance: 运费券还差金额文字替换string
  - text: 提示文案string
  - type: 提示类型，1-toast提示text,2不享受员工优惠的商品提示,3主动命中券文案integer
  - products: 产品列表array
    - image: 产品图片string
    - price: 产品单价integer
    - name: 产品名称string
    - subTotalPrice: 产品单价小计integer
- products: 餐品array可选
  - code: 产品Codestring
  - isPromotion: 当前产品是否优惠商品:0-否;1-是;(任意消费享免费开始启用)integer
  - customization: CartCustomization_购物车详情特调信息
    - options: 特调选项列表(是否需要类型，中台叫勾选要不要类型)array
      - displayText: 展示特调定制文本string
      - code: 特调编码string
      - quantity: 数量integer
      - checkedCode: 【前端请忽略】选中的Codestring
      - price: 价格,单位分。(暂时用不到)integer
      - name: 特调名称，如：冰量string
      - checked: 是否选择:0-否;1-是;integer
    - items: 特调选项列表(单选类型，中台叫平铺选项类型)array
      - displayText: 展示特调定制文本string
      - code: 特调编码string
      - values: 选中项(数组)array
        code: 选项值Codestring
        quantity: 数量integer
        price: 价格,单位分。(暂时用不到)integer
        name: 选项值名称string
      - name: 特调名称，如：冰量string
  - invalidTime: 商品失效时间string
  - originPrice: 【前端请忽略】基础价integer
  - type: 产品类型:1-单品;2-套餐;integer
  - subTotalPrice: 产品单价小计integer
  - realPackingFeeTotalPrice: 实际商品打包费总价[单位分]integer
  - bu: 商品所属BU:1-母店;2-麦咖啡;3-麦乐送;integer
  - isCouponEnable: 当前优惠是否可用:0-否;1-是;integer
  - price: 产品单价integer
  - realSubTotalPrice: 产品优惠后单价小计integer
  - packingFeePrice: 商品打包费单价[单位分]integer
  - image: 产品图片string
  - quantity: 数量integer
  - coupon: MenuCartProductCoupon_购物车产品里的优惠券信息
    - iconText: 权益卡图标文字string
    - code: 优惠券Codestring
    - mpCouponCardType: 中台优惠券卡类型: 0-普通券; 1-员工卡券; 2-权益卡券integer
    - icon: 权益卡图标-展示在产品名称下面string
    - rightCardType: 权益卡类型：0OH麦卡,1麦乐送卡,2早餐卡,3麦咖啡月享卡integer
    - rightCardTypeText: 权益卡类型描述string
    - promotionId: 优惠IDstring
    - eligibleItemQuantity: 参与促销优惠的数量integer
    - showPmtType: 促销展示类型，1券，2促销integer
    - cardIcon: 权益卡图标-展示价格前面string
    - couponType: 优惠券类型:0-非预付券 1 预付券integer
    - cardId: 权益卡Id 随单购需求加的字段string
    - name: 优惠券名称string
    - id: 优惠券Idstring
    - rightCardName: 权益卡名称string
    - isWithOrder: 是否随单购,1是,0不是integer
  - cardType: 产品所属权益卡类型integer
  - comboItems: 套餐里的餐品信息array
    - comboProducts: 该轮次已选餐品array
      - image: 餐品图片string
      - bu: 商品所属BU:1-母店;2-麦咖啡;3-麦乐送;integer
      - code: 餐品编码string
      - quantity: 子项数量integer
      - customization: CartCustomization_购物车详情特调信息
        options: 特调选项列表(是否需要类型，中台叫勾选要不要类型)array
        displayText: 展示特调定制文本string
        code: 特调编码string
        quantity: 数量integer
        checkedCode: 【前端请忽略】选中的Codestring
        price: 价格,单位分。(暂时用不到)integer
        name: 特调名称，如：冰量string
        checked: 是否选择:0-否;1-是;integer
        items: 特调选项列表(单选类型，中台叫平铺选项类型)array
        displayText: 展示特调定制文本string
        code: 特调编码string
        values: 选中项(数组)array
        code: 选项值Codestring
        quantity: 数量integer
        price: 价格,单位分。(暂时用不到)integer
        name: 选项值名称string
        name: 特调名称，如：冰量string
      - price: 【前端请忽略】子餐品价格integer
      - name: 餐品名称string
      - onSale: 当前状态是否可售:0-否，不可售;1-是，可售;integer
      - originPrice: 【前端请忽略】子餐品基础价integer
    - quantity: 数量integer
    - round: 轮次integer
    - isChoices: 是否可选项:0-否;1-是;integer
    - choicesCode: 可选组编码string
    - costInclusive: 【前端请忽略】是否包含在套餐里string
    - classification: 套餐构成分类: 1-主食;2-小食;3-饮料;4-玩具;5-配料;integer
  - saleStatus: 可售卖状态:1-正常;2-不可售卖;3-部分餐品可售(套餐,type=2才会有);integer
  - belongCards: 产品所属权益卡列表array
    - cardId: 产品所属权益卡idstring
    - cardType: 产品所属权益卡类型integer
  - sequence: 购物车序号integer
  - couponDisableReason: 优惠券不可用原因, isCouponEnable=0 时有值string
  - pmtIcons: 优惠图标列表array
    - image: 展示图标string
    - text: 展示文字string
    - type: 展示样式,1无员工优惠样式,2麦咖啡月享卡integer
  - displayComboItems: 套餐里的餐品信息(用于展示，将相同的餐品合并起来，使用 quantity 字段表示数量)array
    - comboProducts: 该轮次已选餐品array
      - image: 餐品图片string
      - bu: 商品所属BU:1-母店;2-麦咖啡;3-麦乐送;integer
      - code: 餐品编码string
      - quantity: 子项数量integer
      - customization: CartCustomization_购物车详情特调信息
        options: 特调选项列表(是否需要类型，中台叫勾选要不要类型)array
        displayText: 展示特调定制文本string
        code: 特调编码string
        quantity: 数量integer
        checkedCode: 【前端请忽略】选中的Codestring
        price: 价格,单位分。(暂时用不到)integer
        name: 特调名称，如：冰量string
        checked: 是否选择:0-否;1-是;integer
        items: 特调选项列表(单选类型，中台叫平铺选项类型)array
        displayText: 展示特调定制文本string
        code: 特调编码string
        values: 选中项(数组)array
        code: 选项值Codestring
        quantity: 数量integer
        price: 价格,单位分。(暂时用不到)integer
        name: 选项值名称string
        name: 特调名称，如：冰量string
      - price: 【前端请忽略】子餐品价格integer
      - name: 餐品名称string
      - onSale: 当前状态是否可售:0-否，不可售;1-是，可售;integer
      - originPrice: 【前端请忽略】子餐品基础价integer
    - quantity: 数量integer
    - round: 轮次integer
    - isChoices: 是否可选项:0-否;1-是;integer
    - choicesCode: 可选组编码string
    - costInclusive: 【前端请忽略】是否包含在套餐里string
    - classification: 套餐构成分类: 1-主食;2-小食;3-饮料;4-玩具;5-配料;integer
  - cardId: 产品所属权益卡idstring
  - name: 产品名称string
  - customizationMode: 是否可特制integer
  - actions: 操作,1可删除,2可改数量,3可进产品详情array[integer]
  - realPrice: 产品优惠后单价integer
- promptType: 购物车底部提示信息类型。枚举值: 1-任意消费免费享错误提示(从 attrs 里取: name,image); 默认 0，即直接展示 Text。integer可选
- daypartCode: 餐段string可选
- realPackingFeeTotalPrice: 实际打包费总价[单位分]integer可选
- realTotalPrice: 实际总金额单位分integer可选
- realDeliveryPrice: 实际配送价格单位分integer可选
- cartType: 购物车类型: 1-普通购物车;2-共享购物车;3-离线购物车;integer可选
- promptAttrs: MenuCartPromptAttrs_购物车底部提示扩展信息可选
  - image: 产品/优惠券图片string
  - name: 产品名称string
- promptBinds: 占位符号替换字符及颜色。(目前无需使用，后面有需求会用到。)array可选
  - color: 色彩string
  - text: 替换文字string
- promptText: 购物车底部提示信息，格式形如: XXX{1}XXXX{2}XXX{3}XXXstring可选
- maxPurchaseQuantity: 餐品最大可购买数量integer可选
- deliveryPrice: 配送价格[单位分]integer可选
- withOrderCardDiscountTips: 随单购权益卡优惠提示string可选
- promotions: 整单的优惠array可选
  - image: 图片链接string
  - couponName: 优惠券名称string
  - memoBinds: 优惠说明特殊处理部分绑定数据array[string]
  - cardType: 权益卡类型integer
  - discount: 折扣,员工卡 7.5number
  - memo: 优惠说明string
  - used: 是否已应用boolean
  - couponId: 优惠券IDstring
  - cardHas: 权益卡是否拥有了boolean
  - promotionId: 促销IDstring
  - validateNum: 有效时长天数,权益卡在用integer
  - couponDisableReason: 优惠券不可用原因string
  - couponType: 券类型:0-普通券，1-员工券，2-权益券;integer
  - cardId: 权益卡Idstring
  - showType: 优惠展示类型(辅助字段，与业务逻辑无关):101-员工卡;103-oh麦卡、mds卡、早餐卡;104麦咖啡月享卡integer
  - couponCode: 优惠券Codestring
  - realPrice: 真实价格,单位分integer
- tipsList: 提示信息列表array可选
  - orderCouponBalance: 订单券还差金额文字替换string
  - deliveryCouponText: 运费券文案string
  - orderCouponText: 订单券文案string
  - deliveryCouponBalance: 运费券还差金额文字替换string
  - text: 提示文案string
  - type: 提示类型，1-toast提示text,2不享受员工优惠的商品提示,3主动命中券文案integer
  - products: 产品列表array
    - image: 产品图片string
    - price: 产品单价integer
    - name: 产品名称string
    - subTotalPrice: 产品单价小计integer
- beCode: BE编码string可选
- realProductTotalPrice: 实际餐品价格单位分integer可选
- storeCode: 门店编码string可选

conflictCoupons: CartConflictInfo_冲突信息
- coupons: 冲突的券的具体信息array必须M
  - image: 优惠券图标string可选
  - orderType: 外送类型:1-pickup;2-deliver;integer必须
  - cardType: 权益类型integer可选
  - couponId: Coupon Idstring可选
  - todayLeftCount: 今日剩余可用次数integer可选
  - isDisplay: 是否展示：0-不展示；1-展示； integer可选
  - promotionId: Promotionstring可选
  - totalLeftCount: 总剩余可用次数integer可选
  - couponType: 券类型，枚举值为: 0-普通券，1-员工券，2-权益券;integer可选
  - cardId: 权益idstring可选
  - couponCode: Coupon Codestring可选
  - couponTitle: 优惠券标题string可选
  - timeRange: 使用时间范围string可选
- text: 提示文案string
- cartButtonInfos: 加购提示按钮array
  - text: 按钮文案string
  - type: 按钮类型, 1. do nothing, 2.replace confirm,3不使用月享卡但需要加商品integer
- products: 冲突的商品的具体信息array
  - image: 产品图片string
  - sequence: 购物车序号integer
  - code: 产品Codestring
  - name: 产品名称string
  - isDisplay: 是否展示：0-不展示；1-展示；integer

PUT 清空购物车

访问地址: /carts/empty

定义

PUT /carts/empty

请求示例

curl -X PUT "https://api.open.mcd.cn/carts/empty" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" \

  -d "{\"date\":\"Lorem ipsum dolor \",\"daypartCode\":40,\"orderType\":1,\"cartType\":99,\"beCode\":\"Lorem ipsu\",\"time\":\"Lorem ipsum do\",\"isGroupMeal\":1,\"storeCode\":\"Lorem ipsum dolo\"}"

返回结果示例


{
  "datetime": "2021-08-04 11:02:26",
  "code": 200,
  "data": {
    "localDateTime": "2021-08-04 11:02:26",
    "orderType": 1,
    "maxPurchaseQuantity": 99,
    "submit": 0,
    "totalPrice": 0,
    "productTotalPrice": 0,
    "channel": "03",
    "discountAmount": 0,
    "deliveryPrice": 0,
    "withOrderCardDiscountTips": "已帮您最优匹配OH麦卡单件权益价",
    "products": [

    ],
    "promptType": 0,
    "realTotalPrice": 0,
    "daypartCode": "2",
    "promotions": [
      {
        "image": "https://menu-img.mcdchina.net/pcm/sit/menu/20200819a0803/product/MS_507715_100.png",
        "couponName": "OH麦卡",
        "couponType": 2,
        "cardId": "CRD0EC6AF084F5F2D491BCE8B2C1C6589B8",
        "showType": 103,
        "memo": "OH麦卡职场卡仿生产",
        "used": false,
        "realPrice": 1900,
        "validateNum": 30
      }
    ],
    "realDeliveryPrice": 0,
    "cartType": 1,
    "realProductTotalPrice": 0,
    "storeCode": "123456"
  },
  "success": true,
  "message": "请求成功"
}

入参说明(在BODY)

date: 日期，默认当天，格式形如 20200808string可选

daypartCode: 餐段integer必须

orderType: 外送类型:1-pickup;2-deliver;integer必须

cartType: 购物车类型: 1-普通购物车integer必须

beCode: 门店becodestring可选

time: 时间，默认当前时间, 格式为 HH:mm, 比如 09:08string可选

isGroupMeal: 团餐标志位 1:是团餐integer可选

storeCode: 餐厅编码string必须

返参说明

localDateTime: 当前时间string必须

promptColor: 购物车底部提示信息文字颜色string可选

orderType: 外送类型: 1-pickup;2-deliver;integer可选

submit: 是否可提交结算:0-否;1-是;integer可选

totalPrice: 总金额单位分integer可选

productTotalPrice: 餐品价格单位分integer可选

channel: 渠道string可选

discountAmount: 餐品优惠金额单位分integer可选

tips: CartTips_提示信息可选
- orderCouponBalance: 订单券还差金额文字替换string
- deliveryCouponText: 运费券文案string
- orderCouponText: 订单券文案string
- deliveryCouponBalance: 运费券还差金额文字替换string
- text: 提示文案string
- type: 提示类型，1-toast提示text,2不享受员工优惠的商品提示,3主动命中券文案integer
- products: 产品列表array
  - image: 产品图片string
  - price: 产品单价integer
  - name: 产品名称string
  - subTotalPrice: 产品单价小计integer

products: 餐品array可选
- code: 产品Codestring
- isPromotion: 当前产品是否优惠商品:0-否;1-是;(任意消费享免费开始启用)integer
- customization: CartCustomization_购物车详情特调信息
  - options: 特调选项列表(是否需要类型，中台叫勾选要不要类型)array
    - displayText: 展示特调定制文本string
    - code: 特调编码string
    - quantity: 数量integer
    - checkedCode: 【前端请忽略】选中的Codestring
    - price: 价格,单位分。(暂时用不到)integer
    - name: 特调名称，如：冰量string
    - checked: 是否选择:0-否;1-是;integer
  - items: 特调选项列表(单选类型，中台叫平铺选项类型)array
    - displayText: 展示特调定制文本string
    - code: 特调编码string
    - values: 选中项(数组)array
      - code: 选项值Codestring
      - quantity: 数量integer
      - price: 价格,单位分。(暂时用不到)integer
      - name: 选项值名称string
    - name: 特调名称，如：冰量string
- invalidTime: 商品失效时间string
- originPrice: 【前端请忽略】基础价integer
- type: 产品类型:1-单品;2-套餐;integer
- subTotalPrice: 产品单价小计integer
- realPackingFeeTotalPrice: 实际商品打包费总价[单位分]integer
- bu: 商品所属BU:1-母店;2-麦咖啡;3-麦乐送;integer
- isCouponEnable: 当前优惠是否可用:0-否;1-是;integer
- price: 产品单价integer
- realSubTotalPrice: 产品优惠后单价小计integer
- packingFeePrice: 商品打包费单价[单位分]integer
- image: 产品图片string
- quantity: 数量integer
- coupon: MenuCartProductCoupon_购物车产品里的优惠券信息
  - iconText: 权益卡图标文字string
  - code: 优惠券Codestring
  - mpCouponCardType: 中台优惠券卡类型: 0-普通券; 1-员工卡券; 2-权益卡券integer
  - icon: 权益卡图标-展示在产品名称下面string
  - rightCardType: 权益卡类型：0OH麦卡,1麦乐送卡,2早餐卡,3麦咖啡月享卡integer
  - rightCardTypeText: 权益卡类型描述string
  - promotionId: 优惠IDstring
  - eligibleItemQuantity: 参与促销优惠的数量integer
  - showPmtType: 促销展示类型，1券，2促销integer
  - cardIcon: 权益卡图标-展示价格前面string
  - couponType: 优惠券类型:0-非预付券 1 预付券integer
  - cardId: 权益卡Id 随单购需求加的字段string
  - name: 优惠券名称string
  - id: 优惠券Idstring
  - rightCardName: 权益卡名称string
  - isWithOrder: 是否随单购,1是,0不是integer
- cardType: 产品所属权益卡类型integer
- comboItems: 套餐里的餐品信息array
  - comboProducts: 该轮次已选餐品array
    - image: 餐品图片string
    - bu: 商品所属BU:1-母店;2-麦咖啡;3-麦乐送;integer
    - code: 餐品编码string
    - quantity: 子项数量integer
    - customization: CartCustomization_购物车详情特调信息
      - options: 特调选项列表(是否需要类型，中台叫勾选要不要类型)array
        displayText: 展示特调定制文本string
        code: 特调编码string
        quantity: 数量integer
        checkedCode: 【前端请忽略】选中的Codestring
        price: 价格,单位分。(暂时用不到)integer
        name: 特调名称，如：冰量string
        checked: 是否选择:0-否;1-是;integer
      - items: 特调选项列表(单选类型，中台叫平铺选项类型)array
        displayText: 展示特调定制文本string
        code: 特调编码string
        values: 选中项(数组)array
        code: 选项值Codestring
        quantity: 数量integer
        price: 价格,单位分。(暂时用不到)integer
        name: 选项值名称string
        name: 特调名称，如：冰量string
    - price: 【前端请忽略】子餐品价格integer
    - name: 餐品名称string
    - onSale: 当前状态是否可售:0-否，不可售;1-是，可售;integer
    - originPrice: 【前端请忽略】子餐品基础价integer
  - quantity: 数量integer
  - round: 轮次integer
  - isChoices: 是否可选项:0-否;1-是;integer
  - choicesCode: 可选组编码string
  - costInclusive: 【前端请忽略】是否包含在套餐里string
  - classification: 套餐构成分类: 1-主食;2-小食;3-饮料;4-玩具;5-配料;integer
- saleStatus: 可售卖状态:1-正常;2-不可售卖;3-部分餐品可售(套餐,type=2才会有);integer
- belongCards: 产品所属权益卡列表array
  - cardId: 产品所属权益卡idstring
  - cardType: 产品所属权益卡类型integer
- sequence: 购物车序号integer
- couponDisableReason: 优惠券不可用原因, isCouponEnable=0 时有值string
- pmtIcons: 优惠图标列表array
  - image: 展示图标string
  - text: 展示文字string
  - type: 展示样式,1无员工优惠样式,2麦咖啡月享卡integer
- displayComboItems: 套餐里的餐品信息(用于展示，将相同的餐品合并起来，使用 quantity 字段表示数量)array
  - comboProducts: 该轮次已选餐品array
    - image: 餐品图片string
    - bu: 商品所属BU:1-母店;2-麦咖啡;3-麦乐送;integer
    - code: 餐品编码string
    - quantity: 子项数量integer
    - customization: CartCustomization_购物车详情特调信息
      - options: 特调选项列表(是否需要类型，中台叫勾选要不要类型)array
        displayText: 展示特调定制文本string
        code: 特调编码string
        quantity: 数量integer
        checkedCode: 【前端请忽略】选中的Codestring
        price: 价格,单位分。(暂时用不到)integer
        name: 特调名称，如：冰量string
        checked: 是否选择:0-否;1-是;integer
      - items: 特调选项列表(单选类型，中台叫平铺选项类型)array
        displayText: 展示特调定制文本string
        code: 特调编码string
        values: 选中项(数组)array
        code: 选项值Codestring
        quantity: 数量integer
        price: 价格,单位分。(暂时用不到)integer
        name: 选项值名称string
        name: 特调名称，如：冰量string
    - price: 【前端请忽略】子餐品价格integer
    - name: 餐品名称string
    - onSale: 当前状态是否可售:0-否，不可售;1-是，可售;integer
    - originPrice: 【前端请忽略】子餐品基础价integer
  - quantity: 数量integer
  - round: 轮次integer
  - isChoices: 是否可选项:0-否;1-是;integer
  - choicesCode: 可选组编码string
  - costInclusive: 【前端请忽略】是否包含在套餐里string
  - classification: 套餐构成分类: 1-主食;2-小食;3-饮料;4-玩具;5-配料;integer
- cardId: 产品所属权益卡idstring
- name: 产品名称string
- customizationMode: 是否可特制integer
- actions: 操作,1可删除,2可改数量,3可进产品详情array[integer]
- realPrice: 产品优惠后单价integer

promptType: 购物车底部提示信息类型。枚举值: 1-任意消费免费享错误提示(从 attrs 里取: name,image); 默认 0，即直接展示 Text。integer可选

daypartCode: 餐段string可选

realPackingFeeTotalPrice: 实际打包费总价[单位分]integer可选

realTotalPrice: 实际总金额单位分integer可选

realDeliveryPrice: 实际配送价格单位分integer可选

cartType: 购物车类型: 1-普通购物车;2-共享购物车;3-离线购物车;integer可选

promptAttrs: MenuCartPromptAttrs_购物车底部提示扩展信息可选
- image: 产品/优惠券图片string
- name: 产品名称string

promptBinds: 占位符号替换字符及颜色。(目前无需使用，后面有需求会用到。)array可选
- color: 色彩string
- text: 替换文字string

promptText: 购物车底部提示信息，格式形如: XXX{1}XXXX{2}XXX{3}XXXstring可选

maxPurchaseQuantity: 餐品最大可购买数量integer可选

deliveryPrice: 配送价格[单位分]integer可选

withOrderCardDiscountTips: 随单购权益卡优惠提示string可选

promotions: 整单的优惠array可选
- image: 图片链接string
- couponName: 优惠券名称string
- memoBinds: 优惠说明特殊处理部分绑定数据array[string]
- cardType: 权益卡类型integer
- discount: 折扣,员工卡 7.5number
- memo: 优惠说明string
- used: 是否已应用boolean
- couponId: 优惠券IDstring
- cardHas: 权益卡是否拥有了boolean
- promotionId: 促销IDstring
- validateNum: 有效时长天数,权益卡在用integer
- couponDisableReason: 优惠券不可用原因string
- couponType: 券类型:0-普通券，1-员工券，2-权益券;integer
- cardId: 权益卡Idstring
- showType: 优惠展示类型(辅助字段，与业务逻辑无关):101-员工卡;103-oh麦卡、mds卡、早餐卡;104麦咖啡月享卡integer
- couponCode: 优惠券Codestring
- realPrice: 真实价格,单位分integer

tipsList: 提示信息列表array可选
- orderCouponBalance: 订单券还差金额文字替换string
- deliveryCouponText: 运费券文案string
- orderCouponText: 订单券文案string
- deliveryCouponBalance: 运费券还差金额文字替换string
- text: 提示文案string
- type: 提示类型，1-toast提示text,2不享受员工优惠的商品提示,3主动命中券文案integer
- products: 产品列表array
  - image: 产品图片string
  - price: 产品单价integer
  - name: 产品名称string
  - subTotalPrice: 产品单价小计integer

beCode: BE编码string可选

realProductTotalPrice: 实际餐品价格单位分integer可选

storeCode: 门店编码string可选

POST 提交订单

访问地址: /orders

定义

POST /orders

请求示例

curl -X POST "https://api.open.mcd.cn/orders" \
  -H "accept: application/json" \
  -H "tid: Lorem ipsum " \
  -H "Content-Type: application/json" \

  -d "{\"expectDeliveryTimeCode\":\"Lorem ipsu\",\"orderType\":\"Lorem ipsu\",\"pickupTimeCode\":\"Lorem ipsum dol\",\"laterCouponInfo\":{\"select\":1,\"reqPmtList\":[{\"discountAmount\":1,\"promotionId\":\"Lorem ipsum do\"}],\"list\":[{\"quantity\":95,\"couponId\":\"Lorem ipsum dolo\"}]},\"remark\":\"Lorem ipsum dolo\",\"eatTypeCode\":\"Lorem ipsum dolo\",\"isGroupMeal\":1,\"driveDuration\":26,\"tablewareCode\":\"Lorem ipsum do\",\"tid\":\"Lorem ipsum dolor \",\"addressId\":\"Lorem ipsum d\",\"cashCoupon\":{\"couponName\":\"Lorem ipsum dolor s\",\"iconText\":\"Lorem ipsum dolor \",\"promotionType\":17,\"cardName\":\"Lorem ipsum \",\"cardTypeName\":\"Lorem ipsum dolor s\",\"cardType\":76,\"icon\":\"Lorem ipsum \",\"discountAmount\":\"Lorem ipsum d\",\"couponId\":\"Lorem ipsum dolor s\",\"promotionId\":\"Lorem ipsum \",\"couponPromotionType\":84,\"eligibleItemQuantity\":68,\"showPmtType\":82,\"couponType\":71,\"cardId\":\"Lorem ipsum do\",\"mpCouponType\":20,\"couponCode\":\"Lorem ipsum do\"},\"licensePlate\":\"Lorem ipsum dolor si\",\"realDeliveryPrice\":\"Lorem ipsum dolo\",\"cardId\":\"Lorem ipsum dolor s\",\"beCode\":\"Lorem ipsu\",\"pickupTimeType\":\"Lorem ipsum\",\"realTotalAmount\":\"Lorem ipsum dolor \",\"dayPartCode\":\"Lorem ipsu\",\"cartItems\":[{\"sequence\":86,\"productCode\":\"Lorem ipsum\",\"quantity\":91,\"couponList\":[{\"couponName\":\"Lorem ipsum \",\"iconText\":\"Lorem ipsum dol\",\"promotionType\":40,\"cardName\":\"Lorem ipsum dol\",\"cardTypeName\":\"Lorem ipsum dolor si\",\"cardType\":3,\"icon\":\"Lorem ipsum\",\"discountAmount\":\"Lorem ipsum d\",\"couponId\":\"Lorem ipsum\",\"promotionId\":\"Lorem ipsum dolor s\",\"couponPromotionType\":5,\"eligibleItemQuantity\":11,\"showPmtType\":33,\"couponType\":7,\"cardId\":\"Lorem ipsum do\",\"mpCouponType\":3,\"couponCode\":\"Lorem ipsum dolor si\"}],\"realSubtotal\":\"Lorem ipsum dolor si\",\"uniqueKey\":\"Lorem ipsum dolo\",\"productName\":\"Lorem ipsum dolor s\",\"productType\":\"Lorem ipsum dolo\"}],\"expectDeliveryDateCode\":\"Lorem ipsum dolor s\",\"promotionList\":[{\"couponName\":\"Lorem ipsum dol\",\"iconText\":\"Lorem ipsum dolor\",\"promotionType\":41,\"cardName\":\"Lorem ipsum dol\",\"cardTypeName\":\"Lorem ipsum dolor s\",\"cardType\":95,\"icon\":\"Lorem ipsum dolo\",\"discountAmount\":\"Lorem ipsum do\",\"couponId\":\"Lorem ipsum dolor si\",\"promotionId\":\"Lorem ipsum dolor \",\"couponPromotionType\":38,\"eligibleItemQuantity\":4,\"showPmtType\":29,\"couponType\":39,\"cardId\":\"Lorem ipsum dol\",\"mpCouponType\":73,\"couponCode\":\"Lorem ipsum dolor\"}],\"storeCode\":\"Lorem ipsum dolor\"}"

返回结果示例


{
  "productLimitInfo": [
    {
      "productImage": "Lorem ipsum dolo",
      "limitQuantity": 82,
      "productName": "Lorem ipsum dolor si"
    }
  ],
  "orderId": "Lorem ipsum dolor si",
  "pickupTimeChangeInfo": {
    "pickUpTimeOptions": [
      {
        "itemType": "Lorem ipsum dolor ",
        "code": "Lorem ipsum ",
        "selectText": "Lorem ipsum dolor",
        "text": "Lorem ipsum dolor",
        "needIcon": 1,
        "subText": "Lorem ipsum do",
        "selected": 0
      }
    ],
    "text": "Lorem ipsum"
  },
  "orderStatus": "Lorem ipsum dolo",
  "payId": "Lorem ipsum do",
  "eatTypeCode": "Lorem ipsum dolo"
}

入参说明(在HTTP头部)

名称	描述	数据类型	必填
tid	tid (Only:undefined)	string	否

入参说明(在BODY)

expectDeliveryTimeCode: 期望配送时间string可选

orderType: 订单类型string必须

pickupTimeCode: 取餐时间string可选

laterCouponInfo: LaterCouponInfoRequest_后返券信息-请求体可选
- select: boolean
- reqPmtList: 请求后返券优惠列表array
  - discountAmount: 优惠金额integer
  - promotionId: 促销规则idstring
- list: 后返券列表array
  - quantity: 优惠券数量integer
  - couponId: 优惠券idstring

remark: 备注string可选

eatTypeCode: 就餐类型string可选

isGroupMeal: 团餐标志位 1:是团餐integer可选

driveDuration: 驾车到门店所需时长单位秒integer可选

tablewareCode: 餐具string必须

tid: TIDstring可选

addressId: 配送地址idstring可选

cashCoupon: Coupon_卡券必须M
- couponName: 优惠券namestring必须
- iconText: 小图标文案string可选
- promotionType: 促销大类【单品：(10:单品 20:BOGO) 整单：(30:满减 40:买赠) 运费：(50:运费)】integer必须
- cardName: 权益卡名称string可选
- cardTypeName: 权益卡类型名称string可选
- cardType: 权益卡类型integer可选
- icon: 小图标string可选
- discountAmount: 优惠金额string必须
- couponId: 优惠Idstring必须
- promotionId: 促销Idstring必须
- couponPromotionType: 优惠券促销类型,1商品类、2订单类、3运费类integer必须
- eligibleItemQuantity: 参与促销优惠的数量integer可选
- showPmtType: 促销展示类型，1券，2促销integer可选
- couponType: 优惠券卡类型,0普通券、1员工卡、2权益卡劵integer必须
- cardId: 权益卡idstring可选
- mpCouponType: 中台优惠券类型: 0-非预付券 1-预付券integer必须
- couponCode: 优惠券Codestring必须

licensePlate: 车牌号string可选

realDeliveryPrice: 实付运费,单位元string必须

cardId: 权益卡idstring可选

beCode: 门店beCodestring可选

pickupTimeType: 取餐时间类型 2:表示DT根据用户位置计算出来的取餐时间 1:现在就餐、10分钟、20分钟、30分钟string可选

realTotalAmount: 实付金额,单位元,含餐具费，不含现金券string必须

dayPartCode: 餐时段string必须

cartItems: 商品信息array必须M
- sequence: 序号integer必须
- productCode: 商品codestring必须
- quantity: 数量integer必须
- couponList: 商品券array必须M
  - couponName: 优惠券namestring必须
  - iconText: 小图标文案string可选
  - promotionType: 促销大类【单品：(10:单品 20:BOGO) 整单：(30:满减 40:买赠) 运费：(50:运费)】integer必须
  - cardName: 权益卡名称string可选
  - cardTypeName: 权益卡类型名称string可选
  - cardType: 权益卡类型integer可选
  - icon: 小图标string可选
  - discountAmount: 优惠金额string必须
  - couponId: 优惠Idstring必须
  - promotionId: 促销Idstring必须
  - couponPromotionType: 优惠券促销类型,1商品类、2订单类、3运费类integer必须
  - eligibleItemQuantity: 参与促销优惠的数量integer可选
  - showPmtType: 促销展示类型，1券，2促销integer可选
  - couponType: 优惠券卡类型,0普通券、1员工卡、2权益卡劵integer必须
  - cardId: 权益卡idstring可选
  - mpCouponType: 中台优惠券类型: 0-非预付券 1-预付券integer必须
  - couponCode: 优惠券Codestring必须
- realSubtotal: 实际总金额,单位元string必须
- uniqueKey: 唯一keystring必须
- productName: 商品名称string必须
- productType: 1：单品 2：套餐string必须

expectDeliveryDateCode: 期望配送日期string可选

promotionList: 促销优惠array必须M
- couponName: 优惠券namestring必须
- iconText: 小图标文案string可选
- promotionType: 促销大类【单品：(10:单品 20:BOGO) 整单：(30:满减 40:买赠) 运费：(50:运费)】integer必须
- cardName: 权益卡名称string可选
- cardTypeName: 权益卡类型名称string可选
- cardType: 权益卡类型integer可选
- icon: 小图标string可选
- discountAmount: 优惠金额string必须
- couponId: 优惠Idstring必须
- promotionId: 促销Idstring必须
- couponPromotionType: 优惠券促销类型,1商品类、2订单类、3运费类integer必须
- eligibleItemQuantity: 参与促销优惠的数量integer可选
- showPmtType: 促销展示类型，1券，2促销integer可选
- couponType: 优惠券卡类型,0普通券、1员工卡、2权益卡劵integer必须
- cardId: 权益卡idstring可选
- mpCouponType: 中台优惠券类型: 0-非预付券 1-预付券integer必须
- couponCode: 优惠券Codestring必须

storeCode: 门店Codestring必须

返参说明

productLimitInfo: 产品限制提示信息array必须M
- productImage: 图片string必须
- limitQuantity: 限制数量integer必须
- productName: 商品名称string必须

orderId: 订单idstring必须

pickupTimeChangeInfo: PickupTimeChangeInfo可选
- pickUpTimeOptions: 就餐时间选项array
  - itemType: 就餐时间选项类型 2:表示DT根据用户位置计算出来的取餐时间 1:现在就餐、10分钟、20分钟、30分钟string
  - code: string
  - selectText: string
  - text: string
  - needIcon: boolean
  - subText: string
  - selected: boolean
- text: toast提示信息string

orderStatus: 订单状态string必须

payId: 支付idstring必须

eatTypeCode: 取餐方式string可选

GET 查询订单列表

访问地址: /orders

定义

GET /orders

请求示例

curl -X GET "https://api.open.mcd.cn/orders?orderCategoryId=Loremipsumd&orderStatus=Loremipsumdol&page=Loremipsumdolor&size=Loremipsu" \
  -H "accept: application/json" \
  -H "apiVersion: 1.0" \

返回结果示例


{
  "datetime": "2021-08-04 11:21:40",
  "code": 200,
  "data": {
    "pages": 20,
    "count": 198,
    "list": [
      {
        "orderType": "2",
        "orderId": "1030592420000137576623582922",
        "mpOrderStatusCode": "60",
        "channel": "03",
        "storeInBusiness": true,
        "orderStatus": "已取消",
        "pickupWaitMinute": 0,
        "categoryName": "麦乐送",
        "orderActionList": [

        ],
        "saleTime": "",
        "eatType": 0,
        "storeName": "南京研发中心实验室",
        "orderProductList": [
          {
            "quantity": 1,
            "productName": "巴西莓风味莓果雪冰(大杯)",
            "sequence": 0,
            "productCode": "901192",
            "productImage": "https://menu-img.mcdchina.net/pcm/sit/menu/20200819a0702/product/MS_901192_320.png",
            "subtotal": "19",
            "realSubtotal": "19",
            "comboItemList": [

            ],
            "productType": "1"
          },
          {
            "quantity": 3,
            "productName": "冰香草风味拿铁-大杯",
            "sequence": 0,
            "productCode": "901038",
            "productImage": "https://menu-img.mcdchina.net/pcm/sit/menu/20200819a0702/product/MS_901038_320.png",
            "subtotal": "75",
            "realSubtotal": "45",
            "comboItemList": [

            ],
            "productType": "1"
          }
        ],
        "leftPaySecond": 0,
        "orderTypeName": "麦乐送",
        "beType": "2",
        "createTime": "2021-07-16 19:47:58",
        "pickupWaitOrder": 0,
        "orderStatusCode": "7",
        "realTotalAmount": "73",
        "beCode": "199099902",
        "payId": "11336232513867403264",
        "channelTag": "APP",
        "categoryId": 2,
        "storeCode": "1990999"
      }
    ]
  },
  "success": true,
  "message": "请求成功"
}

入参说明(在HTTP头部)

名称	描述	数据类型	必填
apiVersion	apiVersion (Only:undefined)	string	是

入参说明(在GET)

名称	描述	数据类型	必填
orderCategoryId	0全部订单、1到店取餐、2麦乐送	string	是
orderStatus	订单状态,32订单配送中、33订单配餐中	string	否
page	页数	string	否
size	每页数量	string	否

返参说明

pages: 总页数integer必须

count: 总数integer必须

list: 列表array必须M
- orderType: 订单类型string必须
- orderId: 订单idstring必须
- mpOrderStatusCode: 中台的订单状态codestring必须
- channel: 渠道string必须
- expirePayTime: 期望支付时间string可选
- storeInBusiness: 门店是否在营业中boolean必须
- orderStatus: 订单状态string必须
- pickupWaitMinute: 取餐等待分钟integer可选
- categoryName: 订单类别namestring必须
- rider: 订单骑手信息可选
  - nickName: 骑手昵称string
  - mobileNo: 骑手手机号string
- orderActionList: 订单操作，pay去支付，contact_rider联系骑手，rider_position查看骑手位置，invoice开发票，comment去评价，another_one再来一单，cancel取消订单，refund退款，reminder催单，customer_service联系客服array必须
  - code: string
  - name: string
  - url: string
- lockerCode: 取餐柜码string可选
- saleTime: 售卖时间string可选
- eatType: 到店取餐方式 1=堂食 2=外带 3=得来速 4=取餐柜integer可选
- storeName: 门店名string必须
- orderProductList: 订单商品array必须M
  - quantity: 数量integer必须
  - uniqueKey: 唯一keystring必须
  - productName: 商品名称string必须
  - realPackingFeeTotalPrice: 实际商品打包费总价,单位元string可选
  - sequence: 序号integer必须
  - productCode: 商品codestring必须
  - productImage: 商品图片string必须
  - couponList: 商品券array必须M
    - couponName: 优惠券namestring必须
    - iconText: 小图标文案string可选
    - promotionType: 促销大类【单品：(10:单品 20:BOGO) 整单：(30:满减 40:买赠) 运费：(50:运费)】integer必须
    - cardName: 权益卡名称string可选
    - cardTypeName: 权益卡类型名称string可选
    - cardType: 权益卡类型integer可选
    - icon: 小图标string可选
    - discountAmount: 优惠金额string必须
    - couponId: 优惠Idstring必须
    - promotionId: 促销Idstring必须
    - couponPromotionType: 优惠券促销类型,1商品类、2订单类、3运费类integer必须
    - eligibleItemQuantity: 参与促销优惠的数量integer可选
    - showPmtType: 促销展示类型，1券，2促销integer可选
    - couponType: 优惠券卡类型,0普通券、1员工卡、2权益卡劵integer必须
    - cardId: 权益卡idstring可选
    - mpCouponType: 中台优惠券类型: 0-非预付券 1-预付券integer必须
    - couponCode: 优惠券Codestring必须
  - price: 原价,单位元string必须
  - subtotal: 总价,单位元string必须
  - realSubtotal: 实际总金额,单位元string必须
  - packingFeePrice: 商品打包费单价,单位元string可选
  - comboItemList: 子项列表array必须M
    - quantity: 子项名数量integer必须
    - name: 子项名string必须
  - productType: 1：单品 2：套餐string必须
- leftPaySecond: 剩余支付秒数integer可选
- estimateDeliveryTime: 预计配送时间string可选
- orderStatusTips: 订单状态提示string必须
- riderLocation: 订单骑手位置信息可选
  - riderLng: 骑手经度number
  - storeLat: 门店纬度number
  - riderLat: 骑手纬度number
  - receiverLng: 配送经度number
  - receiverLat: 配送纬度number
  - storeLng: 门店经度number
- beType: beTypestring必须
- orderTypeName: 订单类型名string必须
- createTime: 下单时间string可选
- pickupWaitOrder: 取餐等待订单数integer可选
- orderCancelReasons: 取消原因string可选
- orderStatusCode: 订单状态code，1待支付、2配餐中-已支付、4配送中、6已完成、7已取消、8已评价、10配餐中-餐厅确认配餐中string必须
- beCode: beCodestring必须
- pickupCode: 取餐码string可选
- realTotalAmount: 实际总金额string必须
- payId: 支付单号idstring必须
- channelTag: 渠道标签string可选
- categoryId: 订单类别id，0全部订单、1到店取餐、2麦乐送integer必须
- storeCode: 门店codestring必须

GET 查询订单详情

访问地址: /orders/{orderId}

定义

GET /orders/{orderId}

请求示例

curl -X GET "https://api.open.mcd.cn/orders/Loremipsumdolorsi" \
  -H "accept: application/json" \

返回结果示例


{
  "datetime": "2021-08-04 11:20:17",
  "code": 200,
  "data": {
    "orderType": "1",
    "orderId": "1030425110000137645393389571",
    "mpOrderStatusCode": "10",
    "productTotalPrice": "7",
    "channel": "45",
    "pickupWaitMinute": 0,
    "orderProductList": [
      {
        "quantity": 1,
        "productName": "咸蛋黄鸡丝粥",
        "sequence": 0,
        "productCode": "123456",
        "productImage": "https://menu-img.mcdchina.net/pcm/sit/menu/20200819a0702/product/MS_502451_320.png",
        "price": "7",
        "subtotal": "7",
        "realSubtotal": "7",
        "comboItemList": [

        ],
        "productType": "1"
      }
    ],
    "storeCityCode": "320100",
    "pickupTips": "",
    "totalAmount": "7",
    "storeAddress": "南京研发中心实验室",
    "pickupWaitOrder": 0,
    "couponList": [

    ],
    "beCode": "",
    "payId": "11340069643514695680",
    "storeCode": "123456",
    "realProductTotalPrice": "7",
    "tablewareInfo": "不需要餐具",
    "storeCityName": "南京市",
    "orderStatusTitleType": 0,
    "eatTypeName": "堂食",
    "orderStatus": "待支付",
    "remark": "",
    "categoryName": "到店取餐",
    "orderActionList": [
      {
        "code": "customer_service",
        "name": "联系客服"
      },
      {
        "code": "cancel",
        "name": "取消订单"
      },
      {
        "code": "advise",
        "name": "投诉建议",
        "url": "mcdapp://page?iosPageName=MCDReactNativeViewController&androidPageName=com.mcd.library.rn.McdReactNativeActivity&parameters=%7B%22rctModuleName%22%3A%22suggestDetail%22%2C%22rctModuleParams%22%3A%7B%22orderStoreName%22%3A%22%E5%8D%97%E4%BA%AC%E7%A0%94%E5%8F%91%E4%B8%AD%E5%BF%83%E5%AE%9E%E9%AA%8C%E5%AE%A4%22%2C%22questionId%22%3A0%2C%22question%22%3A%22%E5%88%B0%E5%BA%97%E5%8F%96%E9%A4%90%22%7D%2C%22rctModule%22%3A%22mcduser%22%7D"
      }
    ],
    "saleTime": "",
    "freightCouponList": [

    ],
    "eatType": 1,
    "realDeliveryPrice": "0",
    "customerServicePhone": "4009-200-205",
    "orderStatusTitle": "待支付",
    "storeName": "南京研发中心实验室",
    "deliveryPrice": "0",
    "orderTypeName": "到店取餐",
    "beType": "1",
    "createTime": "2021-07-27 09:55:21",
    "orderStatusCode": "1",
    "pickupCode": "",
    "realTotalAmount": "7",
    "invoice": {
      "code": 1,
      "desc": "订单完成后可开具电子发票\r\n开票金额仅为实付金额，红包、优惠、麦钱包余额、麦当劳礼品卡等支付部分不在开票范围内"
    },
    "channelTag": "微信小程序",
    "paymentTransactionId": "",
    "categoryId": 1
  },
  "success": true,
  "message": "请求成功"
}

入参说明(在PATH)

名称	描述	数据类型	必填
orderId	orderId	string	是

返参说明

traceId: string

datetime: string

code: integer

data: 订单详情响应必须M
- orderType: 订单类型string必须
- paymentChannelLabel: 支付方式名称string可选
- orderId: 订单idstring必须
- mpOrderStatusCode: 中台订单状态codestring必须
- productTotalPrice: 商品价格,单位元string必须
- tablewarePrice: 餐具价格,单位元string必须
- channel: 渠道string必须
- staffCardDiscountAmount: 员工卡优惠金额string可选
- pickupWaitMinute: 取餐等待分钟integer可选
- orderStatusDetail: 订单状态提示语string可选
- realPayAmount: 实际支付金额string可选
- customerServiceUrl: 在线客服地址string可选
- invoiceActionUrl: 开发票链接string可选
- orderProductList: 订单商品array必须M
  - quantity: 数量integer必须
  - uniqueKey: 唯一keystring必须
  - productName: 商品名称string必须
  - realPackingFeeTotalPrice: 实际商品打包费总价,单位元string可选
  - sequence: 序号integer必须
  - productCode: 商品codestring必须
  - productImage: 商品图片string必须
  - couponList: 商品券array必须M
    - couponName: 优惠券namestring必须
    - iconText: 小图标文案string可选
    - promotionType: 促销大类【单品：(10:单品 20:BOGO) 整单：(30:满减 40:买赠) 运费：(50:运费)】integer必须
    - cardName: 权益卡名称string可选
    - cardTypeName: 权益卡类型名称string可选
    - cardType: 权益卡类型integer可选
    - icon: 小图标string可选
    - discountAmount: 优惠金额string必须
    - couponId: 优惠Idstring必须
    - promotionId: 促销Idstring必须
    - couponPromotionType: 优惠券促销类型,1商品类、2订单类、3运费类integer必须
    - eligibleItemQuantity: 参与促销优惠的数量integer可选
    - showPmtType: 促销展示类型，1券，2促销integer可选
    - couponType: 优惠券卡类型,0普通券、1员工卡、2权益卡劵integer必须
    - cardId: 权益卡idstring可选
    - mpCouponType: 中台优惠券类型: 0-非预付券 1-预付券integer必须
    - couponCode: 优惠券Codestring必须
  - price: 原价,单位元string必须
  - subtotal: 总价,单位元string必须
  - realSubtotal: 实际总金额,单位元string必须
  - packingFeePrice: 商品打包费单价,单位元string可选
  - comboItemList: 子项列表array必须M
    - quantity: 子项名数量integer必须
    - name: 子项名string必须
  - productType: 1：单品 2：套餐string必须
- orderProcessNodeHistory: 订单历史状态array可选
  - isCurrent: 是否当前状态integer
  - processNode: 节点code 10=待付款 20=配餐中 31=待取餐 32=配送中 41=已完成 42=已送达 50=已完成 60=已评价 70=已取消string
  - processNodeName: 节点名称string
- totalDiscountAmount: 总优惠金额string可选
- mcCafeCard: ConfirmationMcCafeCardInfo_确认麦咖啡月享卡信息可选
  - discountAmount: 优惠金额string
- storeCityCode: 门店城市codestring可选
- laterCouponInfo: OrderLaterCouponInfo_订单后返券信息可选
  - quantity: 后返券总数量integer
  - discountAmount: 后返券优惠金额，单位元-全部立减才有值否则展示张数string
  - list: 后返券列表array
    - couponName: 优惠券名string
    - quantity: 优惠券数量integer
    - showPmtType: 促销展示类型，1券，2促销integer
    - discountUnit: 优惠额单位，如元、折string
    - discountType: 优惠类型，用于展示:1-特价;2-折扣;3-立减;integer
    - couponId: 优惠券idstring
    - discountValue: 优惠额，直接用于展示string
- paymentChannel: 支付方式string可选
- pickupTips: 取餐提示string可选
- totalAmount: 总金额string可选
- storeAddress: 门店地址string可选
- couponList: 优惠券列表array必须M
  - couponName: 卡券名称string必须
  - showPmtType: 促销展示类型，1券，2促销integer可选
  - cardName: 权益卡名称string可选
  - cardTypeName: 权益卡类型名称string可选
  - cardType: 权益卡类型integer可选
  - discountAmount: 优惠金额string必须
- pickupWaitOrder: 取餐等待订单数integer可选
- orderStatusSubTitle: 订单状态副标题string可选
- beCode: beCodestring必须
- payId: 支付单号idstring必须
- displayOrderId: 对接第三方系统业务IDstring必须
- realProductTotalPrice: 实际商品价格,单位元string必须
- redpack: Redpack_红包入口可选
  - activityCode: 活动idstring
  - backImg: 背景图片string
  - buttonImg: 按钮图片string
  - buttonText: 按钮文案string
  - leftImg: 左边的图片string
  - rightImg: 右边的图片string
  - icon: 图标string
  - text: 文案string
  - alertImg: 弹框的图片string
- storeCode: 门店codestring必须
- tablewareInfo: 餐具需求string可选
- payDiscountAmount: 支付优惠金额如支付宝优惠string可选
- storeCityName: 门店城市namestring可选
- orderStatusTitleType: 订单状态主标题类型，1取餐码、0其它integer可选
- eatTypeName: 就餐方式namestring可选
- orderStatus: 订单状态 1待支付、2配餐中-已支付、4配送中、6已完成、7已取消、8已评价、10配餐中-餐厅确认配餐中string必须
- remark: 订单备注string可选
- categoryName: 订单类别名string必须
- orderActionList: 订单操作，pay去支付，contact_rider联系骑手，rider_position查看骑手位置，invoice开发票，comment去评价，another_one再来一单，cancel取消订单，refund退款，reminder催单，customer_service联系客服array可选
  - code: string
  - name: string
  - url: string
- realPackingFeeTotalPrice: 实际打包费总价,单位元string可选
- saleTime: 售卖时间string可选
- freightCouponList: 运费券列表array必须M
  - couponName: 卡券名称string必须
  - showPmtType: 促销展示类型，1券，2促销integer可选
  - cardName: 权益卡名称string可选
  - cardTypeName: 权益卡类型名称string可选
  - cardType: 权益卡类型integer可选
  - discountAmount: 优惠金额string必须
- customerServicePhone: 客服电话string可选
- eatType: 到店取餐方式 1=堂食 2=外带 3=得来速 4=取餐柜integer可选
- realDeliveryPrice: 实付配送费string可选
- orderStatusTitle: 订单状态主标题string可选
- storeName: 门店名string可选
- cancelReason: 订单取消原因string可选
- leftPaySecond: 剩余支付秒数integer可选
- deliveryInfo: 配送信息可选
  - addressDetail: 配送地址string
  - gender: 收件人称谓string
  - mobilePhone: 收件人手机号string
  - deliveryAddress: 配送地址string
  - customerNickname: 收件人姓名string
  - riderLocation: 订单骑手位置信息
    - riderLng: 骑手经度number
    - storeLat: 门店纬度number
    - riderLat: 骑手纬度number
    - receiverLng: 配送经度number
    - receiverLat: 配送纬度number
    - storeLng: 门店经度number
  - riderMobilePhone: 配送骑士电话string
  - deliveryType: 配送方式 1=预约送出 2=立即送出integer
  - riderNickName: 配送骑士string
  - deliveryTypeLabel: 配送方式label 1=预约送出 2=立即送出string
  - expectDeliveryTime: 预计送达时间年月日时分秒string
- invoiceInfo: 发票信息可选
  - pdfUrl: 发票链接string
  - invoicingTips: 开票中提示string
  - invoiceType: 发票类型名称string
  - status: 发票状态, 0开票中、1已开票string
- expectPickUpTime: 预计到店取餐时间string可选
- deliveryPrice: 配送费string可选
- beType: beTypestring必须
- orderTypeName: 订单类型名string必须
- createTime: 下单时间string可选
- expectDeliveryTimeShort: 预计送达时间短格式14：15string可选
- orderStatusCode: 订单状态codestring必须
- pickupCode: 取餐码string可选
- realTotalAmount: 实际总金额string可选
- invoice: OrderDetailInvoice_订单详情发票信息必须M
  - pdfUrl: 发票pdf链接string可选
  - code: 1默认文案取desc，2已退款取desc，3已取消取desc，4开票中取desc，5去开票取actionUrl，6查看发票integer必须
  - actionUrl: 操作链接string可选
  - invoiceType: 发票类型名称string可选
  - desc: 描述string必须
- channelTag: 渠道标签string可选
- paymentTransactionId: 交易号string可选
- categoryId: 订单类别 1=到店取餐 2=麦乐送integer可选

success: boolean

message: string

PUT 取消订单

访问地址: /orders/{orderId}/cancellation

定义

PUT /orders/{orderId}/cancellation

请求示例

curl -X PUT "https://api.open.mcd.cn/orders/Loremipsumdolo/cancellation" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" \

  -d "{\"cancelReasonCode\":\"Lorem ipsum\",\"cancelRemark\":\"Lorem ipsum dolo\"}"

返回结果示例


{
  "confirmResult": 0
}

入参说明(在PATH)

名称	描述	数据类型	必填
orderId	orderId	string	是

入参说明(在BODY)

cancelReasonCode: 取消原因codestring必须

cancelRemark: 取消备注string可选

返参说明

confirmResult: 确认结果boolean必须