修改政策

總覽

讓您定義如何在符合條件時動態對費率套用動作,例如調整價格或啟用退款功能。與 Promotions API 不同,後者僅適用於套用最低折扣的合格促銷活動,但會在符合特定條件時套用任何動作,包括可能會大幅提高最終價格的價格調整。

要求數量

語法

RateModifications 訊息使用下列語法:

<?xml version="1.0" encoding="UTF-8"?>
<RateModifications partner="partner_key"
                      id="message_ID"
                      timestamp="timestamp">
  <HotelRateModifications hotel_id="HotelID" action="[overlay]">
    <ItineraryRateModification id="ModificationID" action="[delete]">
      <BookingDates>
        <DateRange start="YYYY-MM-DD" end="YYYY-MM-DD" days_of_week=""MTWHFSU_or_subset""/>
        <DateRange start="YYYY-MM-DD" end="YYYY-MM-DD" days_of_week=""MTWHFSU_or_subset""/>
      </BookingDates>
      <BookingWindow min="integer" max="integer"/>
      <CheckinDates>
        <DateRange start="YYYY-MM-DD" end="YYYY-MM-DD" days_of_week=""MTWHFSU_or_subset""/>
      </CheckinDates>
      <CheckoutDates>
        <DateRange start="YYYY-MM-DD" end="YYYY-MM-DD" days_of_week=""MTWHFSU_or_subset""/>
      </CheckoutDates>
      <Devices>
        <Device type="[desktop|tablet|mobile]"/>
      </Devices>
      <LengthOfStay min="integer" max="integer"/>
      <MinimumAmount before_discount="integer"/>
      <RatePlans>
        <RatePlan id="PackageID_1"/>
        <RatePlan id="PackageID_2"/>
      </RatePlans>
      <RoomTypes>
        <RoomType id="RoomID_1"/>
        <RoomType id="RoomID_2"/>
      </RoomTypes>
      <StayDates application="[all|any]">
        <DateRange start="YYYY-MM-DD" end="YYYY-MM-DD" days_of_week=""MTWHFSU_or_subset""/>
      </StayDates>
      <UserCountries type="[include|exclude]">
        <Country code="country_code"/>
      </UserCountries>
      <ModificationActions>
        <PriceAdjustment multiplier="float"/>
        <RateRule id="RateRuleID"/>
        <Refundable available="[false|true]"
                       refundable_until_days="number_of_days"
                       refundable_until_time="time"/>
        <Availability status="[unavailable]"/>
      </ModificationActions>
    </ItineraryRateModification>
  </HotelRateModifications>
</RateModifications>

元素和屬性

RateModifications 訊息包含下列元素和屬性:

元素 / @Attribute 發生次數 類型 說明
RateModifications 1 Complex element 費率調整訊息的根元素。
RateModifications / @partner 1 string 這則訊息的合作夥伴帳戶。這個字串值是 Hotel Center 的 帳戶設定頁面列出的「合作夥伴金鑰」值。

注意:如果您的後端會為多個帳戶提供動態饋給,則這個值必須與同一個帳戶的 <OTA_HotelRateAmountNotifRQ><OTA_HotelAvailNotifRQ> 訊息中指定的 ID 屬性值相符。<RequestorID>

RateModifications / @id 1 string 此要求訊息的專屬 ID。這個值會在回應訊息中傳回。允許的字元為 a-z、A-Z、0-9、_ (底線) 和 - (破折號)。
RateModifications / @timestamp 1 DateTime 建立這則訊息的日期和時間。
RateModifications / HotelRateModifications 0..n HotelRateModifications

修改房源的費率。每項費率調整都套用至單一屬性。

注意:如果系統可對相同費率套用多個費率修改,系統就會套用所有修改內容。不保證會依照特定順序排列。

RateModifications / HotelRateModifications / @hotel_id 1 string 房源的專屬 ID。這個值必須與飯店清單動態饋給中 <listing> 元素中 <id> 指定的飯店 ID 相符。Hotel Center 中也會顯示飯店 ID。
RateModifications / HotelRateModifications / @action 0..1 enum

如未指定 action,系統會為這間飯店新增或更新這個元素內的修改內容。如果指定 action="overlay",系統會先刪除這間飯店先前所有定義的修改項目。然後寫入此處指定的修改內容。如果使用 action="overlay",且這個元素內未指定任何修改項目,則系統會刪除這間飯店的所有修改項目。

RateModifications / HotelRateModifications / ItineraryRateModification 0..200 ItineraryRateModification

房源的單次費率修改。

注意:修改費率的做法難以偵錯,因此建議謹慎使用。如果需要使用超過 200 項費率調整,請與客戶技術顧問 (TAM) 聯絡。

RateModifications / HotelRateModifications / ItineraryRateModification / @id 1 string 費率修改的專屬 ID。允許的字元數上限為 40 個字元。允許的字元為 a-z、A-Z、0-9、_ (底線)、- (破折號) 和 。(半形句號)。
RateModifications / HotelRateModifications / ItineraryRateModification / @action 0..1 enum

如未指定,系統不會儲存具有相同 id 的費率修改內容,並儲存這項費率修改內容。 否則,如未指定,系統會儲存具有相同 id 的費率修改內容,然後更新現有的費率修改內容。

指定的值必須為 "delete"。如果指定 "delete",系統會刪除具有相同 id 的儲存費率修改內容。使用 "delete" 時,請勿在 <ItineraryRateModification> 中加入任何子元素。此外,"delete" 也不會與 <HotelRateModifications action="overlay"/> 搭配使用。

RateModifications / HotelRateModifications / ItineraryRateModification / BookingDates 0..1 BookingDates 用來定義預訂時間的一或多個日期範圍的容器,系統才能套用費率修改內容。
RateModifications / HotelRateModifications / ItineraryRateModification / BookingDates / DateRange 1..99 DateRange 指定必須執行預訂時間的日期範圍,才能套用費率修改。
RateModifications / HotelRateModifications / ItineraryRateModification / BookingDates / DateRange / @start 0..1 Date 日期範圍的開始日期 (以資源的時區為準)。這個日期必須早於或等於 end 日期。如未指定 start,那麼在開始日期內,日期範圍實際上都沒有限制。
RateModifications / HotelRateModifications / ItineraryRateModification / BookingDates / DateRange / @end 0..1 Date 日期範圍的結束日期 (以資源的時區為準)。這個日期必須與 start 日期相同,或晚於。如未指定 end,則在結束日期方面不會有限制的日期範圍。
RateModifications / HotelRateModifications / ItineraryRateModification / BookingDates / DateRange / @days_of_week 0..1 string

日期範圍內允許的星期幾。如果未指定,則允許在日期範圍內全天設定。字串中的每個字元都會指定日期。例如,「MTWHF」會指定日期範圍內允許的平日。

有效的字元包括:

  • M (星期一)
  • T 代表星期二
  • W (星期三)
  • H 代表星期四
  • F 代表星期五
  • S 代表星期六
  • U 代表週日

任何字元組合都有效。

RateModifications / HotelRateModifications / ItineraryRateModification / BookingWindow 0..1 BookingWindow 指定必須依據入住日期 (以房源的時區為準) 指定預訂的時間範圍。例如,預訂期可設為至少 7 天,但不能超過 180 天 (也就是入住前)。
RateModifications / HotelRateModifications / ItineraryRateModification / BookingWindow / @min 0..1 integer 入住日期的最短天數過後,系統才會套用修改房價。如未指定,則沒有下限。
RateModifications / HotelRateModifications / ItineraryRateModification / BookingWindow / @max 0..1 integer 你必須在預訂入住前的最長天數內,才套用價格修改內容。如未指定,則沒有上限。
RateModifications / HotelRateModifications / ItineraryRateModification / CheckinDates 0..1 CheckinDates 用來定義入住時間的一或多個日期範圍的容器,系統必須執行修改費率才能套用費率修改。
RateModifications / HotelRateModifications / ItineraryRateModification / CheckinDates / DateRange 1..99 DateRange 指定必須入住時間的日期範圍,才能套用費率修改。如果刪除一或多個費率修改,則不需要這個元素。
RateModifications / HotelRateModifications / ItineraryRateModification / CheckinDates / DateRange / @start 0..1 Date 日期範圍的開始日期 (以資源的時區為準)。這個日期必須早於或等於 end 日期。如未指定 start,那麼在開始日期內,日期範圍實際上都沒有限制。
RateModifications / HotelRateModifications / ItineraryRateModification / CheckinDates / DateRange / @end 0..1 Date 日期範圍的結束日期 (以資源的時區為準)。這個日期必須與 start 日期相同,或晚於。如未指定 end,則在結束日期方面不會有限制的日期範圍。
RateModifications / HotelRateModifications / ItineraryRateModification / CheckinDates / DateRange / @days_of_week 0..1 string

日期範圍內允許的星期幾。如果未指定,則允許在日期範圍內全天設定。字串中的每個字元都會指定日期。例如,「MTWHF」會指定日期範圍內允許的平日。

有效的字元包括:

  • M (星期一)
  • T 代表星期二
  • W (星期三)
  • H 代表星期四
  • F 代表星期五
  • S 代表星期六
  • U 代表週日

任何字元組合都有效。

RateModifications / HotelRateModifications / ItineraryRateModification / CheckoutDates 0..1 CheckoutDates 用來定義退房時間的一或多個日期範圍的容器,才能套用費率修改資料。
RateModifications / HotelRateModifications / ItineraryRateModification / CheckoutDates / DateRange 1..99 DateRange 必須指定退房時間的日期範圍,才能套用費率修改。如果刪除一或多個費率修改,則不需要這個元素。
RateModifications / HotelRateModifications / ItineraryRateModification / CheckoutDates / DateRange / @start 0..1 Date 日期範圍的開始日期 (以資源的時區為準)。這個日期必須早於或等於 end 日期。如未指定 start,那麼在開始日期內,日期範圍實際上都沒有限制。
RateModifications / HotelRateModifications / ItineraryRateModification / CheckoutDates / DateRange / @end 0..1 Date 日期範圍的結束日期 (以資源的時區為準)。這個日期必須與 start 日期相同,或晚於。如未指定 end,則在結束日期方面不會有限制的日期範圍。
RateModifications / HotelRateModifications / ItineraryRateModification / CheckoutDates / DateRange / @days_of_week 0..1 string

日期範圍內允許的星期幾。如果未指定,則允許在日期範圍內全天設定。字串中的每個字元都會指定日期。例如,「MTWHF」會指定日期範圍內允許的平日。

有效的字元包括:

  • M (星期一)
  • T 代表星期二
  • W (星期三)
  • H 代表星期四
  • F 代表星期五
  • S 代表星期六
  • U 代表週日

任何字元組合都有效。

RateModifications / HotelRateModifications / ItineraryRateModification / Devices 0..1 Devices 用來列出符合費率修改資格的使用者裝置的容器。如果有指定,則只有在使用者符合其中一部裝置時,系統才會套用費率調整。如未指定,則不會限制套用費率調整。
RateModifications / HotelRateModifications / ItineraryRateModification / Devices / Device 1..3 Device 定義符合費率修改條件的使用者裝置類型。
RateModifications / HotelRateModifications / ItineraryRateModification / Devices / Device / @type 1 enum 裝置類型。值必須是 desktoptabletmobile
RateModifications / HotelRateModifications / ItineraryRateModification / ModificationActions 1 ModificationActions

符合所有指定條件時,套用至費率的動作。

RateModifications / HotelRateModifications / ItineraryRateModification / ModificationActions / PriceAdjustment 0..1 PriceAdjustment AmountBeforeTaxAmountAfterTax 乘以指定調節係數,來修改費率
RateModifications / HotelRateModifications / ItineraryRateModification / ModificationActions / PriceAdjustment / @multiplier 1 float AmountBeforeTaxAmountAfterTax 都會乘以這個值。
RateModifications / HotelRateModifications / ItineraryRateModification / ModificationActions / RateRule 0..1 RateRule 套用指定費率規範 ID 來修改費率。
RateModifications / HotelRateModifications / ItineraryRateModification / ModificationActions / RateRule / @id 1 string 這個 ID 與費率規範定義檔案中的費率相符。注意:
  • 這個欄位的字元限制為 40 個字元。
  • 每個費率只能與一項費率規範建立關聯。
  • 如果多項修改內容套用了費率規範 ID,則費率在字母順序最小的費率規範 ID 會指派給費率。
  • 如果這個 ID 與費率規範定義檔案中的費率規範不符,系統就會將該 ID 視為不符合資格。
如要瞭解不同的不公開費率 UI 處理方式,請參閱 這篇文章
RateModifications / HotelRateModifications / ItineraryRateModification / ModificationActions / Refundable 0..1 Refundable 將費率的可退款性覆寫為指定值。

設定屬性時,請注意下列事項:

  • 這項修改動作會完全重寫合格費率的「可退款」設定,而不只是已填入的欄位。
  • 如未設定 availablerefundable_until_days,該費率就不會顯示為可退款。
  • 如果 available0false,系統會忽略其他屬性。即使設定了其中一種其他屬性或兩項屬性,該費率也不會顯示為可退款。
  • 建議設定 refundable_until_time;如未設定,則會使用最早的時間 (午夜)。
RateModifications / HotelRateModifications / ItineraryRateModification / ModificationActions / Refundable / @available 1 boolean (必要) 設為 1true 來表示費率是否允許全額退款;否則請設為 0false
Transaction / PropertyDataSet / PackageData / Refundable / @refundable_until_days 0..1 integer (如果 availabletrue,則為必填) 指定可在入住前要求全額退款的天數。refundable_until_days 的值必須是介於 0 至 330 (含首尾) 之間的整數。
RateModifications / HotelRateModifications / ItineraryRateModification / ModificationActions / Refundable / @refundable_until_time 0..1 Time (若 availabletrue,則建議使用)這個項目可以和 refundable_until_days 合併以指定,例如「退款期限為兩天的下午 4:00 至入住前」。如未設定 refundable_until_time,則預設值為午夜。
RateModifications / HotelRateModifications / ItineraryRateModification / ModificationActions / Availability 0..1 Availability 將房價的供應情形覆寫為指定值。 我們只支援將房價設為 unavailable
RateModifications / HotelRateModifications / ItineraryRateModification / ModificationActions / Availability / @status 1 enum 如果設為 status="unavailable",系統會將費率視為無法取得,無論其是否具備有效價格。
RateModifications / HotelRateModifications / ItineraryRateModification / LengthOfStay 0..1 LengthOfStay 定義可套用這項房價調整的入住天數限制。如果入住天數超過下限和上限,系統就不會套用費率調整。
RateModifications / HotelRateModifications / ItineraryRateModification / LengthOfStay / @min 0..1 integer 要套用費率修改條件的住宿晚數下限。如未指定,則沒有最低限制。
RateModifications / HotelRateModifications / ItineraryRateModification / LengthOfStay / @max 0..1 integer 要套用費率修改條件的住宿晚數上限。如果未指定,則沒有上限。
RateModifications / HotelRateModifications / ItineraryRateModification / MinimumAmount 0..1 MinimumAmount 指定每日房價的下限總和 (使用 AmountBeforeTaxAmountAfterTax 較大的值),因為這個值必須超過這個上限,才能套用費率修改。
RateModifications / HotelRateModifications / ItineraryRateModification / MinimumAmount / @before_discount 1 integer 必須超過這個值才能套用費率修改結果。
RateModifications / HotelRateModifications / ItineraryRateModification / RatePlans 0..1 RatePlans 用於容器,提供費率修改適用的費率方案清單。如未指定 <RatePlans>,則費率調整會套用至所有費率方案。
RateModifications / HotelRateModifications / ItineraryRateModification / RatePlans / RatePlan 1..n RatePlan 指定費率方案。費率方案是由交易 (房源資料)、OTA_HotelRateAmountNotifRQ 和 OTA_HotelAvailNotifRQ 訊息定義,並由 PackageID 指定。
RateModifications / HotelRateModifications / ItineraryRateModification / RatePlans / RatePlan / @id 1 string 費率方案的專屬 ID。這個值對應至交易 (資源資料) 訊息中 <PackageData> 的 PackageID 值,以及 <OTA_HotelRateAmountNotifRQ><OTA_HotelAvailNotifRQ> 訊息中 <StatusApplicationControl>RatePlanCode 屬性。最多 50 個字元。
RateModifications / HotelRateModifications / ItineraryRateModification / RoomTypes 0..1 RoomTypes 容器類型清單,指定要套用費率調整的房型。修改頻率會套用至每個指定的 <RoomType>。如果未指定 <RoomTypes>,系統會將房價調整設定套用至所有會議室。
RateModifications / HotelRateModifications / ItineraryRateModification / RoomTypes / RoomType 1..n RoomType 指定房間類型。您可在交易 (資源資料) 訊息的 <RoomData> 元素中定義房型,並使用其 <RoomID> 值進行參照。(OTA_HotelRateAmountNotifRQ 訊息的 InvTypeCode 屬性也會參照其 <RoomID> 值)。
RateModifications / HotelRateModifications / ItineraryRateModification / RoomTypes / RoomType / @id 1 string 廣告空間的專屬 ID (房間類型)。這個值會對應至交易 (資源資料) 訊息中的 <RoomID>。最多 50 個字元。
RateModifications / HotelRateModifications / ItineraryRateModification / StayDates 0..1 StayDates 包含一或多個日期範圍的容器,用於決定調整費率的套用方式,例如採用季節性價格。
RateModifications / HotelRateModifications / ItineraryRateModification / StayDates / @application 1 enum

說明如何套用費率調整。

以下為有效值:

  • all:如果行程中的「所有」日期與住宿日期重疊,則將費率調整套用至行程中的每個每晚。
  • any:如果行程中的任何日期與住宿日期範圍內的日期重疊,則將費率修改內容套用至行程中的所有住宿日期。

必須指定這個屬性。

RateModifications / HotelRateModifications / ItineraryRateModification / StayDates / DateRange 1..99 DateRange 指定日期,指定要套用費率修改的日期。
RateModifications / HotelRateModifications / ItineraryRateModification / StayDates / DateRange / @start 0..1 Date 日期範圍的開始日期 (以資源的時區為準)。這個日期必須早於或等於 end 日期。如未指定 start,那麼在開始日期內,日期範圍實際上都沒有限制。
RateModifications / HotelRateModifications / ItineraryRateModification / StayDates / DateRange / @end 0..1 Date 日期範圍的結束日期 (以資源的時區為準)。這個日期必須與 start 日期相同,或晚於。如未指定 end,則在結束日期方面不會有限制的日期範圍。
RateModifications / HotelRateModifications / ItineraryRateModification / StayDates / DateRange / @days_of_week 0..1 string

日期範圍內允許的星期幾。如果未指定,則允許在日期範圍內全天設定。字串中的每個字元都會指定日期。例如,「MTWHF」會指定日期範圍內允許的平日。

有效的字元包括:

  • M (星期一)
  • T 代表星期二
  • W (星期三)
  • H 代表星期四
  • F 代表星期五
  • S 代表星期六
  • U 代表週日

任何字元組合都有效。

RateModifications / HotelRateModifications / ItineraryRateModification / UserCountries 0..1 UserCountries 如有指定,則只有在使用者位於其中一個指定國家/地區時,系統才會套用費率調整。如未指定,無論使用者身在何處,系統都會套用費率修改。
RateModifications / HotelRateModifications / ItineraryRateModification / UserCountries / @type 0..1 enum UserCountry 規格類型。

有效值為 includeexclude

如果使用者國家/地區 type 設為 include,則費率調整會套用至所列國家/地區的使用者。

如果使用者國家/地區 typeexclude,則費率調整會套用至下列國家/地區以外的使用者。

如未設定 User countries type,系統會將其視為 include,對所列國家/地區的使用者套用費率修改。

RateModifications / HotelRateModifications / ItineraryRateModification / UserCountries / Country 1..300 Country 指定允許修改費率的使用者國家/地區。
RateModifications / HotelRateModifications / ItineraryRateModification / UserCountries / Country / @code 1 string CLDR 國家/地區代碼,例如 DEFR。請注意,在某些國家/地區,CLDR 國家/地區代碼與 2 個字母的 ISO 國家/地區代碼不同。此外,系統不支援 CLDR 區碼。

示例

基本訊息

以下範例為基本的 RateModifications` 訊息:

<?xml version="1.0" encoding="UTF-8"?>
<RateModifications partner="account_xyz"
                   id="123_abc"
                   timestamp="2023-05-22T16:20:00-04:00">
  <HotelRateModifications hotel_id="Property_1">
    <ItineraryRateModification id="1">
      <BookingDates>
         <DateRange start="2023-07-01" end="2023-07-31" days_of_week="MTWHF"/>
         <DateRange start="2023-09-01" end="2023-09-30"/>
      </BookingDates>
      <BookingWindow min="7" max="330"/>
      <CheckinDates>
         <DateRange start="2023-10-01" end="2023-10-31" days_of_week="FSU"/>
      </CheckinDates>
      <CheckoutDates>
         <DateRange start="2023-10-08" end="2023-11-07" days_of_week="FSU"/>
      </CheckoutDates>
      <Devices>
        <Device type="mobile"/>
        <Device type="tablet"/>
      </Devices>
      <LengthOfStay min="2" max="14"/>
      <RatePlans>
         <RatePlan id="234"/>
         <RatePlan id="567"/>
      </RatePlans>
      <RoomTypes>
         <RoomType id="123"/>
         <RoomType id="456"/>
      </RoomTypes>
      <UserCountries>
        <Country code="US"/>
        <Country code="GB"/>
      </UserCountries>
      <ModificationActions>
        <PriceAdjustment multiplier="1.2"/>
      </ModificationActions>
    </ItineraryRateModification>
  </HotelRateModifications>
</RateModifications>


刪除一項房價修改內容

以下範例說明如何刪除屬性的一次費率調整:

<?xml version="1.0" encoding="UTF-8"?>
<RateModifications partner="account_xyz"
                   id="123_abc"
                   timestamp="2023-05-22T16:20:00-04:00">
  <HotelRateModifications hotel_id="Property_1">
    <ItineraryRateModification id="1" action="delete"/>
  </HotelRateModifications>
</RateModifications>

刪除所有費率修改

以下範例說明如何刪除屬性的所有費率調整:

<?xml version="1.0" encoding="UTF-8"?>
<RateModifications partner="account_xyz"
                   id="123_abc"
                   timestamp="2023-05-22T16:20:00-04:00">
  <HotelRateModifications hotel_id="Property_1" action="overlay"/>
</RateModifications>


疊加所有費率修改

以下範例說明如何將屬性的 <HotelRateModifications> 與一或多項新的費率修改方式重疊。如果設為 action="overlay",系統會先刪除所有已儲存的費率修改,然後才能儲存目前訊息中指定的費率調整。

<?xml version="1.0" encoding="UTF-8"?>
<RateModifications partner="account_xyz"
                   id="123_abc"
                   timestamp="2023-05-22T16:20:00-04:00">
  <HotelRateModifications hotel_id="Property_1" action="overlay"/>
    <ItineraryRateModification id="1">
      <BookingDates>
         <DateRange start="2023-09-01" end="2023-09-30"/>
      </BookingDates>
      <ModificationActions>
        <PriceAdjustment multiplier="1.2"/>
      </ModificationActions>
      <RoomTypes>
         <RoomType id="123"/>
         <RoomType id="456"/>
      </RoomTypes>
      <RatePlans>
         <RatePlan id="234"/>
         <RatePlan id="567"/>
      </RatePlans>
    </ItineraryRateModification>
  </HotelRateModifications>
</RateModifications>

多項修改動作

以下範例說明如何一次執行多項修改動作:

<?xml version="1.0" encoding="UTF-8"?>
<RateModifications partner="account_xyz"
                   id="123_abc"
                   timestamp="2023-05-22T16:20:00-04:00">
  <HotelRateModifications hotel_id="Property_1">
    <ItineraryRateModification id="1">
      <BookingDates>
         <DateRange start="2023-01-01" end="2023-02-28"/>
      </BookingDates>
      <ModificationActions>
        <PriceAdjustment multiplier=".95"/>
        <Refundable available="true"
                    refundable_until_days="1"
                    refundable_until_time="12:00:00"/>
      </ModificationActions>
    </ItineraryRateModification>
  </HotelRateModifications>
</RateModifications>


關閉使用者國家/地區的費率方案

以下範例說明如何將費率方案限制為僅限日文 (JP) 使用者:

<?xml version="1.0" encoding="UTF-8"?>
<RateModifications partner="account_xyz"
                   id="123_abc"
                   timestamp="2023-05-22T16:20:00-04:00">
  <HotelRateModifications hotel_id="Property_1">
    <ItineraryRateModification id="1">
      <RatePlans>
         <RatePlan id="jp_only"/>
      </RatePlans>
      <UserCountries type="exclude">
        <Country code="JP"/>
      </UserCountries>
      <ModificationActions>
        <Availability status="unavailable"/>
      </ModificationActions>
    </ItineraryRateModification>
  </HotelRateModifications>
</RateModifications>


回應

語法

RateModificationsResponse 訊息使用下列語法:

<?xml version="1.0" encoding="UTF-8"?>
<RateModificationsResponse timestamp="timestamp"
                    id="message_ID"
                    partner="partner_key">
  <!-- Either Success or Issues will be populated. -->
  <Success/>
  <Issues>
    <Issue code="issue_code" status="issue_type"><var>issue_description</var></Issue>
  </Issues>
</RateModificationsResponse>

元素和屬性

RateModificationsResponse 訊息包含下列元素和屬性:

元素 / @Attribute 發生次數 類型 說明
RateModifications 1 Complex element 根元素代表收到 RateModifications 要求訊息的成功或問題。
RateModificationsResponse / @timestamp 1 DateTime 建立這則訊息的日期和時間。
RateModificationsResponse / @id 1 string 相關聯 RateModifications 訊息的專屬 ID。
RateModificationsResponse / @partner 1 string 這則訊息的合作夥伴帳戶。
RateModificationsResponse / Success 0..1 Success 表示 RateModifications 訊息已成功處理,且未出現警告、錯誤或失敗情形。

每則訊息中都含有 <Success><Issues>

RateModificationsResponse / Issues 0..1 Issues 用來裝載處理 RateModifications 訊息時發生一或多個問題的容器。

每則訊息中都含有 <Success><Issues>

RateModificationsResponse / Issues / Issue 1..n Issue 處理 RateModifications 訊息時發生的警告、錯誤或失敗說明。如要進一步瞭解這些問題,請參閱動態饋給狀態錯誤訊息一文。
RateModificationsResponse / Issues / Issue / @code 1 integer 問題的 ID。
RateModificationsResponse / Issues / Issue / @status 1 enum

問題類型。

有效值為 warningerrorfailure

示例

成功

以下是針對已順利處理的 RateModifications 訊息的回應。

<?xml version="1.0" encoding="UTF-8"?>
<RateModificationsResponse timestamp="2023-05-22T16:20:00-04:00"
                    id="12345678"
                    partner="partner_key">
  <Success/>
</RateModificationsResponse>

問題

以下是因發生錯誤而未處理 RateModifications 訊息的回應。

<?xml version="1.0" encoding="UTF-8"?>
<RateModificationsResponse timestamp="2023-05-22T16:20:00-04:00"
                    id="12345678"
                    partner="partner_key">
  <Issues>
    <Issue code="1001" status="error">Example</Issue>
  </Issues>
</RateModificationsResponse>