返享Api文档.doc

返享对外接口规范
编制:
审核:
批准:
日期:2015/09/24
版本号:

文档编号:
目录
1. 接口规范说明 4
. 签名接口 4
token获取 4
. 订单接口 5
5
8
(暂未开放) 12
17
(暂未开放) 18
(暂未开放) 18
2. 附录 20
. 操作结果编码 20
接口规范说明
签名接口
描述:根据供货商后台生成的APPkey和secrect生成签名密钥,密钥存活时间为1小时,接口文档中除此之外的接口皆需要传递生成的token
token获取
接口url:http://data./open_auth/get-token
示例: curl -X POST -F "app_key=5608ad571c07f309" -F "secret=154ddebc3848cb3a50cde4a3e2d1582" 'http://data./open_auth/get-token'
请求参数:
重要性
类型
说明
app_key
必须
String
app_key
secret
必须
string
secret
响应结果:
标记
重要性
类型
说明
code
必须
String
返回码,
msg
必须
String
提示信息
info
必须
Json数组
{
"token": "b371c30aeb1830aafdcd169fc37ca8ec"
}
订单接口

接口url:http://data./open_order/order-list
示例: curl -X POST -F "token= b371c30aeb1830aafdcd169fc37ca8ec" 'http://data./open_order/order-list'
请求参数:
重要性
类型
说明
token
必须
String
签名
fields
可选
String
需要返回的交易对象字段,如id,user_id,user_name,order_no,supplier_id,agent_id,goods_snapshot_id,pay_status,post_status,order_status,pay_type,create_time,pay_time,send_time,consignee_address,post_amount,order_amount,over_time,finish_time,pay_amount,post_id,consignee_phone,consignee_name,shop_id,can_return,second_agent_shop_id,third_agent_shop_id,order_goods_status,message,ticket_id,ticket_type,original_amount,discount_type,province,city,area等。多个字段用“,”分隔。如果为空则返回所有
start_created
可选
String
交易创建开始时间。查询在该时间之后(包含该时间)创建的交易,为空则不限制
。例如:2014-01-01 00:00:00
end_created
可选
String
交易创建结束时间。查询在该时间之前创建的交易,为空则不限制。例如:
2014-01-05 00:00:00
order_status
可选
String
交易状态,默认查询所有交易状态的数据,除了默认值外每次只能查询一种状态。
可选值:
WAIT_BUYER_PAY(未支付订单)
WAIT_SELLER_SEND_GOODS(已支付未发货订单)
TRADE_CANCEL(已取消订单)
WAIT_BUYER_CONFIRM_GOODS(已发货订单)
TRADE_BUYER_SIGNED(已收货订单)
TRADE_RETURN(已退货订单,包括已关闭订单)
page_no
可选
int
页码。取值范围:大于零的整数;默认值:1
page_size
可选
int
每页条数。取值范围:大于零的整数;默认值:10;最大值:100
响应结果:
标记
重要性
类型
说明
code
必须
String
返回码,
msg
必须
String
提示信息