Interface ShippingInfo

interface ShippingInfo {
    deliveries?: Delivery[];
    discountedPrice?: DiscountedLineItemPrice;
    price: CentPrecisionMoney;
    shippingMethod?: ShippingMethodReference;
    shippingMethodName: string;
    shippingMethodState: string;
    shippingRate: ShippingRate;
    taxCategory?: TaxCategoryReference;
    taxedPrice?: TaxedItemPrice;
    taxRate?: TaxRate;
}

Properties

deliveries? discountedPrice? price shippingMethod? shippingMethodName shippingMethodState shippingRate taxCategory? taxedPrice? taxRate?

Properties

Optional Readonlydeliveries

deliveries?: Delivery[]

Information on how items are delivered to customers.

Optional ReadonlydiscountedPrice

discountedPrice?: DiscountedLineItemPrice

Discounted price of the Shipping Method.

Readonlyprice

price: CentPrecisionMoney

Determined based on the ShippingRate and its tiered prices, and either the sum of LineItem prices or the shippingRateInput field.

Optional ReadonlyshippingMethod

shippingMethod?: ShippingMethodReference

Not set if a custom Shipping Method is used.

ReadonlyshippingMethodName

shippingMethodName: string

Name of the Shipping Method.

ReadonlyshippingMethodState

shippingMethodState: string

Indicates whether the ShippingMethod referenced in this ShippingInfo is allowed for the Cart.

ReadonlyshippingRate

shippingRate: ShippingRate

Used to determine the price.

Optional ReadonlytaxCategory

taxCategory?: TaxCategoryReference

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

Optional ReadonlytaxedPrice

taxedPrice?: TaxedItemPrice

Automatically set after the taxRate is set.

Optional ReadonlytaxRate

taxRate?: TaxRate

Automatically set in the Platform TaxMode after the shipping address is set.

For the `External` [TaxMode](ctp:api:type:TaxMode) the Tax Rate must be set explicitly with the [ExternalTaxRateDraft](ctp:api:type:ExternalTaxRateDraft).

Settings

Member Visibility

On This Page

Properties