メインコンテンツにスキップ

【AirHost API】「Pricing API(料金更新)」実装の概要

T
対応者:Takashi Obatake
今日アップデートされました

1. 概要

Pricing API は、外部システムから AirHost の料金情報を取得・更新するための API です。

この API を利用することで、AirHost をハブとして複数の OTA(Airbnb、Booking.com など)への料金配信を一元管理することが可能になります。


2. 主な用途

  • 自社開発の料金最適化ロジック(RMS機能)との連携

  • 複数施設・複数部屋タイプの一括料金更新

  • 外部ツールによる料金コントロール


3. 提供機能

レートプラン関連

  • レートプラン一覧取得

  • レートプラン詳細取得

料金関連

  • 日付単位での料金取得

  • 日付単位での料金更新


4. 対応エンドポイント

🔹 料金関連(メイン機能)

  • GET /api/public/rate_plans

  • GET /api/public/rate_plans/{id}

  • GET /api/public/rate_plans/{id}/rates

  • PATCH /api/public/rates


🔹 施設・部屋タイプ情報(補助)

  • GET /api/public/properties

  • GET /api/public/properties/{id}

※ Pricing API が有効化されている施設・部屋タイプのみ返却されます。


5. 実装イメージ

Pricing API を利用する際は、AirHost API から取得した施設・部屋タイプ情報、レートプラン情報、日付ごとの料金情報を、外部システム側のデータベースに保存する形で実装してください。

API 経由で毎回リアルタイムに参照するのではなく、必要な情報を外部システム側で保持し、定期的な同期処理により AirHost 側の情報と連携する構成を推奨します。

🔁 データフローイメージ

⚠️ 実装上のポイント

  • 取得した施設・部屋タイプ情報、レートプラン情報、料金情報は外部システム側のローカルDBに保存してください

  • API 経由で都度リアルタイム参照する実装は推奨していません

  • 定期的な同期処理によりデータを更新してください


6. 処理手順

1. 施設・部屋タイプ情報を取得・保存する

  • GET /api/public/properties

  • GET /api/public/properties/{id}

取得したデータはローカルDBに保存します。


2. レートプラン情報を取得・保存する

  • GET /api/public/rate_plans

  • GET /api/public/rate_plans/{id}

どのレートプランを更新対象とするかを管理します。

3. 日付ごとの料金情報を取得・保存する

  • GET /api/public/rate_plans/{id}/rates

現在の料金情報を取得し、外部システム側で保持します。

4. 外部システムで料金を算出する

RMSや独自ロジックにより、需要・稼働状況などを元に料金を決定します。

5. 料金を更新する

  • PATCH /api/public/rates

更新対象の日付・料金を AirHost に送信します。

6. OTAへ料金が配信される

AirHost 上で更新された料金は、AirHost の通常処理により各 OTA へ同期・配信されます。


7. 設計方針・制限事項

本 API は、料金更新に特化したシンプルな設計となっています。

以下の機能は対象外です:

  • 在庫(inventory)の更新

  • 最低宿泊日数(Min Stay)

  • CTA / CTD

  • OTAごとの個別制御


8. API仕様

詳細なリクエスト・レスポンス仕様は以下をご参照ください:

こちらの回答で解決しましたか?