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;
    taxCategory: TaxCategoryReference;
    version: number;
    zoneRates: ZoneRate[];
}

Hierarchy (View Summary)

Properties

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

Properties

Readonlyactive

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.

ReadonlycreatedAt

createdAt: string

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

Optional ReadonlycreatedBy

createdBy?: CreatedBy

IDs and references that created the ShippingMethod.

Optional Readonlycustom

custom?: CustomFields

Custom Fields of the ShippingMethod.

Optional Readonlydescription

description?: string

Description of the ShippingMethod.

Deprecated

Readonlyid

id: string

Unique identifier of the ShippingMethod.

ReadonlyisDefault

isDefault: boolean

If true, 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.

Optional Readonlykey

key?: string

User-defined unique identifier of the ShippingMethod.

ReadonlylastModifiedAt

lastModifiedAt: string

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

Optional ReadonlylastModifiedBy

lastModifiedBy?: LastModifiedBy

IDs and references that last modified 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 of the ShippingMethod within a Project.

Optional Readonlypredicate

predicate?: string

Valid Cart predicate to select a ShippingMethod for a Cart.

ReadonlytaxCategory

taxCategory: TaxCategoryReference

TaxCategory of all ZoneRates of the ShippingMethod.

Readonlyversion

version: number

Current version of the ShippingMethod.

ReadonlyzoneRates

zoneRates: ZoneRate[]

Defines ShippingRates (prices) for specific Zones.

Settings

Member Visibility

On This Page

Properties