Checkout

The Checkout API is used to handle end customers purchasing a set of cart items, whereas cart items can include tickets and products. Checkout objects keep track of the state and can span over multiple events.

The following workflow illustrates how cart items are managed by checkout objects.

Each Checkout Item belongs to one eventId and represents the cart for this particular event. Thus, if N is the amount of checkout items, N transactions will be created upon completion.

Each Checkout Item consists of multiple cart items, they represent single line items in the cart. Either tickets or products.

Endpoints

The Checkout Object

Attributes

_id

Required

string

The ID of the checkout.

secret

Required

string

The secret token of the checkout.

status

Required

string

The status of the checkout.

NEWABORTEDCOMPLETE

type

Required

string

The type of the checkout.

transactionupgraderebookingpurchaseintentsubscription

sellerId

Required

string

The ID of the seller of the checkout.

items

Required

array

An array of checkout items each representing the 'bag' of one shop.

items[]._id

Required

string

The ID of the checkout item.

items[].eventId

Required

string

The ID of the event containing the item.

items[].regularPrice

Required

number float

The regular price of the checkout item.

items[].realPrice

Required

number float

The calculated price of the checkout item.

items[].outerCharge

Required

number float

The outer charge of the checkout item.

Optional Attributes

Collapse all

items[].shopId

Optional

string

The ID of the under shop this item originated from.

items[].channelId

Optional

string

The ID of the channel this item originated from.

items[].redeemedVouchers

Optional

object

An object including information on all redeemed vouchers within the checkout item.

items[].redeemedVouchers.totalRedeemedAmount

Required

number float

The sum of all vouchers applied.

Optional Attributes

Collapse all

items[].redeemedVouchers.vouchers

Optional

array

An array of all redeemed vouchers of the checkout item.

items[].redeemedVouchers.vouchers[]._id

Required

string

The ID of the voucher.

items[].redeemedVouchers.vouchers[].code

Required

string

The Code of the voucher.

items[].redeemedVouchers.vouchers[].redeemedAmount

Required

number float

The applied value of the voucher.

items[].appliedCoupons

Optional

array

An array including information on all applied coupons within the checkout item.

Optional Attributes

Collapse all

items[].appliedCoupons[]._id

Optional

string

The ID of the applied coupon.

items[].appliedCoupons[].code

Optional

string

The code of the applied coupon.

items[].appliedDiscountInfo

Optional

object

Applied discountInfo of the checkout item.

Optional Attributes

Collapse all

items[].appliedDiscountInfo.items

Optional

array

An array of applied discount info items.

items[].appliedDiscountInfo.items[]._id

Required

string

The ID of the applied discount info item.

Optional Attributes

Collapse all

items[].appliedDiscountInfo.items[].itemId

Optional

string

The ID of the item on which the discount is applied.

items[].appliedDiscountInfo.items[].amount

Optional

number float

The amount of applied discounts.

items[].appliedDiscountInfo.items[].regularPrice

Optional

number float

The regular price before applying the discount.

items[].appliedDiscountInfo.items[].price

Optional

number float

The price after applying the discount.

items[].appliedDiscountInfo.items[].varDiscounts

Optional

array

An array of var discounts of the applied discount info item.

items[].appliedDiscountInfo.items[].varDiscounts[]._id

Required

string

The ID of the discount info.

items[].appliedDiscountInfo.items[].varDiscounts[].type

Required

string

The type of the discount.

fixvarfixPerItem

Optional Attributes

Collapse all

items[].appliedDiscountInfo.items[].varDiscounts[].discountId

Optional

string

The ID of the discount of the discount info.

items[].appliedDiscountInfo.items[].varDiscounts[].category

Optional

string

The category of the discount.

coupongroupDiscountposDiscountvoucher

items[].appliedDiscountInfo.items[].varDiscounts[].name

Optional

string

The name of the discount.

items[].appliedDiscountInfo.items[].varDiscounts[].value

Optional

number float

The value of the discount.

items[].appliedDiscountInfo.items[].varDiscounts[].allowedItems

Optional

array<string>

An array of the IDs of allowed items of the discount.

items[].appliedDiscountInfo.items[].fixDiscounts

Optional

array

An array of fix discounts of the applied discount info item.

items[].appliedDiscountInfo.items[].fixDiscounts[]._id

Required

string

The ID of the discount info.

items[].appliedDiscountInfo.items[].fixDiscounts[].type

Required

string

The type of the discount.

fixvarfixPerItem

Optional Attributes

Collapse all

items[].appliedDiscountInfo.items[].fixDiscounts[].discountId

Optional

string

The ID of the discount of the discount info.

items[].appliedDiscountInfo.items[].fixDiscounts[].category

Optional

string

The category of the discount.

coupongroupDiscountposDiscountvoucher

items[].appliedDiscountInfo.items[].fixDiscounts[].name

Optional

string

The name of the discount.

items[].appliedDiscountInfo.items[].fixDiscounts[].value

Optional

number float

The value of the discount.

items[].appliedDiscountInfo.items[].fixDiscounts[].allowedItems

Optional

array<string>

An array of the IDs of allowed items of the discount.

items[].appliedDiscountInfo.discounts

Optional

array

An array of extended discount info items.

items[].appliedDiscountInfo.discounts[]._id

Required

string

The ID of the discount info.

items[].appliedDiscountInfo.discounts[].type

Required

string

The type of the discount.

fixvarfixPerItem

Optional Attributes

Collapse all

items[].appliedDiscountInfo.discounts[].discountId

Optional

string

The ID of the discount of the discount info.

items[].appliedDiscountInfo.discounts[].category

Optional

string

The category of the discount.

coupongroupDiscountposDiscountvoucher

items[].appliedDiscountInfo.discounts[].name

Optional

string

The name of the discount.

items[].appliedDiscountInfo.discounts[].value

Optional

number float

The value of the discount.

items[].appliedDiscountInfo.discounts[].allowedItems

Optional

array<string>

An array of the IDs of allowed items of the discount.

items[].appliedDiscountInfo.discounts[].maxItemsInCart

Optional

number float

The maximum amount of items the discount will be applied towards.

items[].appliedDiscountInfo.discounts[].maxAbsoluteValue

Optional

number float

The maximum absolute value of the discount.

items[].appliedDiscountInfo.discounts[].absoluteDiscountValue

Optional

number float

The absolute value of the discount.

items[].innerFeeComponents

Optional

object

The inner fee of the transaction as a result of the checkout item including fix and var fees.

items[].innerFeeComponents._id

Required

string

The ID of the fee composition.

Optional Attributes

Collapse all

items[].innerFeeComponents.fix

Optional

array

An array of fee components for the fix fee.

items[].innerFeeComponents.fix[]._id

Required

string

The ID of the fee component.

Optional Attributes

Collapse all

items[].innerFeeComponents.fix[].amount

Optional

number float

The fee amount.

items[].innerFeeComponents.fix[].value

Optional

number float

The fee value.

items[].innerFeeComponents.fix[].total

Optional

number float

The fee total. Calculated with amount and value.

items[].innerFeeComponents.fix[].type

Optional

string

The fee type of the fee component.

onTicketonHardTicketonCart

items[].innerFeeComponents.fix[].name

Optional

string

The name of the fee.

items[].innerFeeComponents.fix[].exposed

Optional

boolean

Whether this fee will be exposed to the ticket buyer.

items[].innerFeeComponents.fix[].scheme

Optional

object

The fee scheme of the fee component.

Optional Attributes

Collapse all

items[].innerFeeComponents.fix[].scheme.schemeId

Optional

string

The ID of the fee scheme.

items[].innerFeeComponents.fix[].scheme.feeId

Optional

string

The ID of the fee scheme fee.

items[].innerFeeComponents.var

Optional

array

An array of fee components for the var fee.

items[].innerFeeComponents.var[]._id

Required

string

The ID of the fee component.

Optional Attributes

Collapse all

items[].innerFeeComponents.var[].amount

Optional

number float

The fee amount.

items[].innerFeeComponents.var[].value

Optional

number float

The fee value.

items[].innerFeeComponents.var[].total

Optional

number float

The fee total. Calculated with amount and value.

items[].innerFeeComponents.var[].type

Optional

string

The fee type of the fee component.

onTicketonHardTicketonCart

items[].innerFeeComponents.var[].name

Optional

string

The name of the fee.

items[].innerFeeComponents.var[].exposed

Optional

boolean

Whether this fee will be exposed to the ticket buyer.

items[].innerFeeComponents.var[].scheme

Optional

object

The fee scheme of the fee component.

Optional Attributes

Collapse all

items[].innerFeeComponents.var[].scheme.schemeId

Optional

string

The ID of the fee scheme.

items[].innerFeeComponents.var[].scheme.feeId

Optional

string

The ID of the fee scheme fee.

items[].innerCharge

Optional

number float

The inner charge of the checkout item.

items[].outerFeeComponents

Optional

object

The outer fee of the transaction as a result of the checkout item including fix and var fees.

items[].outerFeeComponents._id

Required

string

The ID of the fee composition.

Optional Attributes

Collapse all

items[].outerFeeComponents.fix

Optional

array

An array of fee components for the fix fee.

items[].outerFeeComponents.fix[]._id

Required

string

The ID of the fee component.

Optional Attributes

Collapse all

items[].outerFeeComponents.fix[].amount

Optional

number float

The fee amount.

items[].outerFeeComponents.fix[].value

Optional

number float

The fee value.

items[].outerFeeComponents.fix[].total

Optional

number float

The fee total. Calculated with amount and value.

items[].outerFeeComponents.fix[].type

Optional

string

The fee type of the fee component.

onTicketonHardTicketonCart

items[].outerFeeComponents.fix[].name

Optional

string

The name of the fee.

items[].outerFeeComponents.fix[].exposed

Optional

boolean

Whether this fee will be exposed to the ticket buyer.

items[].outerFeeComponents.fix[].scheme

Optional

object

The fee scheme of the fee component.

Optional Attributes

Collapse all

items[].outerFeeComponents.fix[].scheme.schemeId

Optional

string

The ID of the fee scheme.

items[].outerFeeComponents.fix[].scheme.feeId

Optional

string

The ID of the fee scheme fee.

items[].outerFeeComponents.var

Optional

array

An array of fee components for the var fee.

items[].outerFeeComponents.var[]._id

Required

string

The ID of the fee component.

Optional Attributes

Collapse all

items[].outerFeeComponents.var[].amount

Optional

number float

The fee amount.

items[].outerFeeComponents.var[].value

Optional

number float

The fee value.

items[].outerFeeComponents.var[].total

Optional

number float

The fee total. Calculated with amount and value.

items[].outerFeeComponents.var[].type

Optional

string

The fee type of the fee component.

onTicketonHardTicketonCart

items[].outerFeeComponents.var[].name

Optional

string

The name of the fee.

items[].outerFeeComponents.var[].exposed

Optional

boolean

Whether this fee will be exposed to the ticket buyer.

items[].outerFeeComponents.var[].scheme

Optional

object

The fee scheme of the fee component.

Optional Attributes

Collapse all

items[].outerFeeComponents.var[].scheme.schemeId

Optional

string

The ID of the fee scheme.

items[].outerFeeComponents.var[].scheme.feeId

Optional

string

The ID of the fee scheme fee.

items[].tickets

Optional

array

An array containing all ticket cart items.

items[].tickets[].amount

Required

integer

The amount of the cart item.

items[].tickets[].price

Required

number float

The single piece price of the cart item.

items[].tickets[].ticketTypeId

Required

string

The ID of the ticket type of the cart item.

Optional Attributes

Collapse all

items[].tickets[].type

Optional

string

The type of the cart item.

ticket

items[].tickets[]._id

Optional

string

The ID of the cart item.

items[].tickets[].name

Optional

string

The name of the cart item.

items[].tickets[].netPrice

Optional

number float

The single piece net price of the cart item.

items[].tickets[].taxRate

Optional

number float

The tax rate to be applied to this cart item. If not present the tax rate of the transaction is taken.

items[].tickets[].triggeredBy

Optional

An ID or an array of IDs of other cart items which triggered the buy action of the cart item.

One of

Only one of the following types

items[].tickets[].bundleInfo

Optional

object

Optional Attributes

Collapse all

items[].tickets[].bundleInfo.bundleId

Optional

string

items[].tickets[].bundleInfo.componentId

Optional

string

items[].tickets[].bundleInfo.optionId

Optional

string

items[].tickets[].categoryRef

Optional

string

The category reference of the ticket type.

items[].tickets[].seatingInfo

Optional

object

The associated seating object.

items[].tickets[].seatingInfo._type

Required

number float

Indicates the type of seating object. Seat = 6, General Admission = 7.

67

items[].tickets[].seatingInfo.statusId

Required

string

The ID of a container holding information about the seating status of the seating object.

Optional Attributes

Collapse all

items[].tickets[].seatingInfo._id

Optional

string

The ID of the seating object.

items[].tickets[].seatingInfo.categoryId

Optional

string

The ID of the category containing the seating object.

items[].tickets[].seatingInfo.name

Optional

string

If _type == 7. The name of the general admission.

items[].tickets[].seatingInfo.seatType

Optional

string

If _type == 6. The type of the seat. null = normal.

handicapped

items[].tickets[].seatingInfo.sectionName

Optional

string

If _type == 6. The name of the section where the seat is located.

items[].tickets[].seatingInfo.groupName

Optional

string

If _type == 6. The name of the row group where the seat is located.

items[].tickets[].seatingInfo.rowName

Optional

string

If _type == 6. The name of the row where the seat is located.

items[].tickets[].seatingInfo.seatName

Optional

string

If _type == 6. The seat name.

items[].tickets[].seatingInfo.gate

Optional

string

The entry gate associated with the seating object.

items[].tickets[].asHardTicket

Optional

boolean

Whether this ticket is a hard ticket.

items[].tickets[].triggeredAutomations

Optional

boolean

Whether the cart item triggered automations.

items[].tickets[].meta

Optional

object

Meta data which is propagated to the ticket.

items[].products

Optional

array

An array containing all product cart items.

items[].products[].type

Required

string

The type of the cart item.

product

items[].products[].amount

Required

integer

The amount of the cart item.

items[].products[].price

Required

number float

The single piece price of the cart item.

items[].products[].productVariantId

Required

string

The ID of the product variant.

Optional Attributes

Collapse all

items[].products[]._id

Optional

string

The ID of the cart item.

items[].products[].name

Optional

string

The name of the cart item.

items[].products[].netPrice

Optional

number float

The single piece net price of the cart item.

items[].products[].taxRate

Optional

number float

The tax rate to be applied to this cart item. If not present the tax rate of the transaction is taken.

items[].products[].triggeredBy

Optional

An ID or an array of IDs of other cart items which triggered the buy action of the cart item.

One of

Only one of the following types

items[].products[].bundleInfo

Optional

object

Optional Attributes

Collapse all

items[].products[].bundleInfo.bundleId

Optional

string

items[].products[].bundleInfo.componentId

Optional

string

items[].products[].bundleInfo.optionId

Optional

string

items[].products[].isFulfillable

Optional

boolean

Whether the product can be delivered

items[].additionalItems

Optional

array

An array of additional price items of the checkout itemt.

One of

Only one of the following types

items[].additionalItems[].itemId

Required

string

The ID of the item.

items[].additionalItems[].type

Required

string

The type of the additional item.

bundle

items[].additionalItems[].netPrice

Required

number float

The single piece net price of the additional item.

items[].additionalItems[].price

Required

number float

The single piece price of the additional item.

items[].additionalItems[].taxRate

Required

number float

The tax rate to be applied to this additional item.

Optional Attributes

Collapse all

items[].additionalItems[].taxInfo

Optional

object

The tax info details.

Optional Attributes

Collapse all

items[].additionalItems[].taxInfo.serviceTypeId

Optional

string

The ID of the service type.

items[].additionalItems[].taxInfo.exceptionId

Optional

string

The ID of the exception.

items[].additionalItems[].taxInfo.proceedsAccountId

Optional

string

The ID of the proceeds account.

items[].additionalItems[].taxInfo.proceedsAccountCode

Optional

string

The code of the proceeds account.

items[].additionalItems[].taxInfo.taxItems

Optional

array

The array of tax items.

items[].additionalItems[].taxInfo.taxItems[].taxTypeId

Required

string

items[].additionalItems[].taxInfo.taxItems[].rate

Required

number float

items[].additionalItems[].taxInfo.taxItems[].perUnit

Required

number float

items[].additionalItems[].taxInfo.taxItems[].total

Required

number float

Optional Attributes

Collapse all

items[].additionalItems[].taxInfo.taxItems[].name

Optional

string

items[].additionalItems[].taxInfo.taxItems[].taxPayableAccountId

Optional

string

items[].additionalItems[].taxInfo.taxItems[].taxPayableAccountCode

Optional

string

items[].additionalItems[].data

Optional

object

items[].additionalItems[].data.bundleId

Required

string

The ID of the bundle.

items[].seatingReservationToken

Optional

string

The reservation token of the selected seats.

items[].subscriptionId

Optional

string

The ID of the subscription if this item triggered one.

realPrice

Required

number float

The calculated real price of the checkout.

Optional Attributes

Collapse all

company

Optional

string

The company name of the checkout's customer.

firstname

Optional

string

The first name of the checkout's customer.

lastname

Optional

string

The last name of the checkout's customer.

name

Optional

string

The full name of the checkout's customer.

Optional

string email

The email of the checkout's customer.

phone

Optional

string

The phone number of the checkout's customer.

customerId

Optional

string

The ID of the customer.

address

Optional

object

The address of the checkout.

Optional Attributes

Collapse all

address.street

Optional

string

The street of the address. Street name including number.

address.line2

Optional

string

The additional field of the address.

address.postal

Optional

string

The postal code of the address.

address.city

Optional

string

The city of the address.

address.country

Optional

string

The country of the address. An ISO 3166 country code.

address.state

Optional

string

The state of the address. If applicable

deliveryAddress

Optional

object

The delivery address of the checkout.

Optional Attributes

Collapse all

deliveryAddress.street

Optional

string

The street of the address. Street name including number.

deliveryAddress.line2

Optional

string

The additional field of the address.

deliveryAddress.postal

Optional

string

The postal code of the address.

deliveryAddress.city

Optional

string

The city of the address.

deliveryAddress.country

Optional

string

The country of the address. An ISO 3166 country code.

deliveryAddress.state

Optional

string

The state of the address. If applicable

deliveryAddress.name

Optional

string

The name of the person receiving delivery.

currency

Optional

string

An ISO 4217 3-character code of the currency.

EURUSDGBPAUDCHFTHBILSCOPMXNDKKNOKSEKQARCADISKGTQINRDOPSGDPLNSARTTDZARKYDHKDCZKKRWJPYNZDAEDMADTWD

redeemedVouchers

Optional

object

An object including information on all redeemed vouchers of the checkout.

redeemedVouchers.totalRedeemedAmount

Required

number float

The sum of all vouchers applied.

Optional Attributes

Collapse all

redeemedVouchers.vouchers

Optional

array

An array of all redeemed vouchers of the checkout.

redeemedVouchers.vouchers[]._id

Required

string

The ID of the voucher.

redeemedVouchers.vouchers[].code

Required

string

The Code of the voucher.

redeemedVouchers.vouchers[].redeemedAmount

Required

number float

The applied value of the voucher.

preferredLanguage

Optional

string

The prefered language of the checkout.

deenen-GBen-AUfreses-MXnllvhearthrutritpldakojazh-TW

origin

Optional

string

The origin of the checkout.

yourticketposrebookingupgrade

channel

Optional

string

The channel of the checkout.

onlineinternalpos

salesChannelId

Optional

string

The ID of the sales channel of the checkout.

posId

Optional

string

The ID of the POS which created the checkout.

userId

Optional

string

The ID of the user who created the checkout.

extraFields

Optional

object

An object containing key-value information.

expiresAt

Optional

string date-time

An ISO Timestamp indicating when the checkout will expire.

createdAt

Optional

string date-time

An ISO timestamp indicating when the checkout was created.

updatedAt

Optional

string date-time

An ISO timestamp indicating when the checkout was last updated.

Was this section helpful?

Yes No

{
  "_id": "string",
  "secret": "string",
  "status": "NEW",
  "type": "transaction",
  "company": "string",
  "firstname": "string",
  "lastname": "string",
  "name": "string",
  "email": "[email protected]",
  "phone": "string",
  "customerId": "string",
  "address": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string"
  },
  "deliveryAddress": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "string"
  },
  "sellerId": "string",
  "items": [
    {
      "_id": "string",
      "eventId": "string",
      "shopId": "string",
      "channelId": "string",
      "redeemedVouchers": {
        "totalRedeemedAmount": 10.5,
        "vouchers": [
          {
            "_id": "string",
            "code": "string",
            "redeemedAmount": 10.5
          }
        ]
      },
      "appliedCoupons": [
        {
          "_id": "string",
          "code": "string"
        }
      ],
      "appliedDiscountInfo": {
        "items": [
          {
            "_id": "string",
            "itemId": "string",
            "amount": 10.5,
            "regularPrice": 10.5,
            "price": 10.5,
            "varDiscounts": [
              {
                "_id": "string",
                "discountId": "string",
                "category": "coupon",
                "name": "string",
                "type": "fix",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ],
            "fixDiscounts": [
              {
                "_id": "string",
                "discountId": "string",
                "category": "coupon",
                "name": "string",
                "type": "fix",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ]
          }
        ],
        "discounts": [
          {
            "_id": "string",
            "discountId": "string",
            "category": "coupon",
            "name": "string",
            "type": "fix",
            "value": 10.5,
            "allowedItems": [
              "string"
            ],
            "maxItemsInCart": 10.5,
            "maxAbsoluteValue": 10.5,
            "absoluteDiscountValue": 10.5
          }
        ]
      },
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "innerFeeComponents": {
        "_id": "string",
        "fix": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ],
        "var": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ]
      },
      "innerCharge": 10.5,
      "outerFeeComponents": {
        "_id": "string",
        "fix": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ],
        "var": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ]
      },
      "outerCharge": 10.5,
      "tickets": [
        {
          "type": "ticket",
          "_id": "string",
          "name": "string",
          "amount": 1,
          "netPrice": 10.5,
          "price": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "string",
            "componentId": "string",
            "optionId": "string"
          },
          "ticketTypeId": "string",
          "categoryRef": "string",
          "seatingInfo": {
            "_id": "string",
            "_type": 6,
            "categoryId": "string",
            "statusId": "string",
            "name": "string",
            "seatType": "handicapped",
            "sectionName": "string",
            "groupName": "string",
            "rowName": "string",
            "seatName": "string",
            "gate": "string"
          },
          "asHardTicket": true,
          "triggeredAutomations": true,
          "meta": {}
        }
      ],
      "products": [
        {
          "type": "product",
          "_id": "string",
          "name": "string",
          "amount": 1,
          "netPrice": 10.5,
          "price": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "string",
            "componentId": "string",
            "optionId": "string"
          },
          "productVariantId": "string",
          "isFulfillable": true
        }
      ],
      "additionalItems": [],
      "seatingReservationToken": "string",
      "subscriptionId": "string"
    }
  ],
  "realPrice": 10.5,
  "currency": "EUR",
  "redeemedVouchers": {
    "totalRedeemedAmount": 10.5,
    "vouchers": [
      {
        "_id": "string",
        "code": "string",
        "redeemedAmount": 10.5
      }
    ]
  },
  "preferredLanguage": "de",
  "origin": "yourticket",
  "channel": "online",
  "salesChannelId": "string",
  "posId": "string",
  "userId": "string",
  "extraFields": {},
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

PUBLIC

Create a Checkout

Payload

type

Required

string

The type of the checkout.

transactionupgraderebookingpurchaseintentsubscription

eventId

Required

string

The ID of the event to create the checkout item for.

items

Required

array

An array of all cart items.

One of

Only one of the following types

items[].amount

Required

integer

The amount of the cart item.

items[].ticketTypeId

Required

string

The ID of the ticket type of the cart item.

Optional Attributes

Collapse all

items[]._id

Optional

string

The ID of the cart item.

items[].type

Optional

string

The type of the cart item.

ticket

items[].seatingInfo

Optional

object

The associated seating object.

items[].seatingInfo._type

Required

number float

Indicates the type of seating object. Seat = 6, General Admission = 7.

67

items[].seatingInfo.statusId

Required

string

The ID of a container holding information about the seating status of the seating object.

Optional Attributes

Collapse all

items[].seatingInfo._id

Optional

string

The ID of the seating object.

items[].seatingInfo.categoryId

Optional

string

The ID of the category containing the seating object.

items[].seatingInfo.name

Optional

string

If _type == 7. The name of the general admission.

items[].seatingInfo.seatType

Optional

string

If _type == 6. The type of the seat. null = normal.

handicapped

items[].seatingInfo.sectionName

Optional

string

If _type == 6. The name of the section where the seat is located.

items[].seatingInfo.groupName

Optional

string

If _type == 6. The name of the row group where the seat is located.

items[].seatingInfo.rowName

Optional

string

If _type == 6. The name of the row where the seat is located.

items[].seatingInfo.seatName

Optional

string

If _type == 6. The seat name.

items[].seatingInfo.gate

Optional

string

The entry gate associated with the seating object.

items[].asHardTicket

Optional

boolean

Whether this ticket is a hard ticket.

items[].triggeredBy

Optional

An ID or an array of IDs of other cart items which triggered the buy action of the cart item.

One of

Only one of the following types

items[].triggeredAutomations

Optional

boolean

Whether the cart item triggered automations.

items[].meta

Optional

object

Meta data which is propagated to the ticket.

items[].bundleInfo

Optional

object

Optional Attributes

Collapse all

items[].bundleInfo.bundleId

Optional

string

items[].bundleInfo.componentId

Optional

string

items[].bundleInfo.optionId

Optional

string

Optional Attributes

Collapse all

coupons

Optional

array<string>

An array of coupon codes to apply to the checkout item.

vouchers

Optional

array<string>

An array of voucher codes to be redeemed through the checkout.

shopId

Optional

string

The ID of the secret shop to create the checkout item for.

seatingReservationToken

Optional

string

The reservation token of the selected seats.

channelId

Optional

string

The ID of the channel to create the checkout item for.

salesChannelId

Optional

string

The ID of the sales channel to create the checkout item for.

preferredLanguage

Optional

Update checkout items

Adds or updates a checkout item for a given eventId.

Payload

secret

Required

string

The secret token of the checkout

eventId

Required

string

The ID of the event to create the transaction for

items

Required

array

An array of all cart items

One of

Only one of the following types

items[].amount

Required

integer

The amount of the cart item.

items[].ticketTypeId

Required

string

The ID of the ticket type of the cart item.

Optional Attributes

Collapse all

items[]._id

Optional

string

The ID of the cart item.

items[].type

Optional

string

The type of the cart item.

ticket

items[].seatingInfo

Optional

object

The associated seating object.

items[].seatingInfo._type

Required

number float

Indicates the type of seating object. Seat = 6, General Admission = 7.

67

items[].seatingInfo.statusId

Required

string

The ID of a container holding information about the seating status of the seating object.

Optional Attributes

Collapse all

items[].seatingInfo._id

Optional

string

The ID of the seating object.

items[].seatingInfo.categoryId

Optional

string

The ID of the category containing the seating object.

items[].seatingInfo.name

Optional

string

If _type == 7. The name of the general admission.

items[].seatingInfo.seatType

Optional

string

If _type == 6. The type of the seat. null = normal.

handicapped

items[].seatingInfo.sectionName

Optional

string

If _type == 6. The name of the section where the seat is located.

items[].seatingInfo.groupName

Optional

string

If _type == 6. The name of the row group where the seat is located.

items[].seatingInfo.rowName

Optional

string

If _type == 6. The name of the row where the seat is located.

items[].seatingInfo.seatName

Optional

string

If _type == 6. The seat name.

items[].seatingInfo.gate

Optional

string

The entry gate associated with the seating object.

items[].asHardTicket

Optional

boolean

Whether this ticket is a hard ticket.

items[].triggeredBy

Optional

An ID or an array of IDs of other cart items which triggered the buy action of the cart item.

One of

Only one of the following types

items[].triggeredAutomations

Optional

boolean

Whether the cart item triggered automations.

items[].meta

Optional

object

Meta data which is propagated to the ticket.

items[].bundleInfo

Optional

object

Optional Attributes

Collapse all

items[].bundleInfo.bundleId

Optional

string

items[].bundleInfo.componentId

Optional

string

items[].bundleInfo.optionId

Optional

string

Optional Attributes

Collapse all

coupons

Optional

array<string>

An array of coupon code to apply to this transaction

shopId

Optional

string

The ID of the secret shop to create the transaction for

seatingReservationToken

Optional

string

The reservation token of the selected seats

channelId

Optional

string

The ID of the channel to create the transaction for

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "secret": "string",
  "eventId": "string",
  "coupons": [
    "string"
  ],
  "shopId": "string",
  "items": [
    {
      "_id": "string",
      "type": "ticket",
      "amount": 1,
      "ticketTypeId": "string",
      "seatingInfo": {
        "_id": "string",
        "_type": 6,
        "categoryId": "string",
        "statusId": "string",
        "name": "string",
        "seatType": "handicapped",
        "sectionName": "string",
        "groupName": "string",
        "rowName": "string",
        "seatName": "string",
        "gate": "string"
      },
      "asHardTicket": true,
      "triggeredBy": "string",
      "triggeredAutomations": true,
      "meta": {},
      "bundleInfo": {
        "bundleId": "string",
        "componentId": "string",
        "optionId": "string"
      }
    }
  ],
  "seatingReservationToken": "string",
  "channelId": "string"
}

{
  "_id": "string",
  "secret": "string",
  "status": "NEW",
  "type": "transaction",
  "company": "string",
  "firstname": "string",
  "lastname": "string",
  "name": "string",
  "email": "[email protected]",
  "phone": "string",
  "customerId": "string",
  "address": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string"
  },
  "deliveryAddress": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "string"
  },
  "sellerId": "string",
  "items": [
    {
      "_id": "string",
      "eventId": "string",
      "shopId": "string",
      "channelId": "string",
      "redeemedVouchers": {
        "totalRedeemedAmount": 10.5,
        "vouchers": [
          {
            "_id": "string",
            "code": "string",
            "redeemedAmount": 10.5
          }
        ]
      },
      "appliedCoupons": [
        {
          "_id": "string",
          "code": "string"
        }
      ],
      "appliedDiscountInfo": {
        "items": [
          {
            "_id": "string",
            "itemId": "string",
            "amount": 10.5,
            "regularPrice": 10.5,
            "price": 10.5,
            "varDiscounts": [
              {
                "_id": "string",
                "discountId": "string",
                "category": "coupon",
                "name": "string",
                "type": "fix",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ],
            "fixDiscounts": [
              {
                "_id": "string",
                "discountId": "string",
                "category": "coupon",
                "name": "string",
                "type": "fix",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ]
          }
        ],
        "discounts": [
          {
            "_id": "string",
            "discountId": "string",
            "category": "coupon",
            "name": "string",
            "type": "fix",
            "value": 10.5,
            "allowedItems": [
              "string"
            ],
            "maxItemsInCart": 10.5,
            "maxAbsoluteValue": 10.5,
            "absoluteDiscountValue": 10.5
          }
        ]
      },
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "innerFeeComponents": {
        "_id": "string",
        "fix": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ],
        "var": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ]
      },
      "innerCharge": 10.5,
      "outerFeeComponents": {
        "_id": "string",
        "fix": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ],
        "var": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ]
      },
      "outerCharge": 10.5,
      "tickets": [
        {
          "type": "ticket",
          "_id": "string",
          "name": "string",
          "amount": 1,
          "netPrice": 10.5,
          "price": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "string",
            "componentId": "string",
            "optionId": "string"
          },
          "ticketTypeId": "string",
          "categoryRef": "string",
          "seatingInfo": {
            "_id": "string",
            "_type": 6,
            "categoryId": "string",
            "statusId": "string",
            "name": "string",
            "seatType": "handicapped",
            "sectionName": "string",
            "groupName": "string",
            "rowName": "string",
            "seatName": "string",
            "gate": "string"
          },
          "asHardTicket": true,
          "triggeredAutomations": true,
          "meta": {}
        }
      ],
      "products": [
        {
          "type": "product",
          "_id": "string",
          "name": "string",
          "amount": 1,
          "netPrice": 10.5,
          "price": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "string",
            "componentId": "string",
            "optionId": "string"
          },
          "productVariantId": "string",
          "isFulfillable": true
        }
      ],
      "additionalItems": [],
      "seatingReservationToken": "string",
      "subscriptionId": "string"
    }
  ],
  "realPrice": 10.5,
  "currency": "EUR",
  "redeemedVouchers": {
    "totalRedeemedAmount": 10.5,
    "vouchers": [
      {
        "_id": "string",
        "code": "string",
        "redeemedAmount": 10.5
      }
    ]
  },
  "preferredLanguage": "de",
  "origin": "yourticket",
  "channel": "online",
  "salesChannelId": "string",
  "posId": "string",
  "userId": "string",
  "extraFields": {},
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

PUBLIC

Get a Checkout

Query

secret

Required

string

The secret token of the checkout

200

400

Bad Request

404

Not Found

Was this section helpful?

Yes No

{
  "_id": "string",
  "secret": "string",
  "status": "NEW",
  "type": "transaction",
  "company": "string",
  "firstname": "string",
  "lastname": "string",
  "name": "string",
  "email": "[email protected]",
  "phone": "string",
  "customerId": "string",
  "address": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string"
  },
  "deliveryAddress": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "string"
  },
  "sellerId": "string",
  "items": [
    {
      "_id": "string",
      "eventId": "string",
      "shopId": "string",
      "channelId": "string",
      "redeemedVouchers": {
        "totalRedeemedAmount": 10.5,
        "vouchers": [
          {
            "_id": "string",
            "code": "string",
            "redeemedAmount": 10.5
          }
        ]
      },
      "appliedCoupons": [
        {
          "_id": "string",
          "code": "string"
        }
      ],
      "appliedDiscountInfo": {
        "items": [
          {
            "_id": "string",
            "itemId": "string",
            "amount": 10.5,
            "regularPrice": 10.5,
            "price": 10.5,
            "varDiscounts": [
              {
                "_id": "string",
                "discountId": "string",
                "category": "coupon",
                "name": "string",
                "type": "fix",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ],
            "fixDiscounts": [
              {
                "_id": "string",
                "discountId": "string",
                "category": "coupon",
                "name": "string",
                "type": "fix",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ]
          }
        ],
        "discounts": [
          {
            "_id": "string",
            "discountId": "string",
            "category": "coupon",
            "name": "string",
            "type": "fix",
            "value": 10.5,
            "allowedItems": [
              "string"
            ],
            "maxItemsInCart": 10.5,
            "maxAbsoluteValue": 10.5,
            "absoluteDiscountValue": 10.5
          }
        ]
      },
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "innerFeeComponents": {
        "_id": "string",
        "fix": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ],
        "var": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ]
      },
      "innerCharge": 10.5,
      "outerFeeComponents": {
        "_id": "string",
        "fix": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ],
        "var": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ]
      },
      "outerCharge": 10.5,
      "tickets": [
        {
          "type": "ticket",
          "_id": "string",
          "name": "string",
          "amount": 1,
          "netPrice": 10.5,
          "price": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "string",
            "componentId": "string",
            "optionId": "string"
          },
          "ticketTypeId": "string",
          "categoryRef": "string",
          "seatingInfo": {
            "_id": "string",
            "_type": 6,
            "categoryId": "string",
            "statusId": "string",
            "name": "string",
            "seatType": "handicapped",
            "sectionName": "string",
            "groupName": "string",
            "rowName": "string",
            "seatName": "string",
            "gate": "string"
          },
          "asHardTicket": true,
          "triggeredAutomations": true,
          "meta": {}
        }
      ],
      "products": [
        {
          "type": "product",
          "_id": "string",
          "name": "string",
          "amount": 1,
          "netPrice": 10.5,
          "price": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "string",
            "componentId": "string",
            "optionId": "string"
          },
          "productVariantId": "string",
          "isFulfillable": true
        }
      ],
      "additionalItems": [],
      "seatingReservationToken": "string",
      "subscriptionId": "string"
    }
  ],
  "realPrice": 10.5,
  "currency": "EUR",
  "redeemedVouchers": {
    "totalRedeemedAmount": 10.5,
    "vouchers": [
      {
        "_id": "string",
        "code": "string",
        "redeemedAmount": 10.5
      }
    ]
  },
  "preferredLanguage": "de",
  "origin": "yourticket",
  "channel": "online",
  "salesChannelId": "string",
  "posId": "string",
  "userId": "string",
  "extraFields": {},
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get all checkouts

Query

status

Optional

array<string>

Filter checkouts by checkout status

name

Optional

string

Filter checkouts by name

Optional

string

The email of the checkout customer

type

Optional

array<string>

Filter checkouts by checkout type

customerId

Optional

string

The ID of the checkout customer

channel

Optional

array

Filter checkout by checkout channel

One of

Only one of the following types

One of

Only one of the following types

createdAt

Optional

object

Range of dates indicating when the checkout was created in ISO format.

Optional Attributes

Collapse all

createdAt.$gt

Optional

string date-time

value is greater than

createdAt.$gte

Optional

string date-time

value is greater than or equal

createdAt.$lt

Optional

string date-time

value is less than

createdAt.$lte

Optional

string date-time

value is less than or equal

createdAt.$eq

Optional

string date-time

value is equal

createdAt.$ne

Optional

string date-time

value is not equal

updatedAt

Optional

object

Range of dates indicating when the checkout was last updated in ISO format.

Optional Attributes

Collapse all

updatedAt.$gt

Optional

string date-time

value is greater than

updatedAt.$gte

Optional

string date-time

value is greater than or equal

updatedAt.$lt

Optional

string date-time

value is less than

updatedAt.$lte

Optional

string date-time

value is less than or equal

updatedAt.$eq

Optional

string date-time

value is equal

updatedAt.$ne

Optional

string date-time

value is not equal

top

Optional

integer

A limit on the number of objects to be returned. Can range between 1 and 1000.

skip

Optional

integer

The number of objects to skip for the requested result

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "docs": [
    {
      "_id": "string",
      "secret": "string",
      "status": "NEW",
      "type": "transaction",
      "company": "string",
      "firstname": "string",
      "lastname": "string",
      "name": "string",
      "email": "[email protected]",
      "phone": "string",
      "customerId": "string",
      "address": {
        "street": "string",
        "line2": "string",
        "postal": "string",
        "city": "string",
        "country": "string",
        "state": "string"
      },
      "deliveryAddress": {
        "street": "string",
        "line2": "string",
        "postal": "string",
        "city": "string",
        "country": "string",
        "state": "string",
        "name": "string"
      },
      "sellerId": "string",
      "items": [
        {
          "_id": "string",
          "eventId": "string",
          "shopId": "string",
          "channelId": "string",
          "redeemedVouchers": {
            "totalRedeemedAmount": 10.5,
            "vouchers": [
              {
                "_id": "string",
                "code": "string",
                "redeemedAmount": 10.5
              }
            ]
          },
          "appliedCoupons": [
            {
              "_id": "string",
              "code": "string"
            }
          ],
          "appliedDiscountInfo": {
            "items": [
              {
                "_id": "string",
                "itemId": "string",
                "amount": 10.5,
                "regularPrice": 10.5,
                "price": 10.5,
                "varDiscounts": [
                  {
                    "_id": "string",
                    "discountId": "string",
                    "category": "coupon",
                    "name": "string",
                    "type": "fix",
                    "value": 10.5,
                    "allowedItems": [
                      "string"
                    ]
                  }
                ],
                "fixDiscounts": [
                  {
                    "_id": "string",
                    "discountId": "string",
                    "category": "coupon",
                    "name": "string",
                    "type": "fix",
                    "value": 10.5,
                    "allowedItems": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "discounts": [
              {
                "_id": "string",
                "discountId": "string",
                "category": "coupon",
                "name": "string",
                "type": "fix",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ],
                "maxItemsInCart": 10.5,
                "maxAbsoluteValue": 10.5,
                "absoluteDiscountValue": 10.5
              }
            ]
          },
          "regularPrice": 10.5,
          "realPrice": 10.5,
          "innerFeeComponents": {
            "_id": "string",
            "fix": [
              {
                "_id": "string",
                "amount": 10.5,
                "value": 10.5,
                "total": 10.5,
                "type": "onTicket",
                "name": "string",
                "exposed": true,
                "scheme": {
                  "schemeId": "string",
                  "feeId": "string"
                }
              }
            ],
            "var": [
              {
                "_id": "string",
                "amount": 10.5,
                "value": 10.5,
                "total": 10.5,
                "type": "onTicket",
                "name": "string",
                "exposed": true,
                "scheme": {
                  "schemeId": "string",
                  "feeId": "string"
                }
              }
            ]
          },
          "innerCharge": 10.5,
          "outerFeeComponents": {
            "_id": "string",
            "fix": [
              {
                "_id": "string",
                "amount": 10.5,
                "value": 10.5,
                "total": 10.5,
                "type": "onTicket",
                "name": "string",
                "exposed": true,
                "scheme": {
                  "schemeId": "string",
                  "feeId": "string"
                }
              }
            ],
            "var": [
              {
                "_id": "string",
                "amount": 10.5,
                "value": 10.5,
                "total": 10.5,
                "type": "onTicket",
                "name": "string",
                "exposed": true,
                "scheme": {
                  "schemeId": "string",
                  "feeId": "string"
                }
              }
            ]
          },
          "outerCharge": 10.5,
          "tickets": [
            {
              "type": "ticket",
              "_id": "string",
              "name": "string",
              "amount": 1,
              "netPrice": 10.5,
              "price": 10.5,
              "taxRate": 10.5,
              "triggeredBy": "string",
              "bundleInfo": {
                "bundleId": "string",
                "componentId": "string",
                "optionId": "string"
              },
              "ticketTypeId": "string",
              "categoryRef": "string",
              "seatingInfo": {
                "_id": "string",
                "_type": 6,
                "categoryId": "string",
                "statusId": "string",
                "name": "string",
                "seatType": "handicapped",
                "sectionName": "string",
                "groupName": "string",
                "rowName": "string",
                "seatName": "string",
                "gate": "string"
              },
              "asHardTicket": true,
              "triggeredAutomations": true,
              "meta": {}
            }
          ],
          "products": [
            {
              "type": "product",
              "_id": "string",
              "name": "string",
              "amount": 1,
              "netPrice": 10.5,
              "price": 10.5,
              "taxRate": 10.5,
              "triggeredBy": "string",
              "bundleInfo": {
                "bundleId": "string",
                "componentId": "string",
                "optionId": "string"
              },
              "productVariantId": "string",
              "isFulfillable": true
            }
          ],
          "additionalItems": [],
          "seatingReservationToken": "string",
          "subscriptionId": "string"
        }
      ],
      "realPrice": 10.5,
      "currency": "EUR",
      "redeemedVouchers": {
        "totalRedeemedAmount": 10.5,
        "vouchers": [
          {
            "_id": "string",
            "code": "string",
            "redeemedAmount": 10.5
          }
        ]
      },
      "preferredLanguage": "de",
      "origin": "yourticket",
      "channel": "online",
      "salesChannelId": "string",
      "posId": "string",
      "userId": "string",
      "extraFields": {},
      "expiresAt": "2030-01-23T23:00:00.123Z",
      "createdAt": "2030-01-23T23:00:00.123Z",
      "updatedAt": "2030-01-23T23:00:00.123Z"
    }
  ],
  "total": 1
}

PUBLIC

Update a checkout

Payload

secret

Required

string

The secret token of the checkout

Optional Attributes

Collapse all

vouchers

Optional

array<string>

An array of vouchers to be redeemed

200

400

Bad Request

Was this section helpful?

Yes No

{
  "vouchers": [
    "string"
  ],
  "secret": "string"
}

{
  "_id": "string",
  "secret": "string",
  "status": "NEW",
  "type": "transaction",
  "company": "string",
  "firstname": "string",
  "lastname": "string",
  "name": "string",
  "email": "[email protected]",
  "phone": "string",
  "customerId": "string",
  "address": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string"
  },
  "deliveryAddress": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "string"
  },
  "sellerId": "string",
  "items": [
    {
      "_id": "string",
      "eventId": "string",
      "shopId": "string",
      "channelId": "string",
      "redeemedVouchers": {
        "totalRedeemedAmount": 10.5,
        "vouchers": [
          {
            "_id": "string",
            "code": "string",
            "redeemedAmount": 10.5
          }
        ]
      },
      "appliedCoupons": [
        {
          "_id": "string",
          "code": "string"
        }
      ],
      "appliedDiscountInfo": {
        "items": [
          {
            "_id": "string",
            "itemId": "string",
            "amount": 10.5,
            "regularPrice": 10.5,
            "price": 10.5,
            "varDiscounts": [
              {
                "_id": "string",
                "discountId": "string",
                "category": "coupon",
                "name": "string",
                "type": "fix",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ],
            "fixDiscounts": [
              {
                "_id": "string",
                "discountId": "string",
                "category": "coupon",
                "name": "string",
                "type": "fix",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ]
          }
        ],
        "discounts": [
          {
            "_id": "string",
            "discountId": "string",
            "category": "coupon",
            "name": "string",
            "type": "fix",
            "value": 10.5,
            "allowedItems": [
              "string"
            ],
            "maxItemsInCart": 10.5,
            "maxAbsoluteValue": 10.5,
            "absoluteDiscountValue": 10.5
          }
        ]
      },
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "innerFeeComponents": {
        "_id": "string",
        "fix": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ],
        "var": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ]
      },
      "innerCharge": 10.5,
      "outerFeeComponents": {
        "_id": "string",
        "fix": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ],
        "var": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ]
      },
      "outerCharge": 10.5,
      "tickets": [
        {
          "type": "ticket",
          "_id": "string",
          "name": "string",
          "amount": 1,
          "netPrice": 10.5,
          "price": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "string",
            "componentId": "string",
            "optionId": "string"
          },
          "ticketTypeId": "string",
          "categoryRef": "string",
          "seatingInfo": {
            "_id": "string",
            "_type": 6,
            "categoryId": "string",
            "statusId": "string",
            "name": "string",
            "seatType": "handicapped",
            "sectionName": "string",
            "groupName": "string",
            "rowName": "string",
            "seatName": "string",
            "gate": "string"
          },
          "asHardTicket": true,
          "triggeredAutomations": true,
          "meta": {}
        }
      ],
      "products": [
        {
          "type": "product",
          "_id": "string",
          "name": "string",
          "amount": 1,
          "netPrice": 10.5,
          "price": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "string",
            "componentId": "string",
            "optionId": "string"
          },
          "productVariantId": "string",
          "isFulfillable": true
        }
      ],
      "additionalItems": [],
      "seatingReservationToken": "string",
      "subscriptionId": "string"
    }
  ],
  "realPrice": 10.5,
  "currency": "EUR",
  "redeemedVouchers": {
    "totalRedeemedAmount": 10.5,
    "vouchers": [
      {
        "_id": "string",
        "code": "string",
        "redeemedAmount": 10.5
      }
    ]
  },
  "preferredLanguage": "de",
  "origin": "yourticket",
  "channel": "online",
  "salesChannelId": "string",
  "posId": "string",
  "userId": "string",
  "extraFields": {},
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

PUBLIC

Get details form

Query

secret

Required

string

The secret token of the checkout

locale

Optional

string

Get the info for a specific language

200

400

Bad Request

Was this section helpful?

Yes No

{
  "skipAddressInfo": true,
  "extraFields": [
    {
      "name": "string",
      "description": "string",
      "required": true,
      "deleted": true,
      "onlyForCertainTicketsTypes": true,
      "allowedTicketTypes": [
        "string"
      ],
      "printable": true,
      "applyToCustomer": true
    }
  ],
  "enforceCompany": true
}

PUBLIC

Post checkout details

Payload

secret

Required

string

The secret token of the checkout

prename

Required

string

The first name for this checkout

lastname

Required

string

The last name for this checkout

Required

string email

The email for this checkout

emailRepeat

Required

string email

Optional Attributes

Collapse all

company

Optional

string

The company name for this checkout

street

Optional

string

postal

Optional

string

city

Optional

string

country

Optional

string

state

Optional

string

deliveryAddress

Optional

object

Optional Attributes

Collapse all

deliveryAddress.street

Optional

string

The street of the address. Street name including number.

deliveryAddress.line2

Optional

string

The additional field of the address.

deliveryAddress.postal

Optional

string

The postal code of the address.

deliveryAddress.city

Optional

string

The city of the address.

deliveryAddress.country

Optional

string

The country of the address. An ISO 3166 country code.

deliveryAddress.state

Optional

string

The state of the address. If applicable

deliveryAddress.name

Optional

string

The name of the person receiving delivery.

phone

Optional

string

The phone number for this checkout

password

Optional

string

If createAccount = true. The password to create the account with

passwordRepeat

Optional

string

If createAccount = true. Repeat password

createAccount

Optional

boolean

Whether to create an account with the provided data

extraFields

Optional

object

fulfillmentTypes

Optional

array

An array of fulfillment types to be used in the checkout.

fulfillmentTypes[].type

Required

string

The type of the cart item.

fulfillmentType

fulfillmentTypes[].amount

Required

integer

The amount of the cart item.

fulfillmentTypes[].price

Required

number float

The single piece price of the cart item.

Optional Attributes

Collapse all

fulfillmentTypes[]._id

Optional

string

The ID of the cart item.

fulfillmentTypes[].name

Optional

string

The name of the cart item.

fulfillmentTypes[].netPrice

Optional

number float

The single piece net price of the cart item.

fulfillmentTypes[].taxRate

Optional

number float

The tax rate to be applied to this cart item. If not present the tax rate of the transaction is taken.

fulfillmentTypes[].triggeredBy

Optional

An ID or an array of IDs of other cart items which triggered the buy action of the cart item.

One of

Only one of the following types

fulfillmentTypes[].bundleInfo

Optional

object

Optional Attributes

Collapse all

fulfillmentTypes[].bundleInfo.bundleId

Optional

string

fulfillmentTypes[].bundleInfo.componentId

Optional

string

fulfillmentTypes[].bundleInfo.optionId

Optional

string

fulfillmentTypes[].data

Optional

object

fulfillmentTypes[].data.fulfillmentTypeId

Required

string

The ID of the fulfillment type.

Optional Attributes

Collapse all

fulfillmentTypes[].data.cartItemIds

Optional

array<string>

The array of the related cart items IDs.

fulfillmentTypes[].data.discountable

Optional

boolean

Whether the fulfillment type is discountable.

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "secret": "string",
  "company": "string",
  "prename": "string",
  "lastname": "string",
  "street": "string",
  "postal": "string",
  "city": "string",
  "country": "string",
  "state": "string",
  "deliveryAddress": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "string"
  },
  "email": "[email protected]",
  "emailRepeat": "[email protected]",
  "phone": "string",
  "password": "string",
  "passwordRepeat": "string",
  "createAccount": true,
  "extraFields": {},
  "fulfillmentTypes": [
    {
      "type": "fulfillmentType",
      "_id": "string",
      "name": "string",
      "amount": 1,
      "netPrice": 10.5,
      "price": 10.5,
      "taxRate": 10.5,
      "triggeredBy": "string",
      "bundleInfo": {
        "bundleId": "string",
        "componentId": "string",
        "optionId": "string"
      },
      "data": {
        "fulfillmentTypeId": "string",
        "cartItemIds": [
          "string"
        ],
        "discountable": true
      }
    }
  ]
}

{
  "_id": "string",
  "secret": "string",
  "status": "NEW",
  "type": "transaction",
  "company": "string",
  "firstname": "string",
  "lastname": "string",
  "name": "string",
  "email": "[email protected]",
  "phone": "string",
  "customerId": "string",
  "address": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string"
  },
  "deliveryAddress": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "string"
  },
  "sellerId": "string",
  "items": [
    {
      "_id": "string",
      "eventId": "string",
      "shopId": "string",
      "channelId": "string",
      "redeemedVouchers": {
        "totalRedeemedAmount": 10.5,
        "vouchers": [
          {
            "_id": "string",
            "code": "string",
            "redeemedAmount": 10.5
          }
        ]
      },
      "appliedCoupons": [
        {
          "_id": "string",
          "code": "string"
        }
      ],
      "appliedDiscountInfo": {
        "items": [
          {
            "_id": "string",
            "itemId": "string",
            "amount": 10.5,
            "regularPrice": 10.5,
            "price": 10.5,
            "varDiscounts": [
              {
                "_id": "string",
                "discountId": "string",
                "category": "coupon",
                "name": "string",
                "type": "fix",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ],
            "fixDiscounts": [
              {
                "_id": "string",
                "discountId": "string",
                "category": "coupon",
                "name": "string",
                "type": "fix",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ]
          }
        ],
        "discounts": [
          {
            "_id": "string",
            "discountId": "string",
            "category": "coupon",
            "name": "string",
            "type": "fix",
            "value": 10.5,
            "allowedItems": [
              "string"
            ],
            "maxItemsInCart": 10.5,
            "maxAbsoluteValue": 10.5,
            "absoluteDiscountValue": 10.5
          }
        ]
      },
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "innerFeeComponents": {
        "_id": "string",
        "fix": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ],
        "var": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ]
      },
      "innerCharge": 10.5,
      "outerFeeComponents": {
        "_id": "string",
        "fix": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ],
        "var": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ]
      },
      "outerCharge": 10.5,
      "tickets": [
        {
          "type": "ticket",
          "_id": "string",
          "name": "string",
          "amount": 1,
          "netPrice": 10.5,
          "price": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "string",
            "componentId": "string",
            "optionId": "string"
          },
          "ticketTypeId": "string",
          "categoryRef": "string",
          "seatingInfo": {
            "_id": "string",
            "_type": 6,
            "categoryId": "string",
            "statusId": "string",
            "name": "string",
            "seatType": "handicapped",
            "sectionName": "string",
            "groupName": "string",
            "rowName": "string",
            "seatName": "string",
            "gate": "string"
          },
          "asHardTicket": true,
          "triggeredAutomations": true,
          "meta": {}
        }
      ],
      "products": [
        {
          "type": "product",
          "_id": "string",
          "name": "string",
          "amount": 1,
          "netPrice": 10.5,
          "price": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "string",
            "componentId": "string",
            "optionId": "string"
          },
          "productVariantId": "string",
          "isFulfillable": true
        }
      ],
      "additionalItems": [],
      "seatingReservationToken": "string",
      "subscriptionId": "string"
    }
  ],
  "realPrice": 10.5,
  "currency": "EUR",
  "redeemedVouchers": {
    "totalRedeemedAmount": 10.5,
    "vouchers": [
      {
        "_id": "string",
        "code": "string",
        "redeemedAmount": 10.5
      }
    ]
  },
  "preferredLanguage": "de",
  "origin": "yourticket",
  "channel": "online",
  "salesChannelId": "string",
  "posId": "string",
  "userId": "string",
  "extraFields": {},
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

PUBLIC

Reserve a checkout

Fulfills a checkout of type purchaseintent.

Payload

secret

Required

string

The secret token of the checkout

200

400

Bad Request

404

Not Found

Was this section helpful?

Yes No

{
  "secret": "string"
}

{
  "_id": "string",
  "secret": "string",
  "status": "NEW",
  "type": "transaction",
  "company": "string",
  "firstname": "string",
  "lastname": "string",
  "name": "string",
  "email": "[email protected]",
  "phone": "string",
  "customerId": "string",
  "address": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string"
  },
  "deliveryAddress": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "string"
  },
  "sellerId": "string",
  "items": [
    {
      "_id": "string",
      "eventId": "string",
      "shopId": "string",
      "channelId": "string",
      "redeemedVouchers": {
        "totalRedeemedAmount": 10.5,
        "vouchers": [
          {
            "_id": "string",
            "code": "string",
            "redeemedAmount": 10.5
          }
        ]
      },
      "appliedCoupons": [
        {
          "_id": "string",
          "code": "string"
        }
      ],
      "appliedDiscountInfo": {
        "items": [
          {
            "_id": "string",
            "itemId": "string",
            "amount": 10.5,
            "regularPrice": 10.5,
            "price": 10.5,
            "varDiscounts": [
              {
                "_id": "string",
                "discountId": "string",
                "category": "coupon",
                "name": "string",
                "type": "fix",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ],
            "fixDiscounts": [
              {
                "_id": "string",
                "discountId": "string",
                "category": "coupon",
                "name": "string",
                "type": "fix",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ]
          }
        ],
        "discounts": [
          {
            "_id": "string",
            "discountId": "string",
            "category": "coupon",
            "name": "string",
            "type": "fix",
            "value": 10.5,
            "allowedItems": [
              "string"
            ],
            "maxItemsInCart": 10.5,
            "maxAbsoluteValue": 10.5,
            "absoluteDiscountValue": 10.5
          }
        ]
      },
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "innerFeeComponents": {
        "_id": "string",
        "fix": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ],
        "var": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ]
      },
      "innerCharge": 10.5,
      "outerFeeComponents": {
        "_id": "string",
        "fix": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ],
        "var": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ]
      },
      "outerCharge": 10.5,
      "tickets": [
        {
          "type": "ticket",
          "_id": "string",
          "name": "string",
          "amount": 1,
          "netPrice": 10.5,
          "price": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "string",
            "componentId": "string",
            "optionId": "string"
          },
          "ticketTypeId": "string",
          "categoryRef": "string",
          "seatingInfo": {
            "_id": "string",
            "_type": 6,
            "categoryId": "string",
            "statusId": "string",
            "name": "string",
            "seatType": "handicapped",
            "sectionName": "string",
            "groupName": "string",
            "rowName": "string",
            "seatName": "string",
            "gate": "string"
          },
          "asHardTicket": true,
          "triggeredAutomations": true,
          "meta": {}
        }
      ],
      "products": [
        {
          "type": "product",
          "_id": "string",
          "name": "string",
          "amount": 1,
          "netPrice": 10.5,
          "price": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "string",
            "componentId": "string",
            "optionId": "string"
          },
          "productVariantId": "string",
          "isFulfillable": true
        }
      ],
      "additionalItems": [],
      "seatingReservationToken": "string",
      "subscriptionId": "string"
    }
  ],
  "realPrice": 10.5,
  "currency": "EUR",
  "redeemedVouchers": {
    "totalRedeemedAmount": 10.5,
    "vouchers": [
      {
        "_id": "string",
        "code": "string",
        "redeemedAmount": 10.5
      }
    ]
  },
  "preferredLanguage": "de",
  "origin": "yourticket",
  "channel": "online",
  "salesChannelId": "string",
  "posId": "string",
  "userId": "string",
  "extraFields": {},
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

PUBLIC

Abort a checkout

Payload

secret

Required

string

The secret token of the checkout

200

400

Bad Request

404

Not Found

Was this section helpful?

Yes No

{
  "secret": "string"
}

{
  "_id": "string",
  "secret": "string",
  "status": "NEW",
  "type": "transaction",
  "company": "string",
  "firstname": "string",
  "lastname": "string",
  "name": "string",
  "email": "[email protected]",
  "phone": "string",
  "customerId": "string",
  "address": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string"
  },
  "deliveryAddress": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "string"
  },
  "sellerId": "string",
  "items": [
    {
      "_id": "string",
      "eventId": "string",
      "shopId": "string",
      "channelId": "string",
      "redeemedVouchers": {
        "totalRedeemedAmount": 10.5,
        "vouchers": [
          {
            "_id": "string",
            "code": "string",
            "redeemedAmount": 10.5
          }
        ]
      },
      "appliedCoupons": [
        {
          "_id": "string",
          "code": "string"
        }
      ],
      "appliedDiscountInfo": {
        "items": [
          {
            "_id": "string",
            "itemId": "string",
            "amount": 10.5,
            "regularPrice": 10.5,
            "price": 10.5,
            "varDiscounts": [
              {
                "_id": "string",
                "discountId": "string",
                "category": "coupon",
                "name": "string",
                "type": "fix",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ],
            "fixDiscounts": [
              {
                "_id": "string",
                "discountId": "string",
                "category": "coupon",
                "name": "string",
                "type": "fix",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ]
          }
        ],
        "discounts": [
          {
            "_id": "string",
            "discountId": "string",
            "category": "coupon",
            "name": "string",
            "type": "fix",
            "value": 10.5,
            "allowedItems": [
              "string"
            ],
            "maxItemsInCart": 10.5,
            "maxAbsoluteValue": 10.5,
            "absoluteDiscountValue": 10.5
          }
        ]
      },
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "innerFeeComponents": {
        "_id": "string",
        "fix": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ],
        "var": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ]
      },
      "innerCharge": 10.5,
      "outerFeeComponents": {
        "_id": "string",
        "fix": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ],
        "var": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ]
      },
      "outerCharge": 10.5,
      "tickets": [
        {
          "type": "ticket",
          "_id": "string",
          "name": "string",
          "amount": 1,
          "netPrice": 10.5,
          "price": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "string",
            "componentId": "string",
            "optionId": "string"
          },
          "ticketTypeId": "string",
          "categoryRef": "string",
          "seatingInfo": {
            "_id": "string",
            "_type": 6,
            "categoryId": "string",
            "statusId": "string",
            "name": "string",
            "seatType": "handicapped",
            "sectionName": "string",
            "groupName": "string",
            "rowName": "string",
            "seatName": "string",
            "gate": "string"
          },
          "asHardTicket": true,
          "triggeredAutomations": true,
          "meta": {}
        }
      ],
      "products": [
        {
          "type": "product",
          "_id": "string",
          "name": "string",
          "amount": 1,
          "netPrice": 10.5,
          "price": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "string",
            "componentId": "string",
            "optionId": "string"
          },
          "productVariantId": "string",
          "isFulfillable": true
        }
      ],
      "additionalItems": [],
      "seatingReservationToken": "string",
      "subscriptionId": "string"
    }
  ],
  "realPrice": 10.5,
  "currency": "EUR",
  "redeemedVouchers": {
    "totalRedeemedAmount": 10.5,
    "vouchers": [
      {
        "_id": "string",
        "code": "string",
        "redeemedAmount": 10.5
      }
    ]
  },
  "preferredLanguage": "de",
  "origin": "yourticket",
  "channel": "online",
  "salesChannelId": "string",
  "posId": "string",
  "userId": "string",
  "extraFields": {},
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

PUBLIC

Get all tickets for a checkout

Query

secret

Required

string

The secret token of the checkout

200

400

Bad Request

Was this section helpful?

Yes No

{
  "tickets": [
    {
      "sellerId": "string",
      "name": "string",
      "firstname": "string",
      "lastname": "string",
      "email": "string",
      "street": "string",
      "line2": "string",
      "city": "string",
      "postal": "string",
      "state": "string",
      "country": "string",
      "eventId": "string",
      "categoryRef": "string",
      "ticketTypeId": "string",
      "ticketName": "string",
      "categoryName": "string",
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "completed": true,
      "createdAt": "2030-01-23T23:00:00.123Z",
      "updatedAt": "2030-01-23T23:00:00.123Z",
      "status": "VALID",
      "secret": "string",
      "barcode": "string",
      "seat": "string",
      "seatingInfo": {
        "_id": "string",
        "_type": 6,
        "categoryId": "string",
        "statusId": "string",
        "name": "string",
        "seatType": "handicapped",
        "sectionName": "string",
        "groupName": "string",
        "rowName": "string",
        "seatName": "string",
        "gate": "string"
      },
      "type": "SINGLE",
      "origin": "yourticket",
      "extraFields": {},
      "deliveryType": "HARD",
      "transactionId": "string",
      "batchCounter": 10.5
    }
  ]
}

Complete an Internal Checkout

Reserves or completes a checkout and all corresponding transactions.

Payload

customerId

Required

string

The ID of the customer

status

Required

string

The status of the checkout

NEWCOMPLETE

Optional Attributes

Collapse all

fulfillmentTypes

Optional

array

fulfillmentTypes[].type

Required

string

The type of the cart item.

fulfillmentType

fulfillmentTypes[].amount

Required

integer

The amount of the cart item.

fulfillmentTypes[].price

Required

number float

The single piece price of the cart item.

Optional Attributes

Collapse all

fulfillmentTypes[]._id

Optional

string

The ID of the cart item.

fulfillmentTypes[].name

Optional

string

The name of the cart item.

fulfillmentTypes[].netPrice

Optional

number float

The single piece net price of the cart item.

fulfillmentTypes[].taxRate

Optional

number float

The tax rate to be applied to this cart item. If not present the tax rate of the transaction is taken.

fulfillmentTypes[].triggeredBy

Optional

An ID or an array of IDs of other cart items which triggered the buy action of the cart item.

One of

Only one of the following types

fulfillmentTypes[].bundleInfo

Optional

object

Optional Attributes

Collapse all

fulfillmentTypes[].bundleInfo.bundleId

Optional

string

fulfillmentTypes[].bundleInfo.componentId

Optional

string

fulfillmentTypes[].bundleInfo.optionId

Optional

string

fulfillmentTypes[].data

Optional

object

fulfillmentTypes[].data.fulfillmentTypeId

Required

string

The ID of the fulfillment type.

Optional Attributes

Collapse all

fulfillmentTypes[].data.cartItemIds

Optional

array<string>

The array of the related cart items IDs.

fulfillmentTypes[].data.discountable

Optional

boolean

Whether the fulfillment type is discountable.

paymentMethodId

Optional

string

The ID of the payment method. Only used when status == "COMPLETE." Can only submit one payment method (this or CPM). If no payment method is submitted, a local payment is assumed

customerPaymentMethodId

Optional

string

The ID of the customer payment method. Only used when status == "COMPLETE"

sendMail

Optional

boolean

Whether to send checkout confirmation mail

sendTicketMail

Optional

boolean

Whether to send ticket email on checkout completion. Only used when status == "COMPLETE" and checkout.type === "transaction"

reference

Optional

string

The reference of the local payment

paymentStrategyId

Optional

string

The ID of the payment strategy

paymentOptionId

Optional

string

The ID of the payment option

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

{
  "customerId": "string",
  "fulfillmentTypes": [
    {
      "type": "fulfillmentType",
      "_id": "string",
      "name": "string",
      "amount": 1,
      "netPrice": 10.5,
      "price": 10.5,
      "taxRate": 10.5,
      "triggeredBy": "string",
      "bundleInfo": {
        "bundleId": "string",
        "componentId": "string",
        "optionId": "string"
      },
      "data": {
        "fulfillmentTypeId": "string",
        "cartItemIds": [
          "string"
        ],
        "discountable": true
      }
    }
  ],
  "status": "NEW",
  "paymentMethodId": "string",
  "customerPaymentMethodId": "string",
  "sendMail": true,
  "sendTicketMail": true,
  "reference": "string",
  "paymentStrategyId": "string",
  "paymentOptionId": "string"
}

{
  "_id": "string",
  "secret": "string",
  "status": "NEW",
  "type": "transaction",
  "company": "string",
  "firstname": "string",
  "lastname": "string",
  "name": "string",
  "email": "[email protected]",
  "phone": "string",
  "customerId": "string",
  "address": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string"
  },
  "deliveryAddress": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "string"
  },
  "sellerId": "string",
  "items": [
    {
      "_id": "string",
      "eventId": "string",
      "shopId": "string",
      "channelId": "string",
      "redeemedVouchers": {
        "totalRedeemedAmount": 10.5,
        "vouchers": [
          {
            "_id": "string",
            "code": "string",
            "redeemedAmount": 10.5
          }
        ]
      },
      "appliedCoupons": [
        {
          "_id": "string",
          "code": "string"
        }
      ],
      "appliedDiscountInfo": {
        "items": [
          {
            "_id": "string",
            "itemId": "string",
            "amount": 10.5,
            "regularPrice": 10.5,
            "price": 10.5,
            "varDiscounts": [
              {
                "_id": "string",
                "discountId": "string",
                "category": "coupon",
                "name": "string",
                "type": "fix",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ],
            "fixDiscounts": [
              {
                "_id": "string",
                "discountId": "string",
                "category": "coupon",
                "name": "string",
                "type": "fix",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ]
          }
        ],
        "discounts": [
          {
            "_id": "string",
            "discountId": "string",
            "category": "coupon",
            "name": "string",
            "type": "fix",
            "value": 10.5,
            "allowedItems": [
              "string"
            ],
            "maxItemsInCart": 10.5,
            "maxAbsoluteValue": 10.5,
            "absoluteDiscountValue": 10.5
          }
        ]
      },
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "innerFeeComponents": {
        "_id": "string",
        "fix": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ],
        "var": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ]
      },
      "innerCharge": 10.5,
      "outerFeeComponents": {
        "_id": "string",
        "fix": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ],
        "var": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ]
      },
      "outerCharge": 10.5,
      "tickets": [
        {
          "type": "ticket",
          "_id": "string",
          "name": "string",
          "amount": 1,
          "netPrice": 10.5,
          "price": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "string",
            "componentId": "string",
            "optionId": "string"
          },
          "ticketTypeId": "string",
          "categoryRef": "string",
          "seatingInfo": {
            "_id": "string",
            "_type": 6,
            "categoryId": "string",
            "statusId": "string",
            "name": "string",
            "seatType": "handicapped",
            "sectionName": "string",
            "groupName": "string",
            "rowName": "string",
            "seatName": "string",
            "gate": "string"
          },
          "asHardTicket": true,
          "triggeredAutomations": true,
          "meta": {}
        }
      ],
      "products": [
        {
          "type": "product",
          "_id": "string",
          "name": "string",
          "amount": 1,
          "netPrice": 10.5,
          "price": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "string",
            "componentId": "string",
            "optionId": "string"
          },
          "productVariantId": "string",
          "isFulfillable": true
        }
      ],
      "additionalItems": [],
      "seatingReservationToken": "string",
      "subscriptionId": "string"
    }
  ],
  "realPrice": 10.5,
  "currency": "EUR",
  "redeemedVouchers": {
    "totalRedeemedAmount": 10.5,
    "vouchers": [
      {
        "_id": "string",
        "code": "string",
        "redeemedAmount": 10.5
      }
    ]
  },
  "preferredLanguage": "de",
  "origin": "yourticket",
  "channel": "online",
  "salesChannelId": "string",
  "posId": "string",
  "userId": "string",
  "extraFields": {},
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}