Skip to main content

ShippingTimeslot

A specific delivery time window that can be selected for a shipping option

type ShippingTimeslot implements ShippingSelection {
  optionId: Int!
  secureId: String!
  reference: String!
  name: String!
  description: String
  price: ShippingPrice
  start: DateTime!
  end: DateTime!
}

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 option

name ● String!​

Name of the option

description ● String​

Description of the option

price ● ShippingPrice​

Price information for this option

start ● DateTime!​

Start time of the timeslot, in ISO 8601 format

end ● DateTime!​

End time of the timeslot, in ISO 8601 format

Interfaces​

ShippingSelection​

Base interface for additional shipping selections like timeslots or pickup locations

Example​

{
  "price": {
    "regularPrice": {
      "currency": {
        "code": "USD",
        "rate": 11.355,
        "prefix": "$"
      },
      "tax": {}
    }
  },
  "start": "2024-05-03T11:52:33Z"
}