Inventory Query
Fetch the inventory of hotel's product for a period of time,The returned result is an array, and the index sequence corresponds to the date
Request Method#
POST
uri: /ari/daily/inventory
Content-Type: application/json
Request parameter description#
RequestHeader#
Common Request Header[Reference]
RequestBody#
| Parameter | Type | Required | Maximum length | Example |
|---|---|---|---|---|
| hotelId | String | Y | 32 | 12 * * 567 |
| startDate | Date | Y | - | 2021-10-01 |
| endDate | Date | Y | - | 2021-10-02 |
| checkinType | String | Y | 16 | DAY |
| productCandidates | List<ProductCandidate> | N | - | |
| echoToken | String | N | 64 | 7550f7497b2d4dd9beea83cd2fe8cd74 |
ProductCandidate#
| Parameter | Type | Required | Maximum length | Example | Description |
|---|---|---|---|---|---|
| roomTypeCode | String | Y | 64 | DR1 | |
| rateCode | String | Y | 64 | Base-NTR | RateCode |
Response parameter description#
Common Response Parameters[Reference]
content#
| Parameter | Type | Required | Maximum length | Example |
|---|---|---|---|---|
| hotelId | String | Y | 32 | 12**567 |
| startDate | Date | Y | - | 2021-10-01 |
| endDate | Date | Y | - | 2021-10-02 |
| dailyInventories | List<DailyInventory> | Y | - |
DailyInventory#
| Parameter | Type | Required | Maximum length | Example | Description |
|---|---|---|---|---|---|
| roomTypeCode | String | Y | 64 | DR1 | |
| rateCode | String | Y | 64 | Base-NTR | rateCode |
| inventories | List<Integer> | Y | - |
ResponseCode#
| Exception Code | Exception Type | Description |
|---|---|---|
| 1000 | Success | |
| 4301 | Start date and end date does not match the rules | |
| 4302 | End date is invalid | |
| 4303 | Start date is invalid | |
| 4304 | Invalid hotel Id | |
| 4305 | Hotel is closed | |
| 4306 | No match found | |
| 4307 | Unexpected results of querying room quantity | |
| Other | Global Exception Code | Global Exception Code[Reference] |