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

    Interface CartAddShippingMethodAction

    Adds a Shipping Method for a specified shipping address to a Cart with Multiple ShippingMode.

    interface CartAddShippingMethodAction {
        action: "addShippingMethod";
        custom?: CustomFieldsDraft;
        deliveries?: DeliveryDraft[];
        externalTaxRate?: ExternalTaxRateDraft;
        shippingAddress: _BaseAddress;
        shippingKey: string;
        shippingMethod: ShippingMethodResourceIdentifier;
        shippingRateInput?: ShippingRateInputDraft;
    }

    Hierarchy (View Summary)

    Index
    action custom? deliveries? externalTaxRate? shippingAddress shippingKey shippingMethod shippingRateInput?
    action: "addShippingMethod"
    custom?: CustomFieldsDraft

    Custom Fields for the Shipping Method.

    deliveries?: DeliveryDraft[]

    Deliveries to be shipped with the referenced Shipping Method.

    externalTaxRate?: ExternalTaxRateDraft

    Tax Rate used to tax a shipping expense if the Cart has the External TaxMode.

    shippingAddress: _BaseAddress

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

    shippingKey: string

    User-defined identifier for the Shipping that must be unique across the Cart with Multiple ShippingMode.

    shippingMethod: ShippingMethodResourceIdentifier

    ResourceIdentifier to a ShippingMethod to add to the Cart with Multiple ShippingMode. InvalidOperation error is returned in one of the following cases: 1. If the referenced Shipping Method has a predicate that does not match the Cart. 2. If the referenced Shipping Method is not active. 3. If the referenced Shipping Method is associated with a Store that is different from the Cart's Store. 4. If the referenced Shipping Method is associated with a Store and the Cart is not associated with any Store.

    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