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.

Checkout items workflow

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.

The Checkout Object

The associated checkout

Required attributes

  • Name
    _id
    Type
    string
    Description

    The ID of the checkout.

  • Name
    secret
    Type
    string
    Description

    The secret token of the checkout.

  • Name
    status
    Type
    enum(NEW, ABORTED, COMPLETE)
    Description

    The status of the checkout.

  • Name
    type
    Type
    enum(transaction, upgrade, rebooking, purchaseintent, subscription)
    Description

    The type of the checkout.

  • Name
    sellerId
    Type
    string
    Description

    The ID of the seller of the checkout.

  • Name
    items
    Type
    array<object>
    Description

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

    Required nested attributes (5)
    • Name
      _id
      Type
      string
      Description

      The ID of the checkout item.

    • Name
      eventId
      Type
      string
      Description

      The ID of the event containing the item.

    • Name
      regularPrice
      Type
      number
      Description

      The regular price of the checkout item.

    • Name
      realPrice
      Type
      number
      Description

      The calculated price of the checkout item.

    • Name
      outerCharge
      Type
      number
      Description

      The outer charge of the checkout item.

    Optional nested attributes (13)
    • Name
      shopId
      Type
      string
      Description

      The ID of the under shop this item originated from.

    • Name
      channelId
      Type
      string
      Description

      The ID of the channel this item originated from.

    • Name
      redeemedVouchers
      Type
      object
      Description

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

      Required nested attributes (1)
      • Name
        totalRedeemedAmount
        Type
        number
        Description

        The sum of all vouchers applied.

      Optional nested attributes (1)
      • Name
        vouchers
        Type
        array<object>
        Description

        An array of all redeemed vouchers of the checkout item.

        Required nested attributes (2)
        • Name
          code
          Type
          string
          Description

          The Code of the voucher.

        • Name
          redeemedAmount
          Type
          number
          Description

          The applied value of the voucher.

        Optional nested attributes (1)
        • Name
          _id
          Type
          string
          Description

          The ID of the voucher.

    • Name
      appliedCoupons
      Type
      array<object>
      Description

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

      Optional nested attributes (2)
      • Name
        _id
        Type
        string
        Description

        The ID of the applied coupon.

      • Name
        code
        Type
        string
        Description

        The code of the applied coupon.

    • Name
      appliedDiscountInfo
      Type
      object
      Description

      Applied discountInfo of the checkout item.

      Optional nested attributes (2)
      • Name
        items
        Type
        array<object>
        Description

        An array of applied discount info items.

        Required nested attributes (1)
        • Name
          _id
          Type
          string
          Description

          The ID of the applied discount info item.

        Optional nested attributes (6)
        • Name
          itemId
          Type
          string
          Description

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

        • Name
          amount
          Type
          number
          Description

          The amount of applied discounts.

        • Name
          regularPrice
          Type
          number
          Description

          The regular price before applying the discount.

        • Name
          price
          Type
          number
          Description

          The price after applying the discount.

        • Name
          varDiscounts
          Type
          array<object>
          Description

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

          Required nested attributes (2)
          • Name
            _id
            Type
            string
            Description

            The ID of the discount info.

          • Name
            type
            Type
            enum(fix, var, fixPerItem, waiveFees)
            Description

            The type of the discount.

          Optional nested attributes (5)
          • Name
            discountId
            Type
            string
            Description

            The ID of the discount of the discount info.

          • Name
            category
            Type
            enum(coupon, groupDiscount, posDiscount, voucher, system, modifier)
            Description

            The category of the discount.

          • Name
            name
            Type
            string
            Description

            The name of the discount.

          • Name
            value
            Type
            number
            Description

            The value of the discount.

          • Name
            allowedItems
            Type
            array<string>
            Description

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

        • Name
          fixDiscounts
          Type
          array<object>
          Description

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

          Required nested attributes (2)
          • Name
            _id
            Type
            string
            Description

            The ID of the discount info.

          • Name
            type
            Type
            enum(fix, var, fixPerItem, waiveFees)
            Description

            The type of the discount.

          Optional nested attributes (5)
          • Name
            discountId
            Type
            string
            Description

            The ID of the discount of the discount info.

          • Name
            category
            Type
            enum(coupon, groupDiscount, posDiscount, voucher, system, modifier)
            Description

            The category of the discount.

          • Name
            name
            Type
            string
            Description

            The name of the discount.

          • Name
            value
            Type
            number
            Description

            The value of the discount.

          • Name
            allowedItems
            Type
            array<string>
            Description

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

      • Name
        discounts
        Type
        array<object>
        Description

        An array of extended discount info items.

        Required nested attributes (2)
        • Name
          _id
          Type
          string
          Description

          The ID of the discount info.

        • Name
          type
          Type
          enum(fix, var, fixPerItem, waiveFees)
          Description

          The type of the discount.

        Optional nested attributes (8)
        • Name
          discountId
          Type
          string
          Description

          The ID of the discount of the discount info.

        • Name
          category
          Type
          enum(coupon, groupDiscount, posDiscount, voucher, system, modifier)
          Description

          The category of the discount.

        • Name
          name
          Type
          string
          Description

          The name of the discount.

        • Name
          value
          Type
          number
          Description

          The value of the discount.

        • Name
          allowedItems
          Type
          array<string>
          Description

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

        • Name
          maxItemsInCart
          Type
          number
          Description

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

        • Name
          maxAbsoluteValue
          Type
          number
          Description

          The maximum absolute value of the discount.

        • Name
          absoluteDiscountValue
          Type
          number
          Description

          The absolute value of the discount.

    • Name
      innerFeeComponents
      Type
      object
      Description

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

      Required nested attributes (1)
      • Name
        _id
        Type
        string
        Description

        The ID of the fee composition.

      Optional nested attributes (2)
      • Name
        fix
        Type
        array<object>
        Description

        An array of fee components for the fix fee.

        Required nested attributes (1)
        • Name
          _id
          Type
          string
          Description

          The ID of the fee component.

        Optional nested attributes (8)
        • Name
          amount
          Type
          number
          Description

          The fee amount.

        • Name
          value
          Type
          number
          Description

          The fee value.

        • Name
          total
          Type
          number
          Description

          The fee total. Calculated with amount and value.

        • Name
          type
          Type
          enum(onTicket, onHardTicket, onCart)
          Description

          The fee type of the fee component.

        • Name
          name
          Type
          string
          Description

          The name of the fee.

        • Name
          publicName
          Type
          string
          Description

          The public name of the fee component.

        • Name
          exposed
          Type
          boolean
          Description

          Whether this fee will be exposed to the ticket buyer.

        • Name
          scheme
          Type
          object
          Description

          The fee scheme of the fee component.

          Optional nested attributes (2)
          • Name
            schemeId
            Type
            string
            Description

            The ID of the fee scheme.

          • Name
            feeId
            Type
            string
            Description

            The ID of the fee scheme fee.

      • Name
        var
        Type
        array<object>
        Description

        An array of fee components for the var fee.

        Required nested attributes (1)
        • Name
          _id
          Type
          string
          Description

          The ID of the fee component.

        Optional nested attributes (8)
        • Name
          amount
          Type
          number
          Description

          The fee amount.

        • Name
          value
          Type
          number
          Description

          The fee value.

        • Name
          total
          Type
          number
          Description

          The fee total. Calculated with amount and value.

        • Name
          type
          Type
          enum(onTicket, onHardTicket, onCart)
          Description

          The fee type of the fee component.

        • Name
          name
          Type
          string
          Description

          The name of the fee.

        • Name
          publicName
          Type
          string
          Description

          The public name of the fee component.

        • Name
          exposed
          Type
          boolean
          Description

          Whether this fee will be exposed to the ticket buyer.

        • Name
          scheme
          Type
          object
          Description

          The fee scheme of the fee component.

          Optional nested attributes (2)
          • Name
            schemeId
            Type
            string
            Description

            The ID of the fee scheme.

          • Name
            feeId
            Type
            string
            Description

            The ID of the fee scheme fee.

    • Name
      innerCharge
      Type
      number
      Description

      The inner charge of the checkout item.

    • Name
      outerFeeComponents
      Type
      object
      Description

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

      Required nested attributes (1)
      • Name
        _id
        Type
        string
        Description

        The ID of the fee composition.

      Optional nested attributes (2)
      • Name
        fix
        Type
        array<object>
        Description

        An array of fee components for the fix fee.

        Required nested attributes (1)
        • Name
          _id
          Type
          string
          Description

          The ID of the fee component.

        Optional nested attributes (8)
        • Name
          amount
          Type
          number
          Description

          The fee amount.

        • Name
          value
          Type
          number
          Description

          The fee value.

        • Name
          total
          Type
          number
          Description

          The fee total. Calculated with amount and value.

        • Name
          type
          Type
          enum(onTicket, onHardTicket, onCart)
          Description

          The fee type of the fee component.

        • Name
          name
          Type
          string
          Description

          The name of the fee.

        • Name
          publicName
          Type
          string
          Description

          The public name of the fee component.

        • Name
          exposed
          Type
          boolean
          Description

          Whether this fee will be exposed to the ticket buyer.

        • Name
          scheme
          Type
          object
          Description

          The fee scheme of the fee component.

          Optional nested attributes (2)
          • Name
            schemeId
            Type
            string
            Description

            The ID of the fee scheme.

          • Name
            feeId
            Type
            string
            Description

            The ID of the fee scheme fee.

      • Name
        var
        Type
        array<object>
        Description

        An array of fee components for the var fee.

        Required nested attributes (1)
        • Name
          _id
          Type
          string
          Description

          The ID of the fee component.

        Optional nested attributes (8)
        • Name
          amount
          Type
          number
          Description

          The fee amount.

        • Name
          value
          Type
          number
          Description

          The fee value.

        • Name
          total
          Type
          number
          Description

          The fee total. Calculated with amount and value.

        • Name
          type
          Type
          enum(onTicket, onHardTicket, onCart)
          Description

          The fee type of the fee component.

        • Name
          name
          Type
          string
          Description

          The name of the fee.

        • Name
          publicName
          Type
          string
          Description

          The public name of the fee component.

        • Name
          exposed
          Type
          boolean
          Description

          Whether this fee will be exposed to the ticket buyer.

        • Name
          scheme
          Type
          object
          Description

          The fee scheme of the fee component.

          Optional nested attributes (2)
          • Name
            schemeId
            Type
            string
            Description

            The ID of the fee scheme.

          • Name
            feeId
            Type
            string
            Description

            The ID of the fee scheme fee.

    • Name
      tickets
      Type
      array<object>
      Description

      An array containing all ticket cart items.

      Required nested attributes (3)
      • Name
        amount
        Type
        integer
        Description

        The amount of the cart item.

      • Name
        price
        Type
        number
        Description

        The single piece price of the cart item.

      • Name
        ticketTypeId
        Type
        string
        Description

        The ID of the ticket type of the cart item.

      Optional nested attributes (18)
      • Name
        type
        Type
        enum(ticket)
        Description

        The type of the cart item.

      • Name
        _id
        Type
        string
        Description

        Unique identifier for the cart item. If omitted, the system will automatically generate one.

      • Name
        name
        Type
        string
        Description

        The name of the cart item.

      • Name
        netPrice
        Type
        number
        Description

        The single piece net price of the cart item.

      • Name
        taxRate
        Type
        number
        Description

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

      • Name
        triggeredBy
        Type
        oneOf
        Description

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

      • Name
        bundleInfo
        Type
        object
        Description
        Optional nested attributes (3)
        • Name
          bundleId
          Type
          string
          Description
        • Name
          componentId
          Type
          string
          Description
        • Name
          optionId
          Type
          string
          Description
      • Name
        categoryRef
        Type
        string
        Description

        The category reference of the ticket type.

      • Name
        seatingInfo
        Type
        object
        Description

        The associated seating object.

        Required nested attributes (2)
        • Name
          _type
          Type
          enum(6, 7)
          Description

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

        • Name
          statusId
          Type
          string
          Description

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

        Optional nested attributes (9)
        • Name
          _id
          Type
          string
          Description

          The ID of the seating object.

        • Name
          categoryId
          Type
          string
          Description

          The ID of the category containing the seating object.

        • Name
          name
          Type
          string
          Description

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

        • Name
          seatType
          Type
          enum(handicapped, limitedView, foldable)
          Description

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

        • Name
          sectionName
          Type
          string
          Description

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

        • Name
          groupName
          Type
          string
          Description

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

        • Name
          rowName
          Type
          string
          Description

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

        • Name
          seatName
          Type
          string
          Description

          If _type == 6. The seat name.

        • Name
          gate
          Type
          string
          Description

          The entry gate associated with the seating object.

      • Name
        slotInfo
        Type
        object
        Description

        The associated time slot object.

        Required nested attributes (2)
        • Name
          slotId
          Type
          string
          Description

          The ID of the time slot.

        • Name
          slotStartTime
          Type
          string
          Description

          The start time of the time slot.

      • Name
        asHardTicket
        Type
        boolean
        Description

        Whether this ticket is a hard ticket.

      • Name
        listingId
        Type
        string
        Description

        Listing in secondary market.

      • Name
        listingItemId
        Type
        string
        Description

        The ID of the listing item in the secondary market.

      • Name
        triggeredAutomations
        Type
        boolean
        Description

        Whether the cart item triggered automations.

      • Name
        meta
        Type
        object
        Description

        Meta data which is propagated to the ticket.

      • Name
        addOns
        Type
        array<object>
        Description

        A list of Add-Ons of the ticket.

        Required nested attributes (3)
        • Name
          productId
          Type
          string
          Description
        • Name
          productVariantId
          Type
          string
          Description
        • Name
          name
          Type
          string
          Description
      • Name
        capabilities
        Type
        array<oneOf>
        Description

        The capabilities of the ticket.

      • Name
        taxInfo
        Type
        object
        Description

        The tax info details.

        Optional nested attributes (5)
        • Name
          serviceTypeId
          Type
          string
          Description

          The ID of the service type.

        • Name
          exceptionId
          Type
          string
          Description

          The ID of the exception.

        • Name
          proceedsAccountId
          Type
          string
          Description

          The ID of the proceeds account.

        • Name
          proceedsAccountCode
          Type
          string
          Description

          The code of the proceeds account.

        • Name
          taxItems
          Type
          array<object>
          Description

          The array of tax items.

          Required nested attributes (3)
          • Name
            rate
            Type
            number
            Description
          • Name
            perUnit
            Type
            number
            Description
          • Name
            total
            Type
            number
            Description
          Optional nested attributes (6)
          • Name
            name
            Type
            string
            Description
          • Name
            taxTypeId
            Type
            string
            Description
          • Name
            netTotal
            Type
            number
            Description
          • Name
            netPerUnit
            Type
            number
            Description
          • Name
            taxPayableAccountId
            Type
            string
            Description
          • Name
            taxPayableAccountCode
            Type
            string
            Description
    • Name
      products
      Type
      array<object>
      Description

      An array containing all product cart items.

      Required nested attributes (4)
      • Name
        type
        Type
        enum(product)
        Description

        The type of the cart item.

      • Name
        amount
        Type
        integer
        Description

        The amount of the cart item.

      • Name
        price
        Type
        number
        Description

        The single piece price of the cart item.

      • Name
        productVariantId
        Type
        string
        Description

        The ID of the product variant.

      Optional nested attributes (8)
      • Name
        _id
        Type
        string
        Description

        Unique identifier for the cart item. If omitted, the system will automatically generate one.

      • Name
        name
        Type
        string
        Description

        The name of the cart item.

      • Name
        netPrice
        Type
        number
        Description

        The single piece net price of the cart item.

      • Name
        taxRate
        Type
        number
        Description

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

      • Name
        triggeredBy
        Type
        oneOf
        Description

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

      • Name
        bundleInfo
        Type
        object
        Description
        Optional nested attributes (3)
        • Name
          bundleId
          Type
          string
          Description
        • Name
          componentId
          Type
          string
          Description
        • Name
          optionId
          Type
          string
          Description
      • Name
        isFulfillable
        Type
        boolean
        Description

        Whether the product can be delivered

      • Name
        taxInfo
        Type
        object
        Description

        The tax info details.

        Optional nested attributes (5)
        • Name
          serviceTypeId
          Type
          string
          Description

          The ID of the service type.

        • Name
          exceptionId
          Type
          string
          Description

          The ID of the exception.

        • Name
          proceedsAccountId
          Type
          string
          Description

          The ID of the proceeds account.

        • Name
          proceedsAccountCode
          Type
          string
          Description

          The code of the proceeds account.

        • Name
          taxItems
          Type
          array<object>
          Description

          The array of tax items.

          Required nested attributes (3)
          • Name
            rate
            Type
            number
            Description
          • Name
            perUnit
            Type
            number
            Description
          • Name
            total
            Type
            number
            Description
          Optional nested attributes (6)
          • Name
            name
            Type
            string
            Description
          • Name
            taxTypeId
            Type
            string
            Description
          • Name
            netTotal
            Type
            number
            Description
          • Name
            netPerUnit
            Type
            number
            Description
          • Name
            taxPayableAccountId
            Type
            string
            Description
          • Name
            taxPayableAccountCode
            Type
            string
            Description
    • Name
      additionalItems
      Type
      array<oneOf>
      Description

      An array of additional price items of the checkout itemt.

    • Name
      seatingReservationToken
      Type
      string
      Description

      The reservation token of the selected seats.

    • Name
      subscriptionId
      Type
      string
      Description

      The ID of the subscription if this item triggered one.

  • Name
    realPrice
    Type
    number
    Description

    The calculated real price of the checkout.

Optional attributes

  • Name
    company
    Type
    string
    Description

    The company name of the checkout's customer.

  • Name
    firstname
    Type
    string
    Description

    The first name of the checkout's customer.

  • Name
    lastname
    Type
    string
    Description

    The last name of the checkout's customer.

  • Name
    name
    Type
    string
    Description

    The full name of the checkout's customer.

  • Name
    email
    Type
    string
    Description

    The email of the checkout's customer.

  • Name
    phone
    Type
    string
    Description

    The phone number of the checkout's customer.

  • Name
    customerId
    Type
    string
    Description

    The ID of the customer.

  • Name
    address
    Type
    object
    Description

    The address of the checkout.

    Optional nested attributes (7)
    • Name
      fullAddress
      Type
      string
      Description

      Optional full address

    • Name
      street
      Type
      string
      Description

      The street of the address. Street name including number.

    • Name
      line2
      Type
      string
      Description

      The additional field of the address.

    • Name
      postal
      Type
      string
      Description

      The postal code of the address.

    • Name
      city
      Type
      string
      Description

      The city of the address.

    • Name
      country
      Type
      string
      Description

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

    • Name
      state
      Type
      string
      Description

      The state of the address. If applicable

  • Name
    deliveryAddress
    Type
    object
    Description

    The delivery address of the checkout.

    Optional nested attributes (8)
    • Name
      fullAddress
      Type
      string
      Description

      Optional full address

    • Name
      street
      Type
      string
      Description

      The street of the address. Street name including number.

    • Name
      line2
      Type
      string
      Description

      The additional field of the address.

    • Name
      postal
      Type
      string
      Description

      The postal code of the address.

    • Name
      city
      Type
      string
      Description

      The city of the address.

    • Name
      country
      Type
      string
      Description

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

    • Name
      state
      Type
      string
      Description

      The state of the address. If applicable

    • Name
      name
      Type
      string
      Description

      The name of the person receiving delivery.

  • Name
    identification
    Type
    array<object>
    Description

    An array of identification items

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

    An ISO 4217 3-character code of the currency.

  • Name
    redeemedVouchers
    Type
    object
    Description

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

    Required nested attributes (1)
    • Name
      totalRedeemedAmount
      Type
      number
      Description

      The sum of all vouchers applied.

    Optional nested attributes (1)
    • Name
      vouchers
      Type
      array<object>
      Description

      An array of all redeemed vouchers of the checkout.

      Required nested attributes (2)
      • Name
        code
        Type
        string
        Description

        The Code of the voucher.

      • Name
        redeemedAmount
        Type
        number
        Description

        The applied value of the voucher.

      Optional nested attributes (1)
      • Name
        _id
        Type
        string
        Description

        The ID of the voucher.

  • Name
    preferredLanguage
    Type
    enum(de, de-CH, en, en-GB, en-AU, fr, es, es-MX, is, it, ru, pt, tr, nb, nl, pl, sv, sl, da, cs, lv, he, ar, th, ko, ja, zh-TW)
    Description

    The prefered language of the checkout.

  • Name
    origin
    Type
    enum(yourticket, pos, rebooking, upgrade, subscription)
    Description

    The origin of the checkout.

  • Name
    channel
    Type
    enum(online, internal, pos)
    Description

    The channel of the checkout.

  • Name
    salesChannelId
    Type
    string
    Description

    The ID of the sales channel of the checkout.

  • Name
    posId
    Type
    string
    Description

    The ID of the POS which created the checkout.

  • Name
    userId
    Type
    string
    Description

    The ID of the user who created the checkout.

  • Name
    extraFields
    Type
    object
    Description

    An object containing key-value information.

  • Name
    expiresAt
    Type
    string
    Description

    An ISO Timestamp indicating when the checkout will expire.

  • Name
    createdAt
    Type
    string
    Description

    An ISO timestamp indicating when the checkout was created.

  • Name
    updatedAt
    Type
    string
    Description

    An ISO timestamp indicating when the checkout was last updated.

Example

{
  "_id": "507f191e810c19729de860ea",
  "secret": "string",
  "status": "NEW",
  "type": "transaction",
  "sellerId": "507f191e810c19729de860ea",
  "items": [
    {
      "_id": "507f191e810c19729de860ea",
      "eventId": "507f191e810c19729de860ea",
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "outerCharge": 10.5,
      "shopId": "507f191e810c19729de860ea",
      "channelId": "507f191e810c19729de860ea",
      "redeemedVouchers": {
        "totalRedeemedAmount": 10.5,
        "vouchers": [
          {
            "code": "string",
            "redeemedAmount": 10.5,
            "_id": "507f191e810c19729de860ea"
          }
        ]
      },
      "appliedCoupons": [
        {
          "_id": "507f191e810c19729de860ea",
          "code": "string"
        }
      ],
      "appliedDiscountInfo": {
        "items": [
          {
            "_id": "507f191e810c19729de860ea",
            "itemId": "507f191e810c19729de860ea",
            "amount": 10.5,
            "regularPrice": 10.5,
            "price": 10.5,
            "varDiscounts": [
              {
                "_id": "507f191e810c19729de860ea",
                "type": "fix",
                "discountId": "507f191e810c19729de860ea",
                "category": "coupon",
                "name": "Example Name",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ],
            "fixDiscounts": [
              {
                "_id": "507f191e810c19729de860ea",
                "type": "fix",
                "discountId": "507f191e810c19729de860ea",
                "category": "coupon",
                "name": "Example Name",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ]
          }
        ],
        "discounts": [
          {
            "_id": "507f191e810c19729de860ea",
            "type": "fix",
            "discountId": "507f191e810c19729de860ea",
            "category": "coupon",
            "name": "Example Name",
            "value": 10.5,
            "allowedItems": [
              "string"
            ],
            "maxItemsInCart": 10.5,
            "maxAbsoluteValue": 10.5,
            "absoluteDiscountValue": 10.5
          }
        ]
      },
      "innerFeeComponents": {
        "_id": "507f191e810c19729de860ea",
        "fix": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ],
        "var": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ]
      },
      "innerCharge": 10.5,
      "outerFeeComponents": {
        "_id": "507f191e810c19729de860ea",
        "fix": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ],
        "var": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ]
      },
      "tickets": [
        {
          "amount": 1,
          "price": 10.5,
          "ticketTypeId": "507f191e810c19729de860ea",
          "type": "ticket",
          "_id": "507f191e810c19729de860ea",
          "name": "Example Name",
          "netPrice": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "507f191e810c19729de860ea",
            "componentId": "507f191e810c19729de860ea",
            "optionId": "507f191e810c19729de860ea"
          },
          "categoryRef": "string",
          "seatingInfo": {
            "_type": 6,
            "statusId": "507f191e810c19729de860ea",
            "_id": "507f191e810c19729de860ea",
            "categoryId": "507f191e810c19729de860ea",
            "name": "Example Name",
            "seatType": "handicapped",
            "sectionName": "string",
            "groupName": "string",
            "rowName": "string",
            "seatName": "string",
            "gate": "string"
          },
          "slotInfo": {
            "slotId": "507f191e810c19729de860ea",
            "slotStartTime": "2030-01-23T23:00:00.123Z"
          },
          "asHardTicket": true,
          "listingId": "507f191e810c19729de860ea",
          "listingItemId": "507f191e810c19729de860ea",
          "triggeredAutomations": true,
          "meta": {},
          "addOns": [
            {
              "productId": "507f191e810c19729de860ea",
              "productVariantId": "507f191e810c19729de860ea",
              "name": "Example Name"
            }
          ],
          "capabilities": [
            {
              "type": "self_service_return",
              "settings": {
                "phases": [
                  {
                    "condition": {
                      "unit": "hours",
                      "offset": 1,
                      "target": "string"
                    },
                    "refundPercentage": 10.5
                  }
                ],
                "returnRelatedItems": true
              }
            }
          ],
          "taxInfo": {
            "serviceTypeId": "507f191e810c19729de860ea",
            "exceptionId": "507f191e810c19729de860ea",
            "proceedsAccountId": "507f191e810c19729de860ea",
            "proceedsAccountCode": "string",
            "taxItems": [
              {
                "rate": 10.5,
                "perUnit": 10.5,
                "total": 10.5,
                "name": "Example Name",
                "taxTypeId": "507f191e810c19729de860ea",
                "netTotal": 10.5,
                "netPerUnit": 10.5,
                "taxPayableAccountId": "507f191e810c19729de860ea",
                "taxPayableAccountCode": "string"
              }
            ]
          }
        }
      ],
      "products": [
        {
          "type": "product",
          "amount": 1,
          "price": 10.5,
          "productVariantId": "507f191e810c19729de860ea",
          "_id": "507f191e810c19729de860ea",
          "name": "Example Name",
          "netPrice": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "507f191e810c19729de860ea",
            "componentId": "507f191e810c19729de860ea",
            "optionId": "507f191e810c19729de860ea"
          },
          "isFulfillable": true,
          "taxInfo": {
            "serviceTypeId": "507f191e810c19729de860ea",
            "exceptionId": "507f191e810c19729de860ea",
            "proceedsAccountId": "507f191e810c19729de860ea",
            "proceedsAccountCode": "string",
            "taxItems": [
              {
                "rate": 10.5,
                "perUnit": 10.5,
                "total": 10.5,
                "name": "Example Name",
                "taxTypeId": "507f191e810c19729de860ea",
                "netTotal": 10.5,
                "netPerUnit": 10.5,
                "taxPayableAccountId": "507f191e810c19729de860ea",
                "taxPayableAccountCode": "string"
              }
            ]
          }
        }
      ],
      "additionalItems": [],
      "seatingReservationToken": "string",
      "subscriptionId": "507f191e810c19729de860ea"
    }
  ],
  "realPrice": 10.5,
  "company": "string",
  "firstname": "string",
  "lastname": "string",
  "name": "Example Name",
  "email": "example@vivenu.com",
  "phone": "string",
  "customerId": "507f191e810c19729de860ea",
  "address": {
    "fullAddress": "string",
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string"
  },
  "deliveryAddress": {
    "fullAddress": "string",
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "Example Name"
  },
  "identification": [],
  "currency": "EUR",
  "redeemedVouchers": {
    "totalRedeemedAmount": 10.5,
    "vouchers": [
      {
        "code": "string",
        "redeemedAmount": 10.5,
        "_id": "507f191e810c19729de860ea"
      }
    ]
  },
  "preferredLanguage": "de",
  "origin": "yourticket",
  "channel": "online",
  "salesChannelId": "507f191e810c19729de860ea",
  "posId": "507f191e810c19729de860ea",
  "userId": "507f191e810c19729de860ea",
  "extraFields": {},
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}
POSTPUBLIC/api/checkout

Create a Checkout

Create a Checkout

Important: If your checkout items include seating information, use the full seating info object as it was received from the Seat Selector callbacks. Attach them to the appropriate seating fields in your payload. Do not change, remove, or rename any attributes.

See: Seat Selector.

Payload

Required attributes

  • Name
    type
    Type
    enum(transaction, upgrade, rebooking, purchaseintent, subscription)
    Description

    The type of the checkout.

  • Name
    eventId
    Type
    string
    Description

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

  • Name
    items
    Type
    array<oneOf>
    Description

    An array of all cart items.

Optional attributes

  • Name
    coupons
    Type
    array<string>
    Description

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

  • Name
    vouchers
    Type
    array<string>
    Description

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

  • Name
    shopId
    Type
    string
    Description

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

  • Name
    seatingReservationToken
    Type
    string
    Description

    The reservation token of the selected seats.

  • Name
    channelId
    Type
    string
    Description

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

  • Name
    salesChannelId
    Type
    string
    Description

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

  • Name
    preferredLanguage
    Type
    object
    Description
  • Name
    meta
    Type
    object
    Description

    Custom key-value data. Metadata is useful for storing additional, structured information on an object.

Request

POST
/api/checkout
const response = await fetch('https://vivenu.com/api/checkout', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer {token}',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(  {
    "type": "transaction",
    "eventId": "507f191e810c19729de860ea",
    "items": [
      {
        "amount": 1,
        "ticketTypeId": "507f191e810c19729de860ea",
        "_id": "507f191e810c19729de860ea",
        "type": "ticket",
        "seatingInfo": {
          "_type": 6,
          "statusId": "507f191e810c19729de860ea",
          "_id": "507f191e810c19729de860ea",
          "categoryId": "507f191e810c19729de860ea",
          "name": "Example Name",
          "seatType": "handicapped",
          "sectionName": "string",
          "groupName": "string",
          "rowName": "string",
          "seatName": "string",
          "gate": "string"
        },
        "slotInfo": {
          "slotId": "507f191e810c19729de860ea",
          "slotStartTime": "2030-01-23T23:00:00.123Z"
        },
        "asHardTicket": true,
        "listingId": "507f191e810c19729de860ea",
        "triggeredBy": "string",
        "triggeredAutomations": true,
        "meta": {},
        "bundleInfo": {
          "bundleId": "507f191e810c19729de860ea",
          "componentId": "507f191e810c19729de860ea",
          "optionId": "507f191e810c19729de860ea"
        }
      }
    ],
    "coupons": [
      "string"
    ],
    "vouchers": [
      "string"
    ],
    "shopId": "507f191e810c19729de860ea",
    "seatingReservationToken": "string",
    "channelId": "507f191e810c19729de860ea",
    "salesChannelId": "507f191e810c19729de860ea",
    "meta": {}
  }),
})

const data = await response.json()

Response (200)

{
  "_id": "507f191e810c19729de860ea",
  "secret": "string",
  "status": "NEW",
  "type": "transaction",
  "sellerId": "507f191e810c19729de860ea",
  "items": [
    {
      "_id": "507f191e810c19729de860ea",
      "eventId": "507f191e810c19729de860ea",
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "outerCharge": 10.5,
      "shopId": "507f191e810c19729de860ea",
      "channelId": "507f191e810c19729de860ea",
      "redeemedVouchers": {
        "totalRedeemedAmount": 10.5,
        "vouchers": [
          {
            "code": "string",
            "redeemedAmount": 10.5,
            "_id": "507f191e810c19729de860ea"
          }
        ]
      },
      "appliedCoupons": [
        {
          "_id": "507f191e810c19729de860ea",
          "code": "string"
        }
      ],
      "appliedDiscountInfo": {
        "items": [
          {
            "_id": "507f191e810c19729de860ea",
            "itemId": "507f191e810c19729de860ea",
            "amount": 10.5,
            "regularPrice": 10.5,
            "price": 10.5,
            "varDiscounts": [
              {
                "_id": "507f191e810c19729de860ea",
                "type": "fix",
                "discountId": "507f191e810c19729de860ea",
                "category": "coupon",
                "name": "Example Name",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ],
            "fixDiscounts": [
              {
                "_id": "507f191e810c19729de860ea",
                "type": "fix",
                "discountId": "507f191e810c19729de860ea",
                "category": "coupon",
                "name": "Example Name",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ]
          }
        ],
        "discounts": [
          {
            "_id": "507f191e810c19729de860ea",
            "type": "fix",
            "discountId": "507f191e810c19729de860ea",
            "category": "coupon",
            "name": "Example Name",
            "value": 10.5,
            "allowedItems": [
              "string"
            ],
            "maxItemsInCart": 10.5,
            "maxAbsoluteValue": 10.5,
            "absoluteDiscountValue": 10.5
          }
        ]
      },
      "innerFeeComponents": {
        "_id": "507f191e810c19729de860ea",
        "fix": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ],
        "var": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ]
      },
      "innerCharge": 10.5,
      "outerFeeComponents": {
        "_id": "507f191e810c19729de860ea",
        "fix": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ],
        "var": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ]
      },
      "tickets": [
        {
          "amount": 1,
          "price": 10.5,
          "ticketTypeId": "507f191e810c19729de860ea",
          "type": "ticket",
          "_id": "507f191e810c19729de860ea",
          "name": "Example Name",
          "netPrice": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "507f191e810c19729de860ea",
            "componentId": "507f191e810c19729de860ea",
            "optionId": "507f191e810c19729de860ea"
          },
          "categoryRef": "string",
          "seatingInfo": {
            "_type": 6,
            "statusId": "507f191e810c19729de860ea",
            "_id": "507f191e810c19729de860ea",
            "categoryId": "507f191e810c19729de860ea",
            "name": "Example Name",
            "seatType": "handicapped",
            "sectionName": "string",
            "groupName": "string",
            "rowName": "string",
            "seatName": "string",
            "gate": "string"
          },
          "slotInfo": {
            "slotId": "507f191e810c19729de860ea",
            "slotStartTime": "2030-01-23T23:00:00.123Z"
          },
          "asHardTicket": true,
          "listingId": "507f191e810c19729de860ea",
          "listingItemId": "507f191e810c19729de860ea",
          "triggeredAutomations": true,
          "meta": {},
          "addOns": [
            {
              "productId": "507f191e810c19729de860ea",
              "productVariantId": "507f191e810c19729de860ea",
              "name": "Example Name"
            }
          ],
          "capabilities": [
            {
              "type": "self_service_return",
              "settings": {
                "phases": [
                  {
                    "condition": {
                      "unit": "hours",
                      "offset": 1,
                      "target": "string"
                    },
                    "refundPercentage": 10.5
                  }
                ],
                "returnRelatedItems": true
              }
            }
          ],
          "taxInfo": {
            "serviceTypeId": "507f191e810c19729de860ea",
            "exceptionId": "507f191e810c19729de860ea",
            "proceedsAccountId": "507f191e810c19729de860ea",
            "proceedsAccountCode": "string",
            "taxItems": [
              {
                "rate": 10.5,
                "perUnit": 10.5,
                "total": 10.5,
                "name": "Example Name",
                "taxTypeId": "507f191e810c19729de860ea",
                "netTotal": 10.5,
                "netPerUnit": 10.5,
                "taxPayableAccountId": "507f191e810c19729de860ea",
                "taxPayableAccountCode": "string"
              }
            ]
          }
        }
      ],
      "products": [
        {
          "type": "product",
          "amount": 1,
          "price": 10.5,
          "productVariantId": "507f191e810c19729de860ea",
          "_id": "507f191e810c19729de860ea",
          "name": "Example Name",
          "netPrice": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "507f191e810c19729de860ea",
            "componentId": "507f191e810c19729de860ea",
            "optionId": "507f191e810c19729de860ea"
          },
          "isFulfillable": true,
          "taxInfo": {
            "serviceTypeId": "507f191e810c19729de860ea",
            "exceptionId": "507f191e810c19729de860ea",
            "proceedsAccountId": "507f191e810c19729de860ea",
            "proceedsAccountCode": "string",
            "taxItems": [
              {
                "rate": 10.5,
                "perUnit": 10.5,
                "total": 10.5,
                "name": "Example Name",
                "taxTypeId": "507f191e810c19729de860ea",
                "netTotal": 10.5,
                "netPerUnit": 10.5,
                "taxPayableAccountId": "507f191e810c19729de860ea",
                "taxPayableAccountCode": "string"
              }
            ]
          }
        }
      ],
      "additionalItems": [],
      "seatingReservationToken": "string",
      "subscriptionId": "507f191e810c19729de860ea"
    }
  ],
  "realPrice": 10.5,
  "company": "string",
  "firstname": "string",
  "lastname": "string",
  "name": "Example Name",
  "email": "example@vivenu.com",
  "phone": "string",
  "customerId": "507f191e810c19729de860ea",
  "address": {
    "fullAddress": "string",
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string"
  },
  "deliveryAddress": {
    "fullAddress": "string",
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "Example Name"
  },
  "identification": [],
  "currency": "EUR",
  "redeemedVouchers": {
    "totalRedeemedAmount": 10.5,
    "vouchers": [
      {
        "code": "string",
        "redeemedAmount": 10.5,
        "_id": "507f191e810c19729de860ea"
      }
    ]
  },
  "preferredLanguage": "de",
  "origin": "yourticket",
  "channel": "online",
  "salesChannelId": "507f191e810c19729de860ea",
  "posId": "507f191e810c19729de860ea",
  "userId": "507f191e810c19729de860ea",
  "extraFields": {},
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}
POSTPUBLIC/api/checkout/:id/items

Update checkout items

Update checkout items

Adds or updates a checkout item for a given eventId.

Important: When adding or updating cart items with seating information, send the complete, unmodified seating info object as it was received from the Seat Selector callbacks as part of the item payload. Do not change, remove, or rename any attributes.

See: Seat Selector.

Payload

Required attributes

  • Name
    secret
    Type
    string
    Description

    The secret token of the checkout

  • Name
    eventId
    Type
    string
    Description

    The ID of the event to create the transaction for

  • Name
    items
    Type
    array<oneOf>
    Description

    An array of all cart items

Optional attributes

  • Name
    coupons
    Type
    array<string>
    Description

    An array of coupon code to apply to this transaction

  • Name
    shopId
    Type
    string
    Description

    The ID of the secret shop to create the transaction for

  • Name
    seatingReservationToken
    Type
    string
    Description

    The reservation token of the selected seats

  • Name
    channelId
    Type
    string
    Description

    The ID of the channel to create the transaction for

Request

POST
/api/checkout/:id/items
const response = await fetch('https://vivenu.com/api/checkout/507f191e810c19729de860ea/items', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer {token}',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(  {
    "secret": "string",
    "eventId": "507f191e810c19729de860ea",
    "items": [
      {
        "amount": 1,
        "ticketTypeId": "507f191e810c19729de860ea",
        "_id": "507f191e810c19729de860ea",
        "type": "ticket",
        "seatingInfo": {
          "_type": 6,
          "statusId": "507f191e810c19729de860ea",
          "_id": "507f191e810c19729de860ea",
          "categoryId": "507f191e810c19729de860ea",
          "name": "Example Name",
          "seatType": "handicapped",
          "sectionName": "string",
          "groupName": "string",
          "rowName": "string",
          "seatName": "string",
          "gate": "string"
        },
        "slotInfo": {
          "slotId": "507f191e810c19729de860ea",
          "slotStartTime": "2030-01-23T23:00:00.123Z"
        },
        "asHardTicket": true,
        "listingId": "507f191e810c19729de860ea",
        "triggeredBy": "string",
        "triggeredAutomations": true,
        "meta": {},
        "bundleInfo": {
          "bundleId": "507f191e810c19729de860ea",
          "componentId": "507f191e810c19729de860ea",
          "optionId": "507f191e810c19729de860ea"
        }
      }
    ],
    "coupons": [
      "string"
    ],
    "shopId": "507f191e810c19729de860ea",
    "seatingReservationToken": "string",
    "channelId": "507f191e810c19729de860ea"
  }),
})

const data = await response.json()

Response (200)

{
  "_id": "507f191e810c19729de860ea",
  "secret": "string",
  "status": "NEW",
  "type": "transaction",
  "sellerId": "507f191e810c19729de860ea",
  "items": [
    {
      "_id": "507f191e810c19729de860ea",
      "eventId": "507f191e810c19729de860ea",
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "outerCharge": 10.5,
      "shopId": "507f191e810c19729de860ea",
      "channelId": "507f191e810c19729de860ea",
      "redeemedVouchers": {
        "totalRedeemedAmount": 10.5,
        "vouchers": [
          {
            "code": "string",
            "redeemedAmount": 10.5,
            "_id": "507f191e810c19729de860ea"
          }
        ]
      },
      "appliedCoupons": [
        {
          "_id": "507f191e810c19729de860ea",
          "code": "string"
        }
      ],
      "appliedDiscountInfo": {
        "items": [
          {
            "_id": "507f191e810c19729de860ea",
            "itemId": "507f191e810c19729de860ea",
            "amount": 10.5,
            "regularPrice": 10.5,
            "price": 10.5,
            "varDiscounts": [
              {
                "_id": "507f191e810c19729de860ea",
                "type": "fix",
                "discountId": "507f191e810c19729de860ea",
                "category": "coupon",
                "name": "Example Name",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ],
            "fixDiscounts": [
              {
                "_id": "507f191e810c19729de860ea",
                "type": "fix",
                "discountId": "507f191e810c19729de860ea",
                "category": "coupon",
                "name": "Example Name",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ]
          }
        ],
        "discounts": [
          {
            "_id": "507f191e810c19729de860ea",
            "type": "fix",
            "discountId": "507f191e810c19729de860ea",
            "category": "coupon",
            "name": "Example Name",
            "value": 10.5,
            "allowedItems": [
              "string"
            ],
            "maxItemsInCart": 10.5,
            "maxAbsoluteValue": 10.5,
            "absoluteDiscountValue": 10.5
          }
        ]
      },
      "innerFeeComponents": {
        "_id": "507f191e810c19729de860ea",
        "fix": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ],
        "var": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ]
      },
      "innerCharge": 10.5,
      "outerFeeComponents": {
        "_id": "507f191e810c19729de860ea",
        "fix": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ],
        "var": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ]
      },
      "tickets": [
        {
          "amount": 1,
          "price": 10.5,
          "ticketTypeId": "507f191e810c19729de860ea",
          "type": "ticket",
          "_id": "507f191e810c19729de860ea",
          "name": "Example Name",
          "netPrice": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "507f191e810c19729de860ea",
            "componentId": "507f191e810c19729de860ea",
            "optionId": "507f191e810c19729de860ea"
          },
          "categoryRef": "string",
          "seatingInfo": {
            "_type": 6,
            "statusId": "507f191e810c19729de860ea",
            "_id": "507f191e810c19729de860ea",
            "categoryId": "507f191e810c19729de860ea",
            "name": "Example Name",
            "seatType": "handicapped",
            "sectionName": "string",
            "groupName": "string",
            "rowName": "string",
            "seatName": "string",
            "gate": "string"
          },
          "slotInfo": {
            "slotId": "507f191e810c19729de860ea",
            "slotStartTime": "2030-01-23T23:00:00.123Z"
          },
          "asHardTicket": true,
          "listingId": "507f191e810c19729de860ea",
          "listingItemId": "507f191e810c19729de860ea",
          "triggeredAutomations": true,
          "meta": {},
          "addOns": [
            {
              "productId": "507f191e810c19729de860ea",
              "productVariantId": "507f191e810c19729de860ea",
              "name": "Example Name"
            }
          ],
          "capabilities": [
            {
              "type": "self_service_return",
              "settings": {
                "phases": [
                  {
                    "condition": {
                      "unit": "hours",
                      "offset": 1,
                      "target": "string"
                    },
                    "refundPercentage": 10.5
                  }
                ],
                "returnRelatedItems": true
              }
            }
          ],
          "taxInfo": {
            "serviceTypeId": "507f191e810c19729de860ea",
            "exceptionId": "507f191e810c19729de860ea",
            "proceedsAccountId": "507f191e810c19729de860ea",
            "proceedsAccountCode": "string",
            "taxItems": [
              {
                "rate": 10.5,
                "perUnit": 10.5,
                "total": 10.5,
                "name": "Example Name",
                "taxTypeId": "507f191e810c19729de860ea",
                "netTotal": 10.5,
                "netPerUnit": 10.5,
                "taxPayableAccountId": "507f191e810c19729de860ea",
                "taxPayableAccountCode": "string"
              }
            ]
          }
        }
      ],
      "products": [
        {
          "type": "product",
          "amount": 1,
          "price": 10.5,
          "productVariantId": "507f191e810c19729de860ea",
          "_id": "507f191e810c19729de860ea",
          "name": "Example Name",
          "netPrice": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "507f191e810c19729de860ea",
            "componentId": "507f191e810c19729de860ea",
            "optionId": "507f191e810c19729de860ea"
          },
          "isFulfillable": true,
          "taxInfo": {
            "serviceTypeId": "507f191e810c19729de860ea",
            "exceptionId": "507f191e810c19729de860ea",
            "proceedsAccountId": "507f191e810c19729de860ea",
            "proceedsAccountCode": "string",
            "taxItems": [
              {
                "rate": 10.5,
                "perUnit": 10.5,
                "total": 10.5,
                "name": "Example Name",
                "taxTypeId": "507f191e810c19729de860ea",
                "netTotal": 10.5,
                "netPerUnit": 10.5,
                "taxPayableAccountId": "507f191e810c19729de860ea",
                "taxPayableAccountCode": "string"
              }
            ]
          }
        }
      ],
      "additionalItems": [],
      "seatingReservationToken": "string",
      "subscriptionId": "507f191e810c19729de860ea"
    }
  ],
  "realPrice": 10.5,
  "company": "string",
  "firstname": "string",
  "lastname": "string",
  "name": "Example Name",
  "email": "example@vivenu.com",
  "phone": "string",
  "customerId": "507f191e810c19729de860ea",
  "address": {
    "fullAddress": "string",
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string"
  },
  "deliveryAddress": {
    "fullAddress": "string",
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "Example Name"
  },
  "identification": [],
  "currency": "EUR",
  "redeemedVouchers": {
    "totalRedeemedAmount": 10.5,
    "vouchers": [
      {
        "code": "string",
        "redeemedAmount": 10.5,
        "_id": "507f191e810c19729de860ea"
      }
    ]
  },
  "preferredLanguage": "de",
  "origin": "yourticket",
  "channel": "online",
  "salesChannelId": "507f191e810c19729de860ea",
  "posId": "507f191e810c19729de860ea",
  "userId": "507f191e810c19729de860ea",
  "extraFields": {},
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}
GETPUBLIC/api/checkout/:id

Get a Checkout

Get a Checkout

Query parameters

Required query parameters

  • Name
    secret
    Type
    string
    Description

Request

GET
/api/checkout/:id
const response = await fetch('https://vivenu.com/api/checkout/507f191e810c19729de860ea?secret=value', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer {token}',
  },
})

const data = await response.json()

Response (200)

{
  "_id": "507f191e810c19729de860ea",
  "secret": "string",
  "status": "NEW",
  "type": "transaction",
  "sellerId": "507f191e810c19729de860ea",
  "items": [
    {
      "_id": "507f191e810c19729de860ea",
      "eventId": "507f191e810c19729de860ea",
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "outerCharge": 10.5,
      "shopId": "507f191e810c19729de860ea",
      "channelId": "507f191e810c19729de860ea",
      "redeemedVouchers": {
        "totalRedeemedAmount": 10.5,
        "vouchers": [
          {
            "code": "string",
            "redeemedAmount": 10.5,
            "_id": "507f191e810c19729de860ea"
          }
        ]
      },
      "appliedCoupons": [
        {
          "_id": "507f191e810c19729de860ea",
          "code": "string"
        }
      ],
      "appliedDiscountInfo": {
        "items": [
          {
            "_id": "507f191e810c19729de860ea",
            "itemId": "507f191e810c19729de860ea",
            "amount": 10.5,
            "regularPrice": 10.5,
            "price": 10.5,
            "varDiscounts": [
              {
                "_id": "507f191e810c19729de860ea",
                "type": "fix",
                "discountId": "507f191e810c19729de860ea",
                "category": "coupon",
                "name": "Example Name",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ],
            "fixDiscounts": [
              {
                "_id": "507f191e810c19729de860ea",
                "type": "fix",
                "discountId": "507f191e810c19729de860ea",
                "category": "coupon",
                "name": "Example Name",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ]
          }
        ],
        "discounts": [
          {
            "_id": "507f191e810c19729de860ea",
            "type": "fix",
            "discountId": "507f191e810c19729de860ea",
            "category": "coupon",
            "name": "Example Name",
            "value": 10.5,
            "allowedItems": [
              "string"
            ],
            "maxItemsInCart": 10.5,
            "maxAbsoluteValue": 10.5,
            "absoluteDiscountValue": 10.5
          }
        ]
      },
      "innerFeeComponents": {
        "_id": "507f191e810c19729de860ea",
        "fix": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ],
        "var": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ]
      },
      "innerCharge": 10.5,
      "outerFeeComponents": {
        "_id": "507f191e810c19729de860ea",
        "fix": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ],
        "var": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ]
      },
      "tickets": [
        {
          "amount": 1,
          "price": 10.5,
          "ticketTypeId": "507f191e810c19729de860ea",
          "type": "ticket",
          "_id": "507f191e810c19729de860ea",
          "name": "Example Name",
          "netPrice": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "507f191e810c19729de860ea",
            "componentId": "507f191e810c19729de860ea",
            "optionId": "507f191e810c19729de860ea"
          },
          "categoryRef": "string",
          "seatingInfo": {
            "_type": 6,
            "statusId": "507f191e810c19729de860ea",
            "_id": "507f191e810c19729de860ea",
            "categoryId": "507f191e810c19729de860ea",
            "name": "Example Name",
            "seatType": "handicapped",
            "sectionName": "string",
            "groupName": "string",
            "rowName": "string",
            "seatName": "string",
            "gate": "string"
          },
          "slotInfo": {
            "slotId": "507f191e810c19729de860ea",
            "slotStartTime": "2030-01-23T23:00:00.123Z"
          },
          "asHardTicket": true,
          "listingId": "507f191e810c19729de860ea",
          "listingItemId": "507f191e810c19729de860ea",
          "triggeredAutomations": true,
          "meta": {},
          "addOns": [
            {
              "productId": "507f191e810c19729de860ea",
              "productVariantId": "507f191e810c19729de860ea",
              "name": "Example Name"
            }
          ],
          "capabilities": [
            {
              "type": "self_service_return",
              "settings": {
                "phases": [
                  {
                    "condition": {
                      "unit": "hours",
                      "offset": 1,
                      "target": "string"
                    },
                    "refundPercentage": 10.5
                  }
                ],
                "returnRelatedItems": true
              }
            }
          ],
          "taxInfo": {
            "serviceTypeId": "507f191e810c19729de860ea",
            "exceptionId": "507f191e810c19729de860ea",
            "proceedsAccountId": "507f191e810c19729de860ea",
            "proceedsAccountCode": "string",
            "taxItems": [
              {
                "rate": 10.5,
                "perUnit": 10.5,
                "total": 10.5,
                "name": "Example Name",
                "taxTypeId": "507f191e810c19729de860ea",
                "netTotal": 10.5,
                "netPerUnit": 10.5,
                "taxPayableAccountId": "507f191e810c19729de860ea",
                "taxPayableAccountCode": "string"
              }
            ]
          }
        }
      ],
      "products": [
        {
          "type": "product",
          "amount": 1,
          "price": 10.5,
          "productVariantId": "507f191e810c19729de860ea",
          "_id": "507f191e810c19729de860ea",
          "name": "Example Name",
          "netPrice": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "507f191e810c19729de860ea",
            "componentId": "507f191e810c19729de860ea",
            "optionId": "507f191e810c19729de860ea"
          },
          "isFulfillable": true,
          "taxInfo": {
            "serviceTypeId": "507f191e810c19729de860ea",
            "exceptionId": "507f191e810c19729de860ea",
            "proceedsAccountId": "507f191e810c19729de860ea",
            "proceedsAccountCode": "string",
            "taxItems": [
              {
                "rate": 10.5,
                "perUnit": 10.5,
                "total": 10.5,
                "name": "Example Name",
                "taxTypeId": "507f191e810c19729de860ea",
                "netTotal": 10.5,
                "netPerUnit": 10.5,
                "taxPayableAccountId": "507f191e810c19729de860ea",
                "taxPayableAccountCode": "string"
              }
            ]
          }
        }
      ],
      "additionalItems": [],
      "seatingReservationToken": "string",
      "subscriptionId": "507f191e810c19729de860ea"
    }
  ],
  "realPrice": 10.5,
  "company": "string",
  "firstname": "string",
  "lastname": "string",
  "name": "Example Name",
  "email": "example@vivenu.com",
  "phone": "string",
  "customerId": "507f191e810c19729de860ea",
  "address": {
    "fullAddress": "string",
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string"
  },
  "deliveryAddress": {
    "fullAddress": "string",
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "Example Name"
  },
  "identification": [],
  "currency": "EUR",
  "redeemedVouchers": {
    "totalRedeemedAmount": 10.5,
    "vouchers": [
      {
        "code": "string",
        "redeemedAmount": 10.5,
        "_id": "507f191e810c19729de860ea"
      }
    ]
  },
  "preferredLanguage": "de",
  "origin": "yourticket",
  "channel": "online",
  "salesChannelId": "507f191e810c19729de860ea",
  "posId": "507f191e810c19729de860ea",
  "userId": "507f191e810c19729de860ea",
  "extraFields": {},
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}
GET/api/checkouts

Get all checkouts

Get all checkouts

Query parameters

Optional query parameters

  • Name
    status
    Type
    array<enum(NEW, ABORTED, COMPLETE)>
    Description
  • Name
    name
    Type
    string
    Description
  • Name
    email
    Type
    string
    Description
  • Name
    type
    Type
    array<enum(transaction, upgrade, rebooking, purchaseintent, subscription)>
    Description
  • Name
    customerId
    Type
    string
    Description
  • Name
    channel
    Type
    array<oneOf>
    Description
  • Name
    createdAt
    Type
    object
    Description
  • Name
    updatedAt
    Type
    object
    Description
  • Name
    top
    Type
    integer
    Description
  • Name
    skip
    Type
    integer
    Description

Request

GET
/api/checkouts
const response = await fetch('https://vivenu.com/api/checkouts?status=value1%2Cvalue2&name=Example+Name&email=example%40vivenu.com&type=value1%2Cvalue2&customerId=507f191e810c19729de860ea&channel=value1%2Cvalue2&createdAt=value&updatedAt=2030-01-23T23%3A00%3A00.123Z&top=1&skip=1', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer {token}',
  },
})

const data = await response.json()

Response (200)

{
  "docs": [],
  "total": 1
}
PUTPUBLIC/api/checkout/:id

Update a checkout

Update a checkout

Payload

Required attributes

  • Name
    secret
    Type
    string
    Description

    The secret token of the checkout

Optional attributes

  • Name
    vouchers
    Type
    array<string>
    Description

    An array of vouchers to be redeemed

Request

PUT
/api/checkout/:id
const response = await fetch('https://vivenu.com/api/checkout/507f191e810c19729de860ea', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer {token}',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(  {
    "secret": "string",
    "vouchers": [
      "string"
    ]
  }),
})

const data = await response.json()

Response (200)

{
  "_id": "507f191e810c19729de860ea",
  "secret": "string",
  "status": "NEW",
  "type": "transaction",
  "sellerId": "507f191e810c19729de860ea",
  "items": [
    {
      "_id": "507f191e810c19729de860ea",
      "eventId": "507f191e810c19729de860ea",
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "outerCharge": 10.5,
      "shopId": "507f191e810c19729de860ea",
      "channelId": "507f191e810c19729de860ea",
      "redeemedVouchers": {
        "totalRedeemedAmount": 10.5,
        "vouchers": [
          {
            "code": "string",
            "redeemedAmount": 10.5,
            "_id": "507f191e810c19729de860ea"
          }
        ]
      },
      "appliedCoupons": [
        {
          "_id": "507f191e810c19729de860ea",
          "code": "string"
        }
      ],
      "appliedDiscountInfo": {
        "items": [
          {
            "_id": "507f191e810c19729de860ea",
            "itemId": "507f191e810c19729de860ea",
            "amount": 10.5,
            "regularPrice": 10.5,
            "price": 10.5,
            "varDiscounts": [
              {
                "_id": "507f191e810c19729de860ea",
                "type": "fix",
                "discountId": "507f191e810c19729de860ea",
                "category": "coupon",
                "name": "Example Name",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ],
            "fixDiscounts": [
              {
                "_id": "507f191e810c19729de860ea",
                "type": "fix",
                "discountId": "507f191e810c19729de860ea",
                "category": "coupon",
                "name": "Example Name",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ]
          }
        ],
        "discounts": [
          {
            "_id": "507f191e810c19729de860ea",
            "type": "fix",
            "discountId": "507f191e810c19729de860ea",
            "category": "coupon",
            "name": "Example Name",
            "value": 10.5,
            "allowedItems": [
              "string"
            ],
            "maxItemsInCart": 10.5,
            "maxAbsoluteValue": 10.5,
            "absoluteDiscountValue": 10.5
          }
        ]
      },
      "innerFeeComponents": {
        "_id": "507f191e810c19729de860ea",
        "fix": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ],
        "var": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ]
      },
      "innerCharge": 10.5,
      "outerFeeComponents": {
        "_id": "507f191e810c19729de860ea",
        "fix": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ],
        "var": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ]
      },
      "tickets": [
        {
          "amount": 1,
          "price": 10.5,
          "ticketTypeId": "507f191e810c19729de860ea",
          "type": "ticket",
          "_id": "507f191e810c19729de860ea",
          "name": "Example Name",
          "netPrice": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "507f191e810c19729de860ea",
            "componentId": "507f191e810c19729de860ea",
            "optionId": "507f191e810c19729de860ea"
          },
          "categoryRef": "string",
          "seatingInfo": {
            "_type": 6,
            "statusId": "507f191e810c19729de860ea",
            "_id": "507f191e810c19729de860ea",
            "categoryId": "507f191e810c19729de860ea",
            "name": "Example Name",
            "seatType": "handicapped",
            "sectionName": "string",
            "groupName": "string",
            "rowName": "string",
            "seatName": "string",
            "gate": "string"
          },
          "slotInfo": {
            "slotId": "507f191e810c19729de860ea",
            "slotStartTime": "2030-01-23T23:00:00.123Z"
          },
          "asHardTicket": true,
          "listingId": "507f191e810c19729de860ea",
          "listingItemId": "507f191e810c19729de860ea",
          "triggeredAutomations": true,
          "meta": {},
          "addOns": [
            {
              "productId": "507f191e810c19729de860ea",
              "productVariantId": "507f191e810c19729de860ea",
              "name": "Example Name"
            }
          ],
          "capabilities": [
            {
              "type": "self_service_return",
              "settings": {
                "phases": [
                  {
                    "condition": {
                      "unit": "hours",
                      "offset": 1,
                      "target": "string"
                    },
                    "refundPercentage": 10.5
                  }
                ],
                "returnRelatedItems": true
              }
            }
          ],
          "taxInfo": {
            "serviceTypeId": "507f191e810c19729de860ea",
            "exceptionId": "507f191e810c19729de860ea",
            "proceedsAccountId": "507f191e810c19729de860ea",
            "proceedsAccountCode": "string",
            "taxItems": [
              {
                "rate": 10.5,
                "perUnit": 10.5,
                "total": 10.5,
                "name": "Example Name",
                "taxTypeId": "507f191e810c19729de860ea",
                "netTotal": 10.5,
                "netPerUnit": 10.5,
                "taxPayableAccountId": "507f191e810c19729de860ea",
                "taxPayableAccountCode": "string"
              }
            ]
          }
        }
      ],
      "products": [
        {
          "type": "product",
          "amount": 1,
          "price": 10.5,
          "productVariantId": "507f191e810c19729de860ea",
          "_id": "507f191e810c19729de860ea",
          "name": "Example Name",
          "netPrice": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "507f191e810c19729de860ea",
            "componentId": "507f191e810c19729de860ea",
            "optionId": "507f191e810c19729de860ea"
          },
          "isFulfillable": true,
          "taxInfo": {
            "serviceTypeId": "507f191e810c19729de860ea",
            "exceptionId": "507f191e810c19729de860ea",
            "proceedsAccountId": "507f191e810c19729de860ea",
            "proceedsAccountCode": "string",
            "taxItems": [
              {
                "rate": 10.5,
                "perUnit": 10.5,
                "total": 10.5,
                "name": "Example Name",
                "taxTypeId": "507f191e810c19729de860ea",
                "netTotal": 10.5,
                "netPerUnit": 10.5,
                "taxPayableAccountId": "507f191e810c19729de860ea",
                "taxPayableAccountCode": "string"
              }
            ]
          }
        }
      ],
      "additionalItems": [],
      "seatingReservationToken": "string",
      "subscriptionId": "507f191e810c19729de860ea"
    }
  ],
  "realPrice": 10.5,
  "company": "string",
  "firstname": "string",
  "lastname": "string",
  "name": "Example Name",
  "email": "example@vivenu.com",
  "phone": "string",
  "customerId": "507f191e810c19729de860ea",
  "address": {
    "fullAddress": "string",
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string"
  },
  "deliveryAddress": {
    "fullAddress": "string",
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "Example Name"
  },
  "identification": [],
  "currency": "EUR",
  "redeemedVouchers": {
    "totalRedeemedAmount": 10.5,
    "vouchers": [
      {
        "code": "string",
        "redeemedAmount": 10.5,
        "_id": "507f191e810c19729de860ea"
      }
    ]
  },
  "preferredLanguage": "de",
  "origin": "yourticket",
  "channel": "online",
  "salesChannelId": "507f191e810c19729de860ea",
  "posId": "507f191e810c19729de860ea",
  "userId": "507f191e810c19729de860ea",
  "extraFields": {},
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}
GETPUBLIC/api/checkout/:id/detailsform

Get details form

Get details form

Query parameters

Required query parameters

  • Name
    secret
    Type
    string
    Description

Optional query parameters

  • Name
    locale
    Type
    string
    Description

Request

GET
/api/checkout/:id/detailsform
const response = await fetch('https://vivenu.com/api/checkout/507f191e810c19729de860ea/detailsform?secret=value&locale=value', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer {token}',
  },
})

const data = await response.json()

Response (200)

{
  "skipAddressInfo": true,
  "extraFields": [
    {
      "name": "Example Name",
      "description": "string",
      "required": true,
      "deleted": true,
      "onlyForCertainTicketsTypes": true,
      "allowedTicketTypes": [
        "string"
      ],
      "printable": true,
      "applyToCustomer": true
    }
  ],
  "enforceCompany": true,
  "ticketExtraFields": {},
  "enforceAddress": true,
  "identificationConfig": [
    [
      {
        "type": "spain_tax_id",
        "requireAddress": true,
        "identificationThreshold": 10.5
      }
    ]
  ]
}
POSTPUBLIC/api/checkout/:id/details

Post checkout details

Post checkout details

Payload

Required attributes

  • Name
    secret
    Type
    string
    Description

    The secret token of the checkout

  • Name
    prename
    Type
    string
    Description

    The first name for this checkout

  • Name
    lastname
    Type
    string
    Description

    The last name for this checkout

  • Name
    email
    Type
    string
    Description

    The email for this checkout

  • Name
    emailRepeat
    Type
    string
    Description

Optional attributes

  • Name
    company
    Type
    string
    Description

    The company name for this checkout

  • Name
    street
    Type
    string
    Description
  • Name
    postal
    Type
    string
    Description
  • Name
    city
    Type
    string
    Description
  • Name
    country
    Type
    string
    Description
  • Name
    state
    Type
    string
    Description
  • Name
    deliveryAddress
    Type
    object
    Description
    Optional nested attributes (8)
    • Name
      fullAddress
      Type
      string
      Description

      Optional full address

    • Name
      street
      Type
      string
      Description

      The street of the address. Street name including number.

    • Name
      line2
      Type
      string
      Description

      The additional field of the address.

    • Name
      postal
      Type
      string
      Description

      The postal code of the address.

    • Name
      city
      Type
      string
      Description

      The city of the address.

    • Name
      country
      Type
      string
      Description

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

    • Name
      state
      Type
      string
      Description

      The state of the address. If applicable

    • Name
      name
      Type
      string
      Description

      The name of the person receiving delivery.

  • Name
    phone
    Type
    string
    Description

    The phone number for this checkout

  • Name
    password
    Type
    string
    Description

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

  • Name
    passwordRepeat
    Type
    string
    Description

    deprecated, unused

  • Name
    createAccount
    Type
    boolean
    Description

    Whether to create an account with the provided data

  • Name
    extraFields
    Type
    object
    Description
  • Name
    fulfillmentTypes
    Type
    array<object>
    Description

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

    Required nested attributes (3)
    • Name
      type
      Type
      enum(fulfillmentType)
      Description

      The type of the cart item.

    • Name
      amount
      Type
      integer
      Description

      The amount of the cart item.

    • Name
      price
      Type
      number
      Description

      The single piece price of the cart item.

    Optional nested attributes (7)
    • Name
      _id
      Type
      string
      Description

      Unique identifier for the cart item. If omitted, the system will automatically generate one.

    • Name
      name
      Type
      string
      Description

      The name of the cart item.

    • Name
      netPrice
      Type
      number
      Description

      The single piece net price of the cart item.

    • Name
      taxRate
      Type
      number
      Description

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

    • Name
      triggeredBy
      Type
      oneOf
      Description

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

    • Name
      bundleInfo
      Type
      object
      Description
      Optional nested attributes (3)
      • Name
        bundleId
        Type
        string
        Description
      • Name
        componentId
        Type
        string
        Description
      • Name
        optionId
        Type
        string
        Description
    • Name
      data
      Type
      object
      Description
      Required nested attributes (1)
      • Name
        fulfillmentTypeId
        Type
        string
        Description

        The ID of the fulfillment type.

      Optional nested attributes (2)
      • Name
        cartItemIds
        Type
        array<string>
        Description

        The array of the related cart items IDs.

      • Name
        discountable
        Type
        boolean
        Description

        Whether the fulfillment type is discountable.

  • Name
    itemConsents
    Type
    object
    Description

    A map of item IDs and their lists of consents

  • Name
    consents
    Type
    array<object>
    Description
    Required nested attributes (2)
    • Name
      consentId
      Type
      string
      Description
    • Name
      status
      Type
      enum(granted, denied)
      Description
  • Name
    identification
    Type
    array<object>
    Description

    An array of identification items

Request

POST
/api/checkout/:id/details
const response = await fetch('https://vivenu.com/api/checkout/507f191e810c19729de860ea/details', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer {token}',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(  {
    "secret": "string",
    "prename": "string",
    "lastname": "string",
    "email": "example@vivenu.com",
    "emailRepeat": "example@vivenu.com",
    "company": "string",
    "street": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "deliveryAddress": {
      "fullAddress": "string",
      "street": "string",
      "line2": "string",
      "postal": "string",
      "city": "string",
      "country": "string",
      "state": "string",
      "name": "Example Name"
    },
    "phone": "string",
    "password": "string",
    "passwordRepeat": "string",
    "createAccount": true,
    "extraFields": {},
    "fulfillmentTypes": [
      {
        "type": "fulfillmentType",
        "amount": 1,
        "price": 10.5,
        "_id": "507f191e810c19729de860ea",
        "name": "Example Name",
        "netPrice": 10.5,
        "taxRate": 10.5,
        "triggeredBy": "string",
        "bundleInfo": {
          "bundleId": "507f191e810c19729de860ea",
          "componentId": "507f191e810c19729de860ea",
          "optionId": "507f191e810c19729de860ea"
        },
        "data": {
          "fulfillmentTypeId": "507f191e810c19729de860ea",
          "cartItemIds": [
            "string"
          ],
          "discountable": true
        }
      }
    ],
    "itemConsents": {},
    "consents": [
      {
        "consentId": "507f191e810c19729de860ea",
        "status": "granted"
      }
    ],
    "identification": []
  }),
})

const data = await response.json()

Response (200)

{
  "_id": "507f191e810c19729de860ea",
  "secret": "string",
  "status": "NEW",
  "type": "transaction",
  "sellerId": "507f191e810c19729de860ea",
  "items": [
    {
      "_id": "507f191e810c19729de860ea",
      "eventId": "507f191e810c19729de860ea",
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "outerCharge": 10.5,
      "shopId": "507f191e810c19729de860ea",
      "channelId": "507f191e810c19729de860ea",
      "redeemedVouchers": {
        "totalRedeemedAmount": 10.5,
        "vouchers": [
          {
            "code": "string",
            "redeemedAmount": 10.5,
            "_id": "507f191e810c19729de860ea"
          }
        ]
      },
      "appliedCoupons": [
        {
          "_id": "507f191e810c19729de860ea",
          "code": "string"
        }
      ],
      "appliedDiscountInfo": {
        "items": [
          {
            "_id": "507f191e810c19729de860ea",
            "itemId": "507f191e810c19729de860ea",
            "amount": 10.5,
            "regularPrice": 10.5,
            "price": 10.5,
            "varDiscounts": [
              {
                "_id": "507f191e810c19729de860ea",
                "type": "fix",
                "discountId": "507f191e810c19729de860ea",
                "category": "coupon",
                "name": "Example Name",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ],
            "fixDiscounts": [
              {
                "_id": "507f191e810c19729de860ea",
                "type": "fix",
                "discountId": "507f191e810c19729de860ea",
                "category": "coupon",
                "name": "Example Name",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ]
          }
        ],
        "discounts": [
          {
            "_id": "507f191e810c19729de860ea",
            "type": "fix",
            "discountId": "507f191e810c19729de860ea",
            "category": "coupon",
            "name": "Example Name",
            "value": 10.5,
            "allowedItems": [
              "string"
            ],
            "maxItemsInCart": 10.5,
            "maxAbsoluteValue": 10.5,
            "absoluteDiscountValue": 10.5
          }
        ]
      },
      "innerFeeComponents": {
        "_id": "507f191e810c19729de860ea",
        "fix": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ],
        "var": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ]
      },
      "innerCharge": 10.5,
      "outerFeeComponents": {
        "_id": "507f191e810c19729de860ea",
        "fix": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ],
        "var": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ]
      },
      "tickets": [
        {
          "amount": 1,
          "price": 10.5,
          "ticketTypeId": "507f191e810c19729de860ea",
          "type": "ticket",
          "_id": "507f191e810c19729de860ea",
          "name": "Example Name",
          "netPrice": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "507f191e810c19729de860ea",
            "componentId": "507f191e810c19729de860ea",
            "optionId": "507f191e810c19729de860ea"
          },
          "categoryRef": "string",
          "seatingInfo": {
            "_type": 6,
            "statusId": "507f191e810c19729de860ea",
            "_id": "507f191e810c19729de860ea",
            "categoryId": "507f191e810c19729de860ea",
            "name": "Example Name",
            "seatType": "handicapped",
            "sectionName": "string",
            "groupName": "string",
            "rowName": "string",
            "seatName": "string",
            "gate": "string"
          },
          "slotInfo": {
            "slotId": "507f191e810c19729de860ea",
            "slotStartTime": "2030-01-23T23:00:00.123Z"
          },
          "asHardTicket": true,
          "listingId": "507f191e810c19729de860ea",
          "listingItemId": "507f191e810c19729de860ea",
          "triggeredAutomations": true,
          "meta": {},
          "addOns": [
            {
              "productId": "507f191e810c19729de860ea",
              "productVariantId": "507f191e810c19729de860ea",
              "name": "Example Name"
            }
          ],
          "capabilities": [
            {
              "type": "self_service_return",
              "settings": {
                "phases": [
                  {
                    "condition": {
                      "unit": "hours",
                      "offset": 1,
                      "target": "string"
                    },
                    "refundPercentage": 10.5
                  }
                ],
                "returnRelatedItems": true
              }
            }
          ],
          "taxInfo": {
            "serviceTypeId": "507f191e810c19729de860ea",
            "exceptionId": "507f191e810c19729de860ea",
            "proceedsAccountId": "507f191e810c19729de860ea",
            "proceedsAccountCode": "string",
            "taxItems": [
              {
                "rate": 10.5,
                "perUnit": 10.5,
                "total": 10.5,
                "name": "Example Name",
                "taxTypeId": "507f191e810c19729de860ea",
                "netTotal": 10.5,
                "netPerUnit": 10.5,
                "taxPayableAccountId": "507f191e810c19729de860ea",
                "taxPayableAccountCode": "string"
              }
            ]
          }
        }
      ],
      "products": [
        {
          "type": "product",
          "amount": 1,
          "price": 10.5,
          "productVariantId": "507f191e810c19729de860ea",
          "_id": "507f191e810c19729de860ea",
          "name": "Example Name",
          "netPrice": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "507f191e810c19729de860ea",
            "componentId": "507f191e810c19729de860ea",
            "optionId": "507f191e810c19729de860ea"
          },
          "isFulfillable": true,
          "taxInfo": {
            "serviceTypeId": "507f191e810c19729de860ea",
            "exceptionId": "507f191e810c19729de860ea",
            "proceedsAccountId": "507f191e810c19729de860ea",
            "proceedsAccountCode": "string",
            "taxItems": [
              {
                "rate": 10.5,
                "perUnit": 10.5,
                "total": 10.5,
                "name": "Example Name",
                "taxTypeId": "507f191e810c19729de860ea",
                "netTotal": 10.5,
                "netPerUnit": 10.5,
                "taxPayableAccountId": "507f191e810c19729de860ea",
                "taxPayableAccountCode": "string"
              }
            ]
          }
        }
      ],
      "additionalItems": [],
      "seatingReservationToken": "string",
      "subscriptionId": "507f191e810c19729de860ea"
    }
  ],
  "realPrice": 10.5,
  "company": "string",
  "firstname": "string",
  "lastname": "string",
  "name": "Example Name",
  "email": "example@vivenu.com",
  "phone": "string",
  "customerId": "507f191e810c19729de860ea",
  "address": {
    "fullAddress": "string",
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string"
  },
  "deliveryAddress": {
    "fullAddress": "string",
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "Example Name"
  },
  "identification": [],
  "currency": "EUR",
  "redeemedVouchers": {
    "totalRedeemedAmount": 10.5,
    "vouchers": [
      {
        "code": "string",
        "redeemedAmount": 10.5,
        "_id": "507f191e810c19729de860ea"
      }
    ]
  },
  "preferredLanguage": "de",
  "origin": "yourticket",
  "channel": "online",
  "salesChannelId": "507f191e810c19729de860ea",
  "posId": "507f191e810c19729de860ea",
  "userId": "507f191e810c19729de860ea",
  "extraFields": {},
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}
POSTPUBLIC/api/checkout/:id/reserve

Reserve a checkout

Reserve a checkout

Fulfills a checkout of type purchaseintent.

Payload

Required attributes

  • Name
    secret
    Type
    string
    Description

    The secret token of the checkout

Request

POST
/api/checkout/:id/reserve
const response = await fetch('https://vivenu.com/api/checkout/507f191e810c19729de860ea/reserve', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer {token}',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(  {
    "secret": "string"
  }),
})

const data = await response.json()

Response (200)

{
  "_id": "507f191e810c19729de860ea",
  "secret": "string",
  "status": "NEW",
  "type": "transaction",
  "sellerId": "507f191e810c19729de860ea",
  "items": [
    {
      "_id": "507f191e810c19729de860ea",
      "eventId": "507f191e810c19729de860ea",
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "outerCharge": 10.5,
      "shopId": "507f191e810c19729de860ea",
      "channelId": "507f191e810c19729de860ea",
      "redeemedVouchers": {
        "totalRedeemedAmount": 10.5,
        "vouchers": [
          {
            "code": "string",
            "redeemedAmount": 10.5,
            "_id": "507f191e810c19729de860ea"
          }
        ]
      },
      "appliedCoupons": [
        {
          "_id": "507f191e810c19729de860ea",
          "code": "string"
        }
      ],
      "appliedDiscountInfo": {
        "items": [
          {
            "_id": "507f191e810c19729de860ea",
            "itemId": "507f191e810c19729de860ea",
            "amount": 10.5,
            "regularPrice": 10.5,
            "price": 10.5,
            "varDiscounts": [
              {
                "_id": "507f191e810c19729de860ea",
                "type": "fix",
                "discountId": "507f191e810c19729de860ea",
                "category": "coupon",
                "name": "Example Name",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ],
            "fixDiscounts": [
              {
                "_id": "507f191e810c19729de860ea",
                "type": "fix",
                "discountId": "507f191e810c19729de860ea",
                "category": "coupon",
                "name": "Example Name",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ]
          }
        ],
        "discounts": [
          {
            "_id": "507f191e810c19729de860ea",
            "type": "fix",
            "discountId": "507f191e810c19729de860ea",
            "category": "coupon",
            "name": "Example Name",
            "value": 10.5,
            "allowedItems": [
              "string"
            ],
            "maxItemsInCart": 10.5,
            "maxAbsoluteValue": 10.5,
            "absoluteDiscountValue": 10.5
          }
        ]
      },
      "innerFeeComponents": {
        "_id": "507f191e810c19729de860ea",
        "fix": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ],
        "var": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ]
      },
      "innerCharge": 10.5,
      "outerFeeComponents": {
        "_id": "507f191e810c19729de860ea",
        "fix": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ],
        "var": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ]
      },
      "tickets": [
        {
          "amount": 1,
          "price": 10.5,
          "ticketTypeId": "507f191e810c19729de860ea",
          "type": "ticket",
          "_id": "507f191e810c19729de860ea",
          "name": "Example Name",
          "netPrice": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "507f191e810c19729de860ea",
            "componentId": "507f191e810c19729de860ea",
            "optionId": "507f191e810c19729de860ea"
          },
          "categoryRef": "string",
          "seatingInfo": {
            "_type": 6,
            "statusId": "507f191e810c19729de860ea",
            "_id": "507f191e810c19729de860ea",
            "categoryId": "507f191e810c19729de860ea",
            "name": "Example Name",
            "seatType": "handicapped",
            "sectionName": "string",
            "groupName": "string",
            "rowName": "string",
            "seatName": "string",
            "gate": "string"
          },
          "slotInfo": {
            "slotId": "507f191e810c19729de860ea",
            "slotStartTime": "2030-01-23T23:00:00.123Z"
          },
          "asHardTicket": true,
          "listingId": "507f191e810c19729de860ea",
          "listingItemId": "507f191e810c19729de860ea",
          "triggeredAutomations": true,
          "meta": {},
          "addOns": [
            {
              "productId": "507f191e810c19729de860ea",
              "productVariantId": "507f191e810c19729de860ea",
              "name": "Example Name"
            }
          ],
          "capabilities": [
            {
              "type": "self_service_return",
              "settings": {
                "phases": [
                  {
                    "condition": {
                      "unit": "hours",
                      "offset": 1,
                      "target": "string"
                    },
                    "refundPercentage": 10.5
                  }
                ],
                "returnRelatedItems": true
              }
            }
          ],
          "taxInfo": {
            "serviceTypeId": "507f191e810c19729de860ea",
            "exceptionId": "507f191e810c19729de860ea",
            "proceedsAccountId": "507f191e810c19729de860ea",
            "proceedsAccountCode": "string",
            "taxItems": [
              {
                "rate": 10.5,
                "perUnit": 10.5,
                "total": 10.5,
                "name": "Example Name",
                "taxTypeId": "507f191e810c19729de860ea",
                "netTotal": 10.5,
                "netPerUnit": 10.5,
                "taxPayableAccountId": "507f191e810c19729de860ea",
                "taxPayableAccountCode": "string"
              }
            ]
          }
        }
      ],
      "products": [
        {
          "type": "product",
          "amount": 1,
          "price": 10.5,
          "productVariantId": "507f191e810c19729de860ea",
          "_id": "507f191e810c19729de860ea",
          "name": "Example Name",
          "netPrice": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "507f191e810c19729de860ea",
            "componentId": "507f191e810c19729de860ea",
            "optionId": "507f191e810c19729de860ea"
          },
          "isFulfillable": true,
          "taxInfo": {
            "serviceTypeId": "507f191e810c19729de860ea",
            "exceptionId": "507f191e810c19729de860ea",
            "proceedsAccountId": "507f191e810c19729de860ea",
            "proceedsAccountCode": "string",
            "taxItems": [
              {
                "rate": 10.5,
                "perUnit": 10.5,
                "total": 10.5,
                "name": "Example Name",
                "taxTypeId": "507f191e810c19729de860ea",
                "netTotal": 10.5,
                "netPerUnit": 10.5,
                "taxPayableAccountId": "507f191e810c19729de860ea",
                "taxPayableAccountCode": "string"
              }
            ]
          }
        }
      ],
      "additionalItems": [],
      "seatingReservationToken": "string",
      "subscriptionId": "507f191e810c19729de860ea"
    }
  ],
  "realPrice": 10.5,
  "company": "string",
  "firstname": "string",
  "lastname": "string",
  "name": "Example Name",
  "email": "example@vivenu.com",
  "phone": "string",
  "customerId": "507f191e810c19729de860ea",
  "address": {
    "fullAddress": "string",
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string"
  },
  "deliveryAddress": {
    "fullAddress": "string",
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "Example Name"
  },
  "identification": [],
  "currency": "EUR",
  "redeemedVouchers": {
    "totalRedeemedAmount": 10.5,
    "vouchers": [
      {
        "code": "string",
        "redeemedAmount": 10.5,
        "_id": "507f191e810c19729de860ea"
      }
    ]
  },
  "preferredLanguage": "de",
  "origin": "yourticket",
  "channel": "online",
  "salesChannelId": "507f191e810c19729de860ea",
  "posId": "507f191e810c19729de860ea",
  "userId": "507f191e810c19729de860ea",
  "extraFields": {},
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}
POSTPUBLIC/api/checkout/:id/abort

Abort a checkout

Abort a checkout

Payload

Required attributes

  • Name
    secret
    Type
    string
    Description

    The secret token of the checkout

Request

POST
/api/checkout/:id/abort
const response = await fetch('https://vivenu.com/api/checkout/507f191e810c19729de860ea/abort', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer {token}',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(  {
    "secret": "string"
  }),
})

const data = await response.json()

Response (200)

{
  "_id": "507f191e810c19729de860ea",
  "secret": "string",
  "status": "NEW",
  "type": "transaction",
  "sellerId": "507f191e810c19729de860ea",
  "items": [
    {
      "_id": "507f191e810c19729de860ea",
      "eventId": "507f191e810c19729de860ea",
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "outerCharge": 10.5,
      "shopId": "507f191e810c19729de860ea",
      "channelId": "507f191e810c19729de860ea",
      "redeemedVouchers": {
        "totalRedeemedAmount": 10.5,
        "vouchers": [
          {
            "code": "string",
            "redeemedAmount": 10.5,
            "_id": "507f191e810c19729de860ea"
          }
        ]
      },
      "appliedCoupons": [
        {
          "_id": "507f191e810c19729de860ea",
          "code": "string"
        }
      ],
      "appliedDiscountInfo": {
        "items": [
          {
            "_id": "507f191e810c19729de860ea",
            "itemId": "507f191e810c19729de860ea",
            "amount": 10.5,
            "regularPrice": 10.5,
            "price": 10.5,
            "varDiscounts": [
              {
                "_id": "507f191e810c19729de860ea",
                "type": "fix",
                "discountId": "507f191e810c19729de860ea",
                "category": "coupon",
                "name": "Example Name",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ],
            "fixDiscounts": [
              {
                "_id": "507f191e810c19729de860ea",
                "type": "fix",
                "discountId": "507f191e810c19729de860ea",
                "category": "coupon",
                "name": "Example Name",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ]
          }
        ],
        "discounts": [
          {
            "_id": "507f191e810c19729de860ea",
            "type": "fix",
            "discountId": "507f191e810c19729de860ea",
            "category": "coupon",
            "name": "Example Name",
            "value": 10.5,
            "allowedItems": [
              "string"
            ],
            "maxItemsInCart": 10.5,
            "maxAbsoluteValue": 10.5,
            "absoluteDiscountValue": 10.5
          }
        ]
      },
      "innerFeeComponents": {
        "_id": "507f191e810c19729de860ea",
        "fix": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ],
        "var": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ]
      },
      "innerCharge": 10.5,
      "outerFeeComponents": {
        "_id": "507f191e810c19729de860ea",
        "fix": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ],
        "var": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ]
      },
      "tickets": [
        {
          "amount": 1,
          "price": 10.5,
          "ticketTypeId": "507f191e810c19729de860ea",
          "type": "ticket",
          "_id": "507f191e810c19729de860ea",
          "name": "Example Name",
          "netPrice": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "507f191e810c19729de860ea",
            "componentId": "507f191e810c19729de860ea",
            "optionId": "507f191e810c19729de860ea"
          },
          "categoryRef": "string",
          "seatingInfo": {
            "_type": 6,
            "statusId": "507f191e810c19729de860ea",
            "_id": "507f191e810c19729de860ea",
            "categoryId": "507f191e810c19729de860ea",
            "name": "Example Name",
            "seatType": "handicapped",
            "sectionName": "string",
            "groupName": "string",
            "rowName": "string",
            "seatName": "string",
            "gate": "string"
          },
          "slotInfo": {
            "slotId": "507f191e810c19729de860ea",
            "slotStartTime": "2030-01-23T23:00:00.123Z"
          },
          "asHardTicket": true,
          "listingId": "507f191e810c19729de860ea",
          "listingItemId": "507f191e810c19729de860ea",
          "triggeredAutomations": true,
          "meta": {},
          "addOns": [
            {
              "productId": "507f191e810c19729de860ea",
              "productVariantId": "507f191e810c19729de860ea",
              "name": "Example Name"
            }
          ],
          "capabilities": [
            {
              "type": "self_service_return",
              "settings": {
                "phases": [
                  {
                    "condition": {
                      "unit": "hours",
                      "offset": 1,
                      "target": "string"
                    },
                    "refundPercentage": 10.5
                  }
                ],
                "returnRelatedItems": true
              }
            }
          ],
          "taxInfo": {
            "serviceTypeId": "507f191e810c19729de860ea",
            "exceptionId": "507f191e810c19729de860ea",
            "proceedsAccountId": "507f191e810c19729de860ea",
            "proceedsAccountCode": "string",
            "taxItems": [
              {
                "rate": 10.5,
                "perUnit": 10.5,
                "total": 10.5,
                "name": "Example Name",
                "taxTypeId": "507f191e810c19729de860ea",
                "netTotal": 10.5,
                "netPerUnit": 10.5,
                "taxPayableAccountId": "507f191e810c19729de860ea",
                "taxPayableAccountCode": "string"
              }
            ]
          }
        }
      ],
      "products": [
        {
          "type": "product",
          "amount": 1,
          "price": 10.5,
          "productVariantId": "507f191e810c19729de860ea",
          "_id": "507f191e810c19729de860ea",
          "name": "Example Name",
          "netPrice": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "507f191e810c19729de860ea",
            "componentId": "507f191e810c19729de860ea",
            "optionId": "507f191e810c19729de860ea"
          },
          "isFulfillable": true,
          "taxInfo": {
            "serviceTypeId": "507f191e810c19729de860ea",
            "exceptionId": "507f191e810c19729de860ea",
            "proceedsAccountId": "507f191e810c19729de860ea",
            "proceedsAccountCode": "string",
            "taxItems": [
              {
                "rate": 10.5,
                "perUnit": 10.5,
                "total": 10.5,
                "name": "Example Name",
                "taxTypeId": "507f191e810c19729de860ea",
                "netTotal": 10.5,
                "netPerUnit": 10.5,
                "taxPayableAccountId": "507f191e810c19729de860ea",
                "taxPayableAccountCode": "string"
              }
            ]
          }
        }
      ],
      "additionalItems": [],
      "seatingReservationToken": "string",
      "subscriptionId": "507f191e810c19729de860ea"
    }
  ],
  "realPrice": 10.5,
  "company": "string",
  "firstname": "string",
  "lastname": "string",
  "name": "Example Name",
  "email": "example@vivenu.com",
  "phone": "string",
  "customerId": "507f191e810c19729de860ea",
  "address": {
    "fullAddress": "string",
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string"
  },
  "deliveryAddress": {
    "fullAddress": "string",
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "Example Name"
  },
  "identification": [],
  "currency": "EUR",
  "redeemedVouchers": {
    "totalRedeemedAmount": 10.5,
    "vouchers": [
      {
        "code": "string",
        "redeemedAmount": 10.5,
        "_id": "507f191e810c19729de860ea"
      }
    ]
  },
  "preferredLanguage": "de",
  "origin": "yourticket",
  "channel": "online",
  "salesChannelId": "507f191e810c19729de860ea",
  "posId": "507f191e810c19729de860ea",
  "userId": "507f191e810c19729de860ea",
  "extraFields": {},
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}
GETPUBLIC/api/checkout/:id/tickets

Get all tickets for a checkout

Get all tickets for a checkout

Query parameters

Required query parameters

  • Name
    secret
    Type
    string
    Description

Request

GET
/api/checkout/:id/tickets
const response = await fetch('https://vivenu.com/api/checkout/507f191e810c19729de860ea/tickets?secret=value', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer {token}',
  },
})

const data = await response.json()

Response (200)

{
  "tickets": [
    {
      "sellerId": "507f191e810c19729de860ea",
      "eventId": "507f191e810c19729de860ea",
      "ticketTypeId": "507f191e810c19729de860ea",
      "ticketName": "string",
      "createdAt": "2030-01-23T23:00:00.123Z",
      "updatedAt": "2030-01-23T23:00:00.123Z",
      "status": "VALID",
      "secret": "string",
      "barcode": "string",
      "name": "Example Name",
      "firstname": "string",
      "lastname": "string",
      "email": "example@vivenu.com",
      "street": "string",
      "line2": "string",
      "city": "string",
      "postal": "string",
      "state": "string",
      "country": "string",
      "categoryRef": "string",
      "categoryName": "string",
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "completed": true,
      "seat": "string",
      "seatingInfo": {
        "_type": 6,
        "statusId": "507f191e810c19729de860ea",
        "_id": "507f191e810c19729de860ea",
        "categoryId": "507f191e810c19729de860ea",
        "name": "Example Name",
        "seatType": "handicapped",
        "sectionName": "string",
        "groupName": "string",
        "rowName": "string",
        "seatName": "string",
        "gate": "string"
      },
      "type": "SINGLE",
      "origin": "yourticket",
      "extraFields": {},
      "deliveryType": "HARD",
      "transactionId": "507f191e810c19729de860ea",
      "batchCounter": 10.5,
      "slotId": "507f191e810c19729de860ea",
      "slotStartTime": "2030-01-23T23:00:00.123Z",
      "personalized": true,
      "_locks": [
        {
          "by": "string",
          "at": "2030-01-23T23:00:00.123Z",
          "eventId": "507f191e810c19729de860ea",
          "type": "resell"
        }
      ],
      "barcodeRevealed": true,
      "barcodeRevealDate": "2030-01-23T23:00:00.123Z"
    }
  ]
}
POST/api/checkout/:id/internal

Complete an Internal Checkout

Complete an Internal Checkout

Reserves or completes a checkout and all corresponding transactions.

Payload

Required attributes

  • Name
    customerId
    Type
    string
    Description

    The ID of the customer

  • Name
    status
    Type
    enum(NEW, COMPLETE)
    Description

    The status of the checkout

Optional attributes

  • Name
    fulfillmentTypes
    Type
    array<object>
    Description
    Required nested attributes (3)
    • Name
      type
      Type
      enum(fulfillmentType)
      Description

      The type of the cart item.

    • Name
      amount
      Type
      integer
      Description

      The amount of the cart item.

    • Name
      price
      Type
      number
      Description

      The single piece price of the cart item.

    Optional nested attributes (7)
    • Name
      _id
      Type
      string
      Description

      Unique identifier for the cart item. If omitted, the system will automatically generate one.

    • Name
      name
      Type
      string
      Description

      The name of the cart item.

    • Name
      netPrice
      Type
      number
      Description

      The single piece net price of the cart item.

    • Name
      taxRate
      Type
      number
      Description

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

    • Name
      triggeredBy
      Type
      oneOf
      Description

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

    • Name
      bundleInfo
      Type
      object
      Description
      Optional nested attributes (3)
      • Name
        bundleId
        Type
        string
        Description
      • Name
        componentId
        Type
        string
        Description
      • Name
        optionId
        Type
        string
        Description
    • Name
      data
      Type
      object
      Description
      Required nested attributes (1)
      • Name
        fulfillmentTypeId
        Type
        string
        Description

        The ID of the fulfillment type.

      Optional nested attributes (2)
      • Name
        cartItemIds
        Type
        array<string>
        Description

        The array of the related cart items IDs.

      • Name
        discountable
        Type
        boolean
        Description

        Whether the fulfillment type is discountable.

  • Name
    paymentMethodId
    Type
    string
    Description

    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

  • Name
    customerPaymentMethodId
    Type
    string
    Description

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

  • Name
    sendMail
    Type
    boolean
    Description

    Whether to send checkout confirmation mail

  • Name
    sendTicketMail
    Type
    boolean
    Description

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

  • Name
    reference
    Type
    string
    Description

    The reference of the local payment

  • Name
    paymentStrategyId
    Type
    string
    Description

    The ID of the payment strategy

  • Name
    paymentOptionId
    Type
    string
    Description

    The ID of the payment option

  • Name
    extraFields
    Type
    object
    Description

    The extra fields of the checkout

  • Name
    identification
    Type
    array<object>
    Description

    An array of identification items

Request

POST
/api/checkout/:id/internal
const response = await fetch('https://vivenu.com/api/checkout/507f191e810c19729de860ea/internal', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer {token}',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(  {
    "customerId": "507f191e810c19729de860ea",
    "status": "NEW",
    "fulfillmentTypes": [
      {
        "type": "fulfillmentType",
        "amount": 1,
        "price": 10.5,
        "_id": "507f191e810c19729de860ea",
        "name": "Example Name",
        "netPrice": 10.5,
        "taxRate": 10.5,
        "triggeredBy": "string",
        "bundleInfo": {
          "bundleId": "507f191e810c19729de860ea",
          "componentId": "507f191e810c19729de860ea",
          "optionId": "507f191e810c19729de860ea"
        },
        "data": {
          "fulfillmentTypeId": "507f191e810c19729de860ea",
          "cartItemIds": [
            "string"
          ],
          "discountable": true
        }
      }
    ],
    "paymentMethodId": "507f191e810c19729de860ea",
    "customerPaymentMethodId": "507f191e810c19729de860ea",
    "sendMail": true,
    "sendTicketMail": true,
    "reference": "string",
    "paymentStrategyId": "507f191e810c19729de860ea",
    "paymentOptionId": "507f191e810c19729de860ea",
    "extraFields": {},
    "identification": []
  }),
})

const data = await response.json()

Response (200)

{
  "_id": "507f191e810c19729de860ea",
  "secret": "string",
  "status": "NEW",
  "type": "transaction",
  "sellerId": "507f191e810c19729de860ea",
  "items": [
    {
      "_id": "507f191e810c19729de860ea",
      "eventId": "507f191e810c19729de860ea",
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "outerCharge": 10.5,
      "shopId": "507f191e810c19729de860ea",
      "channelId": "507f191e810c19729de860ea",
      "redeemedVouchers": {
        "totalRedeemedAmount": 10.5,
        "vouchers": [
          {
            "code": "string",
            "redeemedAmount": 10.5,
            "_id": "507f191e810c19729de860ea"
          }
        ]
      },
      "appliedCoupons": [
        {
          "_id": "507f191e810c19729de860ea",
          "code": "string"
        }
      ],
      "appliedDiscountInfo": {
        "items": [
          {
            "_id": "507f191e810c19729de860ea",
            "itemId": "507f191e810c19729de860ea",
            "amount": 10.5,
            "regularPrice": 10.5,
            "price": 10.5,
            "varDiscounts": [
              {
                "_id": "507f191e810c19729de860ea",
                "type": "fix",
                "discountId": "507f191e810c19729de860ea",
                "category": "coupon",
                "name": "Example Name",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ],
            "fixDiscounts": [
              {
                "_id": "507f191e810c19729de860ea",
                "type": "fix",
                "discountId": "507f191e810c19729de860ea",
                "category": "coupon",
                "name": "Example Name",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ]
          }
        ],
        "discounts": [
          {
            "_id": "507f191e810c19729de860ea",
            "type": "fix",
            "discountId": "507f191e810c19729de860ea",
            "category": "coupon",
            "name": "Example Name",
            "value": 10.5,
            "allowedItems": [
              "string"
            ],
            "maxItemsInCart": 10.5,
            "maxAbsoluteValue": 10.5,
            "absoluteDiscountValue": 10.5
          }
        ]
      },
      "innerFeeComponents": {
        "_id": "507f191e810c19729de860ea",
        "fix": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ],
        "var": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ]
      },
      "innerCharge": 10.5,
      "outerFeeComponents": {
        "_id": "507f191e810c19729de860ea",
        "fix": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ],
        "var": [
          {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Example Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          }
        ]
      },
      "tickets": [
        {
          "amount": 1,
          "price": 10.5,
          "ticketTypeId": "507f191e810c19729de860ea",
          "type": "ticket",
          "_id": "507f191e810c19729de860ea",
          "name": "Example Name",
          "netPrice": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "507f191e810c19729de860ea",
            "componentId": "507f191e810c19729de860ea",
            "optionId": "507f191e810c19729de860ea"
          },
          "categoryRef": "string",
          "seatingInfo": {
            "_type": 6,
            "statusId": "507f191e810c19729de860ea",
            "_id": "507f191e810c19729de860ea",
            "categoryId": "507f191e810c19729de860ea",
            "name": "Example Name",
            "seatType": "handicapped",
            "sectionName": "string",
            "groupName": "string",
            "rowName": "string",
            "seatName": "string",
            "gate": "string"
          },
          "slotInfo": {
            "slotId": "507f191e810c19729de860ea",
            "slotStartTime": "2030-01-23T23:00:00.123Z"
          },
          "asHardTicket": true,
          "listingId": "507f191e810c19729de860ea",
          "listingItemId": "507f191e810c19729de860ea",
          "triggeredAutomations": true,
          "meta": {},
          "addOns": [
            {
              "productId": "507f191e810c19729de860ea",
              "productVariantId": "507f191e810c19729de860ea",
              "name": "Example Name"
            }
          ],
          "capabilities": [
            {
              "type": "self_service_return",
              "settings": {
                "phases": [
                  {
                    "condition": {
                      "unit": "hours",
                      "offset": 1,
                      "target": "string"
                    },
                    "refundPercentage": 10.5
                  }
                ],
                "returnRelatedItems": true
              }
            }
          ],
          "taxInfo": {
            "serviceTypeId": "507f191e810c19729de860ea",
            "exceptionId": "507f191e810c19729de860ea",
            "proceedsAccountId": "507f191e810c19729de860ea",
            "proceedsAccountCode": "string",
            "taxItems": [
              {
                "rate": 10.5,
                "perUnit": 10.5,
                "total": 10.5,
                "name": "Example Name",
                "taxTypeId": "507f191e810c19729de860ea",
                "netTotal": 10.5,
                "netPerUnit": 10.5,
                "taxPayableAccountId": "507f191e810c19729de860ea",
                "taxPayableAccountCode": "string"
              }
            ]
          }
        }
      ],
      "products": [
        {
          "type": "product",
          "amount": 1,
          "price": 10.5,
          "productVariantId": "507f191e810c19729de860ea",
          "_id": "507f191e810c19729de860ea",
          "name": "Example Name",
          "netPrice": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "507f191e810c19729de860ea",
            "componentId": "507f191e810c19729de860ea",
            "optionId": "507f191e810c19729de860ea"
          },
          "isFulfillable": true,
          "taxInfo": {
            "serviceTypeId": "507f191e810c19729de860ea",
            "exceptionId": "507f191e810c19729de860ea",
            "proceedsAccountId": "507f191e810c19729de860ea",
            "proceedsAccountCode": "string",
            "taxItems": [
              {
                "rate": 10.5,
                "perUnit": 10.5,
                "total": 10.5,
                "name": "Example Name",
                "taxTypeId": "507f191e810c19729de860ea",
                "netTotal": 10.5,
                "netPerUnit": 10.5,
                "taxPayableAccountId": "507f191e810c19729de860ea",
                "taxPayableAccountCode": "string"
              }
            ]
          }
        }
      ],
      "additionalItems": [],
      "seatingReservationToken": "string",
      "subscriptionId": "507f191e810c19729de860ea"
    }
  ],
  "realPrice": 10.5,
  "company": "string",
  "firstname": "string",
  "lastname": "string",
  "name": "Example Name",
  "email": "example@vivenu.com",
  "phone": "string",
  "customerId": "507f191e810c19729de860ea",
  "address": {
    "fullAddress": "string",
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string"
  },
  "deliveryAddress": {
    "fullAddress": "string",
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "Example Name"
  },
  "identification": [],
  "currency": "EUR",
  "redeemedVouchers": {
    "totalRedeemedAmount": 10.5,
    "vouchers": [
      {
        "code": "string",
        "redeemedAmount": 10.5,
        "_id": "507f191e810c19729de860ea"
      }
    ]
  },
  "preferredLanguage": "de",
  "origin": "yourticket",
  "channel": "online",
  "salesChannelId": "507f191e810c19729de860ea",
  "posId": "507f191e810c19729de860ea",
  "userId": "507f191e810c19729de860ea",
  "extraFields": {},
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Was this page helpful?