供应商对接分销平台接口文档
1 产品接口
1.1 POI查询接口(供应商提供)
方法名:BatchQueryPOI
调用方:分销平台
响应方:供应商
接口说明:本接口可用于分销平台从供应商抓取POI数据。
0 < POI数量 <= 100
1.1.1 业务请求参数
| 参数名 |
类型 |
是否必传 |
描述 |
| PoiParams |
List |
是 |
POI基础信息数组 |
PoiParams中的单个对象数据结构
| 参数名 |
类型 |
是否必传 |
描述 |
| belongPartnerIds |
String |
否 |
内部供应商id,以“,”分隔。注意不能包含“,”。备注:新上供应商或数值发生变化,须联系开放平台运营人员 |
| poiId |
String |
是 |
对接方POI id |
| pointName |
String |
是 |
POI名称 |
| phone |
String |
是 |
联系电话 |
| address |
String |
是 |
地址 |
| longitude |
String |
是 |
经度 |
| latitude |
String |
是 |
纬度 |
| cityId |
Integer |
是 |
城市id,必须>0。参考cityId列表 |
| regionType |
Integer |
否 |
默认值:1区域 1:内地 2:海外 不填默认为内地,设置为海外的poi 入住时填写英文入住人姓名 |
| openDate |
String |
是 |
营业时间 |
| starLevel |
Integer |
是 |
POI等级 10 无等级 20 AA 30 AAA 40 AAAA 50 AAAAA |
| poiType |
Integer |
否 |
POI类型 10:景区 20:游乐园 30:场馆 40:剧院 |
| poiDesc |
String |
是 |
POI简介 |
| poiIntroduction |
String |
是 |
POI详情 |
| image1 |
String |
是 |
POI图片1,外网可访问的链接地址 |
| image2 |
String |
是 |
POI图片2,外网可访问的链接地址 |
| image3 |
String |
是 |
POI图片3,外网可访问的链接地址 |
1.1.2 业务响应参数
| 参数名 |
类型 |
描述 |
是否必传 |
| code |
Integer |
是 |
错误码 |
| message |
String |
是 |
响应描述信息 |
| data |
String |
否 |
响应数据 |
1.2 产品查询接口(供应商提供)
方法名:BatchQueryProduct
调用方:分销平台
响应方:供应商
接口说明:分销平台调用此接口从供应商抓取产品信息。
1.2.1 业务请求参数
| 参数名 |
类型 |
描述 |
是否必传 |
| pageIndex |
int |
查询页索引 |
是 |
| pageSize |
int |
查询数量 |
是 |
| productNo |
string |
供应商产品编号 |
否 |
| sceneryNo |
string |
供应商poi编号 |
否 |
1.2.2 业务响应参数
| 参数名 |
类型 |
描述 |
是否必传 |
| code |
Integer |
是 |
错误码 |
| message |
String |
是 |
响应描述信息 |
| data |
String |
否 |
响应数据,业务成功必须返回,是下面结构base64后的字符串 |
| 参数名 |
类型 |
描述 |
是否必传 |
| totalCount |
long |
产品总数量 |
是 |
| productList |
object |
产品列表 |
是 |
productLis中的单个对象数据结构
| 参数名 |
类型 |
描述 |
是否必传 |
| productNo |
string |
供应商产品编号(场次类产品为演出编号) |
是 |
| productName |
string |
供应商产品名称 |
是 |
| retailPrice |
long |
门市价(单位:分) |
是 |
| webPrice |
long |
网络价(单位:分) |
是 |
| contractPrice |
long |
协议价(单位:分) |
是 |
| sceneryNo |
string |
供应商景区编号 |
是 |
| sceneryName |
string |
供应商景区名称 |
是 |
| payType |
int |
支付方式(0 未区分,1 景区到付,2 在线支付) |
是 |
| beginValidDate |
string |
有效期开始时间(格式:yyyy-MM-dd) |
是 |
| endValidDate |
string |
有效期结束时间(格式:yyyy-MM-dd) |
是 |
| shieldDate |
string |
屏蔽日期(yyyy-MM-dd,yyyy-MM-dd) |
否 |
| isRealName |
int |
是否支持实名制(0 不支持 1 支持) |
否 |
| checkWay |
int |
验证方式 0 身份证 1 手机号 2 手机发送识别码 |
否 |
| getTicketWay |
string |
取票方式 |
否 1 商家二维码 2 身份证 3 现场换票 4 商家二维码+身份证 |
| isCanRefund |
int |
是否支持退款 0 不支持 1 支持 |
否 |
| isCanOverdueRefund |
int |
是否支持过期退款 0 不支持 1 支持 |
否 |
| isExistExpiryDate |
int |
是否存在有效期(0 不存在 1 存在) |
否 |
| expiryDays |
int |
有效期天数 (isExistExpiryDate=1) 和isExistExpiryDateint配合使用只有存在有效期时这个值才有作用 |
否 |
| isEvent |
int |
是否支持场次 0 不支持 1 支持 |
否 |
| eventTime |
string |
演出时间,如20:00 |
否,isEvent位true时必传 |
| styleNo |
string |
票类编码 |
是 |
| isStock |
int |
是否存在库存 0 不存在 1 存在 |
否 |
| limitRule |
object |
预订限制信息 |
是 |
| productIntroduction |
string |
产品简介 |
是 |
| productDesc |
string |
产品详情 |
是 |
| refundDesc |
string |
退款说明 |
是 |
| feeInclude |
string |
费用包含 |
否 |
| feeExclude |
string |
费用不含 |
否 |
| getTicketLocation |
string |
换票地址 |
是 |
| openDate |
string |
营业时间 |
是 |
| isRefundNeedReview |
int |
是否审核退单 0 否 1 是 |
否 |
limitRule对象结构
| 参数名 |
类型 |
描述 |
是否必传 |
| lastOrderTimeLimit |
string |
最晚下单时间,如19:00 |
否 |
| minCount |
int |
最少购买数量 |
否 |
| maxCount |
int |
最多购买数量 |
否 |
| advanceLimit |
int |
提前购买时间,单位分钟,订单购买后多长时间生效 |
否 |
1.3 产品价格日历接口(供应商提供)
方法名:GetCalenderPrice
调用方:分销平台
响应方:供应商
接口说明:本接口可用于分销平台从供应商查询一个产品的价格日历
1.3.1 业务请求参数
| 参数名 |
类型 |
是否必传 |
描述 |
| productNo |
int |
是 |
供应商产品编号 |
| showTime |
string |
否 |
演出时间,如20:00 |
| zoneName |
string |
否 |
分区名称,也可以是票类供应商票类编码 |
| startTime |
string |
是 |
开始时间,格式yyyy-MM-dd |
| endTime |
string |
是 |
结束时间,含当天,格式yyyy-MM-dd |
1.3.2 业务响应参数
| 参数名 |
类型 |
是否必传 |
描述 |
| priceList |
List |
是 |
景区基础信息数组 |
priceList中的单个对象数据结构
| 参数名 |
类型 |
是否必传 |
描述 |
| productNo |
int |
是 |
产品编号 |
| showTime |
string |
是 |
演出时间,如20:00 |
| zoneName |
string |
是 |
分区名称,也可以是票类供应商票类编码 |
| date |
String |
是 |
价格日期 |
| marketPrice |
decimal |
是 |
市场价格 |
| sellerPrice |
dcimal |
是 |
分销价格 |
| cashPrice |
decimal |
否 |
分销商结算价格 |
| stock |
int |
否 |
产品可用库存 |
1.4 产品变化通知接口(分销平台提供)
方法名:PushProductChange
调用方:供应商
响应方:分销平台
接口说明:本接口用于供应商通知分销平台产品属性或价格发生变化,分销平台会重新从供应商抓取产品属性或价格。
1.4.1 业务请求参数
| 参数名 |
类型 |
是否必传 |
描述 |
| changeType |
int |
是 |
10 新增产品 20 产品信息变更 30 产品上线 40 产品下线 |
| productIdList |
stirng |
是 |
供应商产品ID列表,多个逗号分隔 |
| showTimeList |
string |
是 |
演出时间,如20:00,多个逗号分隔 |
| zoneNameList |
string |
是 |
分区名称,也可以是票类供应商票类编码,多个逗号分隔 |
1.4.2 业务响应参数
| 参数名 |
类型 |
描述 |
是否必传 |
| code |
Integer |
是 |
错误码 |
| message |
String |
是 |
响应描述信息 |
| data |
String |
否 |
响应数据 |
2 订单接口
2.1 创建订单接口(供应商提供)
方法名:CreateOrder
调用方:分销平台
响应方:供应商
接口说明:本接口可用于分销平台从供应商下单。
2.1.1 业务请求参数
| 参数名 |
类型 |
描述 |
是否必传 |
| ShowNo |
int |
供应商演出编号 |
是 |
| ShowTime |
string |
演出时间,如20:00 |
是 |
| ZoneName |
string |
分区名称,决定价格,也可以是票类供应商票类编码 |
是 |
| VisitDate |
string |
使用日期,格式yyyy-MM-dd |
是 |
| Count |
int |
购买数量 |
是 |
| OrderNo |
int |
分销平台单号 |
是 |
| GuestName |
string |
游客姓名,多个逗号分隔 |
是 |
| MobileNo |
string |
游客手机号,多个逗号分隔 |
否 |
| IdNo |
string |
游客身份证号,多个逗号分隔 |
否 |
| TotalPrice |
decimal |
订单总价,单位元 |
是 |
| GetTicketMan |
string |
取票人姓名 |
是 |
| GetTicketMobile |
string |
取票人手机号 |
是 |
| SellerNo |
string |
渠道编号 |
是 |
| SellerName |
string |
渠道名称,如美团 |
是 |
2.1.2 业务响应参数
| 参数名 |
类型 |
描述 |
是否必传 |
| ResultCode |
string |
响应编码 |
是 |
| ResultMessage |
string |
响应消息 |
是 |
| OrderNo |
int |
分销平台单号 |
是 |
| PurchaseOrderNo |
string |
供应商单号 |
是 |
| BarcodeNo |
stirng |
供应商码号 |
是 |
| Stock |
int |
剩余总库存 |
是 |
2.2 退单接口(供应商提供)
方法名:RefundOrder
调用方:分销平台
响应方:供应商
接口说明:本接口可用于分销平台从供应商退单。
2.2.1 业务请求参数
| 参数名 |
类型 |
描述 |
是否必传 |
| orderNo |
string |
分销平台订单编号 |
是 |
| reserveNo |
string |
供应商码号 |
否 |
| refundCount |
string |
退单数量 |
是 |
2.2.2 业务响应参数
| 参数名 |
类型 |
描述 |
是否必传 |
| ResultCode |
string |
响应编码 |
是 |
| ResultMessage |
string |
响应消息 |
是 |
2.3 验证通知接口(分销平台提供)
方法名:这里为分销平台主动通知地址,具体方法名称在参数中体现
调用方:供应商
响应方:分销平台
接口说明:本接口可用于供应商通知分销平台订单已核销。
2.3.1 业务请求参数
| 参数名 |
类型 |
描述 |
是否必传 |
| orderInfoList |
object[] |
订单列表 |
是 |
| orderNo |
int |
分销平台订单号 |
是 |
| pushType |
string |
推送通知类型,固定为ORDER_CHECK_TICKET |
是 |
orderInfoList中的单个对象数据结构
| 参数名 |
类型 |
描述 |
是否必传 |
| ticketNo |
string |
供应商码号 |
否 |
| ticketCount |
int |
验证总数量 |
是 |
| showName |
string |
演出名称 |
否 |
| showingName |
string |
场次名称 |
否 |
2.3.2 业务响应参数
| 参数名 |
类型 |
描述 |
是否必传 |
| Code |
string |
响应编码 |
是 |
| Msg |
string |
响应消息 |
是 |
| Data |
string |
业务消息,success或fail |
是 |