Purchase Intents

The Purchase Intent object

The associated purchase intent which has been cancelled

Required attributes

Name
_id
Type
string
Description
Name
status
Type
enum(new, complete, canceled)
Description
Name
approvalStatus
Type
enum(awaiting, approved, rejected)
Description
Name
sellerId
Type
string
Description
Name
eventId
Type
string
Description
Name
regularPrice
Type
number float
Description
Name
realPrice
Type
number float
Description
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, MWK)
Description
Name
innerCharge
Type
number float
Description
Name
outerCharge
Type
number float
Description
Name
tickets
Type
array<object>
Description
Required nested attributes (3)
Name
amount
Type
integer
Description
The amount of the cart item.
Name
price
Type
number float
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 float
Description
The single piece net price of the cart item.
Name
taxRate
Type
number float
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.
One of — Only one of the following types
An ID of another cart item 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) float
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.
One of — Only one of the following types
Required attributes
Name
type
Type
enum(self_service_return)
Description
Name
settings
Type
object
Description
Required nested attributes (1)
Name
phases
Type
array<object>
Description
Required nested attributes (2)
Name
condition
Type
object
Description
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
refundPercentage
Type
number float
Description
Optional nested attributes (1)
Name
returnRelatedItems
Type
boolean
Description
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 float
Description
Name
perUnit
Type
number float
Description
Name
total
Type
number float
Description
Optional nested attributes (6)
Name
name
Type
string
Description
Name
taxTypeId
Type
string
Description
Name
netTotal
Type
number float
Description
Name
netPerUnit
Type
number float
Description
Name
taxPayableAccountId
Type
string
Description
Name
taxPayableAccountCode
Type
string
Description
Name
secret
Type
string
Description
Name
createdAt
Type
string date-time
Description
Name
updatedAt
Type
string date-time
Description

Optional attributes

Name
rejectionReason
Type
string
Description
Name
company
Type
string
Description
Name
firstname
Type
string
Description
Name
lastname
Type
string
Description
Name
name
Type
string
Description
Name
email
Type
string email
Description
Name
customerId
Type
string
Description
Name
address
Type
object
Description
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
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<LegalIdentificationDocumentResource>
Description
An array of identification items
One of — Only one of the following types
Required attributes
Name
type
Type
enum(france_siren)
Description
Name
identifier
Type
string
Description
Name
shopId
Type
string
Description
Name
strategyId
Type
string
Description
Name
vouchers
Type
array<string>
Description
Name
appliedCoupons
Type
array<array | boolean | number | object | string>
Description
Name
innerFeeComponents
Type
array | boolean | number | object | string
Description
Name
outerFeeComponents
Type
array | boolean | number | object | string
Description
Name
products
Type
array<object>
Description
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 float
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 float
Description
The single piece net price of the cart item.
Name
taxRate
Type
number float
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.
One of — Only one of the following types
An ID of another cart item 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 float
Description
Name
perUnit
Type
number float
Description
Name
total
Type
number float
Description
Optional nested attributes (6)
Name
name
Type
string
Description
Name
taxTypeId
Type
string
Description
Name
netTotal
Type
number float
Description
Name
netPerUnit
Type
number float
Description
Name
taxPayableAccountId
Type
string
Description
Name
taxPayableAccountCode
Type
string
Description
Name
additionalItems
Type
array<oneOf>
Description
One of — Only one of the following types
Required attributes
Name
itemId
Type
string
Description
The ID of the item.
Name
type
Type
enum(bundle)
Description
The type of the additional item.
Name
netPrice
Type
number float
Description
The single piece net price of the additional item.
Name
price
Type
number float
Description
The single piece price of the additional item.
Name
taxRate
Type
number float
Description
The tax rate to be applied to this additional item.
Optional attributes
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 float
Description
Name
perUnit
Type
number float
Description
Name
total
Type
number float
Description
Optional nested attributes (6)
Name
name
Type
string
Description
Name
taxTypeId
Type
string
Description
Name
netTotal
Type
number float
Description
Name
netPerUnit
Type
number float
Description
Name
taxPayableAccountId
Type
string
Description
Name
taxPayableAccountCode
Type
string
Description
Name
data
Type
object
Description
Required nested attributes (1)
Name
bundleId
Type
string
Description
The ID of the bundle.
Name
extraFields
Type
object
Description
Name
expiresAt
Type
string date-time
Description
Name
transactionId
Type
string
Description
Name
outcome
Type
object
Description
Optional nested attributes (1)
Name
checkoutId
Type
string
Description
Name
restrictedCompletion
Type
array<enum(POS, Online)>
Description
Specifies how the customer can complete their purchase intent
Name
cancellationStrategy
Type
enum(notAllowed, cancellationAllowed)
Description
Name
seatingReservationToken
Type
string
Description
Name
salesChannelId
Type
string
Description
Name
meta
Type
object
Description
Custom key-value data. Metadata is useful for storing additional, structured information on an object.
Name
history
Type
array<object>
Description
An array of history items indicating changes on the purchase intent
Optional nested attributes (4)
Name
type
Type
enum(purchaseIntent.created, purchaseIntent.approved, purchaseIntent.rejected, purchaseIntent.updated, purchaseIntent.expired, purchaseIntent.completed, purchaseIntent.canceled, purchaseIntent.commented, purchaseIntent.resent.mail)
Description
The type of the history item.
Name
date
Type
string date-time
Description
An ISO timestamp indicating the date of the history item.
Name
userId
Type
string
Description
The user ID of the history item.
Name
data
Type
object
Description
The data of the history item
Name
userId
Type
string
Description
The ID of the user who created the purchase intent.
Name
deposit
Type
object
Description
Information for the deposit paid, if there was any
Required nested attributes (3)
Name
amount
Type
number float
Description
The amount paid for the deposit
Name
paymentId
Type
string
Description
The id of the payment for the deposit
Name
balanceTransactionId
Type
string
Description
The id of the transaction for the deposit
Name
__v
Type
integer
Description

Example

{
  "_id": "507f191e810c19729de860ea",
  "status": "new",
  "approvalStatus": "awaiting",
  "sellerId": "507f191e810c19729de860ea",
  "eventId": "507f191e810c19729de860ea",
  "regularPrice": 10.5,
  "realPrice": 10.5,
  "currency": "EUR",
  "innerCharge": 10.5,
  "outerCharge": 10.5,
  "tickets": [
    {
      "amount": 1,
      "price": 10.5,
      "ticketTypeId": "507f191e810c19729de860ea",
      "type": "ticket",
      "_id": "507f191e810c19729de860ea",
      "name": "Some fancy 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": "Some fancy Name",
        "seatType": "handicapped",
        "sectionName": "string",
        "groupName": "string",
        "rowName": "string",
        "seatName": "string",
        "gate": "string"
      },
      "slotInfo": {
        "slotId": "507f191e810c19729de860ea",
        "slotStartTime": "string"
      },
      "asHardTicket": true,
      "listingId": "507f191e810c19729de860ea",
      "listingItemId": "507f191e810c19729de860ea",
      "triggeredAutomations": true,
      "meta": {},
      "addOns": [
        {
          "productId": "507f191e810c19729de860ea",
          "productVariantId": "507f191e810c19729de860ea",
          "name": "Some fancy 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": "Some fancy Name",
            "taxTypeId": "507f191e810c19729de860ea",
            "netTotal": 10.5,
            "netPerUnit": 10.5,
            "taxPayableAccountId": "507f191e810c19729de860ea",
            "taxPayableAccountCode": "string"
          }
        ]
      }
    }
  ],
  "secret": "4b5fb736-45fd-4895-b497-124a2360c7e6",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "rejectionReason": "string",
  "company": "vivenu GmbH",
  "firstname": "string",
  "lastname": "Robot",
  "name": "Some fancy Name",
  "email": "random@mail.com",
  "customerId": "507f191e810c19729de860ea",
  "address": {
    "fullAddress": "string",
    "street": "Speditionsstr",
    "line2": "string",
    "postal": "40221",
    "city": "Düsseldorf",
    "country": "DE",
    "state": "string"
  },
  "deliveryAddress": {
    "fullAddress": "string",
    "street": "Speditionsstr",
    "line2": "string",
    "postal": "40221",
    "city": "Düsseldorf",
    "country": "DE",
    "state": "string",
    "name": "Some fancy Name"
  },
  "identification": [
    {
      "type": "france_siren",
      "identifier": "string"
    }
  ],
  "shopId": "507f191e810c19729de860ea",
  "strategyId": "507f191e810c19729de860ea",
  "vouchers": [
    "string"
  ],
  "appliedCoupons": [
    []
  ],
  "innerFeeComponents": [],
  "outerFeeComponents": [],
  "products": [
    {
      "type": "product",
      "amount": 1,
      "price": 10.5,
      "productVariantId": "507f191e810c19729de860ea",
      "_id": "507f191e810c19729de860ea",
      "name": "Some fancy 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": "Some fancy Name",
            "taxTypeId": "507f191e810c19729de860ea",
            "netTotal": 10.5,
            "netPerUnit": 10.5,
            "taxPayableAccountId": "507f191e810c19729de860ea",
            "taxPayableAccountCode": "string"
          }
        ]
      }
    }
  ],
  "additionalItems": [
    {
      "itemId": "507f191e810c19729de860ea",
      "type": "bundle",
      "netPrice": 10.5,
      "price": 10.5,
      "taxRate": 10.5,
      "taxInfo": {
        "serviceTypeId": "507f191e810c19729de860ea",
        "exceptionId": "507f191e810c19729de860ea",
        "proceedsAccountId": "507f191e810c19729de860ea",
        "proceedsAccountCode": "string",
        "taxItems": [
          {
            "rate": 10.5,
            "perUnit": 10.5,
            "total": 10.5,
            "name": "Some fancy Name",
            "taxTypeId": "507f191e810c19729de860ea",
            "netTotal": 10.5,
            "netPerUnit": 10.5,
            "taxPayableAccountId": "507f191e810c19729de860ea",
            "taxPayableAccountCode": "string"
          }
        ]
      },
      "data": {
        "bundleId": "507f191e810c19729de860ea"
      }
    }
  ],
  "extraFields": {},
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "transactionId": "507f191e810c19729de860ea",
  "outcome": {
    "checkoutId": "507f191e810c19729de860ea"
  },
  "restrictedCompletion": [
    "POS"
  ],
  "cancellationStrategy": "cancellationAllowed",
  "seatingReservationToken": "string",
  "salesChannelId": "507f191e810c19729de860ea",
  "meta": {},
  "history": [
    {
      "type": "purchaseIntent.created",
      "date": "2030-01-23T23:00:00.123Z",
      "userId": "507f191e810c19729de860ea",
      "data": {}
    }
  ],
  "userId": "507f191e810c19729de860ea",
  "deposit": {
    "amount": 10.5,
    "paymentId": "507f191e810c19729de860ea",
    "balanceTransactionId": "507f191e810c19729de860ea"
  },
  "__v": 1
}

POST/api/purchaseintents

Create a PurchaseIntent

Payload

Required attributes

Name
eventId
Type
string
Description
Name
tickets
Type
array<object>
Description
Required nested attributes (3)
Name
amount
Type
integer
Description
The amount of the cart item.
Name
price
Type
number float
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 float
Description
The single piece net price of the cart item.
Name
taxRate
Type
number float
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.
One of — Only one of the following types
An ID of another cart item 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) float
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.
One of — Only one of the following types
Required attributes
Name
type
Type
enum(self_service_return)
Description
Name
settings
Type
object
Description
Required nested attributes (1)
Name
phases
Type
array<object>
Description
Required nested attributes (2)
Name
condition
Type
object
Description
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
refundPercentage
Type
number float
Description
Optional nested attributes (1)
Name
returnRelatedItems
Type
boolean
Description
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 float
Description
Name
perUnit
Type
number float
Description
Name
total
Type
number float
Description
Optional nested attributes (6)
Name
name
Type
string
Description
Name
taxTypeId
Type
string
Description
Name
netTotal
Type
number float
Description
Name
netPerUnit
Type
number float
Description
Name
taxPayableAccountId
Type
string
Description
Name
taxPayableAccountCode
Type
string
Description

Optional attributes

Name
customerId
Type
string
Description
Name
shopId
Type
string
Description
Name
products
Type
array<object>
Description
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 float
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 float
Description
The single piece net price of the cart item.
Name
taxRate
Type
number float
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.
One of — Only one of the following types
An ID of another cart item 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 float
Description
Name
perUnit
Type
number float
Description
Name
total
Type
number float
Description
Optional nested attributes (6)
Name
name
Type
string
Description
Name
taxTypeId
Type
string
Description
Name
netTotal
Type
number float
Description
Name
netPerUnit
Type
number float
Description
Name
taxPayableAccountId
Type
string
Description
Name
taxPayableAccountCode
Type
string
Description
Name
extraFields
Type
object
Description
Name
seatingReservationToken
Type
string
Description
Name
meta
Type
object
Description
Custom key-value data. Metadata is useful for storing additional, structured information on an object.
Name
strategyId
Type
string
Description
Name
salesChannelId
Type
string
Description
Name
coupons
Type
array<string>
Description
Name
sendMail
Type
boolean
Description
Name
additionalItems
Type
array<object>
Description
Required nested attributes (3)
Name
type
Type
enum(bundle, additionalFee, fulfillmentType, insurance)
Description
The type of the cart item.
Name
amount
Type
integer
Description
The amount of the cart item.
Name
price
Type
number float
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 float
Description
The single piece net price of the cart item.
Name
taxRate
Type
number float
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.
One of — Only one of the following types
An ID of another cart item 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
Name
identification
Type
array<LegalIdentificationDocumentResource>
Description
An array of identification items
One of — Only one of the following types
Required attributes
Name
type
Type
enum(france_siren)
Description
Name
identifier
Type
string
Description

Request

POST

/api/purchaseintents

const response = await fetch('https://vivenu.com/api/purchaseintents', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer {token}',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(  {
    "eventId": "507f191e810c19729de860ea",
    "tickets": [
      {
        "amount": 1,
        "price": 10.5,
        "ticketTypeId": "507f191e810c19729de860ea",
        "type": "ticket",
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy 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": "Some fancy Name",
          "seatType": "handicapped",
          "sectionName": "string",
          "groupName": "string",
          "rowName": "string",
          "seatName": "string",
          "gate": "string"
        },
        "slotInfo": {
          "slotId": "507f191e810c19729de860ea",
          "slotStartTime": "string"
        },
        "asHardTicket": true,
        "listingId": "507f191e810c19729de860ea",
        "listingItemId": "507f191e810c19729de860ea",
        "triggeredAutomations": true,
        "meta": {},
        "addOns": [
          {
            "productId": "507f191e810c19729de860ea",
            "productVariantId": "507f191e810c19729de860ea",
            "name": "Some fancy 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": "Some fancy Name",
              "taxTypeId": "507f191e810c19729de860ea",
              "netTotal": 10.5,
              "netPerUnit": 10.5,
              "taxPayableAccountId": "507f191e810c19729de860ea",
              "taxPayableAccountCode": "string"
            }
          ]
        }
      }
    ],
    "customerId": "507f191e810c19729de860ea",
    "shopId": "507f191e810c19729de860ea",
    "products": [
      {
        "type": "product",
        "amount": 1,
        "price": 10.5,
        "productVariantId": "507f191e810c19729de860ea",
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy 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": "Some fancy Name",
              "taxTypeId": "507f191e810c19729de860ea",
              "netTotal": 10.5,
              "netPerUnit": 10.5,
              "taxPayableAccountId": "507f191e810c19729de860ea",
              "taxPayableAccountCode": "string"
            }
          ]
        }
      }
    ],
    "extraFields": {},
    "seatingReservationToken": "string",
    "meta": {},
    "strategyId": "507f191e810c19729de860ea",
    "salesChannelId": "507f191e810c19729de860ea",
    "coupons": [
      "string"
    ],
    "sendMail": true,
    "additionalItems": [
      {
        "type": "bundle",
        "amount": 1,
        "price": 10.5,
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "netPrice": 10.5,
        "taxRate": 10.5,
        "triggeredBy": "string",
        "bundleInfo": {
          "bundleId": "507f191e810c19729de860ea",
          "componentId": "507f191e810c19729de860ea",
          "optionId": "507f191e810c19729de860ea"
        },
        "data": {}
      }
    ],
    "identification": [
      {
        "type": "france_siren",
        "identifier": "string"
      }
    ]
  }),
})

const data = await response.json()

Response (201)

{
  "_id": "507f191e810c19729de860ea",
  "status": "new",
  "approvalStatus": "awaiting",
  "sellerId": "507f191e810c19729de860ea",
  "eventId": "507f191e810c19729de860ea",
  "regularPrice": 10.5,
  "realPrice": 10.5,
  "currency": "EUR",
  "innerCharge": 10.5,
  "outerCharge": 10.5,
  "tickets": [
    {
      "amount": 1,
      "price": 10.5,
      "ticketTypeId": "507f191e810c19729de860ea",
      "type": "ticket",
      "_id": "507f191e810c19729de860ea",
      "name": "Some fancy 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": "Some fancy Name",
        "seatType": "handicapped",
        "sectionName": "string",
        "groupName": "string",
        "rowName": "string",
        "seatName": "string",
        "gate": "string"
      },
      "slotInfo": {
        "slotId": "507f191e810c19729de860ea",
        "slotStartTime": "string"
      },
      "asHardTicket": true,
      "listingId": "507f191e810c19729de860ea",
      "listingItemId": "507f191e810c19729de860ea",
      "triggeredAutomations": true,
      "meta": {},
      "addOns": [
        {
          "productId": "507f191e810c19729de860ea",
          "productVariantId": "507f191e810c19729de860ea",
          "name": "Some fancy 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": "Some fancy Name",
            "taxTypeId": "507f191e810c19729de860ea",
            "netTotal": 10.5,
            "netPerUnit": 10.5,
            "taxPayableAccountId": "507f191e810c19729de860ea",
            "taxPayableAccountCode": "string"
          }
        ]
      }
    }
  ],
  "secret": "4b5fb736-45fd-4895-b497-124a2360c7e6",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "rejectionReason": "string",
  "company": "vivenu GmbH",
  "firstname": "string",
  "lastname": "Robot",
  "name": "Some fancy Name",
  "email": "random@mail.com",
  "customerId": "507f191e810c19729de860ea",
  "address": {
    "fullAddress": "string",
    "street": "Speditionsstr",
    "line2": "string",
    "postal": "40221",
    "city": "Düsseldorf",
    "country": "DE",
    "state": "string"
  },
  "deliveryAddress": {
    "fullAddress": "string",
    "street": "Speditionsstr",
    "line2": "string",
    "postal": "40221",
    "city": "Düsseldorf",
    "country": "DE",
    "state": "string",
    "name": "Some fancy Name"
  },
  "identification": [
    {
      "type": "france_siren",
      "identifier": "string"
    }
  ],
  "shopId": "507f191e810c19729de860ea",
  "strategyId": "507f191e810c19729de860ea",
  "vouchers": [
    "string"
  ],
  "appliedCoupons": [
    []
  ],
  "innerFeeComponents": [],
  "outerFeeComponents": [],
  "products": [
    {
      "type": "product",
      "amount": 1,
      "price": 10.5,
      "productVariantId": "507f191e810c19729de860ea",
      "_id": "507f191e810c19729de860ea",
      "name": "Some fancy 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": "Some fancy Name",
            "taxTypeId": "507f191e810c19729de860ea",
            "netTotal": 10.5,
            "netPerUnit": 10.5,
            "taxPayableAccountId": "507f191e810c19729de860ea",
            "taxPayableAccountCode": "string"
          }
        ]
      }
    }
  ],
  "additionalItems": [
    {
      "itemId": "507f191e810c19729de860ea",
      "type": "bundle",
      "netPrice": 10.5,
      "price": 10.5,
      "taxRate": 10.5,
      "taxInfo": {
        "serviceTypeId": "507f191e810c19729de860ea",
        "exceptionId": "507f191e810c19729de860ea",
        "proceedsAccountId": "507f191e810c19729de860ea",
        "proceedsAccountCode": "string",
        "taxItems": [
          {
            "rate": 10.5,
            "perUnit": 10.5,
            "total": 10.5,
            "name": "Some fancy Name",
            "taxTypeId": "507f191e810c19729de860ea",
            "netTotal": 10.5,
            "netPerUnit": 10.5,
            "taxPayableAccountId": "507f191e810c19729de860ea",
            "taxPayableAccountCode": "string"
          }
        ]
      },
      "data": {
        "bundleId": "507f191e810c19729de860ea"
      }
    }
  ],
  "extraFields": {},
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "transactionId": "507f191e810c19729de860ea",
  "outcome": {
    "checkoutId": "507f191e810c19729de860ea"
  },
  "restrictedCompletion": [
    "POS"
  ],
  "cancellationStrategy": "cancellationAllowed",
  "seatingReservationToken": "string",
  "salesChannelId": "507f191e810c19729de860ea",
  "meta": {},
  "history": [
    {
      "type": "purchaseIntent.created",
      "date": "2030-01-23T23:00:00.123Z",
      "userId": "507f191e810c19729de860ea",
      "data": {}
    }
  ],
  "userId": "507f191e810c19729de860ea",
  "deposit": {
    "amount": 10.5,
    "paymentId": "507f191e810c19729de860ea",
    "balanceTransactionId": "507f191e810c19729de860ea"
  },
  "__v": 1
}

GET/api/purchaseintents/:id

Get a PurchaseIntent

Request

GET

/api/purchaseintents/:id

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

const data = await response.json()

Response (200)

{
  "_id": "507f191e810c19729de860ea",
  "status": "new",
  "approvalStatus": "awaiting",
  "sellerId": "507f191e810c19729de860ea",
  "eventId": "507f191e810c19729de860ea",
  "regularPrice": 10.5,
  "realPrice": 10.5,
  "currency": "EUR",
  "innerCharge": 10.5,
  "outerCharge": 10.5,
  "tickets": [
    {
      "amount": 1,
      "price": 10.5,
      "ticketTypeId": "507f191e810c19729de860ea",
      "type": "ticket",
      "_id": "507f191e810c19729de860ea",
      "name": "Some fancy 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": "Some fancy Name",
        "seatType": "handicapped",
        "sectionName": "string",
        "groupName": "string",
        "rowName": "string",
        "seatName": "string",
        "gate": "string"
      },
      "slotInfo": {
        "slotId": "507f191e810c19729de860ea",
        "slotStartTime": "string"
      },
      "asHardTicket": true,
      "listingId": "507f191e810c19729de860ea",
      "listingItemId": "507f191e810c19729de860ea",
      "triggeredAutomations": true,
      "meta": {},
      "addOns": [
        {
          "productId": "507f191e810c19729de860ea",
          "productVariantId": "507f191e810c19729de860ea",
          "name": "Some fancy 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": "Some fancy Name",
            "taxTypeId": "507f191e810c19729de860ea",
            "netTotal": 10.5,
            "netPerUnit": 10.5,
            "taxPayableAccountId": "507f191e810c19729de860ea",
            "taxPayableAccountCode": "string"
          }
        ]
      }
    }
  ],
  "secret": "4b5fb736-45fd-4895-b497-124a2360c7e6",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "rejectionReason": "string",
  "company": "vivenu GmbH",
  "firstname": "string",
  "lastname": "Robot",
  "name": "Some fancy Name",
  "email": "random@mail.com",
  "customerId": "507f191e810c19729de860ea",
  "address": {
    "fullAddress": "string",
    "street": "Speditionsstr",
    "line2": "string",
    "postal": "40221",
    "city": "Düsseldorf",
    "country": "DE",
    "state": "string"
  },
  "deliveryAddress": {
    "fullAddress": "string",
    "street": "Speditionsstr",
    "line2": "string",
    "postal": "40221",
    "city": "Düsseldorf",
    "country": "DE",
    "state": "string",
    "name": "Some fancy Name"
  },
  "identification": [
    {
      "type": "france_siren",
      "identifier": "string"
    }
  ],
  "shopId": "507f191e810c19729de860ea",
  "strategyId": "507f191e810c19729de860ea",
  "vouchers": [
    "string"
  ],
  "appliedCoupons": [
    []
  ],
  "innerFeeComponents": [],
  "outerFeeComponents": [],
  "products": [
    {
      "type": "product",
      "amount": 1,
      "price": 10.5,
      "productVariantId": "507f191e810c19729de860ea",
      "_id": "507f191e810c19729de860ea",
      "name": "Some fancy 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": "Some fancy Name",
            "taxTypeId": "507f191e810c19729de860ea",
            "netTotal": 10.5,
            "netPerUnit": 10.5,
            "taxPayableAccountId": "507f191e810c19729de860ea",
            "taxPayableAccountCode": "string"
          }
        ]
      }
    }
  ],
  "additionalItems": [
    {
      "itemId": "507f191e810c19729de860ea",
      "type": "bundle",
      "netPrice": 10.5,
      "price": 10.5,
      "taxRate": 10.5,
      "taxInfo": {
        "serviceTypeId": "507f191e810c19729de860ea",
        "exceptionId": "507f191e810c19729de860ea",
        "proceedsAccountId": "507f191e810c19729de860ea",
        "proceedsAccountCode": "string",
        "taxItems": [
          {
            "rate": 10.5,
            "perUnit": 10.5,
            "total": 10.5,
            "name": "Some fancy Name",
            "taxTypeId": "507f191e810c19729de860ea",
            "netTotal": 10.5,
            "netPerUnit": 10.5,
            "taxPayableAccountId": "507f191e810c19729de860ea",
            "taxPayableAccountCode": "string"
          }
        ]
      },
      "data": {
        "bundleId": "507f191e810c19729de860ea"
      }
    }
  ],
  "extraFields": {},
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "transactionId": "507f191e810c19729de860ea",
  "outcome": {
    "checkoutId": "507f191e810c19729de860ea"
  },
  "restrictedCompletion": [
    "POS"
  ],
  "cancellationStrategy": "cancellationAllowed",
  "seatingReservationToken": "string",
  "salesChannelId": "507f191e810c19729de860ea",
  "meta": {},
  "history": [
    {
      "type": "purchaseIntent.created",
      "date": "2030-01-23T23:00:00.123Z",
      "userId": "507f191e810c19729de860ea",
      "data": {}
    }
  ],
  "userId": "507f191e810c19729de860ea",
  "deposit": {
    "amount": 10.5,
    "paymentId": "507f191e810c19729de860ea",
    "balanceTransactionId": "507f191e810c19729de860ea"
  },
  "__v": 1
}

GET/api/purchaseintents

Get all PurchaseIntents

Query parameters

Optional query parameters

Name
customerId
Type
string
Description
The customer id to filter for
Name
status
Type
string
Description
The status to filter for
Name
approvalStatus
Type
string
Description
The approval status to filter for
Name
name
Type
string
Description
The name to filter for
Name
eventId
Type
string
Description
The event id to filter for
Name
shopId
Type
string
Description
The secret shop id to filter for
Name
createdAtStart
Type
string
Description
An ISO timestamp from which to filter for
Name
createdAtEnd
Type
string
Description
An ISO timestamp until which to filter for
Name
outcomeCheckoutId
Type
string
Description
The resulting checkout id.
Name
top
Type
integer
Description
A limit on the number of objects to be returned. Can range between 1 and 1000.
Name
skip
Type
integer
Description
The number of objects to skip for the requested result

Request

GET

/api/purchaseintents

const response = await fetch('https://vivenu.com/api/purchaseintents?customerId=507f191e810c19729de860ea&status=value&approvalStatus=value&name=Some+fancy+Name&eventId=507f191e810c19729de860ea&shopId=507f191e810c19729de860ea&createdAtStart=value&createdAtEnd=value&outcomeCheckoutId=507f191e810c19729de860ea&top=1&skip=1', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer {token}',
  },
})

const data = await response.json()

Response (200)

{
  "rows": [
    {
      "_id": "507f191e810c19729de860ea",
      "status": "new",
      "approvalStatus": "awaiting",
      "sellerId": "507f191e810c19729de860ea",
      "eventId": "507f191e810c19729de860ea",
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "currency": "EUR",
      "innerCharge": 10.5,
      "outerCharge": 10.5,
      "tickets": [
        {
          "amount": 1,
          "price": 10.5,
          "ticketTypeId": "507f191e810c19729de860ea",
          "type": "ticket",
          "_id": "507f191e810c19729de860ea",
          "name": "Some fancy 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": "Some fancy Name",
            "seatType": "handicapped",
            "sectionName": "string",
            "groupName": "string",
            "rowName": "string",
            "seatName": "string",
            "gate": "string"
          },
          "slotInfo": {
            "slotId": "507f191e810c19729de860ea",
            "slotStartTime": "string"
          },
          "asHardTicket": true,
          "listingId": "507f191e810c19729de860ea",
          "listingItemId": "507f191e810c19729de860ea",
          "triggeredAutomations": true,
          "meta": {},
          "addOns": [
            {
              "productId": "507f191e810c19729de860ea",
              "productVariantId": "507f191e810c19729de860ea",
              "name": "Some fancy 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": "Some fancy Name",
                "taxTypeId": "507f191e810c19729de860ea",
                "netTotal": 10.5,
                "netPerUnit": 10.5,
                "taxPayableAccountId": "507f191e810c19729de860ea",
                "taxPayableAccountCode": "string"
              }
            ]
          }
        }
      ],
      "secret": "4b5fb736-45fd-4895-b497-124a2360c7e6",
      "createdAt": "2030-01-23T23:00:00.123Z",
      "updatedAt": "2030-01-23T23:00:00.123Z",
      "rejectionReason": "string",
      "company": "vivenu GmbH",
      "firstname": "string",
      "lastname": "Robot",
      "name": "Some fancy Name",
      "email": "random@mail.com",
      "customerId": "507f191e810c19729de860ea",
      "address": {
        "fullAddress": "string",
        "street": "Speditionsstr",
        "line2": "string",
        "postal": "40221",
        "city": "Düsseldorf",
        "country": "DE",
        "state": "string"
      },
      "deliveryAddress": {
        "fullAddress": "string",
        "street": "Speditionsstr",
        "line2": "string",
        "postal": "40221",
        "city": "Düsseldorf",
        "country": "DE",
        "state": "string",
        "name": "Some fancy Name"
      },
      "identification": [
        {
          "type": "france_siren",
          "identifier": "string"
        }
      ],
      "shopId": "507f191e810c19729de860ea",
      "strategyId": "507f191e810c19729de860ea",
      "vouchers": [
        "string"
      ],
      "appliedCoupons": [
        []
      ],
      "innerFeeComponents": [],
      "outerFeeComponents": [],
      "products": [
        {
          "type": "product",
          "amount": 1,
          "price": 10.5,
          "productVariantId": "507f191e810c19729de860ea",
          "_id": "507f191e810c19729de860ea",
          "name": "Some fancy 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": "Some fancy Name",
                "taxTypeId": "507f191e810c19729de860ea",
                "netTotal": 10.5,
                "netPerUnit": 10.5,
                "taxPayableAccountId": "507f191e810c19729de860ea",
                "taxPayableAccountCode": "string"
              }
            ]
          }
        }
      ],
      "additionalItems": [
        {
          "itemId": "507f191e810c19729de860ea",
          "type": "bundle",
          "netPrice": 10.5,
          "price": 10.5,
          "taxRate": 10.5,
          "taxInfo": {
            "serviceTypeId": "507f191e810c19729de860ea",
            "exceptionId": "507f191e810c19729de860ea",
            "proceedsAccountId": "507f191e810c19729de860ea",
            "proceedsAccountCode": "string",
            "taxItems": [
              {
                "rate": 10.5,
                "perUnit": 10.5,
                "total": 10.5,
                "name": "Some fancy Name",
                "taxTypeId": "507f191e810c19729de860ea",
                "netTotal": 10.5,
                "netPerUnit": 10.5,
                "taxPayableAccountId": "507f191e810c19729de860ea",
                "taxPayableAccountCode": "string"
              }
            ]
          },
          "data": {
            "bundleId": "507f191e810c19729de860ea"
          }
        }
      ],
      "extraFields": {},
      "expiresAt": "2030-01-23T23:00:00.123Z",
      "transactionId": "507f191e810c19729de860ea",
      "outcome": {
        "checkoutId": "507f191e810c19729de860ea"
      },
      "restrictedCompletion": [
        "POS"
      ],
      "cancellationStrategy": "cancellationAllowed",
      "seatingReservationToken": "string",
      "salesChannelId": "507f191e810c19729de860ea",
      "meta": {},
      "history": [
        {
          "type": "purchaseIntent.created",
          "date": "2030-01-23T23:00:00.123Z",
          "userId": "507f191e810c19729de860ea",
          "data": {}
        }
      ],
      "userId": "507f191e810c19729de860ea",
      "deposit": {
        "amount": 10.5,
        "paymentId": "507f191e810c19729de860ea",
        "balanceTransactionId": "507f191e810c19729de860ea"
      },
      "__v": 1
    }
  ],
  "total": 1
}

POST/api/purchaseintents/:id/approval

Set approval status

Payload

Optional attributes

Name
approvalStatus
Type
enum(awaiting, approved, rejected)
Description
Name
rejectionReason
Type
string
Description

Request

POST

/api/purchaseintents/:id/approval

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

const data = await response.json()

Response (200)

{
  "_id": "507f191e810c19729de860ea",
  "status": "new",
  "approvalStatus": "awaiting",
  "sellerId": "507f191e810c19729de860ea",
  "eventId": "507f191e810c19729de860ea",
  "regularPrice": 10.5,
  "realPrice": 10.5,
  "currency": "EUR",
  "innerCharge": 10.5,
  "outerCharge": 10.5,
  "tickets": [
    {
      "amount": 1,
      "price": 10.5,
      "ticketTypeId": "507f191e810c19729de860ea",
      "type": "ticket",
      "_id": "507f191e810c19729de860ea",
      "name": "Some fancy 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": "Some fancy Name",
        "seatType": "handicapped",
        "sectionName": "string",
        "groupName": "string",
        "rowName": "string",
        "seatName": "string",
        "gate": "string"
      },
      "slotInfo": {
        "slotId": "507f191e810c19729de860ea",
        "slotStartTime": "string"
      },
      "asHardTicket": true,
      "listingId": "507f191e810c19729de860ea",
      "listingItemId": "507f191e810c19729de860ea",
      "triggeredAutomations": true,
      "meta": {},
      "addOns": [
        {
          "productId": "507f191e810c19729de860ea",
          "productVariantId": "507f191e810c19729de860ea",
          "name": "Some fancy 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": "Some fancy Name",
            "taxTypeId": "507f191e810c19729de860ea",
            "netTotal": 10.5,
            "netPerUnit": 10.5,
            "taxPayableAccountId": "507f191e810c19729de860ea",
            "taxPayableAccountCode": "string"
          }
        ]
      }
    }
  ],
  "secret": "4b5fb736-45fd-4895-b497-124a2360c7e6",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "rejectionReason": "string",
  "company": "vivenu GmbH",
  "firstname": "string",
  "lastname": "Robot",
  "name": "Some fancy Name",
  "email": "random@mail.com",
  "customerId": "507f191e810c19729de860ea",
  "address": {
    "fullAddress": "string",
    "street": "Speditionsstr",
    "line2": "string",
    "postal": "40221",
    "city": "Düsseldorf",
    "country": "DE",
    "state": "string"
  },
  "deliveryAddress": {
    "fullAddress": "string",
    "street": "Speditionsstr",
    "line2": "string",
    "postal": "40221",
    "city": "Düsseldorf",
    "country": "DE",
    "state": "string",
    "name": "Some fancy Name"
  },
  "identification": [
    {
      "type": "france_siren",
      "identifier": "string"
    }
  ],
  "shopId": "507f191e810c19729de860ea",
  "strategyId": "507f191e810c19729de860ea",
  "vouchers": [
    "string"
  ],
  "appliedCoupons": [
    []
  ],
  "innerFeeComponents": [],
  "outerFeeComponents": [],
  "products": [
    {
      "type": "product",
      "amount": 1,
      "price": 10.5,
      "productVariantId": "507f191e810c19729de860ea",
      "_id": "507f191e810c19729de860ea",
      "name": "Some fancy 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": "Some fancy Name",
            "taxTypeId": "507f191e810c19729de860ea",
            "netTotal": 10.5,
            "netPerUnit": 10.5,
            "taxPayableAccountId": "507f191e810c19729de860ea",
            "taxPayableAccountCode": "string"
          }
        ]
      }
    }
  ],
  "additionalItems": [
    {
      "itemId": "507f191e810c19729de860ea",
      "type": "bundle",
      "netPrice": 10.5,
      "price": 10.5,
      "taxRate": 10.5,
      "taxInfo": {
        "serviceTypeId": "507f191e810c19729de860ea",
        "exceptionId": "507f191e810c19729de860ea",
        "proceedsAccountId": "507f191e810c19729de860ea",
        "proceedsAccountCode": "string",
        "taxItems": [
          {
            "rate": 10.5,
            "perUnit": 10.5,
            "total": 10.5,
            "name": "Some fancy Name",
            "taxTypeId": "507f191e810c19729de860ea",
            "netTotal": 10.5,
            "netPerUnit": 10.5,
            "taxPayableAccountId": "507f191e810c19729de860ea",
            "taxPayableAccountCode": "string"
          }
        ]
      },
      "data": {
        "bundleId": "507f191e810c19729de860ea"
      }
    }
  ],
  "extraFields": {},
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "transactionId": "507f191e810c19729de860ea",
  "outcome": {
    "checkoutId": "507f191e810c19729de860ea"
  },
  "restrictedCompletion": [
    "POS"
  ],
  "cancellationStrategy": "cancellationAllowed",
  "seatingReservationToken": "string",
  "salesChannelId": "507f191e810c19729de860ea",
  "meta": {},
  "history": [
    {
      "type": "purchaseIntent.created",
      "date": "2030-01-23T23:00:00.123Z",
      "userId": "507f191e810c19729de860ea",
      "data": {}
    }
  ],
  "userId": "507f191e810c19729de860ea",
  "deposit": {
    "amount": 10.5,
    "paymentId": "507f191e810c19729de860ea",
    "balanceTransactionId": "507f191e810c19729de860ea"
  },
  "__v": 1
}

POST/api/purchaseintents/:id/cancel

Cancel a purchase intent

Request

POST

/api/purchaseintents/:id/cancel

const response = await fetch('https://vivenu.com/api/purchaseintents/507f191e810c19729de860ea/cancel', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer {token}',
  },
})

const data = await response.json()

Response (200)

{
  "_id": "507f191e810c19729de860ea",
  "status": "new",
  "approvalStatus": "awaiting",
  "sellerId": "507f191e810c19729de860ea",
  "eventId": "507f191e810c19729de860ea",
  "regularPrice": 10.5,
  "realPrice": 10.5,
  "currency": "EUR",
  "innerCharge": 10.5,
  "outerCharge": 10.5,
  "tickets": [
    {
      "amount": 1,
      "price": 10.5,
      "ticketTypeId": "507f191e810c19729de860ea",
      "type": "ticket",
      "_id": "507f191e810c19729de860ea",
      "name": "Some fancy 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": "Some fancy Name",
        "seatType": "handicapped",
        "sectionName": "string",
        "groupName": "string",
        "rowName": "string",
        "seatName": "string",
        "gate": "string"
      },
      "slotInfo": {
        "slotId": "507f191e810c19729de860ea",
        "slotStartTime": "string"
      },
      "asHardTicket": true,
      "listingId": "507f191e810c19729de860ea",
      "listingItemId": "507f191e810c19729de860ea",
      "triggeredAutomations": true,
      "meta": {},
      "addOns": [
        {
          "productId": "507f191e810c19729de860ea",
          "productVariantId": "507f191e810c19729de860ea",
          "name": "Some fancy 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": "Some fancy Name",
            "taxTypeId": "507f191e810c19729de860ea",
            "netTotal": 10.5,
            "netPerUnit": 10.5,
            "taxPayableAccountId": "507f191e810c19729de860ea",
            "taxPayableAccountCode": "string"
          }
        ]
      }
    }
  ],
  "secret": "4b5fb736-45fd-4895-b497-124a2360c7e6",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "rejectionReason": "string",
  "company": "vivenu GmbH",
  "firstname": "string",
  "lastname": "Robot",
  "name": "Some fancy Name",
  "email": "random@mail.com",
  "customerId": "507f191e810c19729de860ea",
  "address": {
    "fullAddress": "string",
    "street": "Speditionsstr",
    "line2": "string",
    "postal": "40221",
    "city": "Düsseldorf",
    "country": "DE",
    "state": "string"
  },
  "deliveryAddress": {
    "fullAddress": "string",
    "street": "Speditionsstr",
    "line2": "string",
    "postal": "40221",
    "city": "Düsseldorf",
    "country": "DE",
    "state": "string",
    "name": "Some fancy Name"
  },
  "identification": [
    {
      "type": "france_siren",
      "identifier": "string"
    }
  ],
  "shopId": "507f191e810c19729de860ea",
  "strategyId": "507f191e810c19729de860ea",
  "vouchers": [
    "string"
  ],
  "appliedCoupons": [
    []
  ],
  "innerFeeComponents": [],
  "outerFeeComponents": [],
  "products": [
    {
      "type": "product",
      "amount": 1,
      "price": 10.5,
      "productVariantId": "507f191e810c19729de860ea",
      "_id": "507f191e810c19729de860ea",
      "name": "Some fancy 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": "Some fancy Name",
            "taxTypeId": "507f191e810c19729de860ea",
            "netTotal": 10.5,
            "netPerUnit": 10.5,
            "taxPayableAccountId": "507f191e810c19729de860ea",
            "taxPayableAccountCode": "string"
          }
        ]
      }
    }
  ],
  "additionalItems": [
    {
      "itemId": "507f191e810c19729de860ea",
      "type": "bundle",
      "netPrice": 10.5,
      "price": 10.5,
      "taxRate": 10.5,
      "taxInfo": {
        "serviceTypeId": "507f191e810c19729de860ea",
        "exceptionId": "507f191e810c19729de860ea",
        "proceedsAccountId": "507f191e810c19729de860ea",
        "proceedsAccountCode": "string",
        "taxItems": [
          {
            "rate": 10.5,
            "perUnit": 10.5,
            "total": 10.5,
            "name": "Some fancy Name",
            "taxTypeId": "507f191e810c19729de860ea",
            "netTotal": 10.5,
            "netPerUnit": 10.5,
            "taxPayableAccountId": "507f191e810c19729de860ea",
            "taxPayableAccountCode": "string"
          }
        ]
      },
      "data": {
        "bundleId": "507f191e810c19729de860ea"
      }
    }
  ],
  "extraFields": {},
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "transactionId": "507f191e810c19729de860ea",
  "outcome": {
    "checkoutId": "507f191e810c19729de860ea"
  },
  "restrictedCompletion": [
    "POS"
  ],
  "cancellationStrategy": "cancellationAllowed",
  "seatingReservationToken": "string",
  "salesChannelId": "507f191e810c19729de860ea",
  "meta": {},
  "history": [
    {
      "type": "purchaseIntent.created",
      "date": "2030-01-23T23:00:00.123Z",
      "userId": "507f191e810c19729de860ea",
      "data": {}
    }
  ],
  "userId": "507f191e810c19729de860ea",
  "deposit": {
    "amount": 10.5,
    "paymentId": "507f191e810c19729de860ea",
    "balanceTransactionId": "507f191e810c19729de860ea"
  },
  "__v": 1
}

The Purchase Intent Strategy object

Required attributes

Name
name
Type
string
Description
Name of the strategy
Name
availabilityStrategy
Type
oneOf
Description
One of — Only one of the following types
Required attributes
Name
createTickets
Type
enum(true)
Description
Name
checkAvailability
Type
boolean
Description
Whether the availability of the requested tickets should be checked when creating a purchase intent
Name
withoutSeats
Type
enum(false)
Description
Name
createValidTickets
Type
boolean
Description
Name
expirationStrategy
Type
object
Description
Optional nested attributes (3)
Name
hoursBeforeEvent
Type
number float
Description
Purchase intents are only valid outside of the defined period before the event
Name
hoursAfterCreation
Type
number float
Description
Purchase intents are only valid in the defined period after creation
Name
expiresAt
Type
string date-time
Description
Purchase intents are only valid until the defined date
Name
needsApproval
Type
boolean
Description
Purchase intent needs approval of the seller before considered valid
Name
sellerId
Type
string
Description
The ID of the seller of the strategy

Optional attributes

Name
deposit
Type
object
Description
Required nested attributes (1)
Name
method
Type
string
Description
Optional nested attributes (1)
Name
value
Type
number float
Description
Name
restrictedCompletion
Type
array<enum(POS, Online)>
Description
Specifies how the customer can complete their purchase intent
Name
cancellationStrategy
Type
enum(notAllowed, cancellationAllowed)
Description
Name
createdAt
Type
string date-time
Description
An ISO timestamp indicating when the strategy was created
Name
updatedAt
Type
string date-time
Description
An ISO timestamp indicating when the strategy was updated

Example

{
  "name": "Some fancy Name",
  "availabilityStrategy": {
    "createTickets": true,
    "checkAvailability": true,
    "withoutSeats": false,
    "createValidTickets": true
  },
  "expirationStrategy": {
    "hoursBeforeEvent": 10.5,
    "hoursAfterCreation": 10.5,
    "expiresAt": "2030-01-23T23:00:00.123Z"
  },
  "needsApproval": true,
  "sellerId": "507f191e810c19729de860ea",
  "deposit": {
    "method": "string",
    "value": 10.5
  },
  "restrictedCompletion": [
    "POS"
  ],
  "cancellationStrategy": "cancellationAllowed",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

POST/api/purchaseintents/strategies

Create PurchaseIntent Strategies

Payload

Required attributes

Name
name
Type
string
Description
Name of the strategy
Name
availabilityStrategy
Type
oneOf
Description
One of — Only one of the following types
Required attributes
Name
createTickets
Type
enum(true)
Description
Name
checkAvailability
Type
boolean
Description
Whether the availability of the requested tickets should be checked when creating a purchase intent
Name
withoutSeats
Type
enum(false)
Description
Name
createValidTickets
Type
boolean
Description
Name
expirationStrategy
Type
object
Description
Optional nested attributes (3)
Name
hoursBeforeEvent
Type
number float
Description
Purchase intents are only valid outside of the defined period before the event
Name
hoursAfterCreation
Type
number float
Description
Purchase intents are only valid in the defined period after creation
Name
expiresAt
Type
string date-time
Description
Purchase intents are only valid until the defined date
Name
needsApproval
Type
boolean
Description
Purchase intent needs approval of the seller before considered valid

Optional attributes

Name
deposit
Type
object
Description
Required nested attributes (1)
Name
method
Type
string
Description
Optional nested attributes (1)
Name
value
Type
number float
Description
Name
restrictedCompletion
Type
array<enum(POS, Online)>
Description
Specifies how the customer can complete their purchase intent
Name
cancellationStrategy
Type
enum(notAllowed, cancellationAllowed)
Description

Request

POST

/api/purchaseintents/strategies

const response = await fetch('https://vivenu.com/api/purchaseintents/strategies', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer {token}',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(  {
    "name": "Some fancy Name",
    "availabilityStrategy": {
      "createTickets": true,
      "checkAvailability": true,
      "withoutSeats": false,
      "createValidTickets": true
    },
    "expirationStrategy": {
      "hoursBeforeEvent": 10.5,
      "hoursAfterCreation": 10.5,
      "expiresAt": "2030-01-23T23:00:00.123Z"
    },
    "needsApproval": true,
    "deposit": {
      "method": "string",
      "value": 10.5
    },
    "restrictedCompletion": [
      "POS"
    ],
    "cancellationStrategy": "cancellationAllowed"
  }),
})

const data = await response.json()

Response (201)

{
  "name": "Some fancy Name",
  "availabilityStrategy": {
    "createTickets": true,
    "checkAvailability": true,
    "withoutSeats": false,
    "createValidTickets": true
  },
  "expirationStrategy": {
    "hoursBeforeEvent": 10.5,
    "hoursAfterCreation": 10.5,
    "expiresAt": "2030-01-23T23:00:00.123Z"
  },
  "needsApproval": true,
  "sellerId": "507f191e810c19729de860ea",
  "deposit": {
    "method": "string",
    "value": 10.5
  },
  "restrictedCompletion": [
    "POS"
  ],
  "cancellationStrategy": "cancellationAllowed",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

GET/api/purchaseintents/strategies/:id

Get a PurchaseIntent Strategy

Request

GET

/api/purchaseintents/strategies/:id

const response = await fetch('https://vivenu.com/api/purchaseintents/strategies/507f191e810c19729de860ea', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer {token}',
  },
})

const data = await response.json()

Response (200)

{
  "name": "Some fancy Name",
  "availabilityStrategy": {
    "createTickets": true,
    "checkAvailability": true,
    "withoutSeats": false,
    "createValidTickets": true
  },
  "expirationStrategy": {
    "hoursBeforeEvent": 10.5,
    "hoursAfterCreation": 10.5,
    "expiresAt": "2030-01-23T23:00:00.123Z"
  },
  "needsApproval": true,
  "sellerId": "507f191e810c19729de860ea",
  "deposit": {
    "method": "string",
    "value": 10.5
  },
  "restrictedCompletion": [
    "POS"
  ],
  "cancellationStrategy": "cancellationAllowed",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

PUT/api/purchaseintents/strategies/:id

Update a PurchaseIntent Strategy

Payload

Optional attributes

Name
name
Type
string
Description
Name of the strategy
Name
availabilityStrategy
Type
oneOf
Description
One of — Only one of the following types
Required attributes
Name
createTickets
Type
enum(true)
Description
Name
checkAvailability
Type
boolean
Description
Whether the availability of the requested tickets should be checked when creating a purchase intent
Name
withoutSeats
Type
enum(false)
Description
Name
createValidTickets
Type
boolean
Description
Name
expirationStrategy
Type
object
Description
Optional nested attributes (3)
Name
hoursBeforeEvent
Type
number float
Description
Purchase intents are only valid outside of the defined period before the event
Name
hoursAfterCreation
Type
number float
Description
Purchase intents are only valid in the defined period after creation
Name
expiresAt
Type
string date-time
Description
Purchase intents are only valid until the defined date
Name
needsApproval
Type
boolean
Description
Purchase intent needs approval of the seller before considered valid
Name
deposit
Type
object
Description
Required nested attributes (1)
Name
method
Type
string
Description
Optional nested attributes (1)
Name
value
Type
number float
Description
Name
restrictedCompletion
Type
array<enum(POS, Online)>
Description
Specifies how the customer can complete their purchase intent
Name
cancellationStrategy
Type
enum(notAllowed, cancellationAllowed)
Description

Request

PUT

/api/purchaseintents/strategies/:id

const response = await fetch('https://vivenu.com/api/purchaseintents/strategies/507f191e810c19729de860ea', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer {token}',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(  {
    "name": "Some fancy Name",
    "availabilityStrategy": {
      "createTickets": true,
      "checkAvailability": true,
      "withoutSeats": false,
      "createValidTickets": true
    },
    "expirationStrategy": {
      "hoursBeforeEvent": 10.5,
      "hoursAfterCreation": 10.5,
      "expiresAt": "2030-01-23T23:00:00.123Z"
    },
    "needsApproval": true,
    "deposit": {
      "method": "string",
      "value": 10.5
    },
    "restrictedCompletion": [
      "POS"
    ],
    "cancellationStrategy": "cancellationAllowed"
  }),
})

const data = await response.json()

Response (200)

{
  "name": "Some fancy Name",
  "availabilityStrategy": {
    "createTickets": true,
    "checkAvailability": true,
    "withoutSeats": false,
    "createValidTickets": true
  },
  "expirationStrategy": {
    "hoursBeforeEvent": 10.5,
    "hoursAfterCreation": 10.5,
    "expiresAt": "2030-01-23T23:00:00.123Z"
  },
  "needsApproval": true,
  "sellerId": "507f191e810c19729de860ea",
  "deposit": {
    "method": "string",
    "value": 10.5
  },
  "restrictedCompletion": [
    "POS"
  ],
  "cancellationStrategy": "cancellationAllowed",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}