修改政策

總覽

此 API 可讓您定義 條件相符,例如調整價格或啟用退款功能。 與只能套用的 Promotions API 不同 符合資格的促銷活動,提供最低折扣,這個 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 訊息包含下列元素和 屬性:

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

注意:如果您的後端 多個帳戶,這個值必須符合 ID<RequestorID> 中指定的屬性值 加入 <OTA_HotelRateAmountNotifRQ> 和 有 <OTA_HotelAvailNotifRQ> 則相同訊息 讓他們使用服務帳戶

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。這個值必須符合 使用 指定飯店 ID <listing> 元素中的 <id> 自動擷取廣告飯店 ID 也會列在 Hotel Center 中。
RateModifications / HotelRateModifications / @action 0..1 enum

如果未指定 action,則修改內容 已為這間飯店新增或更新如果 已指定 action="overlay",則所有先前定義的項目 系統會先刪除對這間飯店的修改內容。然後修改 這裡所指定的文字如果使用 action="overlay",且 這個元素中並未指定任何修改內容,那麼 這間飯店的修改內容已刪除。

RateModifications / HotelRateModifications / ItineraryRateModification 0..200 ItineraryRateModification

針對房源的單一費率修改作業。

注意:費率修改很難偵錯, 建議您謹慎使用請與客戶技術顧問 (TAM) 聯絡,瞭解以下事項: 需修改超過 200 個費率

RateModifications / HotelRateModifications / ItineraryRateModification / @id 1 string 修改費率的專屬 ID。每個 Pod 的 上限為 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 與費率規範定義中的費率規範不符 檔案即視為不符合資格。
,瞭解如何調查及移除這項存取權。 請參閱 這篇文章,瞭解不同不公開費率使用者介面的相關資訊 療法
RateModifications / HotelRateModifications / ItineraryRateModification / ModificationActions / Refundable 0..1 Refundable 將費率的可退款性覆寫為指定值。

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

  • 這項修改操作會完全重寫符合資格的費率「可退款」 設定,而不只是自動填入的欄位。
  • 如果 availablerefundable_until_days 為 如未設定,費率會顯示為可退款。
  • 如果 available0false, 其他屬性都會被忽略。費率不會顯示 但可以退還。
  • 建議設定 refundable_until_time;如果不是 設定時,會使用最早 (午夜) 的時間。
RateModifications / HotelRateModifications / ItineraryRateModification / ModificationActions / Refundable / @available 1 boolean (必要) 設為「1」或 true 表示費率是否允許 退款;否則設為 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 值 顯示在交易 (資源資料) 訊息中,以及 RatePlanCode 屬性 兩者皆有 <StatusApplicationControl> <OTA_HotelRateAmountNotifRQ><OTA_HotelAvailNotifRQ> 訊息。 長度上限為 50 個半形字元。
RateModifications / HotelRateModifications / ItineraryRateModification / RoomTypes 0..1 RoomTypes 用來裝載適用費率調整的房型清單的容器。 費率調整會套用至每個<RoomType> 。如未指定 <RoomTypes>, 費率調整會套用至所有客房。
RateModifications / HotelRateModifications / ItineraryRateModification / RoomTypes / RoomType 1..n RoomType 指定房間類型。房間類型的定義是在 中的 <RoomData> 元素 「交易 (資源資料)」訊息,以及 使用其 <RoomID> 值參照。( <RoomID> 值也會由 OTA_HotelRateAmountNotifRQ 中的 InvTypeCode 屬性 messages.)
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 訊息包含下列內容 元素與屬性:

元素 / @屬性 發生次數 類型 說明
RateModifications 1 Complex element 表示接收端成功或問題的根元素 評分修改要求訊息。
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 用來存放處理 評分修改訊息。

<Success><Issues> 為 。

RateModificationsResponse / Issues / Issue 1..n Issue 出現警告、錯誤或失敗情形的說明 處理 RateModifications 訊息這些問題的詳情 已在動態饋給狀態錯誤中找到 訊息
RateModificationsResponse / Issues / Issue / @code 1 integer 問題的 ID。
RateModificationsResponse / Issues / Issue / @status 1 enum

遇到的問題類型。

有效值為 warningerror、 和 failure

範例

成功

以下為回應成功處理的 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>