变动记录
序号 修改内容 日期 1 1、订单推送(正常零售)接口增加字段:sales_type 必传,值为:正常
2、新增 售后接口(退货退款、换货):
2-1、退货退款 ,注意:sales_type 必传,值为:退货,其中退货明细(detail_list)中需传递:refund_num 退货数量字段,其余明细属性信息按照原单对应明细补充即可;由于售后需要关联原单,所以售后接口入参需要传递两个字段,最原始销售单POS销售单号,当前售后单关联的上一个POS销售单号,详情请看接口
2-2、换货 ,注意:sales_type 必传,值为:换货,其中明细分两层,换货明细第一层即需要退货商品信息,第一层需要传递:refund_num 退货数量字段,每个退货商品信息内部传递第二层该退货对应换货商品明细(exchange_detail_list),换货商品信息:num 即换货数量字段正常传递即可;由于售后需要关联原单,所以售后接口入参需要传递两个字段,最原始销售单POS销售单号,当前售后单关联的上一个POS销售单号,详情请看接口2026-06-16
订单相关接口
订单推送
正常零售
描述
根据订单相关信息: 主单:订单号、门店、会员、配送方式、收货人、收货地址、总下单量、金额、下单时间、付款时间、发货时间、备注等 明细:款号、商家编码(sku)、商品信息、数量、单价、优惠金额、实付价格、货款金额、优惠金额、实付金额、备注等 推送订单相关信息请求
名称 请求方式 POST 请求地址 http://api.yptcgroup.com/thirdpart/bojun/orders/push 公共参数(请求头)
名称 类型 是否必填 描述 appKey String 是 鉴权凭证,应用标识,用于请求API timestamp String 是 鉴权凭证,请求时间戳(毫秒) nonce String 是 随机字符串(防重放,需保证唯一性) sign String 是 签名值,生成方式有提供demo,具体参照示例 请求体
名称 类型 是否必填 描述 biz_no String 是 订单编号(外部单号),例:XXXX202601011200 sales_type String 是 销售类型: 正常、退货、换货
正常零售传:正常vip_mobile String 否 会员手机号,若传值则会按照会员折扣计算相关价格 delivery_type Integer 否 配送方式,0:自提 1:快递 receiver_name String 否 收货人名称 receiver_phone String 否 收货人手机号 receiver_province String 否 收货人地址省 receiver_city String 否 收货人地址市 receiver_district String 否 收货人地址区 receiver_address String 否 收货人地址详情 total_num Integer 是 总下单数量,例:1 total_amount decimal(16,2) 是 总下单货款金额,例:600.00 total_discount_amount decimal(16,2) 是 总下单优惠金额,例:100.00 total_actual_amount decimal(16,2) 是 总下单实付金额,例:500.00 order_time Date 是 用户下单时间,时间格式为:yyyy年-MM月-dd日 HH时:mm分:ss秒
例:2026-04-01 23:59:59pay_time Date 是 用户付款时间,时间格式为yyyy年-MM月-dd日 HH时:mm分:ss秒
例:2026-04-01 23:59:59delivery_time Date 否 发货时间,时间格式为yyyy年-MM月-dd日 HH时:mm分:ss秒
例:2026-04-01 23:59:59platform_type Integer 是 默认传:1 即可 remark String(255) 否 备注 detail_list List 是 商品明细 pay_list List 是 付款明细 仅需要传一种即可
例:
[{"pay_way":"微信","pay_amount",500}]明细:detail_list
名称 类型 是否必填 描述 goods_no String 是 大货款号 merchant_code String 是 商家编码,商品sku,例:GQS130HM color String 是 颜色,例:蓝灰色 size String 是 尺码 , 例:155 spec_name String 是 商品规格信息,例:蓝灰色_155 num Integer 是 数量,例:2 price decimal(16,4) 是 吊牌零售价,例:300 discount_price decimal(16,4) 否 优惠金额,例:50 actual_price decimal(16,4) 是 实付价格,例:250 amount decimal(16,4) 是 货款金额,例:600 300*2 (实际数量 x 吊牌零售价) discount_amount decimal(16,4) 否 优惠金额,例:100 50*2 (实际数量 x 优惠金额) actual_amount decimal(16,4) 是 实付金额,例:500 250*2 (实际数量 x 实付价格) remark String(255) 否 备注 付款方式明细:pay_list
名称 类型 是否必填 描述 pay_way String 是 付款方式:微信 pay_amount decimal(16,4) 是 总下单实付金额:例:500 请求实例
curl --location --request POST 'api.yptcgroup.com/thirdpart/bojun/orders/push' \ --header 'appKey: ep_73929d80f0f31f49' \ --header 'timestamp: 1776233331014' \ --header 'nonce: 76fad03c8a7b4526a3476699833b37f9' \ --header 'sign: 3f30c6f1be56939346446b7e442c0294b8e0d49b514b563ddc70b6c1660c2d4f' \ --header 'Content-Type: application/json;charset=UTF-8' \ --data-raw '{ "biz_no": "xxxx2026040700006", "vip_mobile": "182xxxx6399", "total_num": 3, "total_amount": 1193.20, "total_discount_amount": 0, "total_actual_amount": 1193.20, "order_time": "2026-04-07 10:00:00", "pay_time": "2026-04-07 10:01:00", "platform_type": 1, "detail_list": [ { "goods_no": "GQS130", "merchant_code": "GQS130HS", "spec_name": "蓝灰色_155", "color": "蓝灰色", "size": "155", "num": 1, "price": 407.55, "discount_price": 0, "actual_price": 407.55, "amount": 407.55, "discountAmount": 0, "actualAmount": 407.55, "remark": "测试数据" }, { "goods_no": "GQS130", "merchant_code": "GQS130HM", "spec_name": "蓝灰色_160", "color": "蓝灰色", "size": "160", "num": 1, "price": 407.55, "discount_price": 0, "actual_price": 407.55, "amount": 407.55, "discountAmount": 0, "actualAmount": 407.55, "remark": "测试数据" }, { "goods_no": "BZT1154", "merchant_code": "BZT1154W165", "spec_name": "白色_165", "color": "白色", "size": "165", "num": 2, "price": 189.05, "discount_price": 0, "actual_price": 189.05, "amount": 378.10, "discountAmount": 0, "actualAmount": 378.10, "remark": "测试数据" } ] }'
响应体
名称 类型 描述 code String 请求结果状态码
成功:1
失败:-1data Object 响应内容 msg String 请求结果内容,
异常:服务器错误
成功:操作成功
失败:会返回具体异常提示信息success boolean 请求结果,true:成功 false:失败 traceId String 链路追踪ID,用于定位问题 响应实例
{ "code": "1", "data": null, "msg": "操作成功", "success": true, "traceId": "123456789" }异常实例
{ "code": "101101", "data": null, "msg": "业务单号:xxxx2026040700006,商品校验异常:【商品信息不存在!】", "success": false, "traceId": "789654321" }错误码
错误码 描述 排查建议 -1 系统错误 需要联系我方协助,一般会返回traceId,提供便与定位 400 入参校验异常 字段必填项不能为空 101101 门店校验异常 门店编码、名称是否正确 101102 商品校验异常 商品信息是否存在,是否条码填写有误 101103 库存校验异常 商品库存信息是否充足
售后
退货退款
描述
根据订单相关信息: 主单:订单号、门店、会员、配送方式、收货人、收货地址、总下单量、金额、下单时间、发货时间、备注等 明细:款号、商家编码(sku)、商品信息、退货数量、单价、实付价格、货款金额、优惠金额、实付金额、备注等 推送退货订单相关信息请求
公共参数
名称 类型 必填 描述 appKey String 是 鉴权凭证,应用标识,用于请求API timestamp String 是 鉴权凭证,请求时间戳(毫秒) nonce String 是 随机字符串(防重放,需保证唯一性) sign String 是 签名值,生成方式有提供demo,具体参照示例 请求体
名称 类型 是否必填 描述 biz_no String 是 订单编号(外部单号),例:XXXX202601011200 original_pos_ref_no String 是 原始POS订单号(最开始订单的POS订单号) relate_pos_ref_no String 是 售后关联的订单编号(当前售后单关联的上一个订单号) sales_type String 是 销售类型: 正常、退货、换货
退货退款传:退货vip_mobile String 否 会员手机号,若传值则会按照会员折扣计算相关价格 delivery_type Integer 否 配送方式,0:自提 1:快递 receiver_name String 否 收货人名称 receiver_phone String 否 收货人手机号 receiver_province String 否 收货人地址省 receiver_city String 否 收货人地址市 receiver_district String 否 收货人地址区 receiver_address String 否 收货人地址详情 total_num Integer 是 总下单数量,例:1 total_amount decimal(16,2) 是 总下单货款金额,例:600.00 total_discount_amount decimal(16,2) 是 总下单优惠金额,例:100.00 total_actual_amount decimal(16,2) 是 总下单实付金额,例:500.00 order_time Date 是 用户下单时间,时间格式为:yyyy年-MM月-dd日 HH时:mm分:ss秒
例:2026-04-01 23:59:59pay_time Date 否 用户付款时间,时间格式为yyyy年-MM月-dd日 HH时:mm分:ss秒
例:2026-04-01 23:59:59delivery_time Date 否 发货时间,时间格式为yyyy年-MM月-dd日 HH时:mm分:ss秒
例:2026-04-01 23:59:59platform_type Integer 是 默认传:1 即可 remark String(255) 否 备注 detail_list List 是 商品明细 明细:detail_list
名称 类型 是否必填 描述 goods_no String 是 大货款号 merchant_code String 是 商家编码,商品sku,例:GQS130HM color String 是 颜色,例:蓝灰色 size String 是 尺码 , 例:155 spec_name String 是 商品规格信息,例:蓝灰色_155 refund_num Integer 是 退货数量,例:2 price decimal(16,4) 是 吊牌零售价,例:300 discount_price decimal(16,4) 否 优惠金额,例:50 actual_price decimal(16,4) 是 实付价格,例:250 amount decimal(16,4) 是 货款金额,例:600 300*2 (实际数量 x 吊牌零售价) discount_amount decimal(16,4) 否 优惠金额,例:100 50*2 (实际数量 x 优惠金额) actual_amount decimal(16,4) 是 实付金额,例:500 250*2 (实际数量 x 实付价格) remark String(255) 否 备注 请求实例
curl --location 'api.yptcgroup.com/thirdpart/bojun/orders/returnAndRefund/push' \ --header 'X-AUTH-TOKEN: 06754:123456' \ --header 'appKey: ep_73929d80f0f31f49' \ --header 'timestamp: 1781586399660' \ --header 'nonce: 32b9b7a2c88748e7acaf61e48803b59d' \ --header 'sign: bdd1c5770babda996262f9b2736634b5042bbbc5a245b75799f935c640258a2d' \ --header 'Content-Type: application/json' \ --data '{ "biz_no": "2031032139579338", "original_pos_ref_no": "36C019821PC6A2A67C0", "relate_pos_ref_no":"36C019821PC6A2A67C0", "total_num": 1, "total_amount": 179, "total_discount_amount": 0, "total_actual_amount": 179, "order_time": "2026-05-28 10:00:00", "pay_time": "2026-05-28 10:01:00", "platform_type": 1, "salesType": "退货", "ownerStoreName": "CP调货门店", "ownerStoreCode": "CPTRAN", "detail_list": [ { "goods_no": "GQT047", "merchant_code": "GQT047WM", "spec_name": "黑色_175", "color": "黑色", "size": "M", "refund_num": 1, "price": 179, "discount_price": 0, "actual_price": 179, "amount": 179, "discountAmount": 0, "actualAmount": 179, "remark": "测试退货数据" } ] }'响应体
名称 类型 描述 code String 请求结果状态码
成功:1
失败:-1data Object 响应内容 msg String 请求结果内容,
异常:服务器错误
成功:操作成功
失败:会返回具体异常提示信息success boolean 请求结果,true:成功 false:失败 traceId String 链路追踪ID,用于定位问题 响应实例
{ "code": "1", "data": null, "msg": "操作成功", "success": true, "traceId": "123456789" }异常实例
{ "code": "101103", "data": null, "msg": "业务单号:xxxx2026040700006,库存校验异常:【可退数量不足:BQTMD01B175 需要:[2] 剩余可退:[1]】", "success": false, "traceId": "789654321" }错误码
错误码 描述 排查建议 -1 系统错误 需要联系我方协助,一般会返回traceId,提供便与定位 400 入参校验异常 字段必填项不能为空 101101 门店校验异常 门店编码、名称是否正确 101102 商品校验异常 商品信息是否存在,是否条码填写有误 101103 库存校验异常 商品库存信息是否充足 101104 单据重复异常 业务单号单据重复
换货
描述
根据订单相关信息: 主单:订单号、门店、会员、配送方式、收货人、收货地址、总下单量、金额、下单时间、发货时间、备注等 明细:款号、商家编码(sku)、商品信息、退货数量、单价、实付价格、货款金额、优惠金额、实付金额、备注等 推送换货订单相关信息请求
公共参数
名称 类型 必填 描述 appKey String 是 鉴权凭证,应用标识,用于请求API timestamp String 是 鉴权凭证,请求时间戳(毫秒) nonce String 是 随机字符串(防重放,需保证唯一性) sign String 是 签名值,生成方式有提供demo,具体参照示例 请求体
名称 类型 是否必填 描述 biz_no String 是 订单编号(外部单号),例:XXXX202601011200 original_pos_ref_no String 是 原始POS订单号(最开始订单的POS订单号) relate_pos_ref_no String 是 售后关联的订单编号(当前售后单关联的上一个订单号,即需要售后的零售单号) sales_type String 是 销售类型: 正常、退货、换货
退货退款传:换货vip_mobile String 否 会员手机号,若传值则会按照会员折扣计算相关价格 delivery_type Integer 否 配送方式,0:自提 1:快递 receiver_name String 否 收货人名称 receiver_phone String 否 收货人手机号 receiver_province String 否 收货人地址省 receiver_city String 否 收货人地址市 receiver_district String 否 收货人地址区 receiver_address String 否 收货人地址详情 total_num Integer 是 总下单数量,例:1 total_amount decimal(16,2) 是 总下单货款金额,例:600.00 total_discount_amount decimal(16,2) 是 总下单优惠金额,例:100.00 total_actual_amount decimal(16,2) 是 总下单实付金额,例:500.00 order_time Date 是 用户下单时间,时间格式为:yyyy年-MM月-dd日 HH时:mm分:ss秒
例:2026-04-01 23:59:59pay_time Date 否 用户付款时间,时间格式为yyyy年-MM月-dd日 HH时:mm分:ss秒
例:2026-04-01 23:59:59delivery_time Date 否 发货时间,时间格式为yyyy年-MM月-dd日 HH时:mm分:ss秒
例:2026-04-01 23:59:59platform_type Integer 是 默认传:1 即可 remark String(255) 否 备注 detail_list List 是 商品明细 明细:detail_list
名称 类型 是否必填 描述 goods_no String 是 大货款号 merchant_code String 是 商家编码,商品sku,例:GQS130HM color String 是 颜色,例:蓝灰色 size String 是 尺码 , 例:155 spec_name String 是 商品规格信息,例:蓝灰色_155 refund_num Integer 是 退货数量,例:2 price decimal(16,4) 是 吊牌零售价,例:300 discount_price decimal(16,4) 否 优惠金额,例:50 actual_price decimal(16,4) 是 实付价格,例:250 amount decimal(16,4) 是 货款金额,例:600 300*2 (实际数量 x 吊牌零售价) discount_amount decimal(16,4) 否 优惠金额,例:100 50*2 (实际数量 x 优惠金额) actual_amount decimal(16,4) 是 实付金额,例:500 250*2 (实际数量 x 实付价格) remark String(255) 否 备注 exchange_detail_list List 是 换货商品明细 换货明细:exchange_detail_list
名称 类型 是否必填 描述 goods_no String 是 大货款号 merchant_code String 是 商家编码,商品sku,例:GQS130HM color String 是 颜色,例:蓝灰色 size String 是 尺码 , 例:155 spec_name String 是 商品规格信息,例:蓝灰色_155 num Integer 是 退货数量,例:2 price decimal(16,4) 是 吊牌零售价,例:300 discount_price decimal(16,4) 否 优惠金额,例:50 actual_price decimal(16,4) 是 实付价格,例:250 amount decimal(16,4) 是 货款金额,例:600 300*2 (实际数量 x 吊牌零售价) discount_amount decimal(16,4) 否 优惠金额,例:100 50*2 (实际数量 x 优惠金额) actual_amount decimal(16,4) 是 实付金额,例:500 250*2 (实际数量 x 实付价格) remark String(255) 否 备注 请求实例
curl --location 'api.yptcgroup.com/thirdpart/bojun/orders/returnAndRefund/push' \ --header 'X-AUTH-TOKEN: 06754:123456' \ --header 'appKey: ep_73929d80f0f31f49' \ --header 'timestamp: 1781586399660' \ --header 'nonce: 32b9b7a2c88748e7acaf61e48803b59d' \ --header 'sign: bdd1c5770babda996262f9b2736634b5042bbbc5a245b75799f935c640258a2d' \ --header 'Content-Type: application/json' \ --data '{ "biz_no": "2031032139579338", "original_pos_ref_no": "36C019821PC6A2A67C0", "relate_pos_ref_no":"36C019821PC6A2A67C0", "total_num": 1, "total_amount": 179, "total_discount_amount": 0, "total_actual_amount": 179, "order_time": "2026-05-28 10:00:00", "pay_time": "2026-05-28 10:01:00", "platform_type": 1, "salesType": "退货", "ownerStoreName": "CP调货门店", "ownerStoreCode": "CPTRAN", "detail_list": [ { "goods_no": "GQT047", "merchant_code": "GQT047WM", "spec_name": "黑色_175", "color": "黑色", "size": "M", "refund_num": 1, "price": 179, "discount_price": 0, "actual_price": 179, "amount": 179, "discountAmount": 0, "actualAmount": 179, "remark": "测试换货数据", "exchange_detail_list": [ { "goods_no": "BQTMD01", "merchant_code": "BQTMD01B175", "spec_name": "黑色_175", "color": "黑色", "size": "175", "num": 1, "price": 30, "discount_price": 0, "actual_price": 30, "amount": 30, "discountAmount": 0, "actualAmount": 30, "remark": "测试换货数据", } ] } ] }'响应体
名称 类型 描述 code String 请求结果状态码
成功:1
失败:-1data Object 响应内容 msg String 请求结果内容,
异常:服务器错误
成功:操作成功
失败:会返回具体异常提示信息success boolean 请求结果,true:成功 false:失败 traceId String 链路追踪ID,用于定位问题 响应实例
{ "code": "1", "data": null, "msg": "操作成功", "success": true, "traceId": "123456789" }异常实例
{ "code": "101103", "data": null, "msg": "业务单号:xxxx2026040700006,库存校验异常:【换货数量不足:BQTMD01B175 退货:[1] %s 换货:[2]】", "success": false, "traceId": "789654321" }错误码
错误码 描述 排查建议 -1 系统错误 需要联系我方协助,一般会返回traceId,提供便与定位 400 入参校验异常 字段必填项不能为空 101101 门店校验异常 门店编码、名称是否正确 101102 商品校验异常 商品信息是否存在,是否条码填写有误 101103 库存校验异常 商品库存信息是否充足 101104 单据重复异常 业务单号单据重复
订单查询
描述
根据条件:门店编码、订单业务单号、零售端创建时间获取订单相关信息请求
名称 请求方式 POST 请求地址 http://api.yptcgroup.com/thirdpart/bojun/orders/query 公共参数
名称 类型 必填 描述 appKey String 是 鉴权凭证,应用标识,用于请求API timestamp String 是 鉴权凭证,请求时间戳(毫秒) nonce String 是 随机字符串(防重放,需保证唯一性) sign String 是 签名值,生成方式有提供demo,具体参照示例 请求体
名称 类型 是否必填 描述 page_size Integer 是 分页大小,用于分页查询控制当前页数量,默认30,最大不可超过500 current_page Integer 是 当前分页,用于分页查询控制当前页数,默认1 biz_no_List List 否 订单业务单号,用于条件查询,最大不可超过100个单号,例:["xxxx2026040700002"] 线上推送单据 ref_no_list List POS零售单单号,用于条件查询,最大不可超过100个单号,例:["xxxx2026040700002"] 线下收银零售单 start_creation_date String 否 单据创建时间-开始时间,并非下发时单据时间,会有偏差,我司是异步处理,建议拉大时间范围,但时间范围最大是三个月 例:2026-04-01 00:00:00 end_creation_date String 否 单据创建时间-开始时间,并非下发时单据时间,会有偏差,我司是异步处理,建议拉大时间范围,但时间范围最大是三个月 例:2026-04-01 23:59:59 注意:业务单号和创建时间范围二者必须填写一个作为查询条件,避免查询数据量过大
- 请求实例
curl --location --request POST 'api.yptcgroup.com/thirdpart/bojun/orders/query' \ --header 'appKey: ep_73929d80f0f31f49' \ --header 'timestamp: 1776235489450' \ --header 'nonce: 1077f1b7ea0642c39dfccbd83cda379b' \ --header 'sign: c2297847aecfa141d09029308c31ce791e83534c0b79f37e40e3df10c03b8849' \ --header 'Content-Type: application/json;charset=UTF-8' \ --data-raw '{ "current_page": 1, "page_size": 100, "start_creation_date": "2026-04-10 00:00:00", "end_creation_date": "2026-04-14 23:59:59" }'响应体
名称 类型 描述 code String 请求结果状态码
成功:1
失败:-1data Object 响应内容 msg String 请求结果内容,
异常:服务器错误
成功:操作成功
失败:会返回具体异常提示信息success boolean 请求结果,true:成功 false:失败 traceId String 链路追踪ID,用于定位问题 第一层:本次分页查询结果:data
名称 类型 描述 current long 当前页 size long 当前分页总记录数 total long 总记录数 records List 查询记录列表 第二层:本次分页查询结果:records
名称 类型 描述 id Long 零售单ID order_no String 零售单号 origin_no String 原始单号 ref_no String POS零售单号 biz_no String 外部单号-即第三方单号 total_qty Integer 总的成交数量 retail_amount decimal(16,2) 零售金额 total_actual_amount decimal(16,2) 总的成交金额 discount_amount decimal(16,2) 优惠金额 retail_sale_type String 销售类型,
CMR:正常
RET:退货,
EXP:换货,order_mark String 订单标记,例:WITWIT c_vip_id Long 会员ID vip_mobile String 会员手机号 card_no String 会员卡号 vip_name String 会员名称 creation_date Date 创建时间,时间格式为yyyy年-MM月-dd日 HH时:mm分:ss秒
例:2026-04-01 00:00:00modified_date Date 更新时间,时间格式为yyyy年-MM月-dd日 HH时:mm分:ss秒
例:2026-04-01 00:00:00bill_date Long 单据日期,格式为yyyyMMdd,
例:20260401shopping_guide String 导购员名称 响应实例
{ "code": "1", "data": { "current": 1, "orders": [], "pages": 5, "records": [ { "id": 7778, "order_no": "CPTRANP3699D5610", "origin_no": "CPTRANP3699D5610", "ref_no": "CPTRANP3699D5610", "biz_no": "xxxx2026040100001", "retail_amount": 0.1, "retail_sale_type": "CMR", "order_mark":"正常零售", "total_actual_amount": 0.09, "total_qty": 1, "c_vip_id": 12586, "card_no": "CP18272826399", "vip_mobile": "18272826399", "vip_name": "无敌吹风机", "bill_date": 20260224, "store_code":"MMLGZZZHCD", "store_name":"MMLG-郑州正弘城店", "creation_date": "2026-02-24 15:43:30", "modified_date": "2026-02-24 15:43:30", } ], "size": 1, "total": 1 }, "msg": "操作成功", "success": false, "traceId": "" }异常实例
{ "code": "100001", "data": null, "msg": "时间范围不能为空", "success": false, "traceId": "789654321" }错误码
错误码 描述 排查建议 -1 系统错误 需要联系我方协助,一般会返回traceId,提供便与定位 400 入参校验异常 字段必填项不能为空 100001 日期异常 填写时间范围不可为空(未填写业务单号时);开始时间需小于等于结束时间;开始时间与结束时间差值需小于等于3个月 100002 业务单号异常 业务单号至多填写 100个
订单详情查询
描述
根据条件:门店编码、订单业务单号获取订单明细相关信息请求
名称 请求方式 POST 请求地址 http://api.yptcgroup.com/thirdpart/bojun/orders/detail 公共参数
名称 类型 必填 描述 appKey String 是 鉴权凭证,应用标识,用于请求API timestamp String 是 鉴权凭证,请求时间戳(毫秒) nonce String 是 随机字符串(防重放,需保证唯一性) sign String 是 签名值,生成方式有提供demo,具体参照示例 请求体
名称 类型 是否必填 描述 biz_no String 否 线上订单业务单号,用于条件查询,
例:["WIT2026040700002"]ref_no String 否 线下pos零售单号,用于条件查询,
例:["xxxx2026040700002"]注意:二者须填写至少一个
- 请求实例
curl --location --request POST 'api.yptcgroup.com/thirdpart/bojun/orders/query' \ --header 'appKey: ep_73929d80f0f31f49' \ --header 'timestamp: 1776235489450' \ --header 'nonce: 1077f1b7ea0642c39dfccbd83cda379b' \ --header 'sign: c2297847aecfa141d09029308c31ce791e83534c0b79f37e40e3df10c03b8849' \ --header 'Content-Type: application/json;charset=UTF-8' \ --data-raw '{ "biz_no":"WIT2026040700007" }'响应体
名称 类型 描述 code String 请求结果状态码
成功:1
失败:-1data List 响应内容 msg String 请求结果内容,
异常:服务器错误
成功:操作成功
失败:会返回具体异常提示信息success boolean 请求结果,true:成功 false:失败 traceId String 链路追踪ID,用于定位问题 第一层:本次分页查询结果:data
名称 类型 描述 id Long 零售单明细ID merchant_code String 商家编码 goods_name String 货品名称 color String 颜色 qty Integer 销售数量 r_qty Integer 已退数量 r_can_qty Integer 可退数量 retail_price decimal(16,2) 零售价 amt_amount decimal(16,2) 零售金额 price_actual decimal(16,2) 成交价 tot_amt_actual decimal(16,2) 成交金额 r_qty_amount decimal(16,2) 已退金额 goods_no String 大货款号 size String 尺码 brand_code String 品牌编码 brand_name String 品牌名称 years String 年份 season String 季节 first_level String 一级分类 second_level String 二级分类 third_level String 三级分类 org_doc_no String 原单编号 m_retail_item_id String 原单明细ID ref_no String 主单-POS零售单号 order_no String 主单-业务单号 shopping_guide String 营业员 type Interger 1:正常零售,2:退货,
3:赠品,4:全额,
6:云仓下单,5:换货,响应实例
{ "code": "1", "data": [ { "amt_amount": -599, "brand_code": "CK", "brand_name": "CHIC PARK", "color": "白色", "first_level": "上装", "goods_name": "CHIC PARK外套", "goods_no": "BQT1116", "id": 21211, "m_retail_id": 5650, "m_retail_item_id": 21210, "merchant_code": "BQT1116W160", "order_no": "CPTRANP12505091407080005", "org_doc_no": "CPTRANP12505091359130004", "price_actual": 59, "qty": -1, "r_can_qty": -1, "r_qty": 0, "ref_no": "CPTRANP12505091407080005", "retail_price": 599, "season": "冬季", "second_level": "外套", "third_level": "梭织外套", "tot_amt_actual": -59, "type": 2, "years": "2024", "shopping_guide": "李某某" } ], "msg": "操作成功", "success": true, "traceId": "" }异常实例
{ "code": "400", "data": null, "msg": "业务单号不能为空", "success": false, "traceId": "789654321" }错误码
错误码 描述 排查建议 -1 系统错误 需要联系我方协助,一般会返回traceId,提供便与定位 100002 业务单号校验异常 业务单号、线下pos零售单号不能为空
基础数据相关接口
基础商品查询
描述
根据条件:大货款号、商家编码、年份、季节、款号创建时间获取基础商品相关信息请求
名称 请求方式 POST 请求地址 http://api.yptcgroup.com/thirdpart/bojun/masterdata/goods 公共参数
名称 类型 必填 描述 appKey String 是 鉴权凭证,应用标识,用于请求API timestamp String 是 鉴权凭证,请求时间戳(毫秒) nonce String 是 随机字符串(防重放,需保证唯一性) sign String 是 签名值,生成方式有提供demo,具体参照示例 请求体
名称 类型 是否必填 描述 page_size Integer 是 分页大小,用于分页查询控制当前页数量,默认30,最大不可超过500 current_page Integer 是 当前分页,用于分页查询控制当前页数,默认1 goods_no_list List 否 大货款号集合,用于条件查询,
例:["DBTEST001"]merchant_code_list List 否 大货款号集合,用于条件查询,
例:["DBTEST001H155"]years String 否 年份,例:2026 season String 否 季节,例:春季 start_creation_date String 否 款号创建时间-开始时间,时间格式为yyyy年-MM月-dd日 HH时:mm分:ss秒
例:2026-04-01 00:00:00end_creation_date String 否 款号创建时间-结束时间,时间格式为yyyy年-MM月-dd日 HH时:mm分:ss秒
例:2026-04-01 23:59:59- 请求实例
curl --location --request POST 'api.yptcgroup.com/thirdpart/bojun/masterdata/goods' \ --header 'appKey: ep_73929d80f0f31f49' \ --header 'timestamp: 1776235269962' \ --header 'nonce: d118a97d0c1c4c4cb5748d638efedb0b' \ --header 'sign: 8431666715876b4f00bfec16962b84ebad54ac9f0dcca2d9ab68869344e2c8a7' \ --header 'Content-Type: application/json;charset=UTF-8' \ --data-raw '{ "current_page": 1, "page_size": 100, "goods_no_list": [ "EPP243" ] }'响应体
名称 类型 描述 code String 请求结果状态码
成功:1
失败:-1data Object 响应内容 msg String 请求结果内容,
异常:服务器错误
成功:操作成功
失败:会返回具体异常提示信息success boolean 请求结果,true:成功 false:失败 traceId String 链路追踪ID,用于定位问题 第一层:本次分页查询结果:data
名称 类型 描述 current long 当前页 size long 当前分页总记录数 total long 总记录数 records List 查询记录列表 第二层:本次分页查询结果:records
名称 类型 描述 id Long 条码档案ID goods_no String 大货款号 goods_name String 款号名称 merchant_code String 条码/商家编码 color String 颜色 size String 尺码 brand_code String 品牌编码 brand_name String 品牌名称 years String 年份 season String 季节 spec_no String 规格名称 first_level String 一级分类 second_level String 二级分类 third_level String 三级分类 retail_price decimal(16,2) 零售价,吊牌价 响应实例
{ "code": "1", "data": { "current": 1, "records": [ { "id": 632, "brand_code": "Q", "brand_name": "Mmlg", "color": "黑色", "first_level": "上装", "goods_name": "Mmlg雪纺衫", "goods_no": "BMG1348", "merchant_code": "BMG1348BS", "season": "春季", "second_level": "雪纺衫", "size": "S", "spec_no": "黑色_S", "third_level": "长袖雪纺衫", "years": "2026", "retail_price":168.00 } ], "size": 1, "total": 1 }, "msg": "操作成功", "success": true, "traceId": "123456788" }异常实例
{ "code": "400", "data": null, "msg": "分页参数不能为空", "success": false, "traceId": "789654321" }错误码
错误码 描述 排查建议 -1 系统错误 需要联系我方协助,一般会返回traceId,提供便与定位 400 入参校验异常 字段必填项不能为空
商品库存查询
描述
根据条件:大货款号、商家编码、年份、季节、款号创建时间获取基础商品相关信息请求
名称 请求方式 POST 请求地址 http://api.yptcgroup.com/thirdpart/bojun/masterdata/stock 公共参数
名称 类型 必填 描述 appKey String 是 鉴权凭证,应用标识,用于请求API timestamp String 是 鉴权凭证,请求时间戳(毫秒) nonce String 是 随机字符串(防重放,需保证唯一性) sign String 是 签名值,生成方式有提供demo,具体参照示例 请求体
名称 类型 是否必填 描述 page_size Integer 是 分页大小,用于分页查询控制当前页数量,默认30,最大不可超过500 current_page Integer 是 当前分页,用于分页查询控制当前页数,默认1 goods_no_list List 否 大货款号集合,用于条件查询,
例:["DBTEST001"]merchant_code_list List 否 大货款号集合,用于条件查询,
例:["DBTEST001H155"]years String 否 年份,例:2026 season String 否 季节,例:春季 - 请求实例
curl -X POST 'http://cloud.eptison.com:8888/thirdpart/bojun/masterdata/stock' \ -H 'appKey: ep_73929d80f0f31f49' \ -H 'timestamp: 1776159194570' \ -H 'nonce: 2baca3eca041420285d5af997dca8ca0' \ -H 'sign: 3eb85040a135d96a2b1320fe7e2c883ec0ed46f495b8c4d7f5b6402a66911ecd' \ -H 'Content-Type: application/json' \ -D '{ "current_page": 1, "page_size": 100 }'响应体
名称 类型 描述 code String 请求结果状态码
成功:1
失败:-1data Object 响应内容 msg String 请求结果内容,
异常:服务器错误
成功:操作成功
失败:会返回具体异常提示信息success boolean 请求结果,true:成功 false:失败 traceId String 链路追踪ID,用于定位问题 第一层:本次分页查询结果:data
名称 类型 描述 current long 当前页 size long 当前分页总记录数 total long 总记录数 records List 查询记录列表 第二层:本次分页查询结果:records
名称 类型 描述 id Long 条码档案ID store_code String 门店编码 store_name String 门店名称 goods_no String 大货款号 goods_name String 款号名称 merchant_code String 条码/商家编码 color String 颜色 size String 尺码 brand_code String 品牌编码 brand_name String 品牌名称 years String 年份 season String 季节 spec_no String 规格名称 first_level String 一级分类 second_level String 二级分类 third_level String 三级分类 retail_price decimal(16,2) 零售价,吊牌价 stock_qty Integer 门店库存 available_stock_qty Integer 可用库存 响应实例
{ "code": "1", "data": { "current": 1, "records": [ { "id": 1270600, "brand_code": "Z", "brand_name": "FSK", "store_code":"MMLGZZZHCD", "store_name":"MMLG-郑州正弘城店", "goods_name": "FSK休闲裤", "goods_no": "FSK002", "merchant_code": "FSK002BM", "retail_price": 399, "season": "夏季", "spec_no": "黑色_155", "stock_qty": 50, "available_stock_qty": 50, "first_level": "下搭", "second_level": "梭织休闲裤", "third_level": "加绒梭织长裤", "years": "2024" } ], "size": 1, "total": 1 }, "msg": "操作成功", "success": true, "traceId": "123456788" }异常实例
{ "code": "400", "data": null, "msg": "分页参数不能为空", "success": false, "traceId": "789654321" }错误码
错误码 描述 排查建议 -1 系统错误 需要联系我方协助,一般会返回traceId,提供便与定位 400 入参校验异常 字段必填项不能为空
商品图片下载
描述
根据条件:商家编码下载商品图片信息,以流的形式响应请求
公共参数
名称 类型 必填 描述 appKey String 是 鉴权凭证,应用标识,用于请求API timestamp String 是 鉴权凭证,请求时间戳(毫秒) nonce String 是 随机字符串(防重放,需保证唯一性) sign String 是 签名值,生成方式有提供demo,具体参照示例 请求体
名称 类型 是否必填 描述 merchant_code String 是 商家编码,例:GQS003PS - 请求实例
curl --location --request POST 'api.yptcgroup.com/thirdpart/bojun/masterdata/downloadsImage?accessToken=' \ --header 'appKey: ep_73929d80f0f31f49' \ --header 'timestamp: 1777302023476' \ --header 'nonce: d0191a8a2a7942219990230b521b484a' \ --header 'sign: c5264a89aece458ba7088b0ae9353b4ecd8949dd45e2258549781c7ae39c1b2d' \ --header 'Content-Type: application/json;charset=UTF-8' \ --data-raw '{ "merchant_code": "GQS003PS" }'响应头
名称 类型 描述 Content-Type String image/png 或者image/jpeg Content-Disposition String attachment; filename="GQS003PS.png"
filename后即图片名称,一般是:入参商家编码.文件格式后缀Content-Length String 长度 异常实例
{ "code": "400", "data": null, "msg": "商家编码不能为空", "success": false, "traceId": "789654321" }错误码
错误码 描述 排查建议 -1 系统错误 需要联系我方协助,一般会返回traceId,提供便与定位 400 入参校验异常 字段必填项不能为空 100102 转换流异常 异常处理图片流,接口异常 100103 商品不存在 是否商家编码有误 100104 重复下载 当前商品正在下载中,请勿重复请求
文档更新时间: 2026-06-17 09:46 作者:朱阿鹏