新增訂單項目摘要動作

此輸入是類別 runtime_commerce_oms.AddOrderItemSummaries 中 Apex 定義的變數。

如需有關設定輸入資料的資訊，請參閱此主題的「用途」區段。

該變數有一個欄位：newItems。此欄位是類別 runtime_commerce_oms.AddItem 中一或多個 Apex 定義的變數清單。其中每個變數皆包含以下欄位。

• orderItemSummary — 代表要新增之訂單產品的訂單產品摘要記錄變數。
• reasonCode — 新增的原因。此值為必要值,才能比對「訂單產品摘要變更」物件其「原因」欄位中的其中一個選項清單值。
• orderItemTaxLineItemSummaries — 與訂單產品摘要相關聯的零或多個訂單產品稅金條列項目摘要記錄變數的清單。
• orderItemAdjustmentLineSummaries — 類別 runtime_commerce_oms.AddItemAdjustment 中零或更多 Apex 定義的變數清單,其中包含以下欄位。
  • orderItemAdjustmentLineSummary — 與新增之訂單產品相關的訂單產品調整條列摘要訂單變數清單。
  • orderItemTaxLineItemSummaries — 與訂單產品調整條列摘要相關聯的零或多個訂單產品稅金條列項目摘要記錄清單。

此輸出是類別 ConnectApi.AddOrderItemSummaryOutputRepresentation 中 Apex 定義的變數。包括這些欄位。

changeBalances 欄位中值的符號與變更訂單記錄中的對應值相反。例如，折扣在 changeBalances 中為正值，但在變更訂單記錄中為負值。

• changeBalances — 類別 ConnectApi.ChangeItemOutputRepresentation 中 Apex 定義的變數,其中包含以下欄位。
  • grandTotalAmount - 變更為含稅總計。
  • totalAdjDeliveryAmtWithTax - 變更為調整後的遞送小計 (含稅)。
  • totalAdjDistAmountWithTax - 變更為訂單調整額總計 (含稅)。
  • totalAdjProductAmtWithTax - 變更為調整後的產品小計 (含稅)。
  • totalAdjustedDeliveryAmount - 變更為調整後遞送小計。
  • totalAdjustedDeliveryTaxAmount - 變更為調整後遞送小計的稅額。
  • totalAdjustedProductAmount - 變更為調整後產品小計。
  • totalAdjustedProductTaxAmount - 變更為調整後產品小計的稅額。
  • totalAdjustmentDistributedAmount - 變更為訂單調整額總計。
  • totalAdjustmentDistributedTaxAmount - 變更為訂單調整額總計的稅額。
  • totalAmount - 變更為稅前總計。
  • totalExcessFundsAmount - 與訂單摘要相關之訂單付款摘要中的可用超額基金金額。該金額等於以退款形式欠債，但與發票或貸項憑單無關的擷取金額。超額基金通常在履行之前，但在擷取付款之後取消訂單產品時發生。這種情況在美國並不常見，在美國，基金通常會經過授權，但在履行流程開始之前不會擷取。此值包含與訂單摘要相關的所有超額基金，而不僅包含與目前動作相關的基金。
  • totalRefundableAmount - 可退款的總金額。這是超額基金與套用至履行後變更之任何未清變更訂單總計金額的總和。此值包含與訂單摘要相關的所有可退還金額，而不僅包含與目前動作相關的金額。
  • totalRequiredFundsAmount — 與在目前動作中新增訂單產品相關聯的總金額。

    此金額並不一定是所需的數量。例如，在偶有更換流程中，取消更換產品的訂單金額減少會減去取代產品的必要基金金額。

  • totalTaxAmount — 變更為稅金總計。
• changeOrderId — 動作產生的變更訂單識別碼。
• newItems — 類別 ConnectApi.AddItemOutputRepresentation 中一或多個 Apex 定義的變數清單,每個變數皆代表新增的訂單產品,且具有以下欄位。
  • id — 訂單產品摘要的識別碼。
  • name — 訂單產品摘要的名稱。
  • orderItemAdjustmentLineSummaries — 類別 ConnectApi.AddItemAdjustmentOutputRepresentation 中零或更多 Apex 定義的變數清單,每個變數皆代表與新增的訂單產品摘要相關聯的訂單產品調整條列摘要,且具有以下欄位。
    • id — 訂單產品調整條列摘要的識別碼。
    • name — 訂單產品調整條列摘要的名稱。
    • orderItemTaxLineItemSummaries — 類別 ConnectApi.AddItemTaxOutputRepresentation 中零或更多 Apex 定義的變數清單,每個變數皆代表與訂單產品調整條列摘要相關聯的訂單產品稅額條列項目摘要,且具有以下欄位。
      • id — 訂單產品稅金條列項目摘要的識別碼。
      • name — 訂單產品稅金條列項目摘要名稱。
  • orderItemTaxLineItemSummaries — 類別 ConnectApi.AddItemTaxOutputRepresentation 中零或更多 Apex 定義的變數清單,每個變數皆代表與新增的訂單產品摘要相關聯的訂單產品稅額條列項目摘要,且具有以下欄位。
    • id — 訂單產品稅金條列項目摘要的識別碼。
    • name — 訂單產品稅金條列項目摘要名稱。
• orderSummaryId — 輸入中指定的訂單摘要識別碼。