オンライン中  

/v1/discovery/

Public place discovery and indicative reservation pricing for agents. No account actions.
GET

/v1/discovery/get_best_places

#
Get the AppointmentTrader city hotlist. Ranking is not evidence of available reservations. Public-by-design: exposes public city rankings, without account data or API charges.

パラメーター

名前型必須既定値説明
citySlug string はい — Canonical city slug from /v1/discovery/get_cities.
categorySlug string いいえ "" Optional canonical category, such as restaurants.
pageSize int いいえ 10 Number of results, 1-25.
pageNumber int いいえ 0 Zero-based page, 0-20.
リクエスト例(cURL)
curl --get \
  'https://jp.appointmenttrader.com/v1/discovery/get_best_places' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'citySlug={{citySlug}}' \
  --data-urlencode 'categorySlug={{categorySlug}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}'

戻り値

JSON
See the shared response schema and synthetic example.
レスポンスフィールド
フィールド型必須説明
$discovery_get_best_places_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.cityobject はい
$.oneOf[0].allOf[1].Payload.city.cityName はい
$.oneOf[0].allOf[1].Payload.city.cityName.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.city.cityName.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.city.citySlugstring はい
$.oneOf[0].allOf[1].Payload.city.countryCode はい
$.oneOf[0].allOf[1].Payload.city.countryCode.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.city.countryCode.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.city.isoRegion いいえ
$.oneOf[0].allOf[1].Payload.city.isoRegion.anyOf[0]string いいえ
$.oneOf[0].allOf[1].Payload.city.isoRegion.anyOf[1]null いいえ
$.oneOf[0].allOf[1].Payload.city.stateShort いいえ
$.oneOf[0].allOf[1].Payload.city.stateShort.anyOf[0]string いいえ
$.oneOf[0].allOf[1].Payload.city.stateShort.anyOf[1]null いいえ
$.oneOf[0].allOf[1].Payload.placesarray はい
$.oneOf[0].allOf[1].Payload.places[]object いいえ
$.oneOf[0].allOf[1].Payload.places[].locationAliasstring はい
$.oneOf[0].allOf[1].Payload.places[].namestring はい
$.oneOf[0].allOf[1].Payload.places[].cityNamestring はい
$.oneOf[0].allOf[1].Payload.places[].citySlugstring はい
$.oneOf[0].allOf[1].Payload.places[].countryCodestring はい
$.oneOf[0].allOf[1].Payload.places[].categorySlugstring はい
$.oneOf[0].allOf[1].Payload.places[].addressstring はい
$.oneOf[0].allOf[1].Payload.places[].urlstring はい
$.oneOf[0].allOf[1].Payload.places[].rankinteger はい
$.oneOf[0].allOf[1].Payload.places[].locationIDinteger はい
$.oneOf[0].allOf[1].Payload.rankingBasis = "AppointmentTrader city hotlist" はい
$.oneOf[0].allOf[1].Payload.rankingCacheSeconds = 86400 はい
$.oneOf[0].allOf[1].Payload.availabilityIncluded = false はい
$.oneOf[0].allOf[1].Payload.checkedAtstring はい
$.oneOf[0].allOf[1].Payload.paginationobject はい
$.oneOf[0].allOf[1].Payload.pagination.pageSizeinteger はい
$.oneOf[0].allOf[1].Payload.pagination.pageNumberinteger はい
$.oneOf[0].allOf[1].Payload.pagination.nextPageNumber はい
$.oneOf[0].allOf[1].Payload.pagination.nextPageNumber.anyOf[0]integer はい
$.oneOf[0].allOf[1].Payload.pagination.nextPageNumber.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.pagination.hasMoreboolean はい
$.oneOf[0].allOf[1].Payload.pagination.refineSearchboolean はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[1].ResponseMessage.oneOf[1]array はい
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[1].ResponseMessage.oneOf[2]object はい
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[1].RequestImpersonatedByUserAliasstring いいえ
レスポンス例
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/discovery/get_best_places",
    "RequestUserAlias": "example-user",
    "Payload": {
        "city": {
            "cityName": "synthetic-example",
            "citySlug": "synthetic-example",
            "countryCode": "synthetic-example"
        },
        "places": [],
        "rankingBasis": "AppointmentTrader city hotlist",
        "rankingCacheSeconds": 86400,
        "availabilityIncluded": false,
        "checkedAt": "2030-01-01T12:00:00Z",
        "pagination": {
            "pageSize": 1,
            "pageNumber": 0,
            "nextPageNumber": 1,
            "hasMore": false,
            "refineSearch": false
        }
    }
}
機械可読のエンドポイントドキュメント
GET

/v1/discovery/get_cities

#
Find canonical cities and airport-backed markets; choose among ambiguous matches. Public-by-design: exposes only public city metadata, without account data or API charges.

パラメーター

名前型必須既定値説明
searchFilter string いいえ "" Literal city name to search.
pageSize int いいえ 10 Number of results, 1-25.
pageNumber int いいえ 0 Zero-based page, 0-20.
リクエスト例(cURL)
curl --get \
  'https://jp.appointmenttrader.com/v1/discovery/get_cities' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'searchFilter={{searchFilter}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}'

戻り値

JSON
See the shared response schema and synthetic example.
レスポンスフィールド
フィールド型必須説明
$discovery_get_cities_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.citiesarray はい
$.oneOf[0].allOf[1].Payload.cities[]object いいえ
$.oneOf[0].allOf[1].Payload.cities[].cityIDinteger はい
$.oneOf[0].allOf[1].Payload.cities[].cityName はい
$.oneOf[0].allOf[1].Payload.cities[].cityName.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.cities[].cityName.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.cities[].citySlugstring はい
$.oneOf[0].allOf[1].Payload.cities[].cityCode はい
$.oneOf[0].allOf[1].Payload.cities[].cityCode.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.cities[].cityCode.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.cities[].countryCode はい
$.oneOf[0].allOf[1].Payload.cities[].countryCode.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.cities[].countryCode.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.cities[].regionCode はい
$.oneOf[0].allOf[1].Payload.cities[].regionCode.anyOf[0]string はい
$.oneOf[0].allOf[1].Payload.cities[].regionCode.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.checkedAtstring はい
$.oneOf[0].allOf[1].Payload.paginationobject はい
$.oneOf[0].allOf[1].Payload.pagination.pageSizeinteger はい
$.oneOf[0].allOf[1].Payload.pagination.pageNumberinteger はい
$.oneOf[0].allOf[1].Payload.pagination.nextPageNumber はい
$.oneOf[0].allOf[1].Payload.pagination.nextPageNumber.anyOf[0]integer はい
$.oneOf[0].allOf[1].Payload.pagination.nextPageNumber.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.pagination.hasMoreboolean はい
$.oneOf[0].allOf[1].Payload.pagination.refineSearchboolean はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[1].ResponseMessage.oneOf[1]array はい
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[1].ResponseMessage.oneOf[2]object はい
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[1].RequestImpersonatedByUserAliasstring いいえ
レスポンス例
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/discovery/get_cities",
    "RequestUserAlias": "example-user",
    "Payload": {
        "cities": [],
        "checkedAt": "2030-01-01T12:00:00Z",
        "pagination": {
            "pageSize": 1,
            "pageNumber": 0,
            "nextPageNumber": 1,
            "hasMore": false,
            "refineSearch": false
        }
    }
}
機械可読のエンドポイントドキュメント
GET

/v1/discovery/get_place

#
Read a public place and its valid inventory choices before checking a reservation price. Public-by-design: exposes public venue and inventory metadata, without account data or API charges.

パラメーター

名前型必須既定値説明
locationAlias string はい — Canonical alias from /v1/discovery/get_places.
リクエスト例(cURL)
curl --get \
  'https://jp.appointmenttrader.com/v1/discovery/get_place' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationAlias={{locationAlias}}'

戻り値

JSON
See the shared response schema and synthetic example.
レスポンスフィールド
フィールド型必須説明
$discovery_get_place_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.locationIDinteger はい
$.oneOf[0].allOf[1].Payload.locationAliasstring はい
$.oneOf[0].allOf[1].Payload.namestring はい
$.oneOf[0].allOf[1].Payload.cityNamestring はい
$.oneOf[0].allOf[1].Payload.citySlugstring はい
$.oneOf[0].allOf[1].Payload.countryCodestring はい
$.oneOf[0].allOf[1].Payload.regionCodestring はい
$.oneOf[0].allOf[1].Payload.addressstring はい
$.oneOf[0].allOf[1].Payload.timezonestring はい
$.oneOf[0].allOf[1].Payload.categorySlugstring はい
$.oneOf[0].allOf[1].Payload.urlstring はい
$.oneOf[0].allOf[1].Payload.timeRangeUnitstring はい
$.oneOf[0].allOf[1].Payload.maxTimeRangeUnitsinteger はい
$.oneOf[0].allOf[1].Payload.reservationPricingAllowedboolean はい
$.oneOf[0].allOf[1].Payload.inventoryTypesarray はい
$.oneOf[0].allOf[1].Payload.inventoryTypes[]object いいえ
$.oneOf[0].allOf[1].Payload.inventoryTypes[].inventoryTypeIDinteger はい
$.oneOf[0].allOf[1].Payload.inventoryTypes[].namestring はい
$.oneOf[0].allOf[1].Payload.inventoryTypes[].headcount はい
$.oneOf[0].allOf[1].Payload.inventoryTypes[].headcount.anyOf[0]integer はい
$.oneOf[0].allOf[1].Payload.inventoryTypes[].headcount.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.checkedAtstring はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[1].ResponseMessage.oneOf[1]array はい
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[1].ResponseMessage.oneOf[2]object はい
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[1].RequestImpersonatedByUserAliasstring いいえ
レスポンス例
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/discovery/get_place",
    "RequestUserAlias": "example-user",
    "Payload": {
        "locationID": 0,
        "locationAlias": "synthetic-example",
        "name": "synthetic-example",
        "cityName": "synthetic-example",
        "citySlug": "synthetic-example",
        "countryCode": "synthetic-example",
        "regionCode": "synthetic-example",
        "address": "synthetic-example",
        "timezone": "synthetic-example",
        "categorySlug": "synthetic-example",
        "url": "synthetic-example",
        "timeRangeUnit": "synthetic-example",
        "maxTimeRangeUnits": 0,
        "reservationPricingAllowed": false,
        "inventoryTypes": [],
        "checkedAt": "2030-01-01T12:00:00Z"
    }
}
機械可読のエンドポイントドキュメント
GET

/v1/discovery/get_places

#
Search public place names and aliases. Resolve the intended place from these matches. Public-by-design: exposes public place metadata only, without account data or API charges.

パラメーター

名前型必須既定値説明
searchFilter string はい — Literal place name, at least two characters.
citySlug string いいえ "" Optional canonical city slug from /v1/discovery/get_cities.
pageSize int いいえ 10 Number of results, 1-25.
pageNumber int いいえ 0 Zero-based page, 0-20.
リクエスト例(cURL)
curl --get \
  'https://jp.appointmenttrader.com/v1/discovery/get_places' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'searchFilter={{searchFilter}}' \
  --data-urlencode 'citySlug={{citySlug}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}'

戻り値

JSON
See the shared response schema and synthetic example.
レスポンスフィールド
フィールド型必須説明
$discovery_get_places_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.placesarray はい
$.oneOf[0].allOf[1].Payload.places[]object いいえ
$.oneOf[0].allOf[1].Payload.places[].locationIDinteger はい
$.oneOf[0].allOf[1].Payload.places[].locationAliasstring はい
$.oneOf[0].allOf[1].Payload.places[].namestring はい
$.oneOf[0].allOf[1].Payload.places[].cityNamestring はい
$.oneOf[0].allOf[1].Payload.places[].citySlugstring はい
$.oneOf[0].allOf[1].Payload.places[].countryCodestring はい
$.oneOf[0].allOf[1].Payload.places[].regionCodestring はい
$.oneOf[0].allOf[1].Payload.places[].addressstring はい
$.oneOf[0].allOf[1].Payload.places[].timezonestring はい
$.oneOf[0].allOf[1].Payload.places[].categorySlugstring はい
$.oneOf[0].allOf[1].Payload.places[].urlstring はい
$.oneOf[0].allOf[1].Payload.checkedAtstring はい
$.oneOf[0].allOf[1].Payload.paginationobject はい
$.oneOf[0].allOf[1].Payload.pagination.pageSizeinteger はい
$.oneOf[0].allOf[1].Payload.pagination.pageNumberinteger はい
$.oneOf[0].allOf[1].Payload.pagination.nextPageNumber はい
$.oneOf[0].allOf[1].Payload.pagination.nextPageNumber.anyOf[0]integer はい
$.oneOf[0].allOf[1].Payload.pagination.nextPageNumber.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.pagination.hasMoreboolean はい
$.oneOf[0].allOf[1].Payload.pagination.refineSearchboolean はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[1].ResponseMessage.oneOf[1]array はい
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[1].ResponseMessage.oneOf[2]object はい
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[1].RequestImpersonatedByUserAliasstring いいえ
レスポンス例
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/discovery/get_places",
    "RequestUserAlias": "example-user",
    "Payload": {
        "places": [],
        "checkedAt": "2030-01-01T12:00:00Z",
        "pagination": {
            "pageSize": 1,
            "pageNumber": 0,
            "nextPageNumber": 1,
            "hasMore": false,
            "refineSearch": false
        }
    }
}
機械可読のエンドポイントドキュメント
GET

/v1/discovery/get_reservation_pricing

#
Check public listings and an indicative reservation acquisition price for a specific venue-local window. Historical comps, external references and configured defaults are labeled separately. This is not a checkout quote, does not include all fees or the meal unless explicitly stated, and never guarantees availability or creates a bid. Public-by-design: public inventory and anonymized price evidence only; no account data or API charges.

パラメーター

名前型必須既定値説明
locationAlias string はい — Canonical alias from /v1/discovery/get_places.
inventoryTypeID int はい — Canonical inventory ID from /v1/discovery/get_place.
date string はい — Venue-local date, YYYY-MM-DD.
startHour int はい — Inclusive venue-local start hour, 0-23.
endHour int はい — Exclusive venue-local end hour, 1-24.
timeRangeUnits int いいえ 1 Category duration, default 1; day categories require hours 0-24.
リクエスト例(cURL)
curl --get \
  'https://jp.appointmenttrader.com/v1/discovery/get_reservation_pricing' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationAlias={{locationAlias}}' \
  --data-urlencode 'inventoryTypeID={{inventoryTypeID}}' \
  --data-urlencode 'date={{date}}' \
  --data-urlencode 'startHour={{startHour}}' \
  --data-urlencode 'endHour={{endHour}}' \
  --data-urlencode 'timeRangeUnits={{timeRangeUnits}}'

戻り値

JSON
See the shared response schema and synthetic example.
レスポンスフィールド
フィールド型必須説明
$discovery_get_reservation_pricing_Response はい
$.oneOf[0] はい
$.oneOf[0].allOf[0]object はい
$.oneOf[0].allOf[0].RequestUserAliasstring はい
$.oneOf[0].allOf[0].RequestPathstring | null はい
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" はい
$.oneOf[0].allOf[0].ResponseCodeinteger はい
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object はい
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring いいえ
$.oneOf[0].allOf[1]object はい
$.oneOf[0].allOf[1].Payloadobject はい
$.oneOf[0].allOf[1].Payload.locationobject はい
$.oneOf[0].allOf[1].Payload.location.aliasstring はい
$.oneOf[0].allOf[1].Payload.location.namestring はい
$.oneOf[0].allOf[1].Payload.location.urlstring はい
$.oneOf[0].allOf[1].Payload.location.timezonestring はい
$.oneOf[0].allOf[1].Payload.location.timezoneSource = "location_configuration" はい
$.oneOf[0].allOf[1].Payload.inventoryobject はい
$.oneOf[0].allOf[1].Payload.inventory.idinteger はい
$.oneOf[0].allOf[1].Payload.inventory.namestring はい
$.oneOf[0].allOf[1].Payload.inventory.priceIncludesServiceboolean はい
$.oneOf[0].allOf[1].Payload.requestobject はい
$.oneOf[0].allOf[1].Payload.request.datestring はい
$.oneOf[0].allOf[1].Payload.request.endDatestring はい
$.oneOf[0].allOf[1].Payload.request.startHourinteger はい
$.oneOf[0].allOf[1].Payload.request.endHourinteger はい
$.oneOf[0].allOf[1].Payload.request.endHourExclusive = true はい
$.oneOf[0].allOf[1].Payload.request.timeRangeUnitstring ["Hour","Day"] はい
$.oneOf[0].allOf[1].Payload.request.timeRangeUnitsinteger はい
$.oneOf[0].allOf[1].Payload.availabilityobject はい
$.oneOf[0].allOf[1].Payload.availability.statusstring ["restricted","no_public_listings","listings_disabled","available","no_public_listings_in_returned_sample"] はい
$.oneOf[0].allOf[1].Payload.availability.matchingListingCountinteger はい
$.oneOf[0].allOf[1].Payload.availability.resultSetCompleteboolean はい
$.oneOf[0].allOf[1].Payload.availability.lowestAskingPriceMinor はい
$.oneOf[0].allOf[1].Payload.availability.lowestAskingPriceMinor.anyOf[0]integer はい
$.oneOf[0].allOf[1].Payload.availability.lowestAskingPriceMinor.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.availability.currency = "USD" はい
$.oneOf[0].allOf[1].Payload.availability.listingsarray はい
$.oneOf[0].allOf[1].Payload.availability.listings[]object いいえ
$.oneOf[0].allOf[1].Payload.availability.listings[].listingIDstring はい
$.oneOf[0].allOf[1].Payload.availability.listings[].datestring はい
$.oneOf[0].allOf[1].Payload.availability.listings[].endDatestring はい
$.oneOf[0].allOf[1].Payload.availability.listings[].timeWindow はい
$.oneOf[0].allOf[1].Payload.availability.listings[].timeWindow.anyOf[0]object はい
$.oneOf[0].allOf[1].Payload.availability.listings[].timeWindow.anyOf[0].startHourinteger はい
$.oneOf[0].allOf[1].Payload.availability.listings[].timeWindow.anyOf[0].endHourinteger はい
$.oneOf[0].allOf[1].Payload.availability.listings[].timeWindow.anyOf[0].exactTimeDisclosed = false はい
$.oneOf[0].allOf[1].Payload.availability.listings[].timeWindow.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.availability.listings[].askingPriceMinorinteger はい
$.oneOf[0].allOf[1].Payload.availability.listings[].currency = "USD" はい
$.oneOf[0].allOf[1].Payload.availability.listings[].isCheckoutQuote = false はい
$.oneOf[0].allOf[1].Payload.availability.listings[].urlstring はい
$.oneOf[0].allOf[1].Payload.availability.observedAtstring はい
$.oneOf[0].allOf[1].Payload.estimateDiscoveryPriceEstimate はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[0]object はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[0].currency = "USD" はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[0].amountMinorinteger はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[0].lowAmountMinor = null はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[0].highAmountMinor = null はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[0].source = "external_reference" はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[0].sampleCountinteger はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[0].sameLocationSampleCount = null はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[0].inventoryMatch = "exact" はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[0].priceFactor = null はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[0].requestedDurationMatched = true はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[0].isHistoricalEvidence = false はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[0].isGuaranteed = false はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[0].scope = "recorded_provider_rates_for_requested_dates" はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[0].requiresLiveProviderConfirmation = true はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[1]object はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[1].currency = "USD" はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[1].amountMinorinteger はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[1].lowAmountMinor はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[1].lowAmountMinor.anyOf[0]integer はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[1].lowAmountMinor.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[1].highAmountMinor はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[1].highAmountMinor.anyOf[0]integer はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[1].highAmountMinor.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[1].source = "completed_transactions" はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[1].sampleCountinteger はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[1].sameLocationSampleCountinteger はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[1].inventoryMatchstring ["exact","category_scaled"] はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[1].priceFactor はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[1].priceFactor.anyOf[0]number はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[1].priceFactor.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[1].requestedDurationMatchedboolean はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[1].isHistoricalEvidence = true はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[1].isGuaranteed = false はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[1].scopestring ["same_location","same_category_nearest_locations_first"] はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[1].sampleLimit = 5 はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[1].lookbackMonthsinteger [3,24] はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[1].lookbackDateField = "transaction_last_updated" はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[1].completionDateRangeKnown = false はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[1].comparableDaysNoticeinteger はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[1].comparableMaturityTimezonestring はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[2]object はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[2].currency = "USD" はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[2].amountMinorinteger はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[2].lowAmountMinor = null はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[2].highAmountMinor = null はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[2].source = "external_history" はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[2].sampleCount = null はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[2].sameLocationSampleCount = null はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[2].inventoryMatch = null はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[2].priceFactor = null はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[2].requestedDurationMatched = true はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[2].isHistoricalEvidence = true はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[2].isGuaranteed = false はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[2].scope = "inventory_popularity_and_maturity_with_canonical_fallback" はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[2].containsPricingAdjustment = true はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[3]object はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[3].currency = "USD" はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[3].amountMinorinteger はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[3].lowAmountMinor = null はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[3].highAmountMinor = null はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[3].source = "configured_default" はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[3].sampleCount = 0 はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[3].sameLocationSampleCount = null はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[3].inventoryMatch = "configured_inventory_default" はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[3].priceFactor = null はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[3].requestedDurationMatched = true はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[3].isHistoricalEvidence = false はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[3].isGuaranteed = false はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[3].scope = "configured_starting_amount_without_comparable_evidence" はい
$.oneOf[0].allOf[1].Payload.estimate.oneOf[4]null はい
$.oneOf[0].allOf[1].Payload.pricingContextobject はい
$.oneOf[0].allOf[1].Payload.pricingContext.popularityBracket はい
$.oneOf[0].allOf[1].Payload.pricingContext.popularityBracket.anyOf[0]integer はい
$.oneOf[0].allOf[1].Payload.pricingContext.popularityBracket.anyOf[1]null はい
$.oneOf[0].allOf[1].Payload.pricingContext.daysNoticeinteger はい
$.oneOf[0].allOf[1].Payload.pricingContext.observedAtstring はい
$.oneOf[0].allOf[1].Payload.isCheckoutQuote = false はい
$.oneOf[0].allOf[1].Payload.additionalFeesMayApply = true はい
$.oneOf[0].allOf[1].Payload.guaranteesAvailability = false はい
$.oneOf[0].allOf[1].Payload.canPlaceBid = false はい
$.oneOf[1]object はい
$.oneOf[1].RequestUserAliasstring はい
$.oneOf[1].RequestPathstring | null はい
$.oneOf[1].RequestStatus = "Failed" はい
$.oneOf[1].ResponseCodeinteger はい
$.oneOf[1].ResponseMessageAPIResponseMessage はい
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null はい
$.oneOf[1].ResponseMessage.oneOf[1]array はい
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage いいえ
$.oneOf[1].ResponseMessage.oneOf[2]object はい
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage いいえ
$.oneOf[1].RequestImpersonatedByUserAliasstring いいえ
レスポンス例
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/discovery/get_reservation_pricing",
    "RequestUserAlias": "example-user",
    "Payload": {
        "location": {
            "alias": "synthetic-example",
            "name": "synthetic-example",
            "url": "synthetic-example",
            "timezone": "synthetic-example",
            "timezoneSource": "location_configuration"
        },
        "inventory": {
            "id": 0,
            "name": "synthetic-example",
            "priceIncludesService": false
        },
        "request": {
            "date": "2030-01-15",
            "endDate": "2030-01-15",
            "startHour": 0,
            "endHour": 0,
            "endHourExclusive": true,
            "timeRangeUnit": "Hour",
            "timeRangeUnits": 0
        },
        "availability": {
            "status": "restricted",
            "matchingListingCount": 0,
            "resultSetComplete": false,
            "lowestAskingPriceMinor": 0,
            "currency": "USD",
            "listings": [],
            "observedAt": "2030-01-01T12:00:00Z"
        },
        "estimate": {
            "currency": "USD",
            "amountMinor": 0,
            "lowAmountMinor": null,
            "highAmountMinor": null,
            "source": "external_reference",
            "sampleCount": 0,
            "sameLocationSampleCount": null,
            "inventoryMatch": "exact",
            "priceFactor": null,
            "requestedDurationMatched": true,
            "isHistoricalEvidence": false,
            "isGuaranteed": false,
            "scope": "recorded_provider_rates_for_requested_dates",
            "requiresLiveProviderConfirmation": true
        },
        "pricingContext": {
            "popularityBracket": 0,
            "daysNotice": 0,
            "observedAt": "2030-01-01T12:00:00Z"
        },
        "isCheckoutQuote": false,
        "additionalFeesMayApply": true,
        "guaranteesAvailability": false,
        "canPlaceBid": false
    }
}
機械可読のエンドポイントドキュメント