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).

Note

Special Access Rules

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

Supported REST HTTP Methods

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

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where, TOKEN is a variable.

Inputs

Input	Type	Description
`assetIds`	string array[]	Required. A comma-delimited list of asset IDs to amend.
`amendmentStartDate`	datetime	Required. The date on which the amendment takes effect.
`outputRecordType`	string	Required. The type of record to produce from the amendment. Valid values are `Order` and `Cart`.
`quantityChange`	number	Optional. The change in quantity to apply to the amended assets.
`opportunityId`	string	Optional. The ID of the opportunity to associate with the amendment.
`contractId`	string	Optional. The ID of the contract to associate with the amendment.
`outputRecordId`	string	Optional. The ID of an existing record to which the amendment output is added.
`skipPricing`	boolean	Optional. Indicates whether to skip pricing when generating the amendment output.
`webStoreId`	string	Optional. Required when `outputRecordType` is `Cart`. The ID of the web store.

Outputs

Output	Type	Description
`amendmentRecordId`	string	The ID of the order or cart created by the amendment.
`statusUrl`	string	The URL to track the status of the amendment operation.

Example

POST

This sample request is for the Initiate Asset Amendment action.

1{
2  "inputs": [
3    {
4      "assetIds": ["02ixx0000001AbcAAE"],
5      "amendmentStartDate": "2026-09-01T00:00:00.000Z",
6      "outputRecordType": "Cart",
7      "quantityChange": 1,
8      "webStoreId": "0ZE0Y0000001234WAA"
9    }
10  ]
11}

This sample response is for the Initiate Asset Amendment action.

1[
2  {
3    "actionName": "initiateAmendForConsumerSales",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outputValues": {
8      "amendmentRecordId": "801xx0000012AbcAAE",
9      "statusUrl": "/services/data/v68.0/connect/consumer/initiate-amend/status/801xx0000012AbcAAE"
10    },
11    "sortOrder": -1,
12    "version": 1
13  }
14]