@gradientedge/commercetools-utils
    Preparing search index...

    Interface ShippingDraft

    Wraps all shipping-related information (such as address, rate, deliveries) per Shipping Method for Carts with multiple Shipping Methods.

    interface ShippingDraft {
        custom?: CustomFieldsDraft;
        deliveries?: DeliveryDraft[];
        externalTaxRate?: ExternalTaxRateDraft;
        key: string;
        shippingAddress: _BaseAddress;
        shippingMethod?: ShippingMethodReference;
        shippingRateInput?: ShippingRateInputDraft;
    }
    Index

    Properties

    custom? deliveries? externalTaxRate? key shippingAddress shippingMethod? shippingRateInput?

    Properties

    custom?: CustomFieldsDraft

    Custom Fields for Shipping.

    deliveries?: DeliveryDraft[]

    Deliveries to be shipped with the Shipping Method.

    externalTaxRate?: ExternalTaxRateDraft

    Tax Rate used for taxing a shipping expense if the Cart has the External TaxMode.

    key: string

    User-defined unique identifier for the Shipping in a Cart with Multiple ShippingMode.

    shippingAddress: _BaseAddress

    Determines the shipping rate and Tax Rate of the associated Line Items.

    shippingMethod?: ShippingMethodReference

    Shipping Methods added to the Cart with Multiple ShippingMode.

    shippingRateInput?: ShippingRateInputDraft

    Input used to select a ShippingRatePriceTier. The data type of this field depends on the shippingRateInputType.type configured in the Project:

    - If `CartClassification`, it must be [ClassificationShippingRateInputDraft](ctp:api:type:ClassificationShippingRateInputDraft).
- If `CartScore`, it must be [ScoreShippingRateInputDraft](ctp:api:type:ScoreShippingRateInputDraft).
- If `CartValue`, it cannot be set.

    Settings

    Member Visibility

    On This Page

    Properties