Schema
CheckoutSessionRequest
An object of the Qoene Delivery API.
Fields
| Field | Type | Description |
|---|---|---|
parcelRequired | object | The parcel as packed. |
actualWeightGramsRequired | integer | 1 to 100000 |
lengthMmRequired | integer | 1 to 5000 |
widthMmRequired | integer | 1 to 5000 |
heightMmRequired | integer | 1 to 5000 |
originRequired | object | Where the parcel starts: a drop-off point for Relay and/or a pickup address for Express. |
pointCodeOptional | string | Your drop-off Qoene Point (Relay products). |
addressOptional | object | Address text, a place, or coordinates. |
textOptional | string | 3–300 characters |
latitudeOptional | number | |
longitudeOptional | number | |
placeIdOptional | string | From GET /checkout/places. |
serviceCodesOptional | array of ServiceCode | Products to offer (default: all five). Products you cannot use are still shown as unavailable. |
payOnPickupOptional | boolean | Price the Relay offers for payment when the receiver collects (default false). |
orderReferenceOptional | string | Your order reference; booked with the selection unless the booking sends its own.Pattern ^[A-Za-z0-9][A-Za-z0-9._:/ -]{2,99}$ |
expiresInMinutesOptional | integer | Session lifetime (default 30).5 to 120 |
requestedPickupAtOptional | string (date-time) | Planned pickup or drop-off time; the promise counts from it. |
prefillOptional | object | Shown in the widget's address field. |
addressTextOptional | string | 0–300 characters |