qimen.taobao.pos.weborder.single.sync (单个线上销售单信息同步)

【必读】API使用说明: 1、该接口为隐私保护业务使用。请求方(source_appkey)请求该API时候,务必带上三个参数customerid(要求在路由页面上配置好),oaid,oaidOrderSourceCode(淘宝订单号),奇门转发给后端时,会在下述API参数基础上,多附带上三个参数name,phone,shippingAddress,服务接收方接收时获取这三个参数做对应业务处理即可 2、该接口需要双向授权,即要求用户对source_appkey以及target_appkey做授权,但调用接口时只传递用户与source_appkey的sessionKey即可。

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
orderBillCode String 必须 A123 单据编号
orderWebCod String 必须 A123 原单据号
shopCode String 必须 HZ01 门店代码
billTime String 必须 20171010 营业日期
quantity Number 必须 100 数量
money String 必须 100 标准价格
realMoney String 必须 100 金额
discount String 必须 9 折扣
paymethod String 必须 支付方式:0-线上支付 1-线下支付', 支付方式
province String 可选 浙江省
city String 可选 杭州市
district String 可选 余杭区
street String 可选 文一西路 街道
creater String 可选 张三 制单人
creationDate String 可选 2017-11-11 12:00:00 制单日期
note String 可选 备注信息 备注
shippingCode String 可选 SF 快递代码
shippingSn String 可选 201711110011 快递单号
salerEmployeeNo String 可选 001 店员代码
chargeback String 可选 标记可选;订单、退单、换货单、 退单
system String 必须 来源系统 0-POS、1-中台、2-Retail、3-OMS、4-其他 来源系统
item Item 可选 商品明细
  • └ skuCode
  • String
  • 可选
  • A001
  • 商品条码
  • └ goodsCode
  • String
  • 必须
  • A001
  • 商品代码
  • └ colorCode
  • String
  • 必须
  • A001
  • 颜色代码
  • └ sizeCode
  • String
  • 必须
  • L
  • 尺码代码
  • └ referencePrice
  • String
  • 必须
  • 100
  • 参考价
  • └ price
  • String
  • 必须
  • 80
  • 单价
  • └ discount
  • String
  • 必须
  • 8
  • 折扣
  • └ quantity
  • String
  • 必须
  • 1000
  • 数量
  • └ referenceAmount
  • String
  • 可选
  • 1000
  • 参考金额
  • └ amount
  • String
  • 必须
  • 1000
  • 金额
  • └ status
  • String
  • 必须
  • 0-正常 1-促销 2-换购 3-赠品 4-让利 5-补差优惠 6-VIP叠加优惠 7-生日优惠 8-整单叠加优惠 9-积分换购 11-换货,12-已换货,13-打折
  • 状态
extendProps String 可选 {"name":"名字"} 扩展属性
sourcePlatform String 必须 来源平台:0-后台1-淘宝2-拍拍3-OS主站4-分销商5-京东11-亚马逊13-一号店等' 来源平台
sourceShopCode String 必须 '来源店铺代码 '来源店铺代码
sourceShopName String 必须 '来源店铺名称 '来源店铺名称
sourceChannelCode String 必须 '来源渠道代码 '来源渠道代码
sourceChannelName String 必须 '来源渠道名称 '来源渠道名称
orderShopCode String 必须 '下单门店代码 '下单门店代码
customerMemo String 可选 '顾客留言 '顾客留言
customerComment String 可选 '客服备注 '客服备注
posOuterCode String 可选 '结算代码 '结算代码
customerid String 可选 customerid customerid
oaidOrderSourceCode String 可选 T1234567890 淘宝订单号
name String 可选 张三 姓名
phone String 可选 18888888888 手机号
shippingAddress String 可选 余杭区969号小邮局 快递地址
oaid String 可选 oaid oaid

响应参数

名称 类型 示例值 描述
resFlag String success|failure 响应结果
resCode String 1 1:成功;其他:失败
resMsg String msg 响应信息

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
QimenCloudClient client = new DefaultQimenCloudClient(url, appkey, secret);
TaobaoPosWeborderSingleSyncRequest req = new TaobaoPosWeborderSingleSyncRequest();
req.setOrderBillCode("A123");
req.setOrderWebCod("A123");
req.setShopCode("HZ01");
req.setBillTime("20171010");
req.setQuantity(100L);
req.setMoney("100");
req.setRealMoney("100");
req.setDiscount("9");
req.setPaymethod("支付方式:0-线上支付 1-线下支付',");
req.setProvince("浙江省");
req.setCity("杭州市");
req.setDistrict("余杭区");
req.setStreet("文一西路");
req.setCreater("张三");
req.setCreationDate("2017-11-11 12:00:00");
req.setNote("备注信息");
req.setShippingCode("SF");
req.setShippingSn("201711110011");
req.setSalerEmployeeNo("001");
req.setChargeback("标记可选;订单、退单、换货单、");
req.setSystem("来源系统 0-POS、1-中台、2-Retail、3-OMS、4-其他");
TaobaoPosWeborderSingleSyncRequest.Item obj1 = new TaobaoPosWeborderSingleSyncRequest.Item();
obj1.setSkuCode("A001");
obj1.setGoodsCode("A001");
obj1.setColorCode("A001");
obj1.setSizeCode("L");
obj1.setReferencePrice("100");
obj1.setPrice("80");
obj1.setDiscount("8");
obj1.setQuantity("1000");
obj1.setReferenceAmount("1000");
obj1.setAmount("1000");
obj1.setStatus("0-正常 1-促销 2-换购 3-赠品 4-让利 5-补差优惠 6-VIP叠加优惠 7-生日优惠 8-整单叠加优惠 9-积分换购 11-换货,12-已换货,13-打折");
req.setItem(obj1);
req.setExtendProps("{\"name\":\"名字\"}");
req.setSourcePlatform("来源平台:0-后台1-淘宝2-拍拍3-OS主站4-分销商5-京东11-亚马逊13-一号店等'");
req.setSourceShopCode("'来源店铺代码");
req.setSourceShopName("'来源店铺名称");
req.setSourceChannelCode("'来源渠道代码");
req.setSourceChannelName("'来源渠道名称");
req.setOrderShopCode("'下单门店代码");
req.setCustomerMemo("'顾客留言");
req.setCustomerComment("'客服备注");
req.setPosOuterCode("'结算代码");
req.setCustomerid("customerid");
req.setOaidOrderSourceCode("T1234567890");
req.setName("张三");
req.setPhone("18888888888");
req.setShippingAddress("余杭区969号小邮局");
req.setOaid("oaid");
TaobaoPosWeborderSingleSyncResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<resFlag>success|failure</resFlag>
<resCode>1</resCode>
<resMsg>msg</resMsg>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部