Skip to main content

SelectedShipping

The customer's validated, chosen shipping. Returned by validateShippingSelection, exposed on Checkout and Order. id and totalPrice are the main contract.

id is the shipping option id totalPrice is the amount to charge. breakdown holds the detailes.

type SelectedShipping {
  id: Int!
  totalPrice: MonetaryValue!
  breakdown: SelectedShippingBreakdown!
}

Fields​

id ● Int!​

The shipping option id.

totalPrice ● MonetaryValue!​

The total to charge for shipping (the sum of the breakdown components).

breakdown ● SelectedShippingBreakdown!​

The breakdown behind totalPrice: the option line, addons and selection.

Example​

{
  "totalPrice": {
    "currency": {
      "code": "USD",
      "rate": 11.355,
      "prefix": "$"
    },
    "tax": {}
  },
  "breakdown": {
    "option": {
      "origin": {}
    },
    "addons": [
      {}
    ],
    "selection": {
      "timeslot": {
        "start": "2024-05-03T11:52:33Z"
      },
      "location": {
        "address": {}
      }
    }
  }
}