Skip to main content

ShippingAddon

Additional service or feature that can be added to a shipping option

type ShippingAddon {
  optionId: Int!
  secureId: String!
  name: String!
  description: String
  type: ShippingAddonType!
  price: ShippingPrice
  required: Boolean!
  value: String
}

Fields​

optionId ● Int!​

Id of the shipping option this addon belongs to

secureId ● String!​

This addon's secureId — pass it back at checkout.

name ● String!​

Name or title of the additional service or feature

description ● String​

Description of the additional service or feature

type ● ShippingAddonType!​

Type of the additional service or feature

price ● ShippingPrice​

Pricing information for the additional service or feature

required ● Boolean!​

Indicates whether the additional service or feature requires user input

value ● String​

Default value, if any

Example​

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