一、概述
二、使用须知
注意:
- 需要在阿里开放平台(https://open.taobao.com/),注册appKey;
- 联系飞猪运营小二对appKey进行API授权;对店铺进行授权
- 需要使用appKey和appSecret访问;
- 接口仅支持https协议,以post请求访问;
- SDK调用试例地址: https://open.taobao.com/docV3.htm?spm=a219a.7386653.0.0.7aa5669aaJixbr&docId=101618&docType=1。
- 预发环境地址:ws://premc.api.taobao.com/;正式环境地址:ws://mc.api.taobao.com/
三、业务实体
通用返回码
返回码 |
类型 |
业务 |
信息描述 |
中文描述 |
0 |
成功 |
|
success. |
成功 |
400 |
异常 |
系统 |
request error. |
请求错误 |
401 |
request auth error. |
请求认证错误 |
||
403 |
request forbidden. |
请求被禁止 |
||
404 |
service not found. |
服务未找到 |
||
429 |
too many requests. |
太多请求 |
||
460 |
request parameter error. |
请求参数错误 |
||
500 |
service error. |
服务端错误 |
||
503 |
service not available. |
服务不可用 |
四、API接口定义
1、订单接口
1.1 下单前预校验接口(TOP)
API名称: alitrip.travel.distribute.order.check
证件类型: 0:身份证 1:护照 3:军官证 4:回乡证 5:台胞证 6:港澳通行证 7:国际海员 8:外国人永久居留(身份)证 9:其他证件 10:警官证 11:士兵证 12:台湾通行证 13:入台证 14:户口本 15:出生证明 16:驾驶证 17:港澳居民居住证 18台湾居民居住证
目前只支持:0:身份证 4:回乡证 17:港澳居民居住证 18:台湾居民居住证
1.2 订单创建接口(TOP)
API名称: alitrip.travel.distribute.order.create
证件类型: 0:身份证 1:护照 3:军官证 4:回乡证 5:台胞证 6:港澳通行证 7:国际海员 8:外国人永久居留(身份)证 9:其他证件 10:警官证 11:士兵证 12:台湾通行证 13:入台证 14:户口本 15:出生证明 16:驾驶证 17:港澳居民居住证 18台湾居民居住证
1.3 订单详情查询接口(TOP)
API名称: alitrip.travel.distribute.order.detail
1.4 发起退款接口(TOP)
API名称: alitrip.travel.distribute.order.refund
1.5 订单状态变更消息通知
top: fliggy_ticket_OrderStatusChange
msgType |
含义 |
备注 |
PURCHASE_ORDER_SHIPPED |
采购单发货 |
|
PURCHASE_ORDER_NOT_INVOICED |
采购单出票失败 |
|
PURCHASE_ORDER_TRADE_SUCC |
采购单确认收货 |
|
消息体:
字段 |
类型 |
说明 |
备注 |
orderId |
Long |
子采购订单ID |
|
outOrderId |
String |
外部订单ID |
|
gmtModified |
Date |
修改时间 |
|
gmtCreate |
Date |
创建时间 |
|
closeOrderReason |
String |
采购单关闭原因 |
|
productId |
Long |
产品ID |
|
productName |
String |
产品名称 |
|
productPrice |
Long |
产品价格 |
|
skuId |
Long |
skuId |
|
buyAmount |
Long |
购买数量 |
|
消息示例
{
"content":"
{
"gmt_create":"2021-01-16 14:57:41",
"close_order_reason":"str",
"out_order_id":"************",
"product_id":12345678,
"msg_type":"PURCHASE_ORDER_PAY_SUCC",
"sku_id":123456789,
"product_price":999,
"gmt_modified":"2021-01-16 14:57:41",
"order_id":12345678,
"product_name":"测试商品",
"buy_amount":1
}"
}
1.6 核销通知
top: fliggy_ticket_VerifyNotify
msgType |
含义 |
备注 |
RESOURCE_VERIFIED |
凭证(或码)核销情况 |
|
消息体:
字段 |
类型 |
说明 |
备注 |
orderId |
Long |
子采购订单ID |
Y |
voucherInfos |
List |
码核销信息(包含之前已核销数据) |
Y标准接口为voucherInfos 需核销的凭证信息 |
码核销信息(包含之前已核销数据)
字段 |
类型 |
说明 |
与标准接口字段对应情况 |
confirmCode |
String |
码值 |
Y 标准接口为confirmCode 核销的确认码 |
ticketAvailableTimes |
Integer |
对应码值能核销的次数 |
Y 标准接口为usedQuantity 使用数量=购买张数(一码多刷,刷一次就结账) |
ticketUsageNums |
Integer |
已核销次数 |
N |
{
"content":"
{
"order_id":12345678,
"msg_type":"RESOURCE_VERIFIED",
"voucherinfos":"[
{
"ticketAvailableTimes":"1",
"ticketUsageNums":"1",
"confirmCode":"asfwenjk12"
}]"
}"
}
1.7 退款消息通知
top: fliggy_ticket_OrderRefund
msgType |
含义 |
备注 |
REFUND_RESULT |
退款结果 |
|
消息体:
字段 |
类型 |
说明 |
备注 |
orderId |
|
子采购订单ID |
|
refundStatus |
Integer |
退款状态 |
1是退款中,2是退款成功 3是退款失败 |
refundFailReason |
String |
退款失败原因 |
Y |
refundOrderId |
|
退款单ID |
|
{
"content":"
{
"order_id":12345678,
"msg_type":"REFUND_CREATE",
"refund_status":1,
"refund_fail_reason":"已核销,无法退款",
"refund_order_id":12345678
}"
}