v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
ORDERS

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.

post/v3/merchants/{mId}/orders/{orderId}/line_items/{lineItemId}/modifications

Path parameters

mIdstring required

Merchant Id

orderIdstring required

Order Id

lineItemIdstring required

Line Item Id

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

Request body

idstring
namestring

the name of the modifier when it was applied

alternateNamestring
amountinteger

the additional cost of the modifier when it was applied

quantitySoldinteger

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