Interface ShippingMethodDraft

interface ShippingMethodDraft {
    active?: boolean;
    custom?: CustomFieldsDraft;
    description?: string;
    isDefault: boolean;
    key?: string;
    localizedDescription?: LocalizedString;
    localizedName?: LocalizedString;
    name: string;
    predicate?: string;
    taxCategory: TaxCategoryResourceIdentifier;
    zoneRates: ZoneRateDraft[];
}

Properties

active? custom? description? isDefault key? localizedDescription? localizedName? name predicate? taxCategory zoneRates

Properties

Optional Readonlyactive

active?: boolean

If set to true, the ShippingMethod can be used during the creation or update of a Cart or Order.

Optional Readonlycustom

custom?: CustomFieldsDraft

Custom Fields for the ShippingMethod.

Optional Readonlydescription

description?: string

Description of the ShippingMethod.

Deprecated

ReadonlyisDefault

isDefault: boolean

If set to true, the ShippingMethod will be the Project's default ShippingMethod. When retrieving matching Shipping Methods, it is returned as the first item in the array. This flag does not automatically apply the Shipping Method to Carts.

Optional Readonlykey

key?: string

User-defined unique identifier for the ShippingMethod.

Optional ReadonlylocalizedDescription

localizedDescription?: LocalizedString

Localized description of the ShippingMethod.

Optional ReadonlylocalizedName

localizedName?: LocalizedString

Localized name of the ShippingMethod.

Readonlyname

name: string

Unique name for the ShippingMethod within a Project.

Optional Readonlypredicate

predicate?: string

Valid Cart predicate to select a ShippingMethod for a Cart.

ReadonlytaxCategory

taxCategory: TaxCategoryResourceIdentifier

TaxCategory for all ZoneRates of the ShippingMethod.

ReadonlyzoneRates

zoneRates: ZoneRateDraft[]

Defines ShippingRates (prices) for specific zones.

Settings

Member Visibility

On This Page

Properties