--- schema_version: "1" id: f6eb29f7030e08210b6e8dae54426c180c80a165a876aae5fec4f856fe8e8b2a title: Adjust Order Item Summaries Submit Action collection: admin version: current locale: en-us portal_url: https://docs.salesforce.com/admin/current/en-us/platform/264-0-0/flow_ref_elements_om_actions_adjust_ois_submit.md canonical_url: https://help.salesforce.com/s/articleView?id=platform.flow_ref_elements_om_actions_adjust_ois_submit.htm&release=264.0.0&type=5 source_site: help.salesforce.com content_type: documentation content_hash: 05bfc5caeff032cf0dccd4abaf0438f96f76e70ef81b1a93e4cceea9f062a39f description: In Salesforce Order Management, adjust the price of one or more order product summaries on an order summary. You can only apply a discount, not an increase. This action creates one or more change order records. products: - Flow Builder - Salesforce Platform release: "264" --- # Adjust Order Item Summaries Submit Action In Salesforce Order Management, adjust the price of one or more order product summaries on an order summary. You can only apply a discount, not an increase. This action creates one or more change order records. ### Required Editions
Available in: Lightning Experience
View supported editions.
This feature requires the Salesforce Order Management add-on. To purchase, contact your Salesforce account executive.
In Flow Builder, add an Action element to your flow. Select the **Order Management** category, and search for **Adjust Order Item Summaries Submit**. ## Set Input Values Use values from earlier in the flow to set the inputs.
Input Parameter Description
Order Summary Id ID of the order summary associated with the order product summaries that you want to adjust the prices of.
Adjust Order Product Summaries Input

This input is an Apex-defined variable of class ConnectApi.AdjustOrderItemSummaryInputRepresentation, which includes these fields:

  • adjustItems —This field is a list of Apex-defined variables of class ConnectApi.AdjustItemInputRepresentation. Each of the variables includes these fields:
    • orderItemSummaryId —ID of an order product summary to adjust the price of.
    • description —Optional description of the adjustment.
    • adjustmentType —Specifies how to calculate the adjustment amount from the discountValue field. It can have one of these values:
      • AmountTaxOnly—The value of discountValue is the tax-only adjustment only.
      • AmountWithTax—The value of discountValue is the adjustment, including tax.
      • AmountWithoutTax—The value of discountValue is the adjustment, not including tax. Tax is calculated on the value and added.
      • Percentage—The value of discountValue is a percentage discount. It’s divided by 100, and then multiplied by the total price and total tax amount of the order product summary to determine the adjustment amount.
      • ProductOnly—The value of discountValue is the product-only adjustment only.
    • amount —The value used to calculate the adjustment amount, as specified by the adjustmentType. It must be a negative value.
    • reason — Adjustment reason.The value must match one of the picklist values on the Reason field of the Order Product Summary Change object.
  • allocatedItemsChangeOrderType —Specifies how to create change orders for order product summary quantities that are currently being fulfilled, defined as QuantityAllocated - QuantityFulfilled. It can have one of these values:
    • Disallowed—When distributing the adjustment, ignore any quantities being fulfilled. If an order product summary’s entire quantity is being fulfilled, return an error. This value is the default.
    • InFulfillment—When distributing the adjustment, include quantities being fulfilled. Create a separate change order for the adjustments made to those quantities.
    • PreFulfillment—When distributing the adjustment, include quantities being fulfilled. Include the adjustments made to those quantities in the change order for pre-fulfillment quantity adjustments.
  • individualLineItemTaxAdjustments—Specifies whether to create multiple lines for each tax adjustment or one line with all tax adjustments. The default value is false.
## Store Output Values Use output values later in the flow. The values are assigned when the change orders are created.
Output Parameter Description
Adjust Order Product Summary Output

This output is an Apex-defined variable of class ConnectApi.AdjustOrderSummaryOutputRepresentation. Depending on the order product summaries included in the adjustment, one or more change orders are generated. If multiple change orders are generated, then the changeBalances values combine the values from both of them.

The sign of a value in the changeBalances field is the opposite of the corresponding value on a change order record. For example, a discount is a positive value in changeBalances and a negative value on a change order record.

The orderSummaryId field is the ID of the order summary specified in the input.

The changeBalances field is an Apex-defined variable of class ConnectApi.ChangeItemOutputRepresentation, which includes these fields.

  • grandTotalAmount —Change to the total with tax.
  • totalAdjDeliveryAmtWithTax —Change to the adjusted delivery subtotal, including tax.
  • totalAdjDistAmountWithTax —Change to the total order adjustments, including tax.
  • totalAdjProductAmtWithTax —Change to the adjusted product subtotal, including tax.
  • totalAdjustedDeliveryAmount —Change to the adjusted delivery subtotal.
  • totalAdjustedDeliveryTaxAmount —Change to the adjusted delivery subtotal tax.
  • totalAdjustedProductAmount —Change to the adjusted product subtotal.
  • totalAdjustedProductTaxAmount —Change to the adjusted product subtotal tax.
  • totalAdjustmentDistributedAmount —Change to the total order adjustments.
  • totalAdjustmentDistributedTaxAmount —Change to the total order adjustments tax.
  • totalAmount —Change to the pretax total.
  • totalExcessFundsAmount —The amount of excess funds available on the order payment summaries related to the order summary. It’s equal to the captured amount that is owed as a refund but isn’t associated with an invoice or credit memo. Excess funds normally occur when order products are canceled before fulfillment but after payment has been captured. This situation isn’t common in the US, where funds are normally authorized but not captured until the fulfillment process begins. This value includes all excess funds related to the order summary, not only the funds related to the current action.
  • totalRefundableAmount —The total amount available to be refunded. It’s the sum of the excess funds and any outstanding change order grand total amounts that apply to post-fulfillment changes. This value includes all refundable amounts related to the order summary, not only the amount related to the current action.
  • totalTaxAmount —Change to the total tax.

The postFulfillmentChangeOrderId is the ID of the change order representing the portion of the adjustment that was applied to order product summary quantities that have been fulfilled.

The preFulfillmentChangeOrderId is the ID of the change order representing the portion of the adjustment that was applied to order product summary quantities that haven’t been fulfilled. If the input specified an allocatedItemsChangeOrderType of PreFulfillment, this change order also includes the changes applicable to order product summary quantities that are in the process of being fulfilled.

The inFulfillmentChangeOrderId is the ID of the change order representing the portion of the adjustment that was applied to order product summary quantities that are in the process of being fulfilled. This change order is only created for an input that specified an allocatedItemsChangeOrderType of InFulfillment.

## Usage When a price adjustment is applied to an order product summary, its quantities are considered in three groups: - Pre-fulfillment—QuantityAvailableToFulfill, which is equal to QuantityOrdered - QuantityCanceled - QuantityAllocated - In-fulfillment—QuantityAllocated - QuantityFulfilled - Post-fulfillment—QuantityAvailableToReturn, which is equal to QuantityFulfilled - QuantityReturnInitiated You can apply adjustments to these groups in three different ways, controlled by the **allocatedItemsChangeOrderType** input property: - Distribute the adjustment evenly between pre-fulfillment and post-fulfillment quantities. Ignore in-fulfillment quantities. Create one change order for the adjustments to pre-fulfillment quantities and one change order for the adjustments to post-fulfillment quantities. - Distribute the adjustment evenly between pre-fulfillment, in-fulfillment, and post-fulfillment quantities. Create one change order for the adjustments to both pre-fulfillment and in-fulfillment quantities, and one change order for the adjustments to post-fulfillment quantities. - Distribute the adjustment evenly between pre-fulfillment, in-fulfillment, and post-fulfillment quantities. Create one change order for the adjustments to pre-fulfillment quantities, one change order for the adjustments to in-fulfillment quantities, and one change order for the adjustments to post-fulfillment quantities. To set up the Adjust Order Product Summaries Input: - Use Assignment elements to set the **orderItemSummaryId**, **description**, **adjustmentType**, **discountValue**, and **reason** field values on one or more **ConnectApi.AdjustItemInputRepresentation** variables. - Use an Assignment element to add the **ConnectApi.AdjustItemInputRepresentation** variables to the **changeItems** field on a **ConnectApi.AdjustOrderItemSummaryInputRepresentation** variable. - Use an Assignment element to set the **allocatedItemsChangeOrderType** field on the **ConnectApi.AdjustOrderItemSummaryInputRepresentation** variable. - Use the **ConnectApi.AdjustOrderItemSummaryInputRepresentation** variable and the order summary ID in the action input. In a flow for adjusting the prices of order product summaries, run an Adjust Order Item Summaries Preview action before running this action. Then display its output for the user to review. When the user verifies the expected results, pass the same input to this action. After submitting a price adjustment, process refunds as appropriate: - If the discount only applied to order product summaries for which payment hasn’t been captured, it doesn’t require a refund. This situation normally applies to order products in the US that haven’t been fulfilled. - If the discount applied to order product summaries that haven’t been fulfilled and for which payment has been captured, process a refund. In this case, pass the **totalExcessFundsAmount** from **changeBalances** to the Ensure Refunds Async action. - If the discount applied to order product summaries that have been fulfilled, process a refund. Pass the **postFulfillmentChangeOrderId** to the Create Credit Memo action, then pass the credit memo to the Ensure Refunds Async action. - If the discount applied to both fulfilled and unfulfilled order product summaries for which payment has been captured, process both refunds. Pass the **postFulfillmentChangeOrderId** to the Create Credit Memo action, then pass the credit memo and the **totalExcessFundsAmount** from **changeBalances** to the Ensure Refunds Async action. ![Important](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-platform-platform_automation-264-0-0-production-enus/60568438-ec7e-4665-acd1-7c80dcbe60d5/images/icon_important.png) Important Excess funds aren’t reduced until the payment processor issues a refund. If you don’t process refunds promptly, subsequent refunds can be inaccurate. Consider this example. - An order with a total amount of $100 is placed, and the amount is captured immediately. - A product is canceled from the order, resulting in $20 of excess funds. - Before the excess funds are sent to the payment provider in an ensure refunds action, another product is canceled. This cancellation adds another $20 of excess funds. However, because the original $20 hasn’t been refunded yet, the cancel action returns a total excess funds amount of $40. - The first excess funds amount ($20) is sent to the payment provider in an ensure refunds request. - The second excess funds amount ($40) is sent to the payment provider in an ensure refunds request. - The payment provider receives requests for $60 of refunds, when the correct refund total is $40. Because the total refund amount is less than the total captured amount of $100, the payment provider issues $60 in refunds. #### See Also - [Adjust Order Item Summaries Preview Action](https://help.salesforce.com/s/articleView?id=platform.flow_ref_elements_om_actions_adjust_ois_preview.htm&release=264.0.0&type=5 "In Salesforce Order Management, preview the expected results of adjusting the price of one or more order product summaries on an order summary, without running the adjustment. You can only apply a discount, not an increase. The output of this action contains the values that would be set on the change orders created by submitting the proposed adjustment.") - [Add and Edit Elements](https://help.salesforce.com/s/articleView?id=platform.flow_build_elements.htm&release=264.0.0&type=5 "Use elements to define actions that the flow can run. When they’re on the canvas, connect them to create the order in which they run.")