Apex Developer Guide

Apex Developer Guide
Getting Started with Apex
Writing Apex
Running Apex
Debugging, Testing, and Deploying Apex
Apex Language Reference
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommercePayments Namespace
ConnectApi Namespace
ActionLinks Class
Announcements Class
Chatter Class
ChatterFavorites Class
ChatterFeeds Class
ChatterGroups Class
ChatterMessages Class
ChatterUsers Class
CommerceBuyerExperience Class
CommerceCart Class
CommerceCatalog Class
CommerceStorePricing Class
CommerceWishlist Class
Communities Class
CommunityModeration Class
ContentHub Class
Datacloud Class
EmailMergeFieldService Class
EmployeeProfiles Class
ExternalEmailServices Class
ExternalManagedAccount Class
FieldService Class
FulfillmentOrder Class
Knowledge Class
ManagedContent Class
ManagedTopics Class
Mentions Class
Missions Class
NextBestAction Class
OmnichannelInventoryService Class
OrderPaymentSummary Class
OrderSummary Class
OrderSummary Methods
OrderSummaryCreation Class
Organization Class
Payments Methods
Personalization Class
QuestionAndAnswers Class
Recommendations Class
Records Class
Routing Class
SalesforceInbox Class
SmartDataDiscovery Class
SocialEngagement Class
Survey Class
Topics Class
UserProfiles Class
Zones Class
ConnectApi Input Classes
ConnectApi Output Classes
ConnectApi Enums
ConnectApi Exceptions
Database Namespace
Datacloud Namespace
DataSource Namespace
Dom Namespace
EventBus Namespace
Flow Namespace
Functions Namespace (Beta)
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Site Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
wave Namespace
Appendices
Glossary
PDF

Newer Version Available

This content describes an older version of this product. View Latest

OrderSummary Class

Work with orders in Order Management.

Namespace

ConnectApi

OrderSummary Methods

The following are methods for OrderSummary. All methods are static.

adjustPreview(orderSummaryId, adjustInput)

Retrieve the expected results of adjusting the price of one or more OrderItemSummaries from an OrderSummary, without actually executing the adjustment. The response data contains the financial changes that would result from submitting the proposed adjustment.

API Version

49.0

Requires Chatter

No

Signature

public static ConnectApi.AdjustOrderSummaryOutputRepresentation adjustPreview(String orderSummaryId, ConnectApi.AdjustOrderItemSummaryInputRepresentation adjustInput)

Parameters

orderSummaryId
Type: String
ID of the OrderSummary.
adjustInput
Type: ConnectApi.AdjustOrderItemSummaryInputRepresentation
A list of price adjustments to OrderItemSummaries that make up a price adjustment to an order.

Return Value

Type: ConnectApi.AdjustOrderSummaryOutputRepresentation

adjustSubmit(orderSummaryId, adjustInput)

Adjust the price of one or more OrderItemSummaries from an OrderSummary, and create one or two corresponding change orders.

API Version

49.0

Requires Chatter

No

Signature

public static ConnectApi.AdjustOrderSummaryOutputRepresentation adjustSubmit(String orderSummaryId, ConnectApi.AdjustOrderItemSummaryInputRepresentation adjustInput)

Parameters

orderSummaryId
Type: String
ID of the OrderSummary.
adjustInput
Type: ConnectApi.AdjustOrderItemSummaryInputRepresentation
A list of price adjustments to OrderItemSummaries that make up a price adjustment to an order.

Return Value

Type: ConnectApi.AdjustOrderSummaryOutputRepresentation

Usage

After submitting a price adjustment, process refunds as appropriate:

  • If the discount only applied to OrderItemSummaries for which payment has not been captured, it does not require a refund. This situation normally applies to OrderItemSummaries in the US that have not been fulfilled.
  • If the discount applied to OrderItemSummaries that have not been fulfilled and for which payment has been captured, process a refund. In this case, pass the totalExcessFundsAmount from the output representation to the ensureRefundsAsync() method.
  • If the discount applied to OrderItemSummaries that have been fulfilled, process a refund. Pass the postFulfillmentChangeOrderId from the output representation to the createCreditMemo() method, then pass the CreditMemo to the ensureRefundsAsync() method.
  • If the discount applied to both fulfilled and unfulfilled OrderItemSummaries for which payment has been captured, process both refunds. Pass the postFulfillmentChangeOrderId from the output representation to the createCreditMemo() method, then pass the credit memo and the totalExcessFundsAmount from the output representation to the ensureRefundsAsync() method.

createCreditMemo(orderSummaryId, creditMemoInput)

Create a credit memo to represent the refund for one or more change orders associated with an OrderSummary.

API Version

48.0

Requires Chatter

No

Signature

public static ConnectApi.CreateCreditMemoOutputRepresentation createCreditMemo(String orderSummaryId, ConnectApi.CreateCreditMemoInputRepresentation creditMemoInput)

Parameters

orderSummaryId
Type: String
ID of the OrderSummary.
creditMemoInput
Type: ConnectApi.CreateCreditMemoInputRepresentation
The list of change order IDs.

Return Value

Type: ConnectApi.CreateCreditMemoOutputRepresentation

ensureFundsAsync(orderSummaryId, ensureFundsInput)

Ensure funds for an invoice and apply them to it. If needed, capture authorized funds by sending a request to a payment provider. This method inserts a background operation into an asynchronous job queue and returns the ID of that operation so you can track its status. Payment gateway responses appear in the payment gateway log and do not affect the background operation status.

API Version

48.0

Requires Chatter

No

Signature

public static ConnectApi.EnsureFundsAsyncOutputRepresentation ensureFundsAsync(String orderSummaryId, ConnectApi.EnsureFundsAsyncInputRepresentation ensureFundsInput)

Parameters

orderSummaryId
Type: String
ID of the OrderSummary.
ensureFundsInput
Type: ConnectApi.EnsureFundsAsyncInputRepresentation
The ID of the invoice.

Return Value

Type: ConnectApi.EnsureFundsAsyncOutputRepresentation

Usage

This method checks the OrderPaymentSummaries associated with the specified OrderSummary for funds to apply to the invoice balance as follows:

If multiple OrderPaymentSummaries have the same amount, their order of selection is random.

Note

  1. Verify that the invoice balance doesn’t exceed the total amount of all the OrderPaymentSummaries.
  2. If an OrderPaymentSummary exists with an amount that matches the invoice balance, use it.
  3. Otherwise, if any OrderPaymentSummaries exist with an amount greater than the invoice balance, use the one with the smallest amount greater than the invoice balance.
  4. Otherwise, select OrderPaymentSummaries in order from largest amount to smallest until their amounts meet or exceed the invoice balance.
  5. If any selected funds are authorized, capture them.
  6. Apply the selected funds to the invoice.

ensureRefundsAsync(orderSummaryId, ensureRefundsInput)

Ensure refunds for a credit memo or excess funds by sending a request to a payment provider. This method inserts a background operation into an asynchronous job queue and returns the ID of that operation so you can track its status. Payment gateway responses appear in the payment gateway log and do not affect the background operation status.

API Version

48.0

Requires Chatter

No

Signature

public static ConnectApi.EnsureRefundsAsyncOutputRepresentation ensureRefundsAsync(String orderSummaryId, ConnectApi.EnsureRefundsAsyncInputRepresentation ensureRefundsInput)

Parameters

orderSummaryId
Type: String
ID of the OrderSummary.
ensureRefundsInput
Type: ConnectApi.EnsureRefundsAsyncInputRepresentation
Object that wraps the ID of the credit memo and the excess funds amount.

Return Value

Type: ConnectApi.EnsureRefundsAsyncOutputRepresentation

previewCancel(orderSummaryId, changeInput)

Retrieve the expected change order values for canceling one or more OrderItemSummaries from an OrderSummary, without actually executing the cancel.

API Version

48.0

Requires Chatter

No

Signature

public static ConnectApi.PreviewCancelOutputRepresentation previewCancel(String orderSummaryId, ConnectApi.ChangeInputRepresentation changeInput)

Parameters

orderSummaryId
Type: String
ID of the OrderSummary.
changeInput
Type: ConnectApi.ChangeInputRepresentation
A list of changes to OrderItemSummaries that make up an order change, such as a cancel or return.

Return Value

Type: ConnectApi.PreviewCancelOutputRepresentation

previewReturn(orderSummaryId, changeInput)

Retrieve the expected change order values for returning one or more OrderItemSummaries from an OrderSummary, without actually executing the return.

API Version

48.0

Requires Chatter

No

Signature

public static ConnectApi.PreviewReturnOutputRepresentation previewReturn(String orderSummaryId, ConnectApi.ChangeInputRepresentation changeInput)

Parameters

orderSummaryId
Type: String
ID of the OrderSummary.
changeInput
Type: ConnectApi.ChangeInputRepresentation
A list of changes to OrderItemSummaries that make up an order change, such as a cancel or return.

Return Value

Type: ConnectApi.PreviewReturnOutputRepresentation

submitCancel(orderSummaryId, changeInput)

Cancel one or more OrderItemSummaries from an OrderSummary, and create a corresponding change order.

API Version

48.0

Requires Chatter

No

Signature

public static ConnectApi.SubmitCancelOutputRepresentation submitCancel(String orderSummaryId, ConnectApi.ChangeInputRepresentation changeInput)

Parameters

orderSummaryId
Type: String
ID of the OrderSummary.
changeInput
Type: ConnectApi.ChangeInputRepresentation
A list of changes to OrderItemSummaries that make up an order change, such as a cancel or return.

Return Value

Type: ConnectApi.SubmitCancelOutputRepresentation

submitReturn(orderSummaryId, changeInput)

Return one or more OrderItemSummaries from an OrderSummary, and create a corresponding change order.

API Version

48.0

Requires Chatter

No

Signature

public static ConnectApi.SubmitReturnOutputRepresentation submitReturn(String orderSummaryId, ConnectApi.ChangeInputRepresentation changeInput)

Parameters

orderSummaryId
Type: String
ID of the OrderSummary.
changeInput
Type: ConnectApi.ChangeInputRepresentation
A list of changes to OrderItemSummaries that make up an order change, such as a cancel or return.

Return Value

Type: ConnectApi.SubmitReturnOutputRepresentation

Usage

After submitting a return, process a refund. Pass the changeOrderId from the output representation to the createCreditMemo() method, then pass the credit memo to the ensureRefundsAsync() method.