Skip to main content

ShippingOption

A shipping option provided by a gateway/carrier with pricing, options, and delivery information

type ShippingOption {
  id: Int!
  secureId: String!
  reference: String!
  gateway: String!
  provider: String
  price: ShippingPrice!
  carrier: ShippingCarrier
  name: String!
  description: ShippingOptionDescription
  requiresSelections: Boolean!
  selections(
    limit: Int = 10
    sort: ShippingSelectionsSortInput
  ): [ShippingSelection!]!
  badges: [ShippingBadge]
  icons: [Media!]
  addons: [ShippingAddon!]
  category: ShippingOptionCategory
  deliveryTime: ShippingDeliveryTime
  type: ShippingOptionType!
  infoUrl: String
}

Fields​

id ● Int!​

Unique identifier for the shipping option

secureId ● String!​

The option's secureId — pass it back at checkout (it carries the option's id + price).

reference ● String!​

Unique reference provided by the gateway/carrier to identify this shipping option

gateway ● String!​

The gateway this option belongs to

provider ● String​

The subprovider, if any, this option belongs to

price ● ShippingPrice!​

The price information for this shipping option

carrier ● ShippingCarrier​

The shipping carrier or provider information associated with this option

name ● String!​

The name or title of the shipping option

description ● ShippingOptionDescription​

Description of the shipping option, including primary and secondary text

requiresSelections ● Boolean!​

Indicates whether this shipping option has additional selections that require user selection (e.g., timeslots, pickup locations)

selections ● [ShippingSelection!]!​

List of additional selections available for this shipping option, such as delivery timeslots or pickup locations. The list can be limited and sorted based on the provided arguments.

limit ● Int​
sort ● ShippingSelectionsSortInput​

badges ● [ShippingBadge]​

Badges to highlight specific features or attributes of the shipping option (e.g., eco-friendly, express delivery)

icons ● [Media!]​

Icons associated with the shipping option, e.g. eco-labels like Svanen

addons ● [ShippingAddon!]​

Additional services or features that can be added to this shipping option (e.g., SMS notifications, contactless delivery)

category ● ShippingOptionCategory​

Category of the shipping option indicating the type of delivery (e.g., pickup, home delivery)

deliveryTime ● ShippingDeliveryTime​

Estimated delivery timeframe for this shipping option

type ● ShippingOptionType!​

Type of the shipping option indicating specific delivery or pickup type (e.g., pickup point, postal delivery)

infoUrl ● String​

URL with more information about this shipping option, if provided by the gateway/carrier

Example​

{
  "price": {
    "regularPrice": {
      "currency": {
        "code": "USD",
        "rate": 11.355,
        "prefix": "$"
      },
      "tax": {}
    }
  },
  "carrier": {
    "logo": {
      "link": [
        {
          "url": {
            "language": "EN",
            "value": "String"
          },
          "alternateUrls": [
            {}
          ],
          "redirect": {}
        }
      ],
      "modifiedAt": "2024-05-03T11:52:33Z"
    }
  },
  "description": {},
  "selections": [
    {}
  ],
  "badges": [
    {}
  ],
  "addons": [
    {}
  ],
  "deliveryTime": {
    "interval": {}
  }
}