Skip to main content

Interface: DeliveryLineItem

Extends​

  • Omit<LineItem, "external_inventory_policy" | "grams" | "handle" | "purchase_item_id" | "purchase_item_type" | "sku" | "tax_due" | "tax_lines" | "taxable_amount" | "taxable" | "title" | "total_price" | "unit_price_includes_tax">

Properties​

external_product_id​

external_product_id: ExternalId

An object containing the associated product ID as it appears in the external system.

Inherited from​

Omit.external_product_id

external_variant_id​

external_variant_id: ExternalId

An object containing the associated variant ID as it appears in the external system.

Inherited from​

Omit.external_variant_id

images​

images: ProductImage

An object containing URLs of the Product image.

Inherited from​

Omit.images

is_prepaid​

is_prepaid: boolean

Value is set to true if it is a prepaid item

is_skippable​

is_skippable: boolean

Value is set to true if it is not a onetime or a prepaid item

is_skipped​

is_skipped: boolean

Value is set to true if the order is skipped.

offer_attributes?​

optional offer_attributes: OfferAttributes

An object containing information on the related offer, if applicable

Inherited from​

Omit.offer_attributes

original_price​

original_price: string

The total price of the line item, before discounts.

plan_type​

plan_type: PlanType

The type of the plan. May return null value in certain cases.

product_title​

product_title: string

The name of the product in a store’s catalog.

properties​

properties: Property[]

An array of name value pairs of additional line_item attributes.

Inherited from​

Omit.properties

quantity​

quantity: number

The quantity of the line_item.

Inherited from​

Omit.quantity

subscription_id​

subscription_id: number

Unique numeric identifier for the subscription linked to this line_item in the order.

subtotal_price​

subtotal_price: string

The subtotal price (sum of all line items * their quantity) of the order less discounts.

unit_price​

unit_price: string

The unit price of the line_item.

Inherited from​

Omit.unit_price

variant_title​

variant_title: string

The name of a variant of the Product of this line_item.

Inherited from​

Omit.variant_title