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

    Interface ShippingMethodDraft

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

    Whether the ShippingMethod can be used during the creation or update of a Cart or Order.

    custom?: CustomFieldsDraft

    Custom Fields for the ShippingMethod.

    description?: string

    Description of the ShippingMethod.

    isDefault: boolean

    Whether 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.

    key?: string

    User-defined unique identifier for the ShippingMethod.

    localizedDescription?: LocalizedString

    Localized description of the ShippingMethod.

    localizedName?: LocalizedString

    Localized name of the ShippingMethod.

    name: string

    Unique name for the ShippingMethod within a Project.

    predicate?: string

    Valid Cart predicate to select a ShippingMethod for a Cart.

    stores?: StoreResourceIdentifier[]

    • If defined and not empty, the Shipping Method applies to Carts with a Store that matches any Store in this field.

      • If not defined or empty, the Shipping Method applies to all Carts, irrespective of a Store.

      If the number of referenced Stores exceeds the Stores per Shipping Method limit, an InvalidOperation error is returned.

    taxCategory: TaxCategoryResourceIdentifier

    TaxCategory for all ZoneRates of the ShippingMethod.

    zoneRates: ZoneRateDraft[]

    Defines ShippingRates (prices) for specific zones.

    Settings
    Member Visibility

    On This Page
    Properties