Typescript SDK Type Docs
    Preparing search index...

    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.
Product Attributes are merged with Variant Attributes to ensure the full Attribute context of the Product Variant.
    interface LineItemImportDraft {
        custom?: Custom;
        distributionChannel?: ChannelKeyReference;
        name: LocalizedString;
        price: LineItemPrice;
        product?: ProductKeyReference;
        quantity: number;
        shippingDetails?: ItemShippingDetailsDraft;
        state?: ItemState[];
        supplyChannel?: ChannelKeyReference;
        taxRate?: TaxRate;
        variant: LineItemProductVariantImportDraft;
    }
    Index

    Properties

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

    Properties

    custom?: Custom

    Maps to LineItem.custom.

    distributionChannel?: ChannelKeyReference

    Maps to LineItem.distributionChannel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.

    name: LocalizedString

    Maps to LineItem.name.

    price: LineItemPrice

    Maps to LineItem.price.

    product?: ProductKeyReference

    Maps to LineItem.productId. If the referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the referenced Product is created.

    quantity: number

    Maps to LineItem.quantity.

    shippingDetails?: ItemShippingDetailsDraft

    Maps to LineItem.shippingDetails.

    state?: ItemState[]

    Maps to LineItem.state.

    supplyChannel?: ChannelKeyReference

    Maps to LineItem.supplyChannel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.

    taxRate?: TaxRate

    Maps to LineItem.taxRate.

    variant: LineItemProductVariantImportDraft

    Maps to ProductVariantImportDraft.

    Settings

    Member Visibility

    On This Page

    Properties