Interface StagedOrderSetShippingMethodAction

To set the Cart's Shipping Method, the Cart must have the Single ShippingMode and a shippingAddress.

interface StagedOrderSetShippingMethodAction {
    action: "setShippingMethod";
    externalTaxRate?: ExternalTaxRateDraft;
    shippingMethod?: ShippingMethodResourceIdentifier;
}

Properties

action externalTaxRate? shippingMethod?

Properties

Readonlyaction

action: "setShippingMethod"

Optional ReadonlyexternalTaxRate

externalTaxRate?: ExternalTaxRateDraft

An external Tax Rate can be set if the Cart has the External TaxMode.

Optional ReadonlyshippingMethod

shippingMethod?: ShippingMethodResourceIdentifier

Value to set. If empty, any existing value will be removed. If the referenced Shipping Method has a predicate that does not match the Cart, an InvalidOperation error is returned.

Settings

Member Visibility

On This Page

Properties