store.logistics.offline.send(订单发货接口（同步异步接口）数据获取队列（rpccallback）)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
tid	是	string	323423423428	交易ID
company_code	是	string	POST	物流公司代码.如'POST'就代表中国邮政,'ZJS'就代表宅急送.调用 store.logistics.companies.get 获取。如传入的代码非淘宝官方物流合作公司，默认是'其他'物流的方式，在淘宝不显示物流具体进度，故传入需谨慎。（京东SOPL商家该参数不需要填写）
logistics_no	是	string	F5257222	运单号。具体一个物流公司的真实运单号码。淘宝官方物流会校验，请谨慎传入；若company_code中传入的代码非淘宝官方物流合作公司，此处运单号不校验。（京东SOPL商家该参数不需要填写）
sender_id	是	number	1231234	卖家联系人地址库ID(不填为默认ID)。可以通过store.logistics.address.search接口查询到地址库ID。如果为空，取的卖家的默认取货地址
cancel_id	是	number	示例值	卖家联系人地址库ID。如果为空，取的卖家的默认退货地址
package_num	是	number	1	包裹数量
send_type	是	number	1	发货类型（京东LBP，SOPL商家出库需要填写该参数)默认值为1
company_name	是	string	顺丰快递	物流公司名称
ship_date	是	date	示例值	实际发货时间。格式:yyyy-MM-dd HH:mm:ss（亚马逊必填，默认为当前时间）
item_list	是	string	[{"oid":"123","itemId":"3","num":4},{"oid":"789","itemId":"1","num":2}]	发货单上的商品和数量（itemid为亚马逊订单上亚马逊指定商品编码，num为该商品数量）
oid_list	是	string	111,222,333	拆单子订单列表，对应的数据是：子订单号的列表。可以不传，但是如果传了则必须符合传递的规则。子订单必须是操作的物流订单的子订单的真子集
is_split	是	string	0	表明是否是拆单，默认值0，1表示拆单
node_id	是	string	11111_222222	节点信息
request_type	否	string	async	API请求方式同步：sync；异步：async，默认：async

响应参数

字段	类型	示例值	字段描述
└ rsp接口请求的成功succsuccstring └ msg_id接口任务号（唯一）3463421b2581604c74dcb9b74ffab2e4string data操作结果object shippingobject └ is_success发货请求返回结果标记，成功：truetruestring

字段

类型

示例值

字段描述

└ rsp接口请求的成功succsuccstring

└ msg_id接口任务号（唯一）3463421b2581604c74dcb9b74ffab2e4string

data操作结果object
- shippingobject
- - └ is_success发货请求返回结果标记，成功：truetruestring

响应示例

{
  "rsp": "succ",
  "msg_id": "3463421b2581604c74dcb9b74ffab2e4",
  "data": {
    "shipping": {
      "is_success": "true"
    }
  }
}

异常返回

错误码	错误描述

API工具

API测试工具

store.items.quantity.list.update(批量库存更新接口（条数小于20）（接口只支持异步方式）数据获取队列（rpccallback）)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
list_quantity	是	object		list_quantity中包含3个参数bn:外部商家编码；quantity：库存数；memo:备注;数据传递为json格式，一次包含数据条数上限20条。
list_quantityobject └ bn货号（sku对应的商家编码）ad11string └ quantity库存总数13string └ memo备注string
node_id	是	string	111111_22222	节点信息
request_type	否	string	async	API请求方式同步：sync；异步：async，默认：async

响应参数

字段	类型	示例值	字段描述
└ rsp接口请求的成功succsuccstring └ msg_id接口任务号（唯一）3463421b2581604c74dcb9b74ffab2e4string data操作结果object └ true_bn已更新库存的BNarray └ error_bn更新失败的BNarray └ no_bn不存在的BNarray

字段

类型

示例值

字段描述

└ rsp接口请求的成功succsuccstring

└ msg_id接口任务号（唯一）3463421b2581604c74dcb9b74ffab2e4string

data操作结果object
- └ true_bn已更新库存的BNarray
- └ error_bn更新失败的BNarray
- └ no_bn不存在的BNarray

响应示例

{
  "rsp": "succ",
  "msg_id": "3463421b2581604c74dcb9b74ffab2e4",
  "data": {
    "true_bn": [],
    "error_bn": [],
    "no_bn": []
  }
}

异常返回

错误码	错误描述

API工具

API测试工具

store.logistics.pub(订阅快递单物流流转信息（同步异步接口）数据获取队列（hqepaylogistics）)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
logistic_code_list	是	string	333,444,555,666	运单号,多个用逗号分隔
company_code	是	string	POST	物流公司代码.如'POST'就代表中国邮政,'ZJS'就代表宅急送一次请求只支持一家物流公司
node_id	是	string	111111_222222	节点信息
request_type	否	string	sync	API请求方式同步：sync；异步：async，默认：sync

响应参数

字段	类型	示例值	字段描述
└ rsp接口请求的成功succsuccstring └ msg_id接口任务号（唯一）5745484FC0A817126DB34333****D82Fstring data操作结果object └ update_time更新时间格式 yyyy-MM-dd HH:mm:ssdatetime └ reason备注string └ success表示请求成功或者失败成功：true 失败：falsestring

字段

类型

示例值

字段描述

└ rsp接口请求的成功succsuccstring

└ msg_id接口任务号（唯一）5745484FC0A817126DB34333****D82Fstring

data操作结果object
- └ update_time更新时间格式 yyyy-MM-dd HH:mm:ssdatetime
- └ reason备注string
- └ success表示请求成功或者失败成功：true 失败：falsestring

响应示例

{
  "rsp": "succ",
  "msg_id": "5745484FC0A817126DB34333****D82F",
  "data": {
    "update_time": "",
    "reason": "",
    "success": ""
  }
}

异常返回

错误码	错误描述

API工具

API测试工具

logistics.trace.detail.get(获取快递单物流流转信息（同步异步接口）数据获取队列（hqepaylogistics）)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
tid	是	string	323423423428	交易ID
company_code	是	string	POST	物流公司代码.如'POST'就代表中国邮政,'ZJS'就代表宅急送
logistic_code	是	string	F5257222	运单号。具体一个物流公司的真实运单号码
node_id	是	string	111111_222222	节点信息
request_type	否	string	sync	API请求方式同步：sync；异步：async，默认：sync

响应参数

字段	类型	示例值	字段描述
└ rsp接口请求的成功succsuccstring └ msg_id接口任务号（唯一）5745484FC0A817126DB34333**D82Fstring data操作结果object └ logistic_code运单号。具体一个物流公司的真实运单号码330*3134955string └ company_code物流公司代码.如'POST'就代表中国邮政,'ZJS'就代表宅急送stostring └ state表示快递单状态在途中：2，签收：3，问题件：42string └ success表示请求成功或者失败成功：true 失败：falsetruestring traces快递物流流转信息详情object └ accept_station描述收件】【浙江瑞安公司】的收件员【卡贝卫浴】已收件string └ accept_time时间2016-05-09 16:59:28datetime

字段

类型

示例值

字段描述

└ rsp接口请求的成功succsuccstring

└ msg_id接口任务号（唯一）5745484FC0A817126DB34333****D82Fstring

data操作结果object
- └ logistic_code运单号。具体一个物流公司的真实运单号码330***3134955string
- └ company_code物流公司代码.如'POST'就代表中国邮政,'ZJS'就代表宅急送stostring
- └ state表示快递单状态在途中：2，签收：3，问题件：42string
- └ success表示请求成功或者失败成功：true 失败：falsetruestring
- traces快递物流流转信息详情object
- - └ accept_station描述收件】【浙江瑞安公司】的收件员【卡贝卫浴】已收件string
  - └ accept_time时间2016-05-09 16:59:28datetime

响应示例

{
  "rsp": "succ",
  "msg_id": "5745484FC0A817126DB34333****D82F",
  "data": {
    "logistic_code": "330***3134955",
    "company_code": "sto",
    "state": "2",
    "success": "true",
    "traces": {
      "accept_station": "收件】【浙江瑞安公司】的收件员【卡贝卫浴】已收件",
      "accept_time": "2016-05-09 16:59:28"
    }
  }
}

异常返回

错误码	错误描述

API工具

API测试工具

store.tmc.group.add(订阅发票信息（专供淘宝）)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
group_name	是	string	einvocie	订阅分组名
node_id	是	string	111111_222222	节点信息
tb_nickname	是	string	你好	用户名（淘宝nickname）
request_type	否	string	sync	API请求方式同步：sync；异步：async，默认：sync

响应参数

字段	类型	示例值	字段描述
└ rsp接口请求的成功succsuccstring └ msg_id接口任务号（唯一）5745484FC0A817126DB34333string dataobject └ success表示请求成功或者失败成功：true 失败：falsetruestring

字段

类型

示例值

字段描述

└ rsp接口请求的成功succsuccstring

└ msg_id接口任务号（唯一）5745484FC0A817126DB34333string

dataobject
- └ success表示请求成功或者失败成功：true 失败：falsetruestring

响应示例

{
  "rsp": "succ",
  "msg_id": "5745484FC0A817126DB34333",
  "data": {
    "success": "true"
  }
}

异常返回

错误码	错误描述

API工具

API测试工具

store.tmc.group.delete(取消订阅)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
group_name	是	string	einvocie	订阅分组名
tb_nickname	是	string	你好	用户名（淘宝nickname）
node_id	是	string	111111_222222	节点信息
request_type	否	string	sync	API请求方式同步：sync；异步：async，默认：sync

响应参数

字段	类型	示例值	字段描述
└ rsp接口请求的成功succsuccstring └ msg_id接口任务号（唯一）5745484FC0A817126DB34333string dataobject └ success表示请求成功或者失败成功：true 失败：falsetruestring

字段

类型

示例值

字段描述

└ rsp接口请求的成功succsuccstring

└ msg_id接口任务号（唯一）5745484FC0A817126DB34333string

dataobject
- └ success表示请求成功或者失败成功：true 失败：falsetruestring

响应示例

{
  "rsp": "succ",
  "msg_id": "5745484FC0A817126DB34333",
  "data": {
    "success": "true"
  }
}

异常返回

错误码	错误描述

API工具

API测试工具

store.einvoice.apply.get(开票申请数据获取接口)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
platform_tid	是	string	1231321344123	平台订单号
apply_id	是	string	sdfsfsdf12313	开票申请ID，跟消息中的apply_id对应，传入applyId后，只会返回一条开票申请消息
node_id	是	string	111111_222222	节点信息

响应参数

字段	类型	示例值	字段描述
└ rsp接口请求的成功succsuccstring └ msg_id接口任务号（唯一）5745484FC0A817126DB34333string dataobject └ is_success请求成功truestring apply_list开票明细object └ platform_code电商平台代码,TB,TM,ALIPAY,JDstring └ status开票申请状态，0=已拒绝，1=申请中，2=已同意string └ memo买家备注备注string └ payer_name买家抬头string └ platform_tid电商平台对应的订单号string └ payer_register_no买家税号string └ trigger_status开票申请的触发类型，buyer_payed=卖家已付款，sent_goods=卖家已发货，buyer_confirm=买家确认收货，refund_seller_confirm=卖家同意退款，invoice_supply=买家申请补开发票，invoice_change=买家申请改抬头string └ invoice_kind发票种类，0=电子发票，1=纸质发票，2=专票，现在默认是0string └ business_type抬头类型，0=个人，1=企业string └ invoice_type发票(开票)类型，蓝票blue,红票red，默认bluestring └ invoice_amount开票金额string └ sum_price不含税总金额string └ sum_tax总税额string invoice_items发票明细object └ item_name发票项目名称（或商品名称）string └ amount价税合计。(等于sumPrice和tax之和)string └ row_type发票行性质。0表示正常行，1表示折扣行，2表示被折扣行。比如充电器单价100元，折扣10元，则明细为2行，充电器行性质为2，折扣行性质为1。如果充电器没有折扣，则值应为0string └ specification规格型号,可选string └ sum_price总价，格式：100.00(不含税)string └ tax税额string └ price单价，格式：100.00(不含税)string └ quantity数量string └ tax_rate税率。税率只能为0或0.03或0.04或0.06或0.11或0.13或0.17string └ unit单位string

字段

类型

示例值

字段描述

└ rsp接口请求的成功succsuccstring

└ msg_id接口任务号（唯一）5745484FC0A817126DB34333string

dataobject
- └ is_success请求成功truestring
- apply_list开票明细object
- - └ platform_code电商平台代码,TB,TM,ALIPAY,JDstring
  - └ status开票申请状态，0=已拒绝，1=申请中，2=已同意string
  - └ memo买家备注备注string
  - └ payer_name买家抬头string
  - └ platform_tid电商平台对应的订单号string
  - └ payer_register_no买家税号string
  - └ trigger_status开票申请的触发类型，buyer_payed=卖家已付款，sent_goods=卖家已发货，buyer_confirm=买家确认收货，refund_seller_confirm=卖家同意退款，invoice_supply=买家申请补开发票，invoice_change=买家申请改抬头string
  - └ invoice_kind发票种类，0=电子发票，1=纸质发票，2=专票，现在默认是0string
  - └ business_type抬头类型，0=个人，1=企业string
  - └ invoice_type发票(开票)类型，蓝票blue,红票red，默认bluestring
  - └ invoice_amount开票金额string
  - └ sum_price不含税总金额string
  - └ sum_tax总税额string
  - invoice_items发票明细object
  - - └ item_name发票项目名称（或商品名称）string
    - └ amount价税合计。(等于sumPrice和tax之和)string
    - └ row_type发票行性质。0表示正常行，1表示折扣行，2表示被折扣行。比如充电器单价100元，折扣10元，则明细为2行，充电器行性质为2，折扣行性质为1。如果充电器没有折扣，则值应为0string
    - └ specification规格型号,可选string
    - └ sum_price总价，格式：100.00(不含税)string
    - └ tax税额string
    - └ price单价，格式：100.00(不含税)string
    - └ quantity数量string
    - └ tax_rate税率。税率只能为0或0.03或0.04或0.06或0.11或0.13或0.17string
    - └ unit单位string

响应示例

{
  "rsp": "succ",
  "msg_id": "5745484FC0A817126DB34333",
  "data": {
    "is_success": "true",
    "apply_list": {
      "platform_code": "",
      "status": "",
      "memo": "备注",
      "payer_name": "",
      "platform_tid": "",
      "payer_register_no": "",
      "trigger_status": "",
      "invoice_kind": "",
      "business_type": "",
      "invoice_type": "",
      "invoice_amount": "",
      "sum_price": "",
      "sum_tax": "",
      "invoice_items": {
        "item_name": "",
        "amount": "",
        "row_type": "",
        "specification": "",
        "sum_price": "",
        "tax": "",
        "price": "",
        "quantity": "",
        "tax_rate": "",
        "unit": ""
      }
    }
  }
}

异常返回

错误码	错误描述

API工具

API测试工具

store.confirm.delivery(确认某一条出仓单(唯品会JIT))

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	11111_2222	节点信息
vendor_id	是	string	111231313	供应商ID
storage_no	是	string	12323123	入库单号
store_sn	否	string		门店编码(门店必写)

响应示例(自定义结构)

异常返回

错误码	错误描述

API工具

API测试工具

store.create.delivery(用于用户创建出仓单(唯品会JIT))

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	111111_222222	节点信息
vendor_id	是	string		供应商ID
po_no	是	string		po号
delivery_no	是	string		运单号
warehouse	是	string		送货仓库
delivery_time	否	string	2014-07-01 10:00:00	送货时间
arrival_time	是	string	2014-07-01 09:00:00	要求到货时间；空运(delivery_method=2)可选的时间段：9:00:00,16:00:00,18:00:00，23:59:00 ；汽运（delivery_method=1)可选的时间段：9:00:00,16:00:00,20:00:00,22:00:00，23:59:00
race_time	否	string	2014-07-01 10:00:00	预计收货时间
carrier_name	是	string		承运商名称
tel	否	string		联系电话
driver	否	string		司机姓名
driver_tel	否	string		司机联系电话
plate_number	否	string		车牌号
page	否	string		页码
limit	否	string		每页记录数(如果超过100,也只返回100条记录)
delivery_method	否	string	1	配送方式 1：汽运,2：空运;默认值：1
store_sn	否	string		门店编码
carrier_code	否	string		承运商编码

响应参数

字段	类型	示例值	字段描述
└ rsp接口请求的成功succsuccstring └ msg_id接口任务号（唯一）string dataobject └ delivery_id出库单Idstring └ storage_no入库单号string

字段

类型

示例值

字段描述

└ rsp接口请求的成功succsuccstring

└ msg_id接口任务号（唯一）string

dataobject
- └ delivery_id出库单Idstring
- └ storage_no入库单号string

响应示例

{
  "rsp": "succ",
  "msg_id": "",
  "data": {
    "delivery_id": "",
    "storage_no": ""
  }
}

异常返回

错误码	错误描述

API工具

API测试工具

store.create.pick(创建拣货单信息(唯品会JIT))

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	11111_2222	节点信息
po_no	是	string		po单编号,多po用英文逗号分隔
vendor_id	是	string		供应商ID
co_mode	否	string		合作模式
warehouse	否	string		送货仓库

响应参数

字段	类型	示例值	字段描述
└ rsp接口请求的成功succsuccstring └ msg_id接口任务号（唯一）string dataobject └ pick_no拣货单编号，正常拣货单：PICK- 补货单：BHPICK- 多po拣货单：MULPICK-string └ pick_type拣货单类别: JIT分销：jit_4a 普通jit：jitstring └ warehouse送货仓库string └ store_sn门店编码string └ jit_typejit类型，1：OXO ，2：仓中仓，返回空时，则为普通jitstring

字段

类型

示例值

字段描述

└ rsp接口请求的成功succsuccstring

└ msg_id接口任务号（唯一）string

dataobject
- └ pick_no拣货单编号，正常拣货单：PICK- 补货单：BHPICK- 多po拣货单：MULPICK-string
- └ pick_type拣货单类别: JIT分销：jit_4a 普通jit：jitstring
- └ warehouse送货仓库string
- └ store_sn门店编码string
- └ jit_typejit类型，1：OXO ，2：仓中仓，返回空时，则为普通jitstring

响应示例

{
  "rsp": "succ",
  "msg_id": "",
  "data": {
    "pick_no": "",
    "pick_type": "",
    "warehouse": "",
    "store_sn": "",
    "jit_type": ""
  }
}

异常返回

错误码	错误描述

API工具

API测试工具

store.delete.deliverydetail(接口用于用户删除指定单号的出仓明细(唯品会JIT))

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	11111_222222	节点信息
vendor_id	是	string		供应商ID
storage_no	是	string		入库单号
po_no	否	string		po订单号(多个po用英文逗号隔开）

响应参数

字段

类型

示例值

字段描述

└ rsp接口请求的成功succsuccstring

└ msg_id接口任务号（唯一）string

dataobject
- └ delivery_no入库单号,对应创建出仓单返回的编码storage_nostring
- └ barcode条形码string

响应示例

{
  "rsp": "succ",
  "msg_id": "",
  "data": {
    "delivery_no": "",
    "barcode": ""
  }
}

异常返回

错误码	错误描述

API工具

API测试工具

store.get.pickdetail(获取指定拣货单明细信息(唯品会JIT))

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	11111111_222222	节点信息
po_no	是	string		po单编号
vendor_id	是	string		供应商ID
pick_no	是	string		拣货单编号
page	否	string		页码参数
limit	否	string		每页记录条数，默认50，最大100
co_mode	否	string		合作模式 JIT分销：jit_4a 普通JIT：jit

响应参数

字段

类型

示例值

字段描述

└ rsp接口请求的成功succsuccstring

└ msg_id接口任务号（唯一）string

dataobject
- └ po_nopo单编号string
- └ sell_st_time档期开始销售时间2014-07-01 10:00:00string
- └ sell_et_time档期结束销售时间2014-07-01 10:00:00string
- └ export_time导出时间2014-07-01 10:00:00string
- └ export_num导出次数string
- └ warehouse送货仓库string
- └ order_cate订单类别 Normalstring
- └ total总记录string
- └ store_snstring
- └ jit_typejit类型，1：OXO ，2：仓中仓，返回空时，则为普通jitstring
- pick_product_listobject
- - └ stock商品拣货数量string
  - └ barcode商品条码string
  - └ art_no货号string
  - └ product_name商品名称string
  - └ size尺码string
  - └ actual_unit_price供货价（不含税）；已下架，请从getSkuPriceInfo获取string
  - └ actual_market_price供货价（含税）；已下架，请从getSkuPriceInfo获取string
  - └ not_delivery_num未送货数(海淘模式特有信息)string

响应示例

{
  "rsp": "succ",
  "msg_id": "",
  "data": {
    "po_no": "",
    "sell_st_time": "2014-07-01 10:00:00",
    "sell_et_time": "2014-07-01 10:00:00",
    "export_time": "2014-07-01 10:00:00",
    "export_num": "",
    "warehouse": "",
    "order_cate": "",
    "total": "",
    "store_sn": "",
    "jit_type": "",
    "pick_product_list": {
      "stock": "",
      "barcode": "",
      "art_no": "",
      "product_name": "",
      "size": "",
      "actual_unit_price": "",
      "actual_market_price": "",
      "not_delivery_num": ""
    }
  }
}

异常返回

错误码	错误描述

API工具

API测试工具

store.get.picklist(获取指定供应商下拣货单列表信息(唯品会JIT))

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string		节点信息
vendor_id	是	string		供应商ID
po_no	否	string		po订单号,支持批量，用英文逗号分隔
pick_no	否	string		拣货单编号
warehouse	否	string		送货仓库
co_mode	否	string		合作模式 JIT分销：jit_4a 普通JIT：jit
order_cate	否	string		订单类别 normal
st_create_time	否	string	2014-07-01 10:00:00	开始创建日期
et_create_time	否	string	2014-07-01 10:00:00	结束创建日期
st_sell_time_from	否	string	2014-07-01 10:00:00	开始开售日期
et_sell_time_from	否	string	2014-07-01 10:00:00	结束开售日期
is_export	否	string		导出状态
page	否	string		页码
limit	否	string		每页记录数(如果超过100,也只返回100条记录)
store_sn	否	string		门店编码

响应参数

字段

类型

示例值

字段描述

└ rsp接口请求的成功succsuccstring

└ msg_id接口任务号（唯一）string

dataobject
- pick拣货单信息列表object
- - └ po_nopo单编号string
  - └ pick_no拣货单编号string
  - └ co_mode合作模式 JIT分销：jit_4a 普通JIT：jitstring
  - └ sell_site送货仓库string
  - └ order_cate订单类别 normalstring
  - └ pick_num拣货数量string
  - └ create_time拣货单创建时间string
  - └ first_export_time首次导出时间string
  - └ export_num导出次数string
  - └ delivery_status送货状态string
  - └ store_sn门店编码string
  - └ delivery_num发货数string
- └ total记录总条数string

响应示例

{
  "rsp": "succ",
  "msg_id": "",
  "data": {
    "pick": {
      "po_no": "",
      "pick_no": "",
      "co_mode": "",
      "sell_site": "",
      "order_cate": "",
      "pick_num": "",
      "create_time": "",
      "first_export_time": "",
      "export_num": "",
      "delivery_status": "",
      "store_sn": "",
      "delivery_num": ""
    },
    "total": ""
  }
}

异常返回

错误码	错误描述

API工具

API测试工具

store.import.deliverydetail(将出仓明细信息导入到出仓单中（目前该接口明细信息最大导入量在500条SKU信息)(唯品会JIT))

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	字段描述
node_id	是	string	节点信息
vendor_id	是	string	供应商ID
po_no	是	string	po单编号,多po用逗号隔开
storage_no	是	string	入库单号
store_sn	否	string	门店编码，OXO业务要求填写，非OXO业务不用填写
delivery_list	是	object	出仓产品列表
└ vendor_type供应商类型：只可传：COMMON或3PLstring └ barcode条形码string └ box_no供应商箱号string └ pick_no拣货单号(后期会改为必填，建议现在就传入)string └ amount商品数量string └ po_nopo（对于多po生成的送货单必填）string

响应示例(自定义结构)

异常返回

错误码	错误描述

API工具

API测试工具

store.trade.shippingaddress.update(编辑交易的收货地址（仅限淘宝）)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string		节点信息
tid	是	string		订单号
receiver_name	否	string		收货人全名
receiver_phone	否	string		固定电话
receiver_mobile	否	string		移动电话
receiver_state	否	string	浙江	省份
receiver_city	否	string	杭州	城市
receiver_district	否	string	西湖区	区/县
receiver_address	否	string		收货地址
receiver_zip	否	string		邮政编码
request_type	否	string		API请求方式同步：sync；异步：async，默认：async

响应参数

字段

类型

示例值

字段描述

└ rsp接口请求的成功succsuccstring

└ msg_id接口任务号（唯一）string

dataobject
- └ tid交易编号 (父订单的交易编号)string
- └ modified交易修改时间(用户对订单的任何修改都会更新此字段)。格式:yyyy-MM-dd HH:mm:ssstring

响应示例

{
  "rsp": "succ",
  "msg_id": "",
  "data": {
    "tid": "",
    "modified": ""
  }
}

异常返回

错误码	错误描述

API工具

API测试工具

store.o2o.trade.get(o2o获取到店自提订单信息(有赞))

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
code	是	string		提货码
node_id	是	string		节点信息(店铺ID)
request_type	否	string	sync	API请求方式同步：sync；异步：async，默认：sync

响应示例(自定义结构)

异常返回

错误码	错误描述

API工具

API测试工具

store.o2o.trade.apply(o2o核销到店自提订单(有赞))

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
code	是	string		消费者端的到店自提订单提货码
extra_info	否	string		核销人（开发者根据自己业务规则传，一般为网点号或手机号）
node_id	是	string		节点信息(店铺ID)
request_type	否	string	sync	API请求方式同步：sync；异步：async，默认：sync

响应示例(自定义结构)

异常返回

错误码	错误描述

API工具

API测试工具

store.o2o.stores.get(o2o获取网点门店列表(有赞))

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
page_no	是	string		当前页
page_size	是	string		每页条数
node_id	是	string		节点信息(店铺ID)
request_type	否	string	sync	API请求方式同步：sync；异步：async，默认：sync

响应示例(自定义结构)

异常返回

错误码	错误描述

API工具

API测试工具

store.bind.url(获取绑定url)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
code	否	string
callback	否	string
request_type	否	string	sync	API请求方式同步：sync；异步：async，默认：sync

响应示例(自定义结构)

异常返回

错误码	错误描述

API工具

API测试工具

store.item.sku.list(获取商品sku列表(抖音))

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string		节点信息
request_type	否	string	sync	API请求方式同步：sync；异步：async，默认：sync
iid	是	string		product_id

响应示例(自定义结构)

异常返回

错误码	错误描述

API工具

API测试工具

store.item.sku.get(获取商品sku详情(抖音))

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string		节点信息
request_type	否	string	sync	API请求方式同步：sync；异步：async，默认：sync
sku_id	否	string		sku id

响应示例(自定义结构)

异常返回

错误码	错误描述

API工具

API测试工具

store.items.list.get(获取商品列表信息(抖音))

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string		节点信息
request_type	否	string	sync	API请求方式同步：sync；异步：async，默认：sync
status	否	string		指定状态返回商品列表：0上架 1下架
check_status	否	string		指定审核状态返回商品列表：1未提审 2审核中 3审核通过 4审核驳回 5封禁 7审核通过，待上架状态
product_type	否	string		0-普通，3-虚拟，6玉石闪购，7云闪购
start_time	否	string		创建开始时间，格式为unix时间戳
end_time	否	string		创建结束时间，格式为unix时间戳
page	否	string		页码
size	否	string		每页返回条数，最多支持100条

响应示例(自定义结构)

异常返回

错误码	错误描述

API工具

API测试工具

store.trade.rate.get(淘宝商品评价接口)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	1976120933_1033393833	节点信息
request_type	否	string	sync	API请求方式同步：sync；异步：async，默认：sync
rate_type	否	string	get	评价类型。可选值:get(得到),give(给出)
role	否	string	buyer	评价者角色即评价的发起方。可选值:seller(卖家),buyer(买家)。当 give buyer 以买家身份给卖家的评价；当 get seller 以买家身份得到卖家给的评价；当 give seller 以卖家身份给买家的评价；当 get buyer 以卖家身份得到买家给的评价。
start_time	否	string	2022-09-21 00:00:00	评价开始时。如果只输入开始时间，那么能返回开始时间之后的评价数据。
end_time	否	string	2022-09-22 00:00:00	评价结束时间。如果只输入结束时间，那么全部返回所有评价数据。
page_no	否	string	1	页码。取值范围:大于零的整数最大限制为200; 默认值:1
page_size	否	string	150	每页获取条数。默认值40，最小值1，最大值150。
tid	否	string	123456	交易订单id，可以是父订单id号，也可以是子订单id号
result	否	string	good	评价结果,可选值:good(好评),neutral(中评),bad(差评)

响应示例(自定义结构)

{
  "data": {
    "has_next": true,
    "trade_rate": [
      {
        "content": "从小刷涂料，听大人说就是刷立邦漆，那时候我还以为是所有的涂料都是立邦呢，现在才知道立邦是一个品牌，现在我自己的房子装饰果断选择立邦，大品牌值得信赖 ",
        "created": "2022-09-21 15:14:52",
        "item_title": "立邦竹炭瓷净抗甲醛五合一室内家用墙面白色乳胶漆涂料油漆同城",
        "nick": "~La+CBGKlwcx0+c925akPCQ==~TYKwfj+wW46l~1~~",
        "oid": "2901870759322510351",
        "ouid": "AAEOAVLVAADVO0YAAfQJkc41",
        "rated_nick": "~xFbf4Np5fmfMhwww02/A9wOE4U/r8gyk9AvFoq4wFdQ=~W46l5nS1UrrQRL190ZO9C/wL~1~~",
        "result": "good",
        "role": "buyer",
        "tid": "2901870759322510351",
        "valid_score": false
      },
      {
        "content": "家里该装修了，油工师傅推荐用立邦，这个也是老牌子，之前用过，效果不错。家里有小孩子，还是用个环保系数高的。期待效果，到时候追评。",
        "created": "2022-09-21 15:14:01",
        "item_title": "立邦竹炭防霉抗菌无添加室内家用墙面白色漆乳胶漆涂料油漆同城",
        "nick": "~ynMOdeEdklWHYZ+FltpJCg==~t6uJtE6grNLu5C0+pM8/51aV+cD8~1~~",
        "oid": "2901837855523262740",
        "ouid": "AAEdAVLVAADVO0YAAfTeXv9x",
        "rated_nick": "~xFbf4Np5fmfMhwww02/A9wOE4U/r8gyk9AvFoq4wFdQ=~W46l5nS1UrrQRL190ZO9C/wL~1~~",
        "result": "good",
        "role": "buyer",
        "tid": "2901837855523262740",
        "valid_score": true
      },
      {
        "content": "好评！",
        "created": "2022-09-21 12:10:45",
        "item_title": "【99价】立邦防水防霉美缝贴厨房水池水槽卫生间马桶密封条缝隙填补胶条",
        "nick": "~IE0dxmfglE34ipexQO+YWg==~BblpYLbq~1~~",
        "oid": "2871099828375424261",
        "ouid": "AAFNAVLVAADVO0YAAfRAEBj0",
        "rated_nick": "~xFbf4Np5fmfMhwww02/A9wOE4U/r8gyk9AvFoq4wFdQ=~W46l5nS1UrrQRL190ZO9C/wL~1~~",
        "result": "good",
        "role": "buyer",
        "tid": "2871099828375424261",
        "valid_score": true
      }
    ]
  },
  "msg_id": "632C0A8AC0A8009A4734C7C43EE04504",
  "res": "",
  "rsp": "succ"
}

异常返回

错误码	错误描述

API工具

API测试工具

shopex.taobao.open.decrypt(淘宝解密接口)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	1976120933_1033393833	节点信息
request_type	否	string	sync	API请求方式同步：sync；异步：async，默认：sync
data	是	string	{"2741061531293572620":{"ship_name":"安>>1T6IwoAJRy4u5LpWRC5TZqog0AyLK2k9OZ2pYID7NJicwS1814FYU8PdXJwfd7ibIJes30Nb","ship_mobile":"***6112>>1T6IwoAJRy4u5LpWRC5TZqog0AyLK2k9OZ2pYID7NJicwS1814FYU8PdXJwfd7ibIJes30Nb","ship_addr":"虹街道路号上海普天信息园栋路号楼**层>>1T6IwoAJRy4u5LpWRC5TZqog0AyLK2k9OZ2pYID7NJicwS1814FYU8PdXJwfd7ibIJes30Nb"}}	密文数据
fields	否	string	{"ship_name":"ship_name","ship_mobile":"ship_mobile","ship_addr":"ship_addr"}	解密字段
oaid	是	string	oaid	oaid
tids	是	string	2741061531293572620	交易订单号
version	是	string	2.0	版本号淘宝解密必须传2.0

响应示例(自定义结构)

{
  "data": {
    "yuchenghe_log": "[{'yuchenghe_status': 'true', 'yuchenghe_params': 'appKey=68757809&orderId=2741061531293572620&decryptTime=2022-09-22+15%3A33%3A35&appName=https%3A%2F%2Foms-test.ex-sandbox.com%2Findex.php%2Fapi&url=https%3A%2F%2Fgw.api.taobao.com%2Frouter%2Frest&userId=1033393833&ati=8330120497490&action=1007&logTime=2022-09-22+15%3A33%3A35&time=2022-09-22+15%3A33%3A35&userIp=172.18.3.47&sign=7e704e976728f55ed6f6f022b18bde9c&topAppKey=10011902&topRequestId=16milh9jxjgkb', 'yuchenghe_msg': '{\"result\":\"success\",\"errMsg\":\"\"}'}]",
    "yuchenghe_url": "http://gw.ose.aliyun.com/event/Decrypt",
    "2741061531293572620": {
      "secret_no_expire_time": "",
      "ship_mobile": "17821516112",
      "uname": "",
      "privacy_protection": false,
      "ship_tel": "",
      "error_msg": "",
      "matched": true,
      "buyer_alipay_no": "",
      "name": "安嘉鑫",
      "ship_name": "安嘉鑫",
      "ship_addr": "虹梅路街道宜山路700号 上海普天信息产业园C1栋宜山路700号C1楼12层",
      "email": ""
    }
  },
  "msg_id": "632C0FCFAC12032F1741ECE5C30AE3F1",
  "err_msg": "",
  "rsp": "succ",
  "res": ""
}

异常返回

错误码	错误描述

API工具

API测试工具

store.sms.oaid.message.send(淘宝oaid发短信)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	1976120933_1033393833	节点信息
request_type	否	string	sync	API请求方式同步：sync；异步：async，默认：sync
extend_name	否	string	12345	拓展Name
order_id	是	string	1590159531380428537	订单号
extend_code	否	string	12345	拓展Code
sms_free_sign_name	是	string	聚石塔测试签名	短信签名
template_code	是	string	SMS_12345	短信模板
params	否	string	{"content":"您好! "}	短信占位符，替换短信模板里的占位符
extend	否	string	123	拓展信息
oaid	是	string	3mwdUE03cfGGuH4A4DrWWjcL8lxkl3bH29SM1RHqDNo5RgXYTdCQj1ZMN8wbv7qnLeiX6Dr	oaid
additional_info	否	string	true	是否需要返回附加信息

响应示例(自定义结构)

异常返回

错误码	错误描述

API工具

API测试工具

store.sms.template.create(淘宝短信模板创建)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	1976120933_1033393833	节点信息
request_type	否	string	sync	API请求方式同步：sync；异步：async，默认：sync
template_infos	否	string	[{"file_name":"fileName","file_suffix":"png","file_contents":"/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCASAAhQDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/","file_size":10}]	上传文件
template_type	是	string	1	0--验证码 1--短信通知 2-- 推广短信 3--国际/港澳台消息
template_type_class	是	string	NORMAL	NORMAL -- 普通模板 DIGITAL--数字短信模板
remark	是	string	使用场景说明	使用场景说明
template_name	是	string	模板名称	模板名称
template_content	是	string	您好，你的验证码为${code}	模板内容，占位符用${}标识

响应示例(自定义结构)

异常返回

错误码	错误描述

API工具

API测试工具

store.sms.template.modify(淘宝短信模板修改)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	1976120933_1033393833	节点信息
request_type	否	string	sync	API请求方式同步：sync；异步：async，默认：sync
template_type	是	string	1	不能修改
remark	是	string	场景说明	使用场景说明，可以修改
template_code	是	string	SMS_100001	不能修改
template_name	是	string	测试模板	模板名称，可以修改
template_content	是	string	您好，你的验证码为${code}	模板内容，占位符用${}标识，可以修改

响应示例(自定义结构)

异常返回

错误码	错误描述

API工具

API测试工具

store.sms.template.query(淘宝短信模板查询)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	1976120933_1033393833	节点信息
request_type	否	string	sync	API请求方式同步：sync；异步：async，默认：sync
template_code	是	string	SMS_100001	要查询的模板CODE

响应示例(自定义结构)

异常返回

错误码	错误描述

API工具

API测试工具

store.logistics.dummy.send(淘宝无需物流发货接口)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	1976120933_1033393833	节点信息
request_type	否	string	sync	API请求方式同步：sync；异步：async，默认：sync
tid	是	string	tid	淘宝交易ID

响应示例(自定义结构)

{
  "data": {
    "is_success": true
  },
  "err_msg": "",
  "msg_id": "636B0166C0A802864F70650D1BFF59FB",
  "res": "",
  "rsp": "succ"
}

异常返回

错误码	错误描述

API工具

API测试工具

store.logistics.consign.resend(修改物流公司和运单号)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	1976120933_1033393833	节点信息
request_type	否	string	sync	API请求方式同步：sync；异步：async，默认：sync
tid	是	string	tid	淘宝交易ID
out_sid	是	string	SF1387781288087	运单号
company_code	是	string	SF	物流公司代码
sub_tid	否	string	123,456	拆单子订单列表

响应示例(自定义结构)

{
  "data": {
    "result": {
      "success": true
    },
    "request_id": "16krht583e046"
  },
  "msg_id": "656FCC37C0A80287CEAF806C88A7B97B",
  "res": "",
  "rsp": "succ"
}

异常返回

错误码	错误描述

API工具

API测试工具

store.invoice.status.update(开通发票回传接口)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	1976120933_1033393833	节点信息
request_type	否	string	sync	API请求方式同步：sync；异步：async，默认：sync
invoice_memo	否	string	备注	备注信息
invoice_no	是	string	24332000025568029	发票号（小红书必传发票号码，20位数字）
created	是	string	2024-07-31	开票时间
invoice_title	是	string	个人	开票抬头
business_type	否	string	抬头类型：0-个人，1-企业	注: 拼多多必传
invoice_type	否	string	发票类型 1-蓝票 2-红票	注: 拼多多只支持蓝票（京东、拼多多必传）
invoice_kind	否	string	3	(注: 小红书必传) 0:发票类型未知;1:增值税专用发票；2:增值税纸质普通发票；3:增值税电子普通发票；4:形式发票
payee_name	否	string	XX电动工具（中国）有限公司	注：京东必传销货方公司名称
payee_register_no	是	string	91330700239132724K	税号
upload_file	否	string	发票内容	pdf格式url路径(抖音/京东必传)
invoice_file_content	否	string	发票内容	base64格式(小红书、拼多多必传)
taxfree_amount	否	string	99.9	开票金额(京东、拼多多必填)
tid	是	string	240720-650956061091209	订单号
sum_price	否	string	1000	注: 拼多多必传不含税金额，整数，单位：分
sum_tax	否	string	1000	注: 拼多多必传总税额，整数，单位：分
tax_rate	否	string	13	注: 拼多多必传税率,整数
payee_operator	是	string	赵唯	开票人
order_type	否	string	10001	订单类型 21-SOPL 22-SOP 23-LBV(京东平台非必传)
payee_address	否	string	杭州市滨江区滨康路999号	销货方公司地址(京东平台非必传)
payee_bankaccount	否	string	3511163015	销货方公司银行账户(京东平台非必传)
payee_bankname	否	string	德意志银行（中国）有限公司上海分行	销货方公司开户行(京东平台非必传)
payee_receiver	否	string	Jackie	收款人(京东平台非必传)
blue_invoice_no	否	string	24332000025568029	(注：京东当invoice_type=2必传) 提供原蓝票发票号码
invoice_code	否	string	032002300000	发票代码(小红书必传财务开票编码)
payee_phone	否	string	1388888888	（企业抬头）电话
invoice_items	否	object		开票商品信息
invoice_itemsarray 0object └ item_noSKU编号789798string └ item_nameSKU名称牙膏string └ num数量1string └ price单价18.8number └ spec规格白色-XLstring └ unit单位件string └ tax_rate税率0.13number └ tax_categroy_code税收分类编码string └ is_tax_discount优惠政策标识 0-不使用 1-使用0string └ tax_discount_content增值税特殊管理当优惠政策标识为1时填写string └ zero_tax零税率标识空-非零税率 0-出口退税 1-免税 2-不征收 3-普通零税率string └ deductions扣除额两位小数string └ imei商品IMEI码string └ discount折扣0number └ freight运费0number

响应示例(自定义结构)

{
  "data": {
    "results": {
      "code": 10000,
      "log_id": "202408091101063C89521FCD397A8BE8A8",
      "msg": "success",
      "sub_code": "",
      "sub_msg": ""
    }
  },
  "msg_id": "66B5947FC0A802868A85B121F30535EE",
  "res": "",
  "rsp": "succ"
}

异常返回

错误码	错误描述

API工具

API测试工具

store.trade.invoice.amount.get(查询订单的应开发票)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	1976120933_1033393833	节点信息
request_type	否	string	sync	API请求方式同步：sync；异步：async，默认：sync
tid	否	string	123456789	订单号

响应示例(自定义结构)

{
  "data": {
    "queryamountforown_result": {
      "message": "退款完成，无需开票",
      "success": false
    },
    "code": "0",
    "result": "success",
    "request_id": "3503686.39587.17244102463569311"
  },
  "msg_id": "66C86986C0A8028681BF4B5095528D9A",
  "res": "",
  "rsp": "succ"
}

异常返回

错误码	错误描述

API工具

API测试工具

shopex.jd.decrypt(京东SDK解密接口)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	1088888888_169999999	节点信息
request_type	否	string	sync	API请求方式同步：sync；异步：async，默认：sync
data	是	string	[{\"uName\":\"密文数据\",\"telNo\":\"密文数据\",\"certNo\":\"密文数据\"}]	请求解密数据json字符串格式(注:字段名可以自定义如：[{"a":"密文数据"}])

响应示例(自定义结构)

{
  "rsp": "succ",
  "err_msg": "",
  "data": [
    {
      "uName": "焦某某",
      "telNo": "18999999999",
      "from_node_id": "169999999",
      "certNo": "610509999999999433"
    }
  ],
  "res": ""
}

异常返回

错误码	错误描述

API工具

API测试工具

store.waybill.stdtemplates.get(获取平台标准电子面单模板)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	1088888888_169999999	节点信息
request_type	否	string	sync	API请求方式同步：sync；异步：async，默认：sync
template_type	否	string	standard	抖音平台传参:standard:标准打印模版,custom_2:获取商家自定义打印模版新接口,
company_code	否	string	ZTO	当template_type:custom_2, 可以指定物流公司

响应示例(自定义结构)

{
  "data": [
    {
      "logistics_code_std": "",
      "logistics_code": "zhongtongguoji",
      "template_infos": [
        {
          "template_code": "ztgj_76_130",
          "template_name": "中通国际一联单",
          "template_type": 1,
          "version": 1,
          "template_url": "https://lf3-cm.ecombdstatic.com/obj/logistics-davinci/template/v2/i18n/ztgj_76_130.xml",
          "perview_url": "https://lf3-cm.ecombdstatic.com/obj/logistics-davinci/preview/v2/ztgj_76_130.png",
          "template_id": 36
        },
        {
          "template_code": "ztgj_100_180",
          "template_name": "中通国际二联单",
          "template_type": 2,
          "version": 1,
          "template_url": "https://lf6-cm.ecombdstatic.com/obj/logistics-davinci/template/i18n/template_100_i18n.xml",
          "perview_url": "https://lf3-cm.ecombdstatic.com/obj/logistics-davinci/preview/jt_100_180.png",
          "template_id": 37
        }
      ]
    }
  ],
  "msg_id": "6833C9BFC0A8028717225EFFA7526581",
  "res": "",
  "rsp": "succ"
}

异常返回

错误码	错误描述

API工具

API测试工具

store.waybill.cancel(回收电子面单号)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	1088888888_169999999	节点信息
company_code	是	string	ZTO	物流公司平台编码
waybill_code	是	string	SF123456789	面单号

响应示例(自定义结构)

{
  "res": "",
  "msg_id": "6833C7EAC0A802879CDCAADAAA69D4CB",
  "err_msg": "",
  "data": "{\"results\": {\"code\": 10000, \"sub_msg\": \"\", \"log_id\": \"20250526094619AA08DCCBA50C5E690B00\", \"sub_code\": \"\", \"msg\": \"success\", \"data\": {\"cancel_result\": {\"success\": true}}}}",
  "sign": "DC4B223217517490AFA032C44A8F84D7",
  "rsp": "succ"
}

异常返回

错误码	错误描述

API工具

API测试工具

store.waybill.search(查询商家和物流商的订购关系以及物流单号使用情况)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	1088888888_169999999	节点信息
company_code	是	string	ZTO	(京东不传)物流公司平台编码:淘宝平台文档：https://open.taobao.com/api.htm?spm=a219a.7386797.0.0.4126669aiOVcwx&source=search&docId=27125&docType=2，抖音平台文档：https://op.jinritemai.com/docs/api-docs/1262/1843

响应示例(自定义结构)

{
  "data": {
    "netsites": [
      {
        "logistics_code_std": "ZTO",
        "netsite_name": "金山石化",
        "company": "zhongtong",
        "allocated_quantity": 641,
        "company_type": 2,
        "sender_address": [
          {
            "city_name": "上海市",
            "district_name": "金山区",
            "street_name": "金**镇",
            "province_name": "上海市",
            "detail_address": "学**********室"
          }
        ],
        "cancelled_quantity": 26,
        "amount": "127",
        "netsite_code": "021027",
        "recycled_quantity": 68
      },
      {
        "logistics_code_std": "ZTO",
        "netsite_name": "松**北",
        "recycled_quantity": 0,
        "allocated_quantity": 0,
        "company_type": 2,
        "sender_address": [
          {
            "city_name": "上海市",
            "district_name": "松江区",
            "street_name": "中**道",
            "province_name": "上海市",
            "detail_address": "梅**********1"
          }
        ],
        "cancelled_quantity": 0,
        "amount": "5",
        "netsite_code": "21***3",
        "company": "zhongtong"
      }
    ],
    "company_type": 2,
    "logistics_code": "zhongtong"
  },
  "msg_id": "682EBB2EC0A80286AB43AAE8B81B9265",
  "res": "",
  "rsp": "succ"
}

异常返回

错误码	错误描述

API工具

API测试工具

store.waybill.i.get(电子面单取号)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	1088888888_169999999	节点信息
sender	是	string	https://www.yuque.com/jiting/aetglx/vgui97knx7r7ze4x?singleDoc# 《云收订》	https://www.yuque.com/jiting/aetglx/vgui97knx7r7ze4x?singleDoc# 《云收订》
company_code	是	string	JITU	物流公司平台编码
product_code	否	string	STANDARD_EXPRESS	淘宝平台：目前仅部分快递公司支持此参数，传入快递产品编码
trade_order_info_dtos	是	string	https://www.yuque.com/jiting/aetglx/vgui97knx7r7ze4x?singleDoc# 《云收订》	https://www.yuque.com/jiting/aetglx/vgui97knx7r7ze4x?singleDoc# 《云收订》
store_code	否	string	553323	淘宝: 仓code，仓库WMS系统对接落地配业务，其它场景请不要使用
resource_code	否	string	DISTRIBUTOR_978324	淘宝: 配送资源code，仓库WMS系统对接落地配业务，其它场景请不要使用
dms_sorting	否	string	false	淘宝: 是否使用智分宝预分拣，仓库WMS系统对接落地配业务，其它场景请不要使用
need_encrypt	否	string	true	淘宝: 设定取号返回的云打印报文是否加密
customer_code	否	string	adb123345	淘宝: 月结卡号
brand_code	否	string	FOP	淘宝：品牌编码
extra_info	否	string		淘宝：扩展参数
three_pl_timing	否	string	false	淘宝：订单上是否带3PLtiming属性, 该属性需要严格与订单上属性保持一致，如果不确定，请使用默认false。
call_door_pick_up	否	string	false	淘宝：是否预约上门
door_pick_up_time	否	string	2021-08-07 12:34:30	淘宝：预约上门收件时间
door_pick_up_end_time	否	string	2021-08-07 12:34:30	淘宝：预约上门截止时间
order_channel	否	string	1	抖音：订单渠道来源编码，具体请参考[下单渠道来源编码表](https://bytedance.feishu.cn/sheets/shtcngIVwcJlgXLzWhEtKrmv7Af)，当order_id订单号为非抖音订单时必传
sender_fetch_time	否	string	sender_fetch_time	抖音：要求上门取件时间段
user_id	否	string	12346	抖音：共享账号场景下需传，代表实际使用取号服务的shop_id（需与order_id匹配）
delivery_req	否	string		抖音：派送要求（目前仅德邦支持）

响应示例(自定义结构)

{
  "data": {
    "waybill_cloud_print_response": [
      {
        "logistics_code_std": "SF",
        "real_cp_code": "SF",
        "print_data": "{\"encryptedData\":\"AES:rU904rj6UH2oqfSUb43+Z199vDU2GZtH5/LVIEq0ppUJuwjq7qZ58JRvDHOQ/f2QhqdsWiYYFqp6z96+fPLup3dYRdJO/t5y0OhJjn0EuIyCk6/uwhVfLnU95dKisKaWQs+6A5zITpK6HGcocFDkTWzl/vdaVAL/Kai5VoSN3UIesWa1G3xDhoGioimcN\",\"templateURL\":\"http://cloudprint.cainiao.com/template/standard/501311\",\"ver\":\"waybill_print_secret_version_1\"}",
        "object_id": "T20250522051330",
        "cp_code": "SF",
        "waybill_code": "SF3*****1342",
        "extra_info": "{\"proCode\":\"标快\",\"remark\":\"\",\"limitTypeCode\":\"T6\"}"
      }
    ]
  },
  "msg_id": "682EE259C0A802870A15BF431BD58B08",
  "res": "",
  "rsp": "succ"
}

异常返回

错误码	错误描述

API工具

API测试工具

store.waybill.printdata(获取面单信息(抖音))

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	1088888888_169999999	节点信息
company_code	是	string	ZTO	物流公司编码
waybill_code	是	string	78978979799	运单号

响应示例(自定义结构)

{
  "data": "{\"extend_field\":\"access_token=q2gck586fs1fz65rpyppkp40000il1xm-11&app_key=6841298078998398472&method=logistics.getShopKey&param_json={}&timestamp=2025-05-23 09:08:26&v=2&sign=dedfb29c86deba1c8e0e229ad8bbadb2\",\"waybill_infos\":[{\"order_id\":\"6919548835467328706|2505232000484\",\"print_data\":\"IfEiPZ86a6Nof89kIu1Ilv/WEnKcOsMxGc3\",\"track_no\":\"SF3181736943636\",\"sign\":\"METBBUEk55b9PvNGqBjwj9jLp2NDWjSLfxlI\"}],\"err_infos\":[]}",
  "msg_id": "682FCA8AC0A8028603581A770378FE47",
  "res": "",
  "rsp": "succ"
}

异常返回

错误码	错误描述

API工具

API测试工具

store.waybill.update(更新收件人信息)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	1088888888_169999999	节点信息
sender	否	string	{"contact":{"name":"唐","phone":"18****6"},"address":{"country_code":"CHN","province_name":"上海市","city_name":"上海市","detail_address":"书*3楼","district_name":"松江区","street_name":"镇"}}
package_info	否	string	{"item_name":"xxx"}	包裹信息：抖音参考文档(items)：https://op.jinritemai.com/docs/api-docs/1262/494，淘宝参考文档(package_info字段)：https://open.taobao.com/api.htm?docId=26870&docType=2&source=search
recipient	否	string	{ "name":"jee","mobile":"13131313131","address":{"city":"上海"} }	收件人信息：抖音参考上述文档里receiver_info字段，淘宝参考上述文档里：recipient字段
company_code	是	string	ZTO	物流公司编码
waybill_code	是	string	78978979799	运单号
remark	否	string	备注	抖音：备注信息
extra	否	string	备用扩展字段	抖音：备用扩展字段
shop_id	否	string	123546	抖音：实际使用取号服务店铺user_id
weight	否	string	10	抖音：整数用于与快递商有计抛信任协议的商家）单位克
template_url	否	string	http://cloudprint.cainiao.com/cloudprint/template/getStandardTemplate.json?template_id=1001	淘宝：模板url
logistics_services	否	string	{ "SVC-COD": { "value": "200" } }	淘宝：物流服务内容https://open.taobao.com/doc2/detail.htm?spm=a219a.15212433.0.0.7c1e669arBw5rY&treeId=17&articleId=26765&docType=2
object_id	否	string	12354678DF	淘宝：请求表示id

响应示例(自定义结构)

{
  "data": {
    "results": {
      "code": 10000,
      "sub_msg": "",
      "log_id": "20250526132202781856DA4194D7EB2423",
      "sub_code": "",
      "msg": "success",
      "data": {
        "package_center_name": "",
        "short_address_name": "",
        "short_address_code": "",
        "extra_resp": "{\"orderId\":\"\",\"originCode\":\"\",\"destCode\":\"\",\"filterResult\":0,\"remark\":\"\",\"waybillNoInfoList\":[{\"waybillType\":1,\"trackNo\":\"SF3171962420744\"}],\"routeLabelInfo\":{\"code\":\"\",\"routeLabelData\":{\"trackNo\":\"\",\"sourceTransferCode\":\"\",\"sourceCityCode\":\"\",\"sourceDeptCode\":\"\",\"sourceTeamCode\":\"\",\"destCityCode\":\"\",\"destDeptCode\":\"\",\"destDeptCodeMapping\":\"\",\"destTeamCode\":\"\",\"destTeamCodeMapping\":\"\",\"destTransferCode\":\"\",\"destRouteLabel\":\"\",\"proName\":\"\",\"cargoTypeCode\":\"\",\"limitTypeCode\":\"\",\"expressTypeCode\":\"\",\"codingMapping\":\"\",\"codingMappingOut\":\"\",\"xbFlag\":\"\",\"printFlag\":\"\",\"twoDimensionCode\":\"\",\"proCode\":\"\",\"printIcon\":\"\",\"abFlag\":\"\",\"errMsg\":\"\"},\"message\":\"\"}}",
        "package_center_code": "",
        "track_no": "SF3171962420744",
        "sort_code": ""
      }
    }
  },
  "msg_id": "6833FA7AC0A80287627F9DDF34A7C56D",
  "res": "",
  "rsp": "succ"
}

异常返回

错误码	错误描述

API工具

API测试工具

store.qianbao.bill.detail.query(查询日账单明细)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	1088888888_169999999	节点信息
start_time	是	string	2025-06-01 00:00:00	开始时间(京东必传)
end_time	是	string	2025-06-10 00:00:00	结束时间(京东必传)
page_no	是	string	1	京东需要
page_size	是	string	10
alipay_order_no	否	string	123456
merchant_order_no	否	string	123456
member_id	是	string	123456	二级商户号
type	是	string	2	京东：【1:按账单日查询，2:按到账日查询】抖音：时间类型 0 动账时间 1 下单时间
current_page	否	string	d746da31eee4	抖音：开始下标请求值为上一次响应参数的next_index，第一次请求不传
account_type	否	string	0	抖音：动账账户 0: 所有 1: 微信 2:支付宝 3:合众支付 4:聚合支付
tid	否	string		抖音：订单号
product_id	否	string		抖音：产品id

响应示例(自定义结构)

{
  "data": {
    "success": true,
    "data": [
      {
        "orderId": "18373*******28179",
        "venderId": "8****7",
        "shopName": "",
        "remark": "2025年6月28日其他费项",
        "bal": -0.06,
        "skuName": "",
        "outTradeNo": "20250**************88796",
        "currency": "CNY",
        "shopId": "",
        "skuId": "0",
        "memberId": "11********04",
        "happenTime": 1751119972000,
        "direction": -1,
        "detailStatus": 11,
        "finishTime": 1751170746000,
        "billingTime": 1751119972000,
        "billDate": "20250628",
        "updateTime": 1751170746000,
        "rfBusiId": "92******01",
        "jdShopId": "",
        "detailNo": "2610***********7547830",
        "feeName": "短信服务费",
        "rfBusiType": 1102,
        "deliveredTime": 1751119973000
      }
    ],
    "result": "success",
    "resultCode": "1000",
    "totalElements": 197,
    "message": "成功"
  },
  "msg_id": "68624DD0C0A80287161813DCF2A94896",
  "res": "",
  "rsp": "succ",
  "官方文档地址（使用请去除此字段）": "https://jos.jd.com/apilist?apiGroupId=195&apiId=14652&apiName=jingdong.pop.ledger.bill.queryDailyBillDetail"
}

异常返回

错误码	错误描述

API工具

API测试工具

store.alipay.bill.get(支付宝账单接口详情)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	1088888888_169999999	节点信息
bill_type	是	string	signcustomer	账单类型
bill_date	是	string	2024-10-25	账单日期

响应示例(自定义结构)

{
  "data": {
    "msg": "{\"code\":\"10000\",\"msg\":\"Success\",\"bill_download_url\":\"http:\\/\\/dwbillcenter.alipay.com\\/downloadBillFile.resource?bizType=fnd&partnerId=20882125056871920156&fileType=csv.zip&bizDates=20241025&downloadFileName=20882125056871920156_20241025.csv.zip&fileId=%2Ffnd%2F20882125056871920156%2F20241025.csv.zip&timestamp=1750736894&token=9b26329f4d6dd06d283874697f81ba7b\"}",
    "result": "success"
  },
  "msg_id": "685A1FFDC0A80287E396F2E68B3A989B",
  "res": "",
  "rsp": "succ"
}

异常返回

错误码	错误描述

API工具

API测试工具

store.bill.detail.get(订单结算明细查询)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	1088888888_169999999	节点信息
start_time	否	string	2025-06-29 00:00:00	业务起始时间(京东必传)
end_time	否	string	2025-06-29 23:59:59	业务结束时间(京东必传)
order_id	否	string	318276210974	订单号(京东必传)
settlement_status	否	string	1	结算状态(1已结算、2待结算、3不结算)
bill_number	否	string	10025890573250708	流水id(小店必传)

响应示例(自定义结构)

{
  "data": {
    "data": [
      {
        "orderId": 31899999990974,
        "docCreateTime": 1751273248000,
        "completed": 1751273248000,
        "feeList": [
          {
            "skuId": 0,
            "direction": -1,
            "money": 0.28,
            "currency": "CNY",
            "detailId": "318276210974********02db0f91e0aca1",
            "settlementStatus": 2,
            "businessUuid": "31827621097*********3e073bc02db0f91e0aca1",
            "feeType": 50132
          }
        ],
        "venderId": 7824000012,
        "createTime": 1751273237000,
        "docUpdateTime": 1751273248000
      }
    ],
    "result": "success"
  },
  "msg_id": "686251A8C0A802861F8D4EBA9A0A4C7E",
  "res": "",
  "rsp": "succ",
  "京东官方文档地址（使用请去除此字段）": "https://open.jd.com/v2/#/doc/api?apiCateId=195&apiId=4454&apiName=jingdong.pop.taurus.queryBillChargeListByCondition&gwType=0"
}

异常返回

错误码	错误描述

API工具

API测试工具

store.download.shop.account.item(资金流水明细下载)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	1088888888_169999999	节点信息
start_time	否	string	2025-06-29 00:00:00	开始时间
end_time	否	string	2025-06-29 23:59:59	结束时间
order_id	否	string	4847151209529677080	订单号(如果订单号未传，则时间必须传)
account_type	否	string	0	动账账户 0: 所有 1: 微信 2:支付宝 3:合众支付 4:聚合支付
biz_type	否	string	0	计费类型 0:全部 1:鲁班广告 2:精选联盟 3:值点商城 4:小店自卖 5:橙子建站 6:POI 7:抖+ 8:穿山甲 9:服务市场 10:服务市场外包客服 11:学浪0
time_type	否	string	0	时间类型 0 动账时间 1 下单时间默认：0
product_id	否	string	4564665	产品id

响应示例(自定义结构)

{
  "data": {
    "results": {
      "code": 10000,
      "sub_msg": "",
      "log_id": "20250702********58BB93E19F8",
      "sub_code": "",
      "msg": "success",
      "data": {
        "code_msg": "success",
        "code": "100000",
        "download_id": "DL202507******380854311937"
      }
    }
  },
  "msg_id": "6864BE5EC0A80286437F73A3B71B448F",
  "res": "",
  "rsp": "succ"
}

异常返回

错误码	错误描述

API工具

API测试工具

store.download.shop.account.item.file(资金流水明细下载请求(境内))

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	1088888888_169999999	节点信息
download_id	是	string	DL202111041446472412450342	下载id，有效期24小时；

响应示例(自定义结构)

{
  "data": {
    "results": {
      "code": 10000,
      "sub_msg": "",
      "log_id": "20250702131333B275E01F1C8E1B3F4C6E",
      "sub_code": "",
      "msg": "success",
      "data": {
        "url": "https://lf3-tos-bill-center-sign.bytetos.com/ecom-paysettleinfo/data/download/item/DL20xxxxxx0854311937.csv?lk3s=d3359187&x-expires=1751433513&x-signature=xWKHQpg%2FeRTpzCFE0B4v%2Bz1l%2FKU%3D"
      }
    }
  },
  "msg_id": "6864BFFDC0A80287FEFF8743DABCB67C",
  "res": "",
  "rsp": "succ"
}

异常返回

错误码	错误描述

API工具

API测试工具

store.bill.list.get(获取资金流水列表)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://apigateway.shopex.cn/router	https://apigateway.shopex.cn/router
沙箱环境	xx	xx

公共请求参数：

名称	类型	是否必须	描述
method	String	是	方法名
app_key	String	是	app_key
sign_time	String	是	签名时间
sign	String	是	签名

请求参数

名称	是否必须	类型	示例值	字段描述
node_id	是	string	1088888888_169999999	节点信息
start_time	否	string	2025-07-01 00:00:00	开始时间
end_time	否	string	2025-07-10 23:59:59	结束时间
page_no	否	string	1	页码
page_size	否	string	20	页数
next_key	否	string	13456	分页参数，翻页时写入上一页返回的next_key(page为上一页加一，并且page_size与上一页相同的时候才生效)，page * page_size >= 10000时必填
transaction_id	否	string	12346	支付单号

响应示例(自定义结构)

{
  "data": {
    "has_more": true,
    "next_key": "CAEQFBgAIhExMDAyNzI3NDQ0NTI1MDcwNCjx4Z3DBg==",
    "errcode": 0,
    "errmsg": "资金流水数据截止至2025-07-08。请注意查询条件",
    "flow_ids": [
      "10025890583250708",
      "10025890582250708",
      "10025890581250708",
      "10025890580250708",
      "10025890579250708",
      "10025890578250708",
      "10025890577250708",
      "10025890576250708",
      "10025890575250708",
      "10025890574250708",
      "10025890573250708",
      "10025890572250708",
      "10025890571250708",
      "10025890570250708",
      "10025890569250708",
      "10025890568250708",
      "10025890567250708",
      "10025547339250707",
      "10027274446250704",
      "10027274445250704"
    ]
  },
  "msg_id": "686F195FAC100014FFFF555C465927CE",
  "res": "",
  "rsp": "succ"
}

异常返回

错误码	错误描述

API工具

API测试工具

云收订服务

store.logistics.offline.send(订单发货接口（同步异步接口）数据获取队列（rpccallback）)

公共参数

请求参数

响应参数

响应示例

异常返回

API工具

store.items.quantity.list.update(批量库存更新接口（条数小于20）（接口只支持异步方式）数据获取队列（rpccallback）)

公共参数

请求参数

响应参数

响应示例

异常返回

API工具

store.logistics.pub(订阅快递单物流流转信息（同步异步接口）数据获取队列（hqepaylogistics）)

公共参数

请求参数

响应参数

响应示例

异常返回

API工具

logistics.trace.detail.get(获取快递单物流流转信息（同步异步接口）数据获取队列（hqepaylogistics）)

公共参数

请求参数

响应参数

响应示例

异常返回

API工具

store.tmc.group.add(订阅发票信息（专供淘宝）)

公共参数

请求参数

响应参数

响应示例

异常返回

API工具

store.tmc.group.delete(取消订阅)

公共参数

请求参数

响应参数

响应示例

异常返回

API工具

store.einvoice.apply.get(开票申请数据获取接口)

公共参数

请求参数

响应参数

响应示例

异常返回

API工具

store.confirm.delivery(确认某一条出仓单(唯品会JIT))

公共参数

请求参数

响应示例(自定义结构)

异常返回

API工具

store.create.delivery(用于用户创建出仓单(唯品会JIT))

公共参数

请求参数

响应参数

响应示例

异常返回

API工具

store.create.pick(创建拣货单信息(唯品会JIT))

公共参数

请求参数

响应参数

响应示例

异常返回

API工具

store.delete.deliverydetail(接口用于用户删除指定单号的出仓明细(唯品会JIT))

公共参数

请求参数

响应参数

响应示例

异常返回

API工具

store.get.pickdetail(获取指定拣货单明细信息(唯品会JIT))

公共参数

请求参数