Developers
API referenceBusiness sign in

Checkout

Widget start-up details

GET/checkout/config

Browser · publishable key

Browser only, called by the widget. The merchant name, environment and whether address suggestions are available; with X-Qoene-Checkout-Session, the session's products, parcel and prefill.

Request

No parameters.

Response

Success responses
StatusMeaning
200Configuration

The body is { "status": "success", "data": … }. Fields of data (CheckoutConfig):

Response data
FieldTypeDescription
merchantRequiredobject
nameRequiredstring
environmentRequiredEnvironmentThe key environment. TEST never touches live custody, payments, dispatch or notifications.
widgetVersionOptionalstring
placesRequiredboolean
sessionRequiredobject or null
idOptionalstring
expiresAtOptionalstring (date-time)
serviceCodesOptionalarray of ServiceCode
prefillOptionalobject or null
parcelOptionalobjectThe parcel as packed.
actualWeightGramsRequiredinteger1 to 100000
lengthMmRequiredinteger1 to 5000
widthMmRequiredinteger1 to 5000
heightMmRequiredinteger1 to 5000

Errors

Errors use the error envelope { "status": "error", "message", "code"?, "details"? }.

Error responses
StatusWhen
401Missing, invalid, expired or revoked API key. The API key is missing, invalid, expired or revoked.
403The key lacks the scope, or the operation needs a LIVE key. The key lacks the scope, or this call needs a LIVE key (LIVE_KEY_REQUIRED), or the Business owner is not verified (SENDER_VERIFICATION_REQUIRED).
410The checkout session or price has expired.
429Too many requests. See the RateLimit headers. Too many requests. Wait for Retry-After, then retry with the same idempotency key.