Typescript SDK Type Docs
    Preparing search index...

    Interface ShippingInfoImportDraft

    Maps to an Order's shippingInfo property. This field is usually populated by the Cart associated 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?: ShippingMethodState;
        shippingRate: ShippingRateDraft;
        taxCategory?: TaxCategoryKeyReference;
        taxRate?: TaxRate;
    }
    Index

    Properties

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

    Properties

    deliveries?: Delivery[]

    Maps to shippingInfo.deliveries. You cannot add a DeliveryItem on import, as LineItems and CustomLineItems are not yet referenceable by an id.

    discountedPrice?: DiscountedLineItemPriceDraft

    Maps to shippingInfo.discountedPrice.

    price: TypedMoney

    Maps to shippingInfo.price.

    shippingMethod?: ShippingMethodKeyReference

    Maps to shippingInfo.shippingMethod. If the referenced ShippingMethod does not exist, the state of the ImportOperation will be set to unresolved until the referenced ShippingMethod is created.

    shippingMethodName: string

    Maps to shippingInfo.shippingMethodName.

    shippingMethodState?: ShippingMethodState

    Maps to shippingInfo.shippingMethodState.

    shippingRate: ShippingRateDraft

    Used to determine the price.

    taxCategory?: TaxCategoryKeyReference

    Maps to shippingInfo.taxCategory. If the referenced TaxCategory does not exist, the state of the ImportOperation will be set to unresolved until the referenced TaxCategory is created.

    taxRate?: TaxRate

    Maps to shippingInfo.taxRate.

    Settings

    Member Visibility

    On This Page

    Properties