Apply a modification to a line item

Creates a modification, a record of a modifier as it exists at the time it is applied to the lineItem. To view current modifications, use the 'expand=modifications' query parameter on the lineItem. To learn more about applying a modification, see: https://docs.clover.com/build/working-with-orders/#add-item-modifiers.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Merchant Id

string
required

Order Id

string
required

Line Item Id

Body Params
string
string

the name of the modifier when it was applied

string
int64

the additional cost of the modifier when it was applied

modifier
object

The modifier object. Values from the Modifier are copied to the Modification at the time that the order is placed. Modifier values may change after the modification is created.

int64

This is only used in reports. The count of how many of these modifiers that were sold.

Headers
string
required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <product> / <product-version> <comment>

Response
200
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here!