LineItemInput Class

Sends the list of individual line items associated with the payment to the gateway adapter.

Namespace

CommercePayments

LineItemInput Properties

The following are properties for LineItemInput.

additionalAttributes

Map of additional attributes.

Signature

public Map<String,String> additionalAttributes {get; set;}

Property Value

Type: Map<String,String>

commodityCode

Commodity code.

Signature

public String commodityCode {get; set;}

Property Value

Type: String

description

Description of the product.

Signature

public String description {get; set;}

Property Value

Type: String

discount

Discount applied to the line item level.

Signature

public Double discount {get; set;}

Property Value

Type: Double

discountIndicator

Specifies whether a discount was applied to the specific line item.

Signature

public Boolean discountIndicator {get; set;}

Property Value

Type: Boolean

dutyAmount

Duty or tariff applied specifically to a item (not the whole order).

Signature

public Double dutyAmount {get; set;}

Property Value

Type: Double

grossNetIndicator

Specifies if the line item amount is Gross (before discounts) or Net (after discounts).

Signature

public String grossNetIndicator {get; set;}

Property Value

Type: String

lineItemId

Line item identifier. Specify when multiple items are present.

Signature

public String lineItemId {get; set;}

Property Value

Type: String

lineItemTotal

Total amount for that line item.

Signature

public Double lineItemTotal {get; set;}

Property Value

Type: Double

name

Product or service name.

Signature

public String name {get; set;}

Property Value

Type: String

quantity

Quantity purchased.

Signature

public Integer quantity {get; set;}

Property Value

Type: Integer

shippingAmount

Shipping or freight cost allocated to that line item.

Signature

public Double shippingAmount {get; set;}

Property Value

Type: Double

sku

SKU or product code.

Signature

public String sku {get; set;}

Property Value

Type: String

taxAmount

Line-level tax amount.

Signature

public Double taxAmount {get; set;}

Property Value

Type: Double

taxRate

Tax percentage applied to that specific line item.

Signature

public Double taxRate {get; set;}

Property Value

Type: Double

unitPrice

Unit price.

Signature

public Double unitPrice {get; set;}

Property Value

Type: Double

uom

Unit of measure. For example, EA, HRS, and KG.

Signature

public String uom {get; set;}

Property Value

Type: String

LineItemInput Methods

The following are methods for LineItemInput.

equals(obj)

Maintains the integrity of lists of type LineItemInput by determining the equality of external objects in a list. This method is dynamic and based on the equals method in Java.

Signature

public Boolean equals(Object obj)

Parameters

obj
Type: Object
External object whose key is to be validated.

Return Value

Type: Boolean

hashCode()

Maintains the integrity of lists of type LineItemInput.

Signature

public Integer hashCode()

Return Value

Type: Integer

toString()

Converts a date to a string.

Signature

public String toString()

Return Value

Type: String