Update a line item

post

https://apisandbox.dev.clover.com/v3/merchants/{mId}/orders/{orderId}/line_items/{lineItemId}

Updates a line item for an order.

Path Params

mId

string

required

Merchant Id

orderId

string

required

Order Id

lineItemId

string

required

Line Item Id

Query Params

expand

string

Expandable fields: [employee, orderType, discounts, modifications, taxRates, payments]

Body Params

string

Unique identifier.

item

object

A reference to the inventory item that was used to create this line item. Note that since this a reference the item can be changed and deleted any time such that it no longer matches this line item.

colorCode

string

Hex code representation of the color assigned to item in the form of #fff, #ffffff, or #ffffffff. Note that item color can be changed and deleted any time such that it no longer matches this line item

name

string

Line item name.

alternateName

string

Alternate name of the line item.

price

int64

Price of the item, typically in cents of merchant currency. When unit quantity is not null then this is the price for a single unit and is not the complete price.

priceWithModifiers

int64

Price of item after adding all modifications. This is used only for reporting.

priceWithModifiersAndItemAndOrderDiscounts

int64

Price of item after adding all modifications and subtracting all line item and order level discounts. This is used only for reporting.

unitQty

integer

This is applicable only if the item is priced by quantity of a unit. The item must have a priceType of PER_UNIT. The value is a fixed-point integer with scaling factor of 1000 (e.g. if charging per ounce, the value should be set to 2500 for 2.5 ounces). To compute the complete price perform the following calculation: PRICE * (UNIT QTY / 1000). If the item doesn’t have a priceType of PER_UNIT, then unitQty is ignored.

unitName

string

Unit name (e.g. oz, lb, etc) if priced by unit, otherwise null.

itemCode

string

note

string

printed

boolean

Defaults to false

True if this line item has been printed out on an order printer at least once already.

exchangedLineItem

object

orderFee

object

isOrderFee

boolean

True if this line item is an order fee line item

isPlatformOrderFee

boolean

True if this line item is an platform order fee line item

orderFeeType

string

Used to define type of order fee line item, e.g. gratuity.

binName

string

userData

string

createdTime

int64

orderClientCreatedTime

int64

discounts

array of objects

List of discounts applied to the line item. Each line item on an order may have zero or more percentage or amount discounts. Line item discounts are separate from order-level discounts (which are applied to the order subtotal).

discounts

orderLevelDiscounts

array of objects

List of order level discounts attributed to this line item. Amounts are rounded to the nearest penny. This is for reporting purposes only. These rounding approximates are not used when calculating the transaction.

orderLevelDiscounts

discountAmount

integer

Unnamed fixed discount amount in cents. Or, in reporting, this may be the calculated sum of all the line item discounts.

orderLevelDiscountAmount

int64

The calculated sum of order level discounts attributed, approximately to the nearest cent, to this the line item. This is only used in reporting.

exchanged

boolean

Defaults to false

modifications

array of objects

List of references to modifications applied to this line item.

modifications