订单
Methods
-
<static> analytics(header, body)
-
post 查询有权限访问的酒店订单聚合指标;支持最多两个维度组合,仅统计已确认、已完成订单,不返回订单明细
Parameters:
Name Type Description headermodule:request.YHeader Http request header
bodyobject Http request body
Properties
Name Type Argument Default Description filterobject 筛选条件
Properties
Name Type Description bookedAtArray.<string> 下单时间范围,须传开始和结束两个时间;与 order/search 的双端范围一样,包含开始时间、不包含结束时间;推荐 ISO 8601 带时区格式
groupBystring | Array.<string> <optional>
none 分组:none、day、month、city、hotel、channel;组合分组传最多两个不同维度的数组,不可与 none 组合;单独按 day 分组返回全部有订单的日期
preferredmodule:common.Preferred <optional>
首选设置;currency 支持 CNY(默认)、USD、JPY,language 支持 zh(默认)、en、ja(日语名称回退英文)
pagingmodule:common.Paging <optional>
除单独按 day 分组外的分页:skip 默认 0,limit 默认 10、最大 20;单独按 day 分组不支持 paging
- Since:
-
- 2.0.0
Returns:
- Type
- analyticsResponse
-
<static> cancel(header, body)
-
post取消订单。注意,返回订单并不意味已取消成功。需要确认 order.details.result.cancellation.status 和 no 的值Parameters:
Name Type Description headermodule:request.YHeader Http request header
bodyobject Http request body
Properties
Name Type Argument Description _idstring 订单识别码
penaltyPolicymodule:common.PenaltyPolicy <optional>
罚金。order/search 返回的 penaltyPolicies 中查找 current.applicable 为 true 的数据
paymentPayment <optional>
罚金支付信息
- Since:
-
- 1.0.0
Returns:
- Type
- cancelResponse
-
<static> search(header, body)
-
post搜索订单Parameters:
Name Type Description headermodule:request.YHeader Http request header
bodyobject Http request body
Properties
Name Type Argument Default Description filterOrderFilter 筛选条件
sortstring <optional>
byBookedAt 排序方式
byBookedAt按预订日期byBookedAtDescending按预订日期倒序byCheckInDate按入住日期byCheckInDateDescending按入住日期倒序
pagingmodule:common.Paging <optional>
页码信息,普通查询 limit 最大 20;指定 body.filter._ids 时最大 100
- Since:
-
- 1.0.0
Returns:
- Type
- searchResponse
Type Definitions
-
analyticsAmount
-
Type:
- object
- Since:
-
- 2.0.0
Properties:
Name Type Description amountnumber 金额
currencystring 币种,与响应的 currency 一致
-
analyticsResponse
-
Type:
- object
- Since:
-
- 2.0.0
Properties:
Name Type Argument Description errmodule:common.Error <optional>
错误信息
currencystring 金额币种;数量指标不使用币种
groupBystring | Array.<string> 分组:none、day、month、city、hotel 或 channel;多维分组时为数组
periodobject 查询时间范围,与 filter.bookedAt 一致
Properties
Name Type Description fromstring 开始时间,包含该时刻
tostring 结束时间,不包含该时刻
rowsArray.<analyticsRow> 聚合结果;none 分组最多一行,没有匹配订单时为空数组
hasMoreboolean 除单独按 day 分组外是否还有下一页;单独按 day 分组恒为 false
-
analyticsRow
-
Type:
- object
- Since:
-
- 2.0.0
Properties:
Name Type Argument Description datestring <optional>
按 day 分组时的下单日期,YYYY-MM-DD
monthstring <optional>
按 month 分组时的下单月份,YYYY-MM
cityobject <optional>
按 city 分组时的城市
Properties
Name Type Argument Description _idstring | null <optional>
城市识别码
namestring | null <optional>
城市名称
hotelobject <optional>
按 hotel 分组时的酒店
Properties
Name Type Argument Description _idstring | null <optional>
酒店识别码
namestring | null <optional>
酒店名称
channelobject <optional>
按 channel 分组时的渠道
Properties
Name Type Argument Description _idstring | null <optional>
渠道识别码
keystring | null <optional>
渠道关键字
namestring | null <optional>
渠道名称
totalAmountanalyticsAmount 总金额
averageOrderAmountanalyticsAmount 单均金额
orderCountnumber 订单数
totalNightsnumber 总晚数
averageOrderNightsnumber 单均晚数
-
cancelResponse
-
Type:
- object
- Since:
-
- 1.0.0
Properties:
Name Type Argument Description errmodule:common.Error <optional>
错误信息
orderOrder 订单
-
searchResponse
-
Type:
- object
- Since:
-
- 1.0.0
Properties:
Name Type Argument Description errmodule:common.Error <optional>
错误信息
pagingmodule:common.Paging 页码信息
ordersArray.<Order> 订单