Interface LineItem

interface LineItem {
    currency?: string;
    imageUrl?: string;
    lineItemReference?: string;
    name: string;
    productIdentifier?: string;
    productUrl?: string;
    quantity: number;
    shippingReference?: string;
    subscriptionReference?: string;
    totalAmount: number;
    totalTaxAmount?: number;
    unitPrice?: number;
}

Properties

currency? imageUrl? lineItemReference? name productIdentifier? productUrl? quantity shippingReference? subscriptionReference? totalAmount totalTaxAmount? unitPrice?

Properties

Optionalcurrency

currency?: string

OptionalimageUrl

imageUrl?: string

URL of product image.

OptionallineItemReference

lineItemReference?: string

Unique reference to this line item for correlation with your own system.

Example

SKU12345

name

name: string

Customer facing name of the product.

OptionalproductIdentifier

productIdentifier?: string

GTIN (UPC, ISBN) of the item.

OptionalproductUrl

productUrl?: string

URL of the product page.

quantity

quantity: number

Quantity of the product.

Example

1

OptionalshippingReference

shippingReference?: string

OptionalsubscriptionReference

subscriptionReference?: string

totalAmount

totalAmount: number

Total amount attributed to sales tax in minor currency units.

OptionaltotalTaxAmount

totalTaxAmount?: number

Total amount to charge/credit the consumer, in minor currency units, including any surcharges and deductions. To credit the consumer for discounts, vouchers, gift cards, etc. use a negative total amount.

OptionalunitPrice

unitPrice?: number

Price of one unit in minor currency units.

Total price of line item is (unitPrice * quantity).

Settings

Member Visibility

On This Page

Properties