Skip to main content

ConfigEshopCheckoutShippingPolicy Object

Description​

Shipping policy configuration defining shipping costs for specific countries.

Declaration​

type ConfigEshopCheckoutShippingPolicy {
_id: String!
createdAt: Date!
updatedAt: Date!
active: Boolean!
title: String!
freeShippingThreshold: Float
surcharge: Float
overrideCarrierRates: Boolean
methods: [ConfigEshopCheckoutShippingPolicyMethods!]!
countries: [String!]!
}

Fields​

NameTypeDescription
_idString!Internal identifier for the policy.
createdAtDate!Date when the policy was created.
updatedAtDate!Date when the policy was last updated.
activeBoolean!Whether the policy is currently active.
titleString!Display title for the shipping policy.
freeShippingThresholdFloatThreshold value above which shipping is free.
surchargeFloatFixed amount added to every method priced under this policy (manual ranges and live carrier rates). Negative values reduce prices; totals never go below zero.
overrideCarrierRatesBooleanWhen true and a carrier aggregator is enabled, this policy's manual methods are used instead of live carrier rates for the countries it covers.
methods[ConfigEshopCheckoutShippingPolicyMethods!]!Shipping methods available in this policy.
countries[String!]!List of country codes this policy applies to.