Skip to main content

ShippingPriceInput

Input for creating or updating a shipping method (price).

input ShippingPriceInput {
name: String
price: PositiveDecimal
minimumOrderPrice: PositiveDecimal
maximumOrderPrice: PositiveDecimal
minimumOrderWeight: WeightScalar
maximumOrderWeight: WeightScalar
type: ShippingMethodTypeEnum
shippingZone: ID
requiresSecondaryAddress: Boolean
}

Fields

ShippingPriceInput.name ● String scalar

Name of the shipping method.

ShippingPriceInput.price ● PositiveDecimal scalar

Shipping price of the shipping method.

ShippingPriceInput.minimumOrderPrice ● PositiveDecimal scalar

Minimum order price to use this shipping method (for PRICE_BASED type).

ShippingPriceInput.maximumOrderPrice ● PositiveDecimal scalar

Maximum order price to use this shipping method (for PRICE_BASED type).

ShippingPriceInput.minimumOrderWeight ● WeightScalar scalar

Minimum order weight in kg (for WEIGHT_BASED type).

ShippingPriceInput.maximumOrderWeight ● WeightScalar scalar

Maximum order weight in kg (for WEIGHT_BASED type).

ShippingPriceInput.type ● ShippingMethodTypeEnum enum

Shipping type: price or weight based.

ShippingPriceInput.shippingZone ● ID scalar

Shipping zone this method belongs to.

ShippingPriceInput.requiresSecondaryAddress ● Boolean scalar

Whether this shipping method requires a secondary address.

Member Of

shippingPriceCreate mutation ● shippingPriceUpdate mutation

Was this page helpful?