Interface ShippingInfoImportDraft

Maps to an order's shippingInfo property. This field is usually populated by the cart assosciated with the order, but when importing orders you must provide a draft representation as a part of the OrderImport.

interface ShippingInfoImportDraft {
    deliveries?: Delivery[];
    discountedPrice?: DiscountedLineItemPriceDraft;
    price: TypedMoney;
    shippingMethod?: ShippingMethodKeyReference;
    shippingMethodName: string;
    shippingMethodState?: string;
    shippingRate: ShippingRateDraft;
    taxCategory?: TaxCategoryKeyReference;
    taxRate?: TaxRate;
}

Properties

deliveries? discountedPrice? price shippingMethod? shippingMethodName shippingMethodState? shippingRate taxCategory? taxRate?

Properties

Optional Readonly deliveries

deliveries?: Delivery[]

Note that you can not add a DeliveryItem on import, as LineItems and CustomLineItems are not yet referencable by an id.

Optional Readonly discountedPrice

discountedPrice?: DiscountedLineItemPriceDraft

Readonly price

price: TypedMoney

Optional Readonly shippingMethod

shippingMethod?: ShippingMethodKeyReference

References a shipping method by key.

Readonly shippingMethodName

shippingMethodName: string

Optional Readonly shippingMethodState

shippingMethodState?: string

Readonly shippingRate

shippingRate: ShippingRateDraft

Optional Readonly taxCategory

taxCategory?: TaxCategoryKeyReference

References a tax category by key.

Optional Readonly taxRate

taxRate?: TaxRate

Settings

Member Visibility

Theme

On This Page

deliveriesdiscountedPricepriceshippingMethodshippingMethodNameshippingMethodStateshippingRatetaxCategorytaxRate