Skip to main content

ShippingSelection

Base interface for additional shipping selections like timeslots or pickup locations

interface ShippingSelection {
  optionId: Int!
  secureId: String!
  reference: String!
  name: String!
  description: String
  price: ShippingPrice
}

Fields​

optionId ● Int!​

Id of the shipping option this selection belongs to

secureId ● String!​

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

reference ● String!​

Unique reference provided by the gateway/carrier to identify this selection

name ● String!​

Name of the selection

description ● String​

Description of the selection

price ● ShippingPrice​

Price information for this selection

Example​

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