latestOpenAPI 3.0.32026-08-215925112.0 MB

36be0dca14e7

api
checkout

Update checkout items

post/api/checkout/{id}/items

Path parameters

idstring required

The ID of an existing checkout

Request body

secretstring required

The secret token of the checkout

eventIdstring required

The ID of the event to create the transaction for

couponsstring[]

An array of coupon code to apply to this transaction

shopIdstring

The ID of the secret shop to create the transaction for

seatingReservationTokenstring

The reservation token of the selected seats

channelIdstring

The ID of the channel to create the transaction for

Response

OK

_idstring required

The ID of the checkout.

secretstring required

The secret token of the checkout.

status'NEW' | 'ABORTED' | 'COMPLETE' required

The status of the checkout.

type'transaction' | 'upgrade' | 'rebooking' | 'purchaseintent' | 'subscription' required

The type of the checkout.

companystring

The company name of the checkout's customer.

firstnamestring

The first name of the checkout's customer.

lastnamestring

The last name of the checkout's customer.

namestring

The full name of the checkout's customer.

emailstring email

The email of the checkout's customer.

phonestring

The phone number of the checkout's customer.

customerIdstring

The ID of the customer.

sellerIdstring required

The ID of the seller of the checkout.

realPricenumber float required

The calculated real price of the checkout.

currency'EUR' | 'USD' | 'GBP' | 'AUD' | 'CHF' | 'THB' | 'ILS' | 'COP' | 'MXN' | 'DKK' | 'NOK' | 'SEK' | 'QAR' | 'CAD' | 'ISK' | 'GTQ' | 'INR' | 'DOP' | 'SGD' | 'PLN' | 'SAR' | 'TTD' | 'ZAR' | 'KYD' | 'HKD' | 'CZK' | 'KRW' | 'JPY' | 'NZD' | 'AED' | 'MAD' | 'TWD' | 'BRL' | 'BWP' | 'NAD' | 'KES' | 'SCR' | 'TRY' | 'SZL' | 'LSL' | 'TZS' | 'UGX' | 'ZMW' | 'ZWG' | 'GHS' | 'NGN' | 'SLE' | 'LRD' | 'XOF' | 'XAF' | 'GEL' | 'IDR' | 'ARS' | 'CRC' | 'HUF' | 'EGP' | 'MYR' | 'VND' | 'PHP' | 'MWK'

An ISO 4217 3-character code of the currency.

preferredLanguage'de' | 'de-CH' | 'en' | 'en-GB' | 'en-AU' | 'fr' | 'es' | 'es-MX' | 'is' | 'it' | 'ru' | 'pt' | 'tr' | 'nb' | 'nl' | 'pl' | 'sv' | 'sl' | 'da' | 'cs' | 'lv' | 'he' | 'ar' | 'th' | 'ko' | 'ja' | 'zh-TW'

The prefered language of the checkout.

origin'yourticket' | 'pos' | 'rebooking' | 'upgrade' | 'subscription'

The origin of the checkout.

channel'online' | 'internal' | 'pos'

The channel of the checkout.

salesChannelIdstring

The ID of the sales channel of the checkout.

posIdstring

The ID of the POS which created the checkout.

userIdstring

The ID of the user who created the checkout.

extraFieldsobject

An object containing key-value information.

expiresAtstring date-time

An ISO Timestamp indicating when the checkout will expire.

createdAtstring date-time

An ISO timestamp indicating when the checkout was created.

updatedAtstring date-time

An ISO timestamp indicating when the checkout was last updated.

Example response

{
  "type": "transaction"
}