版本 变更时间 作者 描述

1.0

2019-08-09

崔奇

烘焙云开放平台API服务接口

1.1

2019-08-15

崔奇

新增物料分类接口

1.2

2019-08-15

崔奇

token申请接口以及公共参数优化

1.3

2019-09-16

崔奇

基础数据接口新增更新时间字段

1.4

2019-12-12

崔奇

配送单、要货单、采购单增加业务单位、数量以及转换率要货单新增状态(state)字段,配送单现在可以查到被反审的单据新增事件推送日志查询接口

1.5

2020-04-17

崔奇

新增订单分页查询接口,订单支付明细新增支付状态、支付流水号、支付场景、支付时间 新增充值订单查询接口 充值订单新增更新时间字段 订单新增运费字段

2.0

2020-12-22

崔奇

完工接口结构优化 订单接口新增优惠信息

2.1

2021-07-09

崔奇

订单商品明细新增单位和商品类型字段 退货接口返回申请退货原因

2.2

2021-11-19

烘焙云

会员营销接口开放

2.3

2021-11-25

孙家旺

会员余额变动明细接口、会员积分变动明细接口返回增加变动后值属性,增加会员余额变更、会员积分变更、会员成长值变更通知

2.4

2021-12-01

吴全廷

新增:[线下商品详情查询]接口;
变更:原[门店信息]更名为[门店信息列表查询],原[线下商品]更名为[线下商品详情查询]

2.5

2021-12-01

孙家旺

增加会员余额查询、会员积分查询、会员成长值查询、会员挂失、会员解挂、会员注销、会员成长值变动结果查询接口,增加会员状态变更通知,微信会员注册接口登录密码非必填,会员余额变动明细、会员积分变动明细、会员余额变更、会员积分变更、会员成长值变更增加业务编号返回

2.6

2021-12-03

林鑫

1、新增优惠券模板停用接口;优惠券模板创建新增参数:发送数量
2、优惠券模板创建新增参数:发送数量
3、优惠券接口变更:返回券信息添加发放门店编码;券有效期精度位到秒
4、新增[物料信息列表查询]接口; 增加[门店信息变更][物料信息变更]事件通知
5、新增[创建完工单]接口

2.7

2021-12-03

吴全廷

新增[物料信息列表查询]接口;
增加[门店信息变更][物料信息变更]事件通知;

2.8

2021-12-03

吴全廷

更改[门店信息变更]事件描述为[门店完整信息];
更改[物料信息变更]事件描述为[物料完整信息],触发场景更改为[新增和变动物料信息时触发];

2.9

2021-12-08

林鑫

1、增加手机号注册、会员微信信息绑定接口
2、微信会员注册接口:增加微信小程序openId,微信公众号openId非必填
3、微信会员解绑接口:去除微信openId参数
4、会员余额扣减、会员余额充值、会员余额扣减冲正、会员余额充值冲正、会员余额变动结果查询、会员积分变动、会员积分变动结果查询、会员成长值变动、会员成长值变动结果查询接口:增加三方流水号参数
5、会员余额变动明细接口、会员积分变动明细接口、会员余额变更通知、会员积分变更通知、会员成长值变更通知:增加流水号、门店编码返回
6、各接口Content-Type修改,复杂参数为application/json,单一参数为x-www-form-urlencoded

2.10

2021-12-10

林鑫

1、优惠券接口变更:查询券接口从get改为post
2、订单发货接口不再要求必须传入物流信息
3、订单创建接口和查询接口增加生产门店参数

2.11

2021-12-15

吴全廷

1 【物料信息列表查询】接口请求路径更改为:/material/page;
2 【线下商品列表查询】请求路径更改为:/material/goodspage;
3 【线下商品详情查询】请求路径更改为:/material/list/bycodes;
4 以上接口中返回的原物料编码[materialCode]更改[code];

2.12

2021-12-22

林鑫

1、接口返回值统一修改为对象
2、创建券模板添加券号规则

2.13

2021-12-24

吴全廷

1 【门店信息变更】事件通知编码变更为:200030001
2 【物料信息变更】事件通知编码变更为:200040001

2.14

2021-12-28

林鑫

1、提供部分事件通知的通知内容具体结构
2、券模板停用接口暂不开放
3、券消息通知变更:移除券状态变更通知;新增:券发放、券核销、券反核销、券停用、券启用、券转换通知

2.15

2021-12-31

吴全廷

【线下商品详情查询】接口请求参数描述变更为:线下商品编码,用英文逗号隔开,示例:ejR8ml,bkR7nE,ak206dtp

2.16

2021-12-31

林鑫

1、更新事件通知数据结构示例
2、更新接口调用示例,解决示例在部分操作系统调用失败问题
3、更新订单详情查询接口入参
4、会员余额变动结果查询、会员余额变动明细、会员积分变动结果查询、会员积分变动明细、会员成长值变动结果查询、会员列表查询接口Content-Type修改为application/x-www-form-urlencoded;charset=utf-8

2.17

2022-01-06

崔奇

1、删除完工接口
2、更新签名约定
3、更新事件通知响应结果约定
4、新增应用申请邮件模板

2.18

2022-01-12

孙家旺

1、手机号注册、微信会员注册接口登录密码AES加密描述明确
2、会员手机号变更接口入参格式修改
3、会员登录密码变更、会员挂失、会员解挂、会员注销、会员余额充值冲正接口移除
4、手机号注册、微信会员注册接口入参增加来源门店
5、手机号注册、微信会员注册、会员手机号查询基础信息、会员详细信息、会员列表查询接口返回值增加来源门店
6、线下创建会员通知的通知内容增加来源门店

2.19

2022-01-13

吴全廷

【线下商品详情查询】接口请求参数描述变更为:线下商品编码 用英文逗号隔开,编码个数不大于50 示例:ejR8ml,bkR7nE,ak206dtp

2.20

2022-01-20

林鑫

1、接口变更内容:券模板接口新增参数:适用线上门店类型,原适用门店类型改为适用线下门店类型
2、完善订单业务错误码

2.21

2022-01-25

吴全廷

1、 【线下商品列表查询】接口增加请求参数:是否允许销售(allowSales)、状态(status)
2、【线下商品】响应参数:status字段类型更改为int32

2.22

2022-02-11

崔奇

1、新增事件查询接口

2.23

2022-03-21

孙家旺

1、新增手机号合法性验证接口

2.24

2022-03-25

林鑫

1、开放新接口及事件通知

2.25

2022-04-20

孙家旺

1、新增查询三方商品信息、三方商品上架、三方商品下架接口

2.26

2022-04-26

孙家旺

1、新增券模板查询接口
2、会员余额扣减接口增加密码入参

2.27

2022-05-12

孙家旺

1、会员余额查询接口返回增加本金、赠送金
2、会员余额扣减、会员余额充值、会员余额扣减冲正、会员余额充值冲正、会员余额变动结果查询、会员余额变动明细接口返回增加:本金变动数量、本金变动后值、赠送金变动数量、赠送金变动后值
3、增加会员余额扣减(本金赠送金)、会员余额扣减冲正(本金赠送金)、会员密码设置接口
4、会员余额变更通知增加:本金变动数量、本金变动后值、赠送金变动数量、赠送金变动后值

2.28

2022-06-30

吴全廷

新增【创建配送单】接口

2.29

2022-08-16

孙家旺

1、新增三方商品编辑接口
2、三方商品创建接口、查询三方商品信息接口返回信息增加:商品状态、sku状态
3、会员余额充值增加参数:支付方式
4、“线下创建会员”消息通知调整为“烘焙云创建会员”通知

2.30

2022-08-29

吴全廷

【物料信息变更】事件通知增加thirdCode字段,物料编码 code字段增加注释[对应烘焙云物料设置'物料序号'])

2.31

2022-11-07

孙家旺

1、新增微信解绑会员接口
2、微信会员注册unionId占用提示优化

2.32

2022-12-20

吴全廷

1、新增要货单导入ERP、配送单审核出库事件通知
2、新增工厂要货单、配送单按单号查询接口

2.33

2023-01-16

崔奇

物料编码字段新增描述[对应烘焙云物料设置'物料序号'](实际含义不变,仅优化描述)

2.34

2023-01-17

崔奇

新增【门店配送路线查询】【要货单列表查询】接口

2.35

2023-02-02

崔奇

【要货单列表查询】【要货单按单号查询】接口新增要货时间字段

2.36

2023-02-06

崔奇

1、接口细则目录调整(不影响接口)
2、新增【门店退货单列表查询】【门店退货单按单号查询】接口
3、新增【门店完工单列表查询】【门店完工单按单号查询】接口
4、新增【门店盘点单列表查询】【门店盘点单按单号查询】接口
5、新增【门店调拨单按单号查询】【门店调拨单列表查询】接口
6、新增【门店采购单按单号查询】【门店采购单列表查询】接口
7、新增【门店配送单列表查询】接口
8、接口【工厂配送单按单号查询】、【工厂要货单按单号查询】、【工厂要货单列表查询】更名为【门店配送单按单号查询】、【门店要货单按单号查询】、【门店要货单列表查询】
9、门店配送单返回增加【收货时间、收货状态、配送出库时间、取消配送时间、门店确认收货时间】(receiveTime、 receiveStatus、distributionTime、cancelDistributionTime、confirmReceiveTime)字段
10、门店要货单返回增加confirmTime(审核时间)
11、接口【门店要货列表查询】增加参数 供货工厂编码集合(factoryCodeList)、审核日期(confirmDate)

2.37

2023-02-14

吴全廷

1、新增事件【要货单审核通过】
2、新增事件【要货单取消审核】
3、新增事件【要货单导入erp】
4、新增事件【配送单配送出库】
5、新增事件【配送单取消配送】
6、新增事件【配送单确认收货】
7、新增事件【门店采购】
8、新增事件【门店完工】
9、新增事件【门店调拨】
10、新增事件【门店调拨确认收货】
11、新增事件【门店退货】
12、新增事件【门店退货审核】
13、新增事件【门店盘点】
14、配送单返回明细增加relatedCode[关联单号]字段

2.38

2023-02-20

孙家旺

1、新增会员卡余额变动明细查询接口
2、订单查询类接口开放退款状态字段

2.39

2023-02-24

崔奇

1、【门店信息列表查询】接口返回值新增门店管理区域,门店地址(省市区详细地址),经纬度,门店电话等字段
2、新增【门店组列表查询】接口
3、新增【配送路线列表查询】接口
4、新增【线下商品分类列表查询】接口

2.40

2023-03-08

崔奇

【门店配送路线查询】接口重新上线

2.41

2023-03-10

崔奇

【线下商品列表查询】接口新增数据生成时间,可用门店范围字段

2.42

2023-03-13

崔奇

【门店退货单按单号查询】【门店退货单列表查询】新增金额相关字段

2.43

2023-04-03

吴全廷

1 门店退货单返回增加【关联单号】(linkCode)字段
2 商品的【线下商品列表查询】增加查询参数【门店编码】(storeCode),支持门店物料查询
3 门店业务新增【单门店退货单按单号查询】【单门店退货单创建】【单门店退货单创建】【单门店完工单创建】【单门店实时库存按物料序号查询】接口

2.44

2023-04-20

吴全廷

1 线下商品返回增加【可用车间编码】(workshopCodes)字段
2 门店信息增加【价格体系编码】(priceSystemCode)字段
3 商品新增【线下商品价格查询】接口

2.45

2023-04-20

吴全廷

1 线下商品返回增加【完工车间编码】(finishWorkshopCode)字段

2.46

2023-04-25

孙家旺

1、新增三方商品Sku停用接口
2、会员微信信息绑定接口微信unionId占用提示优化
3、订单新增接单和根据单号查询接口

2.47

2023-05-06

姜鹏

事件重推频率调整,单节点推送频率:30s*1/60s*1/5m*2/30m*1/1h*1/2h*1 -总计3h41min30s,推送7次

2.48

2023-05-08

吴全廷

1 新增【退货单审核】接口
2 【线下商品列表查询】增加了返回字段“允许负库存”(allowNegativeInventory)
3 开放【工厂信息列表查询】【仓库信息列表查询】【退货原因列表查询】
4 增加【工厂信息变更】【仓库信息变更】【退货原因变更】事件通知

2.49

2023-05-28

吴全廷

1 【门店信息】增加了返回字段'营业状态'(storeStatus)

2.50

2023-05-30

崔奇

1 新增【要货模板新增/更新/启用/停用】接口
2 新增【门店要货单创建】接口

2.51

2023-07-27

孙家旺

1、新增礼品卡详情、礼品卡核销、礼品卡余额变动明细查询、会员礼品卡查询、会员礼品卡余额扣减、会员礼品卡余额扣减冲正、会员礼品卡余额变动结果查询接口
2、升级三方商品创建、三方商品编辑、查询三方商品信息、三方商品上架、三方商品下架接口,新增门店三方商品下发接口,废除三方商品Sku停用接口

2.52

2023-07-20

王艳明

1 新增【门店盘点接口】
2 新增【门店现金预盘查询接口】
3 新增【券核销信息查询接口】

2.53

2023-08-16

吴全廷

线下商品返回增加【自定义组合完工】(customFinish)字段

2.54

2023-08-21

王艳明

1 新增【门店库存预盘查询接口】

2.55

2023-09-22

孙家旺

1 新增【会员合并】接口、【会员合并】事件通知

2.56

2023-10-03

崔奇

1 新增【线下商品要货信息查询】接口
2 调拨单接口/事件推送新增 (收/发)货门店(销售/出厂)(价格/总金额)字段

2.57

2023-11-13

崔奇

1 新增【线下商品要货信息分页查询】接口

2.58

2023-12-17

崔奇

1 新增【门店要货单删除接口】接口
2 新增【门店要货单按单号查询】接口

2.59

2023-12-25

崔奇

1 新增【单门店调拨单按单号查询】接口
2 新增【单门店调拨单创建】接口

2.60

2023-12-25

崔奇

1 【门店要货单(已审核)列表查询】接口新增要货模板查询字段

2.61

2024-01-16

吴全廷

1【门店采购单按单号查询】【门店采购单列表查询】接口返回值明细增加taxRate(税率)
2事件通知【门店采购上传】(200100301)返加值明细增加taxRate(税率)
3【门店配送单创建】接口增加参数templateCode(要货模板编码)

2.62

2024-01-25

崔奇

所有完工接口支持扣减末级库存的耗用查询

2.63

2024-02-04

崔奇

新增【要货模板列表查询】接口

2.64

2024-03-11

崔奇

新增【单门店其他出入库单按单号查询】【单门店其他出入库单创建】接口

2.65

2024-05-16

吴全廷

接口【门店退货单按单号查询】、接口【门店退货单列表查询】、事件【门店退货审核】(200100602)增加返回字段splitItemList

2.66

2024-05-20

吴全廷

新增【门店要货单审核】接口

2.67

2024-05-20

崔奇

1 新增【要货单新增】(200100151)、【要货单变更】(200100152)、【要货单删除】(200100153)事件
2【要货模板列表查询】接口返回值增加supplyDepartmentCodeList(供货部门编码列表),原有字段supplyDepartmentCode变更含义为默认供货部门编码

2.68

2024-06-13

吴全廷

接口【线下商品列表查询】【线下商品详情查询】、事件通知【物料信息变更】(200040001)【线下商品变更】(200040002) 返回信息增加 defaultSupplierCode(默认供应商编码)、defaultSupplierName(默认供应商名称)两个字段

2.69

2024-06-14

崔奇

【要货模板创建】【要货模板更新】支持传入顺序号

2.70

2024-05-16

吴全廷

接口【门店配送单按单号查询】、接口【门店配送单列表查询】、事件【配送单配送出库】(200100201)增加返回字段costPrice(成本价),costAmount(成本金额)

2.71

2024-06-23

崔奇

【门店调拨单按单号查询】【门店调拨单列表查询】接口中调拨明细新增发货门店成本价,发货门店成本金额,收货门店成本价,收货门店成本金额,业务总金额字段

2.72

2024-06-14

王艳明

新增【券销售】【券销售退单申请】接口;新增【券销售退单审核结果】通知;

2.73

2024-07-05

林鑫

订单业务查询类接口优惠信息中增加券扩展信息

2.74

2024-07-09

王艳明

【券模板创建】接口新增字段:三方编号

1. 概述

本文旨在为第三方合作站点应用访问烘焙云开放平台提供统一的HTTP接口调用与交互规范。

2. 授权流程

申请对接的商户需要以邮件的形式将商户在烘焙云注册的企业全称、应用名称(英文字母8位以内)等相关信息发送至烘焙云邮箱service@hongbeiyun.com, 邮件主题为“三方系统对接烘焙云开放平台+企业全称+应用名称”。邮件正文中需注明企业对接人和接口开发对接人的联系方式、应用简介、接口申请列表(详见 基础数据接口 与 业务数据接口)、事件推送地址。烘焙云工作人员将以电话或邮件的方式审核确认。 审核通过后,烘焙云将以邮件的形式向授权申请邮箱发送秘钥(密钥用作生成签名,参数签名算法)和应用编码。

申请对接商户及第三方接口开发商(下文简称“第三方”)在收到秘钥和应用编码后应妥善保管,切勿对外泄露。由于秘钥和应用编码外泄导致的商户数据泄露,引起的损失和纠纷由申请对接商户承担,烘焙云不承担任何责任

邮件模板

邮件主题

三方系统对接烘焙云开放平台+***商户+***系统

邮件正文

商户在烘焙云注册的企业全称:***烘焙食品有限公司
三方开发商名称:上海**科技有限公司
对接人姓名:***
对接人电话:138***1234
秘钥接收邮箱:***@*mail.com

应用简介:通过程序对接***功能
应用名称(英文字母8位以内):****
申请接口清单:
  1、接口名称:例如:门店信息列表查询、三方商品创建......
  2、事件通知名称及编码:订单下单200110001、......
事件通知推送地址:(如果有申请事件通知的必须填写)
  正式环境:http://***.***.com/**
  测试环境:http://***.***.com/**

3. 接口约定

版本约定

1.添加请求头。

向请求头内添加“version=1.0”,其中1.0为版本号,实际版本号请以具体业务接口版本号为准。

2.版本号控制规则。

接口版本:接入文档中接口标注的版本号,如果没有标注,默认为1.0版本。 版本受控: 当请求的版本不是接口文档中标明的支持版本,请求将失败,HTTP状态为404。

签名约定

1.参数sign生成说明

curl -X GET -k -H 'version:1.0' -i https://iop.hongbeiyun.com/api/factory/query?timestamp=1564623572&pageNo=1&pageSize=100&code=1,2,3&startTime=2019-07-24&endTime=2019-07-25&name=&age=18&token=7b3f43d5de49493198a40dc4b76052f7

step1:构造源串

源串是由请求内容和秘钥通过‘&’拼接而成。秘钥在前,请求内容在后。将除“sign”外的所有参数(含时间戳timestamp,授权令牌token)按key进行字典升序排列,排序后的参数(key=value)用&拼接起来,如body中有json,将body中的json前加&拼接到最后,然后把privateKey拼到最前面

privateKey=639ce6a1514c46539f74cedc8a3064ad&age=18&code=1,2,3&endTime=2019-07-25&pageNo=1&pageSize=100&startTime=2019-07-24&timestamp=1564623572&token=7b3f43d5de49493198a40dc4b76052f7&{"code":"10010"}

注意: 参数中有value为空的需要过滤掉。如本例中”name=”,在拼接时并没有将其拼接到参数串中。

step2:md5加密

将源串用md5进行签名

sign=b1c88e479a0a5e9fa6285568c95ea152

2.响应结果sign生成说明

{"success":true,"code":"200","data":"{"name":"","age":"15"}","message":"响应一级消息","sign":"","timestamp":"1564625700"}

step1:构造源串

(1)将除“sign”外的所有参数按key进行字典升序排列,排序后的参数(key=value)用&拼接起来。key指的是json中一层级的key,如本例中的success、code、data、message、timestamp;其中如果值为空,则不参与拼接

code=200&data={"name":"","age":"15"}&message=响应消息&success=true&timestamp=1564625700

(2)将秘钥(key=value)与(1)的拼接串用‘&’进行拼接

privateKey=639ce6a1514c46539f74cedc8a3064ad&code=200&data={"name":"","age":"15"}&message=响应消息&success=true&timestamp=1564625700

step2:md5加密

将源串用md5进行签名

sign=7c72435a7eb08351fa1ac480e93b7df5

事件通知约定

烘焙云在本节所列数据发生变化时,烘焙云会产生相应的事件提醒。这里有两种推送方式,一种是将数据的所有信息推送;一种是只推送数据的唯一编码,第三方使用唯一编码作为参数,调用烘焙云提供的API接口获取数据

1.推送所有信息

eventData数据格式与对应数据查询接口返回值中data字段下的元素格式相同,例如200110001订单下单 推送数据格式示例:

{"appCode":"ff4169e80f624326b96365afdeefc36b","data":{"eventData":"{\"orderBase\":{\"code\":\"YD2112271324510100061021\",\"state\":3,\"platform\":1,\"channel\":1,\"terminal\":1,\"scene\":2,\"orderType\":2,\"buyerType\":2,\"buyerId\":\"1441721\",\"buyerName\":\"青岛3981\",\"buyerMobile\":\"188****3981\",\"consigneeName\":\"青岛3981\",\"consigneeMobile\":\"18866263981\",\"storeName\":\"西店\",\"storeCode\":\"1021\",\"takeStoreName\":\"西店\",\"takeStoreCode\":\"1021\",\"produceStoreName\":\"西店\",\"produceStoreCode\":\"1021\",\"preOrderTime\":\"2021-12-27 13:24:45\",\"payedTime\":\"2021-12-27 13:25:14\",\"preTakeTime\":\"2021-12-28 11:00:00\",\"totalAmount\":11.11,\"payAmount\":11.10,\"discountAmount\":0.01,\"takeCertNo\":\"3981\",\"operatorName\":\"马玲\"},\"goodsDetails\":[{\"materialCode\":\"0101010004\",\"materialLabel\":\"暖心红豆\",\"isGift\":0,\"num\":1.000,\"originalPrice\":9.00,\"sellsPrice\":9.00,\"totalDiscountAmount\":0.00,\"totalRealAmount\":9.00,\"goodsType\":1},{\"materialCode\":\"0101010008\",\"materialLabel\":\"摩卡面包\",\"isGift\":0,\"num\":1.000,\"originalPrice\":2.11,\"sellsPrice\":2.11,\"totalDiscountAmount\":0.00,\"totalRealAmount\":2.11,\"goodsType\":1}],\"orderDiscounts\":[{\"discountScene\":1,\"discountType\":1,\"discountMode\":8,\"shareType\":1,\"title\":\"舍入\",\"discountAmount\":0.01}],\"orderGifts\":[{\"source\":2,\"type\":2,\"giftType\":5,\"name\":\"成长值\",\"giftNum\":5}],\"orderDistribute\":{\"consigneeType\":1,\"payType\":3,\"preUserName\":\"青岛3981\",\"preUserMobile\":\"18866263981\",\"consigneeName\":\"青岛3981\",\"consigneeMobile\":\"18866263981\",\"consigneeProvinceCode\":\"370000\",\"consigneeProvinceName\":\"山东省\",\"consigneeCityCode\":\"370200\",\"consigneeCityName\":\"青岛市\",\"consigneeAreaCode\":\"370213\",\"consigneeAreaName\":\"李沧区\"},\"settlementFlows\":[{\"storeCode\":\"1021\",\"businessScene\":2,\"payType\":5,\"payTitle\":\"会员卡\",\"buyerId\":1441721,\"amount\":11.10,\"createdTime\":\"2021-12-27 13:25:14\"}]}","eventTypeCode":"200110001"},"sign":"4655cc678256aa84f17abb4f2156401b","timestamp":"1640583240"}

2.推送唯一编码

{"appCode":"ff4169e80f624326b96365afdeefc36b","data":{"eventData":"DB2019072215010001","eventTypeCode":"200110002"},"sign":"4655cc678256aa84f17abb4f2156401b","timestamp":"1640583240"}

3.响应参数

响应参数签名规则见签名约定

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

timestamp

string

时间戳

sign

string

签名

4.注意事项

如果烘焙云收到第三方的应答不是成功或者验签不通过,烘焙云认为推送失败,烘焙云会通过一定的策略定期重新发起通知,尽可能提高通知的成功率,但烘焙云不保证通知最终能成功(单节点推送频率:30s*1/60s*1/5m*2/30m*1/1h*1/2h*1 -总计3h41min30s,推送7次) 注:同样的事件可能会多次推送给第三方系统。第三方系统必须能够正确处理重复的推送。

 事件分页查询

当前版本:  1.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  查询事件列表,支持增量查询,支持分页。

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

startTime

string

开始时间 示例2019-07-22 00:00:00

true

endTime

string

结束时间 示例2019-07-23 00:00:00,与开始时间间隔不得超过24小时,开始时间与结束时间指的都是数据最后更新时间

true

typeCode

string

事件类型编码,与事件列表中编码一致

false

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求示例

curl -X POST -k -H 'version:1.0' -i https://iop.hongbeiyun.com/api/event/listPage --data 'typeCode=33298&pageSize=10&timestamp=1644482403594&token=hq1f3r&pageNo=1&endTime=2022-02-10 16:40:03&sign=dac949dcc78248863dbd9aae3782dc06&startTime=2022-02-10 16:40:03'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

事件分页数据

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─code

string

事件编码

          └─typeCode

string

事件类型编码

          └─occTime

string

业务发生时间

          └─createTime

string

事件创建事件

          └─data

string

事件内容

          └─status

string

状态 -1:发送失败 0:未发送或发送中 1:发送成功或被丢弃

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "code": "33298",
        "typeCode": "33298",
        "occTime": "2022-02-10 16:40:03",
        "createTime": "2022-02-10 16:40:03",
        "data": "b4y5wj",
        "status": "0tdtpd"
      }
    ]
  },
  "timestamp": "1644482403594",
  "sign": "dac949dcc78248863dbd9aae3782dc06"
}

token申请

当前版本:  1.0

请求类型:  GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  申请token接口,token有效时间为2小时,过期需要重新申请

请求头

参数 类型 描述 是否必填

version

string

版本号(Global)

true

请求参数

参数 类型 描述 是否必填

appCode

string

应用编码(32位编码),由烘焙云提供,详见授权流程

true

timestamp

string

第三方发起请求的时间戳,默认超过300s,则请求失效。

true

sign

string

将上述两个参数,严格按照顺序,并拼接秘钥后,采用md5加密生成签名

true

请求示例

curl -X GET -k -H 'version:1.0' -i https://iop.hongbeiyun.com/api/token/apply?timestamp=1564623572&appCode=appid&sign=ae7a5fe40b600537453f64a66f40cdf6

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

timestamp

string

时间戳

data

string

token值

sign

string

签名

响应示例

{
                    "code": "200",
                    "data": "2ff6d1f217ff423388c528be91cf514c",
                    "message": "",
                    "sign": "59bad6c45dd09f028c6825f7bd595a2f",
                    "sub_code": "200",
                    "sub_message": "",
                    "timestamp": "1566267974"
                    }

4. 接口细则

4.1. 门店基础信息

 门店信息列表查询

当前版本:  1.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  查询门店信息,全量查询,支持分页

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求参数

参数 类型 描述 是否必填

type

string

门店类型(1正式、2 测试)

false

manageType

string

门店管理方式(1直营 2加盟)

false

请求示例

curl -X POST -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/storeInfo/listPage' --data 'type=w8aomm&sign=550652140273bc8c95b81f62acff295a&pageSize=10&timestamp=1724981797&token=qknckb&pageNo=1&manageType=ow3znj'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

门店信息分页数据

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─name

string

门店名称

          └─manageType

string

门店管理方式(1直营 2加盟)

          └─type

string

门店级别(1正式 2 测试)

          └─storeTypeCode

string

门店类型编码

          └─storeTypeName

string

门店类型名称

          └─manageAreaCode

string

管理区域编码

          └─manageAreaName

string

管理区域名称

          └─phone

string

门店电话

          └─provinceCode

string

省编码

          └─provinceName

string

省名称

          └─cityCode

string

市编码

          └─cityName

string

市名称

          └─districtCode

string

区编码

          └─districtName

string

区名称

          └─address

string

地址(不含省市区)

          └─longitude

string

经度

          └─latitude

string

纬度

          └─factoryCode

string

工厂编码

          └─storeCode

string

门店编码

          └─priceSystemCode

string

价格体系编码

          └─storeStatus

string

营业状态 1 开业 2 暂停 3闭店

          └─status

string

状态 0:不可用,1:可用

          └─updatedAt

string

数据更新时间

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "name": "ahmad.osinski",
        "manageType": "xvtgrp",
        "type": "axbpgp",
        "storeTypeCode": "68679",
        "storeTypeName": "ahmad.osinski",
        "manageAreaCode": "68679",
        "manageAreaName": "ahmad.osinski",
        "phone": "785-262-5873",
        "provinceCode": "68679",
        "provinceName": "ahmad.osinski",
        "cityCode": "68679",
        "cityName": "ahmad.osinski",
        "districtCode": "68679",
        "districtName": "ahmad.osinski",
        "address": "9555 Wilfred Plains, North Felixmouth, MI 78129",
        "longitude": "8cq84h",
        "latitude": "vb2wx7",
        "factoryCode": "68679",
        "storeCode": "68679",
        "priceSystemCode": "68679",
        "storeStatus": "s135n4",
        "status": "wpe3d9",
        "updatedAt": "entihx"
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 门店配送路线查询

当前版本:  1.0

请求类型:  GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  根据门店编码查询配送路线

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

storeCodeList

array

门店编码,多个用逗号隔开

true

请求示例

curl -X GET -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/storeInfo/listTransport?token=cmbca7&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a&storeCodeList=meenll'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

array

配送路线列表

     └─storeCode

string

门店编码

     └─code

string

配送路线编码

     └─name

string

配送路线名称

     └─mobile

string

配送人手机号

     └─deliverPerson

string

配送人

     └─description

string

配送路线备注

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": [
    {
      "storeCode": "68679",
      "code": "68679",
      "name": "ahmad.osinski",
      "mobile": "1-219-551-0212",
      "deliverPerson": "nwfjva",
      "description": "7txk8l"
    }
  ],
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 门店组列表查询

当前版本:  1.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  查询门店组信息

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求示例

curl -X POST -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/storeGroup/list?token=ja75w4&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

array

门店组信息

     └─code

string

门店组编码

     └─name

string

门店组名称

     └─remark

string

门店组备注

     └─status

int32

状态 0:不可用,1:可用

     └─updatedAt

string

数据更新时间

     └─storeCodeList

array

门店组包含门店编码

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": [
    {
      "code": "68679",
      "name": "ahmad.osinski",
      "remark": "c4h86t",
      "status": 608,
      "updatedAt": "90yg81",
      "storeCodeList": [
        "064rkw"
      ]
    }
  ],
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 要货模板列表查询

当前版本:  1.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  查询要货模板信息,全量查询,支持分页

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求参数

参数 类型 描述 是否必填

supplyType

int32

供货类型:1 工厂供货 2 门店供货

false

status

int32

状态:1 正常 0 停用

false

请求示例

curl -X POST -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/request/template/page' --data 'status=212&supplyType=731&sign=550652140273bc8c95b81f62acff295a&pageSize=10&timestamp=1724981797&token=kjoiz9&pageNo=1'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

要货模板信息分页数据

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─code

string

模板编码

          └─name

string

模板名称

          └─workshopCode

string

要货车间编码

          └─canUseStore

int32

可用门店:1、全部门店 2、自定义门店

          └─canUseStoreCodes

array

可用门店编码

          └─canUseStoreGroupCodes

array

可用门店组编码

          └─deliveryDays

int32

交货天数

          └─requestDateType

int32

可要货日期类型:1、指定周期 2、循环周期

          └─requestWeekDate

array

指定周期可要货日期(1~7分别代表周一~周日)

          └─requestIntervalDate

object

循环周期可要货日期

               └─requestDateStart

string

可要货日期开始

               └─requestDateInterval

int32

可要货日期间隔 1为每天可要货,2为每两天可要货,以此类推

          └─requestTime

string

最晚可要货时间(格式为HH:mm 例如15:30)

          └─isSplit

int32

是否是拆分模板:0 普通模板 1 拆分模板(拆分模板暂时只支持工厂供货)

          └─supplyType

int32

供货类型:1 工厂供货 2 门店供货

          └─supplyDepartmentCode

string

默认供货部门编码(工厂供货对应仓库编码,门店供货对应车间编码)

          └─supplyDepartmentCodeList

array

供货部门编码列表(所有支持的供货部门)

          └─remark

string

备注

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "code": "68679",
        "name": "ahmad.osinski",
        "workshopCode": "68679",
        "canUseStore": 270,
        "canUseStoreCodes": [
          "zqsdz2"
        ],
        "canUseStoreGroupCodes": [
          "ne0yw7"
        ],
        "deliveryDays": 684,
        "requestDateType": 417,
        "requestWeekDate": [
          230
        ],
        "requestIntervalDate": {
          "requestDateStart": "uaefqf",
          "requestDateInterval": 173
        },
        "requestTime": "2024-08-30 09:36:37",
        "isSplit": 974,
        "supplyType": 71,
        "supplyDepartmentCode": "68679",
        "supplyDepartmentCodeList": [
          "4xv720"
        ],
        "remark": "erkux9"
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 要货模板创建

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  创建要货模板

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求参数

Parameter Type Description Required

name

string

模板名称(不可重复)

true

workshopCode

string

要货车间编码

true

canUseStore

int32

可用门店:1、全部门店 2、自定义门店

true

canUseStoreCodes

array

可用门店编码

false

canUseStoreGroupCodes

array

可用门店组编码

false

deliveryDays

int32

交货天数

true

requestDateType

int32

可要货日期类型:1、指定周期 2、循环周期

true

requestWeekDate

array

指定周期可要货日期(1~7分别代表周一~周日)

false

requestIntervalDate

object

循环周期可要货日期

false

└─requestDateStart

string

可要货日期开始

true

└─requestDateInterval

int32

可要货日期间隔 1为每天可要货,2为每两天可要货,以此类推

true

requestTime

string

最晚可要货时间(格式为HH:mm 例如15:30)

false

supplyDepartmentCode

string

供货部门编码(工厂供货对应仓库编码,门店供货对应车间编码)

true

sn

int32

顺序号(最大999,默认999)

false

remark

string

备注

false

itemList

array

要货模板物料明细

true

└─materialCode

string

物料序号

true

└─requestTimes

number

要货倍数(要货单位)

false

└─requestQuantityMax

int32

最大要货量(要货单位)

false

└─requestQuantityMin

int32

最小要货量(要货单位)

false

└─splitItemList

array

要货物料拆分明细

false

     └─materialCode

string

拆分物料序号

true

     └─quantity

number

拆分数量(最小单位)

true

     └─supplyDepartmentCode

string

供货部门编码(门店供货为车间编码,工厂供货为仓库编码)

true

isSplit

int32

是否是拆分模板:0 普通模板 1 拆分模板(拆分模板暂时只支持工厂供货)

true

supplyType

int32

供货类型:1 工厂供货 2 门店供货

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/request/template/create?sign=550652140273bc8c95b81f62acff295a&pageSize=10&timestamp=1724981797&token=yzyq5q&pageNo=1' --data '{
  "name": "ahmad.osinski",
  "workshopCode": "68679",
  "canUseStore": 903,
  "canUseStoreCodes": [
    "c76sbu"
  ],
  "canUseStoreGroupCodes": [
    "w456t2"
  ],
  "deliveryDays": 674,
  "requestDateType": 428,
  "requestWeekDate": [
    491
  ],
  "requestIntervalDate": {
    "requestDateStart": "77qldx",
    "requestDateInterval": 558
  },
  "requestTime": "2024-08-30 09:36:37",
  "supplyDepartmentCode": "68679",
  "sn": 326,
  "remark": "apzeto",
  "itemList": [
    {
      "materialCode": "68679",
      "requestTimes": 269,
      "requestQuantityMax": 715,
      "requestQuantityMin": 913,
      "splitItemList": [
        {
          "materialCode": "68679",
          "quantity": 318,
          "supplyDepartmentCode": "68679"
        }
      ]
    }
  ],
  "isSplit": 890,
  "supplyType": 500
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

要货模板编码

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": "0pbt0u",
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 要货模板更新

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  更新要货模板

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求参数

Parameter Type Description Required

name

string

模板名称(不可重复)

true

workshopCode

string

要货车间编码

true

canUseStore

int32

可用门店:1、全部门店 2、自定义门店

true

canUseStoreCodes

array

可用门店编码

false

canUseStoreGroupCodes

array

可用门店组编码

false

deliveryDays

int32

交货天数

true

requestDateType

int32

可要货日期类型:1、指定周期 2、循环周期

true

requestWeekDate

array

指定周期可要货日期(1~7分别代表周一~周日)

false

requestIntervalDate

object

循环周期可要货日期

false

└─requestDateStart

string

可要货日期开始

true

└─requestDateInterval

int32

可要货日期间隔 1为每天可要货,2为每两天可要货,以此类推

true

requestTime

string

最晚可要货时间(格式为HH:mm 例如15:30)

false

supplyDepartmentCode

string

供货部门编码(工厂供货对应仓库编码,门店供货对应车间编码)

true

sn

int32

顺序号(最大999,默认999)

false

remark

string

备注

false

itemList

array

要货模板物料明细

true

└─materialCode

string

物料序号

true

└─requestTimes

number

要货倍数(要货单位)

false

└─requestQuantityMax

int32

最大要货量(要货单位)

false

└─requestQuantityMin

int32

最小要货量(要货单位)

false

└─splitItemList

array

要货物料拆分明细

false

     └─materialCode

string

拆分物料序号

true

     └─quantity

number

拆分数量(最小单位)

true

     └─supplyDepartmentCode

string

供货部门编码(门店供货为车间编码,工厂供货为仓库编码)

true

code

string

模板编码

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/request/template/update?sign=550652140273bc8c95b81f62acff295a&pageSize=10&timestamp=1724981797&token=y6hyhr&pageNo=1' --data '{
  "name": "ahmad.osinski",
  "workshopCode": "68679",
  "canUseStore": 798,
  "canUseStoreCodes": [
    "6zq0y4"
  ],
  "canUseStoreGroupCodes": [
    "oc57s9"
  ],
  "deliveryDays": 739,
  "requestDateType": 256,
  "requestWeekDate": [
    134
  ],
  "requestIntervalDate": {
    "requestDateStart": "hk7k9s",
    "requestDateInterval": 6
  },
  "requestTime": "2024-08-30 09:36:37",
  "supplyDepartmentCode": "68679",
  "sn": 494,
  "remark": "2o39gj",
  "itemList": [
    {
      "materialCode": "68679",
      "requestTimes": 314,
      "requestQuantityMax": 687,
      "requestQuantityMin": 265,
      "splitItemList": [
        {
          "materialCode": "68679",
          "quantity": 214,
          "supplyDepartmentCode": "68679"
        }
      ]
    }
  ],
  "code": "68679"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

com.bake.iop.model.IopResult

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": "true",
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 要货模板启用

当前版本:  1.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  启用要货模板

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求参数

参数 类型 描述 是否必填

code

string

要货模板编码

true

请求示例

curl -X POST -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/request/template/enable' --data 'sign=550652140273bc8c95b81f62acff295a&pageSize=10&timestamp=1724981797&token=bwr3pw&pageNo=1&code=68679'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

com.bake.iop.model.IopResult

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": "true",
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 要货模板停用

当前版本:  1.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  停用要货模板

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求参数

参数 类型 描述 是否必填

code

string

要货模板编码

true

请求示例

curl -X POST -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/request/template/disable' --data 'code=68679&sign=550652140273bc8c95b81f62acff295a&pageSize=10&timestamp=1724981797&token=rqrpuc&pageNo=1'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

com.bake.iop.model.IopResult

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": "true",
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

4.2. 物流

 配送路线列表查询

当前版本:  1.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  配送路线列表

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求示例

curl -X POST -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/transport/list?token=gsk6ma&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

array

配送路线列表

     └─code

string

配送路线编码

     └─name

string

配送路线名称

     └─mobile

string

配送人手机号

     └─deliverPerson

string

配送人

     └─description

string

配送路线备注

     └─updatedAt

string

数据更新时间

     └─stationList

array

配送站点列表

          └─type

int32

站点类型 1:门店,2:大客户 (其他类型待拓展)

          └─code

string

站点编码

          └─name

string

站点名称

          └─sequence

int32

顺序号

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": [
    {
      "code": "68679",
      "name": "ahmad.osinski",
      "mobile": "1-219-551-0212",
      "deliverPerson": "90ee7c",
      "description": "lrm5ir",
      "updatedAt": "onoxxs",
      "stationList": [
        {
          "type": 308,
          "code": "68679",
          "name": "ahmad.osinski",
          "sequence": 35
        }
      ]
    }
  ],
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

4.3. 门店业务

 门店要货单(已审核)按单号查询

当前版本:  2.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  查询已审核的要货单数据。

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

codes

array

烘焙云要货单号列表,最多可传20条 示例:YH2019072215010001,YH2019072215010002

true

请求示例

curl -X POST -k -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/request/list/bycodes' --data 'sign=550652140273bc8c95b81f62acff295a&codes=f07mn3&timestamp=1724981797&token=ohnd7w'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

array

要货单数据列表

     └─code

string

要货单号

     └─type

int32

要货类型 1:普通要货; 2:订单要货;

     └─importedErp

int32

是否已导入erp 0 未导入 1 已导入

     └─templateCode

string

要货模板编码("0"为订单模板编码,"-1"为强配模板编码)

     └─requestStoreCode

string

要货门店编码

     └─requestStoreName

string

要货门店名称

     └─requestWorkshopCode

string

要货车间编码

     └─requestWorkshopName

string

要货车间名称

     └─suppliyFactoryCode

string

供货工厂编码

     └─suppliyFactoryName

string

供货工厂名称

     └─customerCode

string

客户编码

     └─customerName

string

客户名称

     └─requestTime

string

要货时间

     └─deliveryTime

string

交货时间

     └─confirmTime

string

审核时间

     └─itemList

array

要货明细集合

          └─materialCode

string

物料序号

          └─materialLabel

string

物料名称

          └─auditQuantity

double

审核要货量(最小单位)

          └─minUnit

string

最小单位

          └─requestUnit

string

要货单位

          └─requestConvert

double

要货单位换算率

          └─auditRequestQuantity

double

审核要货量(要货单位)

          └─suppliyWarehouseCode

string

供货仓库编码

          └─suppliyWarehouseName

string

供货仓库名称

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": [
    {
      "code": "68679",
      "type": 526,
      "importedErp": 931,
      "templateCode": "68679",
      "requestStoreCode": "68679",
      "requestStoreName": "ahmad.osinski",
      "requestWorkshopCode": "68679",
      "requestWorkshopName": "ahmad.osinski",
      "suppliyFactoryCode": "68679",
      "suppliyFactoryName": "ahmad.osinski",
      "customerCode": "68679",
      "customerName": "ahmad.osinski",
      "requestTime": "2024-08-30 09:36:37",
      "deliveryTime": "2024-08-30 09:36:37",
      "confirmTime": "2024-08-30 09:36:37",
      "itemList": [
        {
          "materialCode": "68679",
          "materialLabel": "gbccli",
          "auditQuantity": 56.48,
          "minUnit": "9me8yk",
          "requestUnit": "f4t3ep",
          "requestConvert": 31.1,
          "auditRequestQuantity": 51.82,
          "suppliyWarehouseCode": "68679",
          "suppliyWarehouseName": "ahmad.osinski"
        }
      ]
    }
  ],
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 门店要货单(已审核)列表查询

当前版本:  2.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  分页查询已审核的要货单

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求参数

参数 类型 描述 是否必填

type

int32

要货类型 1 普通要货 2 订单要货

false

importedErp

int32

是否已导入erp 0 未导入 1 已导入

false

deliveryDate

string

交货日期(交货日期、要货日期、审核日期至少填一个) 格式(yyyy-MM-dd)

false

requestDate

string

要货日期(交货日期、要货日期、审核日期至少填一个) 格式(yyyy-MM-dd)

false

confirmDate

string

审核日期(交货日期、要货日期、审核日期至少填一个) 格式(yyyy-MM-dd)

false

templateCode

string

要货模板编码("0"为订单模板编码,"-1"为强配模板编码)

false

storeCodeList

array

要货门店编码,多个编码用逗号隔开

false

warehouseCodeList

array

供货仓库编码,多个编码用逗号隔开

false

factoryCodeList

array

供货工厂编码集合 多个用逗号隔开

false

returnAllItem

int32

是否返回全部明细(默认返回全部) 0 仅返回符合条件的明细(例如使用仓库编码当作过滤条件,则仅返回符合仓库条件的明细) 1 返回全部明细

false

请求示例

curl -X POST -k -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/request/page' --data 'deliveryDate=2024-08-30&confirmDate=2024-08-30&sign=550652140273bc8c95b81f62acff295a&pageSize=10&factoryCodeList=b6p7x3&requestDate=2024-08-30&importedErp=205&returnAllItem=401&type=749&warehouseCodeList=pxbbkx&token=it3lpl&timestamp=1724981797&pageNo=1&storeCodeList=4j22td&templateCode=68679'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

要货单数据列表

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─code

string

要货单号

          └─type

int32

要货类型 1:普通要货; 2:订单要货;

          └─importedErp

int32

是否已导入erp 0 未导入 1 已导入

          └─templateCode

string

要货模板编码("0"为订单模板编码,"-1"为强配模板编码)

          └─requestStoreCode

string

要货门店编码

          └─requestStoreName

string

要货门店名称

          └─requestWorkshopCode

string

要货车间编码

          └─requestWorkshopName

string

要货车间名称

          └─suppliyFactoryCode

string

供货工厂编码

          └─suppliyFactoryName

string

供货工厂名称

          └─customerCode

string

客户编码

          └─customerName

string

客户名称

          └─requestTime

string

要货时间

          └─deliveryTime

string

交货时间

          └─confirmTime

string

审核时间

          └─itemList

array

要货明细集合

               └─materialCode

string

物料序号

               └─materialLabel

string

物料名称

               └─auditQuantity

double

审核要货量(最小单位)

               └─minUnit

string

最小单位

               └─requestUnit

string

要货单位

               └─requestConvert

double

要货单位换算率

               └─auditRequestQuantity

double

审核要货量(要货单位)

               └─suppliyWarehouseCode

string

供货仓库编码

               └─suppliyWarehouseName

string

供货仓库名称

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "code": "68679",
        "type": 526,
        "importedErp": 79,
        "templateCode": "68679",
        "requestStoreCode": "68679",
        "requestStoreName": "ahmad.osinski",
        "requestWorkshopCode": "68679",
        "requestWorkshopName": "ahmad.osinski",
        "suppliyFactoryCode": "68679",
        "suppliyFactoryName": "ahmad.osinski",
        "customerCode": "68679",
        "customerName": "ahmad.osinski",
        "requestTime": "2024-08-30 09:36:37",
        "deliveryTime": "2024-08-30 09:36:37",
        "confirmTime": "2024-08-30 09:36:37",
        "itemList": [
          {
            "materialCode": "68679",
            "materialLabel": "54e0gc",
            "auditQuantity": 12.36,
            "minUnit": "ypt98g",
            "requestUnit": "16au1z",
            "requestConvert": 57.4,
            "auditRequestQuantity": 64.2,
            "suppliyWarehouseCode": "68679",
            "suppliyWarehouseName": "ahmad.osinski"
          }
        ]
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 门店要货单审核

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  按单审核,不支持分批审核。审核明细中需要指定所有要货明细物料,不指定则审核量为0.

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

requestCode

string

烘焙云要货单号

true

auditTime

string

审核时间(格式:yyyy-MM-dd HH:mm:ss)

true

productDate

string

生产日期(格式:yyyy-MM-dd)

false

itemList

array

审核明细集合

true

└─materialCode

string

物料序号(相同审核仓库的物料不允许重复)

true

└─auditQuantity

number

最小单位审核数量(非负数,精度到小数点后三位)

true

└─auditWarehouseCode

string

审核仓库编码(指定供货仓库)

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/request/audit?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=miw5c7' --data '{
  "requestCode": "68679",
  "auditTime": "2024-08-30 09:36:37",
  "productDate": "2024-08-30",
  "itemList": [
    {
      "materialCode": "68679",
      "auditQuantity": 155,
      "auditWarehouseCode": "68679"
    }
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

审核结果(true:成功,false:失败)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": "true",
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 门店要货单创建

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  门店要货单创建

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

quoteCode

string

三方单号

true

storeCode

string

要货门店编码

true

supplyType

int32

供货类型:1 工厂供货 2 门店供货

true

supplyOrganizationCode

string

供货组织编码(工厂供货使用工厂编码,门店供货使用门店编码)

true

deliveryDate

string

交货日期

true

templateCode

string

要货模板编码

true

itemList

array

要货明细

true

└─materialCode

string

要货物料序号

true

└─quantity

number

要货数量(最小单位)

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/request/create?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=8vcik9' --data '{
  "quoteCode": "68679",
  "storeCode": "68679",
  "supplyType": 92,
  "supplyOrganizationCode": "68679",
  "deliveryDate": "2024-08-30",
  "templateCode": "68679",
  "itemList": [
    {
      "materialCode": "68679",
      "quantity": 550
    }
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

要货单号

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": "vs6kwt",
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 门店要货单删除

当前版本:  1.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  门店要货单删除

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

code

string

要货单号

false

请求示例

curl -X POST -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/request/delete' --data 'sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=23cs5q&code=68679'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

是否成功

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": "true",
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 门店要货单按单号查询

当前版本:  3.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  门店要货单按单号查询

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

codes

array

烘焙云要货单号列表,最多可传20条 示例:YH2019072215010001,YH2019072215010002

true

请求示例

curl -X POST -k -H 'version:3.0' -i 'https://iop.hongbeiyun.com/api/request/list/bycodes' --data 'codes=gjp52j&sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=m2sf1j'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

array

要货单号

     └─code

string

单号

     └─quoteCode

string

引用单号

     └─type

int32

要货类型 1:普通要货; 2:订单要货;

     └─supplyType

int32

供货类型 1 工厂供货 2 门店供货

     └─requestStoreCode

string

门店id

     └─requestStoreName

string

要货门店名称

     └─requestWorkshopCode

string

门店车间id

     └─requestWorkshopName

string

要货车间

     └─requestTime

string

要货时间

     └─templateCode

string

要货模版编码

     └─templateName

string

模板名称

     └─supplyOrganization

string

供货机构(工厂编码、门店编码)

     └─supplyOrganizationName

string

供货单位名称

     └─supplyDepartment

string

供货部门

     └─supplyDepartmentName

string

供货部门名称

     └─receiveStoreCode

string

收货门店编码

     └─receiveStoreName

string

收货门店名称

     └─receiveWorkshopCode

string

收货车间编码

     └─receiveWorkshopName

string

收货车间名称

     └─salesTotalAmount

number

物料销售价总金额

     └─factoryTotalAmount

number

物料出厂价总金额

     └─remark

string

备注

     └─state

int32

状态,0待审核 1审核通过 2审核驳回 3审核中 4已取消

     └─auditTime

string

审核时间

     └─auditRemark

string

审核备注

     └─deliveryTime

string

交货日期

     └─itemList

array

要货明细

          └─materialCode

string

物料编码

          └─materialLabel

string

物料名称

          └─materialSpec

string

物料规格

          └─requestUnit

string

要货单位

          └─requestConvert

number

要货转换值

          └─requestQuantity

number

要货量

          └─salesTotalAmount

number

销售价总金额

          └─factoryTotalAmount

number

出厂价总金额

          └─minQuantity

number

最小单位要货量

          └─auditQuantity

number

审核量

          └─auditMinQuantity

number

最小单位审核量

          └─auditStatus

int32

审核状态: 0 待审核, 1 审核通过, 2 审核驳回, 3 已取消

          └─cosPrice

number

成本价

          └─exFactoryPrice

number

出厂价

          └─salePrice

number

销售价

          └─requestTimes

number

要货倍数

          └─requestAmountMin

number

最小要货量

          └─requestAmountMax

number

最大要货量

          └─auditTime

string

审核时间

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": [
    {
      "code": "68679",
      "quoteCode": "68679",
      "type": 681,
      "supplyType": 781,
      "requestStoreCode": "68679",
      "requestStoreName": "ahmad.osinski",
      "requestWorkshopCode": "68679",
      "requestWorkshopName": "ahmad.osinski",
      "requestTime": "2024-08-30 09:36:37",
      "templateCode": "68679",
      "templateName": "ahmad.osinski",
      "supplyOrganization": "x4iqsa",
      "supplyOrganizationName": "ahmad.osinski",
      "supplyDepartment": "8azk4i",
      "supplyDepartmentName": "ahmad.osinski",
      "receiveStoreCode": "68679",
      "receiveStoreName": "ahmad.osinski",
      "receiveWorkshopCode": "68679",
      "receiveWorkshopName": "ahmad.osinski",
      "salesTotalAmount": 747,
      "factoryTotalAmount": 735,
      "remark": "62z6ew",
      "state": 2,
      "auditTime": "2024-08-30 09:36:37",
      "auditRemark": "8klkkq",
      "deliveryTime": "2024-08-30 09:36:37",
      "itemList": [
        {
          "materialCode": "68679",
          "materialLabel": "l1uwf5",
          "materialSpec": "eeg55c",
          "requestUnit": "te6os4",
          "requestConvert": 935,
          "requestQuantity": 873,
          "salesTotalAmount": 55,
          "factoryTotalAmount": 902,
          "minQuantity": 875,
          "auditQuantity": 460,
          "auditMinQuantity": 248,
          "auditStatus": 415,
          "cosPrice": 140,
          "exFactoryPrice": 779,
          "salePrice": 938,
          "requestTimes": 98,
          "requestAmountMin": 148,
          "requestAmountMax": 323,
          "auditTime": "2024-08-30 09:36:37"
        }
      ]
    }
  ],
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 门店配送单按单号查询

当前版本:  2.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  根据单号查询审核出库的配送单

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

codes

array

烘焙云配送单号列表,最多可传20条,示例:PSE2019072215010001,PSE2019072215010002

true

请求示例

curl -X POST -k -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/distribution/list/bycodes' --data 'sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=b2slza&codes=h4n4mt'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

array

配送单列表

     └─code

string

配送单号

     └─type

string

1、普通门店配送单(含强配)、2、订单要货配送单

     └─templateCode

string

要货模板编码("0"为订单模板编码,"-1"为强配模板编码,"-2"为退货差异模板编码)

     └─receiveDate

string

收货日期(已过期 建议使用receiveTime)

     └─receiveTime

string

收货时间

     └─storeCode

string

门店编码

     └─storeName

string

门店名称

     └─workshopCode

string

车间编码

     └─workshopName

string

车间名称

     └─factoryCode

string

工厂编码

     └─factoryName

string

工厂名称

     └─warehouseCode

string

仓库编码

     └─warehouseName

string

仓库名称

     └─customerCode

string

客户编码

     └─customerName

string

客户名称

     └─status

int32

配送状态 0:取消配送,1:正常

     └─receiveStatus

int32

收货状态 0:未收货,1:已收货

     └─auditTime

string

审核时间(已过期 建议使用distributionTime)

     └─distributionTime

string

配送出库时间

     └─cancelAuditTime

string

取消审核时间(已过期 建议使用cancelDistributionTime)

     └─cancelDistributionTime

string

取消配送时间

     └─confirmReceiveTime

string

门店确认收货时间

     └─itemList

array

配送明细

          └─materialCode

string

物料序号

          └─materialLabel

string

物料名称

          └─relatedCode

string

关联单号

          └─salePrice

number

销售价

          └─saleAmount

number

销售金额

          └─exFatoryPrice

number

出厂价

          └─exFatoryAmount

number

出厂金额

          └─costPrice

number

成本价

          └─costAmount

number

成本金额

          └─minUnit

string

最小单位

          └─quantity

double

最小单位配送数量

          └─distributionUnit

string

配送单位 (同要货单位)

          └─distributionConvert

double

配送单位换算率 (同要货单位转换率)

          └─distributionQuantity

double

配送单位配送数量

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": [
    {
      "code": "68679",
      "type": "3ungb9",
      "templateCode": "68679",
      "receiveDate": "2024-08-30",
      "receiveTime": "2024-08-30 09:36:37",
      "storeCode": "68679",
      "storeName": "ahmad.osinski",
      "workshopCode": "68679",
      "workshopName": "ahmad.osinski",
      "factoryCode": "68679",
      "factoryName": "ahmad.osinski",
      "warehouseCode": "68679",
      "warehouseName": "ahmad.osinski",
      "customerCode": "68679",
      "customerName": "ahmad.osinski",
      "status": 522,
      "receiveStatus": 495,
      "auditTime": "2024-08-30 09:36:37",
      "distributionTime": "2024-08-30 09:36:37",
      "cancelAuditTime": "2024-08-30 09:36:37",
      "cancelDistributionTime": "2024-08-30 09:36:37",
      "confirmReceiveTime": "2024-08-30 09:36:37",
      "itemList": [
        {
          "materialCode": "68679",
          "materialLabel": "i0z9v4",
          "relatedCode": "68679",
          "salePrice": 196,
          "saleAmount": 893,
          "exFatoryPrice": 505,
          "exFatoryAmount": 7,
          "costPrice": 69,
          "costAmount": 464,
          "minUnit": "7k8rn5",
          "quantity": 4.48,
          "distributionUnit": "8t5prx",
          "distributionConvert": 97.76,
          "distributionQuantity": 71.84
        }
      ]
    }
  ],
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 门店配送单列表查询

当前版本:  2.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  门店分页查询

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求参数

参数 类型 描述 是否必填

type

int32

类型 1、普通门店配送单(含强配)、2、订单要货配送单

false

distributionDate

string

配送出库日期(配送出库日期、收货日期、门店确认日期至少填一个) 格式(yyyy-MM-dd)

false

receiveDate

string

收货日期(配送出库日期、收货日期、门店确认日期至少填一个) 格式(yyyy-MM-dd)

false

confirmReceiveDate

string

门店确认收货日期(配送出库日期、收货日期、门店确认日期至少填一个) 格式(yyyy-MM-dd)

false

storeCodeList

array

收货门店编码集合 多个用逗号隔开

false

warehouseCodeList

array

出货仓库编码集合 多个用逗号隔开

false

factoryCodeList

array

出货工厂编码集合 多个用逗号隔开

false

请求示例

curl -X POST -k -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/distribution/page' --data 'type=900&distributionDate=2024-08-30&warehouseCodeList=bn7vs8&confirmReceiveDate=2024-08-30&storeCodeList=j8z66f&sign=550652140273bc8c95b81f62acff295a&pageSize=10&factoryCodeList=2535v6&timestamp=1724981797&token=pph9e9&pageNo=1&receiveDate=2024-08-30'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

配送单分页数据

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─code

string

配送单号

          └─type

string

1、普通门店配送单(含强配)、2、订单要货配送单

          └─templateCode

string

要货模板编码("0"为订单模板编码,"-1"为强配模板编码,"-2"为退货差异模板编码)

          └─receiveDate

string

收货日期(已过期 建议使用receiveTime)

          └─receiveTime

string

收货时间

          └─storeCode

string

门店编码

          └─storeName

string

门店名称

          └─workshopCode

string

车间编码

          └─workshopName

string

车间名称

          └─factoryCode

string

工厂编码

          └─factoryName

string

工厂名称

          └─warehouseCode

string

仓库编码

          └─warehouseName

string

仓库名称

          └─customerCode

string

客户编码

          └─customerName

string

客户名称

          └─status

int32

配送状态 0:取消配送,1:正常

          └─receiveStatus

int32

收货状态 0:未收货,1:已收货

          └─auditTime

string

审核时间(已过期 建议使用distributionTime)

          └─distributionTime

string

配送出库时间

          └─cancelAuditTime

string

取消审核时间(已过期 建议使用cancelDistributionTime)

          └─cancelDistributionTime

string

取消配送时间

          └─confirmReceiveTime

string

门店确认收货时间

          └─itemList

array

配送明细

               └─materialCode

string

物料序号

               └─materialLabel

string

物料名称

               └─relatedCode

string

关联单号

               └─salePrice

number

销售价

               └─saleAmount

number

销售金额

               └─exFatoryPrice

number

出厂价

               └─exFatoryAmount

number

出厂金额

               └─costPrice

number

成本价

               └─costAmount

number

成本金额

               └─minUnit

string

最小单位

               └─quantity

double

最小单位配送数量

               └─distributionUnit

string

配送单位 (同要货单位)

               └─distributionConvert

double

配送单位换算率 (同要货单位转换率)

               └─distributionQuantity

double

配送单位配送数量

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "code": "68679",
        "type": "qq3qjq",
        "templateCode": "68679",
        "receiveDate": "2024-08-30",
        "receiveTime": "2024-08-30 09:36:37",
        "storeCode": "68679",
        "storeName": "ahmad.osinski",
        "workshopCode": "68679",
        "workshopName": "ahmad.osinski",
        "factoryCode": "68679",
        "factoryName": "ahmad.osinski",
        "warehouseCode": "68679",
        "warehouseName": "ahmad.osinski",
        "customerCode": "68679",
        "customerName": "ahmad.osinski",
        "status": 534,
        "receiveStatus": 318,
        "auditTime": "2024-08-30 09:36:37",
        "distributionTime": "2024-08-30 09:36:37",
        "cancelAuditTime": "2024-08-30 09:36:37",
        "cancelDistributionTime": "2024-08-30 09:36:37",
        "confirmReceiveTime": "2024-08-30 09:36:37",
        "itemList": [
          {
            "materialCode": "68679",
            "materialLabel": "als2rd",
            "relatedCode": "68679",
            "salePrice": 571,
            "saleAmount": 665,
            "exFatoryPrice": 291,
            "exFatoryAmount": 52,
            "costPrice": 263,
            "costAmount": 283,
            "minUnit": "fdo90b",
            "quantity": 32.25,
            "distributionUnit": "wthbko",
            "distributionConvert": 65.74,
            "distributionQuantity": 78.61
          }
        ]
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 门店配送单创建

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  工厂到门店的配送单

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

code

string

业务单号 (业务回查时用,要求唯一)

true

templateCode

string

要货模板编码

false

requestCode

string

烘焙云要货单号

false

remark

string

备注

false

deliveryTime

string

交货时间 (格式:yyyy-MM-dd HH:mm:ss)

true

factoryCode

string

发货工厂编码

true

warehouseCode

string

发货仓库编码

true

storeCode

string

收货门店编码

true

workshopCode

string

收货车间编码

true

itemList

array

配送明细

true

└─materialCode

string

物料序号

true

└─quantity

number

明细数量(最小单位,不为0,精度到小数点后三位)

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/distribution/create?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=8kpzl5' --data '{
  "code": "68679",
  "templateCode": "68679",
  "requestCode": "68679",
  "remark": "5a2alx",
  "deliveryTime": "2024-08-30 09:36:37",
  "factoryCode": "68679",
  "warehouseCode": "68679",
  "storeCode": "68679",
  "workshopCode": "68679",
  "itemList": [
    {
      "materialCode": "68679",
      "quantity": 429
    }
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

配送单号

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": "gddi5o",
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 门店采购单按单号查询

当前版本:  2.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  采购单按单号查询

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

codes

array

烘焙云要货单号列表,最多可传20条 示例:XY2019072215010001,ZC2019072215010002

true

请求示例

curl -X POST -k -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/purchase/list/bycodes' --data 'sign=550652140273bc8c95b81f62acff295a&codes=pzfylt&timestamp=1724981797&token=sijbll'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

array

采购单列表

     └─code

string

采购单号

     └─purchaseTime

string

采购时间

     └─type

string

类型:1.门店自采;2.协议店采

     └─storeCode

string

门店编码

     └─storeName

string

门店名称

     └─workshopCode

string

车间编码

     └─workshopName

string

车间名称

     └─supplierCode

string

供应商编码

     └─supplierName

string

供应商名称

     └─itemList

array

采购明细

          └─materialCode

string

物料序号

          └─materialLabel

string

物料名称

          └─minUnit

string

最小单位

          └─quantity

number

最小单位数量

          └─purchaseUnit

string

采购单位

          └─purchaseConvert

number

采购单位转换率

          └─purchaseQuantity

number

采购单位数量

          └─price

number

采购单位价格

          └─taxRate

number

税率

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": [
    {
      "code": "68679",
      "purchaseTime": "2024-08-30 09:36:37",
      "type": "ve2xsc",
      "storeCode": "68679",
      "storeName": "ahmad.osinski",
      "workshopCode": "68679",
      "workshopName": "ahmad.osinski",
      "supplierCode": "68679",
      "supplierName": "ahmad.osinski",
      "itemList": [
        {
          "materialCode": "68679",
          "materialLabel": "jmvbqe",
          "minUnit": "4swu5k",
          "quantity": 76,
          "purchaseUnit": "5564m1",
          "purchaseConvert": 605,
          "purchaseQuantity": 107,
          "price": 53,
          "taxRate": 365
        }
      ]
    }
  ],
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 门店采购单列表查询

当前版本:  2.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  门店采购单分页查询

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求参数

参数 类型 描述 是否必填

purchaseDate

string

采购日期 格式(yyyy-MM-dd)

true

type

int32

类型:1.门店自采;2.协议店采

false

storeCodeList

array

采购门店编码 多个用逗号隔开

false

请求示例

curl -X POST -k -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/purchase/page' --data 'storeCodeList=2dlkdc&sign=550652140273bc8c95b81f62acff295a&pageSize=10&purchaseDate=2024-08-30&type=746&timestamp=1724981797&token=thbcb9&pageNo=1'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

采购单分页数据

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─code

string

采购单号

          └─purchaseTime

string

采购时间

          └─type

string

类型:1.门店自采;2.协议店采

          └─storeCode

string

门店编码

          └─storeName

string

门店名称

          └─workshopCode

string

车间编码

          └─workshopName

string

车间名称

          └─supplierCode

string

供应商编码

          └─supplierName

string

供应商名称

          └─itemList

array

采购明细

               └─materialCode

string

物料序号

               └─materialLabel

string

物料名称

               └─minUnit

string

最小单位

               └─quantity

number

最小单位数量

               └─purchaseUnit

string

采购单位

               └─purchaseConvert

number

采购单位转换率

               └─purchaseQuantity

number

采购单位数量

               └─price

number

采购单位价格

               └─taxRate

number

税率

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "code": "68679",
        "purchaseTime": "2024-08-30 09:36:37",
        "type": "itpskg",
        "storeCode": "68679",
        "storeName": "ahmad.osinski",
        "workshopCode": "68679",
        "workshopName": "ahmad.osinski",
        "supplierCode": "68679",
        "supplierName": "ahmad.osinski",
        "itemList": [
          {
            "materialCode": "68679",
            "materialLabel": "fc88pf",
            "minUnit": "6unj56",
            "quantity": 91,
            "purchaseUnit": "dmg7mt",
            "purchaseConvert": 751,
            "purchaseQuantity": 944,
            "price": 515,
            "taxRate": 488
          }
        ]
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 门店完工单按单号查询

当前版本:  2.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  完工单按单号查询

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

codes

array

完工单号集合,用英文逗号隔开,最多可传20条

true

请求示例

curl -X POST -k -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/finish/list/bycodes' --data 'codes=yilukh&sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=ltwzu2'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

array

完工单列表

     └─code

string

完工单号

     └─quoteCode

string

第三方单号

     └─finishTime

string

完工时间

     └─handoverTime

string

交接时间

     └─handoverState

int32

交接状态 0 未交接 1 已交接

     └─storeCode

string

门店编码

     └─storeName

string

门店名称

     └─finishWorkshopCode

string

完工车间编码

     └─finishWorkshopName

string

完工车间名称

     └─receiveWorkshopCode

string

接收车间编码

     └─receiveWorkshopName

string

接收车间名称

     └─itemList

array

完工物料明细集合

          └─materialCode

string

物料序号

          └─materialLabel

string

物料名称

          └─finishQuantity

number

完工单位完工数量

          └─quantity

number

最小单位完工数量

          └─finishUnit

string

完工单位

          └─minUnit

string

最小单位

          └─finishConvert

number

完工单位转换率

          └─itemList

array

耗用明细集合

               └─materialCode

string

物料序号

               └─materialLabel

string

物料名称

               └─consumeQuantity

number

耗用单位耗用数量

               └─quantity

number

最小单位耗用数量

               └─consumeUnit

string

耗用单位

               └─minUnit

string

最小单位

               └─consumeConvert

number

耗用单位转换率

               └─itemList

array

No comments found.

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": [
    {
      "code": "68679",
      "quoteCode": "68679",
      "finishTime": "2024-08-30 09:36:37",
      "handoverTime": "2024-08-30 09:36:37",
      "handoverState": 2,
      "storeCode": "68679",
      "storeName": "ahmad.osinski",
      "finishWorkshopCode": "68679",
      "finishWorkshopName": "ahmad.osinski",
      "receiveWorkshopCode": "68679",
      "receiveWorkshopName": "ahmad.osinski",
      "itemList": [
        {
          "materialCode": "68679",
          "materialLabel": "m7lr3z",
          "finishQuantity": 718,
          "quantity": 983,
          "finishUnit": "6n1ktj",
          "minUnit": "lr4zl8",
          "finishConvert": 425,
          "itemList": [
            {
              "materialCode": "68679",
              "materialLabel": "kmkc4i",
              "consumeQuantity": 689,
              "quantity": 816,
              "consumeUnit": "syy11k",
              "minUnit": "tbnwl9",
              "consumeConvert": 980,
              "itemList": [
                {
                  "$ref": ".."
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 门店完工单列表查询

当前版本:  2.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  完工单分页查询

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求参数

参数 类型 描述 是否必填

finishDate

string

完工日期 格式(yyyy-MM-dd)

true

storeCodeList

array

完工门店编码集合 多个用逗号隔开

false

finishWorkshopCodeList

array

完工车间编码集合 多个用逗号隔开

false

receiveWorkshopCodeList

array

完工收货车间编码集合 多个用逗号隔开

false

请求示例

curl -X POST -k -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/finish/page' --data 'finishDate=2024-08-30&sign=550652140273bc8c95b81f62acff295a&pageSize=10&timestamp=1724981797&token=kfqkd4&finishWorkshopCodeList=ppfg8l&storeCodeList=xxcw1c&pageNo=1&receiveWorkshopCodeList=uql7gb'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

完工单分页数据

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─code

string

完工单号

          └─quoteCode

string

第三方单号

          └─finishTime

string

完工时间

          └─handoverTime

string

交接时间

          └─handoverState

int32

交接状态 0 未交接 1 已交接

          └─storeCode

string

门店编码

          └─storeName

string

门店名称

          └─finishWorkshopCode

string

完工车间编码

          └─finishWorkshopName

string

完工车间名称

          └─receiveWorkshopCode

string

接收车间编码

          └─receiveWorkshopName

string

接收车间名称

          └─itemList

array

完工物料明细集合

               └─materialCode

string

物料序号

               └─materialLabel

string

物料名称

               └─finishQuantity

number

完工单位完工数量

               └─quantity

number

最小单位完工数量

               └─finishUnit

string

完工单位

               └─minUnit

string

最小单位

               └─finishConvert

number

完工单位转换率

               └─itemList

array

耗用明细集合

                    └─materialCode

string

物料序号

                    └─materialLabel

string

物料名称

                    └─consumeQuantity

number

耗用单位耗用数量

                    └─quantity

number

最小单位耗用数量

                    └─consumeUnit

string

耗用单位

                    └─minUnit

string

最小单位

                    └─consumeConvert

number

耗用单位转换率

                    └─itemList

array

No comments found.

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "code": "68679",
        "quoteCode": "68679",
        "finishTime": "2024-08-30 09:36:37",
        "handoverTime": "2024-08-30 09:36:37",
        "handoverState": 2,
        "storeCode": "68679",
        "storeName": "ahmad.osinski",
        "finishWorkshopCode": "68679",
        "finishWorkshopName": "ahmad.osinski",
        "receiveWorkshopCode": "68679",
        "receiveWorkshopName": "ahmad.osinski",
        "itemList": [
          {
            "materialCode": "68679",
            "materialLabel": "fzb6c2",
            "finishQuantity": 919,
            "quantity": 9,
            "finishUnit": "7gbatb",
            "minUnit": "9cjdqt",
            "finishConvert": 255,
            "itemList": [
              {
                "materialCode": "68679",
                "materialLabel": "1x6gz0",
                "consumeQuantity": 365,
                "quantity": 851,
                "consumeUnit": "ka8qh8",
                "minUnit": "8mnj3g",
                "consumeConvert": 449,
                "itemList": [
                  {
                    "$ref": ".."
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 单门店完工单按单号查询

当前版本:  2.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  门店POS完工单按单号查询
  本接口需要请求门店POS机,可能会出现网络连接异常。由于门店网络不可控,建议做好请求重试处理。
提示:
    1 当接口请求返回错误码“50101”时,建议间隔5秒后重试(建议重试三次)。
    2 当重试三次后依然返回 “50101”时,需要线下确认门店POS是否已经开机启动烘焙云。

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

storeCode

string

门店编码

true

code

string

完工单号(或第三方单号)

true

请求示例

curl -X POST -k -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/finish/store/get/bycode' --data 'storeCode=68679&code=68679&sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=y97ayw'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

完工单列表

     └─code

string

完工单号

     └─quoteCode

string

第三方单号

     └─finishTime

string

完工时间

     └─handoverTime

string

交接时间

     └─handoverState

int32

交接状态 0 未交接 1 已交接

     └─storeCode

string

门店编码

     └─storeName

string

门店名称

     └─finishWorkshopCode

string

完工车间编码

     └─finishWorkshopName

string

完工车间名称

     └─receiveWorkshopCode

string

接收车间编码

     └─receiveWorkshopName

string

接收车间名称

     └─itemList

array

完工物料明细集合

          └─materialCode

string

物料序号

          └─materialLabel

string

物料名称

          └─finishQuantity

number

完工单位完工数量

          └─quantity

number

最小单位完工数量

          └─finishUnit

string

完工单位

          └─minUnit

string

最小单位

          └─finishConvert

number

完工单位转换率

          └─itemList

array

耗用明细集合

               └─materialCode

string

物料序号

               └─materialLabel

string

物料名称

               └─consumeQuantity

number

耗用单位耗用数量

               └─quantity

number

最小单位耗用数量

               └─consumeUnit

string

耗用单位

               └─minUnit

string

最小单位

               └─consumeConvert

number

耗用单位转换率

               └─itemList

array

No comments found.

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "code": "68679",
    "quoteCode": "68679",
    "finishTime": "2024-08-30 09:36:37",
    "handoverTime": "2024-08-30 09:36:37",
    "handoverState": 2,
    "storeCode": "68679",
    "storeName": "ahmad.osinski",
    "finishWorkshopCode": "68679",
    "finishWorkshopName": "ahmad.osinski",
    "receiveWorkshopCode": "68679",
    "receiveWorkshopName": "ahmad.osinski",
    "itemList": [
      {
        "materialCode": "68679",
        "materialLabel": "ixv6li",
        "finishQuantity": 982,
        "quantity": 728,
        "finishUnit": "n6s4th",
        "minUnit": "h2g2pd",
        "finishConvert": 546,
        "itemList": [
          {
            "materialCode": "68679",
            "materialLabel": "6fqek6",
            "consumeQuantity": 26,
            "quantity": 670,
            "consumeUnit": "gtwo39",
            "minUnit": "cgjfmu",
            "consumeConvert": 339,
            "itemList": [
              {
                "$ref": ".."
              }
            ]
          }
        ]
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 单门店完工单创建

当前版本:  2.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  门店POS完工单创建
  本接口需要请求门店POS机,可能会出现网络连接异常。由于门店网络不可控,建议做好请求重试处理。
提示:
    1 当接口请求返回错误码“50101”时,建议间隔5秒后重试(建议重试三次)。
    2 当重试三次后依然返回 “50101”时,需要线下确认门店POS是否已经开机启动烘焙云。
    3 写入单据结果未知时,可以查询【单门店完工单按单号查询】接口确认

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

quoteCode

string

第三方单号(32位以内)

true

storeCode

string

完工门店编码

true

workshopCode

string

完工车间编码

true

handoverWorkshopCode

string

完工交接车间编码

true

finishTime

string

完工时间

true

finishOperator

string

完工人员

false

itemList

array

完工明细

true

└─materialCode

string

完工物料编码

true

└─quantity

number

最小单位完工数量

true

└─remark

string

备注

false

└─isCustom

boolean

是否自定义完工(自定义完工需要有耗用明细,非自定义完工不需要有耗用明细,会自动按照配方进行耗用, 默认为非自定义完工)

false

└─bomItemList

array

完工耗用明细

false

     └─materialCode

string

耗用物料编码

true

     └─quantity

number

最小单位耗用数量

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/finish/create?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=olkddy' --data '{
  "quoteCode": "68679",
  "storeCode": "68679",
  "workshopCode": "68679",
  "handoverWorkshopCode": "68679",
  "finishTime": "2024-08-30 09:36:37",
  "finishOperator": "m9uniq",
  "itemList": [
    {
      "materialCode": "68679",
      "quantity": 158,
      "remark": "t9q0k5",
      "isCustom": true,
      "bomItemList": [
        {
          "materialCode": "68679",
          "quantity": 294
        }
      ]
    }
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

完工单号

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": "opnkpg",
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 门店拆分完工单按单号查询

当前版本:  2.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  拆分完工单按单号查询

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

codes

array

完工单号集合,用英文逗号隔开,最多可传20条

true

请求示例

curl -X POST -k -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/finish/split/list/bycodes' --data 'sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=od2u0r&codes=jxtdgl'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

array

拆分完工单列表

     └─code

string

完工单号

     └─finishTime

string

完工时间

     └─storeCode

string

门店编码

     └─storeName

string

门店名称

     └─finishWorkshopCode

string

完工车间编码

     └─finishWorkshopName

string

完工车间名称

     └─itemList

array

耗用物料明细集合

          └─materialCode

string

物料序号

          └─materialLabel

string

物料名称

          └─consumeQuantity

number

耗用单位耗用数量

          └─quantity

number

最小单位耗用数量

          └─consumeUnit

string

耗用单位

          └─minUnit

string

最小单位

          └─consumeConvert

number

耗用单位转换率

          └─itemList

array

完工明细集合

               └─materialCode

string

物料序号

               └─materialLabel

string

物料名称

               └─finishQuantity

number

完工单位完工数量

               └─quantity

number

最小单位完工数量

               └─finishUnit

string

完工单位

               └─minUnit

string

最小单位

               └─finishConvert

number

完工单位转换率

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": [
    {
      "code": "68679",
      "finishTime": "2024-08-30 09:36:37",
      "storeCode": "68679",
      "storeName": "ahmad.osinski",
      "finishWorkshopCode": "68679",
      "finishWorkshopName": "ahmad.osinski",
      "itemList": [
        {
          "materialCode": "68679",
          "materialLabel": "u0s4hc",
          "consumeQuantity": 844,
          "quantity": 870,
          "consumeUnit": "b3ye6g",
          "minUnit": "skn0a1",
          "consumeConvert": 421,
          "itemList": [
            {
              "materialCode": "68679",
              "materialLabel": "0srmnj",
              "finishQuantity": 650,
              "quantity": 366,
              "finishUnit": "knphbm",
              "minUnit": "3vkfcl",
              "finishConvert": 218
            }
          ]
        }
      ]
    }
  ],
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 门店拆分完工单列表查询

当前版本:  2.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  完工单分页查询

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求参数

参数 类型 描述 是否必填

finishDate

string

完工日期 格式(yyyy-MM-dd)

true

storeCodeList

array

完工门店编码集合 多个用逗号隔开

false

finishWorkshopCodeList

array

完工车间编码集合 多个用逗号隔开

false

请求示例

curl -X POST -k -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/finish/split/page' --data 'storeCodeList=pon1mk&finishDate=2024-08-30&sign=550652140273bc8c95b81f62acff295a&pageSize=10&timestamp=1724981797&finishWorkshopCodeList=6p3c94&token=yjq3mg&pageNo=1'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

完工单分页数据

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─code

string

完工单号

          └─finishTime

string

完工时间

          └─storeCode

string

门店编码

          └─storeName

string

门店名称

          └─finishWorkshopCode

string

完工车间编码

          └─finishWorkshopName

string

完工车间名称

          └─itemList

array

耗用物料明细集合

               └─materialCode

string

物料序号

               └─materialLabel

string

物料名称

               └─consumeQuantity

number

耗用单位耗用数量

               └─quantity

number

最小单位耗用数量

               └─consumeUnit

string

耗用单位

               └─minUnit

string

最小单位

               └─consumeConvert

number

耗用单位转换率

               └─itemList

array

完工明细集合

                    └─materialCode

string

物料序号

                    └─materialLabel

string

物料名称

                    └─finishQuantity

number

完工单位完工数量

                    └─quantity

number

最小单位完工数量

                    └─finishUnit

string

完工单位

                    └─minUnit

string

最小单位

                    └─finishConvert

number

完工单位转换率

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "code": "68679",
        "finishTime": "2024-08-30 09:36:37",
        "storeCode": "68679",
        "storeName": "ahmad.osinski",
        "finishWorkshopCode": "68679",
        "finishWorkshopName": "ahmad.osinski",
        "itemList": [
          {
            "materialCode": "68679",
            "materialLabel": "f64b23",
            "consumeQuantity": 667,
            "quantity": 6,
            "consumeUnit": "omi1mq",
            "minUnit": "6yq2ba",
            "consumeConvert": 41,
            "itemList": [
              {
                "materialCode": "68679",
                "materialLabel": "sqazb7",
                "finishQuantity": 368,
                "quantity": 523,
                "finishUnit": "b2rww9",
                "minUnit": "9p845t",
                "finishConvert": 488
              }
            ]
          }
        ]
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 门店调拨单按单号查询

当前版本:  2.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  门店调拨单按单号查询

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

codes

array

烘焙云调拨单号列表,最多可传20条 示例:DB2019072215010001,DB2019072215010002

true

请求示例

curl -X POST -k -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/allot/list/bycodes' --data 'sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=4bg3k1&codes=y6tjp6'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

array

调拨单列表

     └─code

string

调拨单号

     └─receiveStatus

int32

收货状态 0:未收货,1:已收货

     └─sendTime

string

发货时间

     └─receiveTime

string

收货时间

     └─sendStoreCode

string

发货门店编码

     └─sendStoreName

string

发货门店名称

     └─sendWorkshopCode

string

发货车间编码

     └─sendWorkshopName

string

发货车间名称

     └─receiveStoreCode

string

收货门店编码

     └─receiveStoreName

string

收货门店名称

     └─receiveWorkshopCode

string

收货车间编码

     └─receiveWorkshopName

string

收货车间名称

     └─itemList

array

调拨物料明细

          └─materialCode

string

物料序号

          └─materialLabel

string

物料名称

          └─allotQuantity

number

调拨单位数量

          └─quantity

number

最小单位数量

          └─allotUnit

string

调拨单位

          └─minUnit

string

最小单位

          └─allotConvert

number

调拨单位转换率

          └─sendSalePrice

number

发货门店销售价

          └─sendSaleAmount

number

发货门店销售金额

          └─sendExFactoryPrice

number

发货门店出厂价

          └─sendExFactoryAmount

number

发货门店出厂金额

          └─sendCosPrice

number

发货门店成本价

          └─sendCosAmount

number

发货门店成本价总金额

          └─receiveSalePrice

number

收货门店销售价

          └─receiveSaleAmount

number

收货门店销售金额

          └─receiveExFactoryPrice

number

收货门店出厂价

          └─receiveExFactoryAmount

number

收货门店出厂金额

          └─receiveCosPrice

number

收货门店成本价

          └─receiveCosAmount

number

收货门店成本价总金额

          └─businessPrice

number

业务总金额

          └─businessPriceConvert

number

业务总金额

          └─businessAmount

number

业务总金额

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": [
    {
      "code": "68679",
      "receiveStatus": 135,
      "sendTime": "2024-08-30 09:36:37",
      "receiveTime": "2024-08-30 09:36:37",
      "sendStoreCode": "68679",
      "sendStoreName": "ahmad.osinski",
      "sendWorkshopCode": "68679",
      "sendWorkshopName": "ahmad.osinski",
      "receiveStoreCode": "68679",
      "receiveStoreName": "ahmad.osinski",
      "receiveWorkshopCode": "68679",
      "receiveWorkshopName": "ahmad.osinski",
      "itemList": [
        {
          "materialCode": "68679",
          "materialLabel": "ngb9ud",
          "allotQuantity": 249,
          "quantity": 8,
          "allotUnit": "pr1xz7",
          "minUnit": "ma17sf",
          "allotConvert": 295,
          "sendSalePrice": 274,
          "sendSaleAmount": 951,
          "sendExFactoryPrice": 642,
          "sendExFactoryAmount": 211,
          "sendCosPrice": 492,
          "sendCosAmount": 148,
          "receiveSalePrice": 749,
          "receiveSaleAmount": 894,
          "receiveExFactoryPrice": 464,
          "receiveExFactoryAmount": 611,
          "receiveCosPrice": 696,
          "receiveCosAmount": 605,
          "businessPrice": 458,
          "businessPriceConvert": 405,
          "businessAmount": 494
        }
      ]
    }
  ],
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 门店调拨单列表查询

当前版本:  2.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  门店调拨单列表查询

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求参数

参数 类型 描述 是否必填

sendDate

string

发货日期(发货日期与收货日期至少填一个) 格式(yyyy-MM-dd)

false

receiveDate

string

收货日期(发货日期与收货日期至少填一个) 格式(yyyy-MM-dd)

false

sendStoreCodeList

array

发货门店编码集合

false

receiveStoreCodeList

array

收货门店编码集合

false

请求示例

curl -X POST -k -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/allot/page' --data 'sendStoreCodeList=63jk7n&receiveStoreCodeList=lsw4ti&receiveDate=2024-08-30&sign=550652140273bc8c95b81f62acff295a&pageSize=10&timestamp=1724981797&token=kanc65&sendDate=2024-08-30&pageNo=1'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

调拨单分页数据

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─code

string

调拨单号

          └─receiveStatus

int32

收货状态 0:未收货,1:已收货

          └─sendTime

string

发货时间

          └─receiveTime

string

收货时间

          └─sendStoreCode

string

发货门店编码

          └─sendStoreName

string

发货门店名称

          └─sendWorkshopCode

string

发货车间编码

          └─sendWorkshopName

string

发货车间名称

          └─receiveStoreCode

string

收货门店编码

          └─receiveStoreName

string

收货门店名称

          └─receiveWorkshopCode

string

收货车间编码

          └─receiveWorkshopName

string

收货车间名称

          └─itemList

array

调拨物料明细

               └─materialCode

string

物料序号

               └─materialLabel

string

物料名称

               └─allotQuantity

number

调拨单位数量

               └─quantity

number

最小单位数量

               └─allotUnit

string

调拨单位

               └─minUnit

string

最小单位

               └─allotConvert

number

调拨单位转换率

               └─sendSalePrice

number

发货门店销售价

               └─sendSaleAmount

number

发货门店销售金额

               └─sendExFactoryPrice

number

发货门店出厂价

               └─sendExFactoryAmount

number

发货门店出厂金额

               └─sendCosPrice

number

发货门店成本价

               └─sendCosAmount

number

发货门店成本价总金额

               └─receiveSalePrice

number

收货门店销售价

               └─receiveSaleAmount

number

收货门店销售金额

               └─receiveExFactoryPrice

number

收货门店出厂价

               └─receiveExFactoryAmount

number

收货门店出厂金额

               └─receiveCosPrice

number

收货门店成本价

               └─receiveCosAmount

number

收货门店成本价总金额

               └─businessPrice

number

业务总金额

               └─businessPriceConvert

number

业务总金额

               └─businessAmount

number

业务总金额

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "code": "68679",
        "receiveStatus": 907,
        "sendTime": "2024-08-30 09:36:37",
        "receiveTime": "2024-08-30 09:36:37",
        "sendStoreCode": "68679",
        "sendStoreName": "ahmad.osinski",
        "sendWorkshopCode": "68679",
        "sendWorkshopName": "ahmad.osinski",
        "receiveStoreCode": "68679",
        "receiveStoreName": "ahmad.osinski",
        "receiveWorkshopCode": "68679",
        "receiveWorkshopName": "ahmad.osinski",
        "itemList": [
          {
            "materialCode": "68679",
            "materialLabel": "q3ez9e",
            "allotQuantity": 283,
            "quantity": 319,
            "allotUnit": "4e25uo",
            "minUnit": "2c1rzy",
            "allotConvert": 710,
            "sendSalePrice": 651,
            "sendSaleAmount": 9,
            "sendExFactoryPrice": 196,
            "sendExFactoryAmount": 59,
            "sendCosPrice": 850,
            "sendCosAmount": 789,
            "receiveSalePrice": 379,
            "receiveSaleAmount": 947,
            "receiveExFactoryPrice": 960,
            "receiveExFactoryAmount": 44,
            "receiveCosPrice": 302,
            "receiveCosAmount": 808,
            "businessPrice": 497,
            "businessPriceConvert": 567,
            "businessAmount": 713
          }
        ]
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 单门店调拨单按单号查询

当前版本:  1.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  门店POS调拨单按单号查询
  本接口需要请求门店POS机,可能会出现网络连接异常。由于门店网络不可控,建议做好请求重试处理。
提示:
    1 当接口请求返回错误码“50101”时,建议间隔5秒后重试(建议重试三次)。
    2 当重试三次后依然返回 “50101”时,需要线下确认门店POS是否已经开机启动烘焙云。

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

storeCode

string

门店编码

true

code

string

调拨单号(或第三方单号)

true

请求示例

curl -X POST -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/allot/store/get/bycode' --data 'sign=550652140273bc8c95b81f62acff295a&storeCode=68679&code=68679&timestamp=1724981797&token=1to0vc'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

调拨单

     └─code

string

调拨单号

     └─receiveStatus

int32

收货状态 0:未收货,1:已收货

     └─sendTime

string

发货时间

     └─receiveTime

string

收货时间

     └─sendStoreCode

string

发货门店编码

     └─sendStoreName

string

发货门店名称

     └─sendWorkshopCode

string

发货车间编码

     └─sendWorkshopName

string

发货车间名称

     └─receiveStoreCode

string

收货门店编码

     └─receiveStoreName

string

收货门店名称

     └─receiveWorkshopCode

string

收货车间编码

     └─receiveWorkshopName

string

收货车间名称

     └─itemList

array

调拨物料明细

          └─materialCode

string

物料序号

          └─materialLabel

string

物料名称

          └─allotQuantity

number

调拨单位数量

          └─quantity

number

最小单位数量

          └─allotUnit

string

调拨单位

          └─minUnit

string

最小单位

          └─allotConvert

number

调拨单位转换率

          └─sendSalePrice

number

发货门店销售价

          └─sendSaleAmount

number

发货门店销售金额

          └─sendExFactoryPrice

number

发货门店出厂价

          └─sendExFactoryAmount

number

发货门店出厂金额

          └─sendCosPrice

number

发货门店成本价

          └─sendCosAmount

number

发货门店成本价总金额

          └─receiveSalePrice

number

收货门店销售价

          └─receiveSaleAmount

number

收货门店销售金额

          └─receiveExFactoryPrice

number

收货门店出厂价

          └─receiveExFactoryAmount

number

收货门店出厂金额

          └─receiveCosPrice

number

收货门店成本价

          └─receiveCosAmount

number

收货门店成本价总金额

          └─businessPrice

number

业务总金额

          └─businessPriceConvert

number

业务总金额

          └─businessAmount

number

业务总金额

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "code": "68679",
    "receiveStatus": 80,
    "sendTime": "2024-08-30 09:36:37",
    "receiveTime": "2024-08-30 09:36:37",
    "sendStoreCode": "68679",
    "sendStoreName": "ahmad.osinski",
    "sendWorkshopCode": "68679",
    "sendWorkshopName": "ahmad.osinski",
    "receiveStoreCode": "68679",
    "receiveStoreName": "ahmad.osinski",
    "receiveWorkshopCode": "68679",
    "receiveWorkshopName": "ahmad.osinski",
    "itemList": [
      {
        "materialCode": "68679",
        "materialLabel": "cjxwi4",
        "allotQuantity": 592,
        "quantity": 770,
        "allotUnit": "kwsshg",
        "minUnit": "i1th5y",
        "allotConvert": 319,
        "sendSalePrice": 727,
        "sendSaleAmount": 403,
        "sendExFactoryPrice": 990,
        "sendExFactoryAmount": 727,
        "sendCosPrice": 868,
        "sendCosAmount": 736,
        "receiveSalePrice": 104,
        "receiveSaleAmount": 350,
        "receiveExFactoryPrice": 564,
        "receiveExFactoryAmount": 164,
        "receiveCosPrice": 478,
        "receiveCosAmount": 752,
        "businessPrice": 931,
        "businessPriceConvert": 20,
        "businessAmount": 954
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 单门店调拨单创建

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  门店POS调拨单创建
  本接口需要请求门店POS机,可能会出现网络连接异常。由于门店网络不可控,建议做好请求重试处理。
提示:
    1 当接口请求返回错误码“50101”时,建议间隔5秒后重试(建议重试三次)。
    2 当重试三次后依然返回 “50101”时,需要线下确认门店POS是否已经开机启动烘焙云。
    3 写入单据结果未知时,可以查询【调拨单按单号查询】接口确认

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

quoteCode

string

第三方单号(32位以内)

true

sendStoreCode

string

发货门店编码

true

sendWorkshopCode

string

发货车间编码

true

receiveStoreCode

string

收货门店编码

true

receiveWorkshopCode

string

收货车间编码

true

remark

string

备注

false

itemList

array

调拨物料明细

true

└─materialCode

string

物料序号

true

└─quantity

number

最小单位数量

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/allot/create?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=mjkesd' --data '{
  "quoteCode": "68679",
  "sendStoreCode": "68679",
  "sendWorkshopCode": "68679",
  "receiveStoreCode": "68679",
  "receiveWorkshopCode": "68679",
  "remark": "xr3b5q",
  "itemList": [
    {
      "materialCode": "68679",
      "quantity": 584
    }
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

调拨单号

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": "t1ait5",
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 门店退货单按单号查询

当前版本:  2.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  门店退货单(门店退货到工厂仓库)按单号查询

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

codes

array

No comments found.

true

请求示例

curl -X POST -k -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/return/list/bycodes' --data 'sign=550652140273bc8c95b81f62acff295a&codes=49sheo&timestamp=1724981797&token=oxbt23'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

array

退货单列表

     └─code

string

退货单号

     └─type

int32

退货单类型 1 普通门店退货 2 大客户退货

     └─storeCode

string

退货门店编码

     └─storeName

string

退货门店名称

     └─customerCode

string

退货客户编码

     └─customerName

string

退货客户名称

     └─returnTime

string

退货时间

     └─linkCode

string

关联单号

     └─itemList

array

退货明细

          └─factoryCode

string

退回工厂编码

          └─factoryName

string

退回工厂名称

          └─warehouseCode

string

退回仓库编码

          └─warehouseName

string

退回仓库名称

          └─auditFactoryCode

string

审核退回工厂编码

          └─auditFactoryName

string

审核退回工厂名称

          └─auditWarehouseCode

string

审核退回仓库编码

          └─auditWarehouseName

string

审核退回仓库名称

          └─receiveTime

string

审核时间

          └─returnReasonCode

string

退货原因编码

          └─returnReason

string

退货原因

          └─auditReasonCode

string

审核退货原因编码

          └─auditReason

string

审核退货原因

          └─workshopCode

string

车间编码

          └─workshopName

string

车间名称

          └─materialCode

string

物料编码

          └─materialLabel

string

物料名称

          └─returnQuantity

number

退货单位退货量

          └─returnMinQuantity

number

最小单位退货量

          └─auditQuantity

number

退货单位审核量

          └─auditMinQuantity

number

最小单位审核量

          └─returnUnit

string

退货单位

          └─minUnit

string

最小单位

          └─returnConvert

number

退货单位转换率

          └─salePrice

number

销售价

          └─saleAmount

number

销售金额

          └─auditSaleAmount

number

审核销售金额

          └─exFactoryPrice

number

出厂价

          └─exFactoryAmount

number

出厂金额

          └─auditExFactoryAmount

number

审核出厂金额

          └─requestConvert

number

要货单位转换率

          └─splitItemList

array

拆分明细集合(数据结构与itemList相同)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": [
    {
      "code": "68679",
      "type": 229,
      "storeCode": "68679",
      "storeName": "ahmad.osinski",
      "customerCode": "68679",
      "customerName": "ahmad.osinski",
      "returnTime": "2024-08-30 09:36:37",
      "linkCode": "68679",
      "itemList": [
        {
          "factoryCode": "68679",
          "factoryName": "ahmad.osinski",
          "warehouseCode": "68679",
          "warehouseName": "ahmad.osinski",
          "auditFactoryCode": "68679",
          "auditFactoryName": "ahmad.osinski",
          "auditWarehouseCode": "68679",
          "auditWarehouseName": "ahmad.osinski",
          "receiveTime": "2024-08-30 09:36:37",
          "returnReasonCode": "68679",
          "returnReason": "222f17",
          "auditReasonCode": "68679",
          "auditReason": "ob11m6",
          "workshopCode": "68679",
          "workshopName": "ahmad.osinski",
          "materialCode": "68679",
          "materialLabel": "s5qt16",
          "returnQuantity": 213,
          "returnMinQuantity": 133,
          "auditQuantity": 11,
          "auditMinQuantity": 521,
          "returnUnit": "fg3tju",
          "minUnit": "59ce6r",
          "returnConvert": 857,
          "salePrice": 97,
          "saleAmount": 753,
          "auditSaleAmount": 259,
          "exFactoryPrice": 840,
          "exFactoryAmount": 411,
          "auditExFactoryAmount": 225,
          "requestConvert": 185,
          "splitItemList": [
            {
              "$ref": ".."
            }
          ]
        }
      ]
    }
  ],
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 门店退货单列表查询

当前版本:  2.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  门店退货单(门店退货到工厂仓库)分页查询

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求参数

参数 类型 描述 是否必填

type

int32

退货单类型 1 普通门店退货 2 大客户退货

false

returnDate

string

退货日期(审核日期与退货日期至少填一个) 格式(yyyy-MM-dd)

false

receiveDate

string

审核日期(审核日期与退货日期至少填一个) 格式(yyyy-MM-dd)

false

storeCodeList

array

退货门店编码集合 多个用逗号隔开

false

warehouseCodeList

array

退回仓库编码集合 多个用逗号隔开

false

factoryCodeList

array

退回工厂编码集合 多个用逗号隔开

false

returnReasonCodeList

array

门店退货原因编码集合 多个用逗号隔开

false

auditReasonCodeList

array

审核退货原因编码集合 多个用逗号隔开

false

returnAllItem

int32

是否返回全部明细(默认返回全部) 0 仅返回符合条件的明细(例如使用审核日期/退货工厂/退货仓库/门店退货原因/审核退货原因当作过滤条件,则仅返回符合条件的明细) 1 返回全部明细

false

请求示例

curl -X POST -k -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/return/page' --data 'warehouseCodeList=6ck8ow&returnDate=2024-08-30&type=714&storeCodeList=xyli7s&returnReasonCodeList=wogfgg&factoryCodeList=4bbcbj&receiveDate=2024-08-30&returnAllItem=690&sign=550652140273bc8c95b81f62acff295a&auditReasonCodeList=vjlvp9&pageSize=10&timestamp=1724981797&token=nrpkxr&pageNo=1'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

退货单分页数据

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─code

string

退货单号

          └─type

int32

退货单类型 1 普通门店退货 2 大客户退货

          └─storeCode

string

退货门店编码

          └─storeName

string

退货门店名称

          └─customerCode

string

退货客户编码

          └─customerName

string

退货客户名称

          └─returnTime

string

退货时间

          └─linkCode

string

关联单号

          └─itemList

array

退货明细

               └─factoryCode

string

退回工厂编码

               └─factoryName

string

退回工厂名称

               └─warehouseCode

string

退回仓库编码

               └─warehouseName

string

退回仓库名称

               └─auditFactoryCode

string

审核退回工厂编码

               └─auditFactoryName

string

审核退回工厂名称

               └─auditWarehouseCode

string

审核退回仓库编码

               └─auditWarehouseName

string

审核退回仓库名称

               └─receiveTime

string

审核时间

               └─returnReasonCode

string

退货原因编码

               └─returnReason

string

退货原因

               └─auditReasonCode

string

审核退货原因编码

               └─auditReason

string

审核退货原因

               └─workshopCode

string

车间编码

               └─workshopName

string

车间名称

               └─materialCode

string

物料编码

               └─materialLabel

string

物料名称

               └─returnQuantity

number

退货单位退货量

               └─returnMinQuantity

number

最小单位退货量

               └─auditQuantity

number

退货单位审核量

               └─auditMinQuantity

number

最小单位审核量

               └─returnUnit

string

退货单位

               └─minUnit

string

最小单位

               └─returnConvert

number

退货单位转换率

               └─salePrice

number

销售价

               └─saleAmount

number

销售金额

               └─auditSaleAmount

number

审核销售金额

               └─exFactoryPrice

number

出厂价

               └─exFactoryAmount

number

出厂金额

               └─auditExFactoryAmount

number

审核出厂金额

               └─requestConvert

number

要货单位转换率

               └─splitItemList

array

拆分明细集合(数据结构与itemList相同)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "code": "68679",
        "type": 744,
        "storeCode": "68679",
        "storeName": "ahmad.osinski",
        "customerCode": "68679",
        "customerName": "ahmad.osinski",
        "returnTime": "2024-08-30 09:36:37",
        "linkCode": "68679",
        "itemList": [
          {
            "factoryCode": "68679",
            "factoryName": "ahmad.osinski",
            "warehouseCode": "68679",
            "warehouseName": "ahmad.osinski",
            "auditFactoryCode": "68679",
            "auditFactoryName": "ahmad.osinski",
            "auditWarehouseCode": "68679",
            "auditWarehouseName": "ahmad.osinski",
            "receiveTime": "2024-08-30 09:36:37",
            "returnReasonCode": "68679",
            "returnReason": "80a2g9",
            "auditReasonCode": "68679",
            "auditReason": "js6fnw",
            "workshopCode": "68679",
            "workshopName": "ahmad.osinski",
            "materialCode": "68679",
            "materialLabel": "4wi27p",
            "returnQuantity": 992,
            "returnMinQuantity": 182,
            "auditQuantity": 853,
            "auditMinQuantity": 241,
            "returnUnit": "r8ck3h",
            "minUnit": "rh9l6d",
            "returnConvert": 394,
            "salePrice": 922,
            "saleAmount": 379,
            "auditSaleAmount": 650,
            "exFactoryPrice": 682,
            "exFactoryAmount": 801,
            "auditExFactoryAmount": 74,
            "requestConvert": 939,
            "splitItemList": [
              {
                "$ref": ".."
              }
            ]
          }
        ]
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 单门店退货单按单号查询

当前版本:  1.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  查询门店POS机上的退货单据信息
  本接口需要请求门店POS机,可能会出现网络连接异常。由于门店网络不可控,建议做好请求重试处理。
提示:
    1 当接口请求返回错误码“50101”时,建议间隔5秒后重试(建议重试三次)。
    2 当重试三次后依然返回 “50101”时,需要线下确认门店POS是否已经开机启动烘焙云。

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

storeCode

string

门店编码

false

code

string

退货单号(或第三方单号)

true

请求示例

curl -X POST -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/return/store/get/bycode' --data 'storeCode=68679&code=68679&sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=rpmecu'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

门店POS机上的退货单

     └─code

string

退货单号

     └─type

int32

退货单类型 1 普通门店退货 2 大客户退货

     └─storeCode

string

退货门店编码

     └─storeName

string

退货门店名称

     └─customerCode

string

退货客户编码

     └─customerName

string

退货客户名称

     └─returnTime

string

退货时间

     └─linkCode

string

关联单号

     └─itemList

array

退货明细

          └─factoryCode

string

退回工厂编码

          └─factoryName

string

退回工厂名称

          └─warehouseCode

string

退回仓库编码

          └─warehouseName

string

退回仓库名称

          └─auditFactoryCode

string

审核退回工厂编码

          └─auditFactoryName

string

审核退回工厂名称

          └─auditWarehouseCode

string

审核退回仓库编码

          └─auditWarehouseName

string

审核退回仓库名称

          └─receiveTime

string

审核时间

          └─returnReasonCode

string

退货原因编码

          └─returnReason

string

退货原因

          └─auditReasonCode

string

审核退货原因编码

          └─auditReason

string

审核退货原因

          └─workshopCode

string

车间编码

          └─workshopName

string

车间名称

          └─materialCode

string

物料编码

          └─materialLabel

string

物料名称

          └─returnQuantity

number

退货单位退货量

          └─returnMinQuantity

number

最小单位退货量

          └─auditQuantity

number

退货单位审核量

          └─auditMinQuantity

number

最小单位审核量

          └─returnUnit

string

退货单位

          └─minUnit

string

最小单位

          └─returnConvert

number

退货单位转换率

          └─salePrice

number

销售价

          └─saleAmount

number

销售金额

          └─auditSaleAmount

number

审核销售金额

          └─exFactoryPrice

number

出厂价

          └─exFactoryAmount

number

出厂金额

          └─auditExFactoryAmount

number

审核出厂金额

          └─requestConvert

number

要货单位转换率

          └─splitItemList

array

拆分明细集合(数据结构与itemList相同)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "code": "68679",
    "type": 650,
    "storeCode": "68679",
    "storeName": "ahmad.osinski",
    "customerCode": "68679",
    "customerName": "ahmad.osinski",
    "returnTime": "2024-08-30 09:36:37",
    "linkCode": "68679",
    "itemList": [
      {
        "factoryCode": "68679",
        "factoryName": "ahmad.osinski",
        "warehouseCode": "68679",
        "warehouseName": "ahmad.osinski",
        "auditFactoryCode": "68679",
        "auditFactoryName": "ahmad.osinski",
        "auditWarehouseCode": "68679",
        "auditWarehouseName": "ahmad.osinski",
        "receiveTime": "2024-08-30 09:36:37",
        "returnReasonCode": "68679",
        "returnReason": "g584by",
        "auditReasonCode": "68679",
        "auditReason": "qeaoon",
        "workshopCode": "68679",
        "workshopName": "ahmad.osinski",
        "materialCode": "68679",
        "materialLabel": "dwmnzz",
        "returnQuantity": 737,
        "returnMinQuantity": 430,
        "auditQuantity": 295,
        "auditMinQuantity": 81,
        "returnUnit": "qb9f7f",
        "minUnit": "o50rbt",
        "returnConvert": 292,
        "salePrice": 135,
        "saleAmount": 356,
        "auditSaleAmount": 696,
        "exFactoryPrice": 153,
        "exFactoryAmount": 984,
        "auditExFactoryAmount": 756,
        "requestConvert": 755,
        "splitItemList": [
          {
            "$ref": ".."
          }
        ]
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 单门店退货单创建

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  单门店退货单创建接口
  本接口需要请求门店POS机,可能会出现网络连接异常。由于门店网络不可控,建议做好请求重试处理。
提示:
    1 当接口请求返回错误码“50101”时,建议间隔5秒后重试(建议重试三次)。
    2 当重试三次后依然返回 “50101”时,需要线下确认门店POS是否已经开机启动烘焙云。
    3 写入单据结果未知时,可以查询【单门店退货单按单号查询】接口确认

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

quoteCode

string

第三方单号(32位以内,要求唯一)

true

storeCode

string

退货门店编码

true

returnDate

string

退货时间 (格式:yyyy-MM-dd HH:mm:ss)

true

remark

string

备注

false

itemList

array

退货明细

true

└─returnFactoryCode

string

退回工厂编码

true

└─returnWarehouseCode

string

退回仓库编码

true

└─workshopCode

string

退货车间编码

true

└─returnReasonCode

string

退货原因编码

true

└─materialCode

string

物料序号

true

└─quantity

number

最小单位退货数量(正数,精度到小数点后三位)

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/return/create?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=tqv8ct' --data '{
  "quoteCode": "68679",
  "storeCode": "68679",
  "returnDate": "2024-08-30",
  "remark": "7e1dfo",
  "itemList": [
    {
      "returnFactoryCode": "68679",
      "returnWarehouseCode": "68679",
      "workshopCode": "68679",
      "returnReasonCode": "68679",
      "materialCode": "68679",
      "quantity": 490
    }
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

烘焙云退货单号

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": "mbbgp4",
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 退货单审核接口

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  支持分批审核,但相同的退货明细,不能多次审核。

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

returnCode

string

烘焙云退货单号

true

auditTime

string

审核时间(格式:yyyy-MM-dd HH:mm:ss)

true

itemList

array

审核明细集合

true

└─workshopCode

string

退货车间编码

true

└─returnReasonCode

string

退货原因编码

true

└─returnFactoryCode

string

退回工厂编码

true

└─returnWarehouseCode

string

退回仓库编码

true

└─materialCode

string

物料序号(相同车间的物料不允许重复)

true

└─auditFactoryCode

string

审核工厂编码

true

└─auditWarehouseCode

string

审核仓库编码

true

└─auditQuantity

number

最小单位审核退货数量(非负数,精度到小数点后三位)

true

└─auditReturnReasonCode

string

审核退货原因编码

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/return/audit?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=y31zkk' --data '{
  "returnCode": "68679",
  "auditTime": "2024-08-30 09:36:37",
  "itemList": [
    {
      "workshopCode": "68679",
      "returnReasonCode": "68679",
      "returnFactoryCode": "68679",
      "returnWarehouseCode": "68679",
      "materialCode": "68679",
      "auditFactoryCode": "68679",
      "auditWarehouseCode": "68679",
      "auditQuantity": 655,
      "auditReturnReasonCode": "68679"
    }
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

审核结果(true:成功,false:失败)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": "true",
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 门店盘点单按单号查询

当前版本:  2.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  盘点单按单号查询

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

codes

array

No comments found.

true

请求示例

curl -X POST -k -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/inventory/list/bycodes' --data 'sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=43jlje&codes=bh2cbt'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

array

盘点单列表

     └─code

string

盘点单号

     └─storeCode

string

门店编码

     └─storeName

string

门店名称

     └─inventoryDate

string

盘点日期

     └─inventoryTimes

int32

盘点批次

     └─itemList

array

物料编码

          └─workshopCode

string

车间编码

          └─workshopName

string

车间名称

          └─materialCode

string

物料编码

          └─materialLabel

string

物料名称

          └─accountStock

number

账存

          └─actualStock

number

实存

          └─difference

number

差异

          └─unit

string

单位(最小单位)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": [
    {
      "code": "68679",
      "storeCode": "68679",
      "storeName": "ahmad.osinski",
      "inventoryDate": "2024-08-30",
      "inventoryTimes": 836,
      "itemList": [
        {
          "workshopCode": "68679",
          "workshopName": "ahmad.osinski",
          "materialCode": "68679",
          "materialLabel": "49rdzb",
          "accountStock": 402,
          "actualStock": 41,
          "difference": 375,
          "unit": "660zsm"
        }
      ]
    }
  ],
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 门店盘点单列表查询

当前版本:  2.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  盘点数据分页查询

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求参数

参数 类型 描述 是否必填

inventoryDate

string

盘点日期 格式(yyyy-MM-dd)

true

storeCodeList

array

盘点门店编码集合 多个用逗号隔开

false

请求示例

curl -X POST -k -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/inventory/page' --data 'inventoryDate=2024-08-30&storeCodeList=8tsm6r&sign=550652140273bc8c95b81f62acff295a&pageSize=10&timestamp=1724981797&token=9aatkj&pageNo=1'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

盘点数据分页数据

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─code

string

盘点单号

          └─storeCode

string

门店编码

          └─storeName

string

门店名称

          └─inventoryDate

string

盘点日期

          └─inventoryTimes

int32

盘点批次

          └─itemList

array

物料编码

               └─workshopCode

string

车间编码

               └─workshopName

string

车间名称

               └─materialCode

string

物料编码

               └─materialLabel

string

物料名称

               └─accountStock

number

账存

               └─actualStock

number

实存

               └─difference

number

差异

               └─unit

string

单位(最小单位)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "code": "68679",
        "storeCode": "68679",
        "storeName": "ahmad.osinski",
        "inventoryDate": "2024-08-30",
        "inventoryTimes": 751,
        "itemList": [
          {
            "workshopCode": "68679",
            "workshopName": "ahmad.osinski",
            "materialCode": "68679",
            "materialLabel": "yf3ax6",
            "accountStock": 201,
            "actualStock": 313,
            "difference": 151,
            "unit": "7hczp0"
          }
        ]
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 门店盘点接口

当前版本:  2.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  门店盘点接口
注意事项:1、盘点信息较多,分多次传输,最后一次时,将盘点状态改为:已完成;
2、同一个门店盘点信息需要依次调用,前一个调用未返回,请重试;
3、门店生成盘点信息时间较久,调用该接口请设置一个较长的等待时间,建议配置:10秒;
4、同一个物料同一个车间只能存在一条盘点信息,以最后一次的设置为准;

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

storeCode

string

门店编码

true

inventoryDate

string

盘点日期(格式:yyyy-MM-dd)

true

inventoryTimes

int32

盘点批次

true

inventoryState

int32

盘点状态:0 未完成 1 已完成

true

stockItems

array

商品库存列表(最大量=500)
商品库存列表 与 结算方式列表 两者至少选择其一

false

└─workshopCode

string

车间编码

true

└─materialCode

string

物料编码

true

└─accountStock

number

账存

true

└─actualStock

number

实存

true

└─unit

string

单位(最小单位)

true

└─remark

string

备注

false

cashItems

array

结算方式列表(最大量500)
商品库存列表 与 结算方式列表 两者至少选择其一

false

└─settlementCode

string

结算方式编码

true

└─settlementName

string

结算方式名称

true

└─accountAmount

number

账存

true

└─actualAmount

number

实存

true

└─remark

string

备注

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/inventory/create?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=ilxcae' --data '{
  "storeCode": "68679",
  "inventoryDate": "2024-08-30",
  "inventoryTimes": 147,
  "inventoryState": 2,
  "stockItems": [
    {
      "workshopCode": "68679",
      "materialCode": "68679",
      "accountStock": 645,
      "actualStock": 977,
      "unit": "vi6yrf",
      "remark": "p9ci6s"
    }
  ],
  "cashItems": [
    {
      "settlementCode": "68679",
      "settlementName": "ahmad.osinski",
      "accountAmount": 281,
      "actualAmount": 158,
      "remark": "hmkhft"
    }
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

盘点结果

     └─createResult

boolean

创建结果 true:成功 false:失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "createResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 门店现金预盘查询接口

当前版本:  2.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  门店现金预盘查询接口

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

storeCode

string

门店编码

true

请求示例

curl -X POST -k -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/inventory/cash/preOffer' --data 'storeCode=68679&sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=dmf502'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

现金预盘信息

     └─storeCode

string

门店编码

     └─storeName

string

门店名称

     └─items

array

结算方式列表

          └─settlementCode

string

结算方式编码

          └─settlementName

string

结算方式名称

          └─enableEdit

int32

是否启用编辑:1 可编辑 0 不可编辑

          └─accountAmount

number

账存

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "storeCode": "68679",
    "storeName": "ahmad.osinski",
    "items": [
      {
        "settlementCode": "68679",
        "settlementName": "ahmad.osinski",
        "enableEdit": 906,
        "accountAmount": 850
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 门店库存预盘查询接口

当前版本:  2.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  门店库存预盘查询接口

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=300)

true

请求参数

Parameter Type Description Required

storeCode

string

门店编码

true

workshopCode

string

车间编码

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/inventory/stock/preOffer?sign=550652140273bc8c95b81f62acff295a&pageSize=10&timestamp=1724981797&token=6oc5oo&pageNo=1' --data '{
  "storeCode": "68679",
  "workshopCode": "68679"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

库存预盘信息

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─workshopCode

string

车间编码

          └─workshopName

string

车间名称

          └─materialCode

string

物料编码

          └─materialLabel

string

物料名称

          └─accountStock

number

账存

          └─unit

string

单位(最小单位)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "workshopCode": "68679",
        "workshopName": "ahmad.osinski",
        "materialCode": "68679",
        "materialLabel": "nc4fuj",
        "accountStock": 797,
        "unit": "s2jt48"
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 单门店实时库存按物料序号查询

当前版本:  1.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  查询单门店实时库存
  本接口需要请求门店POS机,可能会出现网络连接异常。由于门店网络不可控,建议做好请求重试处理。
提示:
    1 当接口请求返回错误码“50101”时,建议间隔5秒后重试(建议重试三次)。
    2 当重试三次后依然返回 “50101”时,需要线下确认门店POS是否已经开机启动烘焙云。

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

storeCode

string

门店编码

true

workshopCode

string

车间编码

true

materialCodes

array

物料序号 ,个数不大于300 示例:aaa,bbb

true

请求示例

curl -X POST -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/store/stock/real/list/byMaterialCode' --data 'materialCodes=aazx62&workshopCode=68679&storeCode=68679&sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=txniu2'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

array

门店实时库存

     └─storeCode

string

门店编码

     └─workshopCode

string

车间编码

     └─materialCode

string

物料序号

     └─realStock

number

实存

     └─lastChangeTime

string

最后变动时间(格式:yyyy-MM-dd HH:mm:ss)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": [
    {
      "storeCode": "68679",
      "workshopCode": "68679",
      "materialCode": "68679",
      "realStock": 252,
      "lastChangeTime": "2024-08-30 09:36:37"
    }
  ],
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 单门店其他出入库单按单号查询

当前版本:  1.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  门店POS其他出入库单按单号查询
  本接口需要请求门店POS机,可能会出现网络连接异常。由于门店网络不可控,建议做好请求重试处理。
提示:
    1 当接口请求返回错误码“50101”时,建议间隔5秒后重试(建议重试三次)。
    2 当重试三次后依然返回 “50101”时,需要线下确认门店POS是否已经开机启动烘焙云。

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

storeCode

string

门店编码

true

code

string

完工单号(或第三方单号)

true

请求示例

curl -X POST -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/custom/io/store/get/bycode' --data 'code=68679&storeCode=68679&sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=az4b50'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

其他出入库单列表

     └─code

string

编码

     └─quoteCode

string

第三方单号

     └─storeCode

string

门店编码

     └─storeName

string

门店名称

     └─workshopCode

string

车间编码

     └─workshopName

string

车间名称

     └─stockDate

string

出入库日期

     └─stockType

int32

出入库类型 0 出库,1 入库

     └─businessType

string

业务类型编码

     └─businessTypeName

string

业务类型名称

     └─remark

string

备注

     └─itemList

array

出入库明细

          └─materialCode

string

物料编码

          └─materialErpCode

string

物料Erp编码

          └─materialLabel

string

物料名称

          └─materialSpec

string

物料规格

          └─stockQuantity

number

库存单位数量

          └─stockUnit

string

库存单位

          └─stockConvert

number

库存单位转换率

          └─minUnit

string

最小单位

          └─minQuantity

number

最小单位数量

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "code": "68679",
    "quoteCode": "68679",
    "storeCode": "68679",
    "storeName": "ahmad.osinski",
    "workshopCode": "68679",
    "workshopName": "ahmad.osinski",
    "stockDate": "2024-08-30",
    "stockType": 823,
    "businessType": "udnw7b",
    "businessTypeName": "ahmad.osinski",
    "remark": "dq5rbo",
    "itemList": [
      {
        "materialCode": "68679",
        "materialErpCode": "68679",
        "materialLabel": "ozdeqv",
        "materialSpec": "9lenw0",
        "stockQuantity": 264,
        "stockUnit": "w9wss7",
        "stockConvert": 717,
        "minUnit": "dlwx9u",
        "minQuantity": 50
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 单门店其他出入库单创建

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  门店POS其他出入库单创建
  本接口需要请求门店POS机,可能会出现网络连接异常。由于门店网络不可控,建议做好请求重试处理。
提示:
    1 当接口请求返回错误码“50101”时,建议间隔5秒后重试(建议重试三次)。
    2 当重试三次后依然返回 “50101”时,需要线下确认门店POS是否已经开机启动烘焙云。

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

quoteCode

string

第三方单号(32位以内)

true

storeCode

string

门店编码

true

workshopCode

string

车间编码

true

stockDate

string

出入库日期

true

stockType

string

出入库类型 0 出库,1 入库

true

businessType

string

业务类型编码 (详见烘焙云控制台 系统-系统设置-系统参数设置 门店其他入库/门店其他出库)

true

remark

string

备注

false

itemList

array

出入库明细

true

└─materialCode

string

物料编码

true

└─quantity

number

最小单位出入库数量

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/custom/io/create?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=r91gkm' --data '{
  "quoteCode": "68679",
  "storeCode": "68679",
  "workshopCode": "68679",
  "stockDate": "2024-08-30",
  "stockType": "rl2ged",
  "businessType": "elexia",
  "remark": "d67xan",
  "itemList": [
    {
      "materialCode": "68679",
      "quantity": 500
    }
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

其他出入库单号

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": "8rox68",
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 

当前版本:  

请求类型:  GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  null

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

startTime

string

开始时间 示例2019-07-22 00:00:00

false

endTime

string

结束时间 示例2019-07-23 00:00:00,与开始时间间隔不得超过24小时,开始时间与结束时间指的都是数据最后更新时间

false

storeTypes

array

No comments found.

false

storeManageTypes

array

No comments found.

false

storeGroups

array

No comments found.

false

includeStores

array

No comments found.

false

excludeStores

array

No comments found.

false

includeWarehouses

array

No comments found.

false

excludeWarehouses

array

No comments found.

false

includeFactorys

array

No comments found.

false

excludeFactorys

array

No comments found.

false

includePayTypes

array

No comments found.

false

excludePayTypes

array

No comments found.

false

codes

array

No comments found.

false

storeIds

array

No comments found.

false

stockStartDate

string

No comments found.

false

stockEndDate

string

No comments found.

false

includeBusinessTypes

array

No comments found.

false

excludeBusinessTypes

array

No comments found.

false

请求示例

curl -X GET -k -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/custom/io/senior/listPage?token=fg3c1s&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a&stockEndDate=2024-08-30&includeFactorys=o3r9qy&includeBusinessTypes=6df1ma&excludeWarehouses=sjev7p&excludeFactorys=s3zrtj&stockStartDate=2024-08-30&endTime=2024-08-30 09:36:37&storeIds=r8oahv&startTime=2024-08-30 09:36:37&storeTypes=s6ddc7&excludeBusinessTypes=pagmgi&includeWarehouses=0t8a4x&excludeStores=03iu8s&includePayTypes=kjy5hb&includeStores=m7nqeb&storeManageTypes=ygnjli&storeGroups=89iti7&codes=02ofkt&excludePayTypes=gqyjea'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

com.bake.iop.model.IopResult

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─code

string

编码

          └─quoteCode

string

第三方单号

          └─storeCode

string

门店编码

          └─storeName

string

门店名称

          └─workshopCode

string

车间编码

          └─workshopName

string

车间名称

          └─stockDate

string

出入库日期

          └─stockType

int32

出入库类型 0 出库,1 入库

          └─businessType

string

业务类型编码

          └─businessTypeName

string

业务类型名称

          └─remark

string

备注

          └─itemList

array

出入库明细

               └─materialCode

string

物料编码

               └─materialErpCode

string

物料Erp编码

               └─materialLabel

string

物料名称

               └─materialSpec

string

物料规格

               └─stockQuantity

number

库存单位数量

               └─stockUnit

string

库存单位

               └─stockConvert

number

库存单位转换率

               └─minUnit

string

最小单位

               └─minQuantity

number

最小单位数量

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "code": "68679",
        "quoteCode": "68679",
        "storeCode": "68679",
        "storeName": "ahmad.osinski",
        "workshopCode": "68679",
        "workshopName": "ahmad.osinski",
        "stockDate": "2024-08-30",
        "stockType": 674,
        "businessType": "sx9m2f",
        "businessTypeName": "ahmad.osinski",
        "remark": "wlr2o5",
        "itemList": [
          {
            "materialCode": "68679",
            "materialErpCode": "68679",
            "materialLabel": "zwfs6l",
            "materialSpec": "npg3or",
            "stockQuantity": 966,
            "stockUnit": "clshwy",
            "stockConvert": 181,
            "minUnit": "tpbnev",
            "minQuantity": 885
          }
        ]
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

4.4. 工厂基础信息

 退货原因信息列表查询

当前版本:  1.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  查询退货原因,支持全量查询

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求示例

curl -X POST -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/returnReason/list?token=86va5a&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

array

退货原因列表

     └─code

string

退货原因编码

     └─name

string

退货原因名称

     └─state

string

退货原因状态 1 启用;0 禁用

     └─returnType

string

类型:1 退回到物料指定仓库; 2 自定义仓库

     └─warehouseCode

string

自定义仓库编码(类型为2时生效)

     └─updatedAt

string

数据更新时间

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": [
    {
      "code": "68679",
      "name": "ahmad.osinski",
      "state": "vpio48",
      "returnType": "cuinl4",
      "warehouseCode": "68679",
      "updatedAt": "hntn2x"
    }
  ],
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 工厂信息列表查询

当前版本:  1.0

请求类型:  GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  查询工厂信息,全量查询

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求示例

curl -X GET -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/factory/list?token=ha3d82&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

array

工厂列表

     └─factoryCode

string

工厂编码

     └─name

string

工厂名称

     └─status

string

状态0:不可用,1:可用

     └─updatedAt

string

数据更新时间

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": [
    {
      "factoryCode": "68679",
      "name": "ahmad.osinski",
      "status": "83tibr",
      "updatedAt": "d3dcl5"
    }
  ],
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 仓库信息列表查询

当前版本:  1.0

请求类型:  GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  查询仓库信息,全量查询

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求示例

curl -X GET -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/warehouse/list?token=xn74la&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

array

仓库列表

     └─warehouseCode

string

仓库编码

     └─name

string

仓库名称

     └─status

string

状态0:不可用,1:可用

     └─updatedAt

string

数据更新时间

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": [
    {
      "warehouseCode": "68679",
      "name": "ahmad.osinski",
      "status": "n1mgv9",
      "updatedAt": "7cjqv6"
    }
  ],
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

4.5. 礼品卡

 礼品卡详情

当前版本:  1.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  获得未核销礼品卡信息

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

cardCode

string

礼品卡号

true

请求示例

curl -X POST -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/giftCard/cardInfo' --data 'sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=eqpqmn&cardCode=68679'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

礼品卡详情

     └─code

string

卡号

     └─name

string

名称

     └─faceValue

number

面值

     └─describe

string

说明

     └─giftPackCode

string

礼包code

     └─state

int32

状态(2:待销售3:待激活4:待使用5:已使用6:已注销21:已停用22:待生效23:已过期)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "code": "68679",
    "name": "ahmad.osinski",
    "faceValue": 550,
    "describe": "5b38rt",
    "giftPackCode": "68679",
    "state": 2
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 礼品卡核销

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  礼品卡核销(只有[待使用]状态卡可以核销)

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

cardCode

string

礼品卡号

true

cardPwd

string

礼品卡密码(密文,使用应用秘钥进行AES加密:AES/ECB/PKCS5Padding模式128长度的HEX输出)

true

hbyOpenId

string

烘焙云OpenId

true

storeCode

string

来源门店编码

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/giftCard/redeemGiftCard?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=vlnc1r' --data '{
  "cardCode": "68679",
  "cardPwd": "8kta8r",
  "hbyOpenId": "54",
  "storeCode": "68679"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

礼品卡核销结果

     └─redeemResult

boolean

核销结果 true:成功 false:失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "redeemResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 礼品卡余额变动明细查询

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  查询礼品卡余额变动明细

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求参数

Parameter Type Description Required

cardCode

string

礼品卡号

true

startTime

string

开始时间(格式:yyyy-MM-dd HH:mm:ss)

false

endTime

string

结束时间(格式:yyyy-MM-dd HH:mm:ss)

false

direction

int32

收支类型(1:收入2:支出)

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/giftCard/balanceChange/page?sign=550652140273bc8c95b81f62acff295a&pageSize=10&timestamp=1724981797&token=lqgpkn&pageNo=1' --data '{
  "cardCode": "68679",
  "startTime": "2024-08-30 09:36:37",
  "endTime": "2024-08-30 09:36:37",
  "direction": 191
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

礼品卡余额变动明细

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─cardCode

string

礼品卡号

          └─tradeScene

int32

交易场景类型(6消费7退单8充值9取消充值12充值赠送13充值退货16调账)

          └─tradeSceneName

string

交易场景名称

          └─tradeCode

string

业务编号

          └─storeCode

string

门店编码

          └─tradeDetailNo

string

流水号

          └─changeNum

number

变动数量(如+500,-34)

          └─remain

number

变动后值

          └─principalChangeNum

number

本金变动数量(如+500,-34)

          └─principalRemain

number

本金变动后值

          └─giftAmountChangeNum

number

赠送金变动数量(如+500,-34)

          └─giftAmountRemain

number

赠送金变动后值

          └─remark

string

备注

          └─changeTime

string

变动时间(格式:yyyy-MM-dd HH:mm:ss)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "cardCode": "68679",
        "tradeScene": 144,
        "tradeSceneName": "ahmad.osinski",
        "tradeCode": "68679",
        "storeCode": "68679",
        "tradeDetailNo": "ay9w06",
        "changeNum": 488,
        "remain": 432,
        "principalChangeNum": 838,
        "principalRemain": 80,
        "giftAmountChangeNum": 896,
        "giftAmountRemain": 242,
        "remark": "wj6muo",
        "changeTime": "2024-08-30 09:36:37"
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

4.6. 商品

 线下商品价格查询

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  分页查询线下商品价格

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求参数

Parameter Type Description Required

priceSystemCode

string

价格体系编码

true

materialCodeList

array

物料序号集合(个数不大于50)

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/materialPrice/page?sign=550652140273bc8c95b81f62acff295a&pageSize=10&timestamp=1724981797&token=pj2n46&pageNo=1' --data '{
  "priceSystemCode": "68679",
  "materialCodeList": [
    "85jjf1"
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

线下商品价格信息分页数据

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─priceSystemCode

string

价格体系编码

          └─materialCode

string

物料序号

          └─exFactoryPrice

number

出厂价格(要货单位)

          └─salePrice

number

销售价格(最小单位)

          └─maxPurchasePrice

number

最高采购价格(采购单位)

          └─memberPrice

number

会员价格(最小单位)

          └─costPrice

number

成本价格(最小单位)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "priceSystemCode": "68679",
        "materialCode": "68679",
        "exFactoryPrice": 554,
        "salePrice": 441,
        "maxPurchasePrice": 444,
        "memberPrice": 225,
        "costPrice": 298
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 线下商品列表查询

当前版本:  1.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  查询线下商品信息,全量查询,增量查询,支持分页

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求参数

参数 类型 描述 是否必填

allowSales

int32

是否允许销售 0:不允许,1:允许

false

status

int32

状态 0:不可用,1:可用

false

storeCode

string

门店编码

false

startTime

string

开始时间 示例2019-07-22 00:00:00

false

endTime

string

结束时间 示例2019-07-23 00:00:00

false

请求示例

curl -X POST -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/material/goodspage' --data 'endTime=2024-08-30 09:36:37&startTime=2024-08-30 09:36:37&sign=550652140273bc8c95b81f62acff295a&allowSales=803&pageSize=10&status=159&timestamp=1724981797&token=u52xvm&pageNo=1&storeCode=68679'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

线下商品分页数据

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─label

string

物料名称

          └─code

string

物料序号

          └─thirdCode

string

第三方编码(对应烘焙云物料详情"第三方编码")

          └─materialTypeCode

string

物料类型编码

          └─spec

string

物料规格

          └─minUnit

string

最小单位

          └─requestUnit

string

要货单位

          └─requestCovert

double

最小单位与要货单位的转换值

          └─procureUnit

string

采购单位

          └─procureConvert

double

最小单位与采购单位的转换值

          └─inventoryUnit

string

库存单位

          └─inventoryConvert

double

最小单位与库存单位的转换值

          └─allowSales

int32

是否允许销售 0:不允许,1:允许

          └─canUseStore

int32

可用门店:1、全部门店 2、自定义门店

          └─finishWorkshopCode

string

完工车间编码

          └─customFinish

int32

自定义组合完工0:否,1:是

          └─canUseStoreCodes

array

可用门店编码

          └─canUseStoreGroupCodes

array

可用门店组编码

          └─workshopCodes

array

可用车间编码

          └─defaultSupplierCode

string

默认供应商编码

          └─defaultSupplierName

string

默认供应商名称

          └─status

int32

状态 0:不可用,1:可用

          └─createdAt

string

数据生成时间

          └─updatedAt

string

数据更新时间

          └─allowNegativeInventory

int32

允许负库存 0:否;1:是 (查询条件中门店编码不为空时生效)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "label": "fbgrk9",
        "code": "68679",
        "thirdCode": "68679",
        "materialTypeCode": "68679",
        "spec": "0o1v61",
        "minUnit": "hjhnjy",
        "requestUnit": "g9zwqq",
        "requestCovert": 99.48,
        "procureUnit": "d3d2ye",
        "procureConvert": 96.84,
        "inventoryUnit": "vvv5d1",
        "inventoryConvert": 65.53,
        "allowSales": 855,
        "canUseStore": 300,
        "finishWorkshopCode": "68679",
        "customFinish": 385,
        "canUseStoreCodes": [
          "izdaa7"
        ],
        "canUseStoreGroupCodes": [
          "pyekj7"
        ],
        "workshopCodes": [
          "qulens"
        ],
        "defaultSupplierCode": "68679",
        "defaultSupplierName": "ahmad.osinski",
        "status": 11,
        "createdAt": "2lj5b6",
        "updatedAt": "qo952m",
        "allowNegativeInventory": 725
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 线下商品详情查询

当前版本:  1.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  根据编码查询线下商品详情,支持多编码查询

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

codes

array

线下商品编码 用英文逗号隔开,编码个数不大于50 示例:ejR8ml,bkR7nE,ak206dtp

true

请求示例

curl -X POST -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/material/list/bycodes' --data 'sign=550652140273bc8c95b81f62acff295a&codes=2tshm4&timestamp=1724981797&token=4e2b4b'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

array

线下商品详情

     └─label

string

物料名称

     └─code

string

物料序号

     └─thirdCode

string

第三方编码(对应烘焙云物料详情"第三方编码")

     └─materialTypeCode

string

物料类型编码

     └─spec

string

物料规格

     └─minUnit

string

最小单位

     └─requestUnit

string

要货单位

     └─requestCovert

double

最小单位与要货单位的转换值

     └─procureUnit

string

采购单位

     └─procureConvert

double

最小单位与采购单位的转换值

     └─inventoryUnit

string

库存单位

     └─inventoryConvert

double

最小单位与库存单位的转换值

     └─allowSales

int32

是否允许销售 0:不允许,1:允许

     └─canUseStore

int32

可用门店:1、全部门店 2、自定义门店

     └─finishWorkshopCode

string

完工车间编码

     └─customFinish

int32

自定义组合完工0:否,1:是

     └─canUseStoreCodes

array

可用门店编码

     └─canUseStoreGroupCodes

array

可用门店组编码

     └─workshopCodes

array

可用车间编码

     └─defaultSupplierCode

string

默认供应商编码

     └─defaultSupplierName

string

默认供应商名称

     └─status

int32

状态 0:不可用,1:可用

     └─createdAt

string

数据生成时间

     └─updatedAt

string

数据更新时间

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": [
    {
      "label": "celq0z",
      "code": "68679",
      "thirdCode": "68679",
      "materialTypeCode": "68679",
      "spec": "5091zf",
      "minUnit": "7ssnm9",
      "requestUnit": "xlfhhu",
      "requestCovert": 61.3,
      "procureUnit": "hvcuf4",
      "procureConvert": 48.38,
      "inventoryUnit": "c5xxxf",
      "inventoryConvert": 63.4,
      "allowSales": 467,
      "canUseStore": 492,
      "finishWorkshopCode": "68679",
      "customFinish": 606,
      "canUseStoreCodes": [
        "lu712t"
      ],
      "canUseStoreGroupCodes": [
        "ic8rme"
      ],
      "workshopCodes": [
        "oy4mca"
      ],
      "defaultSupplierCode": "68679",
      "defaultSupplierName": "ahmad.osinski",
      "status": 216,
      "createdAt": "8uek7y",
      "updatedAt": "ni80vx"
    }
  ],
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 线下商品要货信息查询

当前版本:  1.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  线下商品要货信息查询

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

codes

array

物料序号 用英文逗号隔开,编码个数不大于50 示例:ejR8ml,bkR7nE,ak206dtp

true

请求示例

curl -X POST -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/material/request/list/bycodes' --data 'sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=z9zz44&codes=2isuva'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

array

线下商品要货信息

     └─materialCode

string

物料序号

     └─materialLabel

string

物料名称

     └─isAllowRequest

boolean

是否允许要货

     └─requestUnit

string

要货单位

     └─requestCovert

number

最小单位与要货单位的转换值

     └─requestTimes

number

要货倍数

     └─requestQuantityMax

number

最大要货量(要货单位)

     └─requestQuantityMin

number

最小要货量(要货单位)

     └─isFactoryDistribution

boolean

是否支持公司配送

     └─supplyWarehouseCodeList

array

供货仓库编码

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": [
    {
      "materialCode": "68679",
      "materialLabel": "dej65g",
      "isAllowRequest": true,
      "requestUnit": "n18ygf",
      "requestCovert": 199,
      "requestTimes": 780,
      "requestQuantityMax": 46,
      "requestQuantityMin": 213,
      "isFactoryDistribution": true,
      "supplyWarehouseCodeList": [
        "rwilqi"
      ]
    }
  ],
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 线下商品要货信息分页查询

当前版本:  1.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  线下商品要货信息分页查询

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

startTime

string

开始时间 示例2019-07-22 00:00:00

false

endTime

string

结束时间 示例2019-07-23 00:00:00

false

请求示例

curl -X POST -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/material/request/page' --data 'endTime=2024-08-30 09:36:37&startTime=2024-08-30 09:36:37&sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=6zucho'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

线下商品要货信息

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─materialCode

string

物料序号

          └─materialLabel

string

物料名称

          └─isAllowRequest

boolean

是否允许要货

          └─requestUnit

string

要货单位

          └─requestCovert

number

最小单位与要货单位的转换值

          └─requestTimes

number

要货倍数

          └─requestQuantityMax

number

最大要货量(要货单位)

          └─requestQuantityMin

number

最小要货量(要货单位)

          └─isFactoryDistribution

boolean

是否支持公司配送

          └─supplyWarehouseCodeList

array

供货仓库编码

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "materialCode": "68679",
        "materialLabel": "7eu17x",
        "isAllowRequest": true,
        "requestUnit": "am1nti",
        "requestCovert": 957,
        "requestTimes": 289,
        "requestQuantityMax": 411,
        "requestQuantityMin": 92,
        "isFactoryDistribution": true,
        "supplyWarehouseCodeList": [
          "hhhoj4"
        ]
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 线下商品分类列表查询

当前版本:  1.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  查询线下商品分类(对应烘焙云物料分类),支持全量查询,支持分页

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求示例

curl -X POST -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/materialType/listPage?token=lrimxc&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a&pageNo=1&pageSize=10'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

线下商品分类分页数据

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─code

string

分类编码

          └─parentCode

string

父级分类编码

          └─label

string

分类名称

          └─path

string

级别路径,以半角逗号分隔

          └─status

string

状态 0:不可用,1:可用

          └─updatedAt

string

数据更新时间

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "code": "68679",
        "parentCode": "68679",
        "label": "ibvypg",
        "path": "jl3djm",
        "status": "9ds9px",
        "updatedAt": "qtizii"
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 配方信息

当前版本:  1.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  查询配方信息,全量查询,支持分页

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求示例

curl -X POST -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/materialBom/page?token=w8xsm5&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a&pageNo=1&pageSize=10'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

配方分页数据

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─bomCode

string

配方编码

          └─label

string

物料名称

          └─materialCode

string

物料序号

          └─status

string

状态(1可用 0不可用)

          └─updatedAt

string

数据更新时间

          └─itemList

array

明细集合

               └─label

string

物料名称

               └─materialCode

string

物料序号

               └─quantity

double

配方明细耗用数量

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "bomCode": "68679",
        "label": "9wmyk5",
        "materialCode": "68679",
        "status": "j2hvp9",
        "updatedAt": "epbzek",
        "itemList": [
          {
            "label": "h2sk2a",
            "materialCode": "68679",
            "quantity": 33.48
          }
        ]
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 三方商品创建

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  三方商品创建接口

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

name

string

三方商品商品名称

true

thirdCode

string

三方商品编码

true

categoryName

string

分类名称

false

description

string

商品描述

false

type

int32

商品类型:1实物

true

kind

int32

商品种类:1线下物料

true

sortNum

int32

序号

false

skuList

array

三方商品sku信息

true

└─name

string

三方商品sku名称

true

└─thirdSkuCode

string

三方商品sku编码

true

└─bizType

int32

业务类型:1物料

true

└─bizCode

string

业务编号(业务类型为1时传入烘焙云物料序号;获取方式:1烘焙云线下商品列表查询接口中的返回的“物料序号”字段。2使用烘焙控制台物料设置功能查询时取列表中的“物料序号”列)

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/goods/createThirdGoods?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=42k3ld' --data '{
  "name": "ahmad.osinski",
  "thirdCode": "68679",
  "categoryName": "ahmad.osinski",
  "description": "zud232",
  "type": 723,
  "kind": 801,
  "sortNum": 873,
  "skuList": [
    {
      "name": "ahmad.osinski",
      "thirdSkuCode": "68679",
      "bizType": 307,
      "bizCode": "68679"
    }
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

三方商品信息

     └─code

string

烘焙云商品编码

     └─name

string

三方商品名称

     └─thirdCode

string

三方商品编码

     └─categoryName

string

分类名称

     └─description

string

商品描述

     └─type

int32

商品类型:1实物

     └─kind

int32

商品种类:1线下物料

     └─sortNum

int32

序号

     └─salesStatus

int32

商品状态:1上架2下架

     └─skuList

array

三方商品sku信息

          └─skuCode

string

烘焙云sku编码

          └─name

string

三方商品sku名称

          └─thirdSkuCode

string

三方商品sku编码

          └─bizType

int32

业务类型:1物料

          └─bizCode

string

业务编号:物料code

          └─bizNum

int32

业务数量

          └─status

int32

sku状态:1启用0停用

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "code": "68679",
    "name": "ahmad.osinski",
    "thirdCode": "68679",
    "categoryName": "ahmad.osinski",
    "description": "0hhxah",
    "type": 735,
    "kind": 723,
    "sortNum": 662,
    "salesStatus": 37,
    "skuList": [
      {
        "skuCode": "68679",
        "name": "ahmad.osinski",
        "thirdSkuCode": "68679",
        "bizType": 852,
        "bizCode": "68679",
        "bizNum": 845,
        "status": 24
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 查询三方商品信息

当前版本:  1.0

请求类型:  GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  查询三方商品接口

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

thirdCode

string

三方商品编码

true

请求示例

curl -X GET -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/goods/thirdGoodsInfo?token=4fxaoi&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a&thirdCode=68679'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

三方商品信息

     └─code

string

烘焙云商品编码

     └─name

string

三方商品名称

     └─thirdCode

string

三方商品编码

     └─categoryName

string

分类名称

     └─description

string

商品描述

     └─type

int32

商品类型:1实物

     └─kind

int32

商品种类:1线下物料

     └─sortNum

int32

序号

     └─salesStatus

int32

商品状态:1上架2下架

     └─skuList

array

三方商品sku信息

          └─skuCode

string

烘焙云sku编码

          └─name

string

三方商品sku名称

          └─thirdSkuCode

string

三方商品sku编码

          └─bizType

int32

业务类型:1物料

          └─bizCode

string

业务编号:物料code

          └─bizNum

int32

业务数量

          └─status

int32

sku状态:1启用0停用

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "code": "68679",
    "name": "ahmad.osinski",
    "thirdCode": "68679",
    "categoryName": "ahmad.osinski",
    "description": "3h166e",
    "type": 333,
    "kind": 122,
    "sortNum": 330,
    "salesStatus": 791,
    "skuList": [
      {
        "skuCode": "68679",
        "name": "ahmad.osinski",
        "thirdSkuCode": "68679",
        "bizType": 251,
        "bizCode": "68679",
        "bizNum": 677,
        "status": 623
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 三方商品编辑

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  三方商品编辑接口

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

code

string

烘焙云商品编码

true

name

string

三方商品商品名称

false

thirdCode

string

三方商品编码

false

categoryName

string

分类名称

false

description

string

商品描述

false

type

int32

商品类型:1实物

false

kind

int32

商品种类:1线下物料

false

sortNum

int32

序号

false

skuList

array

三方商品sku信息

false

└─skuCode

string

烘焙云sku编码(如果传值则在原sku基础上进行编辑,如果传空则新增sku)

false

└─name

string

三方商品sku名称(烘焙云sku编码传空时必填)

false

└─thirdSkuCode

string

三方商品sku编码(烘焙云sku编码传空时必填)

false

└─bizType

int32

业务类型:1物料(烘焙云sku编码传空时必填)

false

└─bizCode

string

业务编号(业务类型为1时传入烘焙云物料序号;获取方式:1烘焙云线下商品列表查询接口中的返回的“物料序号”字段。2使用烘焙控制台物料设置功能查询时取列表中的“物料序号”列)(烘焙云sku编码传空时必填)

false

└─status

int32

sku状态:1启用0停用(烘焙云sku编码传空时必填)

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/goods/updateThirdGoods?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=v3erpu' --data '{
  "code": "68679",
  "name": "ahmad.osinski",
  "thirdCode": "68679",
  "categoryName": "ahmad.osinski",
  "description": "7bkgup",
  "type": 819,
  "kind": 334,
  "sortNum": 145,
  "skuList": [
    {
      "skuCode": "68679",
      "name": "ahmad.osinski",
      "thirdSkuCode": "68679",
      "bizType": 778,
      "bizCode": "68679",
      "status": 453
    }
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

三方商品编辑结果

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": "true",
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 三方商品上架门店

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  三方商品上架门店接口

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

goodsCodes

array

烘焙云商品编码,格式:(商品编码,商品编码) 最多20个

true

storeType

int32

上架门店类型:1全部门店2自定义门店

true

storeCodes

array

上架门店code,格式:(门店code,门店code)

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/goods/onShelfThirdGoods?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=ccm3h6' --data '{
  "goodsCodes": [
    "mtxrc7"
  ],
  "storeType": 607,
  "storeCodes": [
    "q0mxjh"
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

三方商品上架门店结果

     └─onShelfResult

boolean

上架结果 true:成功 false:失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "onShelfResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 三方商品下架门店

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  三方商品下架门店接口

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

goodsCodes

array

烘焙云商品编码,格式:(商品编码,商品编码) 最多20个

true

storeType

int32

下架门店类型:1全部门店2自定义门店

true

storeCodes

array

下架门店code,格式:门店code,门店code

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/goods/offShelfThirdGoods?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=ki9ay5' --data '{
  "goodsCodes": [
    "ybd87f"
  ],
  "storeType": 867,
  "storeCodes": [
    "glxfir"
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

三方商品下架门店结果

     └─offShelfResult

boolean

下架结果 true:成功 false:失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "offShelfResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 门店三方商品下发

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  门店下发三方商品

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

storeCode

string

门店编码

true

goodsCodes

array

烘焙云商品编码,格式:商品编码,商品编码

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/goods/storeThirdGoodsIssue?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=pfstja' --data '{
  "storeCode": "68679",
  "goodsCodes": [
    "10dxuu"
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

下发结果

     └─issueResult

boolean

下发结果 true:成功 false:失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "issueResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 物料信息列表查询(已过期,不建议使用)

当前版本:  1.0

请求类型:  POST

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  查询物料信息,全量查询,支持分页

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求示例

curl -X POST -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/material/page?token=pr36wu&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a&pageNo=1&pageSize=10'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

物料信息分页数据

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─label

string

物料名称

          └─code

string

物料序号

          └─thirdCode

string

第三方编码(对应烘焙云物料详情"第三方编码")

          └─materialTypeCode

string

物料类型编码

          └─spec

string

物料规格

          └─minUnit

string

最小单位

          └─requestUnit

string

要货单位

          └─requestCovert

double

最小单位与要货单位的转换值

          └─procureUnit

string

采购单位

          └─procureConvert

double

最小单位与采购单位的转换值

          └─inventoryUnit

string

库存单位

          └─inventoryConvert

double

最小单位与库存单位的转换值

          └─allowSales

int32

是否允许销售 0:不允许,1:允许

          └─canUseStore

int32

可用门店:1、全部门店 2、自定义门店

          └─finishWorkshopCode

string

完工车间编码

          └─customFinish

int32

自定义组合完工0:否,1:是

          └─canUseStoreCodes

array

可用门店编码

          └─canUseStoreGroupCodes

array

可用门店组编码

          └─workshopCodes

array

可用车间编码

          └─defaultSupplierCode

string

默认供应商编码

          └─defaultSupplierName

string

默认供应商名称

          └─status

int32

状态 0:不可用,1:可用

          └─createdAt

string

数据生成时间

          └─updatedAt

string

数据更新时间

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "label": "loknv6",
        "code": "68679",
        "thirdCode": "68679",
        "materialTypeCode": "68679",
        "spec": "afuwyv",
        "minUnit": "7dwqmd",
        "requestUnit": "1gr8ze",
        "requestCovert": 83.63,
        "procureUnit": "xef89m",
        "procureConvert": 29.58,
        "inventoryUnit": "rkx74z",
        "inventoryConvert": 71.31,
        "allowSales": 923,
        "canUseStore": 287,
        "finishWorkshopCode": "68679",
        "customFinish": 46,
        "canUseStoreCodes": [
          "774jp4"
        ],
        "canUseStoreGroupCodes": [
          "chxji5"
        ],
        "workshopCodes": [
          "o0v534"
        ],
        "defaultSupplierCode": "68679",
        "defaultSupplierName": "ahmad.osinski",
        "status": 355,
        "createdAt": "gwxvkz",
        "updatedAt": "rpxs66"
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

4.7. 充值单

 充值单查询

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  根据支付日期、退单日期查询充值单

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求参数

Parameter Type Description Required

payDate

string

支付日期(yyyy-MM-dd),支付日期与退单日期不能同时为空

false

returnedDate

string

退单日期(yyyy-MM-dd),支付日期与退单日期不能同时为空

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/rechargeOrder/page?sign=550652140273bc8c95b81f62acff295a&pageSize=10&timestamp=1724981797&token=ngr8h4&pageNo=1' --data '{
  "payDate": "2024-08-30",
  "returnedDate": "2024-08-30"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

充值单分页信息

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─code

string

充值单号

          └─state

int32

充值单状态3已完成5已取消

          └─platform

int32

平台:1烘焙云,2美团,3饿了么,4口碑,5有赞,101企迈

          └─hbyOpenId

string

会员烘焙云OpenId

          └─rechargeAmount

number

充值金额

          └─rechargePrincipal

number

充值本金金额

          └─giftDetail

array

充值赠送明细

               └─source

int32

赠品来源:1活动赠送 2基础赠送

               └─type

int32

赠品分类:1实物 2虚拟

               └─giftType

int32

赠品类型:1商品 2券 3积分 4余额 5成长值

               └─name

string

赠品名称

               └─giftValue

string

赠品内容(物料编码/券号)

               └─giftNum

number

赠送数量

               └─giftRemark

string

赠送备注

               └─state

int32

赠送状态:0未赠送1已赠送2已回收

          └─payType

int32

支付方式

          └─payTitle

string

支付方式名称

          └─payAmount

number

支付总金额

          └─discountAmount

number

优惠金额

          └─discountDetail

array

优惠明细

               └─discountMode

int32

优惠类型 1优惠券3充值卡4储值卡5礼品卡

               └─title

string

优惠标题

               └─description

string

优惠描述

               └─discountAmount

number

优惠金额

               └─cost

string

消耗内容(券号、充值卡号、礼品卡号)

               └─discountCost

number

优惠成本

          └─storeCode

string

门店编码

          └─storeName

string

门店名称

          └─payTime

string

支付时间(格式:yyyy-MM-dd HH:mm:ss)

          └─returnedTime

string

取消充值时间(格式:yyyy-MM-dd HH:mm:ss)

          └─remark

string

充值单备注

          └─createdAt

string

创建时间(格式:yyyy-MM-dd HH:mm:ss)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "code": "68679",
        "state": 2,
        "platform": 292,
        "hbyOpenId": "54",
        "rechargeAmount": 112,
        "rechargePrincipal": 955,
        "giftDetail": [
          {
            "source": 506,
            "type": 760,
            "giftType": 800,
            "name": "ahmad.osinski",
            "giftValue": "p7peos",
            "giftNum": 270,
            "giftRemark": "yc103d",
            "state": 2
          }
        ],
        "payType": 209,
        "payTitle": "wuupyq",
        "payAmount": 496,
        "discountAmount": 479,
        "discountDetail": [
          {
            "discountMode": 455,
            "title": "t6hqby",
            "description": "yeg9r0",
            "discountAmount": 422,
            "cost": "t4cq8e",
            "discountCost": 409
          }
        ],
        "storeCode": "68679",
        "storeName": "ahmad.osinski",
        "payTime": "2024-08-30 09:36:37",
        "returnedTime": "2024-08-30 09:36:37",
        "remark": "eqca4g",
        "createdAt": "pmtfpm"
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

4.8. 会员

 手机号注册

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  手机号注册接口

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

mobile

string

手机号

true

loginPassword

string

登录密码,6位数字(密文,使用应用秘钥进行AES加密:AES/ECB/PKCS5Padding模式128长度的HEX输出)

false

name

string

姓名

false

sex

int32

性别0:未知;1:男;2:女

false

birthday

string

生日(格式:yyyy-MM-dd)

false

email

string

邮箱

false

homeAddr

string

家庭住址

false

storeCode

string

来源门店

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/member/mobileRegister?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=81wg1w' --data '{
  "mobile": "1-219-551-0212",
  "loginPassword": "dxsbdr",
  "name": "ahmad.osinski",
  "sex": 1,
  "birthday": "2024-08-30",
  "email": "lane.mayer@gmail.com",
  "homeAddr": "ullj6u",
  "storeCode": "68679"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

会员基础信息

     └─hbyOpenId

string

烘焙云OpenId

     └─mobile

string

手机号

     └─name

string

姓名

     └─sex

int32

性别0:未知;1:男;2:女

     └─birthday

string

生日

     └─email

string

邮箱

     └─homeAddr

string

家庭住址

     └─storeCode

string

来源门店

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "hbyOpenId": "54",
    "mobile": "1-219-551-0212",
    "name": "ahmad.osinski",
    "sex": 1,
    "birthday": "2024-08-30",
    "email": "lane.mayer@gmail.com",
    "homeAddr": "5tyxkw",
    "storeCode": "68679"
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员微信信息绑定

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  会员绑定微信信息

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

hbyOpenId

string

烘焙云OpenId

true

wechatInfoParam

object

微信信息

true

└─openId

string

微信公众号openId(和微信小程序openId不能同时为空)

false

└─miniProgramOpenId

string

微信小程序openId(和微信公众号openId不能同时为空)

false

└─unionId

string

微信unionId

true

└─country

string

用户所在国家

false

└─province

string

用户所在省份

false

└─city

string

用户所在城市

false

└─headImgUrl

string

用户头像

false

└─nickName

string

用户的昵称

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/member/bindWechat?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=gcaw5n' --data '{
  "hbyOpenId": "54",
  "wechatInfoParam": {
    "openId": "54",
    "miniProgramOpenId": "54",
    "unionId": "54",
    "country": "9dbdlo",
    "province": "ndx8ub",
    "city": "mekx0r",
    "headImgUrl": "www.dominic-howell.org",
    "nickName": "orpha.sanford"
  }
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

绑定结果

     └─bindResult

boolean

绑定结果 true:成功 false:失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "bindResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 微信会员解绑

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  微信会员解绑

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

hbyOpenId

string

烘焙云OpenId

true

unionId

string

微信unionId

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/member/untyingWechat?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=0n9w80' --data '{
  "hbyOpenId": "54",
  "unionId": "54"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

解绑结果

     └─untyingResult

boolean

解绑结果 true:成功 false:失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "untyingResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 微信解绑会员

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  根据微信UnionId解绑微信绑定的会员(需要单独申请权限)

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

unionId

string

微信unionId

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/member/wechatUntyingMember?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=4lhrci' --data '{
  "unionId": "54"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

解绑结果

     └─untyingResult

boolean

解绑结果 true:成功 false:失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "untyingResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 微信会员注册

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  微信会员注册接口

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

mobile

string

手机号

true

loginPassword

string

登录密码,6位数字(密文,使用应用秘钥进行AES加密:AES/ECB/PKCS5Padding模式128长度的HEX输出)

false

name

string

姓名

false

sex

int32

性别0:未知;1:男;2:女

false

birthday

string

生日(格式:yyyy-MM-dd)

false

email

string

邮箱

false

homeAddr

string

家庭住址

false

storeCode

string

来源门店

false

wechatInfoParam

object

微信信息

true

└─openId

string

微信公众号openId(和微信小程序openId不能同时为空)

false

└─miniProgramOpenId

string

微信小程序openId(和微信公众号openId不能同时为空)

false

└─unionId

string

微信unionId

true

└─country

string

用户所在国家

false

└─province

string

用户所在省份

false

└─city

string

用户所在城市

false

└─headImgUrl

string

用户头像

false

└─nickName

string

用户的昵称

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/member/wechatRegister?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=rofec9' --data '{
  "mobile": "1-219-551-0212",
  "loginPassword": "f8emfi",
  "name": "ahmad.osinski",
  "sex": 1,
  "birthday": "2024-08-30",
  "email": "lane.mayer@gmail.com",
  "homeAddr": "jf42lz",
  "storeCode": "68679",
  "wechatInfoParam": {
    "openId": "54",
    "miniProgramOpenId": "54",
    "unionId": "54",
    "country": "6xuele",
    "province": "9b8bac",
    "city": "gj7yqw",
    "headImgUrl": "www.dominic-howell.org",
    "nickName": "orpha.sanford"
  }
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

会员基础信息

     └─hbyOpenId

string

烘焙云OpenId

     └─mobile

string

手机号

     └─name

string

姓名

     └─sex

int32

性别0:未知;1:男;2:女

     └─birthday

string

生日

     └─email

string

邮箱

     └─homeAddr

string

家庭住址

     └─storeCode

string

来源门店

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "hbyOpenId": "54",
    "mobile": "1-219-551-0212",
    "name": "ahmad.osinski",
    "sex": 1,
    "birthday": "2024-08-30",
    "email": "lane.mayer@gmail.com",
    "homeAddr": "ml8lxr",
    "storeCode": "68679"
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员基础信息变更

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  根据会员openId变更会员基础信息

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

hbyOpenId

string

烘焙云OpenId

true

name

string

姓名

false

sex

int32

性别0:未知;1:男;2:女

false

birthday

string

生日

false

email

string

邮箱

false

homeAddr

string

家庭住址

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/member/modify?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=o7ou3k' --data '{
  "hbyOpenId": "54",
  "name": "ahmad.osinski",
  "sex": 1,
  "birthday": "2024-08-30",
  "email": "lane.mayer@gmail.com",
  "homeAddr": "yt3jwf"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

变更结果

     └─modifyResult

boolean

变更结果 true:成功 false:失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "modifyResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员手机号查询基础信息

当前版本:  1.0

请求类型:  GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  根据mobile查询会员基础信息

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

mobile

string

手机号

true

请求示例

curl -X GET -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/member/mobileGetBaseInfo?token=sdyq3k&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a&mobile=1-219-551-0212'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

会员基础信息

     └─hbyOpenId

string

烘焙云OpenId

     └─mobile

string

手机号

     └─name

string

姓名

     └─sex

int32

性别0:未知;1:男;2:女

     └─birthday

string

生日

     └─email

string

邮箱

     └─homeAddr

string

家庭住址

     └─storeCode

string

来源门店

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "hbyOpenId": "54",
    "mobile": "1-219-551-0212",
    "name": "ahmad.osinski",
    "sex": 1,
    "birthday": "2024-08-30",
    "email": "lane.mayer@gmail.com",
    "homeAddr": "p24ao6",
    "storeCode": "68679"
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 手机号合法性验证

当前版本:  

请求类型:  GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  手机号合法性验证

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

mobile

string

会员手机号

true

password

string

登录密码,6位数字(密文,使用应用秘钥进行AES加密:AES/ECB/PKCS5Padding模式128长度的HEX输出)

true

请求示例

curl -X GET -k -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/member/mobileVerification?token=3p3n3c&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a&mobile=1-219-551-0212&password=3ovi0q'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

com.bake.web.common.HttpJsonResult

     └─hbyOpenId

string

烘焙云OpenId

     └─mobile

string

手机号

     └─name

string

姓名

     └─sex

int32

性别0:未知;1:男;2:女

     └─birthday

string

生日

     └─email

string

邮箱

     └─homeAddr

string

家庭住址

     └─storeCode

string

来源门店

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "hbyOpenId": "54",
    "mobile": "1-219-551-0212",
    "name": "ahmad.osinski",
    "sex": 1,
    "birthday": "2024-08-30",
    "email": "lane.mayer@gmail.com",
    "homeAddr": "m2k1bi",
    "storeCode": "68679"
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员详细信息

当前版本:  1.0

请求类型:  GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  根据会员openId查询会员详细信息

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

hbyOpenId

string

烘焙云openId

true

请求示例

curl -X GET -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/member/detailInfo?token=5o3234&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a&hbyOpenId=54'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

会员详细信息

     └─hbyOpenId

string

烘焙云OpenId

     └─mobile

string

手机号

     └─name

string

姓名

     └─sex

int32

性别0:未知;1:男;2:女

     └─birthday

string

生日

     └─email

string

邮箱

     └─homeAddr

string

家庭住址

     └─storeCode

string

来源门店

     └─balance

number

余额

     └─state

int32

会员状态,1正常,4挂失

     └─integral

int32

积分

     └─level

int32

等级

     └─growthValue

int32

成长值

     └─registrationTime

string

注册时间(格式:yyyy-MM-dd HH:mm:ss)

     └─memberWechatInfoDTO

object

会员微信信息

          └─openId

string

微信openId

          └─unionId

string

微信unionId

          └─miniProgramOpenId

string

微信小程序openId

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "hbyOpenId": "54",
    "mobile": "1-219-551-0212",
    "name": "ahmad.osinski",
    "sex": 1,
    "birthday": "2024-08-30",
    "email": "lane.mayer@gmail.com",
    "homeAddr": "rxs4xq",
    "storeCode": "68679",
    "balance": 104,
    "state": 2,
    "integral": 433,
    "level": 829,
    "growthValue": 11,
    "registrationTime": "2024-08-30 09:36:37",
    "memberWechatInfoDTO": {
      "openId": "54",
      "unionId": "54",
      "miniProgramOpenId": "54"
    }
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员余额查询

当前版本:  1.0

请求类型:  GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  根据会员openId查询会员余额信息

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

hbyOpenId

string

烘焙云openId

true

请求示例

curl -X GET -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/member/balance?token=ompli5&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a&hbyOpenId=54'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

会员余额信息

     └─balance

number

会员余额

     └─principal

number

本金

     └─giftAmount

number

赠送金

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "balance": 30,
    "principal": 859,
    "giftAmount": 953
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员积分查询

当前版本:  1.0

请求类型:  GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  根据会员openId查询会员积分信息

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

hbyOpenId

string

烘焙云openId

true

请求示例

curl -X GET -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/member/integral?token=vdfyv3&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a&hbyOpenId=54'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

会员积分信息

     └─integral

int32

会员积分

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "integral": 97
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员成长值查询

当前版本:  1.0

请求类型:  GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  根据会员openId查询会员成长值

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

hbyOpenId

string

烘焙云openId

true

请求示例

curl -X GET -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/member/growthValue?token=l1b1x7&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a&hbyOpenId=54'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

会员成长值信息

     └─growthValue

int32

会员成长值

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "growthValue": 643
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员手机号变更

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  会员手机号变更(该接口只进行手机号变更的操作,由调用方负责确认会员身份的合法性验证,避免给原手机号会员的资产产生损失)

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

hbyOpenId

string

烘焙云OpenId

true

mobile

string

变更后手机号

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/member/mobileChange?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=gdev9s' --data '{
  "hbyOpenId": "54",
  "mobile": "1-219-551-0212"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

变更结果

     └─changeResult

boolean

变更结果 true:成功 false:失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "changeResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员密码设置

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  根据会员openId进行会员密码设置(会员没有密码需要设置密码时使用)

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

hbyOpenId

string

烘焙云OpenId

true

password

string

会员密码,6位数字(密文,使用应用秘钥进行AES加密:AES/ECB/PKCS5Padding模式128长度的HEX输出)

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/member/setPassword?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=yn22m3' --data '{
  "hbyOpenId": "54",
  "password": "g8e0m0"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

设置结果

     └─setResult

boolean

设置结果 true:成功 false:失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "setResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员登录密码变更

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  根据会员openId进行会员登录密码变更

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

hbyOpenId

string

烘焙云OpenId

true

oldPwd

string

原登录密码,6位数字(密文,使用应用秘钥进行AES加密:AES/ECB/PKCS5Padding模式128长度的HEX输出)

true

newPwd

string

新登录密码,6位数字(密文,使用应用秘钥进行AES加密:AES/ECB/PKCS5Padding模式128长度的HEX输出)

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/member/loginPasswordChange?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=gif54i' --data '{
  "hbyOpenId": "54",
  "oldPwd": "wsmkfd",
  "newPwd": "vwe46v"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

变更结果

     └─changeResult

boolean

变更结果 true:成功 false:失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "changeResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员等级变更

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  会员等级变更

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

hbyOpenId

string

烘焙云OpenId

true

level

int32

变更后等级

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/member/levelChange?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=ffdlnp' --data '{
  "hbyOpenId": "54",
  "level": 999
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

变更结果

     └─changeResult

boolean

变更结果 true:成功 false:失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "changeResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员登录码生成

当前版本:  1.0

请求类型:  GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  根据会员openId生成烘焙云会员登录码(会员登录码动态生成,有效期150秒)

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

hbyOpenId

string

烘焙云openId

true

请求示例

curl -X GET -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/member/loginCode?token=s9afbx&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a&hbyOpenId=54'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

会员登录码信息

     └─loginCode

string

烘焙云会员登录码(长度15位,格式:HBY000000000001)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "loginCode": "68679"
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 实体卡挂失

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  实体卡挂失

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

hbyOpenId

string

烘焙云OpenId

true

cardCode

string

挂失卡号

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/member/cardReportLoss?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=qr3ucx' --data '{
  "hbyOpenId": "54",
  "cardCode": "68679"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

挂失结果

     └─reportLossResult

boolean

挂失结果 true:成功 false:失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "reportLossResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 实体卡解挂

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  会员实体卡解除挂失状态

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

hbyOpenId

string

烘焙云OpenId

true

cardCode

string

解挂卡号

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/member/cardCancelLoss?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=lyptxy' --data '{
  "hbyOpenId": "54",
  "cardCode": "68679"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

解挂结果

     └─cancelLossResult

boolean

解挂结果 true:成功 false:失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "cancelLossResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员合并

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  被并会员的余额、积分、礼品卡、券等资产会转移到目标会员

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

mergedHbyOpenId

string

被并会员Openid

true

targetHbyOpenId

string

目标会员OpenId

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/member/merge?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=rb63zz' --data '{
  "mergedHbyOpenId": "54",
  "targetHbyOpenId": "54"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

会员合并结果

     └─mergeResult

boolean

合并结果 true:成功 false:失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "mergeResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员余额扣减(标准)

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  会员余额扣减,传入扣减金额

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

hbyOpenId

string

烘焙云OpenId

true

password

string

密码,6位数字(密文,使用应用秘钥进行AES加密:AES/ECB/PKCS5Padding模式128长度的HEX输出)

false

amount

number

金额(单位:元、正数、精确到小数点后两位)

true

tradeCode

string

三方业务单号

true

tradeDetailNo

string

三方流水号

true

storeCode

string

来源门店编码

true

reason

string

原因

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/account/balanceDeduction?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=o80291' --data '{
  "hbyOpenId": "54",
  "password": "c94s3e",
  "amount": 840,
  "tradeCode": "68679",
  "tradeDetailNo": "4aj2ow",
  "storeCode": "68679",
  "reason": "euql0x"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

扣减结果

     └─changeTime

string

变动时间(格式:yyyy-MM-dd HH:mm:ss)

     └─variation

number

变动值

     └─balance

number

变动后余额

     └─principalChangeNum

number

本金变动数量

     └─principalRemain

number

本金变动后值

     └─giftAmountChangeNum

number

赠送金变动数量

     └─giftAmountRemain

number

赠送金变动后值

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "changeTime": "2024-08-30 09:36:37",
    "variation": 456,
    "balance": 986,
    "principalChangeNum": 904,
    "principalRemain": 100,
    "giftAmountChangeNum": 290,
    "giftAmountRemain": 646
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员列表查询

当前版本:  1.0

请求类型:  GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  分页查询会员详细信息列表(仅用于初始化,需要单独申请权限)

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求参数

参数 类型 描述 是否必填

beginTime

string

会员创建开始时间(yyyy-MM-dd HH:mm:ss)

true

endTime

string

会员创建结束时间(yyyy-MM-dd HH:mm:ss),会员创建时间周期不能大于7天

true

请求示例

curl -X GET -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/member/listPage?token=9wskpo&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a&pageNo=1&pageSize=10&beginTime=2024-08-30 09:36:37&endTime=2024-08-30 09:36:37'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

会员详细信息

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─hbyOpenId

string

烘焙云OpenId

          └─mobile

string

手机号

          └─name

string

姓名

          └─sex

int32

性别0:未知;1:男;2:女

          └─birthday

string

生日

          └─email

string

邮箱

          └─homeAddr

string

家庭住址

          └─storeCode

string

来源门店

          └─balance

number

余额

          └─state

int32

会员状态,1正常,4挂失

          └─integral

int32

积分

          └─level

int32

等级

          └─growthValue

int32

成长值

          └─registrationTime

string

注册时间(格式:yyyy-MM-dd HH:mm:ss)

          └─memberWechatInfoDTO

object

会员微信信息

               └─openId

string

微信openId

               └─unionId

string

微信unionId

               └─miniProgramOpenId

string

微信小程序openId

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "hbyOpenId": "54",
        "mobile": "1-219-551-0212",
        "name": "ahmad.osinski",
        "sex": 1,
        "birthday": "2024-08-30",
        "email": "lane.mayer@gmail.com",
        "homeAddr": "arkivl",
        "storeCode": "68679",
        "balance": 705,
        "state": 2,
        "integral": 209,
        "level": 360,
        "growthValue": 705,
        "registrationTime": "2024-08-30 09:36:37",
        "memberWechatInfoDTO": {
          "openId": "54",
          "unionId": "54",
          "miniProgramOpenId": "54"
        }
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员余额扣减(本金赠送金)

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  会员余额扣减,传入扣减本金、扣减赠送金

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

hbyOpenId

string

烘焙云OpenId

true

password

string

密码,6位数字(密文,使用应用秘钥进行AES加密:AES/ECB/PKCS5Padding模式128长度的HEX输出)

false

principal

number

本金(单位:元、正数、精确到小数点后两位)

true

giftAmount

number

赠送金(单位:元、正数、精确到小数点后两位)

true

tradeCode

string

三方业务单号

true

tradeDetailNo

string

三方流水号

true

storeCode

string

来源门店编码

true

reason

string

原因

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/account/balanceDeductionEnhanced?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=gm6hn1' --data '{
  "hbyOpenId": "54",
  "password": "mh802k",
  "principal": 35,
  "giftAmount": 557,
  "tradeCode": "68679",
  "tradeDetailNo": "c2icvn",
  "storeCode": "68679",
  "reason": "49tbyk"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

扣减结果

     └─changeTime

string

变动时间(格式:yyyy-MM-dd HH:mm:ss)

     └─variation

number

变动值

     └─balance

number

变动后余额

     └─principalChangeNum

number

本金变动数量

     └─principalRemain

number

本金变动后值

     └─giftAmountChangeNum

number

赠送金变动数量

     └─giftAmountRemain

number

赠送金变动后值

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "changeTime": "2024-08-30 09:36:37",
    "variation": 410,
    "balance": 929,
    "principalChangeNum": 879,
    "principalRemain": 320,
    "giftAmountChangeNum": 155,
    "giftAmountRemain": 374
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员余额充值

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  会员余额充值

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

hbyOpenId

string

烘焙云OpenId

true

amount

number

金额(单位:元、正数、精确到小数点后两位)

true

giftAmount

number

赠送金额(单位:元、正数、精确到小数点后两位)

false

tradeCode

string

三方业务单号

true

tradeDetailNo

string

三方流水号

true

storeCode

string

来源门店编码

true

reason

string

原因

false

payType

int32

支付方式:0其它3支付宝4微信

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/account/balanceRecharge?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=og0o1t' --data '{
  "hbyOpenId": "54",
  "amount": 924,
  "giftAmount": 5,
  "tradeCode": "68679",
  "tradeDetailNo": "s9kzjs",
  "storeCode": "68679",
  "reason": "m5k8ex",
  "payType": 510
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

充值结果

     └─changeTime

string

变动时间(格式:yyyy-MM-dd HH:mm:ss)

     └─variation

number

变动值

     └─balance

number

变动后余额

     └─principalChangeNum

number

本金变动数量

     └─principalRemain

number

本金变动后值

     └─giftAmountChangeNum

number

赠送金变动数量

     └─giftAmountRemain

number

赠送金变动后值

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "changeTime": "2024-08-30 09:36:37",
    "variation": 843,
    "balance": 461,
    "principalChangeNum": 328,
    "principalRemain": 637,
    "giftAmountChangeNum": 102,
    "giftAmountRemain": 333
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员余额扣减冲正(标准)

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  会员余额扣减冲正,对应会员余额扣减(标准)接口

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

hbyOpenId

string

烘焙云OpenId

true

rushAmount

number

冲正金额(单位:元、正数、精确到小数点后两位)

true

tradeCode

string

三方原业务单号(要被冲正的三方业务单号)

true

rushTradeCode

string

三方冲正业务单号

true

rushTradeDetailNo

string

三方冲正流水号

true

storeCode

string

来源门店编码

true

reason

string

原因

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/account/balanceDeductionRush?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=ifv9eq' --data '{
  "hbyOpenId": "54",
  "rushAmount": 216,
  "tradeCode": "68679",
  "rushTradeCode": "68679",
  "rushTradeDetailNo": "8t3jwl",
  "storeCode": "68679",
  "reason": "6yhetq"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

扣减冲正结果

     └─changeTime

string

变动时间(格式:yyyy-MM-dd HH:mm:ss)

     └─variation

number

变动值

     └─balance

number

变动后余额

     └─principalChangeNum

number

本金变动数量

     └─principalRemain

number

本金变动后值

     └─giftAmountChangeNum

number

赠送金变动数量

     └─giftAmountRemain

number

赠送金变动后值

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "changeTime": "2024-08-30 09:36:37",
    "variation": 917,
    "balance": 171,
    "principalChangeNum": 417,
    "principalRemain": 528,
    "giftAmountChangeNum": 905,
    "giftAmountRemain": 484
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员余额扣减冲正(本金赠送金)

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  会员余额扣减冲正,对应会员余额扣减(本金赠送金)接口

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

hbyOpenId

string

烘焙云OpenId

true

rushPrincipal

number

冲正本金(单位:元、正数、精确到小数点后两位)

true

rushGiftAmount

number

冲正赠送金(单位:元、正数、精确到小数点后两位)

true

tradeCode

string

三方原业务单号(要被冲正的三方业务单号)

true

rushTradeCode

string

三方冲正业务单号

true

rushTradeDetailNo

string

三方冲正流水号

true

storeCode

string

来源门店编码

true

reason

string

原因

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/account/balanceDeductionEnhancedRush?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=hwp27s' --data '{
  "hbyOpenId": "54",
  "rushPrincipal": 155,
  "rushGiftAmount": 483,
  "tradeCode": "68679",
  "rushTradeCode": "68679",
  "rushTradeDetailNo": "za870h",
  "storeCode": "68679",
  "reason": "zx9jhf"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

扣减冲正结果

     └─changeTime

string

变动时间(格式:yyyy-MM-dd HH:mm:ss)

     └─variation

number

变动值

     └─balance

number

变动后余额

     └─principalChangeNum

number

本金变动数量

     └─principalRemain

number

本金变动后值

     └─giftAmountChangeNum

number

赠送金变动数量

     └─giftAmountRemain

number

赠送金变动后值

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "changeTime": "2024-08-30 09:36:37",
    "variation": 441,
    "balance": 358,
    "principalChangeNum": 843,
    "principalRemain": 860,
    "giftAmountChangeNum": 86,
    "giftAmountRemain": 389
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员余额充值冲正

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  会员余额充值冲正

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

hbyOpenId

string

烘焙云OpenId

true

tradeCode

string

三方原业务单号(要被冲正的三方业务单号)(最长36位)

true

rushTradeCode

string

三方冲正业务单号(最长36位)

true

rushTradeDetailNo

string

三方冲正流水号(最长36位)

true

storeCode

string

来源门店编码

true

reason

string

原因

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/account/balanceRechargeRush?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=9hgb3o' --data '{
  "hbyOpenId": "54",
  "tradeCode": "68679",
  "rushTradeCode": "68679",
  "rushTradeDetailNo": "joobbi",
  "storeCode": "68679",
  "reason": "mlsoyt"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

充值冲正结果

     └─changeTime

string

变动时间(格式:yyyy-MM-dd HH:mm:ss)

     └─variation

number

变动值

     └─balance

number

变动后余额

     └─principalChangeNum

number

本金变动数量

     └─principalRemain

number

本金变动后值

     └─giftAmountChangeNum

number

赠送金变动数量

     └─giftAmountRemain

number

赠送金变动后值

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "changeTime": "2024-08-30 09:36:37",
    "variation": 358,
    "balance": 722,
    "principalChangeNum": 339,
    "principalRemain": 565,
    "giftAmountChangeNum": 525,
    "giftAmountRemain": 343
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员余额变动结果查询

当前版本:  1.0

请求类型:  GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  会员余额扣减、扣减冲正、充值、充值冲正等变动结果查询

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

hbyOpenId

string

烘焙云OpenId

true

tradeCode

string

三方业务单号或三方冲正业务单号

true

tradeDetailNo

string

三方流水号或三方冲正流水号

true

请求示例

curl -X GET -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/account/balanceChangeResultQuery?token=p0y16j&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a&hbyOpenId=54&tradeDetailNo=qo1jeq&tradeCode=68679'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

会员余额变动结果

     └─changeTime

string

变动时间(格式:yyyy-MM-dd HH:mm:ss)

     └─variation

number

变动值

     └─balance

number

变动后余额

     └─principalChangeNum

number

本金变动数量

     └─principalRemain

number

本金变动后值

     └─giftAmountChangeNum

number

赠送金变动数量

     └─giftAmountRemain

number

赠送金变动后值

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "changeTime": "2024-08-30 09:36:37",
    "variation": 382,
    "balance": 869,
    "principalChangeNum": 599,
    "principalRemain": 510,
    "giftAmountChangeNum": 453,
    "giftAmountRemain": 619
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 充值卡充值

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  充值卡充值

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

hbyOpenId

string

烘焙云OpenId

true

cardCode

string

充值卡号

true

cardPwd

string

充值卡密码

true

storeCode

string

使用门店编码

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/account/useRechargeCard?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=r1o94u' --data '{
  "hbyOpenId": "54",
  "cardCode": "68679",
  "cardPwd": "ir8xxw",
  "storeCode": "68679"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

充值卡充值结果

     └─rechargeResult

boolean

充值结果 true:成功 false:失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "rechargeResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员余额变动明细

当前版本:  1.0

请求类型:  GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  查询会员余额变动明细

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求参数

参数 类型 描述 是否必填

hbyOpenId

string

烘焙云OpenId

true

operateType

int32

操作类型:1收入2支出

false

beginTime

string

变动开始时间(yyyy-MM-dd HH:mm:ss)

false

endTime

string

变动结束时间(yyyy-MM-dd HH:mm:ss)

false

请求示例

curl -X GET -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/account/balanceChange/listPage?token=dvy3hg&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a&pageNo=1&pageSize=10&operateType=556&beginTime=2024-08-30 09:36:37&endTime=2024-08-30 09:36:37&hbyOpenId=54'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

用户余额变动明细

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─sceneType

int32

变动场景类型(1:消费2:退单3:充值4:取消充值5:积分兑换8:充值赠送9:充值退货11:并卡转移12:旧卡合并15:调账)

          └─sceneName

string

变动场景名称

          └─tradeCode

string

业务编号

          └─storeCode

string

门店编码

          └─tradeDetailNo

string

流水号

          └─changeNum

number

变动数量(如+500,-34)

          └─remain

number

变动后值

          └─principalChangeNum

number

本金变动数量(如+500,-34)

          └─principalRemain

number

本金变动后值

          └─giftAmountChangeNum

number

赠送金变动数量(如+500,-34)

          └─giftAmountRemain

number

赠送金变动后值

          └─reason

string

原因

          └─changeTime

string

变动时间(格式:yyyy-MM-dd HH:mm:ss)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "sceneType": 524,
        "sceneName": "ahmad.osinski",
        "tradeCode": "68679",
        "storeCode": "68679",
        "tradeDetailNo": "ll11r6",
        "changeNum": 275,
        "remain": 277,
        "principalChangeNum": 669,
        "principalRemain": 4,
        "giftAmountChangeNum": 819,
        "giftAmountRemain": 93,
        "reason": "rprug3",
        "changeTime": "2024-08-30 09:36:37"
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员礼品卡查询

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  根据查询条件分页查询会员礼品卡

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求参数

Parameter Type Description Required

hbyOpenId

string

会员OpenId

true

balanceType

int32

余额查询类型:1有余额2没余额

false

state

int32

卡状态:1正常2挂失

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/member/giftCard/page?sign=550652140273bc8c95b81f62acff295a&pageSize=10&timestamp=1724981797&token=ddw2hr&pageNo=1' --data '{
  "hbyOpenId": "54",
  "balanceType": 529,
  "state": 2
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

会员礼品卡

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─code

string

卡号

          └─name

string

名称

          └─faceValue

number

面值

          └─balance

number

余额

          └─principal

number

本金

          └─giftAmount

number

赠送金

          └─redeemTime

string

核销时间

          └─redeemStoreName

string

核销门店名称

          └─redeemOperatorName

string

核销操作人名称

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "code": "68679",
        "name": "ahmad.osinski",
        "faceValue": 978,
        "balance": 454,
        "principal": 797,
        "giftAmount": 329,
        "redeemTime": "2024-08-30 09:36:56",
        "redeemStoreName": "ahmad.osinski",
        "redeemOperatorName": "ahmad.osinski"
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员礼品卡余额扣减

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  会员礼品卡余额余额扣减

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

hbyOpenId

string

烘焙云OpenId

true

cardCodes

array

礼品卡卡号,格式:礼品卡卡号,礼品卡卡号 例如:LP0001,LP0002。为空则按照默认顺序规则扣减

false

amount

number

金额(单位:元、正数、精确到小数点后两位)

true

tradeCode

string

三方业务单号

true

tradeDetailNo

string

三方流水号

true

storeCode

string

来源门店编码

true

remark

string

备注(最长256)

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/account/giftCardBalanceDeduction?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=om0wga' --data '{
  "hbyOpenId": "54",
  "cardCodes": [
    "57yqhp"
  ],
  "amount": 815,
  "tradeCode": "68679",
  "tradeDetailNo": "bz8umi",
  "storeCode": "68679",
  "remark": "qt03pe"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

扣减结果

     └─changeTime

string

变动时间(格式:yyyy-MM-dd HH:mm:ss)

     └─totalChange

number

总变动值

     └─principalChange

number

本金变动值

     └─giftAmountChange

number

赠送金变动值

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "changeTime": "2024-08-30 09:36:37",
    "totalChange": 767,
    "principalChange": 963,
    "giftAmountChange": 712
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员礼品卡余额扣减冲正

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  会员礼品卡余额扣减冲正

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

hbyOpenId

string

烘焙云OpenId

true

rushAmount

number

冲正金额(单位:元、正数、精确到小数点后两位)

true

tradeCode

string

三方原业务单号(要被冲正的三方业务单号)

true

rushTradeCode

string

三方冲正业务单号

true

rushTradeDetailNo

string

三方冲正流水号

true

storeCode

string

来源门店编码

true

remark

string

备注(最长256)

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/account/giftCardBalanceDeductionRush?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=1g8tci' --data '{
  "hbyOpenId": "54",
  "rushAmount": 518,
  "tradeCode": "68679",
  "rushTradeCode": "68679",
  "rushTradeDetailNo": "mtj3rq",
  "storeCode": "68679",
  "remark": "hqelrb"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

冲正结果

     └─changeTime

string

变动时间(格式:yyyy-MM-dd HH:mm:ss)

     └─totalChange

number

总变动值

     └─principalChange

number

本金变动值

     └─giftAmountChange

number

赠送金变动值

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "changeTime": "2024-08-30 09:36:37",
    "totalChange": 465,
    "principalChange": 494,
    "giftAmountChange": 936
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员礼品卡余额变动结果查询

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  会员礼品卡余额扣减、扣减冲正等变动结果查询

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

hbyOpenId

string

烘焙云OpenId

true

tradeCode

string

三方业务单号或三方冲正业务单号

true

tradeDetailNo

string

三方流水号或三方冲正流水号

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/account/giftCardBalanceChangeResult?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=pvyium' --data '{
  "hbyOpenId": "54",
  "tradeCode": "68679",
  "tradeDetailNo": "yqa036"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

会员礼品卡余额变动结果

     └─changeTime

string

变动时间(格式:yyyy-MM-dd HH:mm:ss)

     └─totalChange

number

总变动值

     └─principalChange

number

本金变动值

     └─giftAmountChange

number

赠送金变动值

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "changeTime": "2024-08-30 09:36:37",
    "totalChange": 423,
    "principalChange": 637,
    "giftAmountChange": 916
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员积分变动

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  会员积分变动

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

hbyOpenId

string

烘焙云OpenId

true

tradeCode

string

三方业务单号

true

tradeDetailNo

string

三方流水号

true

type

int32

类型1扣减2增加3消费4冻结5解冻6回补

true

changeNum

int32

变动数量(正整数,范围:1-99999999)

true

storeCode

string

来源门店编码

true

reason

string

原因

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/account/integralChange?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=83k7n0' --data '{
  "hbyOpenId": "54",
  "tradeCode": "68679",
  "tradeDetailNo": "olnh9p",
  "type": 911,
  "changeNum": 867,
  "storeCode": "68679",
  "reason": "6spu0x"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

会员积分变动结果

     └─changeTime

string

变动时间(格式:yyyy-MM-dd HH:mm:ss)

     └─variation

int32

变动值

     └─integral

int32

变更后积分

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "changeTime": "2024-08-30 09:36:37",
    "variation": 795,
    "integral": 663
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员积分变动结果查询

当前版本:  1.0

请求类型:  GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  会员积分变动结果查询

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

hbyOpenId

string

烘焙云OpenId

true

tradeCode

string

三方业务单号

true

tradeDetailNo

string

三方流水号

true

请求示例

curl -X GET -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/account/integralChangeResultQuery?token=a8a8eh&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a&tradeDetailNo=vavknh&hbyOpenId=54&tradeCode=68679'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

会员积分变动结果

     └─changeTime

string

变动时间(格式:yyyy-MM-dd HH:mm:ss)

     └─variation

int32

变动值

     └─integral

int32

变更后积分

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "changeTime": "2024-08-30 09:36:37",
    "variation": 78,
    "integral": 451
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员积分变动明细

当前版本:  1.0

请求类型:  GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  查询会员积分变动明细

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求参数

参数 类型 描述 是否必填

hbyOpenId

string

烘焙云OpenId

true

operateType

int32

操作类型:1收入2支出

false

beginTime

string

变动开始时间(yyyy-MM-dd HH:mm:ss)

false

endTime

string

变动结束时间(yyyy-MM-dd HH:mm:ss)

false

请求示例

curl -X GET -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/account/integralChange/listPage?token=msgz65&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a&pageNo=1&pageSize=10&beginTime=2024-08-30 09:36:37&operateType=235&hbyOpenId=54&endTime=2024-08-30 09:36:37'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

用户积分变动明细

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─sceneType

int32

变动场景类型(1消费2退单3充值4取消充值5积分兑换6购物赠送7购物退货8充值赠送9充值退货10评价赠送11并卡转移12旧卡合并13积分抵扣14积分过期)

          └─sceneName

string

变动场景名称

          └─tradeCode

string

业务编号

          └─storeCode

string

门店编码

          └─tradeDetailNo

string

流水号

          └─changeNum

number

变动数量(如+500,-34)

          └─remain

number

变动后值

          └─reason

string

原因

          └─changeTime

string

变动时间(格式:yyyy-MM-dd HH:mm:ss)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "sceneType": 779,
        "sceneName": "ahmad.osinski",
        "tradeCode": "68679",
        "storeCode": "68679",
        "tradeDetailNo": "r4tn7w",
        "changeNum": 192,
        "remain": 770,
        "reason": "nit4l6",
        "changeTime": "2024-08-30 09:36:37"
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员成长值变动

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  会员成长值变动

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

hbyOpenId

string

烘焙云OpenId

true

type

int32

类型1扣减2增加

true

changeNum

int32

变动数量

true

tradeCode

string

三方业务单号

true

tradeDetailNo

string

三方流水号

true

storeCode

string

来源门店编码

true

reason

string

原因

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/account/growthValueChange?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=4bf7ed' --data '{
  "hbyOpenId": "54",
  "type": 173,
  "changeNum": 758,
  "tradeCode": "68679",
  "tradeDetailNo": "fvko7q",
  "storeCode": "68679",
  "reason": "fnyj78"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

会员成长值变动结果

     └─changeTime

string

变动时间(格式:yyyy-MM-dd HH:mm:ss)

     └─variation

int32

变动值

     └─growthValue

int32

变更后成长值

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "changeTime": "2024-08-30 09:36:37",
    "variation": 615,
    "growthValue": 696
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员成长值变动结果查询

当前版本:  1.0

请求类型:  GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  会员成长值变动结果查询

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

hbyOpenId

string

烘焙云OpenId

true

tradeCode

string

三方业务单号

true

tradeDetailNo

string

三方流水号

true

请求示例

curl -X GET -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/account/growthValueChangeQuery?token=ho3m1b&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a&tradeCode=68679&hbyOpenId=54&tradeDetailNo=797q9e'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

会员成长值变动结果

     └─changeTime

string

变动时间(格式:yyyy-MM-dd HH:mm:ss)

     └─variation

int32

变动值

     └─growthValue

int32

变更后成长值

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "changeTime": "2024-08-30 09:36:37",
    "variation": 926,
    "growthValue": 60
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 会员卡余额变动明细查询

当前版本:  1.0

请求类型:  GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  根据日期周期查询会员卡余额变动明细(最大日期周期为一天,需要单独申请权限)

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=500)

true

请求参数

参数 类型 描述 是否必填

beginTime

string

变动开始时间(yyyy-MM-dd HH:mm:ss),开始结束时间周期不能超过一天

true

endTime

string

变动结束时间(yyyy-MM-dd HH:mm:ss),开始结束时间周期不能超过一天

true

请求示例

curl -X GET -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/account/balanceChange/queryPage?token=dk0u7s&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a&pageNo=1&pageSize=10&beginTime=2024-08-30 09:36:37&endTime=2024-08-30 09:36:37'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

会员卡余额变动明细分页信息

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─sceneType

int32

变动场景类型(1:消费2:退单3:充值4:取消充值5:积分兑换8:充值赠送9:充值退货11:并卡转移12:旧卡合并15:调账)

          └─sceneName

string

变动场景名称

          └─tradeCode

string

业务编号

          └─storeCode

string

门店编码

          └─tradeDetailNo

string

流水号

          └─changeNum

number

变动数量(如+500,-34)

          └─remain

number

变动后值

          └─principalChangeNum

number

本金变动数量(如+500,-34)

          └─principalRemain

number

本金变动后值

          └─giftAmountChangeNum

number

赠送金变动数量(如+500,-34)

          └─giftAmountRemain

number

赠送金变动后值

          └─reason

string

原因

          └─changeTime

string

变动时间(格式:yyyy-MM-dd HH:mm:ss)

          └─hbyOpenId

string

烘焙云OpenId

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "sceneType": 650,
        "sceneName": "ahmad.osinski",
        "tradeCode": "68679",
        "storeCode": "68679",
        "tradeDetailNo": "drdzfw",
        "changeNum": 856,
        "remain": 336,
        "principalChangeNum": 872,
        "principalRemain": 729,
        "giftAmountChangeNum": 63,
        "giftAmountRemain": 477,
        "reason": "sh7l6o",
        "changeTime": "2024-08-30 09:36:37",
        "hbyOpenId": "54"
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

4.9. 订单

 批量查询订单详情

当前版本:  2.0

请求类型:  GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  根据单号列表查询订单,返回订单详细信息,包括订单基础信息、商品信息、优惠信息、赠送信息、物流信息、支付信息,一次最多允许传入20个单号\n注意:此接口返回的订单数据有一定延时,
如果需要实时数据建议使用/detail

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

codes

array

烘焙云单号列表 示例:SC2005311100020300WX99,SC2005311100020300WX99

true

请求示例

curl -X GET -k -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/order/list/bycodes?token=y9rjk5&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a&codes=wqzog6'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

array

订单详细信息

     └─orderBase

object

订单基础信息

          └─code

string

烘焙云单号

          └─quoteCode

string

第三方单号

          └─state

int32

订单状态:.0 待付款,1 已取消,2 待接单,3 待发货/代提货/预定成功,4 取消预定成功,5 待收货,6 收货/提货/交易成功 7 交易关闭 ,9 退单成功

          └─platform

int32

平台 - 1烘焙云 2美团 3饿了么 4口碑

          └─channel

int32

渠道 - 0其它 1门店 2总部 3商城 4拼团 5秒杀 6外卖

          └─terminal

int32

终端 - 0其它 1门店pos 2门店自助收银 3H5 4小程序

          └─scene

int32

场景 - 1 销售(用于门店直接销售场景) 2 预定(用于先付款,后交付场景)

          └─orderType

int32

订单类型 - 1销售单 2普通预定 5积分兑换

          └─buyerType

int32

买家类型:1普通顾客 2会员

          └─buyerId

string

买家ID(会员openId),买家类型为会员时必填

          └─buyerName

string

买家名称,买家类型为会员时必填

          └─buyerMobile

string

买家手机号码,买家类型为会员时必填

          └─buyerCardCode

string

买家卡号

          └─consigneeName

string

提货/收货人姓名

          └─consigneeMobile

string

提货/收货人手机号

          └─sellerRemark

string

卖家备注(256字以内)

          └─buyerRemark

string

买家备注(128字以内)

          └─storeName

string

下单门店名称

          └─storeCode

string

下单门店编码

          └─takeStoreName

string

履约门店名称

          └─takeStoreCode

string

履约门店编码

          └─produceStoreName

string

生产门店名称

          └─produceStoreCode

string

生产门店编码

          └─preOrderTime

string

下单时间(格式:yyyy-MM-dd HH:mm:ss)

          └─payedTime

string

支付完成时间(格式:yyyy-MM-dd HH:mm:ss)

          └─preTakeTime

string

预定提货时间(格式:yyyy-MM-dd HH:mm:ss)

          └─cancelReserveTime

string

取消预定时间(格式:yyyy-MM-dd HH:mm:ss)

          └─completedTime

string

交易完成时间(格式:yyyy-MM-dd HH:mm:ss)

          └─returnedTime

string

退货时间(格式:yyyy-MM-dd HH:mm:ss)

          └─deliveryTime

string

发货时间(格式:yyyy-MM-dd HH:mm:ss)

          └─refundedTime

string

退款时间(格式:yyyy-MM-dd HH:mm:ss)

          └─totalAmount

number

订单总金额

          └─payAmount

number

实付金额

          └─discountAmount

number

优惠金额

          └─takeCertNo

string

取货凭证号

          └─operatorName

string

操作人名称

          └─customerCode

string

大客户编码

          └─refundState

int32

退款状态0未退款1部分退款成功2全额退款成功

          └─boxAmount

number

餐盒费

          └─serviceFee

number

服务费(抽佣)

          └─otherAmount

number

其它费用合计

     └─goodsDetails

array

订单商品明细集合

          └─materialCode

string

物料序号

          └─materialLabel

string

物料名称

          └─goodsCode

string

商品编码

          └─goodsName

string

商品名称

          └─skuId

string

skuId

          └─skuValue

string

sku名称

          └─isGift

int32

是否赠品 1:是 ,0:否

          └─num

number

商品数量

          └─originalPrice

number

原价

          └─sellsPrice

number

售价

          └─totalDiscountAmount

number

合计优惠金额

          └─totalRealAmount

number

合计实付金额

          └─goodsType

int32

商品分类 1实物 2虚拟

     └─orderDiscounts

array

订单优惠信息

          └─materialCode

string

物料序号

          └─materialName

string

物料名称

          └─goodsCode

string

商品编码

          └─goodsName

string

商品名称

          └─skuId

string

skuId

          └─skuValue

string

sku描述

          └─num

number

物料数量

          └─discountScene

int32

优惠场景 :1预售 2预定、销售、积分兑换 3提货

          └─discountType

int32

优惠类型 :1整单优惠 2商品优惠

          └─discountMode

int32

优惠方式:0其它 1优惠券 2积分支付 3积分兑换 4活动 5会员价 6手工折扣 7手工折让 8舍入 9协议价

          └─shareType

int32

计算分摊方式 1均摊(整单级优惠) 2商品独享(商品级优惠)

          └─title

string

优惠标题

          └─cost

string

消耗内容(积分数量、券号)

          └─discountAmount

number

优惠金额

          └─discountCost

number

优惠成本

          └─couponExtraInfo

object

券优惠扩展信息(只有烘焙云订单包含此信息)

               └─identifier

string

券核销标识

               └─platform

int32

券平台

     └─orderGifts

array

订单赠品信息

          └─source

int32

赠品来源 1活动赠送 2基础赠送

          └─type

int32

赠品分类 1实物 2虚拟

          └─giftType

int32

赠品类型 0其它 1商品 2券 3积分 4余额 5成长值

          └─name

string

赠品名称

          └─giftValue

string

赠品内容 物料序号/券号

          └─giftNum

number

赠送数量

     └─orderDistribute

object

订单物流信息

          └─consigneeType

int32

收货方式:1自提 2商家配送 3第三方物流

          └─payType

int32

邮费支付方式 1预付 2到付 3包邮

          └─postage

number

运费

          └─preUserName

string

下单人姓名

          └─preUserMobile

string

下单人手机号

          └─consigneeName

string

收货人姓名

          └─consigneeAddress

string

收货人详细地址

          └─consigneeMobile

string

收货人手机号

          └─consigneeProvinceCode

string

收货人省-代码

          └─consigneeProvinceName

string

收货人省-名称

          └─consigneeCityCode

string

收货人市-代码

          └─consigneeCityName

string

收货人市-名称

          └─consigneeAreaCode

string

收货人区-代码

          └─consigneeAreaName

string

收货人区-名称

          └─consigneeLongitude

string

收货人 - 经度

          └─consigneeLatitude

string

收货人 - 纬度

     └─settlementFlows

array

订单支付详情集合

          └─code

string

流水编码

          └─storeCode

string

门店编码

          └─operationScene

int32

操作类型1支付 2退款

          └─businessScene

int32

业务场景 1销售 2预付款 3尾款 4积分兑换

          └─payType

int32

支付方式 0其它 3支付宝 4微信 5会员卡

          └─payTitle

string

支付方式名

          └─payerType

int32

支付方类型 1买家 2商家 3支付服务商

          └─buyerId

string

会员ID

          └─amount

number

支付金额(精确到小数点后两位)

          └─amountType

int32

金额类型:1 本金 2 赠送金

          └─createdTime

string

业务时间 (支付/退款发生时间。格式:yyyy-MM-dd HH:mm:ss)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": [
    {
      "orderBase": {
        "code": "68679",
        "quoteCode": "68679",
        "state": 2,
        "platform": 160,
        "channel": 536,
        "terminal": 821,
        "scene": 194,
        "orderType": 342,
        "buyerType": 444,
        "buyerId": "54",
        "buyerName": "ahmad.osinski",
        "buyerMobile": "1-219-551-0212",
        "buyerCardCode": "68679",
        "consigneeName": "ahmad.osinski",
        "consigneeMobile": "1-219-551-0212",
        "sellerRemark": "pr35zh",
        "buyerRemark": "3wot2j",
        "storeName": "ahmad.osinski",
        "storeCode": "68679",
        "takeStoreName": "ahmad.osinski",
        "takeStoreCode": "68679",
        "produceStoreName": "ahmad.osinski",
        "produceStoreCode": "68679",
        "preOrderTime": "2024-08-30 09:36:37",
        "payedTime": "2024-08-30 09:36:37",
        "preTakeTime": "2024-08-30 09:36:37",
        "cancelReserveTime": "2024-08-30 09:36:37",
        "completedTime": "2024-08-30 09:36:37",
        "returnedTime": "2024-08-30 09:36:37",
        "deliveryTime": "2024-08-30 09:36:37",
        "refundedTime": "2024-08-30 09:36:37",
        "totalAmount": 366,
        "payAmount": 566,
        "discountAmount": 623,
        "takeCertNo": "6g947k",
        "operatorName": "ahmad.osinski",
        "customerCode": "68679",
        "refundState": 2,
        "boxAmount": 625,
        "serviceFee": 349,
        "otherAmount": 161
      },
      "goodsDetails": [
        {
          "materialCode": "68679",
          "materialLabel": "hq5jyx",
          "goodsCode": "68679",
          "goodsName": "ahmad.osinski",
          "skuId": "54",
          "skuValue": "b36rqt",
          "isGift": 83,
          "num": 587,
          "originalPrice": 95,
          "sellsPrice": 453,
          "totalDiscountAmount": 403,
          "totalRealAmount": 630,
          "goodsType": 864
        }
      ],
      "orderDiscounts": [
        {
          "materialCode": "68679",
          "materialName": "ahmad.osinski",
          "goodsCode": "68679",
          "goodsName": "ahmad.osinski",
          "skuId": "54",
          "skuValue": "6noc0j",
          "num": 366,
          "discountScene": 654,
          "discountType": 124,
          "discountMode": 55,
          "shareType": 541,
          "title": "k7awc9",
          "cost": "fu8e5u",
          "discountAmount": 961,
          "discountCost": 614,
          "couponExtraInfo": {
            "identifier": "idzhr7",
            "platform": 111
          }
        }
      ],
      "orderGifts": [
        {
          "source": 919,
          "type": 517,
          "giftType": 640,
          "name": "ahmad.osinski",
          "giftValue": "8ipl2e",
          "giftNum": 541
        }
      ],
      "orderDistribute": {
        "consigneeType": 338,
        "payType": 229,
        "postage": 311,
        "preUserName": "ahmad.osinski",
        "preUserMobile": "1-219-551-0212",
        "consigneeName": "ahmad.osinski",
        "consigneeAddress": "9555 Wilfred Plains, North Felixmouth, MI 78129",
        "consigneeMobile": "1-219-551-0212",
        "consigneeProvinceCode": "68679",
        "consigneeProvinceName": "ahmad.osinski",
        "consigneeCityCode": "68679",
        "consigneeCityName": "ahmad.osinski",
        "consigneeAreaCode": "68679",
        "consigneeAreaName": "ahmad.osinski",
        "consigneeLongitude": "jhfymt",
        "consigneeLatitude": "n7j9gh"
      },
      "settlementFlows": [
        {
          "code": "68679",
          "storeCode": "68679",
          "operationScene": 220,
          "businessScene": 871,
          "payType": 434,
          "payTitle": "rva1g7",
          "payerType": 498,
          "buyerId": "54",
          "amount": 466,
          "amountType": 810,
          "createdTime": "2024-08-30 09:36:37"
        }
      ]
    }
  ],
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 查询订单详情

当前版本:  2.0

请求类型:  GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  根据单号查询单个订单详细信息。

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

code

string

烘焙云单号

true

请求示例

curl -X GET -k -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/order/detail?token=vzw1f9&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a&code=68679'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

订单详细信息

     └─orderBase

object

订单基础信息

          └─code

string

烘焙云单号

          └─quoteCode

string

第三方单号

          └─state

int32

订单状态:.0 待付款,1 已取消,2 待接单,3 待发货/代提货/预定成功,4 取消预定成功,5 待收货,6 收货/提货/交易成功 7 交易关闭 ,9 退单成功

          └─platform

int32

平台 - 1烘焙云 2美团 3饿了么 4口碑

          └─channel

int32

渠道 - 0其它 1门店 2总部 3商城 4拼团 5秒杀 6外卖

          └─terminal

int32

终端 - 0其它 1门店pos 2门店自助收银 3H5 4小程序

          └─scene

int32

场景 - 1 销售(用于门店直接销售场景) 2 预定(用于先付款,后交付场景)

          └─orderType

int32

订单类型 - 1销售单 2普通预定 5积分兑换

          └─buyerType

int32

买家类型:1普通顾客 2会员

          └─buyerId

string

买家ID(会员openId),买家类型为会员时必填

          └─buyerName

string

买家名称,买家类型为会员时必填

          └─buyerMobile

string

买家手机号码,买家类型为会员时必填

          └─buyerCardCode

string

买家卡号

          └─consigneeName

string

提货/收货人姓名

          └─consigneeMobile

string

提货/收货人手机号

          └─sellerRemark

string

卖家备注(256字以内)

          └─buyerRemark

string

买家备注(128字以内)

          └─storeName

string

下单门店名称

          └─storeCode

string

下单门店编码

          └─takeStoreName

string

履约门店名称

          └─takeStoreCode

string

履约门店编码

          └─produceStoreName

string

生产门店名称

          └─produceStoreCode

string

生产门店编码

          └─preOrderTime

string

下单时间(格式:yyyy-MM-dd HH:mm:ss)

          └─payedTime

string

支付完成时间(格式:yyyy-MM-dd HH:mm:ss)

          └─preTakeTime

string

预定提货时间(格式:yyyy-MM-dd HH:mm:ss)

          └─cancelReserveTime

string

取消预定时间(格式:yyyy-MM-dd HH:mm:ss)

          └─completedTime

string

交易完成时间(格式:yyyy-MM-dd HH:mm:ss)

          └─returnedTime

string

退货时间(格式:yyyy-MM-dd HH:mm:ss)

          └─deliveryTime

string

发货时间(格式:yyyy-MM-dd HH:mm:ss)

          └─refundedTime

string

退款时间(格式:yyyy-MM-dd HH:mm:ss)

          └─totalAmount

number

订单总金额

          └─payAmount

number

实付金额

          └─discountAmount

number

优惠金额

          └─takeCertNo

string

取货凭证号

          └─operatorName

string

操作人名称

          └─customerCode

string

大客户编码

          └─refundState

int32

退款状态0未退款1部分退款成功2全额退款成功

          └─boxAmount

number

餐盒费

          └─serviceFee

number

服务费(抽佣)

          └─otherAmount

number

其它费用合计

     └─goodsDetails

array

订单商品明细集合

          └─materialCode

string

物料序号

          └─materialLabel

string

物料名称

          └─goodsCode

string

商品编码

          └─goodsName

string

商品名称

          └─skuId

string

skuId

          └─skuValue

string

sku名称

          └─isGift

int32

是否赠品 1:是 ,0:否

          └─num

number

商品数量

          └─originalPrice

number

原价

          └─sellsPrice

number

售价

          └─totalDiscountAmount

number

合计优惠金额

          └─totalRealAmount

number

合计实付金额

          └─goodsType

int32

商品分类 1实物 2虚拟

     └─orderDiscounts

array

订单优惠信息

          └─materialCode

string

物料序号

          └─materialName

string

物料名称

          └─goodsCode

string

商品编码

          └─goodsName

string

商品名称

          └─skuId

string

skuId

          └─skuValue

string

sku描述

          └─num

number

物料数量

          └─discountScene

int32

优惠场景 :1预售 2预定、销售、积分兑换 3提货

          └─discountType

int32

优惠类型 :1整单优惠 2商品优惠

          └─discountMode

int32

优惠方式:0其它 1优惠券 2积分支付 3积分兑换 4活动 5会员价 6手工折扣 7手工折让 8舍入 9协议价

          └─shareType

int32

计算分摊方式 1均摊(整单级优惠) 2商品独享(商品级优惠)

          └─title

string

优惠标题

          └─cost

string

消耗内容(积分数量、券号)

          └─discountAmount

number

优惠金额

          └─discountCost

number

优惠成本

          └─couponExtraInfo

object

券优惠扩展信息(只有烘焙云订单包含此信息)

               └─identifier

string

券核销标识

               └─platform

int32

券平台

     └─orderGifts

array

订单赠品信息

          └─source

int32

赠品来源 1活动赠送 2基础赠送

          └─type

int32

赠品分类 1实物 2虚拟

          └─giftType

int32

赠品类型 0其它 1商品 2券 3积分 4余额 5成长值

          └─name

string

赠品名称

          └─giftValue

string

赠品内容 物料序号/券号

          └─giftNum

number

赠送数量

     └─orderDistribute

object

订单物流信息

          └─consigneeType

int32

收货方式:1自提 2商家配送 3第三方物流

          └─payType

int32

邮费支付方式 1预付 2到付 3包邮

          └─postage

number

运费

          └─preUserName

string

下单人姓名

          └─preUserMobile

string

下单人手机号

          └─consigneeName

string

收货人姓名

          └─consigneeAddress

string

收货人详细地址

          └─consigneeMobile

string

收货人手机号

          └─consigneeProvinceCode

string

收货人省-代码

          └─consigneeProvinceName

string

收货人省-名称

          └─consigneeCityCode

string

收货人市-代码

          └─consigneeCityName

string

收货人市-名称

          └─consigneeAreaCode

string

收货人区-代码

          └─consigneeAreaName

string

收货人区-名称

          └─consigneeLongitude

string

收货人 - 经度

          └─consigneeLatitude

string

收货人 - 纬度

     └─settlementFlows

array

订单支付详情集合

          └─code

string

流水编码

          └─storeCode

string

门店编码

          └─operationScene

int32

操作类型1支付 2退款

          └─businessScene

int32

业务场景 1销售 2预付款 3尾款 4积分兑换

          └─payType

int32

支付方式 0其它 3支付宝 4微信 5会员卡

          └─payTitle

string

支付方式名

          └─payerType

int32

支付方类型 1买家 2商家 3支付服务商

          └─buyerId

string

会员ID

          └─amount

number

支付金额(精确到小数点后两位)

          └─amountType

int32

金额类型:1 本金 2 赠送金

          └─createdTime

string

业务时间 (支付/退款发生时间。格式:yyyy-MM-dd HH:mm:ss)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "orderBase": {
      "code": "68679",
      "quoteCode": "68679",
      "state": 2,
      "platform": 350,
      "channel": 7,
      "terminal": 279,
      "scene": 813,
      "orderType": 185,
      "buyerType": 13,
      "buyerId": "54",
      "buyerName": "ahmad.osinski",
      "buyerMobile": "1-219-551-0212",
      "buyerCardCode": "68679",
      "consigneeName": "ahmad.osinski",
      "consigneeMobile": "1-219-551-0212",
      "sellerRemark": "1gmaok",
      "buyerRemark": "1u1rzp",
      "storeName": "ahmad.osinski",
      "storeCode": "68679",
      "takeStoreName": "ahmad.osinski",
      "takeStoreCode": "68679",
      "produceStoreName": "ahmad.osinski",
      "produceStoreCode": "68679",
      "preOrderTime": "2024-08-30 09:36:37",
      "payedTime": "2024-08-30 09:36:37",
      "preTakeTime": "2024-08-30 09:36:37",
      "cancelReserveTime": "2024-08-30 09:36:37",
      "completedTime": "2024-08-30 09:36:37",
      "returnedTime": "2024-08-30 09:36:37",
      "deliveryTime": "2024-08-30 09:36:37",
      "refundedTime": "2024-08-30 09:36:37",
      "totalAmount": 639,
      "payAmount": 347,
      "discountAmount": 337,
      "takeCertNo": "xwz5d1",
      "operatorName": "ahmad.osinski",
      "customerCode": "68679",
      "refundState": 2,
      "boxAmount": 199,
      "serviceFee": 202,
      "otherAmount": 838
    },
    "goodsDetails": [
      {
        "materialCode": "68679",
        "materialLabel": "prl1zj",
        "goodsCode": "68679",
        "goodsName": "ahmad.osinski",
        "skuId": "54",
        "skuValue": "8dx1r7",
        "isGift": 657,
        "num": 503,
        "originalPrice": 90,
        "sellsPrice": 912,
        "totalDiscountAmount": 578,
        "totalRealAmount": 416,
        "goodsType": 518
      }
    ],
    "orderDiscounts": [
      {
        "materialCode": "68679",
        "materialName": "ahmad.osinski",
        "goodsCode": "68679",
        "goodsName": "ahmad.osinski",
        "skuId": "54",
        "skuValue": "mroi5q",
        "num": 875,
        "discountScene": 482,
        "discountType": 243,
        "discountMode": 461,
        "shareType": 420,
        "title": "m29hm2",
        "cost": "ufxlzy",
        "discountAmount": 119,
        "discountCost": 361,
        "couponExtraInfo": {
          "identifier": "ggqdu7",
          "platform": 696
        }
      }
    ],
    "orderGifts": [
      {
        "source": 621,
        "type": 217,
        "giftType": 700,
        "name": "ahmad.osinski",
        "giftValue": "99qy2p",
        "giftNum": 342
      }
    ],
    "orderDistribute": {
      "consigneeType": 77,
      "payType": 284,
      "postage": 507,
      "preUserName": "ahmad.osinski",
      "preUserMobile": "1-219-551-0212",
      "consigneeName": "ahmad.osinski",
      "consigneeAddress": "9555 Wilfred Plains, North Felixmouth, MI 78129",
      "consigneeMobile": "1-219-551-0212",
      "consigneeProvinceCode": "68679",
      "consigneeProvinceName": "ahmad.osinski",
      "consigneeCityCode": "68679",
      "consigneeCityName": "ahmad.osinski",
      "consigneeAreaCode": "68679",
      "consigneeAreaName": "ahmad.osinski",
      "consigneeLongitude": "zunn9b",
      "consigneeLatitude": "oqp4wp"
    },
    "settlementFlows": [
      {
        "code": "68679",
        "storeCode": "68679",
        "operationScene": 408,
        "businessScene": 722,
        "payType": 886,
        "payTitle": "m9mv3y",
        "payerType": 556,
        "buyerId": "54",
        "amount": 287,
        "amountType": 834,
        "createdTime": "2024-08-30 09:36:37"
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 创建订单

当前版本:  2.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  创建订单

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

quoteCode

string

第三方单号(32位以内)

true

channel

int32

渠道 - 0其它 1门店 2总部 3商城 4拼团 5秒杀 6外卖

true

terminal

int32

终端 - 0其它 1门店pos 2门店自助收银 3H5 4小程序 5APP

true

scene

int32

场景 - 1 销售(用于门店直接销售场景) 2 预定(用于先付款,后交付场景)

true

orderType

int32

订单类型 - 1销售单 2普通预定 5积分兑换

true

storeCode

string

下单门店编码

true

takeStoreCode

string

履约门店编码

true

produceStoreCode

string

生产门店编码

false

buyerType

int32

买家类型:1普通顾客 2会员

true

buyerId

string

买家ID(会员openId),买家类型为会员时必填

false

buyerName

string

买家名称,买家类型为会员时必填(32位以内)

false

buyerMobile

string

买家手机号码,买家类型为会员时必填

false

buyerRemark

string

买家备注(128字以内)

false

sellerRemark

string

卖家备注(256字以内)

false

preOrderTime

string

下单时间(格式:yyyy-MM-dd HH:mm:ss)

true

payedTime

string

支付完成时间(格式:yyyy-MM-dd HH:mm:ss)

false

preTakeTime

string

预订履约时间(格式:yyyy-MM-dd HH:mm:ss)
自提单和配送单必传

false

totalAmount

number

订单总额(精确到小数点后两位)
订单总金额 = 商品总计实付 + 商品总计优惠 + 邮费等额外费用

true

payAmount

number

实付金额(精确到小数点后两位)
实付金额 <= 订单总额 - 优惠总额
实付金额 = 各流水金额总计

true

discountAmount

number

优惠总额(精确到小数点后两位)
优惠金额 = 各优惠记录金额总计

true

takeCertNo

string

取货凭证号(16位)

false

operatorName

string

操作人名称(16位)

false

goodsDetails

array

商品详细信息

true

└─goodsCode

string

第三方商品编码(16)

false

└─goodsName

string

第三方商品名称

true

└─materialCode

string

物料序号
对应烘焙云线下商品查询接口返回的物料序号(历史对接方式,不推荐使用)
如果对接了三方商品,可以转填skuId字段

false

└─goodsType

int32

商品类型 1实物 2虚拟(电子卡券)

true

└─skuId

string

三方skuID
调用烘焙云三方商品创建接口时返回的三方商品sku编码

false

└─skuValue

string

第三方sku属性(列:六寸 蓝色),三方提供的sku描述,做展示用

false

└─url

string

第三方商品图片url(256位)

false

└─isGift

int32

是否赠品 1是 0否

true

└─num

number

商品数量

true

└─originalPrice

number

原价(划线价,精确到小数点后两位)

true

└─sellsPrice

number

售价(未计算优惠前的商品销售价格,精确到小数点后两位)

true

└─totalDiscountAmount

number

合计优惠金额(应用到该商品上的优惠合计(含活动、券等),精确到小数点后两位)

true

└─totalRealAmount

number

合计实付金额(扣除商品级优惠后的实付金额,精确到小数点后两位)
说明:合计实付金额 = 商品售价 * 商品数量 - 合计优惠金额

true

└─remark

string

商品备注(256位)

false

orderDiscounts

array

优惠信息

false

└─discountType

int32

优惠类型 :1整单优惠 2单品优惠

true

└─materialCode

string

物料序号
单品优惠必填(历史对接方式,不推荐使用)
如果对接了三方商品,可以转填skuId字段

false

└─goodsCode

string

第三方商品编码

false

└─goodsName

string

第三方商品名称 单品优惠必填

false

└─skuId

string

调用烘焙云三方商品创建接口时返回的三方商品sku编码

false

└─skuValue

string

第三方商品SKU属性(列:六寸 蓝色)

false

└─num

number

物料数量 单品优惠必填

false

└─discountScene

int32

优惠场景 1预售 2预定、销售、积分兑换 3提货

true

└─discountMode

int32

优惠方式:0其它 1优惠券 2积分支付 3积分兑换 4活动 5会员价 6手工折扣 7手工折让 8舍入 9协议价

true

└─shareType

int32

计算分摊方式 1均摊(整单级优惠) 2商品独享(商品级优惠)

true

└─title

string

优惠标题(第三方活动名称)

false

└─cost

string

消耗内容(积分数量、券号)

false

└─discountAmount

number

优惠金额(本条优惠记录总计优惠金额,精确到小数点后两位)

true

└─discountCost

number

优惠成本(精确到小数点后两位)
例:使用优惠券在订单内抵扣了10元,但是优惠券销售时售价8元,此处记录8.00

false

orderGifts

array

赠品信息

false

└─source

int32

赠品来源 1活动赠送 2基础赠送

true

└─type

int32

赠品分类 1实物 2虚拟(电子卡、券)

true

└─giftType

int32

赠品类型 0其它 1商品 2券 3积分 4余额 5成长值

true

└─name

string

赠品名称

true

└─giftValue

string

赠品内容(32位) 如:物料序号、单个券号。
物料序号特殊说明:如果对接了三方商品,使用三方商品sku编码,即与订单商品详细信息中的skuId相同的值

false

└─giftNum

number

赠送数量

true

orderDistribute

object

物流配送信息

false

└─consigneeType

int32

收货方式:1自提 2商家配送 3第三方物流
备注:自提方式可以只填写收货人部分信息

true

└─payType

int32

运费支付方式 1预付 2到付 3包邮

false

└─postage

number

运费

false

└─preUserName

string

下单人姓名

false

└─preUserMobile

string

下单人手机号

false

└─consigneeName

string

收货人姓名

false

└─consigneeAddress

string

收货人详细地址

false

└─consigneeMobile

string

收货人手机号,可以填写座机和手机,没有强校验

false

└─consigneeProvinceCode

string

收货人省-国标码

false

└─consigneeProvinceName

string

收货人省-名称

false

└─consigneeCityCode

string

收货人市-国标码

false

└─consigneeCityName

string

收货人市-名称

false

└─consigneeAreaCode

string

收货人区-国标码

false

└─consigneeAreaName

string

收货人区-名称

false

└─consigneeLongitude

string

收货人 - 经度(腾讯)

false

└─consigneeLatitude

string

收货人 - 纬度(腾讯)

false

settlementFlows

array

支付流水信息

false

└─storeCode

string

门店编码

true

└─code

string

流水编号

true

└─batchCode

string

批次号(用于多阶段付款)

true

└─businessScene

int32

业务场景 1销售 2预付款 3尾款 4积分兑换

true

└─payType

int32

支付方式 0其它 3支付宝 4微信 5会员卡余额 204礼品卡
如需对接详细支付方式,可以在烘焙云控制台【系统】-【系统配置】-【支付配置】功能模块内查看支付方式

true

└─payTitle

string

支付方式名

true

└─buyerId

string

会员OpenId

false

└─amount

number

支付金额(精确到小数点后两位)

true

└─createdTime

string

业务时间 (支付/退款发生时间。格式:yyyy-MM-dd HH:mm:ss)

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/order/create?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=3tznlw' --data '{
  "quoteCode": "68679",
  "channel": 657,
  "terminal": 680,
  "scene": 245,
  "orderType": 392,
  "storeCode": "68679",
  "takeStoreCode": "68679",
  "produceStoreCode": "68679",
  "buyerType": 813,
  "buyerId": "54",
  "buyerName": "ahmad.osinski",
  "buyerMobile": "1-219-551-0212",
  "buyerRemark": "lobgyt",
  "sellerRemark": "8lrr7v",
  "preOrderTime": "2024-08-30 09:36:37",
  "payedTime": "2024-08-30 09:36:37",
  "preTakeTime": "2024-08-30 09:36:37",
  "totalAmount": 614,
  "payAmount": 329,
  "discountAmount": 346,
  "takeCertNo": "s41nzu",
  "operatorName": "ahmad.osinski",
  "goodsDetails": [
    {
      "goodsCode": "68679",
      "goodsName": "ahmad.osinski",
      "materialCode": "68679",
      "goodsType": 863,
      "skuId": "54",
      "skuValue": "hb17oj",
      "url": "www.dominic-howell.org",
      "isGift": 506,
      "num": 371,
      "originalPrice": 424,
      "sellsPrice": 536,
      "totalDiscountAmount": 451,
      "totalRealAmount": 593,
      "remark": "ybcc7p"
    }
  ],
  "orderDiscounts": [
    {
      "discountType": 714,
      "materialCode": "68679",
      "goodsCode": "68679",
      "goodsName": "ahmad.osinski",
      "skuId": "54",
      "skuValue": "sfy8mo",
      "num": 312,
      "discountScene": 157,
      "discountMode": 979,
      "shareType": 736,
      "title": "36awfm",
      "cost": "t96mh7",
      "discountAmount": 205,
      "discountCost": 626
    }
  ],
  "orderGifts": [
    {
      "source": 275,
      "type": 612,
      "giftType": 424,
      "name": "ahmad.osinski",
      "giftValue": "7mr8ib",
      "giftNum": 855
    }
  ],
  "orderDistribute": {
    "consigneeType": 656,
    "payType": 282,
    "postage": 967,
    "preUserName": "ahmad.osinski",
    "preUserMobile": "1-219-551-0212",
    "consigneeName": "ahmad.osinski",
    "consigneeAddress": "9555 Wilfred Plains, North Felixmouth, MI 78129",
    "consigneeMobile": "1-219-551-0212",
    "consigneeProvinceCode": "68679",
    "consigneeProvinceName": "ahmad.osinski",
    "consigneeCityCode": "68679",
    "consigneeCityName": "ahmad.osinski",
    "consigneeAreaCode": "68679",
    "consigneeAreaName": "ahmad.osinski",
    "consigneeLongitude": "qvj3c6",
    "consigneeLatitude": "xpidhl"
  },
  "settlementFlows": [
    {
      "storeCode": "68679",
      "code": "68679",
      "batchCode": "68679",
      "businessScene": 15,
      "payType": 859,
      "payTitle": "jvsivs",
      "buyerId": "54",
      "amount": 461,
      "createdTime": "2024-08-30 09:36:37"
    }
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

烘焙云订单号

     └─orderCode

string

烘焙云订单号

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "orderCode": "68679"
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 接单

当前版本:  2.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  接单

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

orderCode

string

烘焙云订单编号

true

takeTime

string

接单时间 (格式:yyyy-MM-dd HH:mm:ss)

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/order/take?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=9fyh1k' --data '{
  "orderCode": "68679",
  "takeTime": "2024-08-30 09:36:37"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

com.bake.web.common.HttpJsonResult

     └─takeResult

boolean

订单接单结果,true取消成功,false取消失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "takeResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 取消订单

当前版本:  2.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  支持整单取消以及部分取消后剩余信息的取消

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

orderCode

string

烘焙云订单编号

true

cancelTime

string

取消时间 (格式:yyyy-MM-dd HH:mm:ss)

true

amount

number

总退款金额

true

settlementFlows

array

流水信息

false

└─storeCode

string

门店编码

true

└─code

string

流水编号

true

└─batchCode

string

批次号(用于多阶段付款)

true

└─businessScene

int32

业务场景 1销售 2预付款 3尾款 4积分兑换

true

└─payType

int32

支付方式 0其它 3支付宝 4微信 5会员卡余额 204礼品卡
如需对接详细支付方式,可以在烘焙云控制台【系统】-【系统配置】-【支付配置】功能模块内查看支付方式

true

└─payTitle

string

支付方式名

true

└─buyerId

string

会员OpenId

false

└─amount

number

支付金额(精确到小数点后两位)

true

└─createdTime

string

业务时间 (支付/退款发生时间。格式:yyyy-MM-dd HH:mm:ss)

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/order/cancel?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=750o7c' --data '{
  "orderCode": "68679",
  "cancelTime": "2024-08-30 09:36:37",
  "amount": 47,
  "settlementFlows": [
    {
      "storeCode": "68679",
      "code": "68679",
      "batchCode": "68679",
      "businessScene": 8,
      "payType": 93,
      "payTitle": "vjxqhz",
      "buyerId": "54",
      "amount": 15,
      "createdTime": "2024-08-30 09:36:37"
    }
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

true取消成功,false取消失败

     └─cancelResult

boolean

取消订单结果,true取消成功,false取消失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "cancelResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 取消订单失败

当前版本:  2.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  烘焙云发起取消订单申请后,如果三方无法取消,调用此接口通知失败原因

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

orderCode

string

烘焙云订单编号

true

reason

string

失败原因

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/order/cancel/fail?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=cnv1pz' --data '{
  "orderCode": "68679",
  "reason": "e6ap7d"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

true取消成功,false取消失败

     └─cancelFailResult

boolean

取消订单失败结果,true取消成功,false取消失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "cancelFailResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 订单部分取消

当前版本:  2.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  订单提发货之前指定退还部分数量的商品。不会改变订单状态,订单依然可以提发货。

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

orderCode

string

烘焙云订单编号

true

cancelTime

string

取消时间 (格式:yyyy-MM-dd HH:mm:ss)

true

code

string

退货单号
接口按照退货单号做幂等校验,如果为空,则按照取消时间做幂等

false

reason

string

退还原因(64)

false

remark

string

退还备注(128)(用于对选择的退还原因做额外描述)

false

postage

number

退还的邮费金额

true

goodsDetails

array

退还的商品信息

true

└─goodsCode

string

创建订单时传入的第三方商品编码(16)

false

└─skuId

string

创建订单时传入的skuId

true

└─num

number

退还商品数量,精确到小数点后三位

true

└─amount

number

商品退还金额(本商品合计退还金额,精确到小数点后两位)

true

settlementFlows

array

退还时发生的金额流水

false

└─storeCode

string

门店编码

true

└─code

string

流水编号

true

└─batchCode

string

批次号(用于多阶段付款)

true

└─businessScene

int32

业务场景 1销售 2预付款 3尾款 4积分兑换

true

└─payType

int32

支付方式 0其它 3支付宝 4微信 5会员卡余额 204礼品卡
如需对接详细支付方式,可以在烘焙云控制台【系统】-【系统配置】-【支付配置】功能模块内查看支付方式

true

└─payTitle

string

支付方式名

true

└─buyerId

string

会员OpenId

false

└─amount

number

支付金额(精确到小数点后两位)

true

└─createdTime

string

业务时间 (支付/退款发生时间。格式:yyyy-MM-dd HH:mm:ss)

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/order/cancel/part?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=6gvsic' --data '{
  "orderCode": "68679",
  "cancelTime": "2024-08-30 09:36:37",
  "code": "68679",
  "reason": "1q93rx",
  "remark": "r7xtfu",
  "postage": 940,
  "goodsDetails": [
    {
      "goodsCode": "68679",
      "skuId": "54",
      "num": 468,
      "amount": 391
    }
  ],
  "settlementFlows": [
    {
      "storeCode": "68679",
      "code": "68679",
      "batchCode": "68679",
      "businessScene": 23,
      "payType": 104,
      "payTitle": "ez8r5x",
      "buyerId": "54",
      "amount": 619,
      "createdTime": "2024-08-30 09:36:37"
    }
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

com.bake.web.common.HttpJsonResult

     └─refundResult

boolean

部分退单结果,true成功,false失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "refundResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 退单

当前版本:  2.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  支持整单退还或者部分退之后剩余信息的退还

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

orderCode

string

烘焙云订单编号

true

cancelTime

string

取消时间 (格式:yyyy-MM-dd HH:mm:ss)

true

amount

number

总退款金额

true

settlementFlows

array

流水信息

false

└─storeCode

string

门店编码

true

└─code

string

流水编号

true

└─batchCode

string

批次号(用于多阶段付款)

true

└─businessScene

int32

业务场景 1销售 2预付款 3尾款 4积分兑换

true

└─payType

int32

支付方式 0其它 3支付宝 4微信 5会员卡余额 204礼品卡
如需对接详细支付方式,可以在烘焙云控制台【系统】-【系统配置】-【支付配置】功能模块内查看支付方式

true

└─payTitle

string

支付方式名

true

└─buyerId

string

会员OpenId

false

└─amount

number

支付金额(精确到小数点后两位)

true

└─createdTime

string

业务时间 (支付/退款发生时间。格式:yyyy-MM-dd HH:mm:ss)

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/order/refund?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=6sccs8' --data '{
  "orderCode": "68679",
  "cancelTime": "2024-08-30 09:36:37",
  "amount": 687,
  "settlementFlows": [
    {
      "storeCode": "68679",
      "code": "68679",
      "batchCode": "68679",
      "businessScene": 865,
      "payType": 229,
      "payTitle": "9wotus",
      "buyerId": "54",
      "amount": 600,
      "createdTime": "2024-08-30 09:36:37"
    }
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

true退单成功,false退单失败

     └─refundResult

boolean

退单结果,true成功,false失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "refundResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 退单失败

当前版本:  2.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  烘焙云发起退单申请后,如果三方无法退单,调用此接口通知失败原因

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

orderCode

string

烘焙云订单编号

true

reason

string

失败原因

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/order/refund/fail?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=5n4clt' --data '{
  "orderCode": "68679",
  "reason": "e0cgwc"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

true取消成功,false取消失败

     └─refundFailResult

boolean

退单失败结果,true取消成功,false取消失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "refundFailResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 订单部分退单

当前版本:  2.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  订单已出库后指定退还部分数量的商品。不会改变订单状态,订单依然可以再次发起退款。

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

orderCode

string

烘焙云订单编号

true

cancelTime

string

取消时间 (格式:yyyy-MM-dd HH:mm:ss)

true

code

string

退货单号
接口按照退货单号做幂等校验,如果为空,则按照取消时间做幂等

false

reason

string

退还原因(64)

false

remark

string

退还备注(128)(用于对选择的退还原因做额外描述)

false

postage

number

退还的邮费金额

true

goodsDetails

array

退还的商品信息

true

└─goodsCode

string

创建订单时传入的第三方商品编码(16)

false

└─skuId

string

创建订单时传入的skuId

true

└─num

number

退还商品数量,精确到小数点后三位

true

└─amount

number

商品退还金额(本商品合计退还金额,精确到小数点后两位)

true

settlementFlows

array

退还时发生的金额流水

false

└─storeCode

string

门店编码

true

└─code

string

流水编号

true

└─batchCode

string

批次号(用于多阶段付款)

true

└─businessScene

int32

业务场景 1销售 2预付款 3尾款 4积分兑换

true

└─payType

int32

支付方式 0其它 3支付宝 4微信 5会员卡余额 204礼品卡
如需对接详细支付方式,可以在烘焙云控制台【系统】-【系统配置】-【支付配置】功能模块内查看支付方式

true

└─payTitle

string

支付方式名

true

└─buyerId

string

会员OpenId

false

└─amount

number

支付金额(精确到小数点后两位)

true

└─createdTime

string

业务时间 (支付/退款发生时间。格式:yyyy-MM-dd HH:mm:ss)

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/order/refund/part?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=6o1kdw' --data '{
  "orderCode": "68679",
  "cancelTime": "2024-08-30 09:36:37",
  "code": "68679",
  "reason": "qkhi5p",
  "remark": "4o9lb0",
  "postage": 194,
  "goodsDetails": [
    {
      "goodsCode": "68679",
      "skuId": "54",
      "num": 838,
      "amount": 561
    }
  ],
  "settlementFlows": [
    {
      "storeCode": "68679",
      "code": "68679",
      "batchCode": "68679",
      "businessScene": 346,
      "payType": 830,
      "payTitle": "szku0s",
      "buyerId": "54",
      "amount": 982,
      "createdTime": "2024-08-30 09:36:37"
    }
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

com.bake.web.common.HttpJsonResult

     └─refundResult

boolean

部分退单结果,true成功,false失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "refundResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 订单提/发货

当前版本:  2.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  调用此接口必须保证订单内所有商品都在物流单内,可以分散在多个物流单内。

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

orderCode

string

烘焙云单号

true

deliveryTime

string

发货时间 (格式:yyyy-MM-dd HH:mm:ss)

true

deliveryInfos

array

物流单信息

false

└─batchCode

string

批次号(一个订单分批次发货时,不同批次物流单应使用同一批次号)

true

└─code

string

物流单号

true

└─deliveryCompanyName

string

物流公司名称

false

└─deliveryTotalAmount

number

物流公司运费(正数,精确到小数点后两位)

false

└─deliveryPrevPayment

number

物流公司预付费(正数,精确到小数点后两位)

false

└─deliveryPayState

int32

物流运费支付状态:1、已完成,2、未完成

false

└─totalGoodsAmount

number

配送商品总金额 (正数,精确到小数点后两位)

false

└─storeCode

string

取货门店编码

true

└─receiverName

string

收货人姓名

true

└─receiverMobile

string

收货人手机号,可以填写座机和手机,没有强校验

true

└─receiverProvince

string

收货人所在省

true

└─receiverProvinceCode

string

收货人所在省国标码

false

└─receiverCity

string

收货人所在城市

true

└─receiverCityCode

string

收货人所在城市国标码

false

└─receiverCounty

string

收货人所在区县

true

└─receiverCountyCode

string

收货人所在区县国标码

false

└─receiverDetailedAddress

string

收货人详细地址

true

└─receiverLongitude

string

收货人所在地经度

false

└─receiverLatitude

string

收货人所在地纬度

false

└─deliveryType

int32

物流配送方式:1、配送,2、快递

true

└─deliveryName

string

配送人姓名

false

└─deliverMobile

string

配送人联系方式
如果输入此参数,必须是满足手机号正则的字符串

false

└─sendTime

string

配送时间(格式:yyyy-MM-dd HH:mm:ss)

false

└─customerRemark

string

买家备注(512)

false

└─businessRemark

string

卖家备注(512)

false

└─goodsDetails

array

物流单内商品信息列表

true

     └─materialCode

string

物料序号

true

     └─goodsNum

number

商品数量

true

     └─goodsName

string

商品名称

true

     └─goodsSkuDescribe

string

商品sku描述(列:六寸 蓝色)

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/order/delivery?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=toeh3p' --data '{
  "orderCode": "68679",
  "deliveryTime": "2024-08-30 09:36:37",
  "deliveryInfos": [
    {
      "batchCode": "68679",
      "code": "68679",
      "deliveryCompanyName": "ahmad.osinski",
      "deliveryTotalAmount": 243,
      "deliveryPrevPayment": 673,
      "deliveryPayState": 2,
      "totalGoodsAmount": 293,
      "storeCode": "68679",
      "receiverName": "ahmad.osinski",
      "receiverMobile": "1-219-551-0212",
      "receiverProvince": "hzspwl",
      "receiverProvinceCode": "68679",
      "receiverCity": "7j3iy8",
      "receiverCityCode": "68679",
      "receiverCounty": "fvzzhh",
      "receiverCountyCode": "68679",
      "receiverDetailedAddress": "9555 Wilfred Plains, North Felixmouth, MI 78129",
      "receiverLongitude": "u1tz04",
      "receiverLatitude": "b4ty5i",
      "deliveryType": 96,
      "deliveryName": "ahmad.osinski",
      "deliverMobile": "1-219-551-0212",
      "sendTime": "2024-08-30 09:36:37",
      "customerRemark": "xjpv0c",
      "businessRemark": "n7sucf",
      "goodsDetails": [
        {
          "materialCode": "68679",
          "goodsNum": 336,
          "goodsName": "ahmad.osinski",
          "goodsSkuDescribe": "237omf"
        }
      ]
    }
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

true成功,false失败

     └─deliveryResult

boolean

发货结果,true成功,false失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "deliveryResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 订单确认收货

当前版本:  2.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  订单确认收货,支持批量确认,每次最多100个订单同时确认。单次确认收货的订单越多,接口调用时长越长

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

receiveInfos

array

确认收货信息

true

└─orderCode

string

烘焙云订单编号

true

└─confirmTime

string

确认收货时间 (格式:yyyy-MM-dd HH:mm:ss)

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/order/receive?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=9zz8gj' --data '{
  "receiveInfos": [
    {
      "orderCode": "68679",
      "confirmTime": "2024-08-30 09:36:37"
    }
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

true成功,false失败

     └─receiveResult

boolean

确认收货结果,true成功,false失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "receiveResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 查询物流详情

当前版本:  2.0

请求类型:  GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  查询物流详情

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

orderCode

string

烘焙云订单编号

true

请求示例

curl -X GET -k -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/order/logistics/detail?token=7agfgh&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a&orderCode=68679'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

array

物流单详细信息

     └─orderCode

string

烘焙云订单号

     └─batchCode

string

批次号(多次发货)

     └─code

string

物流单号

     └─deliveryCompanyName

string

物流公司名称

     └─deliveryTotalAmount

number

物流公司运费(精确到小数点后两位)

     └─deliveryPrevPayment

number

物流公司预付费(精确到小数点后两位)

     └─deliveryPayState

int32

物流运费支付状态:1、已完成,2、未完成

     └─totalGoodsAmount

number

配送商品总金额 (精确到小数点后两位)

     └─storeCode

string

取货门店编码

     └─receiverName

string

收货人姓名

     └─receiverMobile

string

收货人手机号

     └─receiverProvince

string

收货人所在省

     └─receiverProvinceCode

string

收货人所在省编号

     └─receiverCity

string

收货人所在城市

     └─receiverCityCode

string

收货人所在城市编号

     └─receiverCounty

string

收货人所在区县

     └─receiverCountyCode

string

收货人所在区县编号

     └─receiverDetailedAddress

string

收货人详细地址

     └─receiverLongitude

string

收货人所在地经度

     └─receiverLatitude

string

收货人所在地纬度

     └─deliveryType

int32

物流配送方式:1、配送,2、快递

     └─deliveryName

string

配送人姓名

     └─deliverMobile

string

配送人联系方式

     └─sendTime

string

配送时间

     └─customerRemark

string

买家备注(512)

     └─businessRemark

string

卖家备注(512)

     └─goodsDetailList

array

物流单内商品信息列表

          └─materialCode

string

物料序号

          └─goodsNum

number

商品数量

          └─goodsName

string

商品名称

          └─goodsSkuDescribe

string

商品sku描述(列:六寸 蓝色)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": [
    {
      "orderCode": "68679",
      "batchCode": "68679",
      "code": "68679",
      "deliveryCompanyName": "ahmad.osinski",
      "deliveryTotalAmount": 791,
      "deliveryPrevPayment": 927,
      "deliveryPayState": 2,
      "totalGoodsAmount": 653,
      "storeCode": "68679",
      "receiverName": "ahmad.osinski",
      "receiverMobile": "1-219-551-0212",
      "receiverProvince": "o2qdvh",
      "receiverProvinceCode": "68679",
      "receiverCity": "fk3939",
      "receiverCityCode": "68679",
      "receiverCounty": "t7hq89",
      "receiverCountyCode": "68679",
      "receiverDetailedAddress": "9555 Wilfred Plains, North Felixmouth, MI 78129",
      "receiverLongitude": "qnhkwb",
      "receiverLatitude": "c6y9ku",
      "deliveryType": 750,
      "deliveryName": "ahmad.osinski",
      "deliverMobile": "1-219-551-0212",
      "sendTime": "2024-08-30 09:36:37",
      "customerRemark": "g0o75h",
      "businessRemark": "pazdn0",
      "goodsDetailList": [
        {
          "materialCode": "68679",
          "goodsNum": 876,
          "goodsName": "ahmad.osinski",
          "goodsSkuDescribe": "a1q9ov"
        }
      ]
    }
  ],
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 全量订单查询

当前版本:  2.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  分页查询一定时间范围内全量订单,最长只允许查询三天内订单(仅用于初始化,需要单独申请权限)

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求参数

Parameter Type Description Required

startTime

string

开始时间 (格式:yyyy-MM-dd HH:mm:ss)

true

endTime

string

结束时间 (格式:yyyy-MM-dd HH:mm:ss)
开始时间与结束时间指的都是订单下单时间

true

states

array

订单状态列表

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:2.0' -i 'https://iop.hongbeiyun.com/api/order/full/page?sign=550652140273bc8c95b81f62acff295a&pageSize=10&timestamp=1724981797&token=eldoco&pageNo=1' --data '{
  "startTime": "2024-08-30 09:36:37",
  "endTime": "2024-08-30 09:36:37",
  "states": [
    616
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

订单列表

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─orderBase

object

订单基础信息

               └─code

string

烘焙云单号

               └─quoteCode

string

第三方单号

               └─state

int32

订单状态:.0 待付款,1 已取消,2 待接单,3 待发货/代提货/预定成功,4 取消预定成功,5 待收货,6 收货/提货/交易成功 7 交易关闭 ,9 退单成功

               └─platform

int32

平台 - 1烘焙云 2美团 3饿了么 4口碑

               └─channel

int32

渠道 - 0其它 1门店 2总部 3商城 4拼团 5秒杀 6外卖

               └─terminal

int32

终端 - 0其它 1门店pos 2门店自助收银 3H5 4小程序

               └─scene

int32

场景 - 1 销售(用于门店直接销售场景) 2 预定(用于先付款,后交付场景)

               └─orderType

int32

订单类型 - 1销售单 2普通预定 5积分兑换

               └─buyerType

int32

买家类型:1普通顾客 2会员

               └─buyerId

string

买家ID(会员openId),买家类型为会员时必填

               └─buyerName

string

买家名称,买家类型为会员时必填

               └─buyerMobile

string

买家手机号码,买家类型为会员时必填

               └─buyerCardCode

string

买家卡号

               └─consigneeName

string

提货/收货人姓名

               └─consigneeMobile

string

提货/收货人手机号

               └─sellerRemark

string

卖家备注(256字以内)

               └─buyerRemark

string

买家备注(128字以内)

               └─storeName

string

下单门店名称

               └─storeCode

string

下单门店编码

               └─takeStoreName

string

履约门店名称

               └─takeStoreCode

string

履约门店编码

               └─produceStoreName

string

生产门店名称

               └─produceStoreCode

string

生产门店编码

               └─preOrderTime

string

下单时间(格式:yyyy-MM-dd HH:mm:ss)

               └─payedTime

string

支付完成时间(格式:yyyy-MM-dd HH:mm:ss)

               └─preTakeTime

string

预定提货时间(格式:yyyy-MM-dd HH:mm:ss)

               └─cancelReserveTime

string

取消预定时间(格式:yyyy-MM-dd HH:mm:ss)

               └─completedTime

string

交易完成时间(格式:yyyy-MM-dd HH:mm:ss)

               └─returnedTime

string

退货时间(格式:yyyy-MM-dd HH:mm:ss)

               └─deliveryTime

string

发货时间(格式:yyyy-MM-dd HH:mm:ss)

               └─refundedTime

string

退款时间(格式:yyyy-MM-dd HH:mm:ss)

               └─totalAmount

number

订单总金额

               └─payAmount

number

实付金额

               └─discountAmount

number

优惠金额

               └─takeCertNo

string

取货凭证号

               └─operatorName

string

操作人名称

               └─customerCode

string

大客户编码

               └─refundState

int32

退款状态0未退款1部分退款成功2全额退款成功

               └─boxAmount

number

餐盒费

               └─serviceFee

number

服务费(抽佣)

               └─otherAmount

number

其它费用合计

          └─goodsDetails

array

订单商品明细集合

               └─materialCode

string

物料序号

               └─materialLabel

string

物料名称

               └─goodsCode

string

商品编码

               └─goodsName

string

商品名称

               └─skuId

string

skuId

               └─skuValue

string

sku名称

               └─isGift

int32

是否赠品 1:是 ,0:否

               └─num

number

商品数量

               └─originalPrice

number

原价

               └─sellsPrice

number

售价

               └─totalDiscountAmount

number

合计优惠金额

               └─totalRealAmount

number

合计实付金额

               └─goodsType

int32

商品分类 1实物 2虚拟

          └─orderDiscounts

array

订单优惠信息

               └─materialCode

string

物料序号

               └─materialName

string

物料名称

               └─goodsCode

string

商品编码

               └─goodsName

string

商品名称

               └─skuId

string

skuId

               └─skuValue

string

sku描述

               └─num

number

物料数量

               └─discountScene

int32

优惠场景 :1预售 2预定、销售、积分兑换 3提货

               └─discountType

int32

优惠类型 :1整单优惠 2商品优惠

               └─discountMode

int32

优惠方式:0其它 1优惠券 2积分支付 3积分兑换 4活动 5会员价 6手工折扣 7手工折让 8舍入 9协议价

               └─shareType

int32

计算分摊方式 1均摊(整单级优惠) 2商品独享(商品级优惠)

               └─title

string

优惠标题

               └─cost

string

消耗内容(积分数量、券号)

               └─discountAmount

number

优惠金额

               └─discountCost

number

优惠成本

               └─couponExtraInfo

object

券优惠扩展信息(只有烘焙云订单包含此信息)

                    └─identifier

string

券核销标识

                    └─platform

int32

券平台

          └─orderGifts

array

订单赠品信息

               └─source

int32

赠品来源 1活动赠送 2基础赠送

               └─type

int32

赠品分类 1实物 2虚拟

               └─giftType

int32

赠品类型 0其它 1商品 2券 3积分 4余额 5成长值

               └─name

string

赠品名称

               └─giftValue

string

赠品内容 物料序号/券号

               └─giftNum

number

赠送数量

          └─orderDistribute

object

订单物流信息

               └─consigneeType

int32

收货方式:1自提 2商家配送 3第三方物流

               └─payType

int32

邮费支付方式 1预付 2到付 3包邮

               └─postage

number

运费

               └─preUserName

string

下单人姓名

               └─preUserMobile

string

下单人手机号

               └─consigneeName

string

收货人姓名

               └─consigneeAddress

string

收货人详细地址

               └─consigneeMobile

string

收货人手机号

               └─consigneeProvinceCode

string

收货人省-代码

               └─consigneeProvinceName

string

收货人省-名称

               └─consigneeCityCode

string

收货人市-代码

               └─consigneeCityName

string

收货人市-名称

               └─consigneeAreaCode

string

收货人区-代码

               └─consigneeAreaName

string

收货人区-名称

               └─consigneeLongitude

string

收货人 - 经度

               └─consigneeLatitude

string

收货人 - 纬度

          └─settlementFlows

array

订单支付详情集合

               └─code

string

流水编码

               └─storeCode

string

门店编码

               └─operationScene

int32

操作类型1支付 2退款

               └─businessScene

int32

业务场景 1销售 2预付款 3尾款 4积分兑换

               └─payType

int32

支付方式 0其它 3支付宝 4微信 5会员卡

               └─payTitle

string

支付方式名

               └─payerType

int32

支付方类型 1买家 2商家 3支付服务商

               └─buyerId

string

会员ID

               └─amount

number

支付金额(精确到小数点后两位)

               └─amountType

int32

金额类型:1 本金 2 赠送金

               └─createdTime

string

业务时间 (支付/退款发生时间。格式:yyyy-MM-dd HH:mm:ss)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "orderBase": {
          "code": "68679",
          "quoteCode": "68679",
          "state": 2,
          "platform": 616,
          "channel": 980,
          "terminal": 523,
          "scene": 973,
          "orderType": 205,
          "buyerType": 959,
          "buyerId": "54",
          "buyerName": "ahmad.osinski",
          "buyerMobile": "1-219-551-0212",
          "buyerCardCode": "68679",
          "consigneeName": "ahmad.osinski",
          "consigneeMobile": "1-219-551-0212",
          "sellerRemark": "xj7juv",
          "buyerRemark": "b4b2cd",
          "storeName": "ahmad.osinski",
          "storeCode": "68679",
          "takeStoreName": "ahmad.osinski",
          "takeStoreCode": "68679",
          "produceStoreName": "ahmad.osinski",
          "produceStoreCode": "68679",
          "preOrderTime": "2024-08-30 09:36:37",
          "payedTime": "2024-08-30 09:36:37",
          "preTakeTime": "2024-08-30 09:36:37",
          "cancelReserveTime": "2024-08-30 09:36:37",
          "completedTime": "2024-08-30 09:36:37",
          "returnedTime": "2024-08-30 09:36:37",
          "deliveryTime": "2024-08-30 09:36:37",
          "refundedTime": "2024-08-30 09:36:37",
          "totalAmount": 316,
          "payAmount": 416,
          "discountAmount": 333,
          "takeCertNo": "ld6sga",
          "operatorName": "ahmad.osinski",
          "customerCode": "68679",
          "refundState": 2,
          "boxAmount": 810,
          "serviceFee": 139,
          "otherAmount": 878
        },
        "goodsDetails": [
          {
            "materialCode": "68679",
            "materialLabel": "kaf1d0",
            "goodsCode": "68679",
            "goodsName": "ahmad.osinski",
            "skuId": "54",
            "skuValue": "wfwb8c",
            "isGift": 146,
            "num": 26,
            "originalPrice": 283,
            "sellsPrice": 637,
            "totalDiscountAmount": 370,
            "totalRealAmount": 929,
            "goodsType": 161
          }
        ],
        "orderDiscounts": [
          {
            "materialCode": "68679",
            "materialName": "ahmad.osinski",
            "goodsCode": "68679",
            "goodsName": "ahmad.osinski",
            "skuId": "54",
            "skuValue": "9niiaw",
            "num": 169,
            "discountScene": 597,
            "discountType": 894,
            "discountMode": 868,
            "shareType": 294,
            "title": "qllylj",
            "cost": "4xe90i",
            "discountAmount": 60,
            "discountCost": 382,
            "couponExtraInfo": {
              "identifier": "b6evb3",
              "platform": 734
            }
          }
        ],
        "orderGifts": [
          {
            "source": 307,
            "type": 908,
            "giftType": 119,
            "name": "ahmad.osinski",
            "giftValue": "c691yt",
            "giftNum": 951
          }
        ],
        "orderDistribute": {
          "consigneeType": 756,
          "payType": 61,
          "postage": 83,
          "preUserName": "ahmad.osinski",
          "preUserMobile": "1-219-551-0212",
          "consigneeName": "ahmad.osinski",
          "consigneeAddress": "9555 Wilfred Plains, North Felixmouth, MI 78129",
          "consigneeMobile": "1-219-551-0212",
          "consigneeProvinceCode": "68679",
          "consigneeProvinceName": "ahmad.osinski",
          "consigneeCityCode": "68679",
          "consigneeCityName": "ahmad.osinski",
          "consigneeAreaCode": "68679",
          "consigneeAreaName": "ahmad.osinski",
          "consigneeLongitude": "m8bm4m",
          "consigneeLatitude": "cfofq7"
        },
        "settlementFlows": [
          {
            "code": "68679",
            "storeCode": "68679",
            "operationScene": 441,
            "businessScene": 100,
            "payType": 422,
            "payTitle": "prwwpu",
            "payerType": 160,
            "buyerId": "54",
            "amount": 782,
            "amountType": 854,
            "createdTime": "2024-08-30 09:36:37"
          }
        ]
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

4.10. 优惠券

 券发放

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  根据指定模板批次编号发放指定数量的券
注:一次最多发放1000张券(会员数量* 发放数量 <= 1000)

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

templateCode

string

模板编号

true

num

int32

发放数量

true

memberOpenIds

array

会员OpenId数组(["aaa","bbb"])

false

storeCode

string

门店编号

false

scene

int32

场景 1:交易(购买) 2:赠送 3:领取

true

sendSource

string

发放来源

false

dealCode

string

交易编号

false

dealAmount

number

交易金额(券成本,默认为:0;最大两位小数,单位:元)

false

sendIdentifier

string

发放标识(用于幂等,最大64位,仅3天内有效)

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/coupon/send?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=n45m1k' --data '{
  "templateCode": "68679",
  "num": 480,
  "memberOpenIds": [
    "4c9u8v"
  ],
  "storeCode": "68679",
  "scene": 551,
  "sendSource": "jdlry9",
  "dealCode": "68679",
  "dealAmount": 293,
  "sendIdentifier": "93ynuy"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

array

券信息

     └─couponCode

string

券码

     └─couponType

int32

券类型 1:满减券

     └─carrierType

int32

载体类型 1:电子券 2:纸质券

     └─templateCode

string

模板编号

     └─templateName

string

模板名称

     └─couponValue

number

券面值(仅满减券有值,最大两位小数,单位:元)

     └─startDate

string

券有效期-开始日期(格式:yyyy-MM-dd HH:mm:ss)(券有效期 ≥ 开始时间)

     └─endDate

string

券有效期-结束日期(格式:yyyy-MM-dd HH:mm:ss)(券有效期 < 结束日期)

     └─memberOpenId

string

会员OpenId(非会员券,该信息为空)

     └─sendStoreCode

string

发放门店编码

     └─couponState

int32

券状态 1:待使用 2:已使用 3:已转换 4:已停用 5:已过期 6:待生效

     └─salePrice

number

券销售价

     └─transformCode

string

转换券码

     └─sendDate

string

发券时间(格式:yyyy-MM-dd HH:mm:ss)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": [
    {
      "couponCode": "68679",
      "couponType": 292,
      "carrierType": 584,
      "templateCode": "68679",
      "templateName": "ahmad.osinski",
      "couponValue": 700,
      "startDate": "2024-08-30",
      "endDate": "2024-08-30",
      "memberOpenId": "54",
      "sendStoreCode": "68679",
      "couponState": 2,
      "salePrice": 748,
      "transformCode": "68679",
      "sendDate": "2024-08-30"
    }
  ],
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 券发放(多模板)

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  根据指定模板批次编号发放指定数量的券
注:一次最多发放1000张券(SUM(券模板(会员数量* 发放数量))<= 1000)

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

storeCode

string

门店编号

false

scene

int32

场景 1:交易(购买) 2:赠送 3:领取

true

sendSource

string

发放来源

false

dealCode

string

交易编号

false

sendIdentifier

string

发放标识(用于幂等,最大64位,仅3天内有效)

false

couponTemplates

array

券模板信息

true

└─templateCode

string

模板编号

true

└─num

int32

发放数量

true

└─memberOpenIds

array

会员OpenId数组(["aaa","bbb"])

false

└─cost

number

券成本金额(每张券成本金额,默认为:0;最大两位小数,单位:元)

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/coupon/sendMoreTemplate?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=0g1kk0' --data '{
  "storeCode": "68679",
  "scene": 393,
  "sendSource": "n0wwyg",
  "dealCode": "68679",
  "sendIdentifier": "t96u6e",
  "couponTemplates": [
    {
      "templateCode": "68679",
      "num": 843,
      "memberOpenIds": [
        "d47gzw"
      ],
      "cost": 374
    }
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

array

券信息

     └─couponCode

string

券码

     └─couponType

int32

券类型 1:满减券

     └─carrierType

int32

载体类型 1:电子券 2:纸质券

     └─templateCode

string

模板编号

     └─templateName

string

模板名称

     └─couponValue

number

券面值(仅满减券有值,最大两位小数,单位:元)

     └─startDate

string

券有效期-开始日期(格式:yyyy-MM-dd HH:mm:ss)(券有效期 ≥ 开始时间)

     └─endDate

string

券有效期-结束日期(格式:yyyy-MM-dd HH:mm:ss)(券有效期 < 结束日期)

     └─memberOpenId

string

会员OpenId(非会员券,该信息为空)

     └─sendStoreCode

string

发放门店编码

     └─couponState

int32

券状态 1:待使用 2:已使用 3:已转换 4:已停用 5:已过期 6:待生效

     └─salePrice

number

券销售价

     └─transformCode

string

转换券码

     └─sendDate

string

发券时间(格式:yyyy-MM-dd HH:mm:ss)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": [
    {
      "couponCode": "68679",
      "couponType": 520,
      "carrierType": 99,
      "templateCode": "68679",
      "templateName": "ahmad.osinski",
      "couponValue": 240,
      "startDate": "2024-08-30",
      "endDate": "2024-08-30",
      "memberOpenId": "54",
      "sendStoreCode": "68679",
      "couponState": 2,
      "salePrice": 469,
      "transformCode": "68679",
      "sendDate": "2024-08-30"
    }
  ],
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 券停用

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  停用指定券码的券

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

couponCode

string

券码

true

reason

string

停用原因

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/coupon/stop?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=yme3vn' --data '{
  "couponCode": "68679",
  "reason": "78cu4q"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

停用结果

     └─stopResult

boolean

停用结果 true:成功 false:失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "stopResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 券批量停用

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  批量停用指定券码的券

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

couponCodes

array

券码数组,最大量=100

true

reason

string

停用原因

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/coupon/stopCoupons?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=r7tjti' --data '{
  "couponCodes": [
    "84j382"
  ],
  "reason": "ygbw3h"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

停用结果

     └─stopResult

boolean

停用结果 true:成功 false:失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "stopResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 券核销

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  根据券码,一次性核销掉同一交易下的若干张券

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

scene

int32

场景 1:订单 2:充值

true

dealCode

string

交易编码

true

storeCode

string

门店编号

true

coupons

array

券信息

true

└─couponCode

string

券码

true

└─amount

number

金额(券使用金额,默认为:0;最大两位小数,单位:元)

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/coupon/consume?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=x0gxwu' --data '{
  "scene": 410,
  "dealCode": "68679",
  "storeCode": "68679",
  "coupons": [
    {
      "couponCode": "68679",
      "amount": 223
    }
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

核销结果

     └─consumeResult

boolean

核销结果 true:成功 false:失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "consumeResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 券反核销

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  撤销已核销券码

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

couponCode

string

券码

true

dealCode

string

交易编码(需与核销时交易编码一致)

true

reason

string

反核销原因

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/coupon/cancel?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=qw61ja' --data '{
  "couponCode": "68679",
  "dealCode": "68679",
  "reason": "iyr3jv"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

反核销结果

     └─cancelResult

boolean

反核销结果 true:成功 false:失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "cancelResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 券绑定会员

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  将指定券码的券绑定到会员

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

couponCode

string

券码

true

memberOpenId

string

会员OpenId

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/coupon/bindMember?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=4hwfo0' --data '{
  "couponCode": "68679",
  "memberOpenId": "54"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

券绑定会员结果

     └─bindMemberResult

boolean

绑定会员结果 true:成功 false:失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "bindMemberResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

  查询券信息(已过期)

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  根据券码获取优惠券完整信息

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

couponCode

string

券码

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/coupon/queryByCode?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=lc582p' --data '{
  "couponCode": "68679"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

券信息

     └─couponCode

string

券码

     └─couponType

int32

券类型 1:满减券

     └─carrierType

int32

载体类型 1:电子券 2:纸质券

     └─templateCode

string

模板编号

     └─templateName

string

模板名称

     └─couponValue

number

券面值(仅满减券有值,最大两位小数,单位:元)

     └─startDate

string

券有效期-开始日期(格式:yyyy-MM-dd HH:mm:ss)(券有效期 ≥ 开始时间)

     └─endDate

string

券有效期-结束日期(格式:yyyy-MM-dd HH:mm:ss)(券有效期 < 结束日期)

     └─memberOpenId

string

会员OpenId(非会员券,该信息为空)

     └─sendStoreCode

string

发放门店编码

     └─couponState

int32

券状态 1:待使用 2:已使用 3:已转换 4:已停用 5:已过期 6:待生效

     └─salePrice

number

券销售价

     └─transformCode

string

转换券码

     └─sendDate

string

发券时间(格式:yyyy-MM-dd HH:mm:ss)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "couponCode": "68679",
    "couponType": 493,
    "carrierType": 378,
    "templateCode": "68679",
    "templateName": "ahmad.osinski",
    "couponValue": 839,
    "startDate": "2024-08-30",
    "endDate": "2024-08-30",
    "memberOpenId": "54",
    "sendStoreCode": "68679",
    "couponState": 2,
    "salePrice": 696,
    "transformCode": "68679",
    "sendDate": "2024-08-30"
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 批量查询券信息

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  根据券码获取优惠券完整信息

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

couponCodes

array

券码,最多20个

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/coupon/queryByCodes?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=5qhgsy' --data '{
  "couponCodes": [
    "1i9nx0"
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

array

券信息

     └─couponCode

string

券码

     └─couponType

int32

券类型 1:满减券

     └─carrierType

int32

载体类型 1:电子券 2:纸质券

     └─templateCode

string

模板编号

     └─templateName

string

模板名称

     └─couponValue

number

券面值(仅满减券有值,最大两位小数,单位:元)

     └─startDate

string

券有效期-开始日期(格式:yyyy-MM-dd HH:mm:ss)(券有效期 ≥ 开始时间)

     └─endDate

string

券有效期-结束日期(格式:yyyy-MM-dd HH:mm:ss)(券有效期 < 结束日期)

     └─memberOpenId

string

会员OpenId(非会员券,该信息为空)

     └─sendStoreCode

string

发放门店编码

     └─couponState

int32

券状态 1:待使用 2:已使用 3:已转换 4:已停用 5:已过期 6:待生效

     └─salePrice

number

券销售价

     └─transformCode

string

转换券码

     └─sendDate

string

发券时间(格式:yyyy-MM-dd HH:mm:ss)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": [
    {
      "couponCode": "68679",
      "couponType": 724,
      "carrierType": 823,
      "templateCode": "68679",
      "templateName": "ahmad.osinski",
      "couponValue": 489,
      "startDate": "2024-08-30",
      "endDate": "2024-08-30",
      "memberOpenId": "54",
      "sendStoreCode": "68679",
      "couponState": 2,
      "salePrice": 498,
      "transformCode": "68679",
      "sendDate": "2024-08-30"
    }
  ],
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 查询会员券

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  查询会员券列表(分页)

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求参数

Parameter Type Description Required

memberOpenId

string

会员openId

true

couponState

int32

券状态 1:待使用 2:已使用 3:已转换 4:已停用 5:已过期 6:待生效
如果为空,则查全部

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/coupon/queryByMember?sign=550652140273bc8c95b81f62acff295a&pageSize=10&timestamp=1724981797&token=3dw6l2&pageNo=1' --data '{
  "memberOpenId": "54",
  "couponState": 2
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

券信息

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─couponCode

string

券码

          └─couponType

int32

券类型 1:满减券

          └─carrierType

int32

载体类型 1:电子券 2:纸质券

          └─templateCode

string

模板编号

          └─templateName

string

模板名称

          └─couponValue

number

券面值(仅满减券有值,最大两位小数,单位:元)

          └─startDate

string

券有效期-开始日期(格式:yyyy-MM-dd HH:mm:ss)(券有效期 ≥ 开始时间)

          └─endDate

string

券有效期-结束日期(格式:yyyy-MM-dd HH:mm:ss)(券有效期 < 结束日期)

          └─memberOpenId

string

会员OpenId(非会员券,该信息为空)

          └─sendStoreCode

string

发放门店编码

          └─couponState

int32

券状态 1:待使用 2:已使用 3:已转换 4:已停用 5:已过期 6:待生效

          └─salePrice

number

券销售价

          └─transformCode

string

转换券码

          └─sendDate

string

发券时间(格式:yyyy-MM-dd HH:mm:ss)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "couponCode": "68679",
        "couponType": 417,
        "carrierType": 353,
        "templateCode": "68679",
        "templateName": "ahmad.osinski",
        "couponValue": 346,
        "startDate": "2024-08-30",
        "endDate": "2024-08-30",
        "memberOpenId": "54",
        "sendStoreCode": "68679",
        "couponState": 2,
        "salePrice": 758,
        "transformCode": "68679",
        "sendDate": "2024-08-30"
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 券核销信息查询接口

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  券核销信息查询(分页)

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

pageNo

int32

当前页码

true

pageSize

int32

每页数量(最大量=50)

true

请求参数

Parameter Type Description Required

consumeDate

string

核销日期(格式:yyyy-MM-dd)
核销日期与反核销日期,二者至少选其一

false

cancelDate

string

反核销日期(格式:yyyy-MM-dd)
核销日期与反核销日期,二者至少选其一

false

consumeState

int32

券核销状态仅支持1:已核销 0:已反核销
如果为空,则查全部

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/coupon/consume/page?sign=550652140273bc8c95b81f62acff295a&pageSize=10&timestamp=1724981797&token=jhyauy&pageNo=1' --data '{
  "consumeDate": "2024-08-30",
  "cancelDate": "2024-08-30",
  "consumeState": 2
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

券核销信息信息

     └─pageNo

int32

当前页码

     └─pageSize

int32

每页数量

     └─total

int64

总量

     └─data

array

数据

          └─couponCode

string

券码

          └─couponType

int32

券类型 1:满减券

          └─templateName

string

模板名称

          └─createPlatform

int32

创建平台(0其他 1烘焙云 2美团 4口碑 6抖音 。。。)

          └─sendPlatform

int32

发放平台(0其他 1烘焙云 2美团 4口碑 6抖音 。。。)

          └─carrierType

int32

载体类型 1:电子券 2:纸质券

          └─consumeState

int32

核销状态:1 已核销 0 已反核销

          └─consumeAmount

number

核销金额(最大两位小数,单位:元)

          └─salePrice

number

券销售价(最大两位小数,单位:元)

          └─consumeDate

string

核销时间(格式:yyyy-MM-dd HH:mm:ss)

          └─consumeStoreCode

string

核销门店编码

          └─consumeStoreName

string

核销门店名称

          └─consumeBizType

int32

核销单据类型:1 订单 2 充值单 3 合作客户核销(待开放)

          └─consumeBizCode

string

核销单据编号

          └─cancelDate

string

反核销时间(格式:yyyy-MM-dd HH:mm:ss)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
      {
        "couponCode": "68679",
        "couponType": 684,
        "templateName": "ahmad.osinski",
        "createPlatform": 339,
        "sendPlatform": 337,
        "carrierType": 247,
        "consumeState": 2,
        "consumeAmount": 182,
        "salePrice": 815,
        "consumeDate": "2024-08-30",
        "consumeStoreCode": "68679",
        "consumeStoreName": "ahmad.osinski",
        "consumeBizType": 896,
        "consumeBizCode": "68679",
        "cancelDate": "2024-08-30"
      }
    ]
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 券模板创建

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  创建券模板,用于券发放

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

name

string

名称(最多64位)

true

quoteCode

string

三方编号(最多64位)

false

type

int32

类型 1:满减券

true

value

number

面值(满减券时,必填;最大两位小数,单位:元)

false

carrierType

int32

载体类型:1、电子券;2、纸质券

true

codeRule

object

券码生成规则

true

└─type

int32

券码规则类型: 1:烘焙云规则 2:指定规则

true

└─prevCode

string

前缀
券码规则类型为 指定规则 时,该项必填
注:1、不能是Y、HBY、HYX、33~100
2、大小写不敏感,如是英文请大写

false

└─serialLength

int32

序号位长度
券码规则类型为 指定规则 时,该项必填
注:不能小于8

false

└─passwordLength

int32

密码位长度
券码规则类型为 指定规则 时,该项必填
注:不能小于4

false

sendChannel

int32

发放渠道 1:活动

true

sendNum

int32

发放数量

false

usedRule

object

使用规则

true

└─onlyMemberUse

int32

仅限会员使用 0:否(券可不绑定会员使用) 1:是(券必须绑定会员后才可使用)

true

└─onlineStoreType

int32

适用线上门店类型 0 全部
适用线上门店类型 与 适用线下门店类型 不可同时为空

false

└─storeType

int32

适用线下门店类型 0 全部 1 仅发放门店 2 指定门店
适用线下门店类型 与 适用线上门店类型 不可同时为空

false

└─storeCodes

array

线下门店编码数组(["aaa","bbb"])
适用线下门店类型为 指定门店 时,该项必填

false

└─dealAmount

number

整单金额(最大两位小数,单位:元)
>= 整单金额,可使用

false

└─goodsType

int32

适用商品类型 0 全部 1 指定商品

true

└─goodsCodes

array

商品编码数组(["aaa","bbb"])
适用商品类型为 指定商品 时,该项必填
该字段目前支持两种取值。1烘焙云线下商品查询接口返回的物料序号(历史对接方式,不推荐),2调用烘焙云三方商品创建接口时返回的三方商品sku编码(推荐)

false

└─goodsAmount

number

商品金额(最大两位小数,单位:元)
>= 商品金额,可使用

false

└─goodsNumber

number

商品数量
>= 商品数量,可使用

false

└─isSuperimposedUse

int32

是否可叠加使用 0:否(不可叠加) 1:是(允许叠加)

true

effectDate

object

生效时间

true

└─type

int32

类型 1:绝对日期 2:领取后多少天

true

└─value

string

设置值
类型为:绝对日期 时,设置为日期(格式:yyyy-MM-dd HH:mm:ss);
类型为:领取后多少天 时,设置为数值

true

expiredDate

object

失效时间

true

└─type

int32

类型 1:绝对日期 2:领取后多少天

true

└─value

string

设置值
类型为:绝对日期 时,设置为日期(格式:yyyy-MM-dd HH:mm:ss);
类型为:领取后多少天 时,设置为数值

true

canRecharge

int32

是否可充值余额 0:否 1:是

true

rechargeAmount

number

充值金额(最大两位小数,单位:元)
当是否可充值余额为 是 时,该字段必填

false

transformTemplateCodes

array

可转换模板编号数组(["aaa","bbb"])
最多可支持3个转换模板

false

instructionsForUse

string

使用说明(最多250位)

false

remark

string

备注(最多50位)

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/coupon/template/create?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=4mqpy0' --data '{
  "name": "ahmad.osinski",
  "quoteCode": "68679",
  "type": 143,
  "value": 646,
  "carrierType": 51,
  "codeRule": {
    "type": 526,
    "prevCode": "68679",
    "serialLength": 718,
    "passwordLength": 14
  },
  "sendChannel": 914,
  "sendNum": 382,
  "usedRule": {
    "onlyMemberUse": 397,
    "onlineStoreType": 493,
    "storeType": 812,
    "storeCodes": [
      "q2pv29"
    ],
    "dealAmount": 373,
    "goodsType": 429,
    "goodsCodes": [
      "w269a8"
    ],
    "goodsAmount": 940,
    "goodsNumber": 848,
    "isSuperimposedUse": 951
  },
  "effectDate": {
    "type": 526,
    "value": "9o97ku"
  },
  "expiredDate": {
    "type": 246,
    "value": "8helec"
  },
  "canRecharge": 956,
  "rechargeAmount": 17,
  "transformTemplateCodes": [
    "p46xdx"
  ],
  "instructionsForUse": "e0b9g3",
  "remark": "kox7hp"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

券模板

     └─code

string

券模板编号

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "code": "68679"
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 券模板变更

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  变更指定的券模板信息,全量数据覆盖更新,该模板下待使用的券将会使用新规则

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

code

string

编号

true

name

string

名称(最多64位)

true

value

number

面值(满减券时,必填;最大两位小数,单位:元)

false

usedRule

object

使用规则

true

└─onlyMemberUse

int32

仅限会员使用 0:否(券可不绑定会员使用) 1:是(券必须绑定会员后才可使用)

true

└─onlineStoreType

int32

适用线上门店类型 0 全部
适用线上门店类型 与 适用线下门店类型 不可同时为空

false

└─storeType

int32

适用线下门店类型 0 全部 1 仅发放门店 2 指定门店
适用线下门店类型 与 适用线上门店类型 不可同时为空

false

└─storeCodes

array

线下门店编码数组(["aaa","bbb"])
适用线下门店类型为 指定门店 时,该项必填

false

└─dealAmount

number

整单金额(最大两位小数,单位:元)
>= 整单金额,可使用

false

└─goodsType

int32

适用商品类型 0 全部 1 指定商品

true

└─goodsCodes

array

商品编码数组(["aaa","bbb"])
适用商品类型为 指定商品 时,该项必填
该字段目前支持两种取值。1烘焙云线下商品查询接口返回的物料序号(历史对接方式,不推荐),2调用烘焙云三方商品创建接口时返回的三方商品sku编码(推荐)

false

└─goodsAmount

number

商品金额(最大两位小数,单位:元)
>= 商品金额,可使用

false

└─goodsNumber

number

商品数量
>= 商品数量,可使用

false

└─isSuperimposedUse

int32

是否可叠加使用 0:否(不可叠加) 1:是(允许叠加)

true

effectDate

object

生效时间

true

└─type

int32

类型 1:绝对日期 2:领取后多少天

true

└─value

string

设置值
类型为:绝对日期 时,设置为日期(格式:yyyy-MM-dd HH:mm:ss);
类型为:领取后多少天 时,设置为数值

true

expiredDate

object

失效时间

true

└─type

int32

类型 1:绝对日期 2:领取后多少天

true

└─value

string

设置值
类型为:绝对日期 时,设置为日期(格式:yyyy-MM-dd HH:mm:ss);
类型为:领取后多少天 时,设置为数值

true

canRecharge

int32

是否可充值余额 0:否 1:是

true

rechargeAmount

number

充值金额(最大两位小数,单位:元)
当是否可充值余额为 是 时,该字段必填

false

transformTemplateCodes

array

可转换模板编号数组(["aaa","bbb"])
最多可支持3个转换模板

false

instructionsForUse

string

使用说明(最多250位)

false

remark

string

备注(最多50位)

false

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/coupon/template/update?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=ipfllm' --data '{
  "code": "68679",
  "name": "ahmad.osinski",
  "value": 60,
  "usedRule": {
    "onlyMemberUse": 702,
    "onlineStoreType": 427,
    "storeType": 905,
    "storeCodes": [
      "cmr7gu"
    ],
    "dealAmount": 238,
    "goodsType": 314,
    "goodsCodes": [
      "ap1wwa"
    ],
    "goodsAmount": 25,
    "goodsNumber": 179,
    "isSuperimposedUse": 814
  },
  "effectDate": {
    "type": 689,
    "value": "refnzr"
  },
  "expiredDate": {
    "type": 851,
    "value": "eowx1x"
  },
  "canRecharge": 641,
  "rechargeAmount": 930,
  "transformTemplateCodes": [
    "ul6jse"
  ],
  "instructionsForUse": "s6d6rc",
  "remark": "xjzgby"
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

变更结果

     └─updateResult

boolean

变更结果 true:成功 false:失败

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": {
    "updateResult": true
  },
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 券模板查询

当前版本:  1.0

请求类型:  GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  根据指定的券模板编号,批量查询券模板信息

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

codes

array

编号数组(aaa,bbb)

true

请求示例

curl -X GET -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/coupon/template/listByCodes?token=wtvero&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a&codes=bqm3rf'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

array

券模板信息

     └─code

string

编号

     └─name

string

名称

     └─type

int32

类型 1:满减券

     └─value

number

面值(满减券时,单位:元)

     └─carrierType

int32

载体类型:1、电子券;2、纸质券

     └─codeRule

object

券码生成规则

          └─prevCode

string

前缀

          └─serialLength

int32

序号位长度

          └─passwordLength

int32

密码位长度

     └─sendChannel

int32

发放渠道 1:活动 2:销售

     └─usedRule

object

使用规则

          └─onlyMemberUse

int32

仅限会员使用 0:否(券可不绑定会员使用) 1:是(券必须绑定会员后才可使用)

          └─onlineStoreType

int32

适用线上门店类型 0 全部

          └─storeType

int32

适用线下门店类型 0 全部 1 仅发放门店 2 指定门店

          └─storeCodes

array

线下门店编码数组(["aaa","bbb"])

          └─dealAmount

number

整单金额(单位:元)

          └─goodsType

int32

适用商品类型 0 全部 1 指定商品

          └─goodsCodes

array

商品编码数组(["aaa","bbb"])
未对接三方商品返回:烘焙云线下商品查询接口返回的物料序号(历史对接方式)
对接三方商品返回:调用烘焙云三方商品创建接口时返回的三方商品sku编码

          └─goodsAmount

number

商品金额(单位:元)

          └─goodsNumber

number

商品数量

          └─isSuperimposedUse

int32

是否可叠加使用 0:否(不可叠加) 1:是(允许叠加)

     └─effectDate

object

生效时间

          └─type

int32

类型 1:绝对日期 2:领取后多少天

          └─value

string

设置值

     └─expiredDate

object

失效时间

          └─type

int32

类型 1:绝对日期 2:领取后多少天

          └─value

string

设置值

     └─canRecharge

int32

是否可充值余额 0:否 1:是

     └─rechargeAmount

number

充值金额(最大两位小数,单位:元)

     └─transformTemplateCodes

array

可转换模板编号数组(["aaa","bbb"])

     └─instructionsForUse

string

使用说明

     └─remark

string

备注

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": [
    {
      "code": "68679",
      "name": "ahmad.osinski",
      "type": 15,
      "value": 541,
      "carrierType": 152,
      "codeRule": {
        "prevCode": "68679",
        "serialLength": 79,
        "passwordLength": 799
      },
      "sendChannel": 212,
      "usedRule": {
        "onlyMemberUse": 260,
        "onlineStoreType": 316,
        "storeType": 27,
        "storeCodes": [
          "zi7wwq"
        ],
        "dealAmount": 425,
        "goodsType": 786,
        "goodsCodes": [
          "xsamig"
        ],
        "goodsAmount": 372,
        "goodsNumber": 891,
        "isSuperimposedUse": 43
      },
      "effectDate": {
        "type": 941,
        "value": "2ylhcl"
      },
      "expiredDate": {
        "type": 321,
        "value": "5lxfe2"
      },
      "canRecharge": 71,
      "rechargeAmount": 905,
      "transformTemplateCodes": [
        "b2j4xr"
      ],
      "instructionsForUse": "ni1b1k",
      "remark": "xtxsb4"
    }
  ],
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 券销售

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  券销售,根据优惠券设置的发放规则自动匹配券销售
注:1、一次最多可销售券数量为2000张
2、三方单号是幂等字段,如果请求超时(建议设置超时时间为5秒),请重新请求

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

thirdCode

string

三方单号(唯一,幂等)

true

channel

int32

渠道 - 0其它 1门店 2总部 3商城 4拼团 5秒杀 6外卖

true

customerCode

string

客户编码

true

customerName

string

客户名称

false

contactName

string

联系人名称

false

contactMobile

string

联系人电话

false

preTime

string

下单时间,格式:yyyy-MM-dd HH:mm:ss

true

preStoreCode

string

下单门店编号

true

preOperatorName

string

下单操作员名称

true

departmentName

string

业务部门名称

true

operatorName

string

业务人员名称

true

payTypeCode

string

支付方式 0 其他 1 银行卡 2 现金 3支付宝 4微信 5 会员卡余额 204礼品卡
如需对接详细支付方式,可以在烘焙云控制台【系统】-【系统配置】-【支付配置】功能模块内查看支付方式

true

payTypeName

string

支付方式名称

true

sellerRemark

string

商家备注

false

useScene

string

用途
如需对接详细用途,可以在烘焙云控制台【系统】-【系统配置】-【数据参数设置】-【卡券用途】功能模块内查看

true

couponDetails

array

券明细(最多20种)

true

└─line

int32

行号

true

└─templateCode

string

模板编号

true

└─originPrice

number

单券原始单价(最多2位小数)

true

└─num

int32

销售数量(最大1000)

true

└─realAmount

number

销售总价(最多2位小数)

true

└─sendWay

int32

发放方式:1、电子券;2、纸质券

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/coupon/sale/create?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=ekxyf4' --data '{
  "thirdCode": "68679",
  "channel": 691,
  "customerCode": "68679",
  "customerName": "ahmad.osinski",
  "contactName": "ahmad.osinski",
  "contactMobile": "1-219-551-0212",
  "preTime": "2024-08-30 09:36:37",
  "preStoreCode": "68679",
  "preOperatorName": "ahmad.osinski",
  "departmentName": "ahmad.osinski",
  "operatorName": "ahmad.osinski",
  "payTypeCode": "68679",
  "payTypeName": "ahmad.osinski",
  "sellerRemark": "zvqbrv",
  "useScene": "iat5pt",
  "couponDetails": [
    {
      "line": 721,
      "templateCode": "68679",
      "originPrice": 107,
      "num": 379,
      "realAmount": 661,
      "sendWay": 113
    }
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

烘焙云券销售单号

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": "0atlwb",
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

 券销售退单申请

当前版本:  1.0

请求类型:  POST

Content-Type: application/json; charset=utf-8

描述:  券销售退单申请

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

Parameter Type Description Required

thirdCode

string

三方退单号(唯一,幂等)

true

saleCode

string

销售单号,券销售接口返回的销售单号

true

channel

int32

渠道 - 0其它 1门店 2总部 3商城 4拼团 5秒杀 6外卖

true

cancelTime

string

退单时间,格式:yyyy-MM-dd HH:mm:ss

true

cancelOperatorName

string

退单操作员名称

true

refundTypeCode

string

退款方式 0 其他 1 银行卡 2 现金 3支付宝 4微信 5 会员卡余额 204礼品卡
如需对接详细支付方式,可以在烘焙云控制台【系统】-【系统配置】-【支付配置】功能模块内查看支付方式

true

refundTypeName

string

退款方式名称

true

sellerRemark

string

商家备注

false

cancelType

int32

退单类型 1 全部退 2 自定义退

true

couponDetails

array

券明细(最多20种)
当cancelType=2时,券明细不可为空

false

└─line

int32

行号

true

└─templateCode

string

模板编号

true

└─originPrice

number

单券原始单价(最多2位小数)

true

└─num

int32

退单数量

true

└─realAmount

number

退单总价(最多2位小数)

true

请求示例

curl -X POST -k -H 'Content-Type: application/json; charset=utf-8' -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/coupon/sale/cancelApply?sign=550652140273bc8c95b81f62acff295a&timestamp=1724981797&token=3nlalv' --data '{
  "thirdCode": "68679",
  "saleCode": "68679",
  "channel": 902,
  "cancelTime": "2024-08-30 09:36:37",
  "cancelOperatorName": "ahmad.osinski",
  "refundTypeCode": "68679",
  "refundTypeName": "ahmad.osinski",
  "sellerRemark": "q8fbz6",
  "cancelType": 571,
  "couponDetails": [
    {
      "line": 790,
      "templateCode": "68679",
      "originPrice": 915,
      "num": 921,
      "realAmount": 50
    }
  ]
}'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

object

烘焙云券退单号

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": "bp2vcl",
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

4.11. 活动

 充值活动

当前版本:  1.0

请求类型:  GET

Content-Type: application/x-www-form-urlencoded;charset=utf-8

描述:  获取会员可参加的可用的充值活动

请求头

参数 类型 描述 是否必填

version

string

版本号

true

公共请求参数

参数 类型 描述 是否必填

token

string

有效令牌,调用token申请接口获取,有效时间为2小时,过期需要重新申请

true

timestamp

string

第三方发起请求的时间戳,用户校验请求时间,默认超过300s,则请求失效

true

sign

string

签名,将所有参数按顺序排列后进行md5加密(小写),签名规则详见 参数签名算法

true

请求参数

参数 类型 描述 是否必填

memberOpenId

string

会员openId

true

请求示例

curl -X GET -k -H 'version:1.0' -i 'https://iop.hongbeiyun.com/api/activity/recharge/listByMember?token=08s9qz&timestamp=1724981797&sign=550652140273bc8c95b81f62acff295a&memberOpenId=54'

响应参数

参数 类型 描述

success

boolean

响应结果标识。 true:成功 false:失败

code

string

网关返回码

message

string

网关返回码描述

sub_code

string

业务返回码

sub_message

string

业务返回码描述

data

array

充值活动信息

     └─code

string

活动编码

     └─name

string

活动名称

     └─explanation

string

活动说明

     └─storeType

int32

可参与活动门店类型 0 全部 1 指定门店

     └─storeCodes

array

可参与活动门店编码数组(["aaa","bbb"])

     └─description

string

描述

     └─payAmount

number

支付金额(单位:元)

     └─rechargeAmount

number

充值金额(单位:元)

     └─giftAmount

number

赠送金额(单位:元)(不支持负值)

     └─giftIntegral

int32

赠送积分

     └─giftGrowth

int32

赠送成长值

     └─giftCoupons

array

赠送优惠券

          └─templateCode

string

券模板编号

          └─num

int32

数量

     └─isLimitFirst

int32

是否限制首次充值 1:仅限首次充值 0:不限制

     └─isSuperimposedUse

int32

是否可叠加使用 0:否(不可叠加) 1:是(允许叠加)

timestamp

string

时间戳

sign

string

签名

响应示例

{
  "success": true,
  "code": "200",
  "message": "",
  "sub_code": "200",
  "sub_message": "",
  "data": [
    {
      "code": "68679",
      "name": "ahmad.osinski",
      "explanation": "tadzjb",
      "storeType": 165,
      "storeCodes": [
        "h2nul5"
      ],
      "description": "wiril2",
      "payAmount": 513,
      "rechargeAmount": 118,
      "giftAmount": 720,
      "giftIntegral": 621,
      "giftGrowth": 90,
      "giftCoupons": [
        {
          "templateCode": "68679",
          "num": 912
        }
      ],
      "isLimitFirst": 95,
      "isSuperimposedUse": 813
    }
  ],
  "timestamp": "1724981797",
  "sign": "550652140273bc8c95b81f62acff295a"
}

5. 事件通知列表

公共请求参数

参数 类型 描述

appCode

string

应用编码

timestamp

string

时间戳(s)

sign

string

签名

data

object

内容

               └─eventTypeCode

string

事件编码

               └─eventData

string

事件内容(详见事件列表内容定义)

5.1. 订单

事件编码 事件名称 触发场景 通知内容

200110001

订单下单

烘焙云下单后

基础信息、商品信息、优惠信息、赠送信息、物流信息、支付流水信息,本通知详细结构同订单详情查询接口返回值  展开

200110002

订单接单

门店确认收到订单信息后确认接单

订单号、接单时间  展开

200110003

订单提货

门店自提单提货

订单号、提货时间  展开

200110004

订单发货

订单内所有商品发货后,订单变为已发货状态

订单号、发货时间、物流详细信息(同查询物流详情接口返回值)  展开

200110005

订单取消预订

订单尚未提、发货时,订单被取消

订单号、取消时间、退款流水信息(同订单详情查询接口内支付流水信息)  展开

200110006

订单退单

订单已提、发货,物料已出库后,订单被取消

订单号、退单时间、退款流水  展开

200110007

订单收货确认

顾客主动确认收货,或系统自动确认收货

订单号、确认收货时间  展开

200110008

订单部分退款

订单发生部分退还业务

订单号,退还信息  展开

200111001

订单履约门店变更

使用调拨业务更改履约门店

订单号、新旧门店信息  展开

200111002

订单生产门店变更

使用调拨业务更改生产门店

订单号、新旧门店信息  展开

200111003

门店预订信息变更

订单提发货之前,对预订信息进行修改

订单号、变更信息的新旧值  展开

200112001

订单取消预订申请

门店发起订单退订请求

订单号  展开

200112002

订单退单申请

门店发起订单退单请求

订单号  展开

5.2. 优惠券

事件编码 事件名称 触发场景 通知内容

200060002

券有效期变更

修改券的有效期时触发

券码、模板编号、券状态、券开始时间、券结束时间、发生时间  展开

200060003

券发放

发放渠道:活动,在发放时触发;发放渠道:销售,在销售时触发

券信息,参考券查询接口  展开

200060004

券核销

券核销时触发

券码、券模板编号、券状态、交易场景、交易单号、会员OpenId、门店编码、客户姓名、客户手机号、发生时间  展开

200060005

券反核销

券反核销时触发

券码、券模板编号、券状态、交易单号、反核销原因、发生时间  展开

200060006

券停用

券停用时触发

券码、券模板编号、券状态、停用原因、发生时间  展开

200060007

券启用

券启用时触发

券码、券模板编号、券状态、启用原因、发生时间  展开

200060008

券转换

券转换时触发

券码、券模板编号、券状态、转换券号、发生时间  展开

200060009

券绑定会员

券绑定会员时触发

券码、券模板、券状态、会员OpenId、发生时间  展开

200061001

券模板创建

券模板创建时触发

券模板信息,参考券模板创建接口  展开

200061002

券模板更新

券模板更新时触发

券模板信息,参考券模板创建接口  展开

200062001

券销售退单审核结果

券销售退单申请审核时触发

烘焙云券退单号、审核结果、审核时间  展开

5.3. 配送

事件编码 事件名称 触发场景 通知内容

200100002

配送单审核出库(已过期,不建议使用)

配送单审核出库;配送单取消审核

配送单编码,多个用逗号隔开 

200100201

配送单配送出库

配送单审核出库后

配送单全量信息  展开

200100202

配送单取消配送

配送单取消审核后

配送单号 取消时间  展开

200100203

配送单确认收货

配送单确认收货后

配送单号 收货时间  展开

5.4. 线下商品

事件编码 事件名称 触发场景 通知内容

200040001

物料信息变更

新增和变动物料信息时触发

物料完整信息  展开

200040002

线下商品变更

新增和变动商品时触发

线下商品全量信息  展开

5.5. 库存

事件编码 事件名称 触发场景 通知内容

200130001

线下商品库存信息变动

库存发生变动,或库存类型发生变动

门店编码、线下商品编码、库存类型(1无限、2同步门店、3每日可售)、库存值  展开

200130003

线下商品库存停用

商品在门店内暂时停止售卖

门店编码、线下商品编码  展开

5.6. 盘点

事件编码 事件名称 触发场景 通知内容

200100701

门店盘点

门店盘点上传后

盘点单全量信息  展开

5.7. 商品

事件编码 事件名称 触发场景 通知内容

200050001

门店商品上架

商品在门店上架时

门店编码、烘焙云商品编码  展开

200050002

门店商品下架

商品在门店下架时

门店编码、烘焙云商品编码  展开

5.8. 调拨

事件编码 事件名称 触发场景 通知内容

200100501

门店调拨

门店调拨单上传后

调拨单全量信息  展开

200100502

门店调拨确认收货

门店调拨单确认收货后

调拨单号 收货时间  展开

5.9. 采购

事件编码 事件名称 触发场景 通知内容

200100301

门店采购

门店采购上传后

采购单全量信息  展开

5.10. 退货

事件编码 事件名称 触发场景 通知内容

200100601

门店退货

门店退货单上传后/订单退货保存后

退货单全量信息  展开

200100602

门店退货审核

门店退货审核后

退货单审核信息  展开

5.11. 要货

事件编码 事件名称 触发场景 通知内容

200100001

要货单导入ERP(已过期,不建议使用)

要货单导入ERP

要货单编码,多个用逗号隔开 

200100101

要货单审核通过

要货单审核通过后

要货单全量信息  展开

200100102

要货单取消审核

要货单取消审核后

要货单号 取消时间  展开

200100103

要货单导入erp

要货单导入erp后

要货单号列表 导入时间  展开

200100151

要货单新增

要货单新增

要货单全量信息  展开

200100152

要货单变更

要货单变更

要货单全量信息  展开

200100153

要货单删除

要货单删除

要货单号 

5.12. 会员

事件编码 事件名称 触发场景 通知内容

200140001

会员基础信息变更

会员基础信息发生变更时

会员openId  展开

200140002

烘焙云创建会员

烘焙云系统创建会员时

会员openId、姓名、性别、生日、邮箱、手机号、家庭住址、来源门店  展开

200140003

会员余额变更

会员的余额发生变更时

会员openId、变动场景类型、变动场景名称、业务编号、流水号、门店编码、变动数量、变动后余额、本金变动数量、本金变动后值、赠送金变动数量、赠送金变动后值、原因、变动时间  展开

200140004

会员积分变更

会员的积分发生变更时

会员openId、变动场景类型、变动场景名称、业务编号、流水号、门店编码、变动数量、变动后积分、原因、变动时间  展开

200140005

会员成长值变更

会员的成长值发生变更时

会员openId、变动场景类型、变动场景名称、业务编号、流水号、门店编码、变动数量、变动后成长值、原因、变动时间  展开

200140007

会员手机号变更

会员手机号发生变更时

会员openId、变更后手机号  展开

200140008

会员合并

会员发生合并时

目标会员OpenId、被并会员Openid  展开

5.13. 工厂基础信息

事件编码 事件名称 触发场景 通知内容

200020101

工厂信息变更

新增和变动工厂信息时触发

工厂完整信息  展开

200020201

仓库信息变更

新增和变动仓库信息时触发

仓库完整信息  展开

200020301

退货原因变更

新增和变动退货原因时触发

退货原因完整信息  展开

5.14. 组合完工

事件编码 事件名称 触发场景 通知内容

200100401

门店组合完工

门店组合完工单上传后

完工单全量信息  展开

5.15. 拆分完工

事件编码 事件名称 触发场景 通知内容

200100801

门店拆分完工

门店拆分完工单上传后

完工单全量信息  展开

5.16. 门店

事件编码 事件名称 触发场景 通知内容

200030001

门店信息变更

新增和变动门店信息时触发

门店完整信息  展开

6. 错误码列表

6.1. 活动

错误码 描述

100150001

参数校验异常

100150002

券数据异常

100159999

活动业务异常

6.2. 商品

错误码 描述

100050001

三方商品编码已存在

100050002

三方商品sku编码已存在

100050003

商品编码格式不正确

100050004

无效的商品编码

100050005

商品sku编码格式不正确

100050006

无效的商品sku编码

100050007

商品不存在

100050008

商品已上架

100050009

商品已下架

100050010

物料序号{}不存在

100059999

商品业务异常

6.3. 订单

错误码 描述

100110003

流水编号不能重复

100110004

确认订单数量超过限制

100110005

超过查询时间限制

100110006

退款流水与退款总金额不符

100110007

获取执行权限超时,订单正在进行其他业务操作。

100110008

订单正在进行其他操作,请稍后重试

100110009

订单目前状态无法进行此操作

100110010

订单正在退订中

100110011

订单正在退单中

100110012

订单正在提货中

100110013

订单正在发货中

100110014

订单正在同步中

100110015

退款金额不能超出支付金额

100111001

暂不支持此操作

100111002

订单总金额有误

100111003

订单优惠金额有误

100111004

支付金额不能高于应付金额

100111005

订单支付金额与流水不符

100111006

组装门店返回值错误

100113004

未获取到创建事件

100113005

订单事件信息不完整

100113006

请传入三方单号

100113007

订单内物料信息不完整

100113008

无关联物料

100113009

下单门店或提货门店为空

100113010

未获取到三方订单

100113011

流水号已存在

100113012

流水批次号已存在

100113013

流水批次号不一致

100113014

退还的商品不存在

404

订单信息不存在

6.4. 优惠券

错误码 描述

100060001

参数校验异常

100060002

券数据异常

100061001

券不存在

100061002

券已锁定

100061003

交易与券不一致

100061004

券消费金额超过设置金额

100061005

券已绑定会员

100061006

券禁止绑定会员

100062001

券已核销

100062002

券已过期

100062003

券待生效

100062004

券未核销

100062005

券已停用

100062006

券已转换

100063001

券模板不存在

100063002

券模板已停用

100069999

券业务异常

6.5. 充值单

错误码 描述

100209997

充值单业务参数校验异常

100209998

未获得执行权限

100209999

充值单业务异常

6.6. 门店仓储

错误码 描述

100100101

要货单号错误

100100102

要货审核明细重复

100100103

要货单不能审核

100100104

存在不是本单的要货物料编码:

100100105

存在本单要货模板不支持的供货仓库编码:

100100208

要货模板编码错误

1001005001

门店调拨业务参数异常

1001005607

门店调拨三方单号已存在

1001005999

门店调拨业务异常

100101001

门店其他出入库业务参数异常

100101099

门店其他出入库业务异常

100160001

该单号已存在,不能重复写入

100160002

发货工厂编码错误

100160003

发货仓库编码错误

100160004

收货门店编码错误

100160005

收货车间编码错误

100160006

物料序号错误

100160007

无配送明细

100160099

业务异常

100170001

三方单号已存在,不能重复写入

100170002

创建门店退货单失败

100170003

查询门店退货单失败

100170004

退货明细重复

100170005

退货单号错误

100170006

审核退货明细错误

100170007

退货明细已审核

100170099

业务异常

100181001

门店实存业务参数异常

100181999

门店实存业务异常

100191001

门店完工业务参数异常

100191999

门店完工业务异常

100211001

门店盘点业务参数异常

100219999

门店盘点业务异常

6.7. 会员

错误码 描述

100140001

会员OpenId格式不正确

100140002

无效的会员OpenId

100140003

会员不存在

100140004

会员账户已挂失

100140005

会员余额不足

100140006

会员积分不足

100140007

会员成长值不足

100140008

来源门店不存在

100140009

冲正业务单号余额变动不存在

100140010

冲正金额超出原业务金额

100140011

流水号重复

100140012

手机号已存在会员

100140013

微信UnionId已被占用

100140014

微信公众号OpenId已被占用

100140015

微信小程序OpenId已被占用

100140016

会员没有微信信息

100140017

会员UnionId不匹配

100140018

密码解密失败

100140019

折扣卡会员

100140020

未获得该等级设置信息

100140021

变更等级成长值小于当前等级成长值

100140022

业务单号已完成冲正,不能再次冲正

100140023

登录密码明文格式不正确(6位数字)

100140024

会员与卡号不匹配

100140025

卡号已挂失

100140026

卡号状态正常

100140027

新旧密码不能相同

100140028

密码校验不通过

100140029

会员已存在密码

100140030

支付方式不能为空

100140031

无效的微信UnionId

100140032

手机号注册中,请勿重复注册

100140033

微信UnionId无绑定会员

100140034

被并会员有进行中的PLUS权益

100140035

目标会员余额超出{}的限制

100140036

共享会员与非共享会员不允许合并

100140037

{}已挂失不允许合并

100140038

会员类型无{}权限

100140039

会员类型不允许合并

100149997

参数校验异常

100149998

未获得执行权限

100149999

会员业务异常

6.8. 错误码列表

错误码 描述

100020101

工厂编码错误

100020201

仓库编码错误

100030101

门店编码错误

100030201

车间编码错误

100040001

物料序号错误

50101

POS网络异常

6.9. 系统

错误码 描述

40000

参数值有误,请检查

40001

请求参数不含有任何公共头信息

40002

签名不能为空

40003

TOKEN不能为空

40004

商户代码不能为空

40005

商户代码必须为1~16位英文字母

40006

应用名必须为1~8位英文字母

40007

应用名不合法

40008

事件推送地址不能为空

40009

推送地址不合法

40010

应用编码不能为空

40011

方法名不能为空

40012

时间戳不能为空

40013

字符集不能为空

40014

应用已暂停

40100

签名未通过校验

40101

签名加密类型不合法

40130

无权访问

40131

未获取到应用

40132

触发应用级限流

40300

字符集暂不支持

40301

TOKEN已失效

40400

URI不能为空

40500

平台暂不支持该请求方式

40501

方法名不合法

40800

请求时刻超出有效请求时刻

41200

版本号不合法

41500

平台暂不支持该content-type,请设置为application/x-www-form-urlencoded

50000

内部错误:因为意外情况,服务器不能完成请求

50001

创建秘钥失败

50002

创建应用失败

50003

创建请求日志失败

50004

应用名称已存在

50005

应用尚未注册

50006

应用信息缓存读写失败

50007

开放平台系统层级异常,请联系平台管理员

50041

创建事件失败

50042

批量创建事件发送任务失败

50043

未查询到与该事件相关的应用

6.10. 礼品卡

错误码 描述

100220001

礼品卡不存在

100220002

礼品卡状态不可核销,状态为{}

100220003

礼品卡密码校验不通过

100220004

来源门店不存在

100220005

礼品卡密码解密失败

100220006

礼品卡卡号重复

100220007

礼品卡{}不存在

100220008

礼品卡{}不属于会员

100220009

礼品卡{}状态为{},不可扣减

100229997

礼品卡业务参数校验异常

100229998

礼品卡业务未获得执行权限

100229999

礼品卡业务异常

Top