--- title: "GET /api/checkouts" method: GET path: "/api/checkouts" tags: ["api", "checkouts"] --- # GET /api/checkouts `GET /api/checkouts` Get all checkouts ## Query parameters - `status` string[] — Filter checkouts by checkout status - `name` string — Filter checkouts by name - `email` string — The email of the checkout customer - `type` string[] — Filter checkouts by checkout type - `customerId` string — The ID of the checkout customer - `channel` union[] — Filter checkout by checkout channel - union - boolean - number - object - string - boolean - number - object - string - boolean - number - object - string - `createdAt` object — Range of dates indicating when the checkout was created in ISO format. - `$gt` string, date-time — value is greater than - `$gte` string, date-time — value is greater than or equal - `$lt` string, date-time — value is less than - `$lte` string, date-time — value is less than or equal - `$eq` string, date-time — value is equal - `$ne` string, date-time — value is not equal - `updatedAt` object — Range of dates indicating when the checkout was last updated in ISO format. - `$gt` string, date-time — value is greater than - `$gte` string, date-time — value is greater than or equal - `$lt` string, date-time — value is less than - `$lte` string, date-time — value is less than or equal - `$eq` string, date-time — value is equal - `$ne` string, date-time — value is not equal - `top` integer — A limit on the number of objects to be returned. Can range between 1 and 1000. - `skip` integer — The number of objects to skip for the requested result ## Response `200` OK - GETCheckoutsGetAllCheckouts200Response - `docs` CheckoutResource[] - `_id` string, required — The ID of the checkout. - `secret` string, 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. - `company` string — The company name of the checkout's customer. - `firstname` string — The first name of the checkout's customer. - `lastname` string — The last name of the checkout's customer. - `name` string — The full name of the checkout's customer. - `email` string, email — The email of the checkout's customer. - `phone` string — The phone number of the checkout's customer. - `customerId` string — The ID of the customer. - `address` object — The address of the checkout. - `fullAddress` string, nullable — Optional full address - `street` string, nullable — The street of the address. Street name including number. - `line2` string, nullable — The additional field of the address. - `postal` string, nullable — The postal code of the address. - `city` string, nullable — The city of the address. - `country` string, nullable — The country of the address. An ISO 3166 country code. - `state` string, nullable — The state of the address. If applicable - `deliveryAddress` object — The delivery address of the checkout. - `fullAddress` string, nullable — Optional full address - `street` string, nullable — The street of the address. Street name including number. - `line2` string, nullable — The additional field of the address. - `postal` string, nullable — The postal code of the address. - `city` string, nullable — The city of the address. - `country` string, nullable — The country of the address. An ISO 3166 country code. - `state` string, nullable — The state of the address. If applicable - `name` string — The name of the person receiving delivery. - `identification` LegalIdentificationDocumentResource[] — An array of identification items - union - object - `type` 'france_siren', required - `identifier` string, required - object - `type` 'spain_tax_id' | 'origin_country_id', required — The type of the identification document. - `sellerId` string, required — The ID of the seller of the checkout. - `items` object[], required — An array of checkout items each representing the 'bag' of one shop. - `_id` string, required — The ID of the checkout item. - `eventId` string, required — The ID of the event containing the item. - `shopId` string — The ID of the under shop this item originated from. - `channelId` string — The ID of the channel this item originated from. - `redeemedVouchers` object — An object including information on all redeemed vouchers within the checkout item. - `totalRedeemedAmount` number, float, required — The sum of all vouchers applied. - `vouchers` object[] — An array of all redeemed vouchers of the checkout item. - `_id` string — The ID of the voucher. - `code` string, required — The Code of the voucher. - `redeemedAmount` number, float, required — The applied value of the voucher. - `appliedCoupons` object[] — An array including information on all applied coupons within the checkout item. - `_id` string — The ID of the applied coupon. - `code` string — The code of the applied coupon. - `appliedDiscountInfo` object — Applied discountInfo of the checkout item. - `items` object[] — An array of applied discount info items. - `_id` string, required — The ID of the applied discount info item. - `itemId` string — The ID of the item on which the discount is applied. - `amount` number, float — The amount of applied discounts. - `regularPrice` number, float — The regular price before applying the discount. - `price` number, float — The price after applying the discount. - `varDiscounts` object[] — An array of var discounts of the applied discount info item. - `_id` string, required — The ID of the discount info. - `discountId` string — The ID of the discount of the discount info. - `category` 'coupon' | 'groupDiscount' | 'posDiscount' | 'voucher' | 'system' | 'modifier' — The category of the discount. - `name` string — The name of the discount. - `type` 'fix' | 'var' | 'fixPerItem' | 'waiveFees', required — The type of the discount. - `value` number, float — The value of the discount. - `allowedItems` string[] — An array of the IDs of allowed items of the discount. - `fixDiscounts` object[] — An array of fix discounts of the applied discount info item. - `_id` string, required — The ID of the discount info. - `discountId` string — The ID of the discount of the discount info. - `category` 'coupon' | 'groupDiscount' | 'posDiscount' | 'voucher' | 'system' | 'modifier' — The category of the discount. - `name` string — The name of the discount. - `type` 'fix' | 'var' | 'fixPerItem' | 'waiveFees', required — The type of the discount. - `value` number, float — The value of the discount. - `allowedItems` string[] — An array of the IDs of allowed items of the discount. - `discounts` object[] — An array of extended discount info items. - `_id` string, required — The ID of the discount info. - `discountId` string — The ID of the discount of the discount info. - `category` 'coupon' | 'groupDiscount' | 'posDiscount' | 'voucher' | 'system' | 'modifier' — The category of the discount. - `name` string — The name of the discount. - `type` 'fix' | 'var' | 'fixPerItem' | 'waiveFees', required — The type of the discount. - `value` number, float — The value of the discount. - `allowedItems` string[] — An array of the IDs of allowed items of the discount. - `maxItemsInCart` number, float — The maximum amount of items the discount will be applied towards. - `maxAbsoluteValue` number, float — The maximum absolute value of the discount. - `absoluteDiscountValue` number, float — The absolute value of the discount. - `regularPrice` number, float, required — The regular price of the checkout item. - `realPrice` number, float, required — The calculated price of the checkout item. - `innerFeeComponents` object — The inner fee of the transaction as a result of the checkout item including fix and var fees. - `_id` string, required — The ID of the fee composition. - `fix` object[] — An array of fee components for the fix fee. - `_id` string, required — The ID of the fee component. - `amount` number, float — The fee amount. - `value` number, float — The fee value. - `total` number, float — The fee total. Calculated with amount and value. - `type` 'onTicket' | 'onHardTicket' | 'onCart' — The fee type of the fee component. - `name` string, nullable — The name of the fee. - `publicName` string — The public name of the fee component. - `exposed` boolean — Whether this fee will be exposed to the ticket buyer. - `scheme` object — The fee scheme of the fee component. - `schemeId` string — The ID of the fee scheme. - `feeId` string — The ID of the fee scheme fee. - `var` object[] — An array of fee components for the var fee. - `_id` string, required — The ID of the fee component. - `amount` number, float — The fee amount. - `value` number, float — The fee value. - `total` number, float — The fee total. Calculated with amount and value. - `type` 'onTicket' | 'onHardTicket' | 'onCart' — The fee type of the fee component. - `name` string, nullable — The name of the fee. - `publicName` string — The public name of the fee component. - `exposed` boolean — Whether this fee will be exposed to the ticket buyer. - `scheme` object — The fee scheme of the fee component. - `schemeId` string — The ID of the fee scheme. - `feeId` string — The ID of the fee scheme fee. - `innerCharge` number, float — The inner charge of the checkout item. - `outerFeeComponents` object — The outer fee of the transaction as a result of the checkout item including fix and var fees. - `_id` string, required — The ID of the fee composition. - `fix` object[] — An array of fee components for the fix fee. - `_id` string, required — The ID of the fee component. - `amount` number, float — The fee amount. - `value` number, float — The fee value. - `total` number, float — The fee total. Calculated with amount and value. - `type` 'onTicket' | 'onHardTicket' | 'onCart' — The fee type of the fee component. - `name` string, nullable — The name of the fee. - `publicName` string — The public name of the fee component. - `exposed` boolean — Whether this fee will be exposed to the ticket buyer. - `scheme` object — The fee scheme of the fee component. - `schemeId` string — The ID of the fee scheme. - `feeId` string — The ID of the fee scheme fee. - `var` object[] — An array of fee components for the var fee. - `_id` string, required — The ID of the fee component. - `amount` number, float — The fee amount. - `value` number, float — The fee value. - `total` number, float — The fee total. Calculated with amount and value. - `type` 'onTicket' | 'onHardTicket' | 'onCart' — The fee type of the fee component. - `name` string, nullable — The name of the fee. - `publicName` string — The public name of the fee component. - `exposed` boolean — Whether this fee will be exposed to the ticket buyer. - `scheme` object — The fee scheme of the fee component. - `schemeId` string — The ID of the fee scheme. - `feeId` string — The ID of the fee scheme fee. - `outerCharge` number, float, required — The outer charge of the checkout item. - `tickets` object[] — An array containing all ticket cart items. - `type` 'ticket' — The type of the cart item. - `_id` string — Unique identifier for the cart item. If omitted, the system will automatically generate one. - `name` string, nullable — The name of the cart item. - `amount` integer, required — The amount of the cart item. - `netPrice` number, float — The single piece net price of the cart item. - `price` number, float, required — The single piece price of the cart item. - `taxRate` number, float, nullable — The tax rate to be applied to this cart item. If not present the tax rate of the transaction is taken. - `triggeredBy` union — An ID or an array of IDs of other cart items which triggered the buy action of the cart item. - string — An ID of another cart item which triggered the buy action of the cart item. - string[] — An array of IDs of other cart items which triggered the buy action of the cart item. - `bundleInfo` object, nullable - `bundleId` string - `componentId` string - `optionId` string - `ticketTypeId` string, required — The ID of the ticket type of the cart item. - `categoryRef` string — The category reference of the ticket type. - `seatingInfo` object, nullable — The associated seating object. - `_id` string — The ID of the seating object. - `_type` 6 | 7, float, required — Indicates the type of seating object. Seat = 6, General Admission = 7. - `categoryId` string — The ID of the category containing the seating object. - `statusId` string, required — The ID of a container holding information about the seating status of the seating object. - `name` string, nullable — If _type == 7. The name of the general admission. - `seatType` 'handicapped' | 'limitedView' | 'foldable', nullable — If _type == 6. The type of the seat. null = normal. - `sectionName` string, nullable — If _type == 6. The name of the section where the seat is located. - `groupName` string, nullable — If _type == 6. The name of the row group where the seat is located. - `rowName` string, nullable — If _type == 6. The name of the row where the seat is located. - `seatName` string, nullable — If _type == 6. The seat name. - `gate` string, nullable — The entry gate associated with the seating object. - `slotInfo` object, nullable — The associated time slot object. - `slotId` string, required — The ID of the time slot. - `slotStartTime` string, required — The start time of the time slot. - `asHardTicket` boolean, nullable — Whether this ticket is a hard ticket. - `listingId` string, nullable — Listing in secondary market. - `listingItemId` string, nullable — The ID of the listing item in the secondary market. - `triggeredAutomations` boolean, nullable — Whether the cart item triggered automations. - `meta` object, nullable — Meta data which is propagated to the ticket. - `addOns` object[] — A list of Add-Ons of the ticket. - `productId` string, required - `productVariantId` string, required - `name` string, required - `capabilities` union[], nullable — The capabilities of the ticket. - union - object - … - object - … - `taxInfo` object — The tax info details. - `serviceTypeId` string — The ID of the service type. - `exceptionId` string — The ID of the exception. - `proceedsAccountId` string — The ID of the proceeds account. - `proceedsAccountCode` string — The code of the proceeds account. - `taxItems` object[] — The array of tax items. - `name` string, nullable - `taxTypeId` string, nullable - `rate` number, float, required - `perUnit` number, float, required - `total` number, float, required - `netTotal` number, float, nullable - `netPerUnit` number, float, nullable - `taxPayableAccountId` string, nullable - `taxPayableAccountCode` string, nullable - `products` object[] — An array containing all product cart items. - `type` 'product', required — The type of the cart item. - `_id` string — Unique identifier for the cart item. If omitted, the system will automatically generate one. - `name` string, nullable — The name of the cart item. - `amount` integer, required — The amount of the cart item. - `netPrice` number, float — The single piece net price of the cart item. - `price` number, float, required — The single piece price of the cart item. - `taxRate` number, float, nullable — The tax rate to be applied to this cart item. If not present the tax rate of the transaction is taken. - `triggeredBy` union — An ID or an array of IDs of other cart items which triggered the buy action of the cart item. - string — An ID of another cart item which triggered the buy action of the cart item. - string[] — An array of IDs of other cart items which triggered the buy action of the cart item. - `bundleInfo` object, nullable - `bundleId` string - `componentId` string - `optionId` string - `productVariantId` string, required — The ID of the product variant. - `isFulfillable` boolean — Whether the product can be delivered - `taxInfo` object — The tax info details. - `serviceTypeId` string — The ID of the service type. - `exceptionId` string — The ID of the exception. - `proceedsAccountId` string — The ID of the proceeds account. - `proceedsAccountCode` string — The code of the proceeds account. - `taxItems` object[] — The array of tax items. - `name` string, nullable - `taxTypeId` string, nullable - `rate` number, float, required - `perUnit` number, float, required - `total` number, float, required - `netTotal` number, float, nullable - `netPerUnit` number, float, nullable - `taxPayableAccountId` string, nullable - `taxPayableAccountCode` string, nullable - `additionalItems` union[] — An array of additional price items of the checkout itemt. - union - object - `itemId` string, required — The ID of the item. - `type` 'bundle', required — The type of the additional item. - `netPrice` number, float, required — The single piece net price of the additional item. - `price` number, float, required — The single piece price of the additional item. - `taxRate` number, float, nullable, required — The tax rate to be applied to this additional item. - `taxInfo` object — The tax info details. - … - `data` object - … - object - `itemId` string, required — The ID of the item. - `type` 'fulfillmentType', required — The type of the additional item. - `netPrice` number, float, required — The single piece net price of the additional item. - `price` number, float, required — The single piece price of the additional item. - `taxRate` number, float, nullable, required — The tax rate to be applied to this additional item. - `taxInfo` object — The tax info details. - … - `data` object - … - `seatingReservationToken` string — The reservation token of the selected seats. - `subscriptionId` string — The ID of the subscription if this item triggered one. - `realPrice` number, 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. - `redeemedVouchers` object — An object including information on all redeemed vouchers of the checkout. - `totalRedeemedAmount` number, float, required — The sum of all vouchers applied. - `vouchers` object[] — An array of all redeemed vouchers of the checkout. - `_id` string — The ID of the voucher. - `code` string, required — The Code of the voucher. - `redeemedAmount` number, float, required — The applied value of the voucher. - `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. - `salesChannelId` string — The ID of the sales channel of the checkout. - `posId` string — The ID of the POS which created the checkout. - `userId` string — The ID of the user who created the checkout. - `extraFields` object — An object containing key-value information. - `expiresAt` string, date-time — An ISO Timestamp indicating when the checkout will expire. - `createdAt` string, date-time — An ISO timestamp indicating when the checkout was created. - `updatedAt` string, date-time — An ISO timestamp indicating when the checkout was last updated. - `total` integer ## Other responses - `400` — Bad Request - `401` — Unauthorized --- [API](https://skmtc.net/vivenu/apis/vivenu-api.md) · [All operations](https://skmtc.net/vivenu/apis/vivenu-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vivenu/vivenu-api/revisions/36be0dca14e7/schema)