--- title: "GET /api/pos/{id}/collect-checkout/{checkoutId}" method: GET path: "/api/pos/{id}/collect-checkout/{checkoutId}" tags: ["api"] --- # GET /api/pos/{id}/collect-checkout/{checkoutId} `GET /api/pos/{id}/collect-checkout/{checkoutId}` Collect Checkout Data ## Path parameters - `id` string, required - `checkoutId` string, required ## Response `200` OK - CheckoutPOSDataResource - `checkout` CheckoutResource — The associated checkout - `_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. - `posData` object[] — An array of data for every transaction of a POS Checkout - `transaction` TransactionResource - `_id` string, required — The ID of the transaction - `sellerId` string, required — The ID of the seller of the transaction - `customerId` string — The ID of the customer of the transaction - `eventId` string, required — The ID of the event containing this transaction - `company` string — The company name of the user of the transaction - `name` string — The name of the user of the transaction - `prename` string — The firstname of the user of the transaction - `lastname` string — The lastname of the user of the transaction - `email` string, email — The email of the user of the transaction - `street` string — The street of the user of the transaction - `line2` string — The additional address field of the user of the transaction. - `city` string — The city of the user of the transaction - `state` string — The state of the user of the transaction - `country` string — The country of the user of the transaction - `postal` string — The postal of the user of the transaction - `deliveryAddress` object — The delivery address of the transaction - `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. - `tickets` object[] — An array of cart ticket items of the transaction - `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 of cart product items of the transaction - `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 transaction - 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 - … - `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 - `regularPrice` number, float — The regular price of the transaction - `realPrice` number, float, required — The calculated real price of the transaction - `paymentCharge` number, float — The payment charge of the transaction - `innerCharge` number, float — The inner charge of the transaction - `outerCharge` number, float — The outer charge of the transaction - `innerFeeComponents` object — The inner fee of the transaction including fix and var fee - `_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. - `outerFeeComponents` object — The outer fee of the transaction including fix and var fee - `_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. - `cancellationFee` object — The cancellation fee of the transaction - `_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. - `cancellationInfo` object — The cancellation info of the transaction - `cancellableItems` object[] — An array of cancellable items - `cartItemId` string, required — The ID of the cart to which the item belongs to - `type` 'ticket' | 'product' | 'fee' | 'discount' | 'fulfillment' | 'insurance', required — The type of the item indicated where it originated from - `name` string, nullable — The name of the item - `price` number, float, required — The price of the item - `taxRate` number, float — The applied tax rate for that item - `origin` union — Object indicating where the item originated from - object - … - object - … - object - … - `cancellationFee` object — The cancellation fee of the item. Is set when cancellation fees are charged at cancellation - `_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. - … - `refundId` string — The ID of the refund. Is set when item was refunded - `cancelledAt` string, date-time — A date indicating when the item has been cancelled - `refundableByTarget` object — Remaining refundable amounts for this transaction, keyed by refund target - `taxRate` number, float — The tax rate of the transaction - `createdAt` string, date-time — An ISO timestamp indicating when the transaction was created - `updatedAt` string, date-time — An ISO Timestamp indicating when the voucher was last updated - `status` 'NEW' | 'RESERVED-BY-SYSTEM' | 'ABORTED' | 'COMPLETE' | 'CANCELED', required — The status of the transaction. - `psp` string - `paymentMethod` 'paypal' | 'stripe' | 'local' | 'external' | 'vivenu-payments' — The payment method of the transaction. - `paymentInfo` object — The payment info of the transaction - `_id` string, required — The ID of the payment info - `psp` string - `gateway` 'managed' | 'external' | 'local' — The payment gateway of the payment. - `providerType` 'stripeConnect' | 'vivenu' — The payment provider of the payment. - `providerId` string — The ID of the provider of the payment - `method` string — The method of the payment - `methodVariant` string — The method variant of the payment - `locale` string — The locale of the payment - `riskLevel` string — The risk level of the payment - `riskScore` number, float — The risk score of the payment - `refundId` string — The ID of the refund of the payment - `collectedApplicationFee` number, float — The application fee of the payment - `paymentStatus` 'AWAITING' | 'PENDING' | 'RECEIVED' | 'REFUND' | 'CANCELED' | 'FAILED' | 'DISPUTE' | 'CHARGEBACK' | 'POS-RECEIVED' | 'POS-CANCELED' | 'LOCAL-PENDING' | 'LOCAL-AWAITING' | 'LOCAL-RECEIVED' | 'EXTERNAL' — The payment status of the transaction. - `origin` 'yourticket' | 'pos' | 'rebooking' | 'upgrade' | 'subscription' — The origin of the transaction. - `subscriptionId` string — The ID of the subscription of the transaction - `userId` string — The ID of the user who created the transaction. - `posId` string — The ID of pos of the transaction - `posInfo` object — The POS info of the transaction - `_id` string, required — The ID of the POS info - `sessionId` string — The ID of the session of the POS - `billingNo` string — The billing no of the POS - `taxId` string — The tax ID of the POS - `paymentMethod` string — The payment method of the POS. - `canceledAt` string, date-time — The cancellation Date of the POS - `cancellationNo` string, date-time — The cancellation no of the POS - `history` object[] — An array of history entry items of the transaction - `_id` string, required — The ID of the transaction history entry - `date` string, date-time — The date of the history entry - `title` string — The title of the history entry - `message` string — A message which describes the history entry - `type` 'PAYMENT' | 'YOURTICKET' | 'USER' — The type of the history entry. - `risk` 'DANGER' | 'NEUTRAL' | 'GOOD' — The risk of the transaction history entry. NEUTRAL = is a neutral risk of the transaction. GOOD = is a good risk factor of the transaction, which means less risk. DANGER = is a danger risk factor of the transaction, which means high risk. - `historyEntries` object[] — An array of history entry items of the transaction - `_id` string, required — The ID of the transaction history entry - `date` string, date-time — The date of the history entry - `userId` string — The ID of the user of the history entry - `data` object — The data of the history entry - `type` 'created' | 'reserved' | 'completed' | 'completed.manually' | 'aborted' | 'canceled' | 'partial.canceled' | 'pos.created' | 'pos.canceled' | 'pos.payment.method.changed' | 'payment.canceled' | 'payment.authorized' | 'payment.failed' | 'payment.succeeded' | 'payment.chargeback' | 'payment.localReceived' | 'dispute.created' | 'dispute.countered' | 'dispute.won' | 'dispute.lost' | 'refunded' | 'partial.refunded' | 'refund.failed' | 'partial.refunded.voucher' | 'refunded.voucher' | 'partial.refunded.balance' | 'refunded.balance' | 'payment.local.added' | 'payment_correction.refund.missing_in_core' | 'payment_correction.refund.failed' | 'price.recalculated' | 'invitation.reserved.mail' | 'transaction.resent.mail' | 'transaction.resent.ticket_mail' | 'transaction.resent.voucher_mail' | 'tickets.booked' | 'transaction.sent.sms' | 'commented' — The type of the history entry. - `risk` 'DANGER' | 'NEUTRAL' | 'GOOD' — The risk of the transaction history entry. NEUTRAL = is a neutral risk of the transaction. GOOD = is a good risk factor of the transaction, which means less risk. DANGER = is a danger risk factor of the transaction, which means high risk. - `ticketMailSend` boolean — Whether the mail with the ticket of the transaction was sent - `orderMailSend` boolean — Whether the mail with the order of the transaction was sent - `extraFields` object — The extra fields of the transaction - `channel` string — The channel of the transaction - `underShop` string — The under shop of the transaction - `userAgent` object — The User Agent of the transaction - `_id` string, required — The ID of the User Agent - `ua` string — The user agent - `browser` object — The browser of the user - `device` object — The device of the user - `engine` object — The engine of the user - `os` object — The OS of the user - `cpu` object — The CPU of the user - `ipLookup` object — The IP lookup info of the transaction - `ip` string — The IP address of the IP lookup info - `lookup` object — The IP lookup result - `range` number[] — The Range of the ip adress - `country` string — The country of the IP lookup - `region` string — The region of the IP lookup - `eu` string - `timezone` string — The timezone of the IP lookup - `city` string — The city city of the IP lookup - `ll` number[] - `metro` number, float - `area` number, float - `locationCenter` number[] - `secret` string, required — The secret token of the transaction - `vouchers` string[] — An array of voucher codes applied to this transaction - `redeemedVouchers` object — An array of voucher codes redeemed for this transaction - `totalRedeemedAmount` number, float, required — The sum of all vouchers applied. - `vouchers` object[] — An array of all redeemed vouchers. - `_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 of applied coupons within the transaction - `_id` string — The ID of the applied coupon. - `code` string — The code of the applied coupon. - `appliedDiscountGroups` string[] — An array of discount groups applied to the transaction - `posDiscounts` object[] — An array of POS discounts - `_id` string, required — The ID of the POS discount - `name` string, required — The name of the POS discount - `discountType` 'TOTAL' | 'PERCENTAGE' | 'fix' | 'var' — The discount type. - `value` number, float, required — The value of the POS discount - `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 preferred language of the transaction. It is determined automatically - `cancellationReason` 'REQUESTED_BY_CUSTOMER' | 'CLAIM' | 'COMMUNICATION_ERROR' | 'TRAINING/TEST' — The reason of the cancellation of the transaction - `appliedDiscountInfo` object — Applied discountInfo for the transaction - `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. - `invoiceVersion` string — The invoice version of the transaction. - `seatingReservationToken` string — The seating reservation token of the transaction - `tickets` TicketResource[] — An array of tickets of the transaction - `_id` string, required - `sellerId` string, required — The ID of the seller that ticket belongs to. - `company` string - `email` string - `name` string — The name of the ticket owner - `firstname` string — The first name of the ticket owner - `lastname` string — The last name of the ticket owner - `street` string - `line2` string — The additional address field of the user of the ticket - `city` string - `postal` string - `state` string — The state of the user of the ticket - `country` string — The country of the user of the ticket - `eventId` string, required — The ID of the event the ticket belongs to - `rootEventId` string — The ID of the root event, if exists - `transactionId` string — The transaction the ticket originated from - `posId` string — The point of sale the ticket was created on - `underShopId` string — The ID of an undershop the ticket was purchased through - `categoryRef` string — A UUID of the category the ticket belongs to. - `categoryName` string — The name of the category the ticket belongs to. - `ticketTypeId` string, required — The ID of the ticket type this ticket inherits from - `slotId` string — The ID of the time slot this ticket belongs to, if exists - `slotStartTime` string — The start time of the time slot this ticket belongs to, if exists. - `cartItemId` string — The ID of the cart item to which the ticket belongs - `triggeredBy` string[] — An array of IDs of cart items which triggered the buy action of the ticket - `ticketName` string, required — The name of the ticket type this ticket inherits from - `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 - `regularPrice` number, float — The original non discounted price for the ticket - `realPrice` number, float — The real price for the ticket - `completed` boolean — Whether all steps for validating the ticket has been made - `createdAt` string, date-time, required — An ISO Timestamp indicating when the ticket was created. - `updatedAt` string, date-time, required — An ISO Timestamp indicating when the ticket was updated. - `expiresAt` string, date-time — An ISO Timestamp indicating when the ticket will be expired. - `status` 'VALID' | 'INVALID' | 'RESERVED' | 'DETAILSREQUIRED' | 'BLANK', required — The status of the ticket - `secret` string, required — The secret token of the ticket - `barcode` string, required — The barcode of the ticket - `seat` string - `seatingInfo` object — 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. - `type` 'SINGLE' | 'MULTI' — The type of the ticket - `origin` 'yourticket' | 'pos' | 'rebooking' | 'upgrade' | 'subscription' | 'transfer' - `extraFields` object — A hashmap of extra fields for the ticket - `batch` string — A UUId indicating in which batch the tickets were created - `batchCounter` number, float — A counter indicating the order of the ticket in the batch - `deliveryType` 'HARD' | 'VIRTUAL' — The delivery type of the ticket - `readyForDelivery` boolean — Whether the ticket is ready for delivery - `customMessage` string - `priceCategoryId` string - `entryPermissions` union[] - union - boolean - number - object - string - `customerId` string - `history` union[] - union - boolean - number - object - string - `personalized` boolean - `excludedEventIds` string[] — An array of IDs of events for which the ticket has been blocked - `originTicketId` string — The ID of the origin ticket from which the ticket created - `fulfillmentTypeId` string — The ID of the fulfillment type used to deliver the ticket - `packageInfo` object — The package information of the ticket - `packageId` string, required — The ID of the package - `packageConfigId` string, required — The ID of the package configuration - `name` string, required — The name of the package - `__v` integer - `_locks` object[] — List of locks on this ticket - `by` string, required - `at` string, date-time, required - `eventId` string - `type` union - boolean - number - object - 'resell' - `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 - `type` 'self_service_return', required - `settings` object, required - … - object - `type` 'repersonalization', required - `settings` object, required - … - `personalizations` union[] — A list of personalizations of the ticket. - union - boolean - number - object - string - `vouchers` VoucherResource[] — An array of vouchers that was bought by the transaction - `code` string, required — Code used to redeem the voucher - `amount` number, float, required — The amount of the voucher in seller's currency. eg. 50.0 -> 50 EUR - `validUntil` string, date-time — The date until this voucher can be redeemed. - `sellerId` string — The ID of the seller of the voucher - `transactionId` string — The ID of the transaction if the voucher was a result of a transaction - `productId` string — The ID of the product if the voucher was a result of a product - `refundId` string — The ID of the refund if the voucher was a result of a refund - `customerId` string — The ID of the customer if the voucher was created for a specific customer - `origin` 'default' | 'shop' | 'import' | 'upgrade' | 'refund' — The origin of the voucher - `createdAt` string, date-time, required — An ISO Timestamp indicating when the voucher was created. - `updatedAt` string, date-time, required — An ISO Timestamp indicating when the voucher was last updated. - `invoice` InvoiceResource — The invoice of the transaction - `_id` string, required — The ID of the invoice. - `type` 'invoice' | 'cancellation' — The type of the invoice. - `sellerId` string, required — The ID of the seller associated with the invoice. - `recipient` object, required — Information on the recipient of the invoice. - `company` string — The company name of the recipient. - `name` string, required — The name of the recipient. - `firstname` string, required — The first name of the recipient. - `lastname` string, required — The last name of the recipient. - `address` object — The address of the recipient. - `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 - `transactionId` string — The ID of the transaction the invoice originated from. - `cancellationId` string — The ID of the associated cancellation. - `counter` number, float, required — The counter used to create no. - `no` string, required — A unique number for the invoice consisting of the creation date and an increasing counter. - `items` object[], required — An array of invoice items. - `type` 'product' | 'ticket' | 'fulfillment' | 'outerCharge' | 'discount' | 'voucher' | 'bundle' | 'additionalFee' | 'insurance' — The type of the invoice item. - `title` string, required — The title of the invoice item. - `amount` number, float, required — The amount of the invoice item. - `total` number, float, required — The total of the invoice item. - `regularTotal` number, float, required — The non-discounted total of the invoice item. - `includedTax` number, float, required — The total of taxes included in the invoice item. - `taxRate` number, float, required — The tax rate applied on the invoice item. - `components` object[] — An array of exposed price components. - `name` string - `total` number, float - `total` number, float — The invoice total after discounts and taxes. - `discountSum` number, float — The total of all discounts applied. - `detailsPerRate` object[] — The tax details grouped by tax rates. - `taxRate` number, float, required — The applied tax rate. - `includedTax` number, float, required — The total of taxes associated with the tax rate. - `reducedTax` number, float, required — The tax reduction through applied discounts. - `taxItems` object[] — An 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 - `includedTax` number, float — The total of all taxes included. - `taxRate` number, float — The default tax rate applied on items. - `includedOuterChargeTax` number, float — The total of all taxes on included outer charges. - `outerChargeTaxRate` number, float — The tax rate applied on outer charges. - `origin` 'onlinesale' | 'pos' — Whether the invoice has been created through an online or offline transaction. - `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', required — An ISO 4217 3-character code of the currency. - `extraFields` object — The extra fields of the invoice. - `secret` string — The secret of the invoice. - `referenceInvoiceId` string — The reference invoice which the invoice evolved from. - `footerText` string[] — The custom footer columns of the invoice. - `createdAt` string, date-time — An ISO Timestamp indicating when the invoice was created. - `updatedAt` string, date-time — An ISO Timestamp indicating when the invoice was last updated. - `posNo` string — The pos number of the POS of the transaction ## 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)