文档中心 > API类目 > 奇门仓储API

taobao.qimen.returnorder.create (退货入库单创建接口)

taobao.qimen.returnorder.create

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
request ReturnOrderCreateRequest 可选
  • returnOrder
  • ReturnOrder
  • 可选
  • 退货单信息
  • └ returnOrderCode
  • String
  • 必须
  • R1234
  • ERP的退货入库单编码
  • └ warehouseCode
  • String
  • 必须
  • W1234
  • 仓库编码(统仓统配等无需ERP指定仓储编码的情况填OTHER)
  • └ orderType
  • String
  • 可选
  • THRK
  • 单据类型(THRK=退货入库;HHRK=换货入库;只传英文编码)
  • └ orderFlag
  • String
  • 可选
  • VISIT
  • 用字符串格式来表示订单标记列表(比如VISIT^ SELLER_AFFORD^SYNC_RETURN_BILL等;中间用“^”来隔开订单标记list (所 有字母全部大写) VISIT=上门;SELLER_AFFORD=是否卖家承担运费(默认是)SYNC_RETURN_BILL=同时退回发票)
  • └ preDeliveryOrderCode
  • String
  • 必须
  • PD1234
  • 原出库单号(ERP分配)
  • └ preDeliveryOrderId
  • String
  • 可选
  • PDI1234
  • 原出库单号(WMS分配)
  • └ logisticsCode
  • String
  • 必须
  • SF
  • 物流公司编码(SF=顺丰、EMS=标准快递、EYB=经济快件、ZJS=宅急送、YTO=圆通、ZTO=中通(ZTO)、HTKY=百世汇通、 UC=优速、STO=申通、TTKDEX=天天快递、QFKD=全峰、FAST=快捷、POSTB=邮政小包、GTO=国通、YUNDA=韵达、JD=京东配送、DD=当当宅配、 AMAZON=亚马逊物流、OTHER=其他;只传英文编码)
  • └ logisticsName
  • String
  • 可选
  • 顺丰
  • 物流公司名称
  • └ expressCode
  • String
  • 可选
  • YD1234
  • 运单号
  • └ returnReason
  • String
  • 可选
  • 破损退货
  • 退货原因
  • └ buyerNick
  • String
  • 可选
  • 淘宝
  • 买家昵称
  • senderInfo
  • SenderInfo
  • 可选
  • 发件人信息
  • └ company
  • String
  • 可选
  • 淘宝
  • 公司名称
  • └ name
  • String
  • 必须
  • 老王
  • 姓名
  • └ zipCode
  • String
  • 可选
  • 043300
  • 邮编
  • └ tel
  • String
  • 可选
  • 81020340
  • 固定电话
  • └ mobile
  • String
  • 必须
  • 13214567869
  • 移动电话
  • └ email
  • String
  • 可选
  • 345@gmail.com
  • 电子邮箱
  • └ countryCode
  • String
  • 可选
  • 051532
  • 国家二字码
  • └ province
  • String
  • 必须
  • 浙江省
  • 省份
  • └ city
  • String
  • 必须
  • 杭州
  • 城市
  • └ area
  • String
  • 可选
  • 余杭
  • 区域
  • └ town
  • String
  • 可选
  • 横加桥
  • 村镇
  • └ detailAddress
  • String
  • 必须
  • 杭州市余杭区989号
  • 详细地址
  • └ extendProps
  • Map
  • 可选
  • 发件人扩展信息
  • └ remark
  • String
  • 可选
  • 备注信息
  • 备注
  • └ sourcePlatformCode
  • String
  • 可选
  • TB
  • 订单来源平台编码, string (50),TB= 淘宝 、TM=天猫 、JD=京东、DD=当当、PP=拍拍、YX=易讯、EBAY=ebay、QQ=QQ网购、AMAZON=亚马逊、SN=苏宁、GM=国美、WPH=唯品会、JM=聚美、LF=乐蜂、MGJ=蘑菇街、JS=聚尚、PX=拍鞋、YT=银泰、YHD=1号店、VANCL=凡客、YL=邮乐、YG=优购、1688=阿里巴巴、POS=POS门店、MIA=蜜芽、GW=商家官网、CT=村淘、YJWD=云集微店、PDD=拼多多、OTHERS=其他,
  • └ sourcePlatformName
  • String
  • 可选
  • 淘宝
  • 订单来源平台名称
  • └ shopNick
  • String
  • 可选
  • 店铺名称
  • 店铺名称
  • └ sellerNick
  • String
  • 可选
  • 卖家名称
  • 卖家名称
  • └ extendProps
  • Map
  • 可选
  • 退货单信息扩展字段
  • orderLines
  • OrderLine []
  • 可选
  • 订单信息
  • └ orderLineNo
  • String
  • 可选
  • D1234
  • 单据行号
  • └ sourceOrderCode
  • String
  • 可选
  • PD1224
  • 交易平台订单
  • └ subSourceOrderCode
  • String
  • 可选
  • PL1234
  • 交易平台子订单编码
  • └ ownerCode
  • String
  • 必须
  • HZ1234
  • 货主编码
  • └ itemCode
  • String
  • 必须
  • I1234
  • 商品编码
  • └ itemId
  • String
  • 可选
  • CK1234
  • 仓储系统商品编码(条件为提供后端(仓储系统)商品编码的仓储系统)
  • └ inventoryType
  • String
  • 可选
  • ZP
  • 库存类型(ZP=正品;CC=残次;JS=机损;XS=箱损;默认为ZP)
  • └ planQty
  • Number
  • 必须
  • 12
  • 应收商品数量
  • └ batchCode
  • String
  • 可选
  • P123
  • 批次编码
  • └ productDate
  • String
  • 可选
  • 2016-09-09
  • 生产日期(YYYY-MM-DD)
  • └ expireDate
  • String
  • 可选
  • 2016-09-09
  • 过期日期(YYYY-MM-DD)
  • └ produceCode
  • String
  • 可选
  • P1234
  • 生产批号
  • snList
  • SnList
  • 可选
  • sn列表
  • └ sn
  • String []
  • 可选
  • sn编码
  • └ orderFlag
  • String
  • 必须
  • visit
  • 用字符串格式来表示订单标记列表(比如VISIT^ SELLER_AFFORD^SYNC_RETURN_BILL等;中间用“^”来隔开订单标记list (所 有字母全部大写) VISIT=上门;SELLER_AFFORD=是否卖家承担运费(默认是)SYNC_RETURN_BILL=同时退回发票)
  • └ returnReason
  • String
  • 必须
  • 破损退货
  • 退货原因
  • └ extendProps
  • Map
  • 可选
  • 订单信息扩展字段
  • └ extendProps
  • Map
  • 可选
  • 扩展属性

响应参数

名称 类型 示例值 描述
response Response
  • └ flag
  • String
  • success
  • 响应结果:success|failure
  • └ code
  • String
  • 0
  • 响应码
  • └ message
  • String
  • invalid appkey
  • 响应信息
  • └ returnOrderId
  • String
  • RID1234
  • 仓储系统退货单编码

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
QimenClient client = new DefaultQimenClient(url, appkey, secret);
ReturnorderCreateRequest req = new ReturnorderCreateRequest();
req.setCustomerId("stub-cust-code");
req.setVersion("2.0");
Item obj1 = new Item();
obj1.setOwnerCode("奇门仓储字段,说明,string(50),,");
obj1.setTitle("奇门仓储字段,说明,string(50),,");
obj1.setItemCode("奇门仓储字段,说明,string(50),,");
obj1.setItemId("奇门仓储字段,说明,string(50),,");
obj1.setItemName("奇门仓储字段,说明,string(50),,");
obj1.setEnglishName("奇门仓储字段,说明,string(50),,");
obj1.setShortName("奇门仓储字段,说明,string(50),,");
obj1.setCategoryId("奇门仓储字段,说明,string(50),,");
obj1.setCategoryName("奇门仓储字段,说明,string(50),,");
obj1.setSkuProperty("奇门仓储字段,说明,string(50),,");
obj1.setItemType("奇门仓储字段,说明,string(50),,");
obj1.setTagPrice("奇门仓储字段,说明,string(50),,");
obj1.setRetailPrice("奇门仓储字段,说明,string(50),,");
obj1.setCostPrice("奇门仓储字段,说明,string(50),,");
obj1.setPurchasePrice("奇门仓储字段,说明,string(50),,");
obj1.setSupplierCode("奇门仓储字段,说明,string(50),,");
obj1.setSupplierName("奇门仓储字段,说明,string(50),,");
obj1.setSeasonCode("奇门仓储字段,说明,string(50),,");
obj1.setSeasonName("奇门仓储字段,说明,string(50),,");
obj1.setBrandCode("奇门仓储字段,说明,string(50),,");
obj1.setBrandName("奇门仓储字段,说明,string(50),,");
obj1.setSn("奇门仓储字段,说明,string(50),,");
obj1.setIsSNMgmt("奇门仓储字段,说明,string(50),,");
obj1.setBarCode("奇门仓储字段,说明,string(50),,");
obj1.setColor("奇门仓储字段,说明,string(50),,");
obj1.setSize("奇门仓储字段,说明,string(50),,");
obj1.setLength("奇门仓储字段,说明,string(50),,");
obj1.setWidth("奇门仓储字段,说明,string(50),,");
obj1.setHeight("奇门仓储字段,说明,string(50),,");
obj1.setVolume("奇门仓储字段,说明,string(50),,");
obj1.setGrossWeight("奇门仓储字段,说明,string(50),,");
obj1.setNetWeight("奇门仓储字段,说明,string(50),,");
obj1.setTareWeight("奇门仓储字段,说明,string(50),,");
obj1.setSafetyStock("奇门仓储字段,说明,string(50),,");
obj1.setStockUnit("奇门仓储字段,说明,string(50),,");
obj1.setStockStatus("奇门仓储字段,说明,string(50),,");
obj1.setProductDate("奇门仓储字段,说明,string(50),,");
obj1.setExpireDate("奇门仓储字段,说明,string(50),,");
obj1.setIsShelfLifeMgmt("奇门仓储字段,说明,string(50),,");
obj1.setShelfLife("奇门仓储字段,说明,string(50),,");
obj1.setRejectLifecycle("奇门仓储字段,说明,string(50),,");
obj1.setLockupLifecycle("奇门仓储字段,说明,string(50),,");
obj1.setAdventLifecycle("奇门仓储字段,说明,string(50),,");
obj1.setBatchCode("奇门仓储字段,说明,string(50),,");
obj1.setBatchRemark("奇门仓储字段,说明,string(50),,");
obj1.setIsBatchMgmt("奇门仓储字段,说明,string(50),,");
obj1.setPackCode("奇门仓储字段,说明,string(50),,");
obj1.setPcs("奇门仓储字段,说明,string(50),,");
obj1.setOriginAddress("奇门仓储字段,说明,string(50),,");
obj1.setApprovalNumber("奇门仓储字段,说明,string(50),,");
obj1.setIsFragile("奇门仓储字段,说明,string(50),,");
obj1.setIsHazardous("奇门仓储字段,说明,string(50),,");
obj1.setPricingCategory("奇门仓储字段,说明,string(50),,");
obj1.setIsSku("奇门仓储字段,说明,string(50),,");
obj1.setPackageMaterial("奇门仓储字段,说明,string(50),,");
obj1.setPrice("奇门仓储字段,说明,string(50),,");
obj1.setIsAreaSale("奇门仓储字段,说明,string(50),,");
obj1.setQuantity("奇门仓储字段,说明,string(50),,");
obj1.setNormalQty("奇门仓储字段,说明,string(50),,");
obj1.setDefectiveQty("奇门仓储字段,说明,string(50),,");
obj1.setReceiveQty("奇门仓储字段,说明,string(50),,");
obj1.setExCode("奇门仓储字段,说明,string(50),,");
obj1.setDiscountPrice("奇门仓储字段,说明,string(50),,");
obj1.setInventoryType("奇门仓储字段,说明,string(50),,");
obj1.setPlanQty("奇门仓储字段,说明,string(50),,");
obj1.setSourceOrderCode("奇门仓储字段,说明,string(50),,");
obj1.setSubSourceOrderCode("奇门仓储字段,说明,string(50),,");
obj1.setProduceCode("奇门仓储字段,说明,string(50),,");
obj1.setOrderLineNo("奇门仓储字段,说明,string(50),,");
obj1.setActualQty("奇门仓储字段,说明,string(50),,");
obj1.setAmount("奇门仓储字段,说明,string(50),,");
obj1.setUnit("奇门仓储字段,说明,string(50),,");
obj1.setWarehouseCode("奇门仓储字段,说明,string(50),,");
obj1.setLockQuantity("奇门仓储字段,说明,string(50),,");
obj1.setOrderCode("奇门仓储字段,说明,string(50),,");
obj1.setOrderType("奇门仓储字段,说明,string(50),,");
obj1.setOutBizCode("奇门仓储字段,说明,string(50),,");
obj1.setProductCode("奇门仓储字段,说明,string(50),,");
obj1.setPaperQty("奇门仓储字段,说明,string(50),,");
obj1.setDiffQuantity("奇门仓储字段,说明,string(50),,");
obj1.setExtCode("奇门仓储字段,说明,string(50),,");
obj1.setLackQty("奇门仓储字段,说明,string(50),,");
obj1.setReason("奇门仓储字段,说明,string(50),,");
obj1.setSnCode("奇门仓储字段,说明,string(50),,");
Batch obj2 = new Batch();
obj2.setBatchCode("奇门仓储字段,说明,string(50),,");
obj2.setProductDate("奇门仓储字段,说明,string(50),,");
obj2.setExpireDate("奇门仓储字段,说明,string(50),,");
obj2.setProduceCode("奇门仓储字段,说明,string(50),,");
obj2.setInventoryType("奇门仓储字段,说明,string(50),,");
obj2.setActualQty("奇门仓储字段,说明,string(50),,");
obj2.setQuantity("奇门仓储字段,说明,string(50),,");
obj2.setRemark("备注");
Batch obj3 = new Batch();
obj3.setBatchCode("奇门仓储字段,说明,string(50),,");
obj3.setProductDate("奇门仓储字段,说明,string(50),,");
obj3.setExpireDate("奇门仓储字段,说明,string(50),,");
obj3.setProduceCode("奇门仓储字段,说明,string(50),,");
obj3.setInventoryType("奇门仓储字段,说明,string(50),,");
obj3.setActualQty("奇门仓储字段,说明,string(50),,");
obj3.setQuantity("奇门仓储字段,说明,string(50),,");
obj2.setBatch(obj3);
obj1.setBatchs(obj2);
obj1.setGoodsCode("奇门仓储字段,说明,string(50),,");
obj1.setStandardPrice("奇门仓储字段,说明,string(50),,");
obj1.setReferencePrice("奇门仓储字段,说明,string(50),,");
obj1.setDiscount("奇门仓储字段,说明,string(50),,");
obj1.setActualAmount("奇门仓储字段,说明,string(50),,");
PriceAdjustment obj4 = new PriceAdjustment();
obj4.setType("奇门仓储字段,说明,string(50),,");
obj4.setStandardPrice("奇门仓储字段,说明,string(50),,");
obj4.setDiscount("奇门仓储字段,说明,string(50),,");
obj4.setStartDate("奇门仓储字段,说明,string(50),,");
obj4.setEndDate("奇门仓储字段,说明,string(50),,");
obj4.setRemark("备注");
obj1.setPriceAdjustment(obj4);
obj1.setLatestUpdateTime("奇门仓储字段,说明,string(50),,");
obj1.setChangeTime("奇门仓储字段,说明,string(50),,");
obj1.setTempRequirement("奇门仓储字段,说明,string(50),,");
obj1.setChannelCode("奇门仓储字段,说明,string(50),,");
obj1.setOriginCode("奇门仓储字段,说明,string(50),,");
obj1.setRemark("备注");
req.setItemList(obj1);
ReturnOrder obj5 = new ReturnOrder();
obj5.setOwnerCode("奇门仓储字段,说明,string(50),,");
obj5.setReturnOrderStatus("奇门仓储字段,说明,string(50),,");
obj5.setSourceOrderCode("奇门仓储字段,说明,string(50),,");
obj5.setRefOrderCode("奇门仓储字段,说明,string(50),,");
obj5.setEarliestArrivalTime("奇门仓储字段,说明,string(50),,");
obj5.setPlanArrivalTime("奇门仓储字段,说明,string(50),,");
obj5.setActionType("奇门仓储字段,说明,string(50),,");
obj5.setReturnOrderId("奇门仓储字段,说明,string(50),,");
obj5.setOrderConfirmTime("奇门仓储字段,说明,string(50),,");
obj5.setOutBizCode("奇门仓储字段,说明,string(50),,");
obj5.setSupplierCode("奇门仓储字段,说明,string(50),,");
obj5.setSupplierName("奇门仓储字段,说明,string(50),,");
obj5.setReturnOrderCode("R1234");
obj5.setWarehouseCode("W1234");
obj5.setOrderType("THRK");
obj5.setOrderFlag("VISIT");
obj5.setPreDeliveryOrderCode("PD1234");
obj5.setPreDeliveryOrderId("PDI1234");
obj5.setLogisticsCode("SF");
obj5.setLogisticsName("顺丰");
obj5.setExpressCode("YD1234");
obj5.setReturnReason("破损退货");
obj5.setBuyerNick("淘宝");
SenderInfo obj6 = new SenderInfo();
obj6.setRemark("备注");
obj6.setId("奇门仓储字段,说明,string(50),,");
obj6.setCarNo("奇门仓储字段,说明,string(50),,");
obj6.setFax("奇门仓储字段,说明,string(50),,");
obj6.setBirthDate("奇门仓储字段,说明,string(50),,");
obj6.setCareer("奇门仓储字段,说明,string(50),,");
obj6.setNick("奇门仓储字段,说明,string(50),,");
obj6.setIdType("奇门仓储字段,说明,string(50),,");
obj6.setIdNumber("奇门仓储字段,说明,string(50),,");
obj6.setCountryCodeCiq("奇门仓储字段,说明,string(50),,");
obj6.setCountryCodeCus("奇门仓储字段,说明,string(50),,");
obj6.setGender("奇门仓储字段,说明,string(50),,");
obj6.setCompany("淘宝");
obj6.setName("老王");
obj6.setZipCode("043300");
obj6.setTel("81020340");
obj6.setMobile("13214567869");
obj6.setEmail("345@gmail.com");
obj6.setCountryCode("051532");
obj6.setProvince("浙江省");
obj6.setCity("杭州");
obj6.setArea("余杭");
obj6.setTown("横加桥");
obj6.setDetailAddress("杭州市余杭区989号");
obj5.setSenderInfo(obj6);
obj5.setRemark("备注信息");
obj5.setSourcePlatformCode("TB");
obj5.setSourcePlatformName("淘宝");
obj5.setShopNick("店铺名称");
obj5.setSellerNick("卖家名称");
req.setReturnOrder(obj5);
OrderLine obj7 = new OrderLine();
obj7.setOrderSourceCode("奇门仓储字段,说明,string(50),,");
obj7.setSubSourceCode("奇门仓储字段,说明,string(50),,");
obj7.setItemName("奇门仓储字段,说明,string(50),,");
obj7.setSkuProperty("奇门仓储字段,说明,string(50),,");
obj7.setPurchasePrice("奇门仓储字段,说明,string(50),,");
obj7.setRetailPrice("奇门仓储字段,说明,string(50),,");
obj7.setActualQty("奇门仓储字段,说明,string(50),,");
obj7.setExtCode("奇门仓储字段,说明,string(50),,");
obj7.setActualPrice("奇门仓储字段,说明,string(50),,");
obj7.setDiscountAmount("奇门仓储字段,说明,string(50),,");
obj7.setQuantity("奇门仓储字段,说明,string(50),,");
obj7.setOutBizCode("奇门仓储字段,说明,string(50),,");
obj7.setProductCode("奇门仓储字段,说明,string(50),,");
obj7.setStockInQty("奇门仓储字段,说明,string(50),,");
obj7.setStockOutQty("奇门仓储字段,说明,string(50),,");
obj7.setWarehouseCode("奇门仓储字段,说明,string(50),,");
obj7.setDeliveryOrderId("奇门仓储字段,说明,string(50),,");
obj7.setStatus("奇门仓储字段,说明,string(50),,");
obj7.setQrCode("奇门仓储字段,说明,string(50),,");
Batch obj8 = new Batch();
obj8.setBatchCode("奇门仓储字段,说明,string(50),,");
obj8.setProductDate("奇门仓储字段,说明,string(50),,");
obj8.setExpireDate("奇门仓储字段,说明,string(50),,");
obj8.setProduceCode("奇门仓储字段,说明,string(50),,");
obj8.setInventoryType("奇门仓储字段,说明,string(50),,");
obj8.setActualQty("奇门仓储字段,说明,string(50),,");
obj8.setQuantity("奇门仓储字段,说明,string(50),,");
obj8.setRemark("备注");
obj7.setBatchs(obj8);
obj7.setPayNo("奇门仓储字段,说明,string(50),,");
obj7.setTaobaoItemCode("奇门仓储字段,说明,string(50),,");
obj7.setDiscountPrice("奇门仓储字段,说明,string(50),,");
obj7.setColor("奇门仓储字段,说明,string(50),,");
obj7.setSize("奇门仓储字段,说明,string(50),,");
obj7.setStandardPrice("奇门仓储字段,说明,string(50),,");
obj7.setReferencePrice("奇门仓储字段,说明,string(50),,");
obj7.setDiscount("奇门仓储字段,说明,string(50),,");
obj7.setStandardAmount("奇门仓储字段,说明,string(50),,");
obj7.setSettlementAmount("奇门仓储字段,说明,string(50),,");
obj7.setLocationCode("奇门仓储字段,说明,string(50),,");
obj7.setAmount("奇门仓储字段,说明,string(50),,");
obj7.setMoveOutLocation("奇门仓储字段,说明,string(50),,");
obj7.setMoveInLocation("奇门仓储字段,说明,string(50),,");
obj7.setExceptionQty("奇门仓储字段,说明,string(50),,");
obj7.setSubDeliveryOrderId("奇门仓储字段,说明,string(50),,");
obj7.setRemark("备注");
obj7.setOrderLineNo("D1234");
obj7.setSourceOrderCode("PD1224");
obj7.setSubSourceOrderCode("PL1234");
obj7.setOwnerCode("HZ1234");
obj7.setItemCode("I1234");
obj7.setItemId("CK1234");
obj7.setInventoryType("ZP");
obj7.setPlanQty(12L);
obj7.setBatchCode("P123");
obj7.setProductDate("2016-09-09");
obj7.setExpireDate("2016-09-09");
obj7.setProduceCode("P1234");
SnList obj9 = new SnList();
obj9.setSn("");
obj7.setSnList(obj9);
obj7.setOrderFlag("visit");
obj7.setReturnReason("破损退货");
req.setOrderLines(obj7);
ReturnorderCreateResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<response>
    <flag>success</flag>
    <code>0</code>
    <message>invalid appkey</message>
    <returnOrderId>RID1234</returnOrderId>
</response>

异常示例

  • 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

返回
顶部