Skip to main content

FreeShippingLimit

Representation of free shipping limit

type FreeShippingLimit {
  remainingAmount: MonetaryValue
  requiredSum: MonetaryValue
  estimatedPrice: MonetaryValue
  remindCustomer: Boolean
}

Fields​

remainingAmount ● MonetaryValue​

Remaining amount until free shipping is granted

requiredSum ● MonetaryValue​

The amount needed to be granted free shipping

estimatedPrice ● MonetaryValue​

The estimated price of the shipping

remindCustomer ● Boolean​

Should customer be remineded about free shipping

Example​

{
  "remainingAmount": {
    "currency": {
      "code": "USD",
      "rate": 11.355,
      "prefix": "$"
    },
    "tax": {}
  }
}