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

    Interface StagedOrderSetCustomShippingMethodAction

    To set the Cart's custom Shipping Method (independent of the ShippingMethods managed through the Shipping Methods API) the Cart must have the Single ShippingMode and a shippingAddress.

    To unset a custom Shipping Method on a Cart, use the [Set ShippingMethod](ctp:api:type:StagedOrderSetShippingMethodAction) update action without the `shippingMethod` field instead.
    interface StagedOrderSetCustomShippingMethodAction {
        action: "setCustomShippingMethod";
        custom?: CustomFieldsDraft;
        externalTaxRate?: ExternalTaxRateDraft;
        shippingMethodName: string;
        shippingRate: ShippingRateDraft;
        taxCategory?: TaxCategoryResourceIdentifier;
    }

    Hierarchy (View Summary)

    Index

    Properties

    action custom? externalTaxRate? shippingMethodName shippingRate taxCategory?

    Properties

    action: "setCustomShippingMethod"
    custom?: CustomFieldsDraft

    Custom Fields for the custom Shipping Method.

    externalTaxRate?: ExternalTaxRateDraft

    External Tax Rate for the shippingRate to be set if the Cart has the External TaxMode.

    shippingMethodName: string

    Name of the custom Shipping Method.

    shippingRate: ShippingRateDraft

    Determines the shipping price.

    taxCategory?: TaxCategoryResourceIdentifier

    Tax Category used to determine the Tax Rate when the Cart has the Platform TaxMode.

    Settings

    Member Visibility

    On This Page

    Properties