Interface StagedOrderSetShippingAddressAndCustomShippingMethodAction

Sets the shipping address and a custom Shipping Method together to prevent an inconsistent state.

interface StagedOrderSetShippingAddressAndCustomShippingMethodAction {
    action: "setShippingAddressAndCustomShippingMethod";
    address: _BaseAddress;
    custom?: CustomFieldsDraft;
    externalTaxRate?: ExternalTaxRateDraft;
    shippingMethodName: string;
    shippingRate: ShippingRateDraft;
    taxCategory?: TaxCategoryResourceIdentifier;
}

Hierarchy (View Summary)

Properties

action address custom? externalTaxRate? shippingMethodName shippingRate taxCategory?

Properties

Readonlyaction

action: "setShippingAddressAndCustomShippingMethod"

Readonlyaddress

address: _BaseAddress

Value to set for shippingAddress.

Optional Readonlycustom

custom?: CustomFieldsDraft

Custom Fields for the custom Shipping Method.

Optional ReadonlyexternalTaxRate

externalTaxRate?: ExternalTaxRateDraft

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

ReadonlyshippingMethodName

shippingMethodName: string

Value to set.

ReadonlyshippingRate

shippingRate: ShippingRateDraft

Value to set.

Optional ReadonlytaxCategory

taxCategory?: TaxCategoryResourceIdentifier

Used to select a Tax Rate when the Order has the Platform TaxMode.

Settings

Member Visibility

On This Page

Properties