Developers
API referenceBusiness sign in

Schema

CheckoutSessionRequest

An object of the Qoene Delivery API.

Fields

CheckoutSessionRequest fields
FieldTypeDescription
parcelRequiredobjectThe parcel as packed.
actualWeightGramsRequiredinteger1 to 100000
lengthMmRequiredinteger1 to 5000
widthMmRequiredinteger1 to 5000
heightMmRequiredinteger1 to 5000
originRequiredobjectWhere the parcel starts: a drop-off point for Relay and/or a pickup address for Express.
pointCodeOptionalstringYour drop-off Qoene Point (Relay products).
addressOptionalobjectAddress text, a place, or coordinates.
textOptionalstring3–300 characters
latitudeOptionalnumber
longitudeOptionalnumber
placeIdOptionalstringFrom GET /checkout/places.
serviceCodesOptionalarray of ServiceCodeProducts to offer (default: all five). Products you cannot use are still shown as unavailable.
payOnPickupOptionalbooleanPrice the Relay offers for payment when the receiver collects (default false).
orderReferenceOptionalstringYour order reference; booked with the selection unless the booking sends its own.Pattern ^[A-Za-z0-9][A-Za-z0-9._:/ -]{2,99}$
expiresInMinutesOptionalintegerSession lifetime (default 30).5 to 120
requestedPickupAtOptionalstring (date-time)Planned pickup or drop-off time; the promise counts from it.
prefillOptionalobjectShown in the widget's address field.
addressTextOptionalstring0–300 characters

Used by