Interface Order

Represents an order placed on the site.

interface Order {
    currency: string;
    discountCodes: DiscountCode[];
    lineItems: QuantityProduct[];
    lineItemsTotal: number;
    orderNumber: string;
    subtotal: number;
    total: number;
    totalShipping: number;
    totalTax: number;
}

Properties

currency discountCodes lineItems lineItemsTotal orderNumber subtotal total totalShipping totalTax

Properties

currency

currency: string

The local currency used for prices. Must be “USD”, unless another currency has been agreed upon by Bazaarvoice.

discountCodes

discountCodes: DiscountCode[]

A list of discounts applied to this order. If no discounts are applicable, this should be an empty array.

lineItems

lineItems: QuantityProduct[]

The products in the order and their corresponding ordered quantities.

lineItemsTotal

lineItemsTotal: number

The total value of all items in the cart before any discounts, taxes and shipping, but after sale pricing.

orderNumber

orderNumber: string

The unique identifier for this order.

subtotal

subtotal: number

The total value of the items in the order after discounts but before shipping or taxes. This should match the order total you use in your own analytics.

total

total: number

The total price (after discounts) including shipping and possibly taxes.

totalShipping

totalShipping: number

The total value of any shipping costs applied to this order.

totalTax

totalTax: number

The total value of any taxes applied to this order.

Settings

Member Visibility

On This Page

Properties