Skip to main content

ShippingLocation

A pickup point location where the customer can collect their shipment

type ShippingLocation implements ShippingSelection {
  optionId: Int!
  secureId: String!
  reference: String!
  name: String!
  description: String
  price: ShippingPrice
  address: ShippingLocationAddress!
  coordinates: ShippingLocationCoordinates
  openHours: ShippingLocationOpenHours
  distance: Float
}

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 selection

price ● ShippingPrice​

Price information for this selection

address ● ShippingLocationAddress!​

Physical address of the pickup location

coordinates ● ShippingLocationCoordinates​

Geographic coordinates of the pickup location

openHours ● ShippingLocationOpenHours​

Opening hours information for the pickup location

distance ● Float​

Distance in kilometers, if applicable

Interfaces​

ShippingSelection​

Base interface for additional shipping selections like timeslots or pickup locations

Example​

{
  "price": {
    "regularPrice": {
      "currency": {
        "code": "USD",
        "rate": 11.355,
        "prefix": "$"
      },
      "tax": {}
    }
  },
  "address": {},
  "coordinates": {},
  "openHours": {
    "intervals": [
      {}
    ]
  }
}