Interface LineItemImportDraft

Represents an individual Line Item in an Order. A line item is a snapshot of a product at the time it was added to the order.

You cannot create an Order that includes line item operations that do not exist in the Project or have been deleted.
Products and Product Variants referenced by a line item must already exist in the Project.
interface LineItemImportDraft {
    custom?: Custom;
    distributionChannel?: ChannelKeyReference;
    name: LocalizedString;
    price: LineItemPrice;
    product?: ProductKeyReference;
    quantity: number;
    shippingDetails?: ItemShippingDetailsDraft;
    state?: ItemState[];
    supplyChannel?: ChannelKeyReference;
    taxRate?: TaxRate;
    variant: LineItemProductVariantImportDraft;
}

Properties

custom? distributionChannel? name price product? quantity shippingDetails? state? supplyChannel? taxRate? variant

Properties

Optional Readonly custom

custom?: Custom

Custom Fields for this Line Item.

Optional Readonly distributionChannel

distributionChannel?: ChannelKeyReference

Maps to LineItem.distributionChannel. The Reference to the Distribution Channel with which the LineItem is associated. If referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the necessary Distribution Channel is created.

Readonly name

name: LocalizedString

Maps to LineItem.name.

Readonly price

price: LineItemPrice

Maps to LineItem.price.

Optional Readonly product

product?: ProductKeyReference

Maps to LineItem.productId.

Readonly quantity

quantity: number

Maps to LineItem.quantity.

Optional Readonly shippingDetails

shippingDetails?: ItemShippingDetailsDraft

Maps to LineItem.shippingDetails.

Optional Readonly state

state?: ItemState[]

Optional Readonly supplyChannel

supplyChannel?: ChannelKeyReference

Maps to LineItem.supplyChannel. The Reference to the Supply Channel with which the LineItem is associated. If referenced Supply Channel does not exist, the state of the ImportOperation will be set to unresolved until the necessary Supply Channel is created.

Optional Readonly taxRate

taxRate?: TaxRate

Maps to LineItem.taxRate.

Readonly variant

variant: LineItemProductVariantImportDraft

Maps to ProductVariantImportDraft.

Settings

Member Visibility

Theme

On This Page

customdistributionChannelnamepriceproductquantityshippingDetailsstatesupplyChanneltaxRatevariant