Module: order

订单

Methods


<static> analytics(header, body)

post 查询有权限访问的酒店订单聚合指标;支持最多两个维度组合,仅统计已确认、已完成订单,不返回订单明细

Parameters:
Name Type Description
header module:request.YHeader

Http request header

body object

Http request body

Properties
Name Type Argument Default Description
filter object

筛选条件

Properties
Name Type Description
bookedAt Array.<string>

下单时间范围,须传开始和结束两个时间;与 order/search 的双端范围一样,包含开始时间、不包含结束时间;推荐 ISO 8601 带时区格式

groupBy string | Array.<string> <optional>
none

分组:none、day、month、city、hotel、channel;组合分组传最多两个不同维度的数组,不可与 none 组合;单独按 day 分组返回全部有订单的日期

preferred module:common.Preferred <optional>

首选设置;currency 支持 CNY(默认)、USD、JPY,language 支持 zh(默认)、en、ja(日语名称回退英文)

paging module: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
header module:request.YHeader

Http request header

body object

Http request body

Properties
Name Type Argument Description
_id string

订单识别码

penaltyPolicy module:common.PenaltyPolicy <optional>

罚金。order/search 返回的 penaltyPolicies 中查找 current.applicable 为 true 的数据

payment Payment <optional>

罚金支付信息

Since:
  • 1.0.0
Returns:
Type
cancelResponse

<static> search(header, body)

post 搜索订单

Parameters:
Name Type Description
header module:request.YHeader

Http request header

body object

Http request body

Properties
Name Type Argument Default Description
filter OrderFilter

筛选条件

sort string <optional>
byBookedAt

排序方式

  • byBookedAt 按预订日期
  • byBookedAtDescending 按预订日期倒序
  • byCheckInDate 按入住日期
  • byCheckInDateDescending 按入住日期倒序
paging module:common.Paging <optional>

页码信息,普通查询 limit 最大 20;指定 body.filter._ids 时最大 100

Since:
  • 1.0.0
Returns:
Type
searchResponse

Type Definitions


analyticsAmount

Type:
  • object
Properties:
Name Type Description
amount number

金额

currency string

币种,与响应的 currency 一致

Since:
  • 2.0.0

analyticsResponse

Type:
  • object
Properties:
Name Type Argument Description
err module:common.Error <optional>

错误信息

currency string

金额币种;数量指标不使用币种

groupBy string | Array.<string>

分组:none、day、month、city、hotel 或 channel;多维分组时为数组

period object

查询时间范围,与 filter.bookedAt 一致

Properties
Name Type Description
from string

开始时间,包含该时刻

to string

结束时间,不包含该时刻

rows Array.<analyticsRow>

聚合结果;none 分组最多一行,没有匹配订单时为空数组

hasMore boolean

除单独按 day 分组外是否还有下一页;单独按 day 分组恒为 false

Since:
  • 2.0.0

analyticsRow

Type:
  • object
Properties:
Name Type Argument Description
date string <optional>

按 day 分组时的下单日期,YYYY-MM-DD

month string <optional>

按 month 分组时的下单月份,YYYY-MM

city object <optional>

按 city 分组时的城市

Properties
Name Type Argument Description
_id string | null <optional>

城市识别码

name string | null <optional>

城市名称

hotel object <optional>

按 hotel 分组时的酒店

Properties
Name Type Argument Description
_id string | null <optional>

酒店识别码

name string | null <optional>

酒店名称

channel object <optional>

按 channel 分组时的渠道

Properties
Name Type Argument Description
_id string | null <optional>

渠道识别码

key string | null <optional>

渠道关键字

name string | null <optional>

渠道名称

totalAmount analyticsAmount

总金额

averageOrderAmount analyticsAmount

单均金额

orderCount number

订单数

totalNights number

总晚数

averageOrderNights number

单均晚数

Since:
  • 2.0.0

cancelResponse

Type:
  • object
Properties:
Name Type Argument Description
err module:common.Error <optional>

错误信息

order Order

订单

Since:
  • 1.0.0

searchResponse

Type:
  • object
Properties:
Name Type Argument Description
err module:common.Error <optional>

错误信息

paging module:common.Paging

页码信息

orders Array.<Order>

订单

Since:
  • 1.0.0