Generate Order Summary Action

Generates a URL so that authenticated and guest users can access order details.
To access, you need these permissions.
  • Salesforce Order Management License or Salesforce B2B Commerce License

This object is available in API version 59.0 and later.

Supported REST HTTP Methods

URI
/services/data/v59.0/actions/standard/generateOrderSummaryUrl
Formats
JSON
HTTP Methods
POST

Inputs

Input Details
orderSummaryId
Type
ID
Description
Optional. The ID of the order summary to generate a URL for.
orderNumber
Type
string
Description
Optional. The ID of the Salesforce payment gateway record that represents the external payment gateway used for processing the sale request.
webStoreId
Type
ID
Description
Required. The order number of the order summary to generate a URL for.

Outputs

Output Details
url
Type
string
Description
The URL generated by the action that links to the order summary.