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

    Interface ShippingMethod

    interface ShippingMethod {
        active: boolean;
        createdAt: string;
        createdBy?: CreatedBy;
        custom?: CustomFields;
        description?: string;
        id: string;
        isDefault: boolean;
        key?: string;
        lastModifiedAt: string;
        lastModifiedBy?: LastModifiedBy;
        localizedDescription?: LocalizedString;
        localizedName?: LocalizedString;
        name: string;
        predicate?: string;
        stores: StoreKeyReference[];
        taxCategory: TaxCategoryReference;
        version: number;
        zoneRates: ZoneRate[];
    }

    Hierarchy (View Summary)

    Index
    active createdAt createdBy? custom? description? id isDefault key? lastModifiedAt lastModifiedBy? localizedDescription? localizedName? name predicate? stores taxCategory version zoneRates
    active: boolean

    Indicates if the ShippingMethod is active.

    If `true`, the ShippingMethod can be used during the creation or update of a Cart or Order.
    createdAt: string

    Date and time (UTC) the ShippingMethod was initially created.

    createdBy?: CreatedBy

    IDs and references that created the ShippingMethod.

    custom?: CustomFields

    Custom Fields of the ShippingMethod.

    description?: string

    Description of the ShippingMethod.

    id: string

    Unique identifier of the ShippingMethod.

    isDefault: boolean

    Whether this ShippingMethod is 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 of the ShippingMethod.

    lastModifiedAt: string

    Date and time (UTC) the ShippingMethod was last updated.

    lastModifiedBy?: LastModifiedBy

    IDs and references that last modified the ShippingMethod.

    localizedDescription?: LocalizedString

    Localized description of the ShippingMethod.

    localizedName?: LocalizedString

    Localized name of the ShippingMethod.

    name: string

    Unique name of the ShippingMethod within a Project.

    predicate?: string

    Valid Cart predicate to select a ShippingMethod for a Cart.

    stores: StoreKeyReference[]
    • If a value exists, the Shipping Method applies to Carts with a Store that matches any Store in this field.
      • If empty, the Shipping Method applies to all Carts, irrespective of a Store.
    taxCategory: TaxCategoryReference

    TaxCategory of all ZoneRates of the ShippingMethod.

    version: number

    Current version of the ShippingMethod.

    zoneRates: ZoneRate[]

    Defines ShippingRates (prices) for specific Zones.

    Settings
    Member Visibility

    On This Page
    Properties