LineItem: {
    imageUrl?: string;
    name: string;
    productIdentifier?: string;
    productUrl?: string;
    quantity: number;
    reference?: string;
    totalAmount: number;
    totalTaxAmount?: number;
    unitPrice?: number;
}

Type declaration

  • Optional imageUrl?: string

    URL of product image.

  • name: string

    Customer facing name of the product.

  • Optional productIdentifier?: string

    GTIN (UPC, ISBN) of the item.

  • Optional productUrl?: string

    URL of the product page.

  • quantity: number

    Quantity of the product.

    Example

    1
    
  • Optional reference?: string

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

    Example

    SKU12345
    
  • totalAmount: number

    Total amount attributed to sales tax in minor currency units.

  • Optional 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.

  • Optional unitPrice?: number

    Price of one unit in minor currency units.

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