Initiate Asset Amendment Action

Initiate an amendment on one or more assets and produce an order or a cart.

This action is available in API version 68.0 and later.

This is applicable for Consumer Sales for business-to-consumer (B2C).

You need the CME B2C permission set to use this invocable action.

URI: /services/data/v68.0/actions/standard/initiateAmendForConsumerSales

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where, TOKEN is a variable.

InputTypeDescription
assetIdsstring array[]Required.
A comma-delimited list of asset IDs to amend.
amendmentStartDatedatetimeRequired.
The date on which the amendment takes effect.
outputRecordTypestringRequired.
The type of record to produce from the amendment. Valid values are Order and Cart.
quantityChangenumberOptional.
The change in quantity to apply to the amended assets.
opportunityIdstringOptional.
The ID of the opportunity to associate with the amendment.
contractIdstringOptional.
The ID of the contract to associate with the amendment.
outputRecordIdstringOptional.
The ID of an existing record to which the amendment output is added.
skipPricingbooleanOptional.
Indicates whether to skip pricing when generating the amendment output.
webStoreIdstringOptional. Required when outputRecordType is Cart.
The ID of the web store.
OutputTypeDescription
amendmentRecordIdstringThe ID of the order or cart created by the amendment.
statusUrlstringThe URL to track the status of the amendment operation.
POST

This sample request is for the Initiate Asset Amendment action.

This sample response is for the Initiate Asset Amendment action.