Webhooks

Webhooks allow you to subscribe to events from your vivenu account in order to build near-real-time integrations.

In order to integrate an external system with vivenu via webhooks, you need to provide a publicly accessible HTTP POST endpoint for the webhook to call, and set up a webhook configuration in vivenu specifying the endpoint to call and the events to subscribe to.

It's possible to specify hmacKey for webhook and we will add a x-vivenu-signature header in order to enable you to verify that the request is authentic and signed with your webhook secret.

The available events and payload formats are listed below. Note that the payload schema is fixed and not user-configurable on vivenu, so any listeners need to adhere to the same schema.

Creating Webhooks

You can configure webhooks via the API or in the dashboard under "Developer" > "Webhooks". If you do not see the webhooks section in the dashboard, ensure you have the "Developer" or "Admin" user role, and that the "Webhooks" feature has been enabled for your seller account.

A webhook configuration defines the listener URL to call, which events to send to the listener, and an optional hmacKey for signing requests. You can set up a single configuration to send multiple types of events to the same listener.

Logs and Debugging

For each configured webhook, you can see the following metrics in the dashboard:

Number of calls in the last 24 hours
Delivery rate over the last 24 hours
Average response time over the last 24 hours

Webhook attempts are logged and shown in the dashboard under the respective webhook configuration. For each webhook event triggered, you can see the following information:

Full JSON payload
Timestamp, HTTP status, and response body for each attempt

You can trigger a retry for failed webhook attempts manually in the dashboard, however you can't automatically replay a range of events.

There is no option to trigger test events on webhooks. In order to test a webhook endpoint, the corresponding event must be triggered on the vivenu platform, e.g. by creating a test booking. We recommend carrying out tests in our dev environment.

Security

When setting up a webhook, you can provide an hmacKey to sign calls made from vivenu. The signature is computed by calculating the HMAC of the raw JSON payload with the provided key and the sha256 algorithm, encoded as a hex string. The signature is added to the request in the x-vivenu-signature header.

We strongly recommend you verify the signature in order to prevent malicious users from sending webhook requests to your listeners.

HTTP endpoints are allowed, for HTTPS endpoints we implement strict certificate validation. Endpoint URLs pointing to internal/development hostnames are rejected. Source IPs for webhook calls are not guaranteed to be stable, and must not be used for verification/access control purposes.

Example Verification Code

const HMAC_KEY = "4f1f83b5-b4..."
const signature = crypto
  .createHmac("sha256", HMAC_KEY)
  .update(req.rawPayload).digest("hex")

const requestSignature = req.headers["x-vivenu-signature"]
const isValid = signature.toLowerCase() === requestSignature.toLowerCase()

Timing and Rate Limits

Webhook calls are scheduled immediately after the respective event happens on the vivenu platform. While there is no rate limit on outgoing webhooks, calls are made asynchronously and may experience a slight lag under high-load scenarios.

Outgoing webhook calls have a timeout of ten seconds.

Retry Policy

If an outgoing webhook call by vivenu does not receive a 2xx or 3xx response, it is retried up to six additional times with a progressive backoff delay ranging from 30 seconds to two hours. The response body is logged in either case, but not evaluated by vivenu.

Failed calls can be inspected and manually re-triggered in the corresponding webhook configuration in the dashboard.

Ordering and Idempotency

Webhooks are not guaranteed to be called in the same order as the events causing them. Webhook calls are sent following an at-least-once approach, and can be de-duplicated based on the id field in the payload body.

POST/api/webhooks

Create a new webhook

Payload

Required attributes

Name
name
Type
string
Description
An internal name to identify the webhook listener
Name
url
Type
string uri
Description
An HTTPS URL to post the webhook data

Optional attributes

Name
enabled
Type
boolean
Description
Whether this listener should be notified.
Name
events
Type
object
Description
An object with the subscription status to the webhook event types.
Optional nested attributes (45)
Name
transaction.complete
Type
boolean
Description
Name
transaction.reservedBySystem
Type
boolean
Description
Name
transaction.canceled
Type
boolean
Description
Name
transaction.partiallyCanceled
Type
boolean
Description
Name
checkout.completed
Type
boolean
Description
Name
checkout.aborted
Type
boolean
Description
Name
checkout.detailsSubmitted
Type
boolean
Description
Name
ticket.created
Type
boolean
Description
Name
ticket.updated
Type
boolean
Description
Name
purchaseIntent.created
Type
boolean
Description
Name
purchaseIntent.approved
Type
boolean
Description
Name
purchaseIntent.rejected
Type
boolean
Description
Name
purchaseIntent.updated
Type
boolean
Description
Name
purchaseIntent.expired
Type
boolean
Description
Name
purchaseIntent.completed
Type
boolean
Description
Name
purchaseIntent.cancelled
Type
boolean
Description
Name
customer.created
Type
boolean
Description
Name
customer.updated
Type
boolean
Description
Name
event.created
Type
boolean
Description
Name
event.updated
Type
boolean
Description
Name
event.deleted
Type
boolean
Description
Name
job.started
Type
boolean
Description
Name
job.failed
Type
boolean
Description
Name
job.completed
Type
boolean
Description
Name
support.assignedToSeller
Type
boolean
Description
Name
ticketTransfer.created
Type
boolean
Description
Name
ticketTransfer.rejected
Type
boolean
Description
Name
ticketTransfer.transferred
Type
boolean
Description
Name
ticketTransfer.expired
Type
boolean
Description
Name
scan.created
Type
boolean
Description
Name
bundle.created
Type
boolean
Description
Name
bundle.updated
Type
boolean
Description
Name
product.created
Type
boolean
Description
Name
product.updated
Type
boolean
Description
Name
product.deleted
Type
boolean
Description
Name
subscription.created
Type
boolean
Description
Name
subscription.updated
Type
boolean
Description
Name
subscription.payment.succeeded
Type
boolean
Description
Name
subscription.payment.failed
Type
boolean
Description
Name
fund.created
Type
boolean
Description
Name
fund.updated
Type
boolean
Description
Name
campaign.created
Type
boolean
Description
Name
campaign.updated
Type
boolean
Description
Name
donation.created
Type
boolean
Description
Name
pledge.created
Type
boolean
Description
Name
hmacKey
Type
string
Description
The HMAC key used to validate webhooks.

Request

POST

/api/webhooks

const response = await fetch('https://vivenu.com/api/webhooks', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer {token}',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(  {
    "name": "Some fancy Name",
    "url": "https://vivenu.com",
    "enabled": true,
    "events": {
      "transaction.complete": true,
      "transaction.reservedBySystem": true,
      "transaction.canceled": true,
      "transaction.partiallyCanceled": true,
      "checkout.completed": true,
      "checkout.aborted": true,
      "checkout.detailsSubmitted": true,
      "ticket.created": true,
      "ticket.updated": true,
      "purchaseIntent.created": true,
      "purchaseIntent.approved": true,
      "purchaseIntent.rejected": true,
      "purchaseIntent.updated": true,
      "purchaseIntent.expired": true,
      "purchaseIntent.completed": true,
      "purchaseIntent.cancelled": true,
      "customer.created": true,
      "customer.updated": true,
      "event.created": true,
      "event.updated": true,
      "event.deleted": true,
      "job.started": true,
      "job.failed": true,
      "job.completed": true,
      "support.assignedToSeller": true,
      "ticketTransfer.created": true,
      "ticketTransfer.rejected": true,
      "ticketTransfer.transferred": true,
      "ticketTransfer.expired": true,
      "scan.created": true,
      "bundle.created": true,
      "bundle.updated": true,
      "product.created": true,
      "product.updated": true,
      "product.deleted": true,
      "subscription.created": true,
      "subscription.updated": true,
      "subscription.payment.succeeded": true,
      "subscription.payment.failed": true,
      "fund.created": true,
      "fund.updated": true,
      "campaign.created": true,
      "campaign.updated": true,
      "donation.created": true,
      "pledge.created": true
    },
    "hmacKey": "string"
  }),
})

const data = await response.json()

Response (201)

{
  "_id": "507f191e810c19729de860ea",
  "name": "Some fancy Name",
  "url": "https://vivenu.com",
  "enabled": true,
  "events": {
    "transaction.complete": true,
    "transaction.reservedBySystem": true,
    "transaction.canceled": true,
    "transaction.partiallyCanceled": true,
    "checkout.completed": true,
    "checkout.aborted": true,
    "checkout.detailsSubmitted": true,
    "ticket.created": true,
    "ticket.updated": true,
    "purchaseIntent.created": true,
    "purchaseIntent.approved": true,
    "purchaseIntent.rejected": true,
    "purchaseIntent.updated": true,
    "purchaseIntent.expired": true,
    "purchaseIntent.completed": true,
    "purchaseIntent.cancelled": true,
    "customer.created": true,
    "customer.updated": true,
    "event.created": true,
    "event.updated": true,
    "event.deleted": true,
    "job.started": true,
    "job.failed": true,
    "job.completed": true,
    "support.assignedToSeller": true,
    "ticketTransfer.created": true,
    "ticketTransfer.rejected": true,
    "ticketTransfer.transferred": true,
    "ticketTransfer.expired": true,
    "scan.created": true,
    "bundle.created": true,
    "bundle.updated": true,
    "product.created": true,
    "product.updated": true,
    "product.deleted": true,
    "subscription.created": true,
    "subscription.updated": true,
    "subscription.payment.succeeded": true,
    "subscription.payment.failed": true,
    "fund.created": true,
    "fund.updated": true,
    "campaign.created": true,
    "campaign.updated": true,
    "donation.created": true,
    "pledge.created": true
  },
  "hmacKey": "string",
  "createdBy": {
    "type": "USER",
    "id": "507f191e810c19729de860ea"
  }
}

PUT/api/webhook/:id

Update a webhook

Payload

Required attributes

Name
name
Type
string
Description
An internal name to identify the webhook listener
Name
url
Type
string uri
Description
An HTTPS URL to post the webhook data

Optional attributes

Name
enabled
Type
boolean
Description
Whether this listener should be notified.
Name
events
Type
object
Description
An object with the subscription status to the webhook event types.
Optional nested attributes (45)
Name
transaction.complete
Type
boolean
Description
Name
transaction.reservedBySystem
Type
boolean
Description
Name
transaction.canceled
Type
boolean
Description
Name
transaction.partiallyCanceled
Type
boolean
Description
Name
checkout.completed
Type
boolean
Description
Name
checkout.aborted
Type
boolean
Description
Name
checkout.detailsSubmitted
Type
boolean
Description
Name
ticket.created
Type
boolean
Description
Name
ticket.updated
Type
boolean
Description
Name
purchaseIntent.created
Type
boolean
Description
Name
purchaseIntent.approved
Type
boolean
Description
Name
purchaseIntent.rejected
Type
boolean
Description
Name
purchaseIntent.updated
Type
boolean
Description
Name
purchaseIntent.expired
Type
boolean
Description
Name
purchaseIntent.completed
Type
boolean
Description
Name
purchaseIntent.cancelled
Type
boolean
Description
Name
customer.created
Type
boolean
Description
Name
customer.updated
Type
boolean
Description
Name
event.created
Type
boolean
Description
Name
event.updated
Type
boolean
Description
Name
event.deleted
Type
boolean
Description
Name
job.started
Type
boolean
Description
Name
job.failed
Type
boolean
Description
Name
job.completed
Type
boolean
Description
Name
support.assignedToSeller
Type
boolean
Description
Name
ticketTransfer.created
Type
boolean
Description
Name
ticketTransfer.rejected
Type
boolean
Description
Name
ticketTransfer.transferred
Type
boolean
Description
Name
ticketTransfer.expired
Type
boolean
Description
Name
scan.created
Type
boolean
Description
Name
bundle.created
Type
boolean
Description
Name
bundle.updated
Type
boolean
Description
Name
product.created
Type
boolean
Description
Name
product.updated
Type
boolean
Description
Name
product.deleted
Type
boolean
Description
Name
subscription.created
Type
boolean
Description
Name
subscription.updated
Type
boolean
Description
Name
subscription.payment.succeeded
Type
boolean
Description
Name
subscription.payment.failed
Type
boolean
Description
Name
fund.created
Type
boolean
Description
Name
fund.updated
Type
boolean
Description
Name
campaign.created
Type
boolean
Description
Name
campaign.updated
Type
boolean
Description
Name
donation.created
Type
boolean
Description
Name
pledge.created
Type
boolean
Description
Name
hmacKey
Type
string
Description
The HMAC key used to validate webhooks.

Request

PUT

/api/webhook/:id

const response = await fetch('https://vivenu.com/api/webhook/507f191e810c19729de860ea', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer {token}',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(  {
    "name": "Some fancy Name",
    "url": "https://vivenu.com",
    "enabled": true,
    "events": {
      "transaction.complete": true,
      "transaction.reservedBySystem": true,
      "transaction.canceled": true,
      "transaction.partiallyCanceled": true,
      "checkout.completed": true,
      "checkout.aborted": true,
      "checkout.detailsSubmitted": true,
      "ticket.created": true,
      "ticket.updated": true,
      "purchaseIntent.created": true,
      "purchaseIntent.approved": true,
      "purchaseIntent.rejected": true,
      "purchaseIntent.updated": true,
      "purchaseIntent.expired": true,
      "purchaseIntent.completed": true,
      "purchaseIntent.cancelled": true,
      "customer.created": true,
      "customer.updated": true,
      "event.created": true,
      "event.updated": true,
      "event.deleted": true,
      "job.started": true,
      "job.failed": true,
      "job.completed": true,
      "support.assignedToSeller": true,
      "ticketTransfer.created": true,
      "ticketTransfer.rejected": true,
      "ticketTransfer.transferred": true,
      "ticketTransfer.expired": true,
      "scan.created": true,
      "bundle.created": true,
      "bundle.updated": true,
      "product.created": true,
      "product.updated": true,
      "product.deleted": true,
      "subscription.created": true,
      "subscription.updated": true,
      "subscription.payment.succeeded": true,
      "subscription.payment.failed": true,
      "fund.created": true,
      "fund.updated": true,
      "campaign.created": true,
      "campaign.updated": true,
      "donation.created": true,
      "pledge.created": true
    },
    "hmacKey": "string"
  }),
})

const data = await response.json()

Response (201)

{
  "_id": "507f191e810c19729de860ea",
  "name": "Some fancy Name",
  "url": "https://vivenu.com",
  "enabled": true,
  "events": {
    "transaction.complete": true,
    "transaction.reservedBySystem": true,
    "transaction.canceled": true,
    "transaction.partiallyCanceled": true,
    "checkout.completed": true,
    "checkout.aborted": true,
    "checkout.detailsSubmitted": true,
    "ticket.created": true,
    "ticket.updated": true,
    "purchaseIntent.created": true,
    "purchaseIntent.approved": true,
    "purchaseIntent.rejected": true,
    "purchaseIntent.updated": true,
    "purchaseIntent.expired": true,
    "purchaseIntent.completed": true,
    "purchaseIntent.cancelled": true,
    "customer.created": true,
    "customer.updated": true,
    "event.created": true,
    "event.updated": true,
    "event.deleted": true,
    "job.started": true,
    "job.failed": true,
    "job.completed": true,
    "support.assignedToSeller": true,
    "ticketTransfer.created": true,
    "ticketTransfer.rejected": true,
    "ticketTransfer.transferred": true,
    "ticketTransfer.expired": true,
    "scan.created": true,
    "bundle.created": true,
    "bundle.updated": true,
    "product.created": true,
    "product.updated": true,
    "product.deleted": true,
    "subscription.created": true,
    "subscription.updated": true,
    "subscription.payment.succeeded": true,
    "subscription.payment.failed": true,
    "fund.created": true,
    "fund.updated": true,
    "campaign.created": true,
    "campaign.updated": true,
    "donation.created": true,
    "pledge.created": true
  },
  "hmacKey": "string",
  "createdBy": {
    "type": "USER",
    "id": "507f191e810c19729de860ea"
  }
}

DELETE/api/webhook/:id

Delete a Webhook

Request

DELETE

/api/webhook/:id

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

const data = await response.json()

Response (200)

{
  "_id": "507f191e810c19729de860ea",
  "name": "Some fancy Name",
  "url": "https://vivenu.com",
  "enabled": true,
  "events": {
    "transaction.complete": true,
    "transaction.reservedBySystem": true,
    "transaction.canceled": true,
    "transaction.partiallyCanceled": true,
    "checkout.completed": true,
    "checkout.aborted": true,
    "checkout.detailsSubmitted": true,
    "ticket.created": true,
    "ticket.updated": true,
    "purchaseIntent.created": true,
    "purchaseIntent.approved": true,
    "purchaseIntent.rejected": true,
    "purchaseIntent.updated": true,
    "purchaseIntent.expired": true,
    "purchaseIntent.completed": true,
    "purchaseIntent.cancelled": true,
    "customer.created": true,
    "customer.updated": true,
    "event.created": true,
    "event.updated": true,
    "event.deleted": true,
    "job.started": true,
    "job.failed": true,
    "job.completed": true,
    "support.assignedToSeller": true,
    "ticketTransfer.created": true,
    "ticketTransfer.rejected": true,
    "ticketTransfer.transferred": true,
    "ticketTransfer.expired": true,
    "scan.created": true,
    "bundle.created": true,
    "bundle.updated": true,
    "product.created": true,
    "product.updated": true,
    "product.deleted": true,
    "subscription.created": true,
    "subscription.updated": true,
    "subscription.payment.succeeded": true,
    "subscription.payment.failed": true,
    "fund.created": true,
    "fund.updated": true,
    "campaign.created": true,
    "campaign.updated": true,
    "donation.created": true,
    "pledge.created": true
  },
  "hmacKey": "string",
  "createdBy": {
    "type": "USER",
    "id": "507f191e810c19729de860ea"
  }
}

GET/api/webhooks

Get all webhooks

Query parameters

Optional query parameters

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/webhooks

const response = await fetch('https://vivenu.com/api/webhooks?top=1&skip=1', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer {token}',
  },
})

const data = await response.json()

Response (200)

{
  "docs": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Some fancy Name",
      "url": "https://vivenu.com",
      "enabled": true,
      "events": {
        "transaction.complete": true,
        "transaction.reservedBySystem": true,
        "transaction.canceled": true,
        "transaction.partiallyCanceled": true,
        "checkout.completed": true,
        "checkout.aborted": true,
        "checkout.detailsSubmitted": true,
        "ticket.created": true,
        "ticket.updated": true,
        "purchaseIntent.created": true,
        "purchaseIntent.approved": true,
        "purchaseIntent.rejected": true,
        "purchaseIntent.updated": true,
        "purchaseIntent.expired": true,
        "purchaseIntent.completed": true,
        "purchaseIntent.cancelled": true,
        "customer.created": true,
        "customer.updated": true,
        "event.created": true,
        "event.updated": true,
        "event.deleted": true,
        "job.started": true,
        "job.failed": true,
        "job.completed": true,
        "support.assignedToSeller": true,
        "ticketTransfer.created": true,
        "ticketTransfer.rejected": true,
        "ticketTransfer.transferred": true,
        "ticketTransfer.expired": true,
        "scan.created": true,
        "bundle.created": true,
        "bundle.updated": true,
        "product.created": true,
        "product.updated": true,
        "product.deleted": true,
        "subscription.created": true,
        "subscription.updated": true,
        "subscription.payment.succeeded": true,
        "subscription.payment.failed": true,
        "fund.created": true,
        "fund.updated": true,
        "campaign.created": true,
        "campaign.updated": true,
        "donation.created": true,
        "pledge.created": true
      },
      "hmacKey": "string",
      "createdBy": {
        "type": "USER",
        "id": "507f191e810c19729de860ea"
      }
    }
  ],
  "total": 1
}

Webhook Events

Transaction

Event	Trigger	Payload
`transaction.complete`	When a transaction transitions to `COMPLETE`	Link
`transaction.reservedBySystem`	When a transaction is created `RESERVED_BY_SYSTEM`	Link
`transaction.canceled`	When a transaction transitions to `CANCELED`	Link
`transaction.partiallyCanceled`	When a transaction is partially canceled	Link

Checkout

Event	Trigger	Payload
`checkout.completed`	When a checkout transitions to `COMPLETE`	Link
`checkout.aborted`	When a checkout transitions to `ABORTED`	Link
`checkout.detailsSubmitted`	When a checkout receives customer details	Link

Ticket

Event	Trigger	Payload
`ticket.created`	When a ticket is created	Link
`ticket.updated`	When a ticket is updated	Link

Purchase Intent

Event	Trigger	Payload
`purchaseIntent.created`	When a purchase intent is created	Link
`purchaseIntent.updated`	When a purchase intent is updated	Link
`purchaseIntent.completed`	When a purchase intent is completed	Link
`purchaseIntent.approved`	When a purchase intent is approved	Link
`purchaseIntent.rejected`	When a purchase intent is rejected	Link
`purchaseIntent.expired`	When a purchase intent expires	Link
`purchaseIntent.cancelled`	When a purchase intent is cancelled	Link

Customer

Event	Trigger	Payload
`customer.created`	When a customer is created	Link
`customer.updated`	When a customer is updated	Link

Event

Event	Trigger	Payload
`event.created`	When an event is created	Link
`event.updated`	When an event is updated	Link
`event.deleted`	When an event is deleted	Link

Job

Event	Trigger	Payload
`job.started`	When a job starts	Link
`job.failed`	When a job fails	Link
`job.completed`	When a job is completed	Link

Support

Event	Trigger	Payload
`support.assignedToSeller`	When a support ticket is assigned to seller	Link

Ticket Transfer

Event	Trigger	Payload
`ticketTransfer.created`	When a ticket transfer is created	Link
`ticketTransfer.rejected`	When a ticket transfer is rejected	Link
`ticketTransfer.transferred`	When a ticket transfer is transferred	Link
`ticketTransfer.expired`	When a ticket transfer is expired	Link

Scan

Event	Trigger	Payload
`scan.created`	When a scan is created	Link

Subscription

Event	Trigger	Payload
`subscription.created`	When a subscription is created	Link
`subscription.updated`	When a subscription is updated	Link
`subscription.payment.succeeded`	When a subscription payment succeeded	Link
`subscription.payment.failed`	When a subscription payment failed	Link

Bundle

Event	Trigger	Payload
`bundle.created`	When a bundle is created	Link
`bundle.updated`	When a bundle is updated	Link

Product

Event	Trigger	Payload
`product.created`	When a product is created	Link
`product.updated`	When a product is updated	Link
`product.deleted`	When a product is deleted	Link

Webhook Payload

The object posted to your listener server. Each event has an individual data object. Examples of these data objects are listed below.

Required attributes

Name
mode
Type
enum(dev, prod)
Description
The mode of the service sending this webhook

Optional attributes

Name
id
Type
string
Description
The unique ID of the HTTP transmission.
Name
type
Type
enum(transaction.complete, transaction.reservedBySystem, transaction.canceled, transaction.partiallyCanceled, checkout.completed, checkout.aborted, checkout.detailsSubmitted, ticket.created, ticket.updated, purchaseIntent.created, purchaseIntent.approved, purchaseIntent.rejected, purchaseIntent.updated, purchaseIntent.expired, purchaseIntent.completed, purchaseIntent.cancelled, customer.created, customer.updated, event.created, event.updated, event.deleted, job.started, job.failed, job.completed, support.assignedToSeller, ticketTransfer.created, ticketTransfer.rejected, ticketTransfer.transferred, ticketTransfer.expired, scan.created, bundle.created, bundle.updated, product.created, product.updated, product.deleted, subscription.created, subscription.updated, subscription.payment.succeeded, subscription.payment.failed, fund.created, fund.updated, campaign.created, campaign.updated, donation.created, pledge.created)
Description
The event type of the webhook
Name
data
Type
object
Description
The associated data for this webhook

Example

{
  "mode": "dev",
  "id": "507f191e810c19729de860ea",
  "type": "transaction.complete",
  "data": {}
}

transaction.complete

The data of the transaction complete webhook event.

Required attributes

Name
transaction
Type
WebhookTransactionResource
Description
The associated transaction
Required nested attributes (8)
Name
_id
Type
string
Description
The ID of the transaction
Name
sellerId
Type
string
Description
The ID of the seller of the transaction
Name
eventId
Type
string
Description
The ID of the event containing this transaction
Name
realPrice
Type
number float
Description
The calculated real price of the transaction
Name
status
Type
enum(NEW, RESERVED-BY-SYSTEM, ABORTED, COMPLETE, CANCELED)
Description
The status of the transaction.
Name
secret
Type
string
Description
The secret token of the transaction
Name
tid
Type
string
Description
The ID of the transaction
Name
coupons
Type
array<string>
Description
An array of applied coupon codes
Optional nested attributes (59)
Name
customerId
Type
string
Description
The ID of the customer of the transaction
Name
company
Type
string
Description
The company name of the user of the transaction
Name
name
Type
string
Description
The name of the user of the transaction
Name
prename
Type
string
Description
The firstname of the user of the transaction
Name
lastname
Type
string
Description
The lastname of the user of the transaction
Name
email
Type
string email
Description
The email of the user of the transaction
Name
street
Type
string
Description
The street of the user of the transaction
Name
line2
Type
string
Description
The additional address field of the user of the transaction.
Name
city
Type
string
Description
The city of the user of the transaction
Name
state
Type
string
Description
The state of the user of the transaction
Name
country
Type
string
Description
The country of the user of the transaction
Name
postal
Type
string
Description
The postal of the user of the transaction
Name
deliveryAddress
Type
object
Description
The delivery address of the transaction
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
tickets
Type
array<object>
Description
An array of cart ticket items of the transaction
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
products
Type
array<object>
Description
An array of cart product items of the transaction
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
An array of additional price items of the transaction
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
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
An ISO 4217 3-character code of the currency
Name
regularPrice
Type
number float
Description
The regular price of the transaction
Name
paymentCharge
Type
number float
Description
The payment charge of the transaction
Name
innerCharge
Type
number float
Description
The inner charge of the transaction
Name
outerCharge
Type
number float
Description
The outer charge of the transaction
Name
innerFeeComponents
Type
object
Description
The inner fee of the transaction including fix and var fee
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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
outerFeeComponents
Type
object
Description
The outer fee of the transaction including fix and var fee
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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
cancellationFee
Type
object
Description
The cancellation fee of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the fee component.
Optional nested attributes (8)
Name
amount
Type
number float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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
cancellationInfo
Type
object
Description
The cancellation info of the transaction
Optional nested attributes (2)
Name
cancellableItems
Type
array<object>
Description
An array of cancellable items
Required nested attributes (3)
Name
cartItemId
Type
string
Description
The ID of the cart to which the item belongs to
Name
type
Type
enum(ticket, product, fee, discount, fulfillment, insurance)
Description
The type of the item indicated where it originated from
Name
price
Type
number float
Description
The price of the item
Optional nested attributes (6)
Name
name
Type
string
Description
The name of the item
Name
taxRate
Type
number float
Description
The applied tax rate for that item
Name
origin
Type
oneOf
Description
Object indicating where the item originated from
One of — Only one of the following types
Optional attributes
Name
fee
Type
object
Description
The cancellation fee of the item
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the fee component.
Optional nested attributes (8)
Name
amount
Type
number float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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
cancellationFee
Type
object
Description
The cancellation fee of the item. Is set when cancellation fees are charged at cancellation
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the fee component.
Optional nested attributes (8)
Name
amount
Type
number float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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
refundId
Type
string
Description
The ID of the refund. Is set when item was refunded
Name
cancelledAt
Type
string date-time
Description
A date indicating when the item has been cancelled
Name
refundableByTarget
Type
object
Description
Remaining refundable amounts for this transaction, keyed by refund target
Name
taxRate
Type
number float
Description
The tax rate of the transaction
Name
createdAt
Type
string date-time
Description
An ISO timestamp indicating when the transaction was created
Name
updatedAt
Type
string date-time
Description
An ISO Timestamp indicating when the voucher was last updated
Name
psp
Type
string
Description
Name
paymentMethod
Type
enum(paypal, stripe, local, external, vivenu-payments)
Description
The payment method of the transaction.
Name
paymentInfo
Type
object
Description
The payment info of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the payment info
Optional nested attributes (11)
Name
psp
Type
string
Description
Name
gateway
Type
enum(managed, external, local)
Description
The payment gateway of the payment.
Name
providerType
Type
enum(stripeConnect, vivenu)
Description
The payment provider of the payment.
Name
providerId
Type
string
Description
The ID of the provider of the payment
Name
method
Type
string
Description
The method of the payment
Name
methodVariant
Type
string
Description
The method variant of the payment
Name
locale
Type
string
Description
The locale of the payment
Name
riskLevel
Type
string
Description
The risk level of the payment
Name
riskScore
Type
number float
Description
The risk score of the payment
Name
refundId
Type
string
Description
The ID of the refund of the payment
Name
collectedApplicationFee
Type
number float
Description
The application fee of the payment
Name
paymentStatus
Type
enum(AWAITING, PENDING, RECEIVED, REFUND, CANCELED, FAILED, DISPUTE, CHARGEBACK, POS-RECEIVED, POS-CANCELED, LOCAL-PENDING, LOCAL-AWAITING, LOCAL-RECEIVED, EXTERNAL)
Description
The payment status of the transaction.
Name
origin
Type
enum(yourticket, pos, rebooking, upgrade, subscription)
Description
The origin of the transaction.
Name
subscriptionId
Type
string
Description
The ID of the subscription of the transaction
Name
userId
Type
string
Description
The ID of the user who created the transaction.
Name
posId
Type
string
Description
The ID of pos of the transaction
Name
posInfo
Type
object
Description
The POS info of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the POS info
Optional nested attributes (6)
Name
sessionId
Type
string
Description
The ID of the session of the POS
Name
billingNo
Type
string
Description
The billing no of the POS
Name
taxId
Type
string
Description
The tax ID of the POS
Name
paymentMethod
Type
string
Description
The payment method of the POS.
Name
canceledAt
Type
string date-time
Description
The cancellation Date of the POS
Name
cancellationNo
Type
string date-time
Description
The cancellation no of the POS
Name
history
Type
array<object>
Status
deprecated
Description
An array of history entry items of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the transaction history entry
Optional nested attributes (5)
Name
date
Type
string date-time
Description
The date of the history entry
Name
title
Type
string
Description
The title of the history entry
Name
message
Type
string
Description
A message which describes the history entry
Name
type
Type
enum(PAYMENT, YOURTICKET, USER)
Description
The type of the history entry.
Name
risk
Type
enum(DANGER, NEUTRAL, GOOD)
Description
The risk of the transaction history entry. NEUTRAL = is a neutral risk of the transaction. GOOD = is a good risk factor of the transaction, which means less risk. DANGER = is a danger risk factor of the transaction, which means high risk.
Name
historyEntries
Type
array<object>
Description
An array of history entry items of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the transaction history entry
Optional nested attributes (5)
Name
date
Type
string date-time
Description
The date of the history entry
Name
userId
Type
string
Description
The ID of the user of the history entry
Name
data
Type
object
Description
The data of the history entry
Name
type
Type
enum(created, reserved, completed, completed.manually, aborted, canceled, partial.canceled, pos.created, pos.canceled, pos.payment.method.changed, payment.canceled, payment.authorized, payment.failed, payment.succeeded, payment.chargeback, payment.localReceived, dispute.created, dispute.countered, dispute.won, dispute.lost, refunded, partial.refunded, refund.failed, partial.refunded.voucher, refunded.voucher, partial.refunded.balance, refunded.balance, payment.local.added, payment_correction.refund.missing_in_core, payment_correction.refund.failed, payment_correction.payment.failed, price.recalculated, invitation.reserved.mail, transaction.resent.mail, transaction.resent.ticket_mail, transaction.resent.voucher_mail, tickets.booked, transaction.sent.sms, commented)
Description
The type of the history entry.
Name
risk
Type
enum(DANGER, NEUTRAL, GOOD)
Description
The risk of the transaction history entry. NEUTRAL = is a neutral risk of the transaction. GOOD = is a good risk factor of the transaction, which means less risk. DANGER = is a danger risk factor of the transaction, which means high risk.
Name
ticketMailSend
Type
boolean
Description
Whether the mail with the ticket of the transaction was sent
Name
orderMailSend
Type
boolean
Description
Whether the mail with the order of the transaction was sent
Name
extraFields
Type
object
Description
The extra fields of the transaction
Name
channel
Type
string
Description
The channel of the transaction
Name
underShop
Type
string
Description
The under shop of the transaction
Name
userAgent
Type
object
Description
The User Agent of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the User Agent
Optional nested attributes (6)
Name
ua
Type
string
Description
The user agent
Name
browser
Type
object
Description
The browser of the user
Name
device
Type
object
Description
The device of the user
Name
engine
Type
object
Description
The engine of the user
Name
os
Type
object
Description
The OS of the user
Name
cpu
Type
object
Description
The CPU of the user
Name
ipLookup
Type
object
Description
The IP lookup info of the transaction
Optional nested attributes (2)
Name
ip
Type
string
Description
The IP address of the IP lookup info
Name
lookup
Type
object
Description
The IP lookup result
Optional nested attributes (9)
Name
range
Type
array<number>
Description
The Range of the ip adress
Name
country
Type
string
Description
The country of the IP lookup
Name
region
Type
string
Description
The region of the IP lookup
Name
eu
Type
string
Description
Name
timezone
Type
string
Description
The timezone of the IP lookup
Name
city
Type
string
Description
The city city of the IP lookup
Name
ll
Type
array<number>
Description
Name
metro
Type
number float
Description
Name
area
Type
number float
Description
Name
locationCenter
Type
array<number>
Description
Name
vouchers
Type
array<string>
Description
An array of voucher codes applied to this transaction
Name
redeemedVouchers
Type
object
Description
An array of voucher codes redeemed for this transaction
Required nested attributes (1)
Name
totalRedeemedAmount
Type
number float
Description
The sum of all vouchers applied.
Optional nested attributes (1)
Name
vouchers
Type
array<object>
Description
An array of all redeemed vouchers.
Required nested attributes (2)
Name
code
Type
string
Description
The Code of the voucher.
Name
redeemedAmount
Type
number float
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 of applied coupons within the transaction
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
appliedDiscountGroups
Type
array<string>
Description
An array of discount groups applied to the transaction
Name
posDiscounts
Type
array<object>
Description
An array of POS discounts
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the POS discount
Name
name
Type
string
Description
The name of the POS discount
Name
value
Type
number float
Description
The value of the POS discount
Optional nested attributes (1)
Name
discountType
Type
enum(TOTAL, PERCENTAGE, fix, var)
Description
The discount type.
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 preferred language of the transaction. It is determined automatically
Name
cancellationReason
Type
enum(REQUESTED_BY_CUSTOMER, CLAIM, COMMUNICATION_ERROR, TRAINING/TEST)
Description
The reason of the cancellation of the transaction
Name
appliedDiscountInfo
Type
object
Description
Applied discountInfo for the transaction
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 float
Description
The amount of applied discounts.
Name
regularPrice
Type
number float
Description
The regular price before applying the discount.
Name
price
Type
number float
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 float
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 float
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 float
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 float
Description
The maximum amount of items the discount will be applied towards.
Name
maxAbsoluteValue
Type
number float
Description
The maximum absolute value of the discount.
Name
absoluteDiscountValue
Type
number float
Description
The absolute value of the discount.
Name
invoiceVersion
Type
string
Description
The invoice version of the transaction.
Name
seatingReservationToken
Type
string
Description
The seating reservation token of the transaction
Name
paymentInfoMethod
Type
enum(paypal, stripe, local, external, vivenu-payments)
Description
The payment method of the transaction.
Name
tickets
Type
array<TicketResource>
Description
An array of the tickets associated to this transaction
Required nested attributes (10)
Name
_id
Type
string
Description
Name
sellerId
Type
string
Description
The ID of the seller that ticket belongs to.
Name
eventId
Type
string
Description
The ID of the event the ticket belongs to
Name
ticketTypeId
Type
string
Description
The ID of the ticket type this ticket inherits from
Name
ticketName
Type
string
Description
The name of the ticket type this ticket inherits from
Name
createdAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket was created.
Name
updatedAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket was updated.
Name
status
Type
enum(VALID, INVALID, RESERVED, DETAILSREQUIRED, BLANK)
Description
The status of the ticket
Name
secret
Type
string
Description
The secret token of the ticket
Name
barcode
Type
string
Description
The barcode of the ticket
Optional nested attributes (50)
Name
company
Type
string
Description
Name
email
Type
string
Description
Name
name
Type
string
Description
The name of the ticket owner
Name
firstname
Type
string
Description
The first name of the ticket owner
Name
lastname
Type
string
Description
The last name of the ticket owner
Name
street
Type
string
Description
Name
line2
Type
string
Description
The additional address field of the user of the ticket
Name
city
Type
string
Description
Name
postal
Type
string
Description
Name
state
Type
string
Description
The state of the user of the ticket
Name
country
Type
string
Description
The country of the user of the ticket
Name
rootEventId
Type
string
Description
The ID of the root event, if exists
Name
transactionId
Type
string
Description
The transaction the ticket originated from
Name
posId
Type
string
Description
The point of sale the ticket was created on
Name
underShopId
Type
string
Description
The ID of an undershop the ticket was purchased through
Name
categoryRef
Type
string
Description
A UUID of the category the ticket belongs to.
Name
categoryName
Type
string
Description
The name of the category the ticket belongs to.
Name
slotId
Type
string
Description
The ID of the time slot this ticket belongs to, if exists
Name
slotStartTime
Type
string
Description
The start time of the time slot this ticket belongs to, if exists.
Name
cartItemId
Type
string
Description
The ID of the cart item to which the ticket belongs
Name
triggeredBy
Type
array<string>
Description
An array of IDs of cart items which triggered the buy action of the ticket
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
An ISO 4217 3-character code of the currency
Name
regularPrice
Type
number float
Description
The original non discounted price for the ticket
Name
realPrice
Type
number float
Description
The real price for the ticket
Name
completed
Type
boolean
Description
Whether all steps for validating the ticket has been made
Name
expiresAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket will be expired.
Name
seat
Type
string
Description
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
type
Type
enum(SINGLE, MULTI)
Description
The type of the ticket
Name
origin
Type
enum(yourticket, pos, rebooking, upgrade, subscription, transfer)
Description
Name
extraFields
Type
object
Description
A hashmap of extra fields for the ticket
Name
batch
Type
string
Description
A UUId indicating in which batch the tickets were created
Name
batchCounter
Type
number float
Description
A counter indicating the order of the ticket in the batch
Name
deliveryType
Type
enum(HARD, VIRTUAL)
Description
The delivery type of the ticket
Name
readyForDelivery
Type
boolean
Description
Whether the ticket is ready for delivery
Name
customMessage
Type
string
Description
Name
priceCategoryId
Type
string
Description
Name
entryPermissions
Type
array<array | boolean | number | object | string>
Description
Name
customerId
Type
string
Description
Name
history
Type
array<array | boolean | number | object | string>
Description
Name
personalized
Type
boolean
Description
Name
excludedEventIds
Type
array<string>
Description
An array of IDs of events for which the ticket has been blocked
Name
originTicketId
Type
string
Description
The ID of the origin ticket from which the ticket created
Name
fulfillmentTypeId
Type
string
Description
The ID of the fulfillment type used to deliver the ticket
Name
packageInfo
Type
object
Description
The package information of the ticket
Required nested attributes (3)
Name
packageId
Type
string
Description
The ID of the package
Name
packageConfigId
Type
string
Description
The ID of the package configuration
Name
name
Type
string
Description
The name of the package
Name
__v
Type
integer
Description
Name
_locks
Type
array<object>
Description
List of locks on this ticket
Required nested attributes (2)
Name
by
Type
string
Description
Name
at
Type
string date-time
Description
Optional nested attributes (2)
Name
eventId
Type
string
Description
Name
type
Type
enum(resell)
Description
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
personalizations
Type
array<array | boolean | number | object | string>
Description
A list of personalizations of the ticket.

Example

{
  "transaction": {
    "_id": "507f191e810c19729de860ea",
    "sellerId": "507f191e810c19729de860ea",
    "eventId": "507f191e810c19729de860ea",
    "realPrice": 10.5,
    "status": "NEW",
    "secret": "4b5fb736-45fd-4895-b497-124a2360c7e6",
    "tid": "string",
    "coupons": [
      "string"
    ],
    "customerId": "507f191e810c19729de860ea",
    "company": "vivenu GmbH",
    "name": "Some fancy Name",
    "prename": "John",
    "lastname": "Robot",
    "email": "random@mail.com",
    "street": "Speditionsstr",
    "line2": "string",
    "city": "Düsseldorf",
    "state": "string",
    "country": "DE",
    "postal": "40221",
    "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"
      }
    ],
    "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"
            }
          ]
        }
      }
    ],
    "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"
        }
      }
    ],
    "currency": "EUR",
    "regularPrice": 10.5,
    "paymentCharge": 10.5,
    "innerCharge": 10.5,
    "outerCharge": 10.5,
    "innerFeeComponents": {
      "_id": "507f191e810c19729de860ea",
      "fix": [
        {
          "_id": "507f191e810c19729de860ea",
          "amount": 10.5,
          "value": 10.5,
          "total": 10.5,
          "type": "onTicket",
          "name": "Some fancy 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": "Some fancy Name",
          "publicName": "string",
          "exposed": true,
          "scheme": {
            "schemeId": "507f191e810c19729de860ea",
            "feeId": "507f191e810c19729de860ea"
          }
        }
      ]
    },
    "outerFeeComponents": {
      "_id": "507f191e810c19729de860ea",
      "fix": [
        {
          "_id": "507f191e810c19729de860ea",
          "amount": 10.5,
          "value": 10.5,
          "total": 10.5,
          "type": "onTicket",
          "name": "Some fancy 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": "Some fancy Name",
          "publicName": "string",
          "exposed": true,
          "scheme": {
            "schemeId": "507f191e810c19729de860ea",
            "feeId": "507f191e810c19729de860ea"
          }
        }
      ]
    },
    "cancellationFee": {
      "_id": "507f191e810c19729de860ea",
      "amount": 10.5,
      "value": 10.5,
      "total": 10.5,
      "type": "onTicket",
      "name": "Some fancy Name",
      "publicName": "string",
      "exposed": true,
      "scheme": {
        "schemeId": "507f191e810c19729de860ea",
        "feeId": "507f191e810c19729de860ea"
      }
    },
    "cancellationInfo": {
      "cancellableItems": [
        {
          "cartItemId": "507f191e810c19729de860ea",
          "type": "ticket",
          "price": 10.5,
          "name": "Some fancy Name",
          "taxRate": 10.5,
          "origin": {
            "fee": {
              "_id": "507f191e810c19729de860ea",
              "amount": 10.5,
              "value": 10.5,
              "total": 10.5,
              "type": "onTicket",
              "name": "Some fancy Name",
              "publicName": "string",
              "exposed": true,
              "scheme": {
                "schemeId": "507f191e810c19729de860ea",
                "feeId": "507f191e810c19729de860ea"
              }
            }
          },
          "cancellationFee": {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Some fancy Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          },
          "refundId": "507f191e810c19729de860ea",
          "cancelledAt": "2030-01-23T23:00:00.123Z"
        }
      ],
      "refundableByTarget": {}
    },
    "taxRate": 0.19,
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z",
    "psp": "string",
    "paymentMethod": "paypal",
    "paymentInfo": {
      "_id": "507f191e810c19729de860ea",
      "psp": "string",
      "gateway": "managed",
      "providerType": "vivenu",
      "providerId": "507f191e810c19729de860ea",
      "method": "string",
      "methodVariant": "string",
      "locale": "string",
      "riskLevel": "string",
      "riskScore": 10.5,
      "refundId": "507f191e810c19729de860ea",
      "collectedApplicationFee": 10.5
    },
    "paymentStatus": "AWAITING",
    "origin": "yourticket",
    "subscriptionId": "507f191e810c19729de860ea",
    "userId": "507f191e810c19729de860ea",
    "posId": "507f191e810c19729de860ea",
    "posInfo": {
      "_id": "507f191e810c19729de860ea",
      "sessionId": "507f191e810c19729de860ea",
      "billingNo": "string",
      "taxId": "507f191e810c19729de860ea",
      "paymentMethod": "string",
      "canceledAt": "2030-01-23T23:00:00.123Z",
      "cancellationNo": "2030-01-23T23:00:00.123Z"
    },
    "history": [
      {
        "_id": "507f191e810c19729de860ea",
        "date": "2030-01-23T23:00:00.123Z",
        "title": "string",
        "message": "string",
        "type": "YOURTICKET",
        "risk": "NEUTRAL"
      }
    ],
    "historyEntries": [
      {
        "_id": "507f191e810c19729de860ea",
        "date": "2030-01-23T23:00:00.123Z",
        "userId": "507f191e810c19729de860ea",
        "data": {},
        "type": "created",
        "risk": "NEUTRAL"
      }
    ],
    "ticketMailSend": true,
    "orderMailSend": true,
    "extraFields": {},
    "channel": "string",
    "underShop": "string",
    "userAgent": {
      "_id": "507f191e810c19729de860ea",
      "ua": "string",
      "browser": {},
      "device": {},
      "engine": {},
      "os": {},
      "cpu": {}
    },
    "ipLookup": {
      "ip": "string",
      "lookup": {
        "range": [
          10.5
        ],
        "country": "DE",
        "region": "string",
        "eu": "string",
        "timezone": "string",
        "city": "Düsseldorf",
        "ll": [
          10.5
        ],
        "metro": 10.5,
        "area": 10.5
      }
    },
    "locationCenter": [
      10.5
    ],
    "vouchers": [
      "string"
    ],
    "redeemedVouchers": {
      "totalRedeemedAmount": 10.5,
      "vouchers": [
        {
          "code": "string",
          "redeemedAmount": 10.5,
          "_id": "507f191e810c19729de860ea"
        }
      ]
    },
    "appliedCoupons": [
      {
        "_id": "507f191e810c19729de860ea",
        "code": "string"
      }
    ],
    "appliedDiscountGroups": [
      "string"
    ],
    "posDiscounts": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "value": 10.5,
        "discountType": "fix"
      }
    ],
    "preferredLanguage": "de",
    "cancellationReason": "REQUESTED_BY_CUSTOMER",
    "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": "Some fancy Name",
              "value": 10.5,
              "allowedItems": [
                "string"
              ]
            }
          ],
          "fixDiscounts": [
            {
              "_id": "507f191e810c19729de860ea",
              "type": "fix",
              "discountId": "507f191e810c19729de860ea",
              "category": "coupon",
              "name": "Some fancy Name",
              "value": 10.5,
              "allowedItems": [
                "string"
              ]
            }
          ]
        }
      ],
      "discounts": [
        {
          "_id": "507f191e810c19729de860ea",
          "type": "fix",
          "discountId": "507f191e810c19729de860ea",
          "category": "coupon",
          "name": "Some fancy Name",
          "value": 10.5,
          "allowedItems": [
            "string"
          ],
          "maxItemsInCart": 10.5,
          "maxAbsoluteValue": 10.5,
          "absoluteDiscountValue": 10.5
        }
      ]
    },
    "invoiceVersion": "v2",
    "seatingReservationToken": "string",
    "paymentInfoMethod": "paypal"
  },
  "tickets": [
    {
      "_id": "507f191e810c19729de860ea",
      "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": "4b5fb736-45fd-4895-b497-124a2360c7e6",
      "barcode": "wbf7tkmy",
      "company": "vivenu GmbH",
      "email": "string",
      "name": "Some fancy Name",
      "firstname": "string",
      "lastname": "Robot",
      "street": "Speditionsstr",
      "line2": "string",
      "city": "Düsseldorf",
      "postal": "40221",
      "state": "string",
      "country": "DE",
      "rootEventId": "507f191e810c19729de860ea",
      "transactionId": "507f191e810c19729de860ea",
      "posId": "507f191e810c19729de860ea",
      "underShopId": "507f191e810c19729de860ea",
      "categoryRef": "string",
      "categoryName": "string",
      "slotId": "507f191e810c19729de860ea",
      "slotStartTime": "string",
      "cartItemId": "507f191e810c19729de860ea",
      "triggeredBy": [
        "string"
      ],
      "currency": "EUR",
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "completed": true,
      "expiresAt": "2030-01-23T23:00:00.123Z",
      "seat": "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"
      },
      "type": "SINGLE",
      "origin": "yourticket",
      "extraFields": {},
      "batch": "string",
      "batchCounter": 10.5,
      "deliveryType": "HARD",
      "readyForDelivery": true,
      "customMessage": "string",
      "priceCategoryId": "507f191e810c19729de860ea",
      "entryPermissions": [
        []
      ],
      "customerId": "507f191e810c19729de860ea",
      "history": [
        []
      ],
      "personalized": true,
      "excludedEventIds": [
        "string"
      ],
      "originTicketId": "507f191e810c19729de860ea",
      "fulfillmentTypeId": "507f191e810c19729de860ea",
      "packageInfo": {
        "packageId": "507f191e810c19729de860ea",
        "packageConfigId": "507f191e810c19729de860ea",
        "name": "Some fancy Name"
      },
      "__v": 1,
      "_locks": [
        {
          "by": "string",
          "at": "2030-01-23T23:00:00.123Z",
          "eventId": "507f191e810c19729de860ea",
          "type": "resell"
        }
      ],
      "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
          }
        }
      ],
      "personalizations": [
        []
      ]
    }
  ]
}

transaction.reservedBySystem

The data of the transaction reserved by system webhook event.

Required attributes

Name
transaction
Type
WebhookTransactionResource
Description
The associated transaction
Required nested attributes (8)
Name
_id
Type
string
Description
The ID of the transaction
Name
sellerId
Type
string
Description
The ID of the seller of the transaction
Name
eventId
Type
string
Description
The ID of the event containing this transaction
Name
realPrice
Type
number float
Description
The calculated real price of the transaction
Name
status
Type
enum(NEW, RESERVED-BY-SYSTEM, ABORTED, COMPLETE, CANCELED)
Description
The status of the transaction.
Name
secret
Type
string
Description
The secret token of the transaction
Name
tid
Type
string
Description
The ID of the transaction
Name
coupons
Type
array<string>
Description
An array of applied coupon codes
Optional nested attributes (59)
Name
customerId
Type
string
Description
The ID of the customer of the transaction
Name
company
Type
string
Description
The company name of the user of the transaction
Name
name
Type
string
Description
The name of the user of the transaction
Name
prename
Type
string
Description
The firstname of the user of the transaction
Name
lastname
Type
string
Description
The lastname of the user of the transaction
Name
email
Type
string email
Description
The email of the user of the transaction
Name
street
Type
string
Description
The street of the user of the transaction
Name
line2
Type
string
Description
The additional address field of the user of the transaction.
Name
city
Type
string
Description
The city of the user of the transaction
Name
state
Type
string
Description
The state of the user of the transaction
Name
country
Type
string
Description
The country of the user of the transaction
Name
postal
Type
string
Description
The postal of the user of the transaction
Name
deliveryAddress
Type
object
Description
The delivery address of the transaction
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
tickets
Type
array<object>
Description
An array of cart ticket items of the transaction
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
products
Type
array<object>
Description
An array of cart product items of the transaction
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
An array of additional price items of the transaction
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
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
An ISO 4217 3-character code of the currency
Name
regularPrice
Type
number float
Description
The regular price of the transaction
Name
paymentCharge
Type
number float
Description
The payment charge of the transaction
Name
innerCharge
Type
number float
Description
The inner charge of the transaction
Name
outerCharge
Type
number float
Description
The outer charge of the transaction
Name
innerFeeComponents
Type
object
Description
The inner fee of the transaction including fix and var fee
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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
outerFeeComponents
Type
object
Description
The outer fee of the transaction including fix and var fee
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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
cancellationFee
Type
object
Description
The cancellation fee of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the fee component.
Optional nested attributes (8)
Name
amount
Type
number float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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
cancellationInfo
Type
object
Description
The cancellation info of the transaction
Optional nested attributes (2)
Name
cancellableItems
Type
array<object>
Description
An array of cancellable items
Required nested attributes (3)
Name
cartItemId
Type
string
Description
The ID of the cart to which the item belongs to
Name
type
Type
enum(ticket, product, fee, discount, fulfillment, insurance)
Description
The type of the item indicated where it originated from
Name
price
Type
number float
Description
The price of the item
Optional nested attributes (6)
Name
name
Type
string
Description
The name of the item
Name
taxRate
Type
number float
Description
The applied tax rate for that item
Name
origin
Type
oneOf
Description
Object indicating where the item originated from
One of — Only one of the following types
Optional attributes
Name
fee
Type
object
Description
The cancellation fee of the item
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the fee component.
Optional nested attributes (8)
Name
amount
Type
number float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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
cancellationFee
Type
object
Description
The cancellation fee of the item. Is set when cancellation fees are charged at cancellation
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the fee component.
Optional nested attributes (8)
Name
amount
Type
number float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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
refundId
Type
string
Description
The ID of the refund. Is set when item was refunded
Name
cancelledAt
Type
string date-time
Description
A date indicating when the item has been cancelled
Name
refundableByTarget
Type
object
Description
Remaining refundable amounts for this transaction, keyed by refund target
Name
taxRate
Type
number float
Description
The tax rate of the transaction
Name
createdAt
Type
string date-time
Description
An ISO timestamp indicating when the transaction was created
Name
updatedAt
Type
string date-time
Description
An ISO Timestamp indicating when the voucher was last updated
Name
psp
Type
string
Description
Name
paymentMethod
Type
enum(paypal, stripe, local, external, vivenu-payments)
Description
The payment method of the transaction.
Name
paymentInfo
Type
object
Description
The payment info of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the payment info
Optional nested attributes (11)
Name
psp
Type
string
Description
Name
gateway
Type
enum(managed, external, local)
Description
The payment gateway of the payment.
Name
providerType
Type
enum(stripeConnect, vivenu)
Description
The payment provider of the payment.
Name
providerId
Type
string
Description
The ID of the provider of the payment
Name
method
Type
string
Description
The method of the payment
Name
methodVariant
Type
string
Description
The method variant of the payment
Name
locale
Type
string
Description
The locale of the payment
Name
riskLevel
Type
string
Description
The risk level of the payment
Name
riskScore
Type
number float
Description
The risk score of the payment
Name
refundId
Type
string
Description
The ID of the refund of the payment
Name
collectedApplicationFee
Type
number float
Description
The application fee of the payment
Name
paymentStatus
Type
enum(AWAITING, PENDING, RECEIVED, REFUND, CANCELED, FAILED, DISPUTE, CHARGEBACK, POS-RECEIVED, POS-CANCELED, LOCAL-PENDING, LOCAL-AWAITING, LOCAL-RECEIVED, EXTERNAL)
Description
The payment status of the transaction.
Name
origin
Type
enum(yourticket, pos, rebooking, upgrade, subscription)
Description
The origin of the transaction.
Name
subscriptionId
Type
string
Description
The ID of the subscription of the transaction
Name
userId
Type
string
Description
The ID of the user who created the transaction.
Name
posId
Type
string
Description
The ID of pos of the transaction
Name
posInfo
Type
object
Description
The POS info of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the POS info
Optional nested attributes (6)
Name
sessionId
Type
string
Description
The ID of the session of the POS
Name
billingNo
Type
string
Description
The billing no of the POS
Name
taxId
Type
string
Description
The tax ID of the POS
Name
paymentMethod
Type
string
Description
The payment method of the POS.
Name
canceledAt
Type
string date-time
Description
The cancellation Date of the POS
Name
cancellationNo
Type
string date-time
Description
The cancellation no of the POS
Name
history
Type
array<object>
Status
deprecated
Description
An array of history entry items of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the transaction history entry
Optional nested attributes (5)
Name
date
Type
string date-time
Description
The date of the history entry
Name
title
Type
string
Description
The title of the history entry
Name
message
Type
string
Description
A message which describes the history entry
Name
type
Type
enum(PAYMENT, YOURTICKET, USER)
Description
The type of the history entry.
Name
risk
Type
enum(DANGER, NEUTRAL, GOOD)
Description
The risk of the transaction history entry. NEUTRAL = is a neutral risk of the transaction. GOOD = is a good risk factor of the transaction, which means less risk. DANGER = is a danger risk factor of the transaction, which means high risk.
Name
historyEntries
Type
array<object>
Description
An array of history entry items of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the transaction history entry
Optional nested attributes (5)
Name
date
Type
string date-time
Description
The date of the history entry
Name
userId
Type
string
Description
The ID of the user of the history entry
Name
data
Type
object
Description
The data of the history entry
Name
type
Type
enum(created, reserved, completed, completed.manually, aborted, canceled, partial.canceled, pos.created, pos.canceled, pos.payment.method.changed, payment.canceled, payment.authorized, payment.failed, payment.succeeded, payment.chargeback, payment.localReceived, dispute.created, dispute.countered, dispute.won, dispute.lost, refunded, partial.refunded, refund.failed, partial.refunded.voucher, refunded.voucher, partial.refunded.balance, refunded.balance, payment.local.added, payment_correction.refund.missing_in_core, payment_correction.refund.failed, payment_correction.payment.failed, price.recalculated, invitation.reserved.mail, transaction.resent.mail, transaction.resent.ticket_mail, transaction.resent.voucher_mail, tickets.booked, transaction.sent.sms, commented)
Description
The type of the history entry.
Name
risk
Type
enum(DANGER, NEUTRAL, GOOD)
Description
The risk of the transaction history entry. NEUTRAL = is a neutral risk of the transaction. GOOD = is a good risk factor of the transaction, which means less risk. DANGER = is a danger risk factor of the transaction, which means high risk.
Name
ticketMailSend
Type
boolean
Description
Whether the mail with the ticket of the transaction was sent
Name
orderMailSend
Type
boolean
Description
Whether the mail with the order of the transaction was sent
Name
extraFields
Type
object
Description
The extra fields of the transaction
Name
channel
Type
string
Description
The channel of the transaction
Name
underShop
Type
string
Description
The under shop of the transaction
Name
userAgent
Type
object
Description
The User Agent of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the User Agent
Optional nested attributes (6)
Name
ua
Type
string
Description
The user agent
Name
browser
Type
object
Description
The browser of the user
Name
device
Type
object
Description
The device of the user
Name
engine
Type
object
Description
The engine of the user
Name
os
Type
object
Description
The OS of the user
Name
cpu
Type
object
Description
The CPU of the user
Name
ipLookup
Type
object
Description
The IP lookup info of the transaction
Optional nested attributes (2)
Name
ip
Type
string
Description
The IP address of the IP lookup info
Name
lookup
Type
object
Description
The IP lookup result
Optional nested attributes (9)
Name
range
Type
array<number>
Description
The Range of the ip adress
Name
country
Type
string
Description
The country of the IP lookup
Name
region
Type
string
Description
The region of the IP lookup
Name
eu
Type
string
Description
Name
timezone
Type
string
Description
The timezone of the IP lookup
Name
city
Type
string
Description
The city city of the IP lookup
Name
ll
Type
array<number>
Description
Name
metro
Type
number float
Description
Name
area
Type
number float
Description
Name
locationCenter
Type
array<number>
Description
Name
vouchers
Type
array<string>
Description
An array of voucher codes applied to this transaction
Name
redeemedVouchers
Type
object
Description
An array of voucher codes redeemed for this transaction
Required nested attributes (1)
Name
totalRedeemedAmount
Type
number float
Description
The sum of all vouchers applied.
Optional nested attributes (1)
Name
vouchers
Type
array<object>
Description
An array of all redeemed vouchers.
Required nested attributes (2)
Name
code
Type
string
Description
The Code of the voucher.
Name
redeemedAmount
Type
number float
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 of applied coupons within the transaction
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
appliedDiscountGroups
Type
array<string>
Description
An array of discount groups applied to the transaction
Name
posDiscounts
Type
array<object>
Description
An array of POS discounts
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the POS discount
Name
name
Type
string
Description
The name of the POS discount
Name
value
Type
number float
Description
The value of the POS discount
Optional nested attributes (1)
Name
discountType
Type
enum(TOTAL, PERCENTAGE, fix, var)
Description
The discount type.
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 preferred language of the transaction. It is determined automatically
Name
cancellationReason
Type
enum(REQUESTED_BY_CUSTOMER, CLAIM, COMMUNICATION_ERROR, TRAINING/TEST)
Description
The reason of the cancellation of the transaction
Name
appliedDiscountInfo
Type
object
Description
Applied discountInfo for the transaction
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 float
Description
The amount of applied discounts.
Name
regularPrice
Type
number float
Description
The regular price before applying the discount.
Name
price
Type
number float
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 float
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 float
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 float
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 float
Description
The maximum amount of items the discount will be applied towards.
Name
maxAbsoluteValue
Type
number float
Description
The maximum absolute value of the discount.
Name
absoluteDiscountValue
Type
number float
Description
The absolute value of the discount.
Name
invoiceVersion
Type
string
Description
The invoice version of the transaction.
Name
seatingReservationToken
Type
string
Description
The seating reservation token of the transaction
Name
paymentInfoMethod
Type
enum(paypal, stripe, local, external, vivenu-payments)
Description
The payment method of the transaction.
Name
tickets
Type
array<TicketResource>
Description
An array of the tickets associated to this transaction
Required nested attributes (10)
Name
_id
Type
string
Description
Name
sellerId
Type
string
Description
The ID of the seller that ticket belongs to.
Name
eventId
Type
string
Description
The ID of the event the ticket belongs to
Name
ticketTypeId
Type
string
Description
The ID of the ticket type this ticket inherits from
Name
ticketName
Type
string
Description
The name of the ticket type this ticket inherits from
Name
createdAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket was created.
Name
updatedAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket was updated.
Name
status
Type
enum(VALID, INVALID, RESERVED, DETAILSREQUIRED, BLANK)
Description
The status of the ticket
Name
secret
Type
string
Description
The secret token of the ticket
Name
barcode
Type
string
Description
The barcode of the ticket
Optional nested attributes (50)
Name
company
Type
string
Description
Name
email
Type
string
Description
Name
name
Type
string
Description
The name of the ticket owner
Name
firstname
Type
string
Description
The first name of the ticket owner
Name
lastname
Type
string
Description
The last name of the ticket owner
Name
street
Type
string
Description
Name
line2
Type
string
Description
The additional address field of the user of the ticket
Name
city
Type
string
Description
Name
postal
Type
string
Description
Name
state
Type
string
Description
The state of the user of the ticket
Name
country
Type
string
Description
The country of the user of the ticket
Name
rootEventId
Type
string
Description
The ID of the root event, if exists
Name
transactionId
Type
string
Description
The transaction the ticket originated from
Name
posId
Type
string
Description
The point of sale the ticket was created on
Name
underShopId
Type
string
Description
The ID of an undershop the ticket was purchased through
Name
categoryRef
Type
string
Description
A UUID of the category the ticket belongs to.
Name
categoryName
Type
string
Description
The name of the category the ticket belongs to.
Name
slotId
Type
string
Description
The ID of the time slot this ticket belongs to, if exists
Name
slotStartTime
Type
string
Description
The start time of the time slot this ticket belongs to, if exists.
Name
cartItemId
Type
string
Description
The ID of the cart item to which the ticket belongs
Name
triggeredBy
Type
array<string>
Description
An array of IDs of cart items which triggered the buy action of the ticket
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
An ISO 4217 3-character code of the currency
Name
regularPrice
Type
number float
Description
The original non discounted price for the ticket
Name
realPrice
Type
number float
Description
The real price for the ticket
Name
completed
Type
boolean
Description
Whether all steps for validating the ticket has been made
Name
expiresAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket will be expired.
Name
seat
Type
string
Description
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
type
Type
enum(SINGLE, MULTI)
Description
The type of the ticket
Name
origin
Type
enum(yourticket, pos, rebooking, upgrade, subscription, transfer)
Description
Name
extraFields
Type
object
Description
A hashmap of extra fields for the ticket
Name
batch
Type
string
Description
A UUId indicating in which batch the tickets were created
Name
batchCounter
Type
number float
Description
A counter indicating the order of the ticket in the batch
Name
deliveryType
Type
enum(HARD, VIRTUAL)
Description
The delivery type of the ticket
Name
readyForDelivery
Type
boolean
Description
Whether the ticket is ready for delivery
Name
customMessage
Type
string
Description
Name
priceCategoryId
Type
string
Description
Name
entryPermissions
Type
array<array | boolean | number | object | string>
Description
Name
customerId
Type
string
Description
Name
history
Type
array<array | boolean | number | object | string>
Description
Name
personalized
Type
boolean
Description
Name
excludedEventIds
Type
array<string>
Description
An array of IDs of events for which the ticket has been blocked
Name
originTicketId
Type
string
Description
The ID of the origin ticket from which the ticket created
Name
fulfillmentTypeId
Type
string
Description
The ID of the fulfillment type used to deliver the ticket
Name
packageInfo
Type
object
Description
The package information of the ticket
Required nested attributes (3)
Name
packageId
Type
string
Description
The ID of the package
Name
packageConfigId
Type
string
Description
The ID of the package configuration
Name
name
Type
string
Description
The name of the package
Name
__v
Type
integer
Description
Name
_locks
Type
array<object>
Description
List of locks on this ticket
Required nested attributes (2)
Name
by
Type
string
Description
Name
at
Type
string date-time
Description
Optional nested attributes (2)
Name
eventId
Type
string
Description
Name
type
Type
enum(resell)
Description
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
personalizations
Type
array<array | boolean | number | object | string>
Description
A list of personalizations of the ticket.

Example

{
  "transaction": {
    "_id": "507f191e810c19729de860ea",
    "sellerId": "507f191e810c19729de860ea",
    "eventId": "507f191e810c19729de860ea",
    "realPrice": 10.5,
    "status": "NEW",
    "secret": "4b5fb736-45fd-4895-b497-124a2360c7e6",
    "tid": "string",
    "coupons": [
      "string"
    ],
    "customerId": "507f191e810c19729de860ea",
    "company": "vivenu GmbH",
    "name": "Some fancy Name",
    "prename": "John",
    "lastname": "Robot",
    "email": "random@mail.com",
    "street": "Speditionsstr",
    "line2": "string",
    "city": "Düsseldorf",
    "state": "string",
    "country": "DE",
    "postal": "40221",
    "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"
      }
    ],
    "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"
            }
          ]
        }
      }
    ],
    "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"
        }
      }
    ],
    "currency": "EUR",
    "regularPrice": 10.5,
    "paymentCharge": 10.5,
    "innerCharge": 10.5,
    "outerCharge": 10.5,
    "innerFeeComponents": {
      "_id": "507f191e810c19729de860ea",
      "fix": [
        {
          "_id": "507f191e810c19729de860ea",
          "amount": 10.5,
          "value": 10.5,
          "total": 10.5,
          "type": "onTicket",
          "name": "Some fancy 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": "Some fancy Name",
          "publicName": "string",
          "exposed": true,
          "scheme": {
            "schemeId": "507f191e810c19729de860ea",
            "feeId": "507f191e810c19729de860ea"
          }
        }
      ]
    },
    "outerFeeComponents": {
      "_id": "507f191e810c19729de860ea",
      "fix": [
        {
          "_id": "507f191e810c19729de860ea",
          "amount": 10.5,
          "value": 10.5,
          "total": 10.5,
          "type": "onTicket",
          "name": "Some fancy 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": "Some fancy Name",
          "publicName": "string",
          "exposed": true,
          "scheme": {
            "schemeId": "507f191e810c19729de860ea",
            "feeId": "507f191e810c19729de860ea"
          }
        }
      ]
    },
    "cancellationFee": {
      "_id": "507f191e810c19729de860ea",
      "amount": 10.5,
      "value": 10.5,
      "total": 10.5,
      "type": "onTicket",
      "name": "Some fancy Name",
      "publicName": "string",
      "exposed": true,
      "scheme": {
        "schemeId": "507f191e810c19729de860ea",
        "feeId": "507f191e810c19729de860ea"
      }
    },
    "cancellationInfo": {
      "cancellableItems": [
        {
          "cartItemId": "507f191e810c19729de860ea",
          "type": "ticket",
          "price": 10.5,
          "name": "Some fancy Name",
          "taxRate": 10.5,
          "origin": {
            "fee": {
              "_id": "507f191e810c19729de860ea",
              "amount": 10.5,
              "value": 10.5,
              "total": 10.5,
              "type": "onTicket",
              "name": "Some fancy Name",
              "publicName": "string",
              "exposed": true,
              "scheme": {
                "schemeId": "507f191e810c19729de860ea",
                "feeId": "507f191e810c19729de860ea"
              }
            }
          },
          "cancellationFee": {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Some fancy Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          },
          "refundId": "507f191e810c19729de860ea",
          "cancelledAt": "2030-01-23T23:00:00.123Z"
        }
      ],
      "refundableByTarget": {}
    },
    "taxRate": 0.19,
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z",
    "psp": "string",
    "paymentMethod": "paypal",
    "paymentInfo": {
      "_id": "507f191e810c19729de860ea",
      "psp": "string",
      "gateway": "managed",
      "providerType": "vivenu",
      "providerId": "507f191e810c19729de860ea",
      "method": "string",
      "methodVariant": "string",
      "locale": "string",
      "riskLevel": "string",
      "riskScore": 10.5,
      "refundId": "507f191e810c19729de860ea",
      "collectedApplicationFee": 10.5
    },
    "paymentStatus": "AWAITING",
    "origin": "yourticket",
    "subscriptionId": "507f191e810c19729de860ea",
    "userId": "507f191e810c19729de860ea",
    "posId": "507f191e810c19729de860ea",
    "posInfo": {
      "_id": "507f191e810c19729de860ea",
      "sessionId": "507f191e810c19729de860ea",
      "billingNo": "string",
      "taxId": "507f191e810c19729de860ea",
      "paymentMethod": "string",
      "canceledAt": "2030-01-23T23:00:00.123Z",
      "cancellationNo": "2030-01-23T23:00:00.123Z"
    },
    "history": [
      {
        "_id": "507f191e810c19729de860ea",
        "date": "2030-01-23T23:00:00.123Z",
        "title": "string",
        "message": "string",
        "type": "YOURTICKET",
        "risk": "NEUTRAL"
      }
    ],
    "historyEntries": [
      {
        "_id": "507f191e810c19729de860ea",
        "date": "2030-01-23T23:00:00.123Z",
        "userId": "507f191e810c19729de860ea",
        "data": {},
        "type": "created",
        "risk": "NEUTRAL"
      }
    ],
    "ticketMailSend": true,
    "orderMailSend": true,
    "extraFields": {},
    "channel": "string",
    "underShop": "string",
    "userAgent": {
      "_id": "507f191e810c19729de860ea",
      "ua": "string",
      "browser": {},
      "device": {},
      "engine": {},
      "os": {},
      "cpu": {}
    },
    "ipLookup": {
      "ip": "string",
      "lookup": {
        "range": [
          10.5
        ],
        "country": "DE",
        "region": "string",
        "eu": "string",
        "timezone": "string",
        "city": "Düsseldorf",
        "ll": [
          10.5
        ],
        "metro": 10.5,
        "area": 10.5
      }
    },
    "locationCenter": [
      10.5
    ],
    "vouchers": [
      "string"
    ],
    "redeemedVouchers": {
      "totalRedeemedAmount": 10.5,
      "vouchers": [
        {
          "code": "string",
          "redeemedAmount": 10.5,
          "_id": "507f191e810c19729de860ea"
        }
      ]
    },
    "appliedCoupons": [
      {
        "_id": "507f191e810c19729de860ea",
        "code": "string"
      }
    ],
    "appliedDiscountGroups": [
      "string"
    ],
    "posDiscounts": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "value": 10.5,
        "discountType": "fix"
      }
    ],
    "preferredLanguage": "de",
    "cancellationReason": "REQUESTED_BY_CUSTOMER",
    "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": "Some fancy Name",
              "value": 10.5,
              "allowedItems": [
                "string"
              ]
            }
          ],
          "fixDiscounts": [
            {
              "_id": "507f191e810c19729de860ea",
              "type": "fix",
              "discountId": "507f191e810c19729de860ea",
              "category": "coupon",
              "name": "Some fancy Name",
              "value": 10.5,
              "allowedItems": [
                "string"
              ]
            }
          ]
        }
      ],
      "discounts": [
        {
          "_id": "507f191e810c19729de860ea",
          "type": "fix",
          "discountId": "507f191e810c19729de860ea",
          "category": "coupon",
          "name": "Some fancy Name",
          "value": 10.5,
          "allowedItems": [
            "string"
          ],
          "maxItemsInCart": 10.5,
          "maxAbsoluteValue": 10.5,
          "absoluteDiscountValue": 10.5
        }
      ]
    },
    "invoiceVersion": "v2",
    "seatingReservationToken": "string",
    "paymentInfoMethod": "paypal"
  },
  "tickets": [
    {
      "_id": "507f191e810c19729de860ea",
      "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": "4b5fb736-45fd-4895-b497-124a2360c7e6",
      "barcode": "wbf7tkmy",
      "company": "vivenu GmbH",
      "email": "string",
      "name": "Some fancy Name",
      "firstname": "string",
      "lastname": "Robot",
      "street": "Speditionsstr",
      "line2": "string",
      "city": "Düsseldorf",
      "postal": "40221",
      "state": "string",
      "country": "DE",
      "rootEventId": "507f191e810c19729de860ea",
      "transactionId": "507f191e810c19729de860ea",
      "posId": "507f191e810c19729de860ea",
      "underShopId": "507f191e810c19729de860ea",
      "categoryRef": "string",
      "categoryName": "string",
      "slotId": "507f191e810c19729de860ea",
      "slotStartTime": "string",
      "cartItemId": "507f191e810c19729de860ea",
      "triggeredBy": [
        "string"
      ],
      "currency": "EUR",
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "completed": true,
      "expiresAt": "2030-01-23T23:00:00.123Z",
      "seat": "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"
      },
      "type": "SINGLE",
      "origin": "yourticket",
      "extraFields": {},
      "batch": "string",
      "batchCounter": 10.5,
      "deliveryType": "HARD",
      "readyForDelivery": true,
      "customMessage": "string",
      "priceCategoryId": "507f191e810c19729de860ea",
      "entryPermissions": [
        []
      ],
      "customerId": "507f191e810c19729de860ea",
      "history": [
        []
      ],
      "personalized": true,
      "excludedEventIds": [
        "string"
      ],
      "originTicketId": "507f191e810c19729de860ea",
      "fulfillmentTypeId": "507f191e810c19729de860ea",
      "packageInfo": {
        "packageId": "507f191e810c19729de860ea",
        "packageConfigId": "507f191e810c19729de860ea",
        "name": "Some fancy Name"
      },
      "__v": 1,
      "_locks": [
        {
          "by": "string",
          "at": "2030-01-23T23:00:00.123Z",
          "eventId": "507f191e810c19729de860ea",
          "type": "resell"
        }
      ],
      "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
          }
        }
      ],
      "personalizations": [
        []
      ]
    }
  ]
}

transaction.canceled

The data of the transaction canceled webhook event.

Required attributes

Name
transaction
Type
WebhookTransactionResource
Description
The associated transaction
Required nested attributes (8)
Name
_id
Type
string
Description
The ID of the transaction
Name
sellerId
Type
string
Description
The ID of the seller of the transaction
Name
eventId
Type
string
Description
The ID of the event containing this transaction
Name
realPrice
Type
number float
Description
The calculated real price of the transaction
Name
status
Type
enum(NEW, RESERVED-BY-SYSTEM, ABORTED, COMPLETE, CANCELED)
Description
The status of the transaction.
Name
secret
Type
string
Description
The secret token of the transaction
Name
tid
Type
string
Description
The ID of the transaction
Name
coupons
Type
array<string>
Description
An array of applied coupon codes
Optional nested attributes (59)
Name
customerId
Type
string
Description
The ID of the customer of the transaction
Name
company
Type
string
Description
The company name of the user of the transaction
Name
name
Type
string
Description
The name of the user of the transaction
Name
prename
Type
string
Description
The firstname of the user of the transaction
Name
lastname
Type
string
Description
The lastname of the user of the transaction
Name
email
Type
string email
Description
The email of the user of the transaction
Name
street
Type
string
Description
The street of the user of the transaction
Name
line2
Type
string
Description
The additional address field of the user of the transaction.
Name
city
Type
string
Description
The city of the user of the transaction
Name
state
Type
string
Description
The state of the user of the transaction
Name
country
Type
string
Description
The country of the user of the transaction
Name
postal
Type
string
Description
The postal of the user of the transaction
Name
deliveryAddress
Type
object
Description
The delivery address of the transaction
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
tickets
Type
array<object>
Description
An array of cart ticket items of the transaction
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
products
Type
array<object>
Description
An array of cart product items of the transaction
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
An array of additional price items of the transaction
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
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
An ISO 4217 3-character code of the currency
Name
regularPrice
Type
number float
Description
The regular price of the transaction
Name
paymentCharge
Type
number float
Description
The payment charge of the transaction
Name
innerCharge
Type
number float
Description
The inner charge of the transaction
Name
outerCharge
Type
number float
Description
The outer charge of the transaction
Name
innerFeeComponents
Type
object
Description
The inner fee of the transaction including fix and var fee
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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
outerFeeComponents
Type
object
Description
The outer fee of the transaction including fix and var fee
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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
cancellationFee
Type
object
Description
The cancellation fee of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the fee component.
Optional nested attributes (8)
Name
amount
Type
number float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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
cancellationInfo
Type
object
Description
The cancellation info of the transaction
Optional nested attributes (2)
Name
cancellableItems
Type
array<object>
Description
An array of cancellable items
Required nested attributes (3)
Name
cartItemId
Type
string
Description
The ID of the cart to which the item belongs to
Name
type
Type
enum(ticket, product, fee, discount, fulfillment, insurance)
Description
The type of the item indicated where it originated from
Name
price
Type
number float
Description
The price of the item
Optional nested attributes (6)
Name
name
Type
string
Description
The name of the item
Name
taxRate
Type
number float
Description
The applied tax rate for that item
Name
origin
Type
oneOf
Description
Object indicating where the item originated from
One of — Only one of the following types
Optional attributes
Name
fee
Type
object
Description
The cancellation fee of the item
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the fee component.
Optional nested attributes (8)
Name
amount
Type
number float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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
cancellationFee
Type
object
Description
The cancellation fee of the item. Is set when cancellation fees are charged at cancellation
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the fee component.
Optional nested attributes (8)
Name
amount
Type
number float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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
refundId
Type
string
Description
The ID of the refund. Is set when item was refunded
Name
cancelledAt
Type
string date-time
Description
A date indicating when the item has been cancelled
Name
refundableByTarget
Type
object
Description
Remaining refundable amounts for this transaction, keyed by refund target
Name
taxRate
Type
number float
Description
The tax rate of the transaction
Name
createdAt
Type
string date-time
Description
An ISO timestamp indicating when the transaction was created
Name
updatedAt
Type
string date-time
Description
An ISO Timestamp indicating when the voucher was last updated
Name
psp
Type
string
Description
Name
paymentMethod
Type
enum(paypal, stripe, local, external, vivenu-payments)
Description
The payment method of the transaction.
Name
paymentInfo
Type
object
Description
The payment info of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the payment info
Optional nested attributes (11)
Name
psp
Type
string
Description
Name
gateway
Type
enum(managed, external, local)
Description
The payment gateway of the payment.
Name
providerType
Type
enum(stripeConnect, vivenu)
Description
The payment provider of the payment.
Name
providerId
Type
string
Description
The ID of the provider of the payment
Name
method
Type
string
Description
The method of the payment
Name
methodVariant
Type
string
Description
The method variant of the payment
Name
locale
Type
string
Description
The locale of the payment
Name
riskLevel
Type
string
Description
The risk level of the payment
Name
riskScore
Type
number float
Description
The risk score of the payment
Name
refundId
Type
string
Description
The ID of the refund of the payment
Name
collectedApplicationFee
Type
number float
Description
The application fee of the payment
Name
paymentStatus
Type
enum(AWAITING, PENDING, RECEIVED, REFUND, CANCELED, FAILED, DISPUTE, CHARGEBACK, POS-RECEIVED, POS-CANCELED, LOCAL-PENDING, LOCAL-AWAITING, LOCAL-RECEIVED, EXTERNAL)
Description
The payment status of the transaction.
Name
origin
Type
enum(yourticket, pos, rebooking, upgrade, subscription)
Description
The origin of the transaction.
Name
subscriptionId
Type
string
Description
The ID of the subscription of the transaction
Name
userId
Type
string
Description
The ID of the user who created the transaction.
Name
posId
Type
string
Description
The ID of pos of the transaction
Name
posInfo
Type
object
Description
The POS info of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the POS info
Optional nested attributes (6)
Name
sessionId
Type
string
Description
The ID of the session of the POS
Name
billingNo
Type
string
Description
The billing no of the POS
Name
taxId
Type
string
Description
The tax ID of the POS
Name
paymentMethod
Type
string
Description
The payment method of the POS.
Name
canceledAt
Type
string date-time
Description
The cancellation Date of the POS
Name
cancellationNo
Type
string date-time
Description
The cancellation no of the POS
Name
history
Type
array<object>
Status
deprecated
Description
An array of history entry items of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the transaction history entry
Optional nested attributes (5)
Name
date
Type
string date-time
Description
The date of the history entry
Name
title
Type
string
Description
The title of the history entry
Name
message
Type
string
Description
A message which describes the history entry
Name
type
Type
enum(PAYMENT, YOURTICKET, USER)
Description
The type of the history entry.
Name
risk
Type
enum(DANGER, NEUTRAL, GOOD)
Description
The risk of the transaction history entry. NEUTRAL = is a neutral risk of the transaction. GOOD = is a good risk factor of the transaction, which means less risk. DANGER = is a danger risk factor of the transaction, which means high risk.
Name
historyEntries
Type
array<object>
Description
An array of history entry items of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the transaction history entry
Optional nested attributes (5)
Name
date
Type
string date-time
Description
The date of the history entry
Name
userId
Type
string
Description
The ID of the user of the history entry
Name
data
Type
object
Description
The data of the history entry
Name
type
Type
enum(created, reserved, completed, completed.manually, aborted, canceled, partial.canceled, pos.created, pos.canceled, pos.payment.method.changed, payment.canceled, payment.authorized, payment.failed, payment.succeeded, payment.chargeback, payment.localReceived, dispute.created, dispute.countered, dispute.won, dispute.lost, refunded, partial.refunded, refund.failed, partial.refunded.voucher, refunded.voucher, partial.refunded.balance, refunded.balance, payment.local.added, payment_correction.refund.missing_in_core, payment_correction.refund.failed, payment_correction.payment.failed, price.recalculated, invitation.reserved.mail, transaction.resent.mail, transaction.resent.ticket_mail, transaction.resent.voucher_mail, tickets.booked, transaction.sent.sms, commented)
Description
The type of the history entry.
Name
risk
Type
enum(DANGER, NEUTRAL, GOOD)
Description
The risk of the transaction history entry. NEUTRAL = is a neutral risk of the transaction. GOOD = is a good risk factor of the transaction, which means less risk. DANGER = is a danger risk factor of the transaction, which means high risk.
Name
ticketMailSend
Type
boolean
Description
Whether the mail with the ticket of the transaction was sent
Name
orderMailSend
Type
boolean
Description
Whether the mail with the order of the transaction was sent
Name
extraFields
Type
object
Description
The extra fields of the transaction
Name
channel
Type
string
Description
The channel of the transaction
Name
underShop
Type
string
Description
The under shop of the transaction
Name
userAgent
Type
object
Description
The User Agent of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the User Agent
Optional nested attributes (6)
Name
ua
Type
string
Description
The user agent
Name
browser
Type
object
Description
The browser of the user
Name
device
Type
object
Description
The device of the user
Name
engine
Type
object
Description
The engine of the user
Name
os
Type
object
Description
The OS of the user
Name
cpu
Type
object
Description
The CPU of the user
Name
ipLookup
Type
object
Description
The IP lookup info of the transaction
Optional nested attributes (2)
Name
ip
Type
string
Description
The IP address of the IP lookup info
Name
lookup
Type
object
Description
The IP lookup result
Optional nested attributes (9)
Name
range
Type
array<number>
Description
The Range of the ip adress
Name
country
Type
string
Description
The country of the IP lookup
Name
region
Type
string
Description
The region of the IP lookup
Name
eu
Type
string
Description
Name
timezone
Type
string
Description
The timezone of the IP lookup
Name
city
Type
string
Description
The city city of the IP lookup
Name
ll
Type
array<number>
Description
Name
metro
Type
number float
Description
Name
area
Type
number float
Description
Name
locationCenter
Type
array<number>
Description
Name
vouchers
Type
array<string>
Description
An array of voucher codes applied to this transaction
Name
redeemedVouchers
Type
object
Description
An array of voucher codes redeemed for this transaction
Required nested attributes (1)
Name
totalRedeemedAmount
Type
number float
Description
The sum of all vouchers applied.
Optional nested attributes (1)
Name
vouchers
Type
array<object>
Description
An array of all redeemed vouchers.
Required nested attributes (2)
Name
code
Type
string
Description
The Code of the voucher.
Name
redeemedAmount
Type
number float
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 of applied coupons within the transaction
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
appliedDiscountGroups
Type
array<string>
Description
An array of discount groups applied to the transaction
Name
posDiscounts
Type
array<object>
Description
An array of POS discounts
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the POS discount
Name
name
Type
string
Description
The name of the POS discount
Name
value
Type
number float
Description
The value of the POS discount
Optional nested attributes (1)
Name
discountType
Type
enum(TOTAL, PERCENTAGE, fix, var)
Description
The discount type.
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 preferred language of the transaction. It is determined automatically
Name
cancellationReason
Type
enum(REQUESTED_BY_CUSTOMER, CLAIM, COMMUNICATION_ERROR, TRAINING/TEST)
Description
The reason of the cancellation of the transaction
Name
appliedDiscountInfo
Type
object
Description
Applied discountInfo for the transaction
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 float
Description
The amount of applied discounts.
Name
regularPrice
Type
number float
Description
The regular price before applying the discount.
Name
price
Type
number float
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 float
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 float
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 float
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 float
Description
The maximum amount of items the discount will be applied towards.
Name
maxAbsoluteValue
Type
number float
Description
The maximum absolute value of the discount.
Name
absoluteDiscountValue
Type
number float
Description
The absolute value of the discount.
Name
invoiceVersion
Type
string
Description
The invoice version of the transaction.
Name
seatingReservationToken
Type
string
Description
The seating reservation token of the transaction
Name
paymentInfoMethod
Type
enum(paypal, stripe, local, external, vivenu-payments)
Description
The payment method of the transaction.
Name
tickets
Type
array<TicketResource>
Description
An array of the tickets associated to this transaction
Required nested attributes (10)
Name
_id
Type
string
Description
Name
sellerId
Type
string
Description
The ID of the seller that ticket belongs to.
Name
eventId
Type
string
Description
The ID of the event the ticket belongs to
Name
ticketTypeId
Type
string
Description
The ID of the ticket type this ticket inherits from
Name
ticketName
Type
string
Description
The name of the ticket type this ticket inherits from
Name
createdAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket was created.
Name
updatedAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket was updated.
Name
status
Type
enum(VALID, INVALID, RESERVED, DETAILSREQUIRED, BLANK)
Description
The status of the ticket
Name
secret
Type
string
Description
The secret token of the ticket
Name
barcode
Type
string
Description
The barcode of the ticket
Optional nested attributes (50)
Name
company
Type
string
Description
Name
email
Type
string
Description
Name
name
Type
string
Description
The name of the ticket owner
Name
firstname
Type
string
Description
The first name of the ticket owner
Name
lastname
Type
string
Description
The last name of the ticket owner
Name
street
Type
string
Description
Name
line2
Type
string
Description
The additional address field of the user of the ticket
Name
city
Type
string
Description
Name
postal
Type
string
Description
Name
state
Type
string
Description
The state of the user of the ticket
Name
country
Type
string
Description
The country of the user of the ticket
Name
rootEventId
Type
string
Description
The ID of the root event, if exists
Name
transactionId
Type
string
Description
The transaction the ticket originated from
Name
posId
Type
string
Description
The point of sale the ticket was created on
Name
underShopId
Type
string
Description
The ID of an undershop the ticket was purchased through
Name
categoryRef
Type
string
Description
A UUID of the category the ticket belongs to.
Name
categoryName
Type
string
Description
The name of the category the ticket belongs to.
Name
slotId
Type
string
Description
The ID of the time slot this ticket belongs to, if exists
Name
slotStartTime
Type
string
Description
The start time of the time slot this ticket belongs to, if exists.
Name
cartItemId
Type
string
Description
The ID of the cart item to which the ticket belongs
Name
triggeredBy
Type
array<string>
Description
An array of IDs of cart items which triggered the buy action of the ticket
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
An ISO 4217 3-character code of the currency
Name
regularPrice
Type
number float
Description
The original non discounted price for the ticket
Name
realPrice
Type
number float
Description
The real price for the ticket
Name
completed
Type
boolean
Description
Whether all steps for validating the ticket has been made
Name
expiresAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket will be expired.
Name
seat
Type
string
Description
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
type
Type
enum(SINGLE, MULTI)
Description
The type of the ticket
Name
origin
Type
enum(yourticket, pos, rebooking, upgrade, subscription, transfer)
Description
Name
extraFields
Type
object
Description
A hashmap of extra fields for the ticket
Name
batch
Type
string
Description
A UUId indicating in which batch the tickets were created
Name
batchCounter
Type
number float
Description
A counter indicating the order of the ticket in the batch
Name
deliveryType
Type
enum(HARD, VIRTUAL)
Description
The delivery type of the ticket
Name
readyForDelivery
Type
boolean
Description
Whether the ticket is ready for delivery
Name
customMessage
Type
string
Description
Name
priceCategoryId
Type
string
Description
Name
entryPermissions
Type
array<array | boolean | number | object | string>
Description
Name
customerId
Type
string
Description
Name
history
Type
array<array | boolean | number | object | string>
Description
Name
personalized
Type
boolean
Description
Name
excludedEventIds
Type
array<string>
Description
An array of IDs of events for which the ticket has been blocked
Name
originTicketId
Type
string
Description
The ID of the origin ticket from which the ticket created
Name
fulfillmentTypeId
Type
string
Description
The ID of the fulfillment type used to deliver the ticket
Name
packageInfo
Type
object
Description
The package information of the ticket
Required nested attributes (3)
Name
packageId
Type
string
Description
The ID of the package
Name
packageConfigId
Type
string
Description
The ID of the package configuration
Name
name
Type
string
Description
The name of the package
Name
__v
Type
integer
Description
Name
_locks
Type
array<object>
Description
List of locks on this ticket
Required nested attributes (2)
Name
by
Type
string
Description
Name
at
Type
string date-time
Description
Optional nested attributes (2)
Name
eventId
Type
string
Description
Name
type
Type
enum(resell)
Description
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
personalizations
Type
array<array | boolean | number | object | string>
Description
A list of personalizations of the ticket.

Example

{
  "transaction": {
    "_id": "507f191e810c19729de860ea",
    "sellerId": "507f191e810c19729de860ea",
    "eventId": "507f191e810c19729de860ea",
    "realPrice": 10.5,
    "status": "NEW",
    "secret": "4b5fb736-45fd-4895-b497-124a2360c7e6",
    "tid": "string",
    "coupons": [
      "string"
    ],
    "customerId": "507f191e810c19729de860ea",
    "company": "vivenu GmbH",
    "name": "Some fancy Name",
    "prename": "John",
    "lastname": "Robot",
    "email": "random@mail.com",
    "street": "Speditionsstr",
    "line2": "string",
    "city": "Düsseldorf",
    "state": "string",
    "country": "DE",
    "postal": "40221",
    "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"
      }
    ],
    "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"
            }
          ]
        }
      }
    ],
    "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"
        }
      }
    ],
    "currency": "EUR",
    "regularPrice": 10.5,
    "paymentCharge": 10.5,
    "innerCharge": 10.5,
    "outerCharge": 10.5,
    "innerFeeComponents": {
      "_id": "507f191e810c19729de860ea",
      "fix": [
        {
          "_id": "507f191e810c19729de860ea",
          "amount": 10.5,
          "value": 10.5,
          "total": 10.5,
          "type": "onTicket",
          "name": "Some fancy 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": "Some fancy Name",
          "publicName": "string",
          "exposed": true,
          "scheme": {
            "schemeId": "507f191e810c19729de860ea",
            "feeId": "507f191e810c19729de860ea"
          }
        }
      ]
    },
    "outerFeeComponents": {
      "_id": "507f191e810c19729de860ea",
      "fix": [
        {
          "_id": "507f191e810c19729de860ea",
          "amount": 10.5,
          "value": 10.5,
          "total": 10.5,
          "type": "onTicket",
          "name": "Some fancy 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": "Some fancy Name",
          "publicName": "string",
          "exposed": true,
          "scheme": {
            "schemeId": "507f191e810c19729de860ea",
            "feeId": "507f191e810c19729de860ea"
          }
        }
      ]
    },
    "cancellationFee": {
      "_id": "507f191e810c19729de860ea",
      "amount": 10.5,
      "value": 10.5,
      "total": 10.5,
      "type": "onTicket",
      "name": "Some fancy Name",
      "publicName": "string",
      "exposed": true,
      "scheme": {
        "schemeId": "507f191e810c19729de860ea",
        "feeId": "507f191e810c19729de860ea"
      }
    },
    "cancellationInfo": {
      "cancellableItems": [
        {
          "cartItemId": "507f191e810c19729de860ea",
          "type": "ticket",
          "price": 10.5,
          "name": "Some fancy Name",
          "taxRate": 10.5,
          "origin": {
            "fee": {
              "_id": "507f191e810c19729de860ea",
              "amount": 10.5,
              "value": 10.5,
              "total": 10.5,
              "type": "onTicket",
              "name": "Some fancy Name",
              "publicName": "string",
              "exposed": true,
              "scheme": {
                "schemeId": "507f191e810c19729de860ea",
                "feeId": "507f191e810c19729de860ea"
              }
            }
          },
          "cancellationFee": {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Some fancy Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          },
          "refundId": "507f191e810c19729de860ea",
          "cancelledAt": "2030-01-23T23:00:00.123Z"
        }
      ],
      "refundableByTarget": {}
    },
    "taxRate": 0.19,
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z",
    "psp": "string",
    "paymentMethod": "paypal",
    "paymentInfo": {
      "_id": "507f191e810c19729de860ea",
      "psp": "string",
      "gateway": "managed",
      "providerType": "vivenu",
      "providerId": "507f191e810c19729de860ea",
      "method": "string",
      "methodVariant": "string",
      "locale": "string",
      "riskLevel": "string",
      "riskScore": 10.5,
      "refundId": "507f191e810c19729de860ea",
      "collectedApplicationFee": 10.5
    },
    "paymentStatus": "AWAITING",
    "origin": "yourticket",
    "subscriptionId": "507f191e810c19729de860ea",
    "userId": "507f191e810c19729de860ea",
    "posId": "507f191e810c19729de860ea",
    "posInfo": {
      "_id": "507f191e810c19729de860ea",
      "sessionId": "507f191e810c19729de860ea",
      "billingNo": "string",
      "taxId": "507f191e810c19729de860ea",
      "paymentMethod": "string",
      "canceledAt": "2030-01-23T23:00:00.123Z",
      "cancellationNo": "2030-01-23T23:00:00.123Z"
    },
    "history": [
      {
        "_id": "507f191e810c19729de860ea",
        "date": "2030-01-23T23:00:00.123Z",
        "title": "string",
        "message": "string",
        "type": "YOURTICKET",
        "risk": "NEUTRAL"
      }
    ],
    "historyEntries": [
      {
        "_id": "507f191e810c19729de860ea",
        "date": "2030-01-23T23:00:00.123Z",
        "userId": "507f191e810c19729de860ea",
        "data": {},
        "type": "created",
        "risk": "NEUTRAL"
      }
    ],
    "ticketMailSend": true,
    "orderMailSend": true,
    "extraFields": {},
    "channel": "string",
    "underShop": "string",
    "userAgent": {
      "_id": "507f191e810c19729de860ea",
      "ua": "string",
      "browser": {},
      "device": {},
      "engine": {},
      "os": {},
      "cpu": {}
    },
    "ipLookup": {
      "ip": "string",
      "lookup": {
        "range": [
          10.5
        ],
        "country": "DE",
        "region": "string",
        "eu": "string",
        "timezone": "string",
        "city": "Düsseldorf",
        "ll": [
          10.5
        ],
        "metro": 10.5,
        "area": 10.5
      }
    },
    "locationCenter": [
      10.5
    ],
    "vouchers": [
      "string"
    ],
    "redeemedVouchers": {
      "totalRedeemedAmount": 10.5,
      "vouchers": [
        {
          "code": "string",
          "redeemedAmount": 10.5,
          "_id": "507f191e810c19729de860ea"
        }
      ]
    },
    "appliedCoupons": [
      {
        "_id": "507f191e810c19729de860ea",
        "code": "string"
      }
    ],
    "appliedDiscountGroups": [
      "string"
    ],
    "posDiscounts": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "value": 10.5,
        "discountType": "fix"
      }
    ],
    "preferredLanguage": "de",
    "cancellationReason": "REQUESTED_BY_CUSTOMER",
    "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": "Some fancy Name",
              "value": 10.5,
              "allowedItems": [
                "string"
              ]
            }
          ],
          "fixDiscounts": [
            {
              "_id": "507f191e810c19729de860ea",
              "type": "fix",
              "discountId": "507f191e810c19729de860ea",
              "category": "coupon",
              "name": "Some fancy Name",
              "value": 10.5,
              "allowedItems": [
                "string"
              ]
            }
          ]
        }
      ],
      "discounts": [
        {
          "_id": "507f191e810c19729de860ea",
          "type": "fix",
          "discountId": "507f191e810c19729de860ea",
          "category": "coupon",
          "name": "Some fancy Name",
          "value": 10.5,
          "allowedItems": [
            "string"
          ],
          "maxItemsInCart": 10.5,
          "maxAbsoluteValue": 10.5,
          "absoluteDiscountValue": 10.5
        }
      ]
    },
    "invoiceVersion": "v2",
    "seatingReservationToken": "string",
    "paymentInfoMethod": "paypal"
  },
  "tickets": [
    {
      "_id": "507f191e810c19729de860ea",
      "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": "4b5fb736-45fd-4895-b497-124a2360c7e6",
      "barcode": "wbf7tkmy",
      "company": "vivenu GmbH",
      "email": "string",
      "name": "Some fancy Name",
      "firstname": "string",
      "lastname": "Robot",
      "street": "Speditionsstr",
      "line2": "string",
      "city": "Düsseldorf",
      "postal": "40221",
      "state": "string",
      "country": "DE",
      "rootEventId": "507f191e810c19729de860ea",
      "transactionId": "507f191e810c19729de860ea",
      "posId": "507f191e810c19729de860ea",
      "underShopId": "507f191e810c19729de860ea",
      "categoryRef": "string",
      "categoryName": "string",
      "slotId": "507f191e810c19729de860ea",
      "slotStartTime": "string",
      "cartItemId": "507f191e810c19729de860ea",
      "triggeredBy": [
        "string"
      ],
      "currency": "EUR",
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "completed": true,
      "expiresAt": "2030-01-23T23:00:00.123Z",
      "seat": "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"
      },
      "type": "SINGLE",
      "origin": "yourticket",
      "extraFields": {},
      "batch": "string",
      "batchCounter": 10.5,
      "deliveryType": "HARD",
      "readyForDelivery": true,
      "customMessage": "string",
      "priceCategoryId": "507f191e810c19729de860ea",
      "entryPermissions": [
        []
      ],
      "customerId": "507f191e810c19729de860ea",
      "history": [
        []
      ],
      "personalized": true,
      "excludedEventIds": [
        "string"
      ],
      "originTicketId": "507f191e810c19729de860ea",
      "fulfillmentTypeId": "507f191e810c19729de860ea",
      "packageInfo": {
        "packageId": "507f191e810c19729de860ea",
        "packageConfigId": "507f191e810c19729de860ea",
        "name": "Some fancy Name"
      },
      "__v": 1,
      "_locks": [
        {
          "by": "string",
          "at": "2030-01-23T23:00:00.123Z",
          "eventId": "507f191e810c19729de860ea",
          "type": "resell"
        }
      ],
      "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
          }
        }
      ],
      "personalizations": [
        []
      ]
    }
  ]
}

transaction.partiallyCanceled

The data of the transaction partially canceled webhook event.

Required attributes

Name
transaction
Type
WebhookTransactionResource
Description
The associated transaction
Required nested attributes (8)
Name
_id
Type
string
Description
The ID of the transaction
Name
sellerId
Type
string
Description
The ID of the seller of the transaction
Name
eventId
Type
string
Description
The ID of the event containing this transaction
Name
realPrice
Type
number float
Description
The calculated real price of the transaction
Name
status
Type
enum(NEW, RESERVED-BY-SYSTEM, ABORTED, COMPLETE, CANCELED)
Description
The status of the transaction.
Name
secret
Type
string
Description
The secret token of the transaction
Name
tid
Type
string
Description
The ID of the transaction
Name
coupons
Type
array<string>
Description
An array of applied coupon codes
Optional nested attributes (59)
Name
customerId
Type
string
Description
The ID of the customer of the transaction
Name
company
Type
string
Description
The company name of the user of the transaction
Name
name
Type
string
Description
The name of the user of the transaction
Name
prename
Type
string
Description
The firstname of the user of the transaction
Name
lastname
Type
string
Description
The lastname of the user of the transaction
Name
email
Type
string email
Description
The email of the user of the transaction
Name
street
Type
string
Description
The street of the user of the transaction
Name
line2
Type
string
Description
The additional address field of the user of the transaction.
Name
city
Type
string
Description
The city of the user of the transaction
Name
state
Type
string
Description
The state of the user of the transaction
Name
country
Type
string
Description
The country of the user of the transaction
Name
postal
Type
string
Description
The postal of the user of the transaction
Name
deliveryAddress
Type
object
Description
The delivery address of the transaction
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
tickets
Type
array<object>
Description
An array of cart ticket items of the transaction
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
products
Type
array<object>
Description
An array of cart product items of the transaction
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
An array of additional price items of the transaction
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
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
An ISO 4217 3-character code of the currency
Name
regularPrice
Type
number float
Description
The regular price of the transaction
Name
paymentCharge
Type
number float
Description
The payment charge of the transaction
Name
innerCharge
Type
number float
Description
The inner charge of the transaction
Name
outerCharge
Type
number float
Description
The outer charge of the transaction
Name
innerFeeComponents
Type
object
Description
The inner fee of the transaction including fix and var fee
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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
outerFeeComponents
Type
object
Description
The outer fee of the transaction including fix and var fee
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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
cancellationFee
Type
object
Description
The cancellation fee of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the fee component.
Optional nested attributes (8)
Name
amount
Type
number float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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
cancellationInfo
Type
object
Description
The cancellation info of the transaction
Optional nested attributes (2)
Name
cancellableItems
Type
array<object>
Description
An array of cancellable items
Required nested attributes (3)
Name
cartItemId
Type
string
Description
The ID of the cart to which the item belongs to
Name
type
Type
enum(ticket, product, fee, discount, fulfillment, insurance)
Description
The type of the item indicated where it originated from
Name
price
Type
number float
Description
The price of the item
Optional nested attributes (6)
Name
name
Type
string
Description
The name of the item
Name
taxRate
Type
number float
Description
The applied tax rate for that item
Name
origin
Type
oneOf
Description
Object indicating where the item originated from
One of — Only one of the following types
Optional attributes
Name
fee
Type
object
Description
The cancellation fee of the item
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the fee component.
Optional nested attributes (8)
Name
amount
Type
number float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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
cancellationFee
Type
object
Description
The cancellation fee of the item. Is set when cancellation fees are charged at cancellation
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the fee component.
Optional nested attributes (8)
Name
amount
Type
number float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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
refundId
Type
string
Description
The ID of the refund. Is set when item was refunded
Name
cancelledAt
Type
string date-time
Description
A date indicating when the item has been cancelled
Name
refundableByTarget
Type
object
Description
Remaining refundable amounts for this transaction, keyed by refund target
Name
taxRate
Type
number float
Description
The tax rate of the transaction
Name
createdAt
Type
string date-time
Description
An ISO timestamp indicating when the transaction was created
Name
updatedAt
Type
string date-time
Description
An ISO Timestamp indicating when the voucher was last updated
Name
psp
Type
string
Description
Name
paymentMethod
Type
enum(paypal, stripe, local, external, vivenu-payments)
Description
The payment method of the transaction.
Name
paymentInfo
Type
object
Description
The payment info of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the payment info
Optional nested attributes (11)
Name
psp
Type
string
Description
Name
gateway
Type
enum(managed, external, local)
Description
The payment gateway of the payment.
Name
providerType
Type
enum(stripeConnect, vivenu)
Description
The payment provider of the payment.
Name
providerId
Type
string
Description
The ID of the provider of the payment
Name
method
Type
string
Description
The method of the payment
Name
methodVariant
Type
string
Description
The method variant of the payment
Name
locale
Type
string
Description
The locale of the payment
Name
riskLevel
Type
string
Description
The risk level of the payment
Name
riskScore
Type
number float
Description
The risk score of the payment
Name
refundId
Type
string
Description
The ID of the refund of the payment
Name
collectedApplicationFee
Type
number float
Description
The application fee of the payment
Name
paymentStatus
Type
enum(AWAITING, PENDING, RECEIVED, REFUND, CANCELED, FAILED, DISPUTE, CHARGEBACK, POS-RECEIVED, POS-CANCELED, LOCAL-PENDING, LOCAL-AWAITING, LOCAL-RECEIVED, EXTERNAL)
Description
The payment status of the transaction.
Name
origin
Type
enum(yourticket, pos, rebooking, upgrade, subscription)
Description
The origin of the transaction.
Name
subscriptionId
Type
string
Description
The ID of the subscription of the transaction
Name
userId
Type
string
Description
The ID of the user who created the transaction.
Name
posId
Type
string
Description
The ID of pos of the transaction
Name
posInfo
Type
object
Description
The POS info of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the POS info
Optional nested attributes (6)
Name
sessionId
Type
string
Description
The ID of the session of the POS
Name
billingNo
Type
string
Description
The billing no of the POS
Name
taxId
Type
string
Description
The tax ID of the POS
Name
paymentMethod
Type
string
Description
The payment method of the POS.
Name
canceledAt
Type
string date-time
Description
The cancellation Date of the POS
Name
cancellationNo
Type
string date-time
Description
The cancellation no of the POS
Name
history
Type
array<object>
Status
deprecated
Description
An array of history entry items of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the transaction history entry
Optional nested attributes (5)
Name
date
Type
string date-time
Description
The date of the history entry
Name
title
Type
string
Description
The title of the history entry
Name
message
Type
string
Description
A message which describes the history entry
Name
type
Type
enum(PAYMENT, YOURTICKET, USER)
Description
The type of the history entry.
Name
risk
Type
enum(DANGER, NEUTRAL, GOOD)
Description
The risk of the transaction history entry. NEUTRAL = is a neutral risk of the transaction. GOOD = is a good risk factor of the transaction, which means less risk. DANGER = is a danger risk factor of the transaction, which means high risk.
Name
historyEntries
Type
array<object>
Description
An array of history entry items of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the transaction history entry
Optional nested attributes (5)
Name
date
Type
string date-time
Description
The date of the history entry
Name
userId
Type
string
Description
The ID of the user of the history entry
Name
data
Type
object
Description
The data of the history entry
Name
type
Type
enum(created, reserved, completed, completed.manually, aborted, canceled, partial.canceled, pos.created, pos.canceled, pos.payment.method.changed, payment.canceled, payment.authorized, payment.failed, payment.succeeded, payment.chargeback, payment.localReceived, dispute.created, dispute.countered, dispute.won, dispute.lost, refunded, partial.refunded, refund.failed, partial.refunded.voucher, refunded.voucher, partial.refunded.balance, refunded.balance, payment.local.added, payment_correction.refund.missing_in_core, payment_correction.refund.failed, payment_correction.payment.failed, price.recalculated, invitation.reserved.mail, transaction.resent.mail, transaction.resent.ticket_mail, transaction.resent.voucher_mail, tickets.booked, transaction.sent.sms, commented)
Description
The type of the history entry.
Name
risk
Type
enum(DANGER, NEUTRAL, GOOD)
Description
The risk of the transaction history entry. NEUTRAL = is a neutral risk of the transaction. GOOD = is a good risk factor of the transaction, which means less risk. DANGER = is a danger risk factor of the transaction, which means high risk.
Name
ticketMailSend
Type
boolean
Description
Whether the mail with the ticket of the transaction was sent
Name
orderMailSend
Type
boolean
Description
Whether the mail with the order of the transaction was sent
Name
extraFields
Type
object
Description
The extra fields of the transaction
Name
channel
Type
string
Description
The channel of the transaction
Name
underShop
Type
string
Description
The under shop of the transaction
Name
userAgent
Type
object
Description
The User Agent of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the User Agent
Optional nested attributes (6)
Name
ua
Type
string
Description
The user agent
Name
browser
Type
object
Description
The browser of the user
Name
device
Type
object
Description
The device of the user
Name
engine
Type
object
Description
The engine of the user
Name
os
Type
object
Description
The OS of the user
Name
cpu
Type
object
Description
The CPU of the user
Name
ipLookup
Type
object
Description
The IP lookup info of the transaction
Optional nested attributes (2)
Name
ip
Type
string
Description
The IP address of the IP lookup info
Name
lookup
Type
object
Description
The IP lookup result
Optional nested attributes (9)
Name
range
Type
array<number>
Description
The Range of the ip adress
Name
country
Type
string
Description
The country of the IP lookup
Name
region
Type
string
Description
The region of the IP lookup
Name
eu
Type
string
Description
Name
timezone
Type
string
Description
The timezone of the IP lookup
Name
city
Type
string
Description
The city city of the IP lookup
Name
ll
Type
array<number>
Description
Name
metro
Type
number float
Description
Name
area
Type
number float
Description
Name
locationCenter
Type
array<number>
Description
Name
vouchers
Type
array<string>
Description
An array of voucher codes applied to this transaction
Name
redeemedVouchers
Type
object
Description
An array of voucher codes redeemed for this transaction
Required nested attributes (1)
Name
totalRedeemedAmount
Type
number float
Description
The sum of all vouchers applied.
Optional nested attributes (1)
Name
vouchers
Type
array<object>
Description
An array of all redeemed vouchers.
Required nested attributes (2)
Name
code
Type
string
Description
The Code of the voucher.
Name
redeemedAmount
Type
number float
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 of applied coupons within the transaction
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
appliedDiscountGroups
Type
array<string>
Description
An array of discount groups applied to the transaction
Name
posDiscounts
Type
array<object>
Description
An array of POS discounts
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the POS discount
Name
name
Type
string
Description
The name of the POS discount
Name
value
Type
number float
Description
The value of the POS discount
Optional nested attributes (1)
Name
discountType
Type
enum(TOTAL, PERCENTAGE, fix, var)
Description
The discount type.
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 preferred language of the transaction. It is determined automatically
Name
cancellationReason
Type
enum(REQUESTED_BY_CUSTOMER, CLAIM, COMMUNICATION_ERROR, TRAINING/TEST)
Description
The reason of the cancellation of the transaction
Name
appliedDiscountInfo
Type
object
Description
Applied discountInfo for the transaction
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 float
Description
The amount of applied discounts.
Name
regularPrice
Type
number float
Description
The regular price before applying the discount.
Name
price
Type
number float
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 float
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 float
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 float
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 float
Description
The maximum amount of items the discount will be applied towards.
Name
maxAbsoluteValue
Type
number float
Description
The maximum absolute value of the discount.
Name
absoluteDiscountValue
Type
number float
Description
The absolute value of the discount.
Name
invoiceVersion
Type
string
Description
The invoice version of the transaction.
Name
seatingReservationToken
Type
string
Description
The seating reservation token of the transaction
Name
paymentInfoMethod
Type
enum(paypal, stripe, local, external, vivenu-payments)
Description
The payment method of the transaction.

Example

{
  "transaction": {
    "_id": "507f191e810c19729de860ea",
    "sellerId": "507f191e810c19729de860ea",
    "eventId": "507f191e810c19729de860ea",
    "realPrice": 10.5,
    "status": "NEW",
    "secret": "4b5fb736-45fd-4895-b497-124a2360c7e6",
    "tid": "string",
    "coupons": [
      "string"
    ],
    "customerId": "507f191e810c19729de860ea",
    "company": "vivenu GmbH",
    "name": "Some fancy Name",
    "prename": "John",
    "lastname": "Robot",
    "email": "random@mail.com",
    "street": "Speditionsstr",
    "line2": "string",
    "city": "Düsseldorf",
    "state": "string",
    "country": "DE",
    "postal": "40221",
    "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"
      }
    ],
    "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"
            }
          ]
        }
      }
    ],
    "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"
        }
      }
    ],
    "currency": "EUR",
    "regularPrice": 10.5,
    "paymentCharge": 10.5,
    "innerCharge": 10.5,
    "outerCharge": 10.5,
    "innerFeeComponents": {
      "_id": "507f191e810c19729de860ea",
      "fix": [
        {
          "_id": "507f191e810c19729de860ea",
          "amount": 10.5,
          "value": 10.5,
          "total": 10.5,
          "type": "onTicket",
          "name": "Some fancy 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": "Some fancy Name",
          "publicName": "string",
          "exposed": true,
          "scheme": {
            "schemeId": "507f191e810c19729de860ea",
            "feeId": "507f191e810c19729de860ea"
          }
        }
      ]
    },
    "outerFeeComponents": {
      "_id": "507f191e810c19729de860ea",
      "fix": [
        {
          "_id": "507f191e810c19729de860ea",
          "amount": 10.5,
          "value": 10.5,
          "total": 10.5,
          "type": "onTicket",
          "name": "Some fancy 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": "Some fancy Name",
          "publicName": "string",
          "exposed": true,
          "scheme": {
            "schemeId": "507f191e810c19729de860ea",
            "feeId": "507f191e810c19729de860ea"
          }
        }
      ]
    },
    "cancellationFee": {
      "_id": "507f191e810c19729de860ea",
      "amount": 10.5,
      "value": 10.5,
      "total": 10.5,
      "type": "onTicket",
      "name": "Some fancy Name",
      "publicName": "string",
      "exposed": true,
      "scheme": {
        "schemeId": "507f191e810c19729de860ea",
        "feeId": "507f191e810c19729de860ea"
      }
    },
    "cancellationInfo": {
      "cancellableItems": [
        {
          "cartItemId": "507f191e810c19729de860ea",
          "type": "ticket",
          "price": 10.5,
          "name": "Some fancy Name",
          "taxRate": 10.5,
          "origin": {
            "fee": {
              "_id": "507f191e810c19729de860ea",
              "amount": 10.5,
              "value": 10.5,
              "total": 10.5,
              "type": "onTicket",
              "name": "Some fancy Name",
              "publicName": "string",
              "exposed": true,
              "scheme": {
                "schemeId": "507f191e810c19729de860ea",
                "feeId": "507f191e810c19729de860ea"
              }
            }
          },
          "cancellationFee": {
            "_id": "507f191e810c19729de860ea",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "Some fancy Name",
            "publicName": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "507f191e810c19729de860ea",
              "feeId": "507f191e810c19729de860ea"
            }
          },
          "refundId": "507f191e810c19729de860ea",
          "cancelledAt": "2030-01-23T23:00:00.123Z"
        }
      ],
      "refundableByTarget": {}
    },
    "taxRate": 0.19,
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z",
    "psp": "string",
    "paymentMethod": "paypal",
    "paymentInfo": {
      "_id": "507f191e810c19729de860ea",
      "psp": "string",
      "gateway": "managed",
      "providerType": "vivenu",
      "providerId": "507f191e810c19729de860ea",
      "method": "string",
      "methodVariant": "string",
      "locale": "string",
      "riskLevel": "string",
      "riskScore": 10.5,
      "refundId": "507f191e810c19729de860ea",
      "collectedApplicationFee": 10.5
    },
    "paymentStatus": "AWAITING",
    "origin": "yourticket",
    "subscriptionId": "507f191e810c19729de860ea",
    "userId": "507f191e810c19729de860ea",
    "posId": "507f191e810c19729de860ea",
    "posInfo": {
      "_id": "507f191e810c19729de860ea",
      "sessionId": "507f191e810c19729de860ea",
      "billingNo": "string",
      "taxId": "507f191e810c19729de860ea",
      "paymentMethod": "string",
      "canceledAt": "2030-01-23T23:00:00.123Z",
      "cancellationNo": "2030-01-23T23:00:00.123Z"
    },
    "history": [
      {
        "_id": "507f191e810c19729de860ea",
        "date": "2030-01-23T23:00:00.123Z",
        "title": "string",
        "message": "string",
        "type": "YOURTICKET",
        "risk": "NEUTRAL"
      }
    ],
    "historyEntries": [
      {
        "_id": "507f191e810c19729de860ea",
        "date": "2030-01-23T23:00:00.123Z",
        "userId": "507f191e810c19729de860ea",
        "data": {},
        "type": "created",
        "risk": "NEUTRAL"
      }
    ],
    "ticketMailSend": true,
    "orderMailSend": true,
    "extraFields": {},
    "channel": "string",
    "underShop": "string",
    "userAgent": {
      "_id": "507f191e810c19729de860ea",
      "ua": "string",
      "browser": {},
      "device": {},
      "engine": {},
      "os": {},
      "cpu": {}
    },
    "ipLookup": {
      "ip": "string",
      "lookup": {
        "range": [
          10.5
        ],
        "country": "DE",
        "region": "string",
        "eu": "string",
        "timezone": "string",
        "city": "Düsseldorf",
        "ll": [
          10.5
        ],
        "metro": 10.5,
        "area": 10.5
      }
    },
    "locationCenter": [
      10.5
    ],
    "vouchers": [
      "string"
    ],
    "redeemedVouchers": {
      "totalRedeemedAmount": 10.5,
      "vouchers": [
        {
          "code": "string",
          "redeemedAmount": 10.5,
          "_id": "507f191e810c19729de860ea"
        }
      ]
    },
    "appliedCoupons": [
      {
        "_id": "507f191e810c19729de860ea",
        "code": "string"
      }
    ],
    "appliedDiscountGroups": [
      "string"
    ],
    "posDiscounts": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "value": 10.5,
        "discountType": "fix"
      }
    ],
    "preferredLanguage": "de",
    "cancellationReason": "REQUESTED_BY_CUSTOMER",
    "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": "Some fancy Name",
              "value": 10.5,
              "allowedItems": [
                "string"
              ]
            }
          ],
          "fixDiscounts": [
            {
              "_id": "507f191e810c19729de860ea",
              "type": "fix",
              "discountId": "507f191e810c19729de860ea",
              "category": "coupon",
              "name": "Some fancy Name",
              "value": 10.5,
              "allowedItems": [
                "string"
              ]
            }
          ]
        }
      ],
      "discounts": [
        {
          "_id": "507f191e810c19729de860ea",
          "type": "fix",
          "discountId": "507f191e810c19729de860ea",
          "category": "coupon",
          "name": "Some fancy Name",
          "value": 10.5,
          "allowedItems": [
            "string"
          ],
          "maxItemsInCart": 10.5,
          "maxAbsoluteValue": 10.5,
          "absoluteDiscountValue": 10.5
        }
      ]
    },
    "invoiceVersion": "v2",
    "seatingReservationToken": "string",
    "paymentInfoMethod": "paypal"
  }
}

checkout.completed

The data of the checkout completed webhook event.

Required attributes

Name
checkout
Type
CheckoutResource
Description
The associated checkout
Required nested attributes (7)
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 float
Description
The regular price of the checkout item.
Name
realPrice
Type
number float
Description
The calculated price of the checkout item.
Name
outerCharge
Type
number float
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 float
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 float
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 float
Description
The amount of applied discounts.
Name
regularPrice
Type
number float
Description
The regular price before applying the discount.
Name
price
Type
number float
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 float
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 float
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 float
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 float
Description
The maximum amount of items the discount will be applied towards.
Name
maxAbsoluteValue
Type
number float
Description
The maximum absolute value of the discount.
Name
absoluteDiscountValue
Type
number float
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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 float
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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 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
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 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
An array of additional price items of the checkout itemt.
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
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 float
Description
The calculated real price of the checkout.
Optional nested attributes (22)
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 email
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<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
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
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 float
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 float
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 date-time
Description
An ISO Timestamp indicating when the checkout will expire.
Name
createdAt
Type
string date-time
Description
An ISO timestamp indicating when the checkout was created.
Name
updatedAt
Type
string date-time
Description
An ISO timestamp indicating when the checkout was last updated.

Example

{
  "checkout": {
    "_id": "507f191e810c19729de860ea",
    "secret": "4b5fb736-45fd-4895-b497-124a2360c7e6",
    "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": "Some fancy Name",
                  "value": 10.5,
                  "allowedItems": [
                    "string"
                  ]
                }
              ],
              "fixDiscounts": [
                {
                  "_id": "507f191e810c19729de860ea",
                  "type": "fix",
                  "discountId": "507f191e810c19729de860ea",
                  "category": "coupon",
                  "name": "Some fancy Name",
                  "value": 10.5,
                  "allowedItems": [
                    "string"
                  ]
                }
              ]
            }
          ],
          "discounts": [
            {
              "_id": "507f191e810c19729de860ea",
              "type": "fix",
              "discountId": "507f191e810c19729de860ea",
              "category": "coupon",
              "name": "Some fancy 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": "Some fancy 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": "Some fancy 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": "Some fancy 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": "Some fancy Name",
              "publicName": "string",
              "exposed": true,
              "scheme": {
                "schemeId": "507f191e810c19729de860ea",
                "feeId": "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"
                }
              ]
            }
          }
        ],
        "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"
            }
          }
        ],
        "seatingReservationToken": "string",
        "subscriptionId": "507f191e810c19729de860ea"
      }
    ],
    "realPrice": 10.5,
    "company": "vivenu GmbH",
    "firstname": "string",
    "lastname": "Robot",
    "name": "Some fancy Name",
    "email": "random@mail.com",
    "phone": "string",
    "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"
      }
    ],
    "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"
  }
}

checkout.aborted

The data of the checkout aborted webhook event.

Required attributes

Name
checkout
Type
CheckoutResource
Description
The associated checkout
Required nested attributes (7)
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 float
Description
The regular price of the checkout item.
Name
realPrice
Type
number float
Description
The calculated price of the checkout item.
Name
outerCharge
Type
number float
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 float
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 float
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 float
Description
The amount of applied discounts.
Name
regularPrice
Type
number float
Description
The regular price before applying the discount.
Name
price
Type
number float
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 float
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 float
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 float
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 float
Description
The maximum amount of items the discount will be applied towards.
Name
maxAbsoluteValue
Type
number float
Description
The maximum absolute value of the discount.
Name
absoluteDiscountValue
Type
number float
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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 float
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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 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
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 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
An array of additional price items of the checkout itemt.
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
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 float
Description
The calculated real price of the checkout.
Optional nested attributes (22)
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 email
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<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
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
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 float
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 float
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 date-time
Description
An ISO Timestamp indicating when the checkout will expire.
Name
createdAt
Type
string date-time
Description
An ISO timestamp indicating when the checkout was created.
Name
updatedAt
Type
string date-time
Description
An ISO timestamp indicating when the checkout was last updated.

Example

{
  "checkout": {
    "_id": "507f191e810c19729de860ea",
    "secret": "4b5fb736-45fd-4895-b497-124a2360c7e6",
    "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": "Some fancy Name",
                  "value": 10.5,
                  "allowedItems": [
                    "string"
                  ]
                }
              ],
              "fixDiscounts": [
                {
                  "_id": "507f191e810c19729de860ea",
                  "type": "fix",
                  "discountId": "507f191e810c19729de860ea",
                  "category": "coupon",
                  "name": "Some fancy Name",
                  "value": 10.5,
                  "allowedItems": [
                    "string"
                  ]
                }
              ]
            }
          ],
          "discounts": [
            {
              "_id": "507f191e810c19729de860ea",
              "type": "fix",
              "discountId": "507f191e810c19729de860ea",
              "category": "coupon",
              "name": "Some fancy 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": "Some fancy 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": "Some fancy 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": "Some fancy 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": "Some fancy Name",
              "publicName": "string",
              "exposed": true,
              "scheme": {
                "schemeId": "507f191e810c19729de860ea",
                "feeId": "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"
                }
              ]
            }
          }
        ],
        "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"
            }
          }
        ],
        "seatingReservationToken": "string",
        "subscriptionId": "507f191e810c19729de860ea"
      }
    ],
    "realPrice": 10.5,
    "company": "vivenu GmbH",
    "firstname": "string",
    "lastname": "Robot",
    "name": "Some fancy Name",
    "email": "random@mail.com",
    "phone": "string",
    "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"
      }
    ],
    "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"
  }
}

checkout.detailsSubmitted

The data of the checkout details submitted webhook event.

Required attributes

Name
checkout
Type
CheckoutResource
Description
The associated checkout
Required nested attributes (7)
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 float
Description
The regular price of the checkout item.
Name
realPrice
Type
number float
Description
The calculated price of the checkout item.
Name
outerCharge
Type
number float
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 float
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 float
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 float
Description
The amount of applied discounts.
Name
regularPrice
Type
number float
Description
The regular price before applying the discount.
Name
price
Type
number float
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 float
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 float
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 float
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 float
Description
The maximum amount of items the discount will be applied towards.
Name
maxAbsoluteValue
Type
number float
Description
The maximum absolute value of the discount.
Name
absoluteDiscountValue
Type
number float
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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 float
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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 float
Description
The fee amount.
Name
value
Type
number float
Description
The fee value.
Name
total
Type
number float
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onFreeTicket, onPosTicket, onKioskTicket, onFreePosTicket, onFreeKioskTicket, onSeasonTicket, onHardTicket, onTicketCustom, onCart, onPosCart, onKioskCart, onFreeCart)
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 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
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 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
An array of additional price items of the checkout itemt.
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
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 float
Description
The calculated real price of the checkout.
Optional nested attributes (22)
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 email
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<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
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
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 float
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 float
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 date-time
Description
An ISO Timestamp indicating when the checkout will expire.
Name
createdAt
Type
string date-time
Description
An ISO timestamp indicating when the checkout was created.
Name
updatedAt
Type
string date-time
Description
An ISO timestamp indicating when the checkout was last updated.

Example

{
  "checkout": {
    "_id": "507f191e810c19729de860ea",
    "secret": "4b5fb736-45fd-4895-b497-124a2360c7e6",
    "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": "Some fancy Name",
                  "value": 10.5,
                  "allowedItems": [
                    "string"
                  ]
                }
              ],
              "fixDiscounts": [
                {
                  "_id": "507f191e810c19729de860ea",
                  "type": "fix",
                  "discountId": "507f191e810c19729de860ea",
                  "category": "coupon",
                  "name": "Some fancy Name",
                  "value": 10.5,
                  "allowedItems": [
                    "string"
                  ]
                }
              ]
            }
          ],
          "discounts": [
            {
              "_id": "507f191e810c19729de860ea",
              "type": "fix",
              "discountId": "507f191e810c19729de860ea",
              "category": "coupon",
              "name": "Some fancy 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": "Some fancy 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": "Some fancy 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": "Some fancy 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": "Some fancy Name",
              "publicName": "string",
              "exposed": true,
              "scheme": {
                "schemeId": "507f191e810c19729de860ea",
                "feeId": "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"
                }
              ]
            }
          }
        ],
        "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"
            }
          }
        ],
        "seatingReservationToken": "string",
        "subscriptionId": "507f191e810c19729de860ea"
      }
    ],
    "realPrice": 10.5,
    "company": "vivenu GmbH",
    "firstname": "string",
    "lastname": "Robot",
    "name": "Some fancy Name",
    "email": "random@mail.com",
    "phone": "string",
    "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"
      }
    ],
    "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"
  }
}

ticket.created

The data of the ticket created webhook event.

Required attributes

Name
ticket
Type
TicketResource
Description
The associated ticket which has been updated
Required nested attributes (10)
Name
_id
Type
string
Description
Name
sellerId
Type
string
Description
The ID of the seller that ticket belongs to.
Name
eventId
Type
string
Description
The ID of the event the ticket belongs to
Name
ticketTypeId
Type
string
Description
The ID of the ticket type this ticket inherits from
Name
ticketName
Type
string
Description
The name of the ticket type this ticket inherits from
Name
createdAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket was created.
Name
updatedAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket was updated.
Name
status
Type
enum(VALID, INVALID, RESERVED, DETAILSREQUIRED, BLANK)
Description
The status of the ticket
Name
secret
Type
string
Description
The secret token of the ticket
Name
barcode
Type
string
Description
The barcode of the ticket
Optional nested attributes (50)
Name
company
Type
string
Description
Name
email
Type
string
Description
Name
name
Type
string
Description
The name of the ticket owner
Name
firstname
Type
string
Description
The first name of the ticket owner
Name
lastname
Type
string
Description
The last name of the ticket owner
Name
street
Type
string
Description
Name
line2
Type
string
Description
The additional address field of the user of the ticket
Name
city
Type
string
Description
Name
postal
Type
string
Description
Name
state
Type
string
Description
The state of the user of the ticket
Name
country
Type
string
Description
The country of the user of the ticket
Name
rootEventId
Type
string
Description
The ID of the root event, if exists
Name
transactionId
Type
string
Description
The transaction the ticket originated from
Name
posId
Type
string
Description
The point of sale the ticket was created on
Name
underShopId
Type
string
Description
The ID of an undershop the ticket was purchased through
Name
categoryRef
Type
string
Description
A UUID of the category the ticket belongs to.
Name
categoryName
Type
string
Description
The name of the category the ticket belongs to.
Name
slotId
Type
string
Description
The ID of the time slot this ticket belongs to, if exists
Name
slotStartTime
Type
string
Description
The start time of the time slot this ticket belongs to, if exists.
Name
cartItemId
Type
string
Description
The ID of the cart item to which the ticket belongs
Name
triggeredBy
Type
array<string>
Description
An array of IDs of cart items which triggered the buy action of the ticket
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
An ISO 4217 3-character code of the currency
Name
regularPrice
Type
number float
Description
The original non discounted price for the ticket
Name
realPrice
Type
number float
Description
The real price for the ticket
Name
completed
Type
boolean
Description
Whether all steps for validating the ticket has been made
Name
expiresAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket will be expired.
Name
seat
Type
string
Description
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
type
Type
enum(SINGLE, MULTI)
Description
The type of the ticket
Name
origin
Type
enum(yourticket, pos, rebooking, upgrade, subscription, transfer)
Description
Name
extraFields
Type
object
Description
A hashmap of extra fields for the ticket
Name
batch
Type
string
Description
A UUId indicating in which batch the tickets were created
Name
batchCounter
Type
number float
Description
A counter indicating the order of the ticket in the batch
Name
deliveryType
Type
enum(HARD, VIRTUAL)
Description
The delivery type of the ticket
Name
readyForDelivery
Type
boolean
Description
Whether the ticket is ready for delivery
Name
customMessage
Type
string
Description
Name
priceCategoryId
Type
string
Description
Name
entryPermissions
Type
array<array | boolean | number | object | string>
Description
Name
customerId
Type
string
Description
Name
history
Type
array<array | boolean | number | object | string>
Description
Name
personalized
Type
boolean
Description
Name
excludedEventIds
Type
array<string>
Description
An array of IDs of events for which the ticket has been blocked
Name
originTicketId
Type
string
Description
The ID of the origin ticket from which the ticket created
Name
fulfillmentTypeId
Type
string
Description
The ID of the fulfillment type used to deliver the ticket
Name
packageInfo
Type
object
Description
The package information of the ticket
Required nested attributes (3)
Name
packageId
Type
string
Description
The ID of the package
Name
packageConfigId
Type
string
Description
The ID of the package configuration
Name
name
Type
string
Description
The name of the package
Name
__v
Type
integer
Description
Name
_locks
Type
array<object>
Description
List of locks on this ticket
Required nested attributes (2)
Name
by
Type
string
Description
Name
at
Type
string date-time
Description
Optional nested attributes (2)
Name
eventId
Type
string
Description
Name
type
Type
enum(resell)
Description
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
personalizations
Type
array<array | boolean | number | object | string>
Description
A list of personalizations of the ticket.

Example

{
  "ticket": {
    "_id": "507f191e810c19729de860ea",
    "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": "4b5fb736-45fd-4895-b497-124a2360c7e6",
    "barcode": "wbf7tkmy",
    "company": "vivenu GmbH",
    "email": "string",
    "name": "Some fancy Name",
    "firstname": "string",
    "lastname": "Robot",
    "street": "Speditionsstr",
    "line2": "string",
    "city": "Düsseldorf",
    "postal": "40221",
    "state": "string",
    "country": "DE",
    "rootEventId": "507f191e810c19729de860ea",
    "transactionId": "507f191e810c19729de860ea",
    "posId": "507f191e810c19729de860ea",
    "underShopId": "507f191e810c19729de860ea",
    "categoryRef": "string",
    "categoryName": "string",
    "slotId": "507f191e810c19729de860ea",
    "slotStartTime": "string",
    "cartItemId": "507f191e810c19729de860ea",
    "triggeredBy": [
      "string"
    ],
    "currency": "EUR",
    "regularPrice": 10.5,
    "realPrice": 10.5,
    "completed": true,
    "expiresAt": "2030-01-23T23:00:00.123Z",
    "seat": "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"
    },
    "type": "SINGLE",
    "origin": "yourticket",
    "extraFields": {},
    "batch": "string",
    "batchCounter": 10.5,
    "deliveryType": "HARD",
    "readyForDelivery": true,
    "customMessage": "string",
    "priceCategoryId": "507f191e810c19729de860ea",
    "entryPermissions": [
      []
    ],
    "customerId": "507f191e810c19729de860ea",
    "history": [
      []
    ],
    "personalized": true,
    "excludedEventIds": [
      "string"
    ],
    "originTicketId": "507f191e810c19729de860ea",
    "fulfillmentTypeId": "507f191e810c19729de860ea",
    "packageInfo": {
      "packageId": "507f191e810c19729de860ea",
      "packageConfigId": "507f191e810c19729de860ea",
      "name": "Some fancy Name"
    },
    "__v": 1,
    "_locks": [
      {
        "by": "string",
        "at": "2030-01-23T23:00:00.123Z",
        "eventId": "507f191e810c19729de860ea",
        "type": "resell"
      }
    ],
    "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
        }
      }
    ],
    "personalizations": [
      []
    ]
  }
}

ticket.updated

The data of the ticket updated webhook event.

Required attributes

Name
ticket
Type
TicketResource
Description
The associated ticket which has been updated
Required nested attributes (10)
Name
_id
Type
string
Description
Name
sellerId
Type
string
Description
The ID of the seller that ticket belongs to.
Name
eventId
Type
string
Description
The ID of the event the ticket belongs to
Name
ticketTypeId
Type
string
Description
The ID of the ticket type this ticket inherits from
Name
ticketName
Type
string
Description
The name of the ticket type this ticket inherits from
Name
createdAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket was created.
Name
updatedAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket was updated.
Name
status
Type
enum(VALID, INVALID, RESERVED, DETAILSREQUIRED, BLANK)
Description
The status of the ticket
Name
secret
Type
string
Description
The secret token of the ticket
Name
barcode
Type
string
Description
The barcode of the ticket
Optional nested attributes (50)
Name
company
Type
string
Description
Name
email
Type
string
Description
Name
name
Type
string
Description
The name of the ticket owner
Name
firstname
Type
string
Description
The first name of the ticket owner
Name
lastname
Type
string
Description
The last name of the ticket owner
Name
street
Type
string
Description
Name
line2
Type
string
Description
The additional address field of the user of the ticket
Name
city
Type
string
Description
Name
postal
Type
string
Description
Name
state
Type
string
Description
The state of the user of the ticket
Name
country
Type
string
Description
The country of the user of the ticket
Name
rootEventId
Type
string
Description
The ID of the root event, if exists
Name
transactionId
Type
string
Description
The transaction the ticket originated from
Name
posId
Type
string
Description
The point of sale the ticket was created on
Name
underShopId
Type
string
Description
The ID of an undershop the ticket was purchased through
Name
categoryRef
Type
string
Description
A UUID of the category the ticket belongs to.
Name
categoryName
Type
string
Description
The name of the category the ticket belongs to.
Name
slotId
Type
string
Description
The ID of the time slot this ticket belongs to, if exists
Name
slotStartTime
Type
string
Description
The start time of the time slot this ticket belongs to, if exists.
Name
cartItemId
Type
string
Description
The ID of the cart item to which the ticket belongs
Name
triggeredBy
Type
array<string>
Description
An array of IDs of cart items which triggered the buy action of the ticket
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
An ISO 4217 3-character code of the currency
Name
regularPrice
Type
number float
Description
The original non discounted price for the ticket
Name
realPrice
Type
number float
Description
The real price for the ticket
Name
completed
Type
boolean
Description
Whether all steps for validating the ticket has been made
Name
expiresAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket will be expired.
Name
seat
Type
string
Description
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
type
Type
enum(SINGLE, MULTI)
Description
The type of the ticket
Name
origin
Type
enum(yourticket, pos, rebooking, upgrade, subscription, transfer)
Description
Name
extraFields
Type
object
Description
A hashmap of extra fields for the ticket
Name
batch
Type
string
Description
A UUId indicating in which batch the tickets were created
Name
batchCounter
Type
number float
Description
A counter indicating the order of the ticket in the batch
Name
deliveryType
Type
enum(HARD, VIRTUAL)
Description
The delivery type of the ticket
Name
readyForDelivery
Type
boolean
Description
Whether the ticket is ready for delivery
Name
customMessage
Type
string
Description
Name
priceCategoryId
Type
string
Description
Name
entryPermissions
Type
array<array | boolean | number | object | string>
Description
Name
customerId
Type
string
Description
Name
history
Type
array<array | boolean | number | object | string>
Description
Name
personalized
Type
boolean
Description
Name
excludedEventIds
Type
array<string>
Description
An array of IDs of events for which the ticket has been blocked
Name
originTicketId
Type
string
Description
The ID of the origin ticket from which the ticket created
Name
fulfillmentTypeId
Type
string
Description
The ID of the fulfillment type used to deliver the ticket
Name
packageInfo
Type
object
Description
The package information of the ticket
Required nested attributes (3)
Name
packageId
Type
string
Description
The ID of the package
Name
packageConfigId
Type
string
Description
The ID of the package configuration
Name
name
Type
string
Description
The name of the package
Name
__v
Type
integer
Description
Name
_locks
Type
array<object>
Description
List of locks on this ticket
Required nested attributes (2)
Name
by
Type
string
Description
Name
at
Type
string date-time
Description
Optional nested attributes (2)
Name
eventId
Type
string
Description
Name
type
Type
enum(resell)
Description
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
personalizations
Type
array<array | boolean | number | object | string>
Description
A list of personalizations of the ticket.

Example

{
  "ticket": {
    "_id": "507f191e810c19729de860ea",
    "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": "4b5fb736-45fd-4895-b497-124a2360c7e6",
    "barcode": "wbf7tkmy",
    "company": "vivenu GmbH",
    "email": "string",
    "name": "Some fancy Name",
    "firstname": "string",
    "lastname": "Robot",
    "street": "Speditionsstr",
    "line2": "string",
    "city": "Düsseldorf",
    "postal": "40221",
    "state": "string",
    "country": "DE",
    "rootEventId": "507f191e810c19729de860ea",
    "transactionId": "507f191e810c19729de860ea",
    "posId": "507f191e810c19729de860ea",
    "underShopId": "507f191e810c19729de860ea",
    "categoryRef": "string",
    "categoryName": "string",
    "slotId": "507f191e810c19729de860ea",
    "slotStartTime": "string",
    "cartItemId": "507f191e810c19729de860ea",
    "triggeredBy": [
      "string"
    ],
    "currency": "EUR",
    "regularPrice": 10.5,
    "realPrice": 10.5,
    "completed": true,
    "expiresAt": "2030-01-23T23:00:00.123Z",
    "seat": "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"
    },
    "type": "SINGLE",
    "origin": "yourticket",
    "extraFields": {},
    "batch": "string",
    "batchCounter": 10.5,
    "deliveryType": "HARD",
    "readyForDelivery": true,
    "customMessage": "string",
    "priceCategoryId": "507f191e810c19729de860ea",
    "entryPermissions": [
      []
    ],
    "customerId": "507f191e810c19729de860ea",
    "history": [
      []
    ],
    "personalized": true,
    "excludedEventIds": [
      "string"
    ],
    "originTicketId": "507f191e810c19729de860ea",
    "fulfillmentTypeId": "507f191e810c19729de860ea",
    "packageInfo": {
      "packageId": "507f191e810c19729de860ea",
      "packageConfigId": "507f191e810c19729de860ea",
      "name": "Some fancy Name"
    },
    "__v": 1,
    "_locks": [
      {
        "by": "string",
        "at": "2030-01-23T23:00:00.123Z",
        "eventId": "507f191e810c19729de860ea",
        "type": "resell"
      }
    ],
    "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
        }
      }
    ],
    "personalizations": [
      []
    ]
  }
}

purchaseIntent.created

The data of the purchase intent created webhook event.

Required attributes

Name
purchaseIntent
Type
PurchaseIntentResource
Description
The associated purchase intent which has been cancelled
Required nested attributes (14)
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 nested attributes (31)
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

{
  "purchaseIntent": {
    "_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
  }
}

purchaseIntent.updated

The data of the purchase intent updated webhook event.

Required attributes

Name
purchaseIntent
Type
PurchaseIntentResource
Description
The associated purchase intent which has been cancelled
Required nested attributes (14)
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 nested attributes (31)
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

{
  "purchaseIntent": {
    "_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
  }
}

purchaseIntent.completed

The data of the purchase intent completed webhook event.

Required attributes

Name
purchaseIntent
Type
PurchaseIntentResource
Description
The associated purchase intent which has been cancelled
Required nested attributes (14)
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 nested attributes (31)
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

{
  "purchaseIntent": {
    "_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
  }
}

purchaseIntent.approved

The data of the purchase intent approved webhook event.

Required attributes

Name
purchaseIntent
Type
PurchaseIntentResource
Description
The associated purchase intent which has been cancelled
Required nested attributes (14)
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 nested attributes (31)
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

{
  "purchaseIntent": {
    "_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
  }
}

purchaseIntent.rejected

The data of the purchase intent rejected webhook event.

Required attributes

Name
purchaseIntent
Type
PurchaseIntentResource
Description
The associated purchase intent which has been cancelled
Required nested attributes (14)
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 nested attributes (31)
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

{
  "purchaseIntent": {
    "_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
  }
}

purchaseIntent.expired

The data of the purchase intent expired webhook event.

Required attributes

Name
purchaseIntent
Type
PurchaseIntentResource
Description
The associated purchase intent which has been cancelled
Required nested attributes (14)
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 nested attributes (31)
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

{
  "purchaseIntent": {
    "_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
  }
}

purchaseIntent.cancelled

The data of the purchase intent cancelled webhook event.

Required attributes

Name
purchaseIntent
Type
PurchaseIntentResource
Description
The associated purchase intent which has been cancelled
Required nested attributes (14)
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 nested attributes (31)
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

{
  "purchaseIntent": {
    "_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
  }
}

customer.created

The data of the customer created webhook event.

Required attributes

Name
customer
Type
CustomerResource
Description
The associated customer which has been updated
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the customer
Name
primaryEmail
Type
string email
Description
The primary email of the customer
Optional nested attributes (21)
Name
company
Type
string
Description
The company of the customer
Name
name
Type
string
Description
The name of the customer collected from first name and last name
Name
prename
Type
string
Description
The first name of the customer
Name
lastname
Type
string
Description
The lastname of the customer
Name
image
Type
string
Status
deprecated
Description
The image of the customer
Name
number
Type
number float
Description
The number of the customer. Need to be unique and incrementing
Name
phone
Type
string
Description
The phone number of the customer
Name
location
Type
object
Description
The location of the customer
Optional nested attributes (8)
Name
street
Type
string
Description
The street of the location
Name
line2
Type
string
Description
The additional address fields of the location
Name
postal
Type
string
Description
The postal of the location
Name
city
Type
string
Description
The city of the location
Name
locale
Type
string
Status
deprecated
Description
The locale of the location
Name
state
Type
string
Description
The state of the location
Name
center
Type
array<number>
Status
deprecated
Description
The center of the location
Name
country
Type
string
Description
An ISO-3166-1 Alpha 2 country code of the location
Name
sellerId
Type
string
Description
The ID of the seller of the customer
Name
notes
Type
string
Description
Notes of the customer
Name
extraFields
Type
object
Description
Extra fields of the customer
Name
tags
Type
array<string>
Description
An array of tags
Name
segments
Type
array<string>
Description
An array of segment slugs, read only
Name
blocked
Type
boolean
Description
Whether the customer is blocked
Name
verified
Type
boolean
Description
Whether the customer is verified
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
_account
Type
object
Description
Account specific information about the customer
Optional nested attributes (4)
Name
verificationToken
Type
string
Description
The verification token will be sent to the customer via email within a verification link, which can be used to verify the account of the customer
Name
passwordResetToken
Type
string
Description
The password reset token will be sent within a password reset link via email, which can be used by the customer to reset its password
Name
limitations
Type
object
Description
Account specific limitations of the customer
Optional nested attributes (1)
Name
nextVerificationMailRequest
Type
string date-time
Description
An ISO timestamp indicating when the next verification mail request can be sent
Name
loginType
Type
enum(password, identityprovider)
Description
The login type of the customer.
Name
meta
Type
object
Description
Custom key-value data. Metadata is useful for storing additional, structured information on an object.
Name
externalId
Type
string
Description
An external identifier of the customer
Name
createdAt
Type
string date-time
Description
An ISO timestamp indicating when the customer was created
Name
updatedAt
Type
string date-time
Description
An ISO timestamp indicating when the customer was updated

Example

{
  "customer": {
    "_id": "507f191e810c19729de860ea",
    "primaryEmail": "random@mail.com",
    "company": "vivenu GmbH",
    "name": "Some fancy Name",
    "prename": "John",
    "lastname": "Robot",
    "image": "https://your-url/image.png",
    "number": 10.5,
    "phone": "string",
    "location": {
      "street": "Speditionsstr",
      "line2": "string",
      "postal": "40221",
      "city": "Düsseldorf",
      "locale": "string",
      "state": "string",
      "center": [
        10.5
      ],
      "country": "DE"
    },
    "sellerId": "507f191e810c19729de860ea",
    "notes": "string",
    "extraFields": {},
    "tags": [
      "string"
    ],
    "segments": [
      "string"
    ],
    "blocked": true,
    "verified": true,
    "identification": [
      {
        "type": "france_siren",
        "identifier": "string"
      }
    ],
    "_account": {
      "verificationToken": "string",
      "passwordResetToken": "string",
      "limitations": {
        "nextVerificationMailRequest": "2030-01-23T23:00:00.123Z"
      },
      "loginType": "password"
    },
    "meta": {},
    "externalId": "507f191e810c19729de860ea",
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z"
  }
}

customer.updated

The data of the customer updated webhook event.

Required attributes

Name
customer
Type
CustomerResource
Description
The associated customer which has been updated
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the customer
Name
primaryEmail
Type
string email
Description
The primary email of the customer
Optional nested attributes (21)
Name
company
Type
string
Description
The company of the customer
Name
name
Type
string
Description
The name of the customer collected from first name and last name
Name
prename
Type
string
Description
The first name of the customer
Name
lastname
Type
string
Description
The lastname of the customer
Name
image
Type
string
Status
deprecated
Description
The image of the customer
Name
number
Type
number float
Description
The number of the customer. Need to be unique and incrementing
Name
phone
Type
string
Description
The phone number of the customer
Name
location
Type
object
Description
The location of the customer
Optional nested attributes (8)
Name
street
Type
string
Description
The street of the location
Name
line2
Type
string
Description
The additional address fields of the location
Name
postal
Type
string
Description
The postal of the location
Name
city
Type
string
Description
The city of the location
Name
locale
Type
string
Status
deprecated
Description
The locale of the location
Name
state
Type
string
Description
The state of the location
Name
center
Type
array<number>
Status
deprecated
Description
The center of the location
Name
country
Type
string
Description
An ISO-3166-1 Alpha 2 country code of the location
Name
sellerId
Type
string
Description
The ID of the seller of the customer
Name
notes
Type
string
Description
Notes of the customer
Name
extraFields
Type
object
Description
Extra fields of the customer
Name
tags
Type
array<string>
Description
An array of tags
Name
segments
Type
array<string>
Description
An array of segment slugs, read only
Name
blocked
Type
boolean
Description
Whether the customer is blocked
Name
verified
Type
boolean
Description
Whether the customer is verified
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
_account
Type
object
Description
Account specific information about the customer
Optional nested attributes (4)
Name
verificationToken
Type
string
Description
The verification token will be sent to the customer via email within a verification link, which can be used to verify the account of the customer
Name
passwordResetToken
Type
string
Description
The password reset token will be sent within a password reset link via email, which can be used by the customer to reset its password
Name
limitations
Type
object
Description
Account specific limitations of the customer
Optional nested attributes (1)
Name
nextVerificationMailRequest
Type
string date-time
Description
An ISO timestamp indicating when the next verification mail request can be sent
Name
loginType
Type
enum(password, identityprovider)
Description
The login type of the customer.
Name
meta
Type
object
Description
Custom key-value data. Metadata is useful for storing additional, structured information on an object.
Name
externalId
Type
string
Description
An external identifier of the customer
Name
createdAt
Type
string date-time
Description
An ISO timestamp indicating when the customer was created
Name
updatedAt
Type
string date-time
Description
An ISO timestamp indicating when the customer was updated

Example

{
  "customer": {
    "_id": "507f191e810c19729de860ea",
    "primaryEmail": "random@mail.com",
    "company": "vivenu GmbH",
    "name": "Some fancy Name",
    "prename": "John",
    "lastname": "Robot",
    "image": "https://your-url/image.png",
    "number": 10.5,
    "phone": "string",
    "location": {
      "street": "Speditionsstr",
      "line2": "string",
      "postal": "40221",
      "city": "Düsseldorf",
      "locale": "string",
      "state": "string",
      "center": [
        10.5
      ],
      "country": "DE"
    },
    "sellerId": "507f191e810c19729de860ea",
    "notes": "string",
    "extraFields": {},
    "tags": [
      "string"
    ],
    "segments": [
      "string"
    ],
    "blocked": true,
    "verified": true,
    "identification": [
      {
        "type": "france_siren",
        "identifier": "string"
      }
    ],
    "_account": {
      "verificationToken": "string",
      "passwordResetToken": "string",
      "limitations": {
        "nextVerificationMailRequest": "2030-01-23T23:00:00.123Z"
      },
      "loginType": "password"
    },
    "meta": {},
    "externalId": "507f191e810c19729de860ea",
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z"
  }
}

event.created

The data of the event created webhook event.

Required attributes

Name
event
Type
EventResource
Description
The associated event which has been deleted
Required nested attributes (6)
Name
_id
Type
string
Description
The ID of the event
Name
name
Type
string
Description
The name of the event
Name
start
Type
string date-time
Description
An ISO timestamp indicating when the event starts
Name
end
Type
string date-time
Description
An ISO timestamp indicating when the event ends
Name
maxAmount
Type
number float
Description
Maximum amount of tickets of the event
Name
maxAmountPerOrder
Type
number float
Description
Maximum amount of tickets per order of the event
Optional nested attributes (73)
Name
sellerId
Type
string
Description
The ID of the seller owning this event
Name
slogan
Type
string
Description
The slogan of the event
Name
description
Type
string
Description
A description about the event. Description is in RichText - JSON format.
Name
locationName
Type
string
Description
The name of the location where the event takes place
Name
locationStreet
Type
string
Description
The street of the location where the event takes place
Name
locationCity
Type
string
Description
The city of the location where the event takes place
Name
locationPostal
Type
string
Description
The postal code of the location where the event takes place
Name
locationCountry
Type
string
Description
The country code of the location where the event takes place
Name
image
Type
string
Description
An image for the event
Name
ticketFooter
Type
string
Description
A footer image for the ticket PDF of the event
Name
ticketBackground
Type
string
Description
A background image for the ticket PDF of the event
Name
ticketShopHeader
Type
string
Description
A header image for the ticket shop of the event
Name
groups
Type
array<object>
Description
An array of groups of ticket types of the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of of the ticket group of the event
Name
name
Type
string
Description
The name of the ticket group of the event
Name
tickets
Type
array<string>
Description
An array of ID's of ticket types of the event
Name
discountGroups
Type
array<object>
Description
An array of discount groups of the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the discount group of the event
Name
name
Type
string
Description
The name of the discount group of the event
Name
value
Type
number float
Description
The value of the discount group
Optional nested attributes (2)
Name
rules
Type
array<object>
Description
An array of rules of the discount group
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the discount group rule
Name
min
Type
number float
Description
Minimum amount of tickets where the discount is valid
Name
max
Type
number float
Description
Maximum amount of tickets where the discount is valid
Optional nested attributes (2)
Name
group
Type
string
Description
The ID of the discount group
Name
type
Type
enum(ticketGroups, cartSum)
Description
The type of the discount rule. ticketGroups is the type for tickets. cartSum is the type for sum of a cart
Name
discountType
Type
enum(TOTAL, PERCENTAGE, fix, var, fixPerItem, waiveFees)
Description
The type of the discount group. TOTAL = absolute discount. PERCENTAGE = percentage discount. fix = fixed discount. var = variable discount
Name
cartAutomationRules
Type
array<object>
Description
An array of automation rules for carts of the event
Required nested attributes (5)
Name
_id
Type
string
Description
The ID of the cart automation rule
Name
name
Type
string
Description
The name of the automation rule for carts of the event
Name
triggerType
Type
enum(hasBeenAdded)
Description
The trigger type of the automation rule.
Name
triggerTargetGroup
Type
string
Description
The trigger target group of the rule. The ID of a ticket group
Name
thenType
Type
enum(autoAdd, chooseFrom)
Description
The type of thenType of the rule. autoAdd = is the type to add automatically to cart. chooseFrom = is the type to choose from e.g. another ticket group
Optional nested attributes (1)
Name
thenTargets
Type
array<object>
Description
The target of the then type
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the then target
Optional nested attributes (3)
Name
thenTargetGroup
Type
string
Description
The ID of the ticket group 'then' refers to
Name
thenTargetMin
Type
number float
Description
Minimum amount of tickets where the then action is valid
Name
thenTargetMax
Type
number float
Description
Maximum amount of tickets where the then action is valid
Name
posDiscounts
Type
array<object>
Description
An array of POS discounts of the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the POS discount
Name
name
Type
string
Description
The name of the POS discount
Name
value
Type
number float
Description
The value of the POS discount
Optional nested attributes (1)
Name
discountType
Type
enum(TOTAL, PERCENTAGE, fix, var, fixPerItem, waiveFees)
Description
The type of the POS discount
Name
categories
Type
array<object>
Description
An array of ticket categories of the event
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the ticket category of the event
Name
name
Type
string
Description
The name of the ticket category of the event
Optional nested attributes (7)
Name
description
Type
string
Description
The description of the ticket category of the event
Name
seatingReference
Type
string
Description
The ID of the seating category
Name
ref
Type
string
Description
The reference to identify the seating category
Name
amount
Type
number float
Description
The amount of available tickets of the category of the event
Name
recommendedTicket
Type
string
Description
Recommended ticket of the category
Name
maxAmountPerOrder
Type
number float
Description
Maximum amount per order of the category
Name
listWithoutSeats
Type
boolean
Description
Whether this category can be sold without seats
Name
tickets
Type
array<object>
Description
An array of ticket types of the event
Required nested attributes (5)
Name
_id
Type
string
Description
The ID of the ticket type of the event
Name
name
Type
string
Description
The name of the ticket type of the event
Name
price
Type
number float
Description
The price of the ticket type of the event
Name
amount
Type
number float
Description
The amount of the ticket type of the event
Name
active
Type
boolean
Description
Whether the ticket type of the event is active
Optional nested attributes (35)
Name
description
Type
string
Description
The description of the ticket type of the event
Name
image
Type
string
Description
The image of the ticket type of the event
Name
color
Type
string
Description
The font color of the ticket type of the event
Name
posActive
Type
boolean
Description
Whether POS for the ticket type of the event is active
Name
categoryRef
Type
string
Description
The reference of the category of the ticket type of the event
Name
ignoredForStartingPrice
Type
boolean
Description
Whether the price of the ticket type should be ignored on starting price determination of the event
Name
conditionalAvailability
Type
boolean
Description
Whether rules can be operated on the ticket type
Name
ticketBackground
Type
string
Description
The background for the ticket PDF of the ticket type
Name
rules
Type
array<object>
Description
An array of rules for the ticket type of the event
Required nested attributes (4)
Name
_id
Type
string
Description
The ID of the ticket type rule
Name
ticketGroup
Type
string
Description
The ID of the ticket group to operate the rule on
Name
min
Type
number float
Description
Minimum amount of tickets where the rule is active
Name
max
Type
number float
Description
Maximum amount of tickets where the rule is active
Name
requiresPersonalization
Type
boolean
Status
deprecated
Description
Deprecated, use requiresPersonalizationMode instead
Name
requiresPersonalizationMode
Type
enum(ENABLED, DISABLED)
Description
Whether the ticket type of the event needs personalization
Name
requiresExtraFields
Type
boolean
Status
deprecated
Description
Deprecated, use requiresExtraFieldsMode instead
Name
requiresExtraFieldsMode
Type
enum(ENABLED, DISABLED)
Description
Whether the ticket type of the event needs extra fields
Name
repersonalizationAllowedMode
Type
enum(ENABLED, DISABLED)
Description
Whether re-personalization (name changes) is allowed for this ticket type. When unset, inherits the event-level repersonalizationAllowed. Enables flex-ticket-like re-personalization without an addon.
Name
repersonalizationFee
Type
number float
Description
The per-ticket fee for repersonalization.
Name
sortingKey
Type
number float
Description
The key to sort the ticket type within the ticket group
Name
enableHardTicketOption
Type
boolean
Description
Whether the ticket type is a hard ticket
Name
forceHardTicketOption
Type
boolean
Description
Whether to force the hard ticket option
Name
maxAmountPerOrder
Type
number float
Description
Maximum amount per order of the ticket type
Name
minAmountPerOrder
Type
number float
Description
Minimum amount per order of the ticket type
Name
minAmountPerOrderRule
Type
number float
Description
Minimum amount of the ticket type, where the minAmountPerOrder goes active
Name
taxRate
Type
number float
Description
The tax rate of the ticket type of the event
Name
styleOptions
Type
object
Description
Style options of the ticket type
Optional nested attributes (3)
Name
thumbnailImage
Type
string
Description
Thumbnail of the ticket type, which will be displayed on checkout
Name
showAvailable
Type
boolean
Description
Whether to show availability of the ticket type
Name
hiddenInSelectionArea
Type
boolean
Description
Whether to show this ticket in the selection area
Name
priceCategoryId
Type
string
Description
The ID of the price category of the ticket type
Name
entryPermissions
Type
array<string>
Description
An array of IDs of entry permissions where the ticket buyer has access to certain areas
Name
ignoreForMaxAmounts
Type
boolean
Description
Do not include tickets if this typw when calculating available amount in categories and event
Name
expirationSettings
Type
object
Description
Expiration settings of the ticket type.
Optional nested attributes (2)
Name
enabled
Type
boolean
Description
Whether expiration enabled for the event ticket types
Name
expiresAfter
Type
object
Description
If enabled = true. A relatve date specification until when ticket is valid.
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
barcodePrefix
Type
string
Description
Characters that precede the barcodes of tickets.
Name
salesStart
Type
object
Description
A relative date before the end of the event, when the sale of this ticket type starts
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
salesEnd
Type
object
Description
A relative date before the end of the event, when the sale of this ticket type ends
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
transferSettings
Type
object
Description
Transfer settings of the ticket type.
Optional nested attributes (6)
Name
mode
Type
enum(ALLOWED, DISABLED)
Description
Ticket transfer mode.
Name
expiresAfter
Type
object
Description
If 'mode = ALLOWED'. A relatve date specification until when ticket transfer is valid.
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
retransferMode
Type
enum(ALLOWED, DISABLED)
Description
Ticket retransfer mode.
Name
allowedUntil
Type
object
Description
If 'mode = ALLOWED'. A relatve date specification until the end of the event where ticket transfer is possible.
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
hardTicketsMode
Type
enum(ALLOWED, DISABLED)
Description
If 'hardTicketsMode = ALLOWED' then hard tickets transfers allowed.
Name
seasonTicketMode
Type
enum(NO_RESTRICTION, CHILDREN_ONLY, GROUP_ONLY)
Description
Restrict how season tickets can be transferred.
Name
scanSettings
Type
object
Description
Scan settings of the ticket type.
Optional nested attributes (2)
Name
feedback
Type
enum(highlight)
Description
Feedback mode during scanning of the ticket
Name
allowedScanCount
Type
number float
Description
Number of times a ticket is allowed to be scanned as valid
Name
deliverySettings
Type
object
Description
Delivery settings of the ticket type.
Optional nested attributes (2)
Name
wallet
Type
object
Description
Optional nested attributes (1)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
pdf
Type
object
Description
Optional nested attributes (1)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
meta
Type
object
Description
Custom key-value data. Metadata is useful for storing additional, structured information on an object.
Name
revealingSettings
Type
object
Description
Barcode reveal settings of the ticket type.
Optional nested attributes (2)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
beforeEvent
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
createdAt
Type
string date-time
Description
An ISO timestamp indicating when the event was created
Name
updatedAt
Type
string date-time
Description
An ISO timestamp indicating when the event was updated
Name
sellStart
Type
string date-time
Description
An ISO timestamp indicating when the event sale starts
Name
sellEnd
Type
string date-time
Description
An ISO timestamp indicating when the event sale ends
Name
maxAmountPerCustomer
Type
number float
Description
Maximum amount of tickets per customer of the event
Name
maxTransactionsPerCustomer
Type
number float
Description
Maximum amount of transactions per customer of the event
Name
minAmountPerOrder
Type
number float
Description
Minimum amount of tickets per order
Name
customerTags
Type
array<string>
Description
An array of customer tags of the event
Name
customerSegments
Type
array<string>
Description
An array of customer segments of the event
Name
showCountdown
Type
boolean
Description
Whether the countdown should be visible till event start
Name
hideInListing
Type
boolean
Description
Whether the event should be hide in listings
Name
visibleAfter
Type
string date-time
Description
An ISO timestamp indicating when the event is visible in listings.
Name
customSettings
Type
object
Description
Custom settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the custom settings of the event
Optional nested attributes (22)
Name
hideTicketsInTransactionPage
Type
boolean
Description
Whether the ticket types of the event should be visible on transaction page
Name
dontSendTicketMail
Type
boolean
Description
Whether an email should be sent of tickets of the event
Name
dontSendBookingConfirmationMail
Type
boolean
Description
Whether an email should be sent for booking confirmation
Name
customMailHeaderImage
Type
string
Description
A custom header image of the mail for ticket types of the event
Name
customTransactionCompletionText
Type
string
Description
A custom transaction completion text for completed transactions of the event
Name
disableAppleWallet
Type
boolean
Status
deprecated
Description
Whether the Apple and Google Wallet functionality should be disabled on the event. Deprecated: use event.deliverySettings.wallet instead
Name
disablePdfTickets
Type
boolean
Status
deprecated
Description
Whether the PDF tickets download functionality should be disabled on the event. Deprecated: use event.deliverySettings.pdf instead
Name
showStartDate
Type
boolean
Description
Whether the start date of the event should be visible on listings
Name
showStartTime
Type
boolean
Description
Whether the start time of the event should be visible on listings
Name
showEndDate
Type
boolean
Description
Whether the end date of the event should be visible on listings
Name
showEndTime
Type
boolean
Description
Whether the end time of the event should be visible on listings
Name
showTimeRangeInListing
Type
boolean
Status
deprecated
Description
Whether the end time of the event should be visible on listings
Name
showTimeRangeInTicket
Type
boolean
Description
Whether the time range of the event should be visible on ticket PDFs
Name
customCheckoutCSS
Type
string
Description
Custom CSS styling of the checkout of the event
Name
useCustomCheckoutBrand
Type
boolean
Description
Whether the checkout of the event should use custom brand
Name
customCheckoutBrand
Type
string
Description
A custom checkout brand of the event
Name
hideLogoInCheckout
Type
boolean
Description
Whether the logo should be hide on the checkout of the event
Name
customEventPageHTML
Type
string
Description
A custom HTML of the event page
Name
customEventPageCSS
Type
string
Description
A custom css styling of the event page
Name
customConfirmationPage
Type
string
Description
A custom css styling of the event page
Name
hideSeatmapInCheckout
Type
boolean
Description
Hides the seatmap from the ticket buyer even if seating ticket types are available
Name
dontSendBookingConfirmationSMS
Type
boolean
Description
Whether a sms should be sent for booking confirmation
Name
extraFields
Type
array<object>
Description
An array of extra fields of the event
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the extra field
Name
required
Type
boolean
Description
Whether the extra field is required
Optional nested attributes (11)
Name
name
Type
string
Description
The name of the extra field
Name
description
Type
string
Description
The description of the extra field
Name
collectInCheckout
Type
boolean
Description
Whether the extra field is collected in checkout
Name
deleted
Type
boolean
Description
Whether the extra field is deleted
Name
type
Type
enum(text, number, select, checkbox, tel, country, email, date, documentUpload, signature, address)
Description
The type of the extra field. text = is a text field. number = is a number field. select = is a selection field of different selections. checkbox = is a checkbox field. tel = is a number field for a phone number. email = is a text field for an email. country = is a text field field for country.
Name
options
Type
array<string>
Description
An array of options of the extra field
Name
onlyForCertainTicketTypes
Type
boolean
Description
Whether the extra field is only for certain ticket types
Name
allowedTicketTypes
Type
array<string>
Description
An array of IDs of the ticket types allowed for the extra field
Name
printable
Type
boolean
Description
Whether the extra field is printable
Name
conditions
Type
array<object>
Description
An array of conditions of the extra field. The conditions can refer to other extra fields.
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the condition
Name
baseSlug
Type
string
Description
The slug of the base extra field which the condition refers to
Name
operator
Type
enum(equals, notEquals, greaterThan, lessThan, greaterThanOrEquals, lessThanOrEquals, exists, notExists)
Description
The operator which will be used to check the condition
Optional nested attributes (1)
Name
value
Type
array | boolean | number | object | string
Description
The value which the operator will be used on to check the condition.
Name
settings
Type
oneOf
Description
Type-specific settings for the extra field
One of — Only one of the following types
Optional attributes
Name
allowedMimeTypes
Type
array<enum(application/pdf, image/jpeg, image/png)>
Description
Name
ticketExtraFields
Type
array<object>
Description
An array of extra fields for ticket types of the event
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the extra field
Name
required
Type
boolean
Description
Whether the extra field is required
Optional nested attributes (11)
Name
name
Type
string
Description
The name of the extra field
Name
description
Type
string
Description
The description of the extra field
Name
collectInCheckout
Type
boolean
Description
Whether the extra field is collected in checkout
Name
deleted
Type
boolean
Description
Whether the extra field is deleted
Name
type
Type
enum(text, number, select, checkbox, tel, country, email, date, documentUpload, signature, address)
Description
The type of the extra field. text = is a text field. number = is a number field. select = is a selection field of different selections. checkbox = is a checkbox field. tel = is a number field for a phone number. email = is a text field for an email. country = is a text field field for country.
Name
options
Type
array<string>
Description
An array of options of the extra field
Name
onlyForCertainTicketTypes
Type
boolean
Description
Whether the extra field is only for certain ticket types
Name
allowedTicketTypes
Type
array<string>
Description
An array of IDs of the ticket types allowed for the extra field
Name
printable
Type
boolean
Description
Whether the extra field is printable
Name
conditions
Type
array<object>
Description
An array of conditions of the extra field. The conditions can refer to other extra fields.
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the condition
Name
baseSlug
Type
string
Description
The slug of the base extra field which the condition refers to
Name
operator
Type
enum(equals, notEquals, greaterThan, lessThan, greaterThanOrEquals, lessThanOrEquals, exists, notExists)
Description
The operator which will be used to check the condition
Optional nested attributes (1)
Name
value
Type
array | boolean | number | object | string
Description
The value which the operator will be used on to check the condition.
Name
settings
Type
oneOf
Description
Type-specific settings for the extra field
One of — Only one of the following types
Optional attributes
Name
allowedMimeTypes
Type
array<enum(application/pdf, image/jpeg, image/png)>
Description
Name
accentColor
Type
string
Description
The accent color of the event page
Name
pageStyle
Type
string
Description
The page style of the event page
Name
showOtherEvents
Type
boolean
Description
Whether other events should be displayed on the event page
Name
underShops
Type
array<object>
Description
An array of under shops of the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the under shop of the event
Name
name
Type
string
Description
The name of the under shop of the event
Name
active
Type
boolean
Description
Whether the under shop is active
Optional nested attributes (25)
Name
tickets
Type
array<object>
Description
An array of ticket types of the under shop
Required nested attributes (6)
Name
_id
Type
string
Description
The ID of ticket type extension of the event under shop
Name
baseTicket
Type
string
Description
The ID of a ticket type of the event used as base ticket type
Name
name
Type
string
Description
The name of the ticket type
Name
price
Type
number float
Description
The price of the ticket type
Name
amount
Type
number float
Description
The amount of the ticket type
Name
active
Type
boolean
Description
Whether the ticket type is active
Optional nested attributes (1)
Name
description
Type
string
Description
The description of the ticket type
Name
categories
Type
array<object>
Description
The array of ticket categories of the under shop
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of ticket category extension
Name
baseCategoryId
Type
string
Description
The ID of a ticket category of the event used as base ticket category
Optional nested attributes (2)
Name
amount
Type
number float
Description
The amount of the ticket category
Name
maxAmountPerOrder
Type
number float
Description
The maximum amount per order of the ticket category
Name
timeSlots
Type
array<object>
Description
The array of time slots of the under shop
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of time slot extension
Name
baseTimeSlotId
Type
string
Description
The ID of a time slot of the event used as base time slot
Name
amount
Type
number float
Description
The amount of the time slot
Optional nested attributes (1)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Whether the time slot enabled for under shop.
Name
sellStart
Type
string date-time
Description
The sell start of the under shop. Optional for ROOT events only
Name
sellEnd
Type
string date-time
Description
The sell end of the under shop. Optional for ROOT events only
Name
maxAmount
Type
number float
Description
The maximum amount of tickets of the under shop
Name
maxAmountPerOrder
Type
number float
Description
The maximum amount per order of the under shop
Name
minAmountPerOrder
Type
number float
Description
The minimum amount per order of the under shop
Name
maxTransactionsPerCustomer
Type
number float
Description
The maximum amount of transactions per customer of the under shop
Name
maxAmountPerCustomer
Type
number float
Description
Maximum amount of tickets per customer of the event
Name
ticketShopHeaderText
Type
string
Description
The header of the ticket shop of the under shop
Name
customCharges
Type
object
Description
Custom charges of the under shop
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the custom charge
Optional nested attributes (7)
Name
outerChargeVar
Type
number float
Description
The variable outer charge of the custom charge
Name
innerChargeVar
Type
number float
Description
The variable inner charge of the custom charge
Name
outerChargeFix
Type
number float
Description
The fix outer charge of the custom charge
Name
innerChargeFix
Type
number float
Description
The fix inner charge of the custom charge
Name
posOuterChargeFix
Type
number float
Description
The fix POS outer charge of the custom charge
Name
posOuterChargeVar
Type
number float
Description
The variable POS outer charge of the custom charge
Name
cartOuterChargeFix
Type
number float
Description
The fix cart outer charge of the custom charge
Name
seatingContingents
Type
array<string>
Description
An array of seating contingents of the under shop
Name
availabilityMode
Type
enum(default, contingentsOnly)
Description
The availability mode of the shop
Name
bestAvailableSeatingConfiguration
Type
object
Description
The best available seating options of the under shop
Optional nested attributes (3)
Name
enabled
Type
boolean
Description
Whether the best available seating is enabled
Name
enforced
Type
boolean
Description
Whether the best available seating is the only option to buy seated tickets. Seatmap won't be shown during checkout
Name
allowMassBooking
Type
boolean
Description
Whether the best available seating allows to buy seated tickets in bulk.
Name
reservationSettings
Type
object
Description
The reservation settings of the under shop
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the reservation setting
Optional nested attributes (2)
Name
option
Type
enum(noReservations, reservationsOnly, reservationsAndPayment, internalReservationsAndPayment)
Description
The option of the reservation setting. reservationsOnly = needs reservation only. noReservations = no reservations needed. reservationsAndPayment = needs reservation and payment
Name
strategyId
Type
string
Description
The ID of the strategy of a purchase intents to be used on the event
Name
accountSettings
Type
object
Description
Account settings of the under shop
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the account settings of the event
Optional nested attributes (2)
Name
enforceAccounts
Type
boolean
Status
deprecated
Description
Whether to enforce accounts for the event
Name
enforceAuthentication
Type
enum(DISABLED, PREVENT_CHECKOUT, PREVENT_DETAILS_STEP)
Description
Whether to enforce authentication for the event and how to enforce it
Name
customerTags
Type
array<string>
Description
An array of customer tags of the under shop
Name
customerSegments
Type
array<string>
Description
An array of customer segments of the under shop
Name
allowMassDownload
Type
boolean
Description
Enables option to download bulk tickets as a CSV or PDF file.
Name
inventoryStrategy
Type
enum(independent, subsidiary, global)
Description
Sets how available tickets will be calculated
Name
extraFields
Type
array<object>
Description
An array of extra fields of the under shop
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the extra field
Name
required
Type
boolean
Description
Whether the extra field is required
Optional nested attributes (11)
Name
name
Type
string
Description
The name of the extra field
Name
description
Type
string
Description
The description of the extra field
Name
collectInCheckout
Type
boolean
Description
Whether the extra field is collected in checkout
Name
deleted
Type
boolean
Description
Whether the extra field is deleted
Name
type
Type
enum(text, number, select, checkbox, tel, country, email, date, documentUpload, signature, address)
Description
The type of the extra field. text = is a text field. number = is a number field. select = is a selection field of different selections. checkbox = is a checkbox field. tel = is a number field for a phone number. email = is a text field for an email. country = is a text field field for country.
Name
options
Type
array<string>
Description
An array of options of the extra field
Name
onlyForCertainTicketTypes
Type
boolean
Description
Whether the extra field is only for certain ticket types
Name
allowedTicketTypes
Type
array<string>
Description
An array of IDs of the ticket types allowed for the extra field
Name
printable
Type
boolean
Description
Whether the extra field is printable
Name
conditions
Type
array<object>
Description
An array of conditions of the extra field. The conditions can refer to other extra fields.
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the condition
Name
baseSlug
Type
string
Description
The slug of the base extra field which the condition refers to
Name
operator
Type
enum(equals, notEquals, greaterThan, lessThan, greaterThanOrEquals, lessThanOrEquals, exists, notExists)
Description
The operator which will be used to check the condition
Optional nested attributes (1)
Name
value
Type
array | boolean | number | object | string
Description
The value which the operator will be used on to check the condition.
Name
settings
Type
oneOf
Description
Type-specific settings for the extra field
One of — Only one of the following types
Optional attributes
Name
allowedMimeTypes
Type
array<enum(application/pdf, image/jpeg, image/png)>
Description
Name
salesChannelGroupSettings
Type
array<object>
Description
An array of sales channel group settings associated with the under shop
Required nested attributes (1)
Name
salesChannelGroupId
Type
string
Description
The ID of the associated sales channel group
Optional nested attributes (1)
Name
enabled
Type
boolean
Description
Whether the sales channel group is enabled
Name
paymentSettings
Type
object
Description
The payment settings of the event
Optional nested attributes (1)
Name
paymentStrategyId
Type
string
Description
The ID of the associated payment strategy
Name
unlockMode
Type
enum(none, couponCode)
Description
Sets how event is locked, e.g. by coupon code.
Name
seating
Type
object
Description
The seating of the event
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the seating
Name
active
Type
boolean
Description
Whether the seating is active
Optional nested attributes (8)
Name
eventKey
Type
string
Description
The key of the event of the seating
Name
eventId
Type
string
Description
The ID of the event of the seating
Name
seatMapId
Type
string
Description
The ID of the seat map of the event
Name
revisionId
Type
string
Description
The ID of the revision of the event
Name
orphanConfiguration
Type
object
Description
The orphan configuration of the seating
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the seating orphan configuration
Optional nested attributes (2)
Name
minSeatDistance
Type
number float
Description
Minimum distance of seats to each other
Name
edgeSeatsOrphaning
Type
boolean
Description
Whether the edge seats can orphaning
Name
contingents
Type
array<string>
Description
An array of seating contingent ids
Name
availabilityMode
Type
enum(default, contingentsOnly)
Description
The seating availability mode
Name
bestAvailableSeatingConfiguration
Type
object
Description
The best available seating configuration of the seating
Optional nested attributes (2)
Name
enabled
Type
boolean
Description
Whether the best available seating is enabled
Name
enforced
Type
boolean
Description
Whether the best available seating is the only option to buy seated tickets. Seatmap won't be shown during checkout
Name
customTextConfig
Type
object
Description
The custom text configuration of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the custom text configuration
Optional nested attributes (1)
Name
buyTicketsCTA
Type
string
Description
The custom CTA after buy tickets
Name
eventType
Type
enum(SINGLE, GROUP, RECURRENCE, ROOT)
Description
The type of the event. SINGLE = it is a single event. GROUP = the event is part of a group of events
Name
childEvents
Type
array<string>
Description
An array of IDs of child events
Name
url
Type
string
Description
The url of the event
Name
tags
Type
array<string>
Description
An array of tags of the event
Name
seoSettings
Type
object
Description
The search engine optimization settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the SEO setting
Optional nested attributes (4)
Name
tags
Type
array<string>
Description
An array of tags of the seo settings
Name
noIndex
Type
boolean
Description
Whether the seo setting has no indexing
Name
title
Type
string
Description
The title of the seo settings
Name
description
Type
string
Description
The description of the seo settings
Name
extraInformation
Type
object
Description
The extra information of the event
Optional nested attributes (4)
Name
_id
Type
string
Description
The ID of the extra information of the event
Name
type
Type
string
Description
The type of the extra information of the event
Name
category
Type
string
Description
The category of the extra information of the event
Name
subCategory
Type
string
Description
The subCategory of the extra information of the event
Name
customCharges
Type
object
Description
Custom charges of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the custom charge
Optional nested attributes (7)
Name
outerChargeVar
Type
number float
Description
The variable outer charge of the custom charge
Name
innerChargeVar
Type
number float
Description
The variable inner charge of the custom charge
Name
outerChargeFix
Type
number float
Description
The fix outer charge of the custom charge
Name
innerChargeFix
Type
number float
Description
The fix inner charge of the custom charge
Name
posOuterChargeFix
Type
number float
Description
The fix POS outer charge of the custom charge
Name
posOuterChargeVar
Type
number float
Description
The variable POS outer charge of the custom charge
Name
cartOuterChargeFix
Type
number float
Description
The fix cart outer charge of the custom charge
Name
gallery
Type
array<object>
Description
An array of gallery items of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the gallery item
Optional nested attributes (5)
Name
title
Type
string
Description
The title of the gallery item
Name
description
Type
string
Description
The description of the gallery item
Name
copyright
Type
string
Description
The copyright of the gallery item
Name
index
Type
number float
Description
The index of the gallery item
Name
image
Type
string
Description
The image of the gallery item
Name
video
Type
object
Description
The video settings of the event
Optional nested attributes (1)
Name
youtubeID
Type
string
Description
The youtube video ID of the event video setting
Name
soldOutFallback
Type
object
Description
The sold out fallback of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of sold out entry
Optional nested attributes (2)
Name
soldOutFallbackType
Type
enum(default, moreinformation, waitinglist)
Description
Name
soldOutFallbackLink
Type
string
Description
The link of the sold out fallback
Name
ticketDesign
Type
object
Description
The ticket design settings for ticket types of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the ticket types design of the event
Optional nested attributes (8)
Name
useCustomDesign
Type
boolean
Description
Whether to use custom design on ticket types of event
Name
customDesignURL
Type
string
Description
The custom design URL for ticket types of event
Name
footerDesignURL
Type
string
Description
The footer design URL for ticket types of the event
Name
disclaimer
Type
string
Description
The disclaimer for ticket types of the event
Name
infoColor
Type
string
Description
The info color for ticket types of the event
Name
showTimeRange
Type
boolean
Description
Whether to show time range on ticket types of the event
Name
hideDates
Type
boolean
Description
Whether to hide dates on ticket types of the event
Name
hideTimes
Type
boolean
Description
Whether to hide the time on ticket types of the event
Name
checkinInformation
Type
object
Description
The checkin information of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the checkin information of the event
Optional nested attributes (1)
Name
checkinStarts
Type
string date-time
Description
The date of when the checkin of the event starts
Name
tracking
Type
object
Description
The tracking of the event
Optional nested attributes (2)
Name
facebookPixel
Type
object
Description
The facebook pixel information of the event tracking
Optional nested attributes (2)
Name
active
Type
boolean
Description
Whether facebook pixel of event tracking is active
Name
pixelId
Type
string
Description
The ID of facebook pixel of the event tracking
Name
tagging
Type
object
Description
The tagging of the event tracking
Optional nested attributes (2)
Name
enabled
Type
boolean
Description
Whether tagging of event tracking is enabled
Name
tags
Type
array<string>
Description
An array of tags of the event tracking
Name
hardTicketSettings
Type
object
Description
The hard ticket settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the event hard ticket settings
Optional nested attributes (9)
Name
enabled
Type
boolean
Description
Whether hard tickets can be bought for this event
Name
fulfillmentType
Type
enum(self, managed)
Description
The type of fulfillment. self fulfilled by the seller. managed fulfilled by vivenu.
Name
printingMethod
Type
enum(preprinted, adhoc)
Description
Which printing method is used. preprinted = The tickets are preprinted. adhoc = The tickets are printed ad-hoc.
Name
hardTicketOuterCharge
Type
number float
Description
Additional charge for every hard ticket that is added to the ticket price and the other outer charges - paid by the ticket buyer.
Name
hardTicketInnerCharge
Type
number float
Description
Additional charge for hard tickets as in the contract of the seller
Name
hardTicketPreviewURL
Type
string
Description
The hard ticket design image
Name
promotionName
Type
string
Description
A special name for hard tickets. e.g. "Collector edition"
Name
promotionText
Type
string
Description
A description about what makes this ticket so special
Name
requiredDays
Type
integer
Description
Required days until deliver of the hard tickets
Name
dataRequestSettings
Type
object
Description
The data request settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the data request settings of the event
Optional nested attributes (12)
Name
requiresPersonalization
Type
boolean
Description
Whether the tickets for this event need personalization
Name
requiresExtraFields
Type
boolean
Description
Whether the tickets for this event need extra data fields
Name
repersonalization
Type
boolean
Status
deprecated
Description
Whether the tickets can be re personalized.
Name
repersonalizationAllowed
Type
boolean
Description
Whether the tickets can be re personalized.
Name
repersonalizationEndDate
Type
string date-time
Status
deprecated
Description
If repersonalization = true. Until when the re personalization is allowed.
Name
repersonalizationDeadline
Type
object
Description
If repersonalization = true. A relatve date specification until when the re personalization is allowed.
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
repersonalizationFee
Type
number float
Description
If repersonalization = true. The per-ticket fee for repersonalization.
Name
repersonalizationsLimit
Type
number float
Description
If repersonalization = true. The number of times repersonalization is allowed.
Name
limitOnlyNameChanges
Type
boolean
Description
If enabled, only name changes count towards the re-personalization limit for every ticket type of the event. Extra fields can always be updated until the re-personalization deadline.
Name
posPersonalization
Type
enum(noPersonalization, optionalPersonalization, requiredPersonalization)
Description
The type of personalization for this event on Point of Sale applications.
Name
skipAddressInfo
Type
boolean
Description
Whether the checkout should not ask for the address of the ticket buyer.
Name
enforceCompany
Type
boolean
Description
Whether the company of the ticket buyer is a required field.
Name
styleOptions
Type
object
Description
Style options of the event page
Optional nested attributes (10)
Name
headerStyle
Type
string
Description
Header style of the event page
Name
brandOne
Type
string
Description
First brand of the event
Name
brandTwo
Type
string
Description
Second brand of the event
Name
hideLocationMap
Type
boolean
Description
Whether the location map on the event page hide
Name
hideLocationAddress
Type
boolean
Description
Whether the location address on the event page hide
Name
categoryAlignment
Type
enum(cascade, asTabs, boxes, ticketWizard, 0, 1, 2, 3) float
Description
The style of category alignment. 0 = cascade = categories among themselves. 1 = asTabs = categories as tabs. 2 = boxes = categories as boxes. 3 = ticket wizard = categories as ticket wizard if configured.
Name
showAvailabilityIndicator
Type
boolean
Description
Whether the availability indicator on the event page should be shown
Name
availabilityIndicatorThresholds
Type
array<number>
Description
The availability indicator thresholds of the event
Name
showAvailable
Type
boolean
Description
Whether to show availability of the time slot. Only applicable for time slot events.
Name
timeSlotsCheckoutSelection
Type
enum(beforeTickets, afterTickets)
Description
Time slots selection in checkout.
Name
geoCode
Type
object
Description
The geographic code of the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the geo code
Name
lat
Type
number float
Description
Latitude coordinate of the geo code
Name
lng
Type
number float
Description
Longitude coordinate of the geo code
Name
accountSettings
Type
object
Description
Account settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the account settings of the event
Optional nested attributes (2)
Name
enforceAccounts
Type
boolean
Status
deprecated
Description
Whether to enforce accounts for the event
Name
enforceAuthentication
Type
enum(DISABLED, PREVENT_CHECKOUT, PREVENT_DETAILS_STEP)
Description
Whether to enforce authentication for the event and how to enforce it
Name
reservationSettings
Type
object
Description
The reservation settings of event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the reservation setting
Optional nested attributes (2)
Name
option
Type
enum(noReservations, reservationsOnly, reservationsAndPayment, internalReservationsAndPayment)
Description
The option of the reservation setting. reservationsOnly = needs reservation only. noReservations = no reservations needed. reservationsAndPayment = needs reservation and payment
Name
strategyId
Type
string
Description
The ID of the strategy of a purchase intents to be used on the event
Name
upsellSettings
Type
object
Description
The upsell settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the upsell settings of the event
Optional nested attributes (4)
Name
active
Type
boolean
Description
Whether upselling is active on the event
Name
productStream
Type
string
Description
The product stream for upselling
Name
headerImage
Type
string
Description
A header image for the ticket shop, when selecting products
Name
crossSells
Type
object
Description
The cross selling settings.
Optional nested attributes (1)
Name
eventIds
Type
array<string>
Description
The array of the promoted event IDs.
Name
repetitionSettings
Type
array<object>
Description
The repetition settings of the event
Required nested attributes (4)
Name
every
Type
number float
Description
Repeat event every unit of time
Name
unit
Type
enum(DAY, WEEK, MONTH)
Description
Unit of repetition - day, week, month
Name
from
Type
string date-time
Description
Repeat event from date
Name
to
Type
string date-time
Description
Repeat event till date
Optional nested attributes (1)
Name
repeatsOn
Type
array<enum(SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY)>
Description
Days of a week when the event is repeated
Name
rootId
Type
string
Description
The id of the root event
Name
daySchemes
Type
array<DaySchemeResource>
Description
The possible day schemas of how event could be sold
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the day scheme.
Name
name
Type
string
Description
The name of the day scheme.
Name
color
Type
string
Description
The color of the day scheme.
Optional nested attributes (1)
Name
offers
Type
object
Description
Offers of the day scheme.
Optional nested attributes (3)
Name
allTicketTypesActive
Type
boolean
Description
Whether the all ticket types active.
Name
ticketTypes
Type
array<object>
Description
The day scheme offer ticket types.
Required nested attributes (1)
Name
ticketTypeId
Type
string
Description
The ticket type id which could be sold.
Optional nested attributes (1)
Name
active
Type
boolean
Description
Whether the ticket type is selling.
Name
timeSlots
Type
array<object>
Description
Time slots overrides.
Required nested attributes (1)
Name
slotId
Type
string
Description
The slotId of the time slot.
Optional nested attributes (2)
Name
enabled
Type
string
Description
Whether the slot is enabled.
Name
amount
Type
number float
Description
The amount of available tickets of the time slot of the day scheme.
Name
daySchemeId
Type
string
Description
The ID of the day scheme assigned to the event.
Name
ticketSettings
Type
object
Description
The event ticket settings
Optional nested attributes (9)
Name
codeDisplay
Type
enum(BARCODE, QRCODE, HIDE)
Description
How the ticket code is displayed. Null inherits the seller setting.
Name
cancellationStrategy
Type
enum(disabled, freeTicketsOnly, withoutRefund)
Description
Cancellation strategy of the ticket types
Name
revealingSettings
Type
object
Description
Barcode reveal settings of the event.
Optional nested attributes (2)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
beforeEvent
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
transferSettings
Type
object
Description
Transfer settings of the ticket types
Optional nested attributes (7)
Name
mode
Type
enum(ALLOWED, DISABLED)
Description
Ticket transfer mode.
Name
expiresAfter
Type
object
Description
If 'mode = ALLOWED'. A relatve date specification until when ticket transfer is valid.
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
retransferMode
Type
enum(ALLOWED, DISABLED)
Description
Ticket retransfer mode.
Name
allowedUntil
Type
object
Description
If 'mode = ALLOWED'. A relatve date specification until the end of the event where ticket transfer is possible.
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
hardTicketsMode
Type
enum(ALLOWED, DISABLED)
Description
If 'hardTicketsMode = ALLOWED' then hard tickets transfers allowed.
Name
seasonTicketMode
Type
enum(NO_RESTRICTION, CHILDREN_ONLY, GROUP_ONLY)
Description
Restrict how season tickets can be transferred.
Name
useSeasonCardTemplate
Type
boolean
Description
Whether to use the season card template for individual tickets transferred from the season.
Name
upgradeSettings
Type
object
Description
Upgrade settings of the ticket types
Optional nested attributes (2)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Whether ticket upgrade settings enabled.
Name
underShopMapping
Type
array<object>
Description
Mapping to define the under shop in which a ticket upgrade will be performed.
Required nested attributes (3)
Name
type
Type
enum(tag)
Description
Name
tag
Type
string
Description
The customer tag
Name
underShopId
Type
string
Description
The ID of the under shop.
Name
resellSettings
Type
object
Description
Resell settings
Optional nested attributes (10)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Whether resell is enabled
Name
resellerFeeFix
Type
number float
Description
The fixed fee per ticket that the reseller pays
Name
resellerFeeVar
Type
number float
Description
The variable fee per ticket that the reseller pays
Name
buyerFeeFix
Type
number float
Description
The fixed fee per ticket that the buyer pays
Name
buyerFeeVar
Type
number float
Description
The variable fee per ticket that the buyer pays
Name
offerCreationStart
Type
object
Description
A relative date specification of offers creation start.
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
offerCreationEnd
Type
object
Description
A relative date specification of offers creation end.
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
salesStart
Type
object
Description
A relative date specification of sales start.
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
priceMarkup
Type
number float
Description
The markup applied to the price of each ticket bought on the secondary market.
Name
cartAutomationMode
Type
enum(BLOCKED, INDIVIDUAL)
Description
Controls whether tickets involved in cart automations can be resold.
Name
barcodeSettings
Type
object
Description
Barcode settings
Optional nested attributes (1)
Name
issueOfflineBarcodes
Type
enum(ENABLED, DISABLED)
Description
Whether offline barcodes are enabled
Name
childEventMapping
Type
array<object>
Description
Child event mapping
Required nested attributes (2)
Name
childEventId
Type
string
Description
The child event for this mapping
Name
ticketTypeMapping
Type
object
Description
Mapping between ticket types of the parent event and the child events
Optional nested attributes (1)
Name
valueShare
Type
number float
Description
The percentage value of this child event from the value of the parent event
Name
seasonCardValueStrategy
Type
enum(childValue, averagePerChild, sharePerChild)
Description
The strategy used to determine the value of a child event in the context of the parent event
Name
accessListMapping
Type
array<object>
Description
The array represents a mapping between access list ids and ticket type ids for which a ticket will be created.
Required nested attributes (2)
Name
listId
Type
string
Description
The ID of the access list.
Name
ticketTypeId
Type
string
Description
The ID of the ticket type.
Name
deliverySettings
Type
object
Description
Delivery Settings
Optional nested attributes (2)
Name
wallet
Type
object
Description
Optional nested attributes (3)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
nfc
Type
enum(ENABLED, DISABLED)
Description
Name
seasonCardShowNextEvent
Type
boolean
Description
Whether to display the information for next event of the season event on a wallet ticket or not. If activated, the information of the next event will be displayed on the wallet ticket instead of the season event.
Name
pdf
Type
object
Description
Optional nested attributes (1)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
meta
Type
object
Description
Custom key-value data. Metadata is useful for storing additional, structured information on an object.
Name
timezone
Type
string
Description
Timezone of event
Name
salesChannelGroupSettings
Type
array<object>
Description
An array of sales channel group settings associated with the event
Required nested attributes (1)
Name
salesChannelGroupId
Type
string
Description
The ID of the associated sales channel group
Optional nested attributes (1)
Name
enabled
Type
boolean
Description
Whether the sales channel group is enabled
Name
paymentSettings
Type
object
Description
The payment settings of the event
Optional nested attributes (1)
Name
paymentStrategyId
Type
string
Description
The ID of the associated payment strategy
Name
timeSlots
Type
array<object>
Description
The time slots for the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the time slot
Name
startTime
Type
object
Description
The time of day the time slot starts
Required nested attributes (2)
Name
hour
Type
integer
Description
Name
minute
Type
integer
Description
Name
refs
Type
array<object>
Description
The ticket references for the time slot
Required nested attributes (2)
Name
refType
Type
enum(category)
Description
The type of the reference
Name
categoryRef
Type
string
Description
The ticket category reference to use for the time slot
Optional nested attributes (1)
Name
amount
Type
number float
Description
The amount of available tickets of the time slot of the event
Name
useTimeSlots
Type
boolean
Description
Whether the event uses time slots.
Name
attributes
Type
object
Description

Example

{
  "event": {
    "_id": "507f191e810c19729de860ea",
    "name": "Some fancy Name",
    "start": "2030-01-23T23:00:00.123Z",
    "end": "2030-01-23T23:00:00.123Z",
    "maxAmount": 10.5,
    "maxAmountPerOrder": 10.5,
    "sellerId": "507f191e810c19729de860ea",
    "slogan": "string",
    "description": "string",
    "locationName": "Some fancy Name",
    "locationStreet": "Speditionsstr",
    "locationCity": "Düsseldorf",
    "locationPostal": "40221",
    "locationCountry": "string",
    "image": "https://your-url/image.png",
    "ticketFooter": "string",
    "ticketBackground": "string",
    "ticketShopHeader": "string",
    "groups": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "tickets": [
          "string"
        ]
      }
    ],
    "discountGroups": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "value": 10.5,
        "rules": [
          {
            "_id": "507f191e810c19729de860ea",
            "min": 10.5,
            "max": 10.5,
            "group": "string",
            "type": "ticketGroups"
          }
        ],
        "discountType": "fix"
      }
    ],
    "cartAutomationRules": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "triggerType": "hasBeenAdded",
        "triggerTargetGroup": "string",
        "thenType": "autoAdd",
        "thenTargets": [
          {
            "_id": "507f191e810c19729de860ea",
            "thenTargetGroup": "string",
            "thenTargetMin": 10.5,
            "thenTargetMax": 10.5
          }
        ]
      }
    ],
    "posDiscounts": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "value": 10.5,
        "discountType": "fix"
      }
    ],
    "categories": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "description": "string",
        "seatingReference": "string",
        "ref": "string",
        "amount": 10.5,
        "recommendedTicket": "string",
        "maxAmountPerOrder": 10.5,
        "listWithoutSeats": true
      }
    ],
    "tickets": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "price": 10.5,
        "amount": 10.5,
        "active": true,
        "description": "string",
        "image": "https://your-url/image.png",
        "color": "string",
        "posActive": true,
        "categoryRef": "string",
        "ignoredForStartingPrice": true,
        "conditionalAvailability": true,
        "ticketBackground": "string",
        "rules": [
          {
            "_id": "507f191e810c19729de860ea",
            "ticketGroup": "string",
            "min": 10.5,
            "max": 10.5
          }
        ],
        "requiresPersonalization": true,
        "requiresPersonalizationMode": "ENABLED",
        "requiresExtraFields": true,
        "requiresExtraFieldsMode": "ENABLED",
        "repersonalizationAllowedMode": "ENABLED",
        "repersonalizationFee": 10.5,
        "sortingKey": 10.5,
        "enableHardTicketOption": true,
        "forceHardTicketOption": true,
        "maxAmountPerOrder": 10.5,
        "minAmountPerOrder": 10.5,
        "minAmountPerOrderRule": 10.5,
        "taxRate": 10.5,
        "styleOptions": {
          "thumbnailImage": "string",
          "showAvailable": true,
          "hiddenInSelectionArea": true
        },
        "priceCategoryId": "507f191e810c19729de860ea",
        "entryPermissions": [
          "string"
        ],
        "ignoreForMaxAmounts": true,
        "expirationSettings": {
          "enabled": true,
          "expiresAfter": {
            "unit": "hours",
            "offset": 1,
            "target": "string"
          }
        },
        "barcodePrefix": "string",
        "salesStart": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "salesEnd": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "transferSettings": {
          "mode": "ALLOWED",
          "expiresAfter": {
            "unit": "hours",
            "offset": 1,
            "target": "string"
          },
          "retransferMode": "ALLOWED",
          "allowedUntil": {
            "unit": "hours",
            "offset": 1,
            "target": "string"
          },
          "hardTicketsMode": "ALLOWED",
          "seasonTicketMode": "NO_RESTRICTION"
        },
        "scanSettings": {
          "feedback": "highlight",
          "allowedScanCount": 10.5
        },
        "deliverySettings": {
          "wallet": {
            "enabled": "ENABLED"
          },
          "pdf": {
            "enabled": "ENABLED"
          }
        },
        "meta": {},
        "revealingSettings": {
          "enabled": "ENABLED",
          "beforeEvent": {
            "unit": "hours",
            "offset": 1,
            "target": "string"
          }
        }
      }
    ],
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z",
    "sellStart": "2030-01-23T23:00:00.123Z",
    "sellEnd": "2030-01-23T23:00:00.123Z",
    "maxAmountPerCustomer": 10.5,
    "maxTransactionsPerCustomer": 10.5,
    "minAmountPerOrder": 1,
    "customerTags": [
      "string"
    ],
    "customerSegments": [
      "string"
    ],
    "showCountdown": true,
    "hideInListing": true,
    "visibleAfter": "2030-01-23T23:00:00.123Z",
    "customSettings": {
      "_id": "507f191e810c19729de860ea",
      "hideTicketsInTransactionPage": true,
      "dontSendTicketMail": true,
      "dontSendBookingConfirmationMail": true,
      "customMailHeaderImage": "string",
      "customTransactionCompletionText": "string",
      "disableAppleWallet": true,
      "disablePdfTickets": true,
      "showStartDate": true,
      "showStartTime": true,
      "showEndDate": true,
      "showEndTime": true,
      "showTimeRangeInListing": true,
      "showTimeRangeInTicket": true,
      "customCheckoutCSS": "string",
      "useCustomCheckoutBrand": true,
      "customCheckoutBrand": "string",
      "hideLogoInCheckout": true,
      "customEventPageHTML": "string",
      "customEventPageCSS": "string",
      "customConfirmationPage": "string",
      "hideSeatmapInCheckout": true,
      "dontSendBookingConfirmationSMS": true
    },
    "extraFields": [
      {
        "_id": "507f191e810c19729de860ea",
        "required": true,
        "name": "Some fancy Name",
        "description": "string",
        "collectInCheckout": true,
        "deleted": true,
        "type": "text",
        "options": [
          "string"
        ],
        "onlyForCertainTicketTypes": true,
        "allowedTicketTypes": [
          "string"
        ],
        "printable": true,
        "conditions": [
          {
            "_id": "507f191e810c19729de860ea",
            "baseSlug": "string",
            "operator": "equals",
            "value": []
          }
        ],
        "settings": {
          "allowedMimeTypes": [
            "application/pdf"
          ]
        }
      }
    ],
    "ticketExtraFields": [
      {
        "_id": "507f191e810c19729de860ea",
        "required": true,
        "name": "Some fancy Name",
        "description": "string",
        "collectInCheckout": true,
        "deleted": true,
        "type": "text",
        "options": [
          "string"
        ],
        "onlyForCertainTicketTypes": true,
        "allowedTicketTypes": [
          "string"
        ],
        "printable": true,
        "conditions": [
          {
            "_id": "507f191e810c19729de860ea",
            "baseSlug": "string",
            "operator": "equals",
            "value": []
          }
        ],
        "settings": {
          "allowedMimeTypes": [
            "application/pdf"
          ]
        }
      }
    ],
    "accentColor": "#006DCC",
    "pageStyle": "white",
    "showOtherEvents": true,
    "underShops": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "active": true,
        "tickets": [
          {
            "_id": "507f191e810c19729de860ea",
            "baseTicket": "string",
            "name": "Some fancy Name",
            "price": 10.5,
            "amount": 10.5,
            "active": true,
            "description": "string"
          }
        ],
        "categories": [
          {
            "_id": "507f191e810c19729de860ea",
            "baseCategoryId": "507f191e810c19729de860ea",
            "amount": 10.5,
            "maxAmountPerOrder": 10.5
          }
        ],
        "timeSlots": [
          {
            "_id": "507f191e810c19729de860ea",
            "baseTimeSlotId": "507f191e810c19729de860ea",
            "amount": 10.5,
            "enabled": "ENABLED"
          }
        ],
        "sellStart": "2030-01-23T23:00:00.123Z",
        "sellEnd": "2030-01-23T23:00:00.123Z",
        "maxAmount": 10.5,
        "maxAmountPerOrder": 10.5,
        "minAmountPerOrder": 1,
        "maxTransactionsPerCustomer": 10.5,
        "maxAmountPerCustomer": 10.5,
        "ticketShopHeaderText": "string",
        "customCharges": {
          "_id": "507f191e810c19729de860ea",
          "outerChargeVar": 10.5,
          "innerChargeVar": 10.5,
          "outerChargeFix": 10.5,
          "innerChargeFix": 10.5,
          "posOuterChargeFix": 10.5,
          "posOuterChargeVar": 10.5,
          "cartOuterChargeFix": 10.5
        },
        "seatingContingents": [
          "string"
        ],
        "availabilityMode": "default",
        "bestAvailableSeatingConfiguration": {
          "enabled": true,
          "enforced": true,
          "allowMassBooking": true
        },
        "reservationSettings": {
          "option": "noReservations"
        },
        "accountSettings": {
          "_id": "507f191e810c19729de860ea",
          "enforceAccounts": true,
          "enforceAuthentication": "DISABLED"
        },
        "customerTags": [
          "string"
        ],
        "customerSegments": [
          "string"
        ],
        "allowMassDownload": true,
        "inventoryStrategy": "independent",
        "extraFields": [
          {
            "_id": "507f191e810c19729de860ea",
            "required": true,
            "name": "Some fancy Name",
            "description": "string",
            "collectInCheckout": true,
            "deleted": true,
            "type": "text",
            "options": [
              "string"
            ],
            "onlyForCertainTicketTypes": true,
            "allowedTicketTypes": [
              "string"
            ],
            "printable": true,
            "conditions": [
              {
                "_id": "507f191e810c19729de860ea",
                "baseSlug": "string",
                "operator": "equals",
                "value": []
              }
            ],
            "settings": {
              "allowedMimeTypes": [
                "application/pdf"
              ]
            }
          }
        ],
        "salesChannelGroupSettings": [
          {
            "salesChannelGroupId": "507f191e810c19729de860ea",
            "enabled": true
          }
        ],
        "paymentSettings": {
          "paymentStrategyId": "507f191e810c19729de860ea"
        },
        "unlockMode": "none"
      }
    ],
    "seating": {
      "_id": "507f191e810c19729de860ea",
      "active": true,
      "eventKey": "string",
      "eventId": "507f191e810c19729de860ea",
      "seatMapId": "507f191e810c19729de860ea",
      "revisionId": "507f191e810c19729de860ea",
      "orphanConfiguration": {
        "_id": "507f191e810c19729de860ea",
        "minSeatDistance": 2,
        "edgeSeatsOrphaning": true
      },
      "contingents": [
        "string"
      ],
      "availabilityMode": "default",
      "bestAvailableSeatingConfiguration": {
        "enabled": true,
        "enforced": true
      }
    },
    "customTextConfig": {
      "_id": "507f191e810c19729de860ea",
      "buyTicketsCTA": "string"
    },
    "eventType": "SINGLE",
    "childEvents": [
      "string"
    ],
    "url": "https://vivenu.com",
    "tags": [
      "string"
    ],
    "seoSettings": {
      "_id": "507f191e810c19729de860ea",
      "tags": [
        "string"
      ],
      "noIndex": true,
      "title": "string",
      "description": "string"
    },
    "extraInformation": {
      "_id": "507f191e810c19729de860ea",
      "type": "string",
      "category": "string",
      "subCategory": "string"
    },
    "customCharges": {
      "_id": "507f191e810c19729de860ea",
      "outerChargeVar": 10.5,
      "innerChargeVar": 10.5,
      "outerChargeFix": 10.5,
      "innerChargeFix": 10.5,
      "posOuterChargeFix": 10.5,
      "posOuterChargeVar": 10.5,
      "cartOuterChargeFix": 10.5
    },
    "gallery": [
      {
        "_id": "507f191e810c19729de860ea",
        "title": "string",
        "description": "string",
        "copyright": "string",
        "index": 10.5,
        "image": "https://your-url/image.png"
      }
    ],
    "video": {
      "youtubeID": "string"
    },
    "soldOutFallback": {
      "_id": "507f191e810c19729de860ea",
      "soldOutFallbackType": "default",
      "soldOutFallbackLink": "string"
    },
    "ticketDesign": {
      "_id": "507f191e810c19729de860ea",
      "useCustomDesign": true,
      "customDesignURL": "string",
      "footerDesignURL": "string",
      "disclaimer": "string",
      "infoColor": "string",
      "showTimeRange": true,
      "hideDates": true,
      "hideTimes": true
    },
    "checkinInformation": {
      "_id": "507f191e810c19729de860ea",
      "checkinStarts": "2030-01-23T23:00:00.123Z"
    },
    "tracking": {
      "facebookPixel": {
        "active": true,
        "pixelId": "507f191e810c19729de860ea"
      },
      "tagging": {
        "enabled": true,
        "tags": [
          "string"
        ]
      }
    },
    "hardTicketSettings": {
      "_id": "507f191e810c19729de860ea",
      "enabled": true,
      "fulfillmentType": "self",
      "printingMethod": "preprinted",
      "hardTicketOuterCharge": 10.5,
      "hardTicketInnerCharge": 10.5,
      "hardTicketPreviewURL": "string",
      "promotionName": "string",
      "promotionText": "string",
      "requiredDays": 1
    },
    "dataRequestSettings": {
      "requiresPersonalization": false,
      "requiresExtraFields": false,
      "repersonalization": false,
      "posPersonalization": "noPersonalization"
    },
    "styleOptions": {
      "headerStyle": "default",
      "hideLocationMap": false,
      "hideLocationAddress": false,
      "categoryAlignment": 0,
      "showAvailabilityIndicator": false,
      "availabilityIndicatorThresholds": [
        0.3,
        0.7
      ]
    },
    "geoCode": {
      "_id": "507f191e810c19729de860ea",
      "lat": 10.5,
      "lng": 10.5
    },
    "accountSettings": {
      "_id": "507f191e810c19729de860ea",
      "enforceAccounts": true,
      "enforceAuthentication": "DISABLED"
    },
    "reservationSettings": {
      "option": "noReservations"
    },
    "upsellSettings": {
      "_id": "507f191e810c19729de860ea",
      "active": true,
      "productStream": "string",
      "headerImage": "string",
      "crossSells": {
        "eventIds": [
          "string"
        ]
      }
    },
    "repetitionSettings": [
      {
        "every": 10.5,
        "unit": "DAY",
        "from": "2030-01-23T23:00:00.123Z",
        "to": "2030-01-23T23:00:00.123Z",
        "repeatsOn": [
          "SUNDAY"
        ]
      }
    ],
    "rootId": "507f191e810c19729de860ea",
    "daySchemes": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "color": "string",
        "offers": {
          "allTicketTypesActive": true,
          "ticketTypes": [
            {
              "ticketTypeId": "507f191e810c19729de860ea",
              "active": true
            }
          ],
          "timeSlots": [
            {
              "slotId": "507f191e810c19729de860ea",
              "enabled": "string",
              "amount": 10.5
            }
          ]
        }
      }
    ],
    "daySchemeId": "507f191e810c19729de860ea",
    "ticketSettings": {
      "codeDisplay": "BARCODE",
      "cancellationStrategy": "disabled",
      "revealingSettings": {
        "enabled": "ENABLED",
        "beforeEvent": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        }
      },
      "transferSettings": {
        "mode": "ALLOWED",
        "expiresAfter": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "retransferMode": "ALLOWED",
        "allowedUntil": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "hardTicketsMode": "ALLOWED",
        "seasonTicketMode": "NO_RESTRICTION",
        "useSeasonCardTemplate": true
      },
      "upgradeSettings": {
        "enabled": "ENABLED",
        "underShopMapping": [
          {
            "type": "tag",
            "tag": "string",
            "underShopId": "507f191e810c19729de860ea"
          }
        ]
      },
      "resellSettings": {
        "enabled": "ENABLED",
        "resellerFeeFix": 10.5,
        "resellerFeeVar": 10.5,
        "buyerFeeFix": 10.5,
        "buyerFeeVar": 10.5,
        "offerCreationStart": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "offerCreationEnd": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "salesStart": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "priceMarkup": 10.5,
        "cartAutomationMode": "BLOCKED"
      },
      "barcodeSettings": {
        "issueOfflineBarcodes": "ENABLED"
      },
      "childEventMapping": [
        {
          "childEventId": "507f191e810c19729de860ea",
          "ticketTypeMapping": {},
          "valueShare": 10.5
        }
      ],
      "seasonCardValueStrategy": "childValue"
    },
    "accessListMapping": [
      {
        "listId": "507f191e810c19729de860ea",
        "ticketTypeId": "507f191e810c19729de860ea"
      }
    ],
    "deliverySettings": {
      "wallet": {
        "enabled": "ENABLED",
        "nfc": "ENABLED",
        "seasonCardShowNextEvent": true
      },
      "pdf": {
        "enabled": "ENABLED"
      }
    },
    "meta": {},
    "timezone": "string",
    "salesChannelGroupSettings": [
      {
        "salesChannelGroupId": "507f191e810c19729de860ea",
        "enabled": true
      }
    ],
    "paymentSettings": {
      "paymentStrategyId": "507f191e810c19729de860ea"
    },
    "timeSlots": [
      {
        "_id": "507f191e810c19729de860ea",
        "startTime": {
          "hour": 1,
          "minute": 1
        },
        "refs": [
          {
            "refType": "category",
            "categoryRef": "string"
          }
        ],
        "amount": 10.5
      }
    ],
    "useTimeSlots": true,
    "attributes": {}
  }
}

event.updated

The data of the event updated webhook event.

Required attributes

Name
event
Type
EventResource
Description
The associated event which has been deleted
Required nested attributes (6)
Name
_id
Type
string
Description
The ID of the event
Name
name
Type
string
Description
The name of the event
Name
start
Type
string date-time
Description
An ISO timestamp indicating when the event starts
Name
end
Type
string date-time
Description
An ISO timestamp indicating when the event ends
Name
maxAmount
Type
number float
Description
Maximum amount of tickets of the event
Name
maxAmountPerOrder
Type
number float
Description
Maximum amount of tickets per order of the event
Optional nested attributes (73)
Name
sellerId
Type
string
Description
The ID of the seller owning this event
Name
slogan
Type
string
Description
The slogan of the event
Name
description
Type
string
Description
A description about the event. Description is in RichText - JSON format.
Name
locationName
Type
string
Description
The name of the location where the event takes place
Name
locationStreet
Type
string
Description
The street of the location where the event takes place
Name
locationCity
Type
string
Description
The city of the location where the event takes place
Name
locationPostal
Type
string
Description
The postal code of the location where the event takes place
Name
locationCountry
Type
string
Description
The country code of the location where the event takes place
Name
image
Type
string
Description
An image for the event
Name
ticketFooter
Type
string
Description
A footer image for the ticket PDF of the event
Name
ticketBackground
Type
string
Description
A background image for the ticket PDF of the event
Name
ticketShopHeader
Type
string
Description
A header image for the ticket shop of the event
Name
groups
Type
array<object>
Description
An array of groups of ticket types of the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of of the ticket group of the event
Name
name
Type
string
Description
The name of the ticket group of the event
Name
tickets
Type
array<string>
Description
An array of ID's of ticket types of the event
Name
discountGroups
Type
array<object>
Description
An array of discount groups of the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the discount group of the event
Name
name
Type
string
Description
The name of the discount group of the event
Name
value
Type
number float
Description
The value of the discount group
Optional nested attributes (2)
Name
rules
Type
array<object>
Description
An array of rules of the discount group
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the discount group rule
Name
min
Type
number float
Description
Minimum amount of tickets where the discount is valid
Name
max
Type
number float
Description
Maximum amount of tickets where the discount is valid
Optional nested attributes (2)
Name
group
Type
string
Description
The ID of the discount group
Name
type
Type
enum(ticketGroups, cartSum)
Description
The type of the discount rule. ticketGroups is the type for tickets. cartSum is the type for sum of a cart
Name
discountType
Type
enum(TOTAL, PERCENTAGE, fix, var, fixPerItem, waiveFees)
Description
The type of the discount group. TOTAL = absolute discount. PERCENTAGE = percentage discount. fix = fixed discount. var = variable discount
Name
cartAutomationRules
Type
array<object>
Description
An array of automation rules for carts of the event
Required nested attributes (5)
Name
_id
Type
string
Description
The ID of the cart automation rule
Name
name
Type
string
Description
The name of the automation rule for carts of the event
Name
triggerType
Type
enum(hasBeenAdded)
Description
The trigger type of the automation rule.
Name
triggerTargetGroup
Type
string
Description
The trigger target group of the rule. The ID of a ticket group
Name
thenType
Type
enum(autoAdd, chooseFrom)
Description
The type of thenType of the rule. autoAdd = is the type to add automatically to cart. chooseFrom = is the type to choose from e.g. another ticket group
Optional nested attributes (1)
Name
thenTargets
Type
array<object>
Description
The target of the then type
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the then target
Optional nested attributes (3)
Name
thenTargetGroup
Type
string
Description
The ID of the ticket group 'then' refers to
Name
thenTargetMin
Type
number float
Description
Minimum amount of tickets where the then action is valid
Name
thenTargetMax
Type
number float
Description
Maximum amount of tickets where the then action is valid
Name
posDiscounts
Type
array<object>
Description
An array of POS discounts of the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the POS discount
Name
name
Type
string
Description
The name of the POS discount
Name
value
Type
number float
Description
The value of the POS discount
Optional nested attributes (1)
Name
discountType
Type
enum(TOTAL, PERCENTAGE, fix, var, fixPerItem, waiveFees)
Description
The type of the POS discount
Name
categories
Type
array<object>
Description
An array of ticket categories of the event
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the ticket category of the event
Name
name
Type
string
Description
The name of the ticket category of the event
Optional nested attributes (7)
Name
description
Type
string
Description
The description of the ticket category of the event
Name
seatingReference
Type
string
Description
The ID of the seating category
Name
ref
Type
string
Description
The reference to identify the seating category
Name
amount
Type
number float
Description
The amount of available tickets of the category of the event
Name
recommendedTicket
Type
string
Description
Recommended ticket of the category
Name
maxAmountPerOrder
Type
number float
Description
Maximum amount per order of the category
Name
listWithoutSeats
Type
boolean
Description
Whether this category can be sold without seats
Name
tickets
Type
array<object>
Description
An array of ticket types of the event
Required nested attributes (5)
Name
_id
Type
string
Description
The ID of the ticket type of the event
Name
name
Type
string
Description
The name of the ticket type of the event
Name
price
Type
number float
Description
The price of the ticket type of the event
Name
amount
Type
number float
Description
The amount of the ticket type of the event
Name
active
Type
boolean
Description
Whether the ticket type of the event is active
Optional nested attributes (35)
Name
description
Type
string
Description
The description of the ticket type of the event
Name
image
Type
string
Description
The image of the ticket type of the event
Name
color
Type
string
Description
The font color of the ticket type of the event
Name
posActive
Type
boolean
Description
Whether POS for the ticket type of the event is active
Name
categoryRef
Type
string
Description
The reference of the category of the ticket type of the event
Name
ignoredForStartingPrice
Type
boolean
Description
Whether the price of the ticket type should be ignored on starting price determination of the event
Name
conditionalAvailability
Type
boolean
Description
Whether rules can be operated on the ticket type
Name
ticketBackground
Type
string
Description
The background for the ticket PDF of the ticket type
Name
rules
Type
array<object>
Description
An array of rules for the ticket type of the event
Required nested attributes (4)
Name
_id
Type
string
Description
The ID of the ticket type rule
Name
ticketGroup
Type
string
Description
The ID of the ticket group to operate the rule on
Name
min
Type
number float
Description
Minimum amount of tickets where the rule is active
Name
max
Type
number float
Description
Maximum amount of tickets where the rule is active
Name
requiresPersonalization
Type
boolean
Status
deprecated
Description
Deprecated, use requiresPersonalizationMode instead
Name
requiresPersonalizationMode
Type
enum(ENABLED, DISABLED)
Description
Whether the ticket type of the event needs personalization
Name
requiresExtraFields
Type
boolean
Status
deprecated
Description
Deprecated, use requiresExtraFieldsMode instead
Name
requiresExtraFieldsMode
Type
enum(ENABLED, DISABLED)
Description
Whether the ticket type of the event needs extra fields
Name
repersonalizationAllowedMode
Type
enum(ENABLED, DISABLED)
Description
Whether re-personalization (name changes) is allowed for this ticket type. When unset, inherits the event-level repersonalizationAllowed. Enables flex-ticket-like re-personalization without an addon.
Name
repersonalizationFee
Type
number float
Description
The per-ticket fee for repersonalization.
Name
sortingKey
Type
number float
Description
The key to sort the ticket type within the ticket group
Name
enableHardTicketOption
Type
boolean
Description
Whether the ticket type is a hard ticket
Name
forceHardTicketOption
Type
boolean
Description
Whether to force the hard ticket option
Name
maxAmountPerOrder
Type
number float
Description
Maximum amount per order of the ticket type
Name
minAmountPerOrder
Type
number float
Description
Minimum amount per order of the ticket type
Name
minAmountPerOrderRule
Type
number float
Description
Minimum amount of the ticket type, where the minAmountPerOrder goes active
Name
taxRate
Type
number float
Description
The tax rate of the ticket type of the event
Name
styleOptions
Type
object
Description
Style options of the ticket type
Optional nested attributes (3)
Name
thumbnailImage
Type
string
Description
Thumbnail of the ticket type, which will be displayed on checkout
Name
showAvailable
Type
boolean
Description
Whether to show availability of the ticket type
Name
hiddenInSelectionArea
Type
boolean
Description
Whether to show this ticket in the selection area
Name
priceCategoryId
Type
string
Description
The ID of the price category of the ticket type
Name
entryPermissions
Type
array<string>
Description
An array of IDs of entry permissions where the ticket buyer has access to certain areas
Name
ignoreForMaxAmounts
Type
boolean
Description
Do not include tickets if this typw when calculating available amount in categories and event
Name
expirationSettings
Type
object
Description
Expiration settings of the ticket type.
Optional nested attributes (2)
Name
enabled
Type
boolean
Description
Whether expiration enabled for the event ticket types
Name
expiresAfter
Type
object
Description
If enabled = true. A relatve date specification until when ticket is valid.
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
barcodePrefix
Type
string
Description
Characters that precede the barcodes of tickets.
Name
salesStart
Type
object
Description
A relative date before the end of the event, when the sale of this ticket type starts
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
salesEnd
Type
object
Description
A relative date before the end of the event, when the sale of this ticket type ends
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
transferSettings
Type
object
Description
Transfer settings of the ticket type.
Optional nested attributes (6)
Name
mode
Type
enum(ALLOWED, DISABLED)
Description
Ticket transfer mode.
Name
expiresAfter
Type
object
Description
If 'mode = ALLOWED'. A relatve date specification until when ticket transfer is valid.
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
retransferMode
Type
enum(ALLOWED, DISABLED)
Description
Ticket retransfer mode.
Name
allowedUntil
Type
object
Description
If 'mode = ALLOWED'. A relatve date specification until the end of the event where ticket transfer is possible.
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
hardTicketsMode
Type
enum(ALLOWED, DISABLED)
Description
If 'hardTicketsMode = ALLOWED' then hard tickets transfers allowed.
Name
seasonTicketMode
Type
enum(NO_RESTRICTION, CHILDREN_ONLY, GROUP_ONLY)
Description
Restrict how season tickets can be transferred.
Name
scanSettings
Type
object
Description
Scan settings of the ticket type.
Optional nested attributes (2)
Name
feedback
Type
enum(highlight)
Description
Feedback mode during scanning of the ticket
Name
allowedScanCount
Type
number float
Description
Number of times a ticket is allowed to be scanned as valid
Name
deliverySettings
Type
object
Description
Delivery settings of the ticket type.
Optional nested attributes (2)
Name
wallet
Type
object
Description
Optional nested attributes (1)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
pdf
Type
object
Description
Optional nested attributes (1)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
meta
Type
object
Description
Custom key-value data. Metadata is useful for storing additional, structured information on an object.
Name
revealingSettings
Type
object
Description
Barcode reveal settings of the ticket type.
Optional nested attributes (2)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
beforeEvent
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
createdAt
Type
string date-time
Description
An ISO timestamp indicating when the event was created
Name
updatedAt
Type
string date-time
Description
An ISO timestamp indicating when the event was updated
Name
sellStart
Type
string date-time
Description
An ISO timestamp indicating when the event sale starts
Name
sellEnd
Type
string date-time
Description
An ISO timestamp indicating when the event sale ends
Name
maxAmountPerCustomer
Type
number float
Description
Maximum amount of tickets per customer of the event
Name
maxTransactionsPerCustomer
Type
number float
Description
Maximum amount of transactions per customer of the event
Name
minAmountPerOrder
Type
number float
Description
Minimum amount of tickets per order
Name
customerTags
Type
array<string>
Description
An array of customer tags of the event
Name
customerSegments
Type
array<string>
Description
An array of customer segments of the event
Name
showCountdown
Type
boolean
Description
Whether the countdown should be visible till event start
Name
hideInListing
Type
boolean
Description
Whether the event should be hide in listings
Name
visibleAfter
Type
string date-time
Description
An ISO timestamp indicating when the event is visible in listings.
Name
customSettings
Type
object
Description
Custom settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the custom settings of the event
Optional nested attributes (22)
Name
hideTicketsInTransactionPage
Type
boolean
Description
Whether the ticket types of the event should be visible on transaction page
Name
dontSendTicketMail
Type
boolean
Description
Whether an email should be sent of tickets of the event
Name
dontSendBookingConfirmationMail
Type
boolean
Description
Whether an email should be sent for booking confirmation
Name
customMailHeaderImage
Type
string
Description
A custom header image of the mail for ticket types of the event
Name
customTransactionCompletionText
Type
string
Description
A custom transaction completion text for completed transactions of the event
Name
disableAppleWallet
Type
boolean
Status
deprecated
Description
Whether the Apple and Google Wallet functionality should be disabled on the event. Deprecated: use event.deliverySettings.wallet instead
Name
disablePdfTickets
Type
boolean
Status
deprecated
Description
Whether the PDF tickets download functionality should be disabled on the event. Deprecated: use event.deliverySettings.pdf instead
Name
showStartDate
Type
boolean
Description
Whether the start date of the event should be visible on listings
Name
showStartTime
Type
boolean
Description
Whether the start time of the event should be visible on listings
Name
showEndDate
Type
boolean
Description
Whether the end date of the event should be visible on listings
Name
showEndTime
Type
boolean
Description
Whether the end time of the event should be visible on listings
Name
showTimeRangeInListing
Type
boolean
Status
deprecated
Description
Whether the end time of the event should be visible on listings
Name
showTimeRangeInTicket
Type
boolean
Description
Whether the time range of the event should be visible on ticket PDFs
Name
customCheckoutCSS
Type
string
Description
Custom CSS styling of the checkout of the event
Name
useCustomCheckoutBrand
Type
boolean
Description
Whether the checkout of the event should use custom brand
Name
customCheckoutBrand
Type
string
Description
A custom checkout brand of the event
Name
hideLogoInCheckout
Type
boolean
Description
Whether the logo should be hide on the checkout of the event
Name
customEventPageHTML
Type
string
Description
A custom HTML of the event page
Name
customEventPageCSS
Type
string
Description
A custom css styling of the event page
Name
customConfirmationPage
Type
string
Description
A custom css styling of the event page
Name
hideSeatmapInCheckout
Type
boolean
Description
Hides the seatmap from the ticket buyer even if seating ticket types are available
Name
dontSendBookingConfirmationSMS
Type
boolean
Description
Whether a sms should be sent for booking confirmation
Name
extraFields
Type
array<object>
Description
An array of extra fields of the event
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the extra field
Name
required
Type
boolean
Description
Whether the extra field is required
Optional nested attributes (11)
Name
name
Type
string
Description
The name of the extra field
Name
description
Type
string
Description
The description of the extra field
Name
collectInCheckout
Type
boolean
Description
Whether the extra field is collected in checkout
Name
deleted
Type
boolean
Description
Whether the extra field is deleted
Name
type
Type
enum(text, number, select, checkbox, tel, country, email, date, documentUpload, signature, address)
Description
The type of the extra field. text = is a text field. number = is a number field. select = is a selection field of different selections. checkbox = is a checkbox field. tel = is a number field for a phone number. email = is a text field for an email. country = is a text field field for country.
Name
options
Type
array<string>
Description
An array of options of the extra field
Name
onlyForCertainTicketTypes
Type
boolean
Description
Whether the extra field is only for certain ticket types
Name
allowedTicketTypes
Type
array<string>
Description
An array of IDs of the ticket types allowed for the extra field
Name
printable
Type
boolean
Description
Whether the extra field is printable
Name
conditions
Type
array<object>
Description
An array of conditions of the extra field. The conditions can refer to other extra fields.
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the condition
Name
baseSlug
Type
string
Description
The slug of the base extra field which the condition refers to
Name
operator
Type
enum(equals, notEquals, greaterThan, lessThan, greaterThanOrEquals, lessThanOrEquals, exists, notExists)
Description
The operator which will be used to check the condition
Optional nested attributes (1)
Name
value
Type
array | boolean | number | object | string
Description
The value which the operator will be used on to check the condition.
Name
settings
Type
oneOf
Description
Type-specific settings for the extra field
One of — Only one of the following types
Optional attributes
Name
allowedMimeTypes
Type
array<enum(application/pdf, image/jpeg, image/png)>
Description
Name
ticketExtraFields
Type
array<object>
Description
An array of extra fields for ticket types of the event
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the extra field
Name
required
Type
boolean
Description
Whether the extra field is required
Optional nested attributes (11)
Name
name
Type
string
Description
The name of the extra field
Name
description
Type
string
Description
The description of the extra field
Name
collectInCheckout
Type
boolean
Description
Whether the extra field is collected in checkout
Name
deleted
Type
boolean
Description
Whether the extra field is deleted
Name
type
Type
enum(text, number, select, checkbox, tel, country, email, date, documentUpload, signature, address)
Description
The type of the extra field. text = is a text field. number = is a number field. select = is a selection field of different selections. checkbox = is a checkbox field. tel = is a number field for a phone number. email = is a text field for an email. country = is a text field field for country.
Name
options
Type
array<string>
Description
An array of options of the extra field
Name
onlyForCertainTicketTypes
Type
boolean
Description
Whether the extra field is only for certain ticket types
Name
allowedTicketTypes
Type
array<string>
Description
An array of IDs of the ticket types allowed for the extra field
Name
printable
Type
boolean
Description
Whether the extra field is printable
Name
conditions
Type
array<object>
Description
An array of conditions of the extra field. The conditions can refer to other extra fields.
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the condition
Name
baseSlug
Type
string
Description
The slug of the base extra field which the condition refers to
Name
operator
Type
enum(equals, notEquals, greaterThan, lessThan, greaterThanOrEquals, lessThanOrEquals, exists, notExists)
Description
The operator which will be used to check the condition
Optional nested attributes (1)
Name
value
Type
array | boolean | number | object | string
Description
The value which the operator will be used on to check the condition.
Name
settings
Type
oneOf
Description
Type-specific settings for the extra field
One of — Only one of the following types
Optional attributes
Name
allowedMimeTypes
Type
array<enum(application/pdf, image/jpeg, image/png)>
Description
Name
accentColor
Type
string
Description
The accent color of the event page
Name
pageStyle
Type
string
Description
The page style of the event page
Name
showOtherEvents
Type
boolean
Description
Whether other events should be displayed on the event page
Name
underShops
Type
array<object>
Description
An array of under shops of the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the under shop of the event
Name
name
Type
string
Description
The name of the under shop of the event
Name
active
Type
boolean
Description
Whether the under shop is active
Optional nested attributes (25)
Name
tickets
Type
array<object>
Description
An array of ticket types of the under shop
Required nested attributes (6)
Name
_id
Type
string
Description
The ID of ticket type extension of the event under shop
Name
baseTicket
Type
string
Description
The ID of a ticket type of the event used as base ticket type
Name
name
Type
string
Description
The name of the ticket type
Name
price
Type
number float
Description
The price of the ticket type
Name
amount
Type
number float
Description
The amount of the ticket type
Name
active
Type
boolean
Description
Whether the ticket type is active
Optional nested attributes (1)
Name
description
Type
string
Description
The description of the ticket type
Name
categories
Type
array<object>
Description
The array of ticket categories of the under shop
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of ticket category extension
Name
baseCategoryId
Type
string
Description
The ID of a ticket category of the event used as base ticket category
Optional nested attributes (2)
Name
amount
Type
number float
Description
The amount of the ticket category
Name
maxAmountPerOrder
Type
number float
Description
The maximum amount per order of the ticket category
Name
timeSlots
Type
array<object>
Description
The array of time slots of the under shop
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of time slot extension
Name
baseTimeSlotId
Type
string
Description
The ID of a time slot of the event used as base time slot
Name
amount
Type
number float
Description
The amount of the time slot
Optional nested attributes (1)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Whether the time slot enabled for under shop.
Name
sellStart
Type
string date-time
Description
The sell start of the under shop. Optional for ROOT events only
Name
sellEnd
Type
string date-time
Description
The sell end of the under shop. Optional for ROOT events only
Name
maxAmount
Type
number float
Description
The maximum amount of tickets of the under shop
Name
maxAmountPerOrder
Type
number float
Description
The maximum amount per order of the under shop
Name
minAmountPerOrder
Type
number float
Description
The minimum amount per order of the under shop
Name
maxTransactionsPerCustomer
Type
number float
Description
The maximum amount of transactions per customer of the under shop
Name
maxAmountPerCustomer
Type
number float
Description
Maximum amount of tickets per customer of the event
Name
ticketShopHeaderText
Type
string
Description
The header of the ticket shop of the under shop
Name
customCharges
Type
object
Description
Custom charges of the under shop
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the custom charge
Optional nested attributes (7)
Name
outerChargeVar
Type
number float
Description
The variable outer charge of the custom charge
Name
innerChargeVar
Type
number float
Description
The variable inner charge of the custom charge
Name
outerChargeFix
Type
number float
Description
The fix outer charge of the custom charge
Name
innerChargeFix
Type
number float
Description
The fix inner charge of the custom charge
Name
posOuterChargeFix
Type
number float
Description
The fix POS outer charge of the custom charge
Name
posOuterChargeVar
Type
number float
Description
The variable POS outer charge of the custom charge
Name
cartOuterChargeFix
Type
number float
Description
The fix cart outer charge of the custom charge
Name
seatingContingents
Type
array<string>
Description
An array of seating contingents of the under shop
Name
availabilityMode
Type
enum(default, contingentsOnly)
Description
The availability mode of the shop
Name
bestAvailableSeatingConfiguration
Type
object
Description
The best available seating options of the under shop
Optional nested attributes (3)
Name
enabled
Type
boolean
Description
Whether the best available seating is enabled
Name
enforced
Type
boolean
Description
Whether the best available seating is the only option to buy seated tickets. Seatmap won't be shown during checkout
Name
allowMassBooking
Type
boolean
Description
Whether the best available seating allows to buy seated tickets in bulk.
Name
reservationSettings
Type
object
Description
The reservation settings of the under shop
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the reservation setting
Optional nested attributes (2)
Name
option
Type
enum(noReservations, reservationsOnly, reservationsAndPayment, internalReservationsAndPayment)
Description
The option of the reservation setting. reservationsOnly = needs reservation only. noReservations = no reservations needed. reservationsAndPayment = needs reservation and payment
Name
strategyId
Type
string
Description
The ID of the strategy of a purchase intents to be used on the event
Name
accountSettings
Type
object
Description
Account settings of the under shop
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the account settings of the event
Optional nested attributes (2)
Name
enforceAccounts
Type
boolean
Status
deprecated
Description
Whether to enforce accounts for the event
Name
enforceAuthentication
Type
enum(DISABLED, PREVENT_CHECKOUT, PREVENT_DETAILS_STEP)
Description
Whether to enforce authentication for the event and how to enforce it
Name
customerTags
Type
array<string>
Description
An array of customer tags of the under shop
Name
customerSegments
Type
array<string>
Description
An array of customer segments of the under shop
Name
allowMassDownload
Type
boolean
Description
Enables option to download bulk tickets as a CSV or PDF file.
Name
inventoryStrategy
Type
enum(independent, subsidiary, global)
Description
Sets how available tickets will be calculated
Name
extraFields
Type
array<object>
Description
An array of extra fields of the under shop
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the extra field
Name
required
Type
boolean
Description
Whether the extra field is required
Optional nested attributes (11)
Name
name
Type
string
Description
The name of the extra field
Name
description
Type
string
Description
The description of the extra field
Name
collectInCheckout
Type
boolean
Description
Whether the extra field is collected in checkout
Name
deleted
Type
boolean
Description
Whether the extra field is deleted
Name
type
Type
enum(text, number, select, checkbox, tel, country, email, date, documentUpload, signature, address)
Description
The type of the extra field. text = is a text field. number = is a number field. select = is a selection field of different selections. checkbox = is a checkbox field. tel = is a number field for a phone number. email = is a text field for an email. country = is a text field field for country.
Name
options
Type
array<string>
Description
An array of options of the extra field
Name
onlyForCertainTicketTypes
Type
boolean
Description
Whether the extra field is only for certain ticket types
Name
allowedTicketTypes
Type
array<string>
Description
An array of IDs of the ticket types allowed for the extra field
Name
printable
Type
boolean
Description
Whether the extra field is printable
Name
conditions
Type
array<object>
Description
An array of conditions of the extra field. The conditions can refer to other extra fields.
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the condition
Name
baseSlug
Type
string
Description
The slug of the base extra field which the condition refers to
Name
operator
Type
enum(equals, notEquals, greaterThan, lessThan, greaterThanOrEquals, lessThanOrEquals, exists, notExists)
Description
The operator which will be used to check the condition
Optional nested attributes (1)
Name
value
Type
array | boolean | number | object | string
Description
The value which the operator will be used on to check the condition.
Name
settings
Type
oneOf
Description
Type-specific settings for the extra field
One of — Only one of the following types
Optional attributes
Name
allowedMimeTypes
Type
array<enum(application/pdf, image/jpeg, image/png)>
Description
Name
salesChannelGroupSettings
Type
array<object>
Description
An array of sales channel group settings associated with the under shop
Required nested attributes (1)
Name
salesChannelGroupId
Type
string
Description
The ID of the associated sales channel group
Optional nested attributes (1)
Name
enabled
Type
boolean
Description
Whether the sales channel group is enabled
Name
paymentSettings
Type
object
Description
The payment settings of the event
Optional nested attributes (1)
Name
paymentStrategyId
Type
string
Description
The ID of the associated payment strategy
Name
unlockMode
Type
enum(none, couponCode)
Description
Sets how event is locked, e.g. by coupon code.
Name
seating
Type
object
Description
The seating of the event
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the seating
Name
active
Type
boolean
Description
Whether the seating is active
Optional nested attributes (8)
Name
eventKey
Type
string
Description
The key of the event of the seating
Name
eventId
Type
string
Description
The ID of the event of the seating
Name
seatMapId
Type
string
Description
The ID of the seat map of the event
Name
revisionId
Type
string
Description
The ID of the revision of the event
Name
orphanConfiguration
Type
object
Description
The orphan configuration of the seating
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the seating orphan configuration
Optional nested attributes (2)
Name
minSeatDistance
Type
number float
Description
Minimum distance of seats to each other
Name
edgeSeatsOrphaning
Type
boolean
Description
Whether the edge seats can orphaning
Name
contingents
Type
array<string>
Description
An array of seating contingent ids
Name
availabilityMode
Type
enum(default, contingentsOnly)
Description
The seating availability mode
Name
bestAvailableSeatingConfiguration
Type
object
Description
The best available seating configuration of the seating
Optional nested attributes (2)
Name
enabled
Type
boolean
Description
Whether the best available seating is enabled
Name
enforced
Type
boolean
Description
Whether the best available seating is the only option to buy seated tickets. Seatmap won't be shown during checkout
Name
customTextConfig
Type
object
Description
The custom text configuration of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the custom text configuration
Optional nested attributes (1)
Name
buyTicketsCTA
Type
string
Description
The custom CTA after buy tickets
Name
eventType
Type
enum(SINGLE, GROUP, RECURRENCE, ROOT)
Description
The type of the event. SINGLE = it is a single event. GROUP = the event is part of a group of events
Name
childEvents
Type
array<string>
Description
An array of IDs of child events
Name
url
Type
string
Description
The url of the event
Name
tags
Type
array<string>
Description
An array of tags of the event
Name
seoSettings
Type
object
Description
The search engine optimization settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the SEO setting
Optional nested attributes (4)
Name
tags
Type
array<string>
Description
An array of tags of the seo settings
Name
noIndex
Type
boolean
Description
Whether the seo setting has no indexing
Name
title
Type
string
Description
The title of the seo settings
Name
description
Type
string
Description
The description of the seo settings
Name
extraInformation
Type
object
Description
The extra information of the event
Optional nested attributes (4)
Name
_id
Type
string
Description
The ID of the extra information of the event
Name
type
Type
string
Description
The type of the extra information of the event
Name
category
Type
string
Description
The category of the extra information of the event
Name
subCategory
Type
string
Description
The subCategory of the extra information of the event
Name
customCharges
Type
object
Description
Custom charges of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the custom charge
Optional nested attributes (7)
Name
outerChargeVar
Type
number float
Description
The variable outer charge of the custom charge
Name
innerChargeVar
Type
number float
Description
The variable inner charge of the custom charge
Name
outerChargeFix
Type
number float
Description
The fix outer charge of the custom charge
Name
innerChargeFix
Type
number float
Description
The fix inner charge of the custom charge
Name
posOuterChargeFix
Type
number float
Description
The fix POS outer charge of the custom charge
Name
posOuterChargeVar
Type
number float
Description
The variable POS outer charge of the custom charge
Name
cartOuterChargeFix
Type
number float
Description
The fix cart outer charge of the custom charge
Name
gallery
Type
array<object>
Description
An array of gallery items of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the gallery item
Optional nested attributes (5)
Name
title
Type
string
Description
The title of the gallery item
Name
description
Type
string
Description
The description of the gallery item
Name
copyright
Type
string
Description
The copyright of the gallery item
Name
index
Type
number float
Description
The index of the gallery item
Name
image
Type
string
Description
The image of the gallery item
Name
video
Type
object
Description
The video settings of the event
Optional nested attributes (1)
Name
youtubeID
Type
string
Description
The youtube video ID of the event video setting
Name
soldOutFallback
Type
object
Description
The sold out fallback of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of sold out entry
Optional nested attributes (2)
Name
soldOutFallbackType
Type
enum(default, moreinformation, waitinglist)
Description
Name
soldOutFallbackLink
Type
string
Description
The link of the sold out fallback
Name
ticketDesign
Type
object
Description
The ticket design settings for ticket types of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the ticket types design of the event
Optional nested attributes (8)
Name
useCustomDesign
Type
boolean
Description
Whether to use custom design on ticket types of event
Name
customDesignURL
Type
string
Description
The custom design URL for ticket types of event
Name
footerDesignURL
Type
string
Description
The footer design URL for ticket types of the event
Name
disclaimer
Type
string
Description
The disclaimer for ticket types of the event
Name
infoColor
Type
string
Description
The info color for ticket types of the event
Name
showTimeRange
Type
boolean
Description
Whether to show time range on ticket types of the event
Name
hideDates
Type
boolean
Description
Whether to hide dates on ticket types of the event
Name
hideTimes
Type
boolean
Description
Whether to hide the time on ticket types of the event
Name
checkinInformation
Type
object
Description
The checkin information of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the checkin information of the event
Optional nested attributes (1)
Name
checkinStarts
Type
string date-time
Description
The date of when the checkin of the event starts
Name
tracking
Type
object
Description
The tracking of the event
Optional nested attributes (2)
Name
facebookPixel
Type
object
Description
The facebook pixel information of the event tracking
Optional nested attributes (2)
Name
active
Type
boolean
Description
Whether facebook pixel of event tracking is active
Name
pixelId
Type
string
Description
The ID of facebook pixel of the event tracking
Name
tagging
Type
object
Description
The tagging of the event tracking
Optional nested attributes (2)
Name
enabled
Type
boolean
Description
Whether tagging of event tracking is enabled
Name
tags
Type
array<string>
Description
An array of tags of the event tracking
Name
hardTicketSettings
Type
object
Description
The hard ticket settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the event hard ticket settings
Optional nested attributes (9)
Name
enabled
Type
boolean
Description
Whether hard tickets can be bought for this event
Name
fulfillmentType
Type
enum(self, managed)
Description
The type of fulfillment. self fulfilled by the seller. managed fulfilled by vivenu.
Name
printingMethod
Type
enum(preprinted, adhoc)
Description
Which printing method is used. preprinted = The tickets are preprinted. adhoc = The tickets are printed ad-hoc.
Name
hardTicketOuterCharge
Type
number float
Description
Additional charge for every hard ticket that is added to the ticket price and the other outer charges - paid by the ticket buyer.
Name
hardTicketInnerCharge
Type
number float
Description
Additional charge for hard tickets as in the contract of the seller
Name
hardTicketPreviewURL
Type
string
Description
The hard ticket design image
Name
promotionName
Type
string
Description
A special name for hard tickets. e.g. "Collector edition"
Name
promotionText
Type
string
Description
A description about what makes this ticket so special
Name
requiredDays
Type
integer
Description
Required days until deliver of the hard tickets
Name
dataRequestSettings
Type
object
Description
The data request settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the data request settings of the event
Optional nested attributes (12)
Name
requiresPersonalization
Type
boolean
Description
Whether the tickets for this event need personalization
Name
requiresExtraFields
Type
boolean
Description
Whether the tickets for this event need extra data fields
Name
repersonalization
Type
boolean
Status
deprecated
Description
Whether the tickets can be re personalized.
Name
repersonalizationAllowed
Type
boolean
Description
Whether the tickets can be re personalized.
Name
repersonalizationEndDate
Type
string date-time
Status
deprecated
Description
If repersonalization = true. Until when the re personalization is allowed.
Name
repersonalizationDeadline
Type
object
Description
If repersonalization = true. A relatve date specification until when the re personalization is allowed.
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
repersonalizationFee
Type
number float
Description
If repersonalization = true. The per-ticket fee for repersonalization.
Name
repersonalizationsLimit
Type
number float
Description
If repersonalization = true. The number of times repersonalization is allowed.
Name
limitOnlyNameChanges
Type
boolean
Description
If enabled, only name changes count towards the re-personalization limit for every ticket type of the event. Extra fields can always be updated until the re-personalization deadline.
Name
posPersonalization
Type
enum(noPersonalization, optionalPersonalization, requiredPersonalization)
Description
The type of personalization for this event on Point of Sale applications.
Name
skipAddressInfo
Type
boolean
Description
Whether the checkout should not ask for the address of the ticket buyer.
Name
enforceCompany
Type
boolean
Description
Whether the company of the ticket buyer is a required field.
Name
styleOptions
Type
object
Description
Style options of the event page
Optional nested attributes (10)
Name
headerStyle
Type
string
Description
Header style of the event page
Name
brandOne
Type
string
Description
First brand of the event
Name
brandTwo
Type
string
Description
Second brand of the event
Name
hideLocationMap
Type
boolean
Description
Whether the location map on the event page hide
Name
hideLocationAddress
Type
boolean
Description
Whether the location address on the event page hide
Name
categoryAlignment
Type
enum(cascade, asTabs, boxes, ticketWizard, 0, 1, 2, 3) float
Description
The style of category alignment. 0 = cascade = categories among themselves. 1 = asTabs = categories as tabs. 2 = boxes = categories as boxes. 3 = ticket wizard = categories as ticket wizard if configured.
Name
showAvailabilityIndicator
Type
boolean
Description
Whether the availability indicator on the event page should be shown
Name
availabilityIndicatorThresholds
Type
array<number>
Description
The availability indicator thresholds of the event
Name
showAvailable
Type
boolean
Description
Whether to show availability of the time slot. Only applicable for time slot events.
Name
timeSlotsCheckoutSelection
Type
enum(beforeTickets, afterTickets)
Description
Time slots selection in checkout.
Name
geoCode
Type
object
Description
The geographic code of the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the geo code
Name
lat
Type
number float
Description
Latitude coordinate of the geo code
Name
lng
Type
number float
Description
Longitude coordinate of the geo code
Name
accountSettings
Type
object
Description
Account settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the account settings of the event
Optional nested attributes (2)
Name
enforceAccounts
Type
boolean
Status
deprecated
Description
Whether to enforce accounts for the event
Name
enforceAuthentication
Type
enum(DISABLED, PREVENT_CHECKOUT, PREVENT_DETAILS_STEP)
Description
Whether to enforce authentication for the event and how to enforce it
Name
reservationSettings
Type
object
Description
The reservation settings of event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the reservation setting
Optional nested attributes (2)
Name
option
Type
enum(noReservations, reservationsOnly, reservationsAndPayment, internalReservationsAndPayment)
Description
The option of the reservation setting. reservationsOnly = needs reservation only. noReservations = no reservations needed. reservationsAndPayment = needs reservation and payment
Name
strategyId
Type
string
Description
The ID of the strategy of a purchase intents to be used on the event
Name
upsellSettings
Type
object
Description
The upsell settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the upsell settings of the event
Optional nested attributes (4)
Name
active
Type
boolean
Description
Whether upselling is active on the event
Name
productStream
Type
string
Description
The product stream for upselling
Name
headerImage
Type
string
Description
A header image for the ticket shop, when selecting products
Name
crossSells
Type
object
Description
The cross selling settings.
Optional nested attributes (1)
Name
eventIds
Type
array<string>
Description
The array of the promoted event IDs.
Name
repetitionSettings
Type
array<object>
Description
The repetition settings of the event
Required nested attributes (4)
Name
every
Type
number float
Description
Repeat event every unit of time
Name
unit
Type
enum(DAY, WEEK, MONTH)
Description
Unit of repetition - day, week, month
Name
from
Type
string date-time
Description
Repeat event from date
Name
to
Type
string date-time
Description
Repeat event till date
Optional nested attributes (1)
Name
repeatsOn
Type
array<enum(SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY)>
Description
Days of a week when the event is repeated
Name
rootId
Type
string
Description
The id of the root event
Name
daySchemes
Type
array<DaySchemeResource>
Description
The possible day schemas of how event could be sold
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the day scheme.
Name
name
Type
string
Description
The name of the day scheme.
Name
color
Type
string
Description
The color of the day scheme.
Optional nested attributes (1)
Name
offers
Type
object
Description
Offers of the day scheme.
Optional nested attributes (3)
Name
allTicketTypesActive
Type
boolean
Description
Whether the all ticket types active.
Name
ticketTypes
Type
array<object>
Description
The day scheme offer ticket types.
Required nested attributes (1)
Name
ticketTypeId
Type
string
Description
The ticket type id which could be sold.
Optional nested attributes (1)
Name
active
Type
boolean
Description
Whether the ticket type is selling.
Name
timeSlots
Type
array<object>
Description
Time slots overrides.
Required nested attributes (1)
Name
slotId
Type
string
Description
The slotId of the time slot.
Optional nested attributes (2)
Name
enabled
Type
string
Description
Whether the slot is enabled.
Name
amount
Type
number float
Description
The amount of available tickets of the time slot of the day scheme.
Name
daySchemeId
Type
string
Description
The ID of the day scheme assigned to the event.
Name
ticketSettings
Type
object
Description
The event ticket settings
Optional nested attributes (9)
Name
codeDisplay
Type
enum(BARCODE, QRCODE, HIDE)
Description
How the ticket code is displayed. Null inherits the seller setting.
Name
cancellationStrategy
Type
enum(disabled, freeTicketsOnly, withoutRefund)
Description
Cancellation strategy of the ticket types
Name
revealingSettings
Type
object
Description
Barcode reveal settings of the event.
Optional nested attributes (2)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
beforeEvent
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
transferSettings
Type
object
Description
Transfer settings of the ticket types
Optional nested attributes (7)
Name
mode
Type
enum(ALLOWED, DISABLED)
Description
Ticket transfer mode.
Name
expiresAfter
Type
object
Description
If 'mode = ALLOWED'. A relatve date specification until when ticket transfer is valid.
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
retransferMode
Type
enum(ALLOWED, DISABLED)
Description
Ticket retransfer mode.
Name
allowedUntil
Type
object
Description
If 'mode = ALLOWED'. A relatve date specification until the end of the event where ticket transfer is possible.
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
hardTicketsMode
Type
enum(ALLOWED, DISABLED)
Description
If 'hardTicketsMode = ALLOWED' then hard tickets transfers allowed.
Name
seasonTicketMode
Type
enum(NO_RESTRICTION, CHILDREN_ONLY, GROUP_ONLY)
Description
Restrict how season tickets can be transferred.
Name
useSeasonCardTemplate
Type
boolean
Description
Whether to use the season card template for individual tickets transferred from the season.
Name
upgradeSettings
Type
object
Description
Upgrade settings of the ticket types
Optional nested attributes (2)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Whether ticket upgrade settings enabled.
Name
underShopMapping
Type
array<object>
Description
Mapping to define the under shop in which a ticket upgrade will be performed.
Required nested attributes (3)
Name
type
Type
enum(tag)
Description
Name
tag
Type
string
Description
The customer tag
Name
underShopId
Type
string
Description
The ID of the under shop.
Name
resellSettings
Type
object
Description
Resell settings
Optional nested attributes (10)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Whether resell is enabled
Name
resellerFeeFix
Type
number float
Description
The fixed fee per ticket that the reseller pays
Name
resellerFeeVar
Type
number float
Description
The variable fee per ticket that the reseller pays
Name
buyerFeeFix
Type
number float
Description
The fixed fee per ticket that the buyer pays
Name
buyerFeeVar
Type
number float
Description
The variable fee per ticket that the buyer pays
Name
offerCreationStart
Type
object
Description
A relative date specification of offers creation start.
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
offerCreationEnd
Type
object
Description
A relative date specification of offers creation end.
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
salesStart
Type
object
Description
A relative date specification of sales start.
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
priceMarkup
Type
number float
Description
The markup applied to the price of each ticket bought on the secondary market.
Name
cartAutomationMode
Type
enum(BLOCKED, INDIVIDUAL)
Description
Controls whether tickets involved in cart automations can be resold.
Name
barcodeSettings
Type
object
Description
Barcode settings
Optional nested attributes (1)
Name
issueOfflineBarcodes
Type
enum(ENABLED, DISABLED)
Description
Whether offline barcodes are enabled
Name
childEventMapping
Type
array<object>
Description
Child event mapping
Required nested attributes (2)
Name
childEventId
Type
string
Description
The child event for this mapping
Name
ticketTypeMapping
Type
object
Description
Mapping between ticket types of the parent event and the child events
Optional nested attributes (1)
Name
valueShare
Type
number float
Description
The percentage value of this child event from the value of the parent event
Name
seasonCardValueStrategy
Type
enum(childValue, averagePerChild, sharePerChild)
Description
The strategy used to determine the value of a child event in the context of the parent event
Name
accessListMapping
Type
array<object>
Description
The array represents a mapping between access list ids and ticket type ids for which a ticket will be created.
Required nested attributes (2)
Name
listId
Type
string
Description
The ID of the access list.
Name
ticketTypeId
Type
string
Description
The ID of the ticket type.
Name
deliverySettings
Type
object
Description
Delivery Settings
Optional nested attributes (2)
Name
wallet
Type
object
Description
Optional nested attributes (3)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
nfc
Type
enum(ENABLED, DISABLED)
Description
Name
seasonCardShowNextEvent
Type
boolean
Description
Whether to display the information for next event of the season event on a wallet ticket or not. If activated, the information of the next event will be displayed on the wallet ticket instead of the season event.
Name
pdf
Type
object
Description
Optional nested attributes (1)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
meta
Type
object
Description
Custom key-value data. Metadata is useful for storing additional, structured information on an object.
Name
timezone
Type
string
Description
Timezone of event
Name
salesChannelGroupSettings
Type
array<object>
Description
An array of sales channel group settings associated with the event
Required nested attributes (1)
Name
salesChannelGroupId
Type
string
Description
The ID of the associated sales channel group
Optional nested attributes (1)
Name
enabled
Type
boolean
Description
Whether the sales channel group is enabled
Name
paymentSettings
Type
object
Description
The payment settings of the event
Optional nested attributes (1)
Name
paymentStrategyId
Type
string
Description
The ID of the associated payment strategy
Name
timeSlots
Type
array<object>
Description
The time slots for the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the time slot
Name
startTime
Type
object
Description
The time of day the time slot starts
Required nested attributes (2)
Name
hour
Type
integer
Description
Name
minute
Type
integer
Description
Name
refs
Type
array<object>
Description
The ticket references for the time slot
Required nested attributes (2)
Name
refType
Type
enum(category)
Description
The type of the reference
Name
categoryRef
Type
string
Description
The ticket category reference to use for the time slot
Optional nested attributes (1)
Name
amount
Type
number float
Description
The amount of available tickets of the time slot of the event
Name
useTimeSlots
Type
boolean
Description
Whether the event uses time slots.
Name
attributes
Type
object
Description

Example

{
  "event": {
    "_id": "507f191e810c19729de860ea",
    "name": "Some fancy Name",
    "start": "2030-01-23T23:00:00.123Z",
    "end": "2030-01-23T23:00:00.123Z",
    "maxAmount": 10.5,
    "maxAmountPerOrder": 10.5,
    "sellerId": "507f191e810c19729de860ea",
    "slogan": "string",
    "description": "string",
    "locationName": "Some fancy Name",
    "locationStreet": "Speditionsstr",
    "locationCity": "Düsseldorf",
    "locationPostal": "40221",
    "locationCountry": "string",
    "image": "https://your-url/image.png",
    "ticketFooter": "string",
    "ticketBackground": "string",
    "ticketShopHeader": "string",
    "groups": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "tickets": [
          "string"
        ]
      }
    ],
    "discountGroups": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "value": 10.5,
        "rules": [
          {
            "_id": "507f191e810c19729de860ea",
            "min": 10.5,
            "max": 10.5,
            "group": "string",
            "type": "ticketGroups"
          }
        ],
        "discountType": "fix"
      }
    ],
    "cartAutomationRules": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "triggerType": "hasBeenAdded",
        "triggerTargetGroup": "string",
        "thenType": "autoAdd",
        "thenTargets": [
          {
            "_id": "507f191e810c19729de860ea",
            "thenTargetGroup": "string",
            "thenTargetMin": 10.5,
            "thenTargetMax": 10.5
          }
        ]
      }
    ],
    "posDiscounts": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "value": 10.5,
        "discountType": "fix"
      }
    ],
    "categories": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "description": "string",
        "seatingReference": "string",
        "ref": "string",
        "amount": 10.5,
        "recommendedTicket": "string",
        "maxAmountPerOrder": 10.5,
        "listWithoutSeats": true
      }
    ],
    "tickets": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "price": 10.5,
        "amount": 10.5,
        "active": true,
        "description": "string",
        "image": "https://your-url/image.png",
        "color": "string",
        "posActive": true,
        "categoryRef": "string",
        "ignoredForStartingPrice": true,
        "conditionalAvailability": true,
        "ticketBackground": "string",
        "rules": [
          {
            "_id": "507f191e810c19729de860ea",
            "ticketGroup": "string",
            "min": 10.5,
            "max": 10.5
          }
        ],
        "requiresPersonalization": true,
        "requiresPersonalizationMode": "ENABLED",
        "requiresExtraFields": true,
        "requiresExtraFieldsMode": "ENABLED",
        "repersonalizationAllowedMode": "ENABLED",
        "repersonalizationFee": 10.5,
        "sortingKey": 10.5,
        "enableHardTicketOption": true,
        "forceHardTicketOption": true,
        "maxAmountPerOrder": 10.5,
        "minAmountPerOrder": 10.5,
        "minAmountPerOrderRule": 10.5,
        "taxRate": 10.5,
        "styleOptions": {
          "thumbnailImage": "string",
          "showAvailable": true,
          "hiddenInSelectionArea": true
        },
        "priceCategoryId": "507f191e810c19729de860ea",
        "entryPermissions": [
          "string"
        ],
        "ignoreForMaxAmounts": true,
        "expirationSettings": {
          "enabled": true,
          "expiresAfter": {
            "unit": "hours",
            "offset": 1,
            "target": "string"
          }
        },
        "barcodePrefix": "string",
        "salesStart": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "salesEnd": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "transferSettings": {
          "mode": "ALLOWED",
          "expiresAfter": {
            "unit": "hours",
            "offset": 1,
            "target": "string"
          },
          "retransferMode": "ALLOWED",
          "allowedUntil": {
            "unit": "hours",
            "offset": 1,
            "target": "string"
          },
          "hardTicketsMode": "ALLOWED",
          "seasonTicketMode": "NO_RESTRICTION"
        },
        "scanSettings": {
          "feedback": "highlight",
          "allowedScanCount": 10.5
        },
        "deliverySettings": {
          "wallet": {
            "enabled": "ENABLED"
          },
          "pdf": {
            "enabled": "ENABLED"
          }
        },
        "meta": {},
        "revealingSettings": {
          "enabled": "ENABLED",
          "beforeEvent": {
            "unit": "hours",
            "offset": 1,
            "target": "string"
          }
        }
      }
    ],
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z",
    "sellStart": "2030-01-23T23:00:00.123Z",
    "sellEnd": "2030-01-23T23:00:00.123Z",
    "maxAmountPerCustomer": 10.5,
    "maxTransactionsPerCustomer": 10.5,
    "minAmountPerOrder": 1,
    "customerTags": [
      "string"
    ],
    "customerSegments": [
      "string"
    ],
    "showCountdown": true,
    "hideInListing": true,
    "visibleAfter": "2030-01-23T23:00:00.123Z",
    "customSettings": {
      "_id": "507f191e810c19729de860ea",
      "hideTicketsInTransactionPage": true,
      "dontSendTicketMail": true,
      "dontSendBookingConfirmationMail": true,
      "customMailHeaderImage": "string",
      "customTransactionCompletionText": "string",
      "disableAppleWallet": true,
      "disablePdfTickets": true,
      "showStartDate": true,
      "showStartTime": true,
      "showEndDate": true,
      "showEndTime": true,
      "showTimeRangeInListing": true,
      "showTimeRangeInTicket": true,
      "customCheckoutCSS": "string",
      "useCustomCheckoutBrand": true,
      "customCheckoutBrand": "string",
      "hideLogoInCheckout": true,
      "customEventPageHTML": "string",
      "customEventPageCSS": "string",
      "customConfirmationPage": "string",
      "hideSeatmapInCheckout": true,
      "dontSendBookingConfirmationSMS": true
    },
    "extraFields": [
      {
        "_id": "507f191e810c19729de860ea",
        "required": true,
        "name": "Some fancy Name",
        "description": "string",
        "collectInCheckout": true,
        "deleted": true,
        "type": "text",
        "options": [
          "string"
        ],
        "onlyForCertainTicketTypes": true,
        "allowedTicketTypes": [
          "string"
        ],
        "printable": true,
        "conditions": [
          {
            "_id": "507f191e810c19729de860ea",
            "baseSlug": "string",
            "operator": "equals",
            "value": []
          }
        ],
        "settings": {
          "allowedMimeTypes": [
            "application/pdf"
          ]
        }
      }
    ],
    "ticketExtraFields": [
      {
        "_id": "507f191e810c19729de860ea",
        "required": true,
        "name": "Some fancy Name",
        "description": "string",
        "collectInCheckout": true,
        "deleted": true,
        "type": "text",
        "options": [
          "string"
        ],
        "onlyForCertainTicketTypes": true,
        "allowedTicketTypes": [
          "string"
        ],
        "printable": true,
        "conditions": [
          {
            "_id": "507f191e810c19729de860ea",
            "baseSlug": "string",
            "operator": "equals",
            "value": []
          }
        ],
        "settings": {
          "allowedMimeTypes": [
            "application/pdf"
          ]
        }
      }
    ],
    "accentColor": "#006DCC",
    "pageStyle": "white",
    "showOtherEvents": true,
    "underShops": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "active": true,
        "tickets": [
          {
            "_id": "507f191e810c19729de860ea",
            "baseTicket": "string",
            "name": "Some fancy Name",
            "price": 10.5,
            "amount": 10.5,
            "active": true,
            "description": "string"
          }
        ],
        "categories": [
          {
            "_id": "507f191e810c19729de860ea",
            "baseCategoryId": "507f191e810c19729de860ea",
            "amount": 10.5,
            "maxAmountPerOrder": 10.5
          }
        ],
        "timeSlots": [
          {
            "_id": "507f191e810c19729de860ea",
            "baseTimeSlotId": "507f191e810c19729de860ea",
            "amount": 10.5,
            "enabled": "ENABLED"
          }
        ],
        "sellStart": "2030-01-23T23:00:00.123Z",
        "sellEnd": "2030-01-23T23:00:00.123Z",
        "maxAmount": 10.5,
        "maxAmountPerOrder": 10.5,
        "minAmountPerOrder": 1,
        "maxTransactionsPerCustomer": 10.5,
        "maxAmountPerCustomer": 10.5,
        "ticketShopHeaderText": "string",
        "customCharges": {
          "_id": "507f191e810c19729de860ea",
          "outerChargeVar": 10.5,
          "innerChargeVar": 10.5,
          "outerChargeFix": 10.5,
          "innerChargeFix": 10.5,
          "posOuterChargeFix": 10.5,
          "posOuterChargeVar": 10.5,
          "cartOuterChargeFix": 10.5
        },
        "seatingContingents": [
          "string"
        ],
        "availabilityMode": "default",
        "bestAvailableSeatingConfiguration": {
          "enabled": true,
          "enforced": true,
          "allowMassBooking": true
        },
        "reservationSettings": {
          "option": "noReservations"
        },
        "accountSettings": {
          "_id": "507f191e810c19729de860ea",
          "enforceAccounts": true,
          "enforceAuthentication": "DISABLED"
        },
        "customerTags": [
          "string"
        ],
        "customerSegments": [
          "string"
        ],
        "allowMassDownload": true,
        "inventoryStrategy": "independent",
        "extraFields": [
          {
            "_id": "507f191e810c19729de860ea",
            "required": true,
            "name": "Some fancy Name",
            "description": "string",
            "collectInCheckout": true,
            "deleted": true,
            "type": "text",
            "options": [
              "string"
            ],
            "onlyForCertainTicketTypes": true,
            "allowedTicketTypes": [
              "string"
            ],
            "printable": true,
            "conditions": [
              {
                "_id": "507f191e810c19729de860ea",
                "baseSlug": "string",
                "operator": "equals",
                "value": []
              }
            ],
            "settings": {
              "allowedMimeTypes": [
                "application/pdf"
              ]
            }
          }
        ],
        "salesChannelGroupSettings": [
          {
            "salesChannelGroupId": "507f191e810c19729de860ea",
            "enabled": true
          }
        ],
        "paymentSettings": {
          "paymentStrategyId": "507f191e810c19729de860ea"
        },
        "unlockMode": "none"
      }
    ],
    "seating": {
      "_id": "507f191e810c19729de860ea",
      "active": true,
      "eventKey": "string",
      "eventId": "507f191e810c19729de860ea",
      "seatMapId": "507f191e810c19729de860ea",
      "revisionId": "507f191e810c19729de860ea",
      "orphanConfiguration": {
        "_id": "507f191e810c19729de860ea",
        "minSeatDistance": 2,
        "edgeSeatsOrphaning": true
      },
      "contingents": [
        "string"
      ],
      "availabilityMode": "default",
      "bestAvailableSeatingConfiguration": {
        "enabled": true,
        "enforced": true
      }
    },
    "customTextConfig": {
      "_id": "507f191e810c19729de860ea",
      "buyTicketsCTA": "string"
    },
    "eventType": "SINGLE",
    "childEvents": [
      "string"
    ],
    "url": "https://vivenu.com",
    "tags": [
      "string"
    ],
    "seoSettings": {
      "_id": "507f191e810c19729de860ea",
      "tags": [
        "string"
      ],
      "noIndex": true,
      "title": "string",
      "description": "string"
    },
    "extraInformation": {
      "_id": "507f191e810c19729de860ea",
      "type": "string",
      "category": "string",
      "subCategory": "string"
    },
    "customCharges": {
      "_id": "507f191e810c19729de860ea",
      "outerChargeVar": 10.5,
      "innerChargeVar": 10.5,
      "outerChargeFix": 10.5,
      "innerChargeFix": 10.5,
      "posOuterChargeFix": 10.5,
      "posOuterChargeVar": 10.5,
      "cartOuterChargeFix": 10.5
    },
    "gallery": [
      {
        "_id": "507f191e810c19729de860ea",
        "title": "string",
        "description": "string",
        "copyright": "string",
        "index": 10.5,
        "image": "https://your-url/image.png"
      }
    ],
    "video": {
      "youtubeID": "string"
    },
    "soldOutFallback": {
      "_id": "507f191e810c19729de860ea",
      "soldOutFallbackType": "default",
      "soldOutFallbackLink": "string"
    },
    "ticketDesign": {
      "_id": "507f191e810c19729de860ea",
      "useCustomDesign": true,
      "customDesignURL": "string",
      "footerDesignURL": "string",
      "disclaimer": "string",
      "infoColor": "string",
      "showTimeRange": true,
      "hideDates": true,
      "hideTimes": true
    },
    "checkinInformation": {
      "_id": "507f191e810c19729de860ea",
      "checkinStarts": "2030-01-23T23:00:00.123Z"
    },
    "tracking": {
      "facebookPixel": {
        "active": true,
        "pixelId": "507f191e810c19729de860ea"
      },
      "tagging": {
        "enabled": true,
        "tags": [
          "string"
        ]
      }
    },
    "hardTicketSettings": {
      "_id": "507f191e810c19729de860ea",
      "enabled": true,
      "fulfillmentType": "self",
      "printingMethod": "preprinted",
      "hardTicketOuterCharge": 10.5,
      "hardTicketInnerCharge": 10.5,
      "hardTicketPreviewURL": "string",
      "promotionName": "string",
      "promotionText": "string",
      "requiredDays": 1
    },
    "dataRequestSettings": {
      "requiresPersonalization": false,
      "requiresExtraFields": false,
      "repersonalization": false,
      "posPersonalization": "noPersonalization"
    },
    "styleOptions": {
      "headerStyle": "default",
      "hideLocationMap": false,
      "hideLocationAddress": false,
      "categoryAlignment": 0,
      "showAvailabilityIndicator": false,
      "availabilityIndicatorThresholds": [
        0.3,
        0.7
      ]
    },
    "geoCode": {
      "_id": "507f191e810c19729de860ea",
      "lat": 10.5,
      "lng": 10.5
    },
    "accountSettings": {
      "_id": "507f191e810c19729de860ea",
      "enforceAccounts": true,
      "enforceAuthentication": "DISABLED"
    },
    "reservationSettings": {
      "option": "noReservations"
    },
    "upsellSettings": {
      "_id": "507f191e810c19729de860ea",
      "active": true,
      "productStream": "string",
      "headerImage": "string",
      "crossSells": {
        "eventIds": [
          "string"
        ]
      }
    },
    "repetitionSettings": [
      {
        "every": 10.5,
        "unit": "DAY",
        "from": "2030-01-23T23:00:00.123Z",
        "to": "2030-01-23T23:00:00.123Z",
        "repeatsOn": [
          "SUNDAY"
        ]
      }
    ],
    "rootId": "507f191e810c19729de860ea",
    "daySchemes": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "color": "string",
        "offers": {
          "allTicketTypesActive": true,
          "ticketTypes": [
            {
              "ticketTypeId": "507f191e810c19729de860ea",
              "active": true
            }
          ],
          "timeSlots": [
            {
              "slotId": "507f191e810c19729de860ea",
              "enabled": "string",
              "amount": 10.5
            }
          ]
        }
      }
    ],
    "daySchemeId": "507f191e810c19729de860ea",
    "ticketSettings": {
      "codeDisplay": "BARCODE",
      "cancellationStrategy": "disabled",
      "revealingSettings": {
        "enabled": "ENABLED",
        "beforeEvent": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        }
      },
      "transferSettings": {
        "mode": "ALLOWED",
        "expiresAfter": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "retransferMode": "ALLOWED",
        "allowedUntil": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "hardTicketsMode": "ALLOWED",
        "seasonTicketMode": "NO_RESTRICTION",
        "useSeasonCardTemplate": true
      },
      "upgradeSettings": {
        "enabled": "ENABLED",
        "underShopMapping": [
          {
            "type": "tag",
            "tag": "string",
            "underShopId": "507f191e810c19729de860ea"
          }
        ]
      },
      "resellSettings": {
        "enabled": "ENABLED",
        "resellerFeeFix": 10.5,
        "resellerFeeVar": 10.5,
        "buyerFeeFix": 10.5,
        "buyerFeeVar": 10.5,
        "offerCreationStart": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "offerCreationEnd": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "salesStart": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "priceMarkup": 10.5,
        "cartAutomationMode": "BLOCKED"
      },
      "barcodeSettings": {
        "issueOfflineBarcodes": "ENABLED"
      },
      "childEventMapping": [
        {
          "childEventId": "507f191e810c19729de860ea",
          "ticketTypeMapping": {},
          "valueShare": 10.5
        }
      ],
      "seasonCardValueStrategy": "childValue"
    },
    "accessListMapping": [
      {
        "listId": "507f191e810c19729de860ea",
        "ticketTypeId": "507f191e810c19729de860ea"
      }
    ],
    "deliverySettings": {
      "wallet": {
        "enabled": "ENABLED",
        "nfc": "ENABLED",
        "seasonCardShowNextEvent": true
      },
      "pdf": {
        "enabled": "ENABLED"
      }
    },
    "meta": {},
    "timezone": "string",
    "salesChannelGroupSettings": [
      {
        "salesChannelGroupId": "507f191e810c19729de860ea",
        "enabled": true
      }
    ],
    "paymentSettings": {
      "paymentStrategyId": "507f191e810c19729de860ea"
    },
    "timeSlots": [
      {
        "_id": "507f191e810c19729de860ea",
        "startTime": {
          "hour": 1,
          "minute": 1
        },
        "refs": [
          {
            "refType": "category",
            "categoryRef": "string"
          }
        ],
        "amount": 10.5
      }
    ],
    "useTimeSlots": true,
    "attributes": {}
  }
}

event.deleted

The data of the event deleted webhook event.

Required attributes

Name
event
Type
EventResource
Description
The associated event which has been deleted
Required nested attributes (6)
Name
_id
Type
string
Description
The ID of the event
Name
name
Type
string
Description
The name of the event
Name
start
Type
string date-time
Description
An ISO timestamp indicating when the event starts
Name
end
Type
string date-time
Description
An ISO timestamp indicating when the event ends
Name
maxAmount
Type
number float
Description
Maximum amount of tickets of the event
Name
maxAmountPerOrder
Type
number float
Description
Maximum amount of tickets per order of the event
Optional nested attributes (73)
Name
sellerId
Type
string
Description
The ID of the seller owning this event
Name
slogan
Type
string
Description
The slogan of the event
Name
description
Type
string
Description
A description about the event. Description is in RichText - JSON format.
Name
locationName
Type
string
Description
The name of the location where the event takes place
Name
locationStreet
Type
string
Description
The street of the location where the event takes place
Name
locationCity
Type
string
Description
The city of the location where the event takes place
Name
locationPostal
Type
string
Description
The postal code of the location where the event takes place
Name
locationCountry
Type
string
Description
The country code of the location where the event takes place
Name
image
Type
string
Description
An image for the event
Name
ticketFooter
Type
string
Description
A footer image for the ticket PDF of the event
Name
ticketBackground
Type
string
Description
A background image for the ticket PDF of the event
Name
ticketShopHeader
Type
string
Description
A header image for the ticket shop of the event
Name
groups
Type
array<object>
Description
An array of groups of ticket types of the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of of the ticket group of the event
Name
name
Type
string
Description
The name of the ticket group of the event
Name
tickets
Type
array<string>
Description
An array of ID's of ticket types of the event
Name
discountGroups
Type
array<object>
Description
An array of discount groups of the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the discount group of the event
Name
name
Type
string
Description
The name of the discount group of the event
Name
value
Type
number float
Description
The value of the discount group
Optional nested attributes (2)
Name
rules
Type
array<object>
Description
An array of rules of the discount group
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the discount group rule
Name
min
Type
number float
Description
Minimum amount of tickets where the discount is valid
Name
max
Type
number float
Description
Maximum amount of tickets where the discount is valid
Optional nested attributes (2)
Name
group
Type
string
Description
The ID of the discount group
Name
type
Type
enum(ticketGroups, cartSum)
Description
The type of the discount rule. ticketGroups is the type for tickets. cartSum is the type for sum of a cart
Name
discountType
Type
enum(TOTAL, PERCENTAGE, fix, var, fixPerItem, waiveFees)
Description
The type of the discount group. TOTAL = absolute discount. PERCENTAGE = percentage discount. fix = fixed discount. var = variable discount
Name
cartAutomationRules
Type
array<object>
Description
An array of automation rules for carts of the event
Required nested attributes (5)
Name
_id
Type
string
Description
The ID of the cart automation rule
Name
name
Type
string
Description
The name of the automation rule for carts of the event
Name
triggerType
Type
enum(hasBeenAdded)
Description
The trigger type of the automation rule.
Name
triggerTargetGroup
Type
string
Description
The trigger target group of the rule. The ID of a ticket group
Name
thenType
Type
enum(autoAdd, chooseFrom)
Description
The type of thenType of the rule. autoAdd = is the type to add automatically to cart. chooseFrom = is the type to choose from e.g. another ticket group
Optional nested attributes (1)
Name
thenTargets
Type
array<object>
Description
The target of the then type
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the then target
Optional nested attributes (3)
Name
thenTargetGroup
Type
string
Description
The ID of the ticket group 'then' refers to
Name
thenTargetMin
Type
number float
Description
Minimum amount of tickets where the then action is valid
Name
thenTargetMax
Type
number float
Description
Maximum amount of tickets where the then action is valid
Name
posDiscounts
Type
array<object>
Description
An array of POS discounts of the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the POS discount
Name
name
Type
string
Description
The name of the POS discount
Name
value
Type
number float
Description
The value of the POS discount
Optional nested attributes (1)
Name
discountType
Type
enum(TOTAL, PERCENTAGE, fix, var, fixPerItem, waiveFees)
Description
The type of the POS discount
Name
categories
Type
array<object>
Description
An array of ticket categories of the event
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the ticket category of the event
Name
name
Type
string
Description
The name of the ticket category of the event
Optional nested attributes (7)
Name
description
Type
string
Description
The description of the ticket category of the event
Name
seatingReference
Type
string
Description
The ID of the seating category
Name
ref
Type
string
Description
The reference to identify the seating category
Name
amount
Type
number float
Description
The amount of available tickets of the category of the event
Name
recommendedTicket
Type
string
Description
Recommended ticket of the category
Name
maxAmountPerOrder
Type
number float
Description
Maximum amount per order of the category
Name
listWithoutSeats
Type
boolean
Description
Whether this category can be sold without seats
Name
tickets
Type
array<object>
Description
An array of ticket types of the event
Required nested attributes (5)
Name
_id
Type
string
Description
The ID of the ticket type of the event
Name
name
Type
string
Description
The name of the ticket type of the event
Name
price
Type
number float
Description
The price of the ticket type of the event
Name
amount
Type
number float
Description
The amount of the ticket type of the event
Name
active
Type
boolean
Description
Whether the ticket type of the event is active
Optional nested attributes (35)
Name
description
Type
string
Description
The description of the ticket type of the event
Name
image
Type
string
Description
The image of the ticket type of the event
Name
color
Type
string
Description
The font color of the ticket type of the event
Name
posActive
Type
boolean
Description
Whether POS for the ticket type of the event is active
Name
categoryRef
Type
string
Description
The reference of the category of the ticket type of the event
Name
ignoredForStartingPrice
Type
boolean
Description
Whether the price of the ticket type should be ignored on starting price determination of the event
Name
conditionalAvailability
Type
boolean
Description
Whether rules can be operated on the ticket type
Name
ticketBackground
Type
string
Description
The background for the ticket PDF of the ticket type
Name
rules
Type
array<object>
Description
An array of rules for the ticket type of the event
Required nested attributes (4)
Name
_id
Type
string
Description
The ID of the ticket type rule
Name
ticketGroup
Type
string
Description
The ID of the ticket group to operate the rule on
Name
min
Type
number float
Description
Minimum amount of tickets where the rule is active
Name
max
Type
number float
Description
Maximum amount of tickets where the rule is active
Name
requiresPersonalization
Type
boolean
Status
deprecated
Description
Deprecated, use requiresPersonalizationMode instead
Name
requiresPersonalizationMode
Type
enum(ENABLED, DISABLED)
Description
Whether the ticket type of the event needs personalization
Name
requiresExtraFields
Type
boolean
Status
deprecated
Description
Deprecated, use requiresExtraFieldsMode instead
Name
requiresExtraFieldsMode
Type
enum(ENABLED, DISABLED)
Description
Whether the ticket type of the event needs extra fields
Name
repersonalizationAllowedMode
Type
enum(ENABLED, DISABLED)
Description
Whether re-personalization (name changes) is allowed for this ticket type. When unset, inherits the event-level repersonalizationAllowed. Enables flex-ticket-like re-personalization without an addon.
Name
repersonalizationFee
Type
number float
Description
The per-ticket fee for repersonalization.
Name
sortingKey
Type
number float
Description
The key to sort the ticket type within the ticket group
Name
enableHardTicketOption
Type
boolean
Description
Whether the ticket type is a hard ticket
Name
forceHardTicketOption
Type
boolean
Description
Whether to force the hard ticket option
Name
maxAmountPerOrder
Type
number float
Description
Maximum amount per order of the ticket type
Name
minAmountPerOrder
Type
number float
Description
Minimum amount per order of the ticket type
Name
minAmountPerOrderRule
Type
number float
Description
Minimum amount of the ticket type, where the minAmountPerOrder goes active
Name
taxRate
Type
number float
Description
The tax rate of the ticket type of the event
Name
styleOptions
Type
object
Description
Style options of the ticket type
Optional nested attributes (3)
Name
thumbnailImage
Type
string
Description
Thumbnail of the ticket type, which will be displayed on checkout
Name
showAvailable
Type
boolean
Description
Whether to show availability of the ticket type
Name
hiddenInSelectionArea
Type
boolean
Description
Whether to show this ticket in the selection area
Name
priceCategoryId
Type
string
Description
The ID of the price category of the ticket type
Name
entryPermissions
Type
array<string>
Description
An array of IDs of entry permissions where the ticket buyer has access to certain areas
Name
ignoreForMaxAmounts
Type
boolean
Description
Do not include tickets if this typw when calculating available amount in categories and event
Name
expirationSettings
Type
object
Description
Expiration settings of the ticket type.
Optional nested attributes (2)
Name
enabled
Type
boolean
Description
Whether expiration enabled for the event ticket types
Name
expiresAfter
Type
object
Description
If enabled = true. A relatve date specification until when ticket is valid.
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
barcodePrefix
Type
string
Description
Characters that precede the barcodes of tickets.
Name
salesStart
Type
object
Description
A relative date before the end of the event, when the sale of this ticket type starts
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
salesEnd
Type
object
Description
A relative date before the end of the event, when the sale of this ticket type ends
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
transferSettings
Type
object
Description
Transfer settings of the ticket type.
Optional nested attributes (6)
Name
mode
Type
enum(ALLOWED, DISABLED)
Description
Ticket transfer mode.
Name
expiresAfter
Type
object
Description
If 'mode = ALLOWED'. A relatve date specification until when ticket transfer is valid.
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
retransferMode
Type
enum(ALLOWED, DISABLED)
Description
Ticket retransfer mode.
Name
allowedUntil
Type
object
Description
If 'mode = ALLOWED'. A relatve date specification until the end of the event where ticket transfer is possible.
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
hardTicketsMode
Type
enum(ALLOWED, DISABLED)
Description
If 'hardTicketsMode = ALLOWED' then hard tickets transfers allowed.
Name
seasonTicketMode
Type
enum(NO_RESTRICTION, CHILDREN_ONLY, GROUP_ONLY)
Description
Restrict how season tickets can be transferred.
Name
scanSettings
Type
object
Description
Scan settings of the ticket type.
Optional nested attributes (2)
Name
feedback
Type
enum(highlight)
Description
Feedback mode during scanning of the ticket
Name
allowedScanCount
Type
number float
Description
Number of times a ticket is allowed to be scanned as valid
Name
deliverySettings
Type
object
Description
Delivery settings of the ticket type.
Optional nested attributes (2)
Name
wallet
Type
object
Description
Optional nested attributes (1)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
pdf
Type
object
Description
Optional nested attributes (1)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
meta
Type
object
Description
Custom key-value data. Metadata is useful for storing additional, structured information on an object.
Name
revealingSettings
Type
object
Description
Barcode reveal settings of the ticket type.
Optional nested attributes (2)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
beforeEvent
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
createdAt
Type
string date-time
Description
An ISO timestamp indicating when the event was created
Name
updatedAt
Type
string date-time
Description
An ISO timestamp indicating when the event was updated
Name
sellStart
Type
string date-time
Description
An ISO timestamp indicating when the event sale starts
Name
sellEnd
Type
string date-time
Description
An ISO timestamp indicating when the event sale ends
Name
maxAmountPerCustomer
Type
number float
Description
Maximum amount of tickets per customer of the event
Name
maxTransactionsPerCustomer
Type
number float
Description
Maximum amount of transactions per customer of the event
Name
minAmountPerOrder
Type
number float
Description
Minimum amount of tickets per order
Name
customerTags
Type
array<string>
Description
An array of customer tags of the event
Name
customerSegments
Type
array<string>
Description
An array of customer segments of the event
Name
showCountdown
Type
boolean
Description
Whether the countdown should be visible till event start
Name
hideInListing
Type
boolean
Description
Whether the event should be hide in listings
Name
visibleAfter
Type
string date-time
Description
An ISO timestamp indicating when the event is visible in listings.
Name
customSettings
Type
object
Description
Custom settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the custom settings of the event
Optional nested attributes (22)
Name
hideTicketsInTransactionPage
Type
boolean
Description
Whether the ticket types of the event should be visible on transaction page
Name
dontSendTicketMail
Type
boolean
Description
Whether an email should be sent of tickets of the event
Name
dontSendBookingConfirmationMail
Type
boolean
Description
Whether an email should be sent for booking confirmation
Name
customMailHeaderImage
Type
string
Description
A custom header image of the mail for ticket types of the event
Name
customTransactionCompletionText
Type
string
Description
A custom transaction completion text for completed transactions of the event
Name
disableAppleWallet
Type
boolean
Status
deprecated
Description
Whether the Apple and Google Wallet functionality should be disabled on the event. Deprecated: use event.deliverySettings.wallet instead
Name
disablePdfTickets
Type
boolean
Status
deprecated
Description
Whether the PDF tickets download functionality should be disabled on the event. Deprecated: use event.deliverySettings.pdf instead
Name
showStartDate
Type
boolean
Description
Whether the start date of the event should be visible on listings
Name
showStartTime
Type
boolean
Description
Whether the start time of the event should be visible on listings
Name
showEndDate
Type
boolean
Description
Whether the end date of the event should be visible on listings
Name
showEndTime
Type
boolean
Description
Whether the end time of the event should be visible on listings
Name
showTimeRangeInListing
Type
boolean
Status
deprecated
Description
Whether the end time of the event should be visible on listings
Name
showTimeRangeInTicket
Type
boolean
Description
Whether the time range of the event should be visible on ticket PDFs
Name
customCheckoutCSS
Type
string
Description
Custom CSS styling of the checkout of the event
Name
useCustomCheckoutBrand
Type
boolean
Description
Whether the checkout of the event should use custom brand
Name
customCheckoutBrand
Type
string
Description
A custom checkout brand of the event
Name
hideLogoInCheckout
Type
boolean
Description
Whether the logo should be hide on the checkout of the event
Name
customEventPageHTML
Type
string
Description
A custom HTML of the event page
Name
customEventPageCSS
Type
string
Description
A custom css styling of the event page
Name
customConfirmationPage
Type
string
Description
A custom css styling of the event page
Name
hideSeatmapInCheckout
Type
boolean
Description
Hides the seatmap from the ticket buyer even if seating ticket types are available
Name
dontSendBookingConfirmationSMS
Type
boolean
Description
Whether a sms should be sent for booking confirmation
Name
extraFields
Type
array<object>
Description
An array of extra fields of the event
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the extra field
Name
required
Type
boolean
Description
Whether the extra field is required
Optional nested attributes (11)
Name
name
Type
string
Description
The name of the extra field
Name
description
Type
string
Description
The description of the extra field
Name
collectInCheckout
Type
boolean
Description
Whether the extra field is collected in checkout
Name
deleted
Type
boolean
Description
Whether the extra field is deleted
Name
type
Type
enum(text, number, select, checkbox, tel, country, email, date, documentUpload, signature, address)
Description
The type of the extra field. text = is a text field. number = is a number field. select = is a selection field of different selections. checkbox = is a checkbox field. tel = is a number field for a phone number. email = is a text field for an email. country = is a text field field for country.
Name
options
Type
array<string>
Description
An array of options of the extra field
Name
onlyForCertainTicketTypes
Type
boolean
Description
Whether the extra field is only for certain ticket types
Name
allowedTicketTypes
Type
array<string>
Description
An array of IDs of the ticket types allowed for the extra field
Name
printable
Type
boolean
Description
Whether the extra field is printable
Name
conditions
Type
array<object>
Description
An array of conditions of the extra field. The conditions can refer to other extra fields.
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the condition
Name
baseSlug
Type
string
Description
The slug of the base extra field which the condition refers to
Name
operator
Type
enum(equals, notEquals, greaterThan, lessThan, greaterThanOrEquals, lessThanOrEquals, exists, notExists)
Description
The operator which will be used to check the condition
Optional nested attributes (1)
Name
value
Type
array | boolean | number | object | string
Description
The value which the operator will be used on to check the condition.
Name
settings
Type
oneOf
Description
Type-specific settings for the extra field
One of — Only one of the following types
Optional attributes
Name
allowedMimeTypes
Type
array<enum(application/pdf, image/jpeg, image/png)>
Description
Name
ticketExtraFields
Type
array<object>
Description
An array of extra fields for ticket types of the event
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the extra field
Name
required
Type
boolean
Description
Whether the extra field is required
Optional nested attributes (11)
Name
name
Type
string
Description
The name of the extra field
Name
description
Type
string
Description
The description of the extra field
Name
collectInCheckout
Type
boolean
Description
Whether the extra field is collected in checkout
Name
deleted
Type
boolean
Description
Whether the extra field is deleted
Name
type
Type
enum(text, number, select, checkbox, tel, country, email, date, documentUpload, signature, address)
Description
The type of the extra field. text = is a text field. number = is a number field. select = is a selection field of different selections. checkbox = is a checkbox field. tel = is a number field for a phone number. email = is a text field for an email. country = is a text field field for country.
Name
options
Type
array<string>
Description
An array of options of the extra field
Name
onlyForCertainTicketTypes
Type
boolean
Description
Whether the extra field is only for certain ticket types
Name
allowedTicketTypes
Type
array<string>
Description
An array of IDs of the ticket types allowed for the extra field
Name
printable
Type
boolean
Description
Whether the extra field is printable
Name
conditions
Type
array<object>
Description
An array of conditions of the extra field. The conditions can refer to other extra fields.
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the condition
Name
baseSlug
Type
string
Description
The slug of the base extra field which the condition refers to
Name
operator
Type
enum(equals, notEquals, greaterThan, lessThan, greaterThanOrEquals, lessThanOrEquals, exists, notExists)
Description
The operator which will be used to check the condition
Optional nested attributes (1)
Name
value
Type
array | boolean | number | object | string
Description
The value which the operator will be used on to check the condition.
Name
settings
Type
oneOf
Description
Type-specific settings for the extra field
One of — Only one of the following types
Optional attributes
Name
allowedMimeTypes
Type
array<enum(application/pdf, image/jpeg, image/png)>
Description
Name
accentColor
Type
string
Description
The accent color of the event page
Name
pageStyle
Type
string
Description
The page style of the event page
Name
showOtherEvents
Type
boolean
Description
Whether other events should be displayed on the event page
Name
underShops
Type
array<object>
Description
An array of under shops of the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the under shop of the event
Name
name
Type
string
Description
The name of the under shop of the event
Name
active
Type
boolean
Description
Whether the under shop is active
Optional nested attributes (25)
Name
tickets
Type
array<object>
Description
An array of ticket types of the under shop
Required nested attributes (6)
Name
_id
Type
string
Description
The ID of ticket type extension of the event under shop
Name
baseTicket
Type
string
Description
The ID of a ticket type of the event used as base ticket type
Name
name
Type
string
Description
The name of the ticket type
Name
price
Type
number float
Description
The price of the ticket type
Name
amount
Type
number float
Description
The amount of the ticket type
Name
active
Type
boolean
Description
Whether the ticket type is active
Optional nested attributes (1)
Name
description
Type
string
Description
The description of the ticket type
Name
categories
Type
array<object>
Description
The array of ticket categories of the under shop
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of ticket category extension
Name
baseCategoryId
Type
string
Description
The ID of a ticket category of the event used as base ticket category
Optional nested attributes (2)
Name
amount
Type
number float
Description
The amount of the ticket category
Name
maxAmountPerOrder
Type
number float
Description
The maximum amount per order of the ticket category
Name
timeSlots
Type
array<object>
Description
The array of time slots of the under shop
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of time slot extension
Name
baseTimeSlotId
Type
string
Description
The ID of a time slot of the event used as base time slot
Name
amount
Type
number float
Description
The amount of the time slot
Optional nested attributes (1)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Whether the time slot enabled for under shop.
Name
sellStart
Type
string date-time
Description
The sell start of the under shop. Optional for ROOT events only
Name
sellEnd
Type
string date-time
Description
The sell end of the under shop. Optional for ROOT events only
Name
maxAmount
Type
number float
Description
The maximum amount of tickets of the under shop
Name
maxAmountPerOrder
Type
number float
Description
The maximum amount per order of the under shop
Name
minAmountPerOrder
Type
number float
Description
The minimum amount per order of the under shop
Name
maxTransactionsPerCustomer
Type
number float
Description
The maximum amount of transactions per customer of the under shop
Name
maxAmountPerCustomer
Type
number float
Description
Maximum amount of tickets per customer of the event
Name
ticketShopHeaderText
Type
string
Description
The header of the ticket shop of the under shop
Name
customCharges
Type
object
Description
Custom charges of the under shop
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the custom charge
Optional nested attributes (7)
Name
outerChargeVar
Type
number float
Description
The variable outer charge of the custom charge
Name
innerChargeVar
Type
number float
Description
The variable inner charge of the custom charge
Name
outerChargeFix
Type
number float
Description
The fix outer charge of the custom charge
Name
innerChargeFix
Type
number float
Description
The fix inner charge of the custom charge
Name
posOuterChargeFix
Type
number float
Description
The fix POS outer charge of the custom charge
Name
posOuterChargeVar
Type
number float
Description
The variable POS outer charge of the custom charge
Name
cartOuterChargeFix
Type
number float
Description
The fix cart outer charge of the custom charge
Name
seatingContingents
Type
array<string>
Description
An array of seating contingents of the under shop
Name
availabilityMode
Type
enum(default, contingentsOnly)
Description
The availability mode of the shop
Name
bestAvailableSeatingConfiguration
Type
object
Description
The best available seating options of the under shop
Optional nested attributes (3)
Name
enabled
Type
boolean
Description
Whether the best available seating is enabled
Name
enforced
Type
boolean
Description
Whether the best available seating is the only option to buy seated tickets. Seatmap won't be shown during checkout
Name
allowMassBooking
Type
boolean
Description
Whether the best available seating allows to buy seated tickets in bulk.
Name
reservationSettings
Type
object
Description
The reservation settings of the under shop
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the reservation setting
Optional nested attributes (2)
Name
option
Type
enum(noReservations, reservationsOnly, reservationsAndPayment, internalReservationsAndPayment)
Description
The option of the reservation setting. reservationsOnly = needs reservation only. noReservations = no reservations needed. reservationsAndPayment = needs reservation and payment
Name
strategyId
Type
string
Description
The ID of the strategy of a purchase intents to be used on the event
Name
accountSettings
Type
object
Description
Account settings of the under shop
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the account settings of the event
Optional nested attributes (2)
Name
enforceAccounts
Type
boolean
Status
deprecated
Description
Whether to enforce accounts for the event
Name
enforceAuthentication
Type
enum(DISABLED, PREVENT_CHECKOUT, PREVENT_DETAILS_STEP)
Description
Whether to enforce authentication for the event and how to enforce it
Name
customerTags
Type
array<string>
Description
An array of customer tags of the under shop
Name
customerSegments
Type
array<string>
Description
An array of customer segments of the under shop
Name
allowMassDownload
Type
boolean
Description
Enables option to download bulk tickets as a CSV or PDF file.
Name
inventoryStrategy
Type
enum(independent, subsidiary, global)
Description
Sets how available tickets will be calculated
Name
extraFields
Type
array<object>
Description
An array of extra fields of the under shop
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the extra field
Name
required
Type
boolean
Description
Whether the extra field is required
Optional nested attributes (11)
Name
name
Type
string
Description
The name of the extra field
Name
description
Type
string
Description
The description of the extra field
Name
collectInCheckout
Type
boolean
Description
Whether the extra field is collected in checkout
Name
deleted
Type
boolean
Description
Whether the extra field is deleted
Name
type
Type
enum(text, number, select, checkbox, tel, country, email, date, documentUpload, signature, address)
Description
The type of the extra field. text = is a text field. number = is a number field. select = is a selection field of different selections. checkbox = is a checkbox field. tel = is a number field for a phone number. email = is a text field for an email. country = is a text field field for country.
Name
options
Type
array<string>
Description
An array of options of the extra field
Name
onlyForCertainTicketTypes
Type
boolean
Description
Whether the extra field is only for certain ticket types
Name
allowedTicketTypes
Type
array<string>
Description
An array of IDs of the ticket types allowed for the extra field
Name
printable
Type
boolean
Description
Whether the extra field is printable
Name
conditions
Type
array<object>
Description
An array of conditions of the extra field. The conditions can refer to other extra fields.
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the condition
Name
baseSlug
Type
string
Description
The slug of the base extra field which the condition refers to
Name
operator
Type
enum(equals, notEquals, greaterThan, lessThan, greaterThanOrEquals, lessThanOrEquals, exists, notExists)
Description
The operator which will be used to check the condition
Optional nested attributes (1)
Name
value
Type
array | boolean | number | object | string
Description
The value which the operator will be used on to check the condition.
Name
settings
Type
oneOf
Description
Type-specific settings for the extra field
One of — Only one of the following types
Optional attributes
Name
allowedMimeTypes
Type
array<enum(application/pdf, image/jpeg, image/png)>
Description
Name
salesChannelGroupSettings
Type
array<object>
Description
An array of sales channel group settings associated with the under shop
Required nested attributes (1)
Name
salesChannelGroupId
Type
string
Description
The ID of the associated sales channel group
Optional nested attributes (1)
Name
enabled
Type
boolean
Description
Whether the sales channel group is enabled
Name
paymentSettings
Type
object
Description
The payment settings of the event
Optional nested attributes (1)
Name
paymentStrategyId
Type
string
Description
The ID of the associated payment strategy
Name
unlockMode
Type
enum(none, couponCode)
Description
Sets how event is locked, e.g. by coupon code.
Name
seating
Type
object
Description
The seating of the event
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the seating
Name
active
Type
boolean
Description
Whether the seating is active
Optional nested attributes (8)
Name
eventKey
Type
string
Description
The key of the event of the seating
Name
eventId
Type
string
Description
The ID of the event of the seating
Name
seatMapId
Type
string
Description
The ID of the seat map of the event
Name
revisionId
Type
string
Description
The ID of the revision of the event
Name
orphanConfiguration
Type
object
Description
The orphan configuration of the seating
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the seating orphan configuration
Optional nested attributes (2)
Name
minSeatDistance
Type
number float
Description
Minimum distance of seats to each other
Name
edgeSeatsOrphaning
Type
boolean
Description
Whether the edge seats can orphaning
Name
contingents
Type
array<string>
Description
An array of seating contingent ids
Name
availabilityMode
Type
enum(default, contingentsOnly)
Description
The seating availability mode
Name
bestAvailableSeatingConfiguration
Type
object
Description
The best available seating configuration of the seating
Optional nested attributes (2)
Name
enabled
Type
boolean
Description
Whether the best available seating is enabled
Name
enforced
Type
boolean
Description
Whether the best available seating is the only option to buy seated tickets. Seatmap won't be shown during checkout
Name
customTextConfig
Type
object
Description
The custom text configuration of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the custom text configuration
Optional nested attributes (1)
Name
buyTicketsCTA
Type
string
Description
The custom CTA after buy tickets
Name
eventType
Type
enum(SINGLE, GROUP, RECURRENCE, ROOT)
Description
The type of the event. SINGLE = it is a single event. GROUP = the event is part of a group of events
Name
childEvents
Type
array<string>
Description
An array of IDs of child events
Name
url
Type
string
Description
The url of the event
Name
tags
Type
array<string>
Description
An array of tags of the event
Name
seoSettings
Type
object
Description
The search engine optimization settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the SEO setting
Optional nested attributes (4)
Name
tags
Type
array<string>
Description
An array of tags of the seo settings
Name
noIndex
Type
boolean
Description
Whether the seo setting has no indexing
Name
title
Type
string
Description
The title of the seo settings
Name
description
Type
string
Description
The description of the seo settings
Name
extraInformation
Type
object
Description
The extra information of the event
Optional nested attributes (4)
Name
_id
Type
string
Description
The ID of the extra information of the event
Name
type
Type
string
Description
The type of the extra information of the event
Name
category
Type
string
Description
The category of the extra information of the event
Name
subCategory
Type
string
Description
The subCategory of the extra information of the event
Name
customCharges
Type
object
Description
Custom charges of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the custom charge
Optional nested attributes (7)
Name
outerChargeVar
Type
number float
Description
The variable outer charge of the custom charge
Name
innerChargeVar
Type
number float
Description
The variable inner charge of the custom charge
Name
outerChargeFix
Type
number float
Description
The fix outer charge of the custom charge
Name
innerChargeFix
Type
number float
Description
The fix inner charge of the custom charge
Name
posOuterChargeFix
Type
number float
Description
The fix POS outer charge of the custom charge
Name
posOuterChargeVar
Type
number float
Description
The variable POS outer charge of the custom charge
Name
cartOuterChargeFix
Type
number float
Description
The fix cart outer charge of the custom charge
Name
gallery
Type
array<object>
Description
An array of gallery items of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the gallery item
Optional nested attributes (5)
Name
title
Type
string
Description
The title of the gallery item
Name
description
Type
string
Description
The description of the gallery item
Name
copyright
Type
string
Description
The copyright of the gallery item
Name
index
Type
number float
Description
The index of the gallery item
Name
image
Type
string
Description
The image of the gallery item
Name
video
Type
object
Description
The video settings of the event
Optional nested attributes (1)
Name
youtubeID
Type
string
Description
The youtube video ID of the event video setting
Name
soldOutFallback
Type
object
Description
The sold out fallback of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of sold out entry
Optional nested attributes (2)
Name
soldOutFallbackType
Type
enum(default, moreinformation, waitinglist)
Description
Name
soldOutFallbackLink
Type
string
Description
The link of the sold out fallback
Name
ticketDesign
Type
object
Description
The ticket design settings for ticket types of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the ticket types design of the event
Optional nested attributes (8)
Name
useCustomDesign
Type
boolean
Description
Whether to use custom design on ticket types of event
Name
customDesignURL
Type
string
Description
The custom design URL for ticket types of event
Name
footerDesignURL
Type
string
Description
The footer design URL for ticket types of the event
Name
disclaimer
Type
string
Description
The disclaimer for ticket types of the event
Name
infoColor
Type
string
Description
The info color for ticket types of the event
Name
showTimeRange
Type
boolean
Description
Whether to show time range on ticket types of the event
Name
hideDates
Type
boolean
Description
Whether to hide dates on ticket types of the event
Name
hideTimes
Type
boolean
Description
Whether to hide the time on ticket types of the event
Name
checkinInformation
Type
object
Description
The checkin information of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the checkin information of the event
Optional nested attributes (1)
Name
checkinStarts
Type
string date-time
Description
The date of when the checkin of the event starts
Name
tracking
Type
object
Description
The tracking of the event
Optional nested attributes (2)
Name
facebookPixel
Type
object
Description
The facebook pixel information of the event tracking
Optional nested attributes (2)
Name
active
Type
boolean
Description
Whether facebook pixel of event tracking is active
Name
pixelId
Type
string
Description
The ID of facebook pixel of the event tracking
Name
tagging
Type
object
Description
The tagging of the event tracking
Optional nested attributes (2)
Name
enabled
Type
boolean
Description
Whether tagging of event tracking is enabled
Name
tags
Type
array<string>
Description
An array of tags of the event tracking
Name
hardTicketSettings
Type
object
Description
The hard ticket settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the event hard ticket settings
Optional nested attributes (9)
Name
enabled
Type
boolean
Description
Whether hard tickets can be bought for this event
Name
fulfillmentType
Type
enum(self, managed)
Description
The type of fulfillment. self fulfilled by the seller. managed fulfilled by vivenu.
Name
printingMethod
Type
enum(preprinted, adhoc)
Description
Which printing method is used. preprinted = The tickets are preprinted. adhoc = The tickets are printed ad-hoc.
Name
hardTicketOuterCharge
Type
number float
Description
Additional charge for every hard ticket that is added to the ticket price and the other outer charges - paid by the ticket buyer.
Name
hardTicketInnerCharge
Type
number float
Description
Additional charge for hard tickets as in the contract of the seller
Name
hardTicketPreviewURL
Type
string
Description
The hard ticket design image
Name
promotionName
Type
string
Description
A special name for hard tickets. e.g. "Collector edition"
Name
promotionText
Type
string
Description
A description about what makes this ticket so special
Name
requiredDays
Type
integer
Description
Required days until deliver of the hard tickets
Name
dataRequestSettings
Type
object
Description
The data request settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the data request settings of the event
Optional nested attributes (12)
Name
requiresPersonalization
Type
boolean
Description
Whether the tickets for this event need personalization
Name
requiresExtraFields
Type
boolean
Description
Whether the tickets for this event need extra data fields
Name
repersonalization
Type
boolean
Status
deprecated
Description
Whether the tickets can be re personalized.
Name
repersonalizationAllowed
Type
boolean
Description
Whether the tickets can be re personalized.
Name
repersonalizationEndDate
Type
string date-time
Status
deprecated
Description
If repersonalization = true. Until when the re personalization is allowed.
Name
repersonalizationDeadline
Type
object
Description
If repersonalization = true. A relatve date specification until when the re personalization is allowed.
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
repersonalizationFee
Type
number float
Description
If repersonalization = true. The per-ticket fee for repersonalization.
Name
repersonalizationsLimit
Type
number float
Description
If repersonalization = true. The number of times repersonalization is allowed.
Name
limitOnlyNameChanges
Type
boolean
Description
If enabled, only name changes count towards the re-personalization limit for every ticket type of the event. Extra fields can always be updated until the re-personalization deadline.
Name
posPersonalization
Type
enum(noPersonalization, optionalPersonalization, requiredPersonalization)
Description
The type of personalization for this event on Point of Sale applications.
Name
skipAddressInfo
Type
boolean
Description
Whether the checkout should not ask for the address of the ticket buyer.
Name
enforceCompany
Type
boolean
Description
Whether the company of the ticket buyer is a required field.
Name
styleOptions
Type
object
Description
Style options of the event page
Optional nested attributes (10)
Name
headerStyle
Type
string
Description
Header style of the event page
Name
brandOne
Type
string
Description
First brand of the event
Name
brandTwo
Type
string
Description
Second brand of the event
Name
hideLocationMap
Type
boolean
Description
Whether the location map on the event page hide
Name
hideLocationAddress
Type
boolean
Description
Whether the location address on the event page hide
Name
categoryAlignment
Type
enum(cascade, asTabs, boxes, ticketWizard, 0, 1, 2, 3) float
Description
The style of category alignment. 0 = cascade = categories among themselves. 1 = asTabs = categories as tabs. 2 = boxes = categories as boxes. 3 = ticket wizard = categories as ticket wizard if configured.
Name
showAvailabilityIndicator
Type
boolean
Description
Whether the availability indicator on the event page should be shown
Name
availabilityIndicatorThresholds
Type
array<number>
Description
The availability indicator thresholds of the event
Name
showAvailable
Type
boolean
Description
Whether to show availability of the time slot. Only applicable for time slot events.
Name
timeSlotsCheckoutSelection
Type
enum(beforeTickets, afterTickets)
Description
Time slots selection in checkout.
Name
geoCode
Type
object
Description
The geographic code of the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the geo code
Name
lat
Type
number float
Description
Latitude coordinate of the geo code
Name
lng
Type
number float
Description
Longitude coordinate of the geo code
Name
accountSettings
Type
object
Description
Account settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the account settings of the event
Optional nested attributes (2)
Name
enforceAccounts
Type
boolean
Status
deprecated
Description
Whether to enforce accounts for the event
Name
enforceAuthentication
Type
enum(DISABLED, PREVENT_CHECKOUT, PREVENT_DETAILS_STEP)
Description
Whether to enforce authentication for the event and how to enforce it
Name
reservationSettings
Type
object
Description
The reservation settings of event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the reservation setting
Optional nested attributes (2)
Name
option
Type
enum(noReservations, reservationsOnly, reservationsAndPayment, internalReservationsAndPayment)
Description
The option of the reservation setting. reservationsOnly = needs reservation only. noReservations = no reservations needed. reservationsAndPayment = needs reservation and payment
Name
strategyId
Type
string
Description
The ID of the strategy of a purchase intents to be used on the event
Name
upsellSettings
Type
object
Description
The upsell settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the upsell settings of the event
Optional nested attributes (4)
Name
active
Type
boolean
Description
Whether upselling is active on the event
Name
productStream
Type
string
Description
The product stream for upselling
Name
headerImage
Type
string
Description
A header image for the ticket shop, when selecting products
Name
crossSells
Type
object
Description
The cross selling settings.
Optional nested attributes (1)
Name
eventIds
Type
array<string>
Description
The array of the promoted event IDs.
Name
repetitionSettings
Type
array<object>
Description
The repetition settings of the event
Required nested attributes (4)
Name
every
Type
number float
Description
Repeat event every unit of time
Name
unit
Type
enum(DAY, WEEK, MONTH)
Description
Unit of repetition - day, week, month
Name
from
Type
string date-time
Description
Repeat event from date
Name
to
Type
string date-time
Description
Repeat event till date
Optional nested attributes (1)
Name
repeatsOn
Type
array<enum(SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY)>
Description
Days of a week when the event is repeated
Name
rootId
Type
string
Description
The id of the root event
Name
daySchemes
Type
array<DaySchemeResource>
Description
The possible day schemas of how event could be sold
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the day scheme.
Name
name
Type
string
Description
The name of the day scheme.
Name
color
Type
string
Description
The color of the day scheme.
Optional nested attributes (1)
Name
offers
Type
object
Description
Offers of the day scheme.
Optional nested attributes (3)
Name
allTicketTypesActive
Type
boolean
Description
Whether the all ticket types active.
Name
ticketTypes
Type
array<object>
Description
The day scheme offer ticket types.
Required nested attributes (1)
Name
ticketTypeId
Type
string
Description
The ticket type id which could be sold.
Optional nested attributes (1)
Name
active
Type
boolean
Description
Whether the ticket type is selling.
Name
timeSlots
Type
array<object>
Description
Time slots overrides.
Required nested attributes (1)
Name
slotId
Type
string
Description
The slotId of the time slot.
Optional nested attributes (2)
Name
enabled
Type
string
Description
Whether the slot is enabled.
Name
amount
Type
number float
Description
The amount of available tickets of the time slot of the day scheme.
Name
daySchemeId
Type
string
Description
The ID of the day scheme assigned to the event.
Name
ticketSettings
Type
object
Description
The event ticket settings
Optional nested attributes (9)
Name
codeDisplay
Type
enum(BARCODE, QRCODE, HIDE)
Description
How the ticket code is displayed. Null inherits the seller setting.
Name
cancellationStrategy
Type
enum(disabled, freeTicketsOnly, withoutRefund)
Description
Cancellation strategy of the ticket types
Name
revealingSettings
Type
object
Description
Barcode reveal settings of the event.
Optional nested attributes (2)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
beforeEvent
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
transferSettings
Type
object
Description
Transfer settings of the ticket types
Optional nested attributes (7)
Name
mode
Type
enum(ALLOWED, DISABLED)
Description
Ticket transfer mode.
Name
expiresAfter
Type
object
Description
If 'mode = ALLOWED'. A relatve date specification until when ticket transfer is valid.
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
retransferMode
Type
enum(ALLOWED, DISABLED)
Description
Ticket retransfer mode.
Name
allowedUntil
Type
object
Description
If 'mode = ALLOWED'. A relatve date specification until the end of the event where ticket transfer is possible.
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
hardTicketsMode
Type
enum(ALLOWED, DISABLED)
Description
If 'hardTicketsMode = ALLOWED' then hard tickets transfers allowed.
Name
seasonTicketMode
Type
enum(NO_RESTRICTION, CHILDREN_ONLY, GROUP_ONLY)
Description
Restrict how season tickets can be transferred.
Name
useSeasonCardTemplate
Type
boolean
Description
Whether to use the season card template for individual tickets transferred from the season.
Name
upgradeSettings
Type
object
Description
Upgrade settings of the ticket types
Optional nested attributes (2)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Whether ticket upgrade settings enabled.
Name
underShopMapping
Type
array<object>
Description
Mapping to define the under shop in which a ticket upgrade will be performed.
Required nested attributes (3)
Name
type
Type
enum(tag)
Description
Name
tag
Type
string
Description
The customer tag
Name
underShopId
Type
string
Description
The ID of the under shop.
Name
resellSettings
Type
object
Description
Resell settings
Optional nested attributes (10)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Whether resell is enabled
Name
resellerFeeFix
Type
number float
Description
The fixed fee per ticket that the reseller pays
Name
resellerFeeVar
Type
number float
Description
The variable fee per ticket that the reseller pays
Name
buyerFeeFix
Type
number float
Description
The fixed fee per ticket that the buyer pays
Name
buyerFeeVar
Type
number float
Description
The variable fee per ticket that the buyer pays
Name
offerCreationStart
Type
object
Description
A relative date specification of offers creation start.
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
offerCreationEnd
Type
object
Description
A relative date specification of offers creation end.
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
salesStart
Type
object
Description
A relative date specification of sales start.
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
priceMarkup
Type
number float
Description
The markup applied to the price of each ticket bought on the secondary market.
Name
cartAutomationMode
Type
enum(BLOCKED, INDIVIDUAL)
Description
Controls whether tickets involved in cart automations can be resold.
Name
barcodeSettings
Type
object
Description
Barcode settings
Optional nested attributes (1)
Name
issueOfflineBarcodes
Type
enum(ENABLED, DISABLED)
Description
Whether offline barcodes are enabled
Name
childEventMapping
Type
array<object>
Description
Child event mapping
Required nested attributes (2)
Name
childEventId
Type
string
Description
The child event for this mapping
Name
ticketTypeMapping
Type
object
Description
Mapping between ticket types of the parent event and the child events
Optional nested attributes (1)
Name
valueShare
Type
number float
Description
The percentage value of this child event from the value of the parent event
Name
seasonCardValueStrategy
Type
enum(childValue, averagePerChild, sharePerChild)
Description
The strategy used to determine the value of a child event in the context of the parent event
Name
accessListMapping
Type
array<object>
Description
The array represents a mapping between access list ids and ticket type ids for which a ticket will be created.
Required nested attributes (2)
Name
listId
Type
string
Description
The ID of the access list.
Name
ticketTypeId
Type
string
Description
The ID of the ticket type.
Name
deliverySettings
Type
object
Description
Delivery Settings
Optional nested attributes (2)
Name
wallet
Type
object
Description
Optional nested attributes (3)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
nfc
Type
enum(ENABLED, DISABLED)
Description
Name
seasonCardShowNextEvent
Type
boolean
Description
Whether to display the information for next event of the season event on a wallet ticket or not. If activated, the information of the next event will be displayed on the wallet ticket instead of the season event.
Name
pdf
Type
object
Description
Optional nested attributes (1)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
meta
Type
object
Description
Custom key-value data. Metadata is useful for storing additional, structured information on an object.
Name
timezone
Type
string
Description
Timezone of event
Name
salesChannelGroupSettings
Type
array<object>
Description
An array of sales channel group settings associated with the event
Required nested attributes (1)
Name
salesChannelGroupId
Type
string
Description
The ID of the associated sales channel group
Optional nested attributes (1)
Name
enabled
Type
boolean
Description
Whether the sales channel group is enabled
Name
paymentSettings
Type
object
Description
The payment settings of the event
Optional nested attributes (1)
Name
paymentStrategyId
Type
string
Description
The ID of the associated payment strategy
Name
timeSlots
Type
array<object>
Description
The time slots for the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the time slot
Name
startTime
Type
object
Description
The time of day the time slot starts
Required nested attributes (2)
Name
hour
Type
integer
Description
Name
minute
Type
integer
Description
Name
refs
Type
array<object>
Description
The ticket references for the time slot
Required nested attributes (2)
Name
refType
Type
enum(category)
Description
The type of the reference
Name
categoryRef
Type
string
Description
The ticket category reference to use for the time slot
Optional nested attributes (1)
Name
amount
Type
number float
Description
The amount of available tickets of the time slot of the event
Name
useTimeSlots
Type
boolean
Description
Whether the event uses time slots.
Name
attributes
Type
object
Description

Example

{
  "event": {
    "_id": "507f191e810c19729de860ea",
    "name": "Some fancy Name",
    "start": "2030-01-23T23:00:00.123Z",
    "end": "2030-01-23T23:00:00.123Z",
    "maxAmount": 10.5,
    "maxAmountPerOrder": 10.5,
    "sellerId": "507f191e810c19729de860ea",
    "slogan": "string",
    "description": "string",
    "locationName": "Some fancy Name",
    "locationStreet": "Speditionsstr",
    "locationCity": "Düsseldorf",
    "locationPostal": "40221",
    "locationCountry": "string",
    "image": "https://your-url/image.png",
    "ticketFooter": "string",
    "ticketBackground": "string",
    "ticketShopHeader": "string",
    "groups": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "tickets": [
          "string"
        ]
      }
    ],
    "discountGroups": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "value": 10.5,
        "rules": [
          {
            "_id": "507f191e810c19729de860ea",
            "min": 10.5,
            "max": 10.5,
            "group": "string",
            "type": "ticketGroups"
          }
        ],
        "discountType": "fix"
      }
    ],
    "cartAutomationRules": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "triggerType": "hasBeenAdded",
        "triggerTargetGroup": "string",
        "thenType": "autoAdd",
        "thenTargets": [
          {
            "_id": "507f191e810c19729de860ea",
            "thenTargetGroup": "string",
            "thenTargetMin": 10.5,
            "thenTargetMax": 10.5
          }
        ]
      }
    ],
    "posDiscounts": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "value": 10.5,
        "discountType": "fix"
      }
    ],
    "categories": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "description": "string",
        "seatingReference": "string",
        "ref": "string",
        "amount": 10.5,
        "recommendedTicket": "string",
        "maxAmountPerOrder": 10.5,
        "listWithoutSeats": true
      }
    ],
    "tickets": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "price": 10.5,
        "amount": 10.5,
        "active": true,
        "description": "string",
        "image": "https://your-url/image.png",
        "color": "string",
        "posActive": true,
        "categoryRef": "string",
        "ignoredForStartingPrice": true,
        "conditionalAvailability": true,
        "ticketBackground": "string",
        "rules": [
          {
            "_id": "507f191e810c19729de860ea",
            "ticketGroup": "string",
            "min": 10.5,
            "max": 10.5
          }
        ],
        "requiresPersonalization": true,
        "requiresPersonalizationMode": "ENABLED",
        "requiresExtraFields": true,
        "requiresExtraFieldsMode": "ENABLED",
        "repersonalizationAllowedMode": "ENABLED",
        "repersonalizationFee": 10.5,
        "sortingKey": 10.5,
        "enableHardTicketOption": true,
        "forceHardTicketOption": true,
        "maxAmountPerOrder": 10.5,
        "minAmountPerOrder": 10.5,
        "minAmountPerOrderRule": 10.5,
        "taxRate": 10.5,
        "styleOptions": {
          "thumbnailImage": "string",
          "showAvailable": true,
          "hiddenInSelectionArea": true
        },
        "priceCategoryId": "507f191e810c19729de860ea",
        "entryPermissions": [
          "string"
        ],
        "ignoreForMaxAmounts": true,
        "expirationSettings": {
          "enabled": true,
          "expiresAfter": {
            "unit": "hours",
            "offset": 1,
            "target": "string"
          }
        },
        "barcodePrefix": "string",
        "salesStart": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "salesEnd": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "transferSettings": {
          "mode": "ALLOWED",
          "expiresAfter": {
            "unit": "hours",
            "offset": 1,
            "target": "string"
          },
          "retransferMode": "ALLOWED",
          "allowedUntil": {
            "unit": "hours",
            "offset": 1,
            "target": "string"
          },
          "hardTicketsMode": "ALLOWED",
          "seasonTicketMode": "NO_RESTRICTION"
        },
        "scanSettings": {
          "feedback": "highlight",
          "allowedScanCount": 10.5
        },
        "deliverySettings": {
          "wallet": {
            "enabled": "ENABLED"
          },
          "pdf": {
            "enabled": "ENABLED"
          }
        },
        "meta": {},
        "revealingSettings": {
          "enabled": "ENABLED",
          "beforeEvent": {
            "unit": "hours",
            "offset": 1,
            "target": "string"
          }
        }
      }
    ],
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z",
    "sellStart": "2030-01-23T23:00:00.123Z",
    "sellEnd": "2030-01-23T23:00:00.123Z",
    "maxAmountPerCustomer": 10.5,
    "maxTransactionsPerCustomer": 10.5,
    "minAmountPerOrder": 1,
    "customerTags": [
      "string"
    ],
    "customerSegments": [
      "string"
    ],
    "showCountdown": true,
    "hideInListing": true,
    "visibleAfter": "2030-01-23T23:00:00.123Z",
    "customSettings": {
      "_id": "507f191e810c19729de860ea",
      "hideTicketsInTransactionPage": true,
      "dontSendTicketMail": true,
      "dontSendBookingConfirmationMail": true,
      "customMailHeaderImage": "string",
      "customTransactionCompletionText": "string",
      "disableAppleWallet": true,
      "disablePdfTickets": true,
      "showStartDate": true,
      "showStartTime": true,
      "showEndDate": true,
      "showEndTime": true,
      "showTimeRangeInListing": true,
      "showTimeRangeInTicket": true,
      "customCheckoutCSS": "string",
      "useCustomCheckoutBrand": true,
      "customCheckoutBrand": "string",
      "hideLogoInCheckout": true,
      "customEventPageHTML": "string",
      "customEventPageCSS": "string",
      "customConfirmationPage": "string",
      "hideSeatmapInCheckout": true,
      "dontSendBookingConfirmationSMS": true
    },
    "extraFields": [
      {
        "_id": "507f191e810c19729de860ea",
        "required": true,
        "name": "Some fancy Name",
        "description": "string",
        "collectInCheckout": true,
        "deleted": true,
        "type": "text",
        "options": [
          "string"
        ],
        "onlyForCertainTicketTypes": true,
        "allowedTicketTypes": [
          "string"
        ],
        "printable": true,
        "conditions": [
          {
            "_id": "507f191e810c19729de860ea",
            "baseSlug": "string",
            "operator": "equals",
            "value": []
          }
        ],
        "settings": {
          "allowedMimeTypes": [
            "application/pdf"
          ]
        }
      }
    ],
    "ticketExtraFields": [
      {
        "_id": "507f191e810c19729de860ea",
        "required": true,
        "name": "Some fancy Name",
        "description": "string",
        "collectInCheckout": true,
        "deleted": true,
        "type": "text",
        "options": [
          "string"
        ],
        "onlyForCertainTicketTypes": true,
        "allowedTicketTypes": [
          "string"
        ],
        "printable": true,
        "conditions": [
          {
            "_id": "507f191e810c19729de860ea",
            "baseSlug": "string",
            "operator": "equals",
            "value": []
          }
        ],
        "settings": {
          "allowedMimeTypes": [
            "application/pdf"
          ]
        }
      }
    ],
    "accentColor": "#006DCC",
    "pageStyle": "white",
    "showOtherEvents": true,
    "underShops": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "active": true,
        "tickets": [
          {
            "_id": "507f191e810c19729de860ea",
            "baseTicket": "string",
            "name": "Some fancy Name",
            "price": 10.5,
            "amount": 10.5,
            "active": true,
            "description": "string"
          }
        ],
        "categories": [
          {
            "_id": "507f191e810c19729de860ea",
            "baseCategoryId": "507f191e810c19729de860ea",
            "amount": 10.5,
            "maxAmountPerOrder": 10.5
          }
        ],
        "timeSlots": [
          {
            "_id": "507f191e810c19729de860ea",
            "baseTimeSlotId": "507f191e810c19729de860ea",
            "amount": 10.5,
            "enabled": "ENABLED"
          }
        ],
        "sellStart": "2030-01-23T23:00:00.123Z",
        "sellEnd": "2030-01-23T23:00:00.123Z",
        "maxAmount": 10.5,
        "maxAmountPerOrder": 10.5,
        "minAmountPerOrder": 1,
        "maxTransactionsPerCustomer": 10.5,
        "maxAmountPerCustomer": 10.5,
        "ticketShopHeaderText": "string",
        "customCharges": {
          "_id": "507f191e810c19729de860ea",
          "outerChargeVar": 10.5,
          "innerChargeVar": 10.5,
          "outerChargeFix": 10.5,
          "innerChargeFix": 10.5,
          "posOuterChargeFix": 10.5,
          "posOuterChargeVar": 10.5,
          "cartOuterChargeFix": 10.5
        },
        "seatingContingents": [
          "string"
        ],
        "availabilityMode": "default",
        "bestAvailableSeatingConfiguration": {
          "enabled": true,
          "enforced": true,
          "allowMassBooking": true
        },
        "reservationSettings": {
          "option": "noReservations"
        },
        "accountSettings": {
          "_id": "507f191e810c19729de860ea",
          "enforceAccounts": true,
          "enforceAuthentication": "DISABLED"
        },
        "customerTags": [
          "string"
        ],
        "customerSegments": [
          "string"
        ],
        "allowMassDownload": true,
        "inventoryStrategy": "independent",
        "extraFields": [
          {
            "_id": "507f191e810c19729de860ea",
            "required": true,
            "name": "Some fancy Name",
            "description": "string",
            "collectInCheckout": true,
            "deleted": true,
            "type": "text",
            "options": [
              "string"
            ],
            "onlyForCertainTicketTypes": true,
            "allowedTicketTypes": [
              "string"
            ],
            "printable": true,
            "conditions": [
              {
                "_id": "507f191e810c19729de860ea",
                "baseSlug": "string",
                "operator": "equals",
                "value": []
              }
            ],
            "settings": {
              "allowedMimeTypes": [
                "application/pdf"
              ]
            }
          }
        ],
        "salesChannelGroupSettings": [
          {
            "salesChannelGroupId": "507f191e810c19729de860ea",
            "enabled": true
          }
        ],
        "paymentSettings": {
          "paymentStrategyId": "507f191e810c19729de860ea"
        },
        "unlockMode": "none"
      }
    ],
    "seating": {
      "_id": "507f191e810c19729de860ea",
      "active": true,
      "eventKey": "string",
      "eventId": "507f191e810c19729de860ea",
      "seatMapId": "507f191e810c19729de860ea",
      "revisionId": "507f191e810c19729de860ea",
      "orphanConfiguration": {
        "_id": "507f191e810c19729de860ea",
        "minSeatDistance": 2,
        "edgeSeatsOrphaning": true
      },
      "contingents": [
        "string"
      ],
      "availabilityMode": "default",
      "bestAvailableSeatingConfiguration": {
        "enabled": true,
        "enforced": true
      }
    },
    "customTextConfig": {
      "_id": "507f191e810c19729de860ea",
      "buyTicketsCTA": "string"
    },
    "eventType": "SINGLE",
    "childEvents": [
      "string"
    ],
    "url": "https://vivenu.com",
    "tags": [
      "string"
    ],
    "seoSettings": {
      "_id": "507f191e810c19729de860ea",
      "tags": [
        "string"
      ],
      "noIndex": true,
      "title": "string",
      "description": "string"
    },
    "extraInformation": {
      "_id": "507f191e810c19729de860ea",
      "type": "string",
      "category": "string",
      "subCategory": "string"
    },
    "customCharges": {
      "_id": "507f191e810c19729de860ea",
      "outerChargeVar": 10.5,
      "innerChargeVar": 10.5,
      "outerChargeFix": 10.5,
      "innerChargeFix": 10.5,
      "posOuterChargeFix": 10.5,
      "posOuterChargeVar": 10.5,
      "cartOuterChargeFix": 10.5
    },
    "gallery": [
      {
        "_id": "507f191e810c19729de860ea",
        "title": "string",
        "description": "string",
        "copyright": "string",
        "index": 10.5,
        "image": "https://your-url/image.png"
      }
    ],
    "video": {
      "youtubeID": "string"
    },
    "soldOutFallback": {
      "_id": "507f191e810c19729de860ea",
      "soldOutFallbackType": "default",
      "soldOutFallbackLink": "string"
    },
    "ticketDesign": {
      "_id": "507f191e810c19729de860ea",
      "useCustomDesign": true,
      "customDesignURL": "string",
      "footerDesignURL": "string",
      "disclaimer": "string",
      "infoColor": "string",
      "showTimeRange": true,
      "hideDates": true,
      "hideTimes": true
    },
    "checkinInformation": {
      "_id": "507f191e810c19729de860ea",
      "checkinStarts": "2030-01-23T23:00:00.123Z"
    },
    "tracking": {
      "facebookPixel": {
        "active": true,
        "pixelId": "507f191e810c19729de860ea"
      },
      "tagging": {
        "enabled": true,
        "tags": [
          "string"
        ]
      }
    },
    "hardTicketSettings": {
      "_id": "507f191e810c19729de860ea",
      "enabled": true,
      "fulfillmentType": "self",
      "printingMethod": "preprinted",
      "hardTicketOuterCharge": 10.5,
      "hardTicketInnerCharge": 10.5,
      "hardTicketPreviewURL": "string",
      "promotionName": "string",
      "promotionText": "string",
      "requiredDays": 1
    },
    "dataRequestSettings": {
      "requiresPersonalization": false,
      "requiresExtraFields": false,
      "repersonalization": false,
      "posPersonalization": "noPersonalization"
    },
    "styleOptions": {
      "headerStyle": "default",
      "hideLocationMap": false,
      "hideLocationAddress": false,
      "categoryAlignment": 0,
      "showAvailabilityIndicator": false,
      "availabilityIndicatorThresholds": [
        0.3,
        0.7
      ]
    },
    "geoCode": {
      "_id": "507f191e810c19729de860ea",
      "lat": 10.5,
      "lng": 10.5
    },
    "accountSettings": {
      "_id": "507f191e810c19729de860ea",
      "enforceAccounts": true,
      "enforceAuthentication": "DISABLED"
    },
    "reservationSettings": {
      "option": "noReservations"
    },
    "upsellSettings": {
      "_id": "507f191e810c19729de860ea",
      "active": true,
      "productStream": "string",
      "headerImage": "string",
      "crossSells": {
        "eventIds": [
          "string"
        ]
      }
    },
    "repetitionSettings": [
      {
        "every": 10.5,
        "unit": "DAY",
        "from": "2030-01-23T23:00:00.123Z",
        "to": "2030-01-23T23:00:00.123Z",
        "repeatsOn": [
          "SUNDAY"
        ]
      }
    ],
    "rootId": "507f191e810c19729de860ea",
    "daySchemes": [
      {
        "_id": "507f191e810c19729de860ea",
        "name": "Some fancy Name",
        "color": "string",
        "offers": {
          "allTicketTypesActive": true,
          "ticketTypes": [
            {
              "ticketTypeId": "507f191e810c19729de860ea",
              "active": true
            }
          ],
          "timeSlots": [
            {
              "slotId": "507f191e810c19729de860ea",
              "enabled": "string",
              "amount": 10.5
            }
          ]
        }
      }
    ],
    "daySchemeId": "507f191e810c19729de860ea",
    "ticketSettings": {
      "codeDisplay": "BARCODE",
      "cancellationStrategy": "disabled",
      "revealingSettings": {
        "enabled": "ENABLED",
        "beforeEvent": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        }
      },
      "transferSettings": {
        "mode": "ALLOWED",
        "expiresAfter": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "retransferMode": "ALLOWED",
        "allowedUntil": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "hardTicketsMode": "ALLOWED",
        "seasonTicketMode": "NO_RESTRICTION",
        "useSeasonCardTemplate": true
      },
      "upgradeSettings": {
        "enabled": "ENABLED",
        "underShopMapping": [
          {
            "type": "tag",
            "tag": "string",
            "underShopId": "507f191e810c19729de860ea"
          }
        ]
      },
      "resellSettings": {
        "enabled": "ENABLED",
        "resellerFeeFix": 10.5,
        "resellerFeeVar": 10.5,
        "buyerFeeFix": 10.5,
        "buyerFeeVar": 10.5,
        "offerCreationStart": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "offerCreationEnd": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "salesStart": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "priceMarkup": 10.5,
        "cartAutomationMode": "BLOCKED"
      },
      "barcodeSettings": {
        "issueOfflineBarcodes": "ENABLED"
      },
      "childEventMapping": [
        {
          "childEventId": "507f191e810c19729de860ea",
          "ticketTypeMapping": {},
          "valueShare": 10.5
        }
      ],
      "seasonCardValueStrategy": "childValue"
    },
    "accessListMapping": [
      {
        "listId": "507f191e810c19729de860ea",
        "ticketTypeId": "507f191e810c19729de860ea"
      }
    ],
    "deliverySettings": {
      "wallet": {
        "enabled": "ENABLED",
        "nfc": "ENABLED",
        "seasonCardShowNextEvent": true
      },
      "pdf": {
        "enabled": "ENABLED"
      }
    },
    "meta": {},
    "timezone": "string",
    "salesChannelGroupSettings": [
      {
        "salesChannelGroupId": "507f191e810c19729de860ea",
        "enabled": true
      }
    ],
    "paymentSettings": {
      "paymentStrategyId": "507f191e810c19729de860ea"
    },
    "timeSlots": [
      {
        "_id": "507f191e810c19729de860ea",
        "startTime": {
          "hour": 1,
          "minute": 1
        },
        "refs": [
          {
            "refType": "category",
            "categoryRef": "string"
          }
        ],
        "amount": 10.5
      }
    ],
    "useTimeSlots": true,
    "attributes": {}
  }
}

job.started

The data of the job started webhook event.

Required attributes

Name
job
Type
oneOf
Description
The associated job which has been started
One of — Only one of the following types
Required attributes
Name
_id
Type
string
Description
The ID of the job
Name
sellerId
Type
string
Description
The ID of the seller of the job
Name
type
Type
enum(transformJob)
Description
Optional attributes
Name
title
Type
string
Description
The title of the job
Name
status
Type
enum(SCHEDULED, RUNNING, FAILED, COMPLETED, COMPLETED_WITH_ERRORS)
Description
The status of the job.
Name
runAfter
Type
string date-time
Description
An ISO timestamp indicating after which time the job should be run.
Name
startedAt
Type
string date-time
Description
An ISO timestamp indicating when the job started
Name
finishedAt
Type
string date-time
Description
An ISO timestamp indicating when the job finished
Name
payload
Type
oneOf
Description
One of — Only one of the following types
Required attributes
Name
resource
Type
enum(ticketRangeInvalidation)
Description
Optional attributes
Name
csv
Type
string
Description
An URL to download the CSV data.
Name
json
Type
string
Description
An URL to download the JSON data.
Name
params
Type
object
Description
Optional nested attributes (2)
Name
batch
Type
string
Description
A UUId indicating in which batch the tickets were created
Name
groups
Type
array<array<integer>>
Description

Example

{
  "job": {
    "_id": "507f191e810c19729de860ea",
    "sellerId": "507f191e810c19729de860ea",
    "type": "transformJob",
    "title": "string",
    "status": "SCHEDULED",
    "runAfter": "2030-01-23T23:00:00.123Z",
    "startedAt": "2030-01-23T23:00:00.123Z",
    "finishedAt": "2030-01-23T23:00:00.123Z",
    "payload": {
      "resource": "ticketRangeInvalidation",
      "csv": "string",
      "json": "string",
      "params": {
        "batch": "string",
        "groups": [
          [
            1
          ]
        ]
      }
    }
  }
}

job.failed

The data of the job failed webhook event.

Required attributes

Name
job
Type
oneOf
Description
The associated job which has been failed
One of — Only one of the following types
Required attributes
Name
_id
Type
string
Description
The ID of the job
Name
sellerId
Type
string
Description
The ID of the seller of the job
Name
type
Type
enum(transformJob)
Description
Optional attributes
Name
title
Type
string
Description
The title of the job
Name
status
Type
enum(SCHEDULED, RUNNING, FAILED, COMPLETED, COMPLETED_WITH_ERRORS)
Description
The status of the job.
Name
runAfter
Type
string date-time
Description
An ISO timestamp indicating after which time the job should be run.
Name
startedAt
Type
string date-time
Description
An ISO timestamp indicating when the job started
Name
finishedAt
Type
string date-time
Description
An ISO timestamp indicating when the job finished
Name
payload
Type
oneOf
Description
One of — Only one of the following types
Required attributes
Name
resource
Type
enum(ticketRangeInvalidation)
Description
Optional attributes
Name
csv
Type
string
Description
An URL to download the CSV data.
Name
json
Type
string
Description
An URL to download the JSON data.
Name
params
Type
object
Description
Optional nested attributes (2)
Name
batch
Type
string
Description
A UUId indicating in which batch the tickets were created
Name
groups
Type
array<array<integer>>
Description

Example

{
  "job": {
    "_id": "507f191e810c19729de860ea",
    "sellerId": "507f191e810c19729de860ea",
    "type": "transformJob",
    "title": "string",
    "status": "SCHEDULED",
    "runAfter": "2030-01-23T23:00:00.123Z",
    "startedAt": "2030-01-23T23:00:00.123Z",
    "finishedAt": "2030-01-23T23:00:00.123Z",
    "payload": {
      "resource": "ticketRangeInvalidation",
      "csv": "string",
      "json": "string",
      "params": {
        "batch": "string",
        "groups": [
          [
            1
          ]
        ]
      }
    }
  }
}

job.completed

The data of the job completed webhook event.

Required attributes

Name
job
Type
oneOf
Description
The associated job which has been completed
One of — Only one of the following types
Required attributes
Name
_id
Type
string
Description
The ID of the job
Name
sellerId
Type
string
Description
The ID of the seller of the job
Name
type
Type
enum(transformJob)
Description
Optional attributes
Name
title
Type
string
Description
The title of the job
Name
status
Type
enum(SCHEDULED, RUNNING, FAILED, COMPLETED, COMPLETED_WITH_ERRORS)
Description
The status of the job.
Name
runAfter
Type
string date-time
Description
An ISO timestamp indicating after which time the job should be run.
Name
startedAt
Type
string date-time
Description
An ISO timestamp indicating when the job started
Name
finishedAt
Type
string date-time
Description
An ISO timestamp indicating when the job finished
Name
payload
Type
oneOf
Description
One of — Only one of the following types
Required attributes
Name
resource
Type
enum(ticketRangeInvalidation)
Description
Optional attributes
Name
csv
Type
string
Description
An URL to download the CSV data.
Name
json
Type
string
Description
An URL to download the JSON data.
Name
params
Type
object
Description
Optional nested attributes (2)
Name
batch
Type
string
Description
A UUId indicating in which batch the tickets were created
Name
groups
Type
array<array<integer>>
Description

Example

{
  "job": {
    "_id": "507f191e810c19729de860ea",
    "sellerId": "507f191e810c19729de860ea",
    "type": "transformJob",
    "title": "string",
    "status": "SCHEDULED",
    "runAfter": "2030-01-23T23:00:00.123Z",
    "startedAt": "2030-01-23T23:00:00.123Z",
    "finishedAt": "2030-01-23T23:00:00.123Z",
    "payload": {
      "resource": "ticketRangeInvalidation",
      "csv": "string",
      "json": "string",
      "params": {
        "batch": "string",
        "groups": [
          [
            1
          ]
        ]
      }
    }
  }
}

support.assignedToSeller

The data of the support assigned to seller webhook event.

Required attributes

Name
support
Type
object
Description
The associated support has been assigned
Required nested attributes (9)
Name
_id
Type
string
Description
The ID of the status
Name
name
Type
string
Description
The name of the ticket
Name
email
Type
string email
Description
The email of the ticket creator
Name
status
Type
enum(NEW, INPROGRESS, RESOLVED)
Description
The current status of the support ticket
Name
priority
Type
enum(LOW, MEDIUM, HIGH)
Description
The priority of the support tickt
Name
secret
Type
string
Description
The secret of the support ticket
Name
lastInteraction
Type
string date-time
Description
An ISO timestamp indicating the last interaction with the ticket
Name
createdAt
Type
string date-time
Description
An ISO timestamp indicating when the support ticket was created
Name
updatedAt
Type
string date-time
Description
An ISO timestamp indicating when the support ticket was updated
Optional nested attributes (12)
Name
transactionId
Type
string
Description
The ID of the corresponding transaction
Name
firstname
Type
string
Description
The firstname of the ticket creator
Name
lastname
Type
string
Description
The lastname of the ticket creator
Name
messages
Type
array<object>
Description
The sent messages associated with this ticket
Required nested attributes (4)
Name
_id
Type
string
Description
The ID of the support message
Name
userId
Type
string
Description
The ID of the user who sent the message
Name
senderName
Type
string
Description
The name of the message sender
Name
message
Type
string
Description
The text content of the support message
Optional nested attributes (1)
Name
createdAt
Type
string date-time
Description
An ISO timestamp indicating when the message was created
Name
assignee
Type
string
Description
The userId of the assignee
Name
assignedToSeller
Type
boolean
Description
Flag indicating whether the ticket is assigned to the seller
Name
note
Type
string
Description
Some internal notes in this support ticket.
Name
sellerId
Type
string
Description
The ID of the seller of the support ticket
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
Name
customerId
Type
string
Description
The ID of the customer
Name
tags
Type
array<string>
Description
Name
context
Type
object
Description

Example

{
  "support": {
    "_id": "507f191e810c19729de860ea",
    "name": "Some fancy Name",
    "email": "random@mail.com",
    "status": "NEW",
    "priority": "MEDIUM",
    "secret": "4b5fb736-45fd-4895-b497-124a2360c7e6",
    "lastInteraction": "2030-01-23T23:00:00.123Z",
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z",
    "transactionId": "507f191e810c19729de860ea",
    "firstname": "string",
    "lastname": "Robot",
    "messages": [
      {
        "_id": "507f191e810c19729de860ea",
        "userId": "507f191e810c19729de860ea",
        "senderName": "string",
        "message": "string",
        "createdAt": "2030-01-23T23:00:00.123Z"
      }
    ],
    "assignee": "string",
    "assignedToSeller": true,
    "note": "string",
    "sellerId": "507f191e810c19729de860ea",
    "preferredLanguage": "de",
    "customerId": "507f191e810c19729de860ea",
    "tags": [
      "string"
    ],
    "context": {}
  }
}

ticketTransfer.created

The data of the ticket transfer created webhook event.

Required attributes

Name
ticketTransfer
Type
TicketTransferResource
Description
The associated ticket transfer which has been expired
Required nested attributes (9)
Name
_id
Type
string
Description
The ID of the ticket transfer.
Name
secret
Type
string
Description
The secret token of the ticket transfer.
Name
ticketIds
Type
array<string>
Description
The ID of the tickets that ticket transfer belongs to.
Name
eventId
Type
string
Description
The ID of the event the ticket transfer belongs to.
Name
sellerId
Type
string
Description
The ID of the seller that ticket transfer belongs to.
Name
status
Type
enum(CREATED, REJECTED, TRANSFERRED, EXPIRED)
Description
The status of the ticket ticket transfer.
Name
origin
Type
enum(customer, stubhub)
Description
The origin of the ticket transfer.
Name
createdAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket transfer was created.
Name
updatedAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket transfer was updated.
Optional nested attributes (6)
Name
groupEventId
Type
string
Description
The ID of the group event the ticket transfer belongs to. Only filled in season card case.
Name
recipient
Type
object
Description
Required nested attributes (1)
Name
email
Type
string email
Description
The email of the ticket transfer recipient.
Optional nested attributes (2)
Name
phone
Type
string
Description
The phone number of the ticket transfer recipient.
Name
customerId
Type
string
Description
The ID of the ticket transfer recipient.
Name
sender
Type
object
Description
Optional nested attributes (4)
Name
email
Type
string email
Description
The email of the ticket transfer sender.
Name
customerId
Type
string
Description
The ID of the ticket transfer sender.
Name
firstname
Type
string
Description
The first name of the ticket transfer sender.
Name
lastname
Type
string
Description
The last name ticket transfer sender.
Name
outcome
Type
object
Description
The object representing result of the completed ticket transfer
Optional nested attributes (1)
Name
tickets
Type
array<object>
Description
The array of objects having transfered and origin tickets.
Required nested attributes (2)
Name
ticketId
Type
string
Description
The ID of the transfered ticket.
Name
originTicketId
Type
string
Description
The ID of the origin ticket.
Name
history
Type
array<object>
Description
An array of history entry items of the ticket transfer.
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the ticket transfer history entry.
Name
date
Type
string date-time
Description
The date of the history entry.
Optional nested attributes (2)
Name
userId
Type
string
Description
The ID of the user of the ticket transfer history entry.
Name
type
Type
enum(created, rejected, transferred, expired)
Description
The type of the ticket transfer history entry.
Name
expiresAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket transfer will be expired.

Example

{
  "ticketTransfer": {
    "_id": "507f191e810c19729de860ea",
    "secret": "4b5fb736-45fd-4895-b497-124a2360c7e6",
    "ticketIds": [
      "string"
    ],
    "eventId": "507f191e810c19729de860ea",
    "sellerId": "507f191e810c19729de860ea",
    "status": "CREATED",
    "origin": "customer",
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z",
    "groupEventId": "507f191e810c19729de860ea",
    "recipient": {
      "email": "random@mail.com",
      "phone": "string",
      "customerId": "507f191e810c19729de860ea"
    },
    "sender": {
      "email": "random@mail.com",
      "customerId": "507f191e810c19729de860ea",
      "firstname": "string",
      "lastname": "Robot"
    },
    "outcome": {
      "tickets": [
        {
          "ticketId": "507f191e810c19729de860ea",
          "originTicketId": "507f191e810c19729de860ea"
        }
      ]
    },
    "history": [
      {
        "_id": "507f191e810c19729de860ea",
        "date": "2030-01-23T23:00:00.123Z",
        "userId": "507f191e810c19729de860ea",
        "type": "created"
      }
    ],
    "expiresAt": "2030-01-23T23:00:00.123Z"
  }
}

ticketTransfer.rejected

The data of the ticket transfer rejected webhook event.

Required attributes

Name
ticketTransfer
Type
TicketTransferResource
Description
The associated ticket transfer which has been expired
Required nested attributes (9)
Name
_id
Type
string
Description
The ID of the ticket transfer.
Name
secret
Type
string
Description
The secret token of the ticket transfer.
Name
ticketIds
Type
array<string>
Description
The ID of the tickets that ticket transfer belongs to.
Name
eventId
Type
string
Description
The ID of the event the ticket transfer belongs to.
Name
sellerId
Type
string
Description
The ID of the seller that ticket transfer belongs to.
Name
status
Type
enum(CREATED, REJECTED, TRANSFERRED, EXPIRED)
Description
The status of the ticket ticket transfer.
Name
origin
Type
enum(customer, stubhub)
Description
The origin of the ticket transfer.
Name
createdAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket transfer was created.
Name
updatedAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket transfer was updated.
Optional nested attributes (6)
Name
groupEventId
Type
string
Description
The ID of the group event the ticket transfer belongs to. Only filled in season card case.
Name
recipient
Type
object
Description
Required nested attributes (1)
Name
email
Type
string email
Description
The email of the ticket transfer recipient.
Optional nested attributes (2)
Name
phone
Type
string
Description
The phone number of the ticket transfer recipient.
Name
customerId
Type
string
Description
The ID of the ticket transfer recipient.
Name
sender
Type
object
Description
Optional nested attributes (4)
Name
email
Type
string email
Description
The email of the ticket transfer sender.
Name
customerId
Type
string
Description
The ID of the ticket transfer sender.
Name
firstname
Type
string
Description
The first name of the ticket transfer sender.
Name
lastname
Type
string
Description
The last name ticket transfer sender.
Name
outcome
Type
object
Description
The object representing result of the completed ticket transfer
Optional nested attributes (1)
Name
tickets
Type
array<object>
Description
The array of objects having transfered and origin tickets.
Required nested attributes (2)
Name
ticketId
Type
string
Description
The ID of the transfered ticket.
Name
originTicketId
Type
string
Description
The ID of the origin ticket.
Name
history
Type
array<object>
Description
An array of history entry items of the ticket transfer.
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the ticket transfer history entry.
Name
date
Type
string date-time
Description
The date of the history entry.
Optional nested attributes (2)
Name
userId
Type
string
Description
The ID of the user of the ticket transfer history entry.
Name
type
Type
enum(created, rejected, transferred, expired)
Description
The type of the ticket transfer history entry.
Name
expiresAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket transfer will be expired.

Example

{
  "ticketTransfer": {
    "_id": "507f191e810c19729de860ea",
    "secret": "4b5fb736-45fd-4895-b497-124a2360c7e6",
    "ticketIds": [
      "string"
    ],
    "eventId": "507f191e810c19729de860ea",
    "sellerId": "507f191e810c19729de860ea",
    "status": "CREATED",
    "origin": "customer",
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z",
    "groupEventId": "507f191e810c19729de860ea",
    "recipient": {
      "email": "random@mail.com",
      "phone": "string",
      "customerId": "507f191e810c19729de860ea"
    },
    "sender": {
      "email": "random@mail.com",
      "customerId": "507f191e810c19729de860ea",
      "firstname": "string",
      "lastname": "Robot"
    },
    "outcome": {
      "tickets": [
        {
          "ticketId": "507f191e810c19729de860ea",
          "originTicketId": "507f191e810c19729de860ea"
        }
      ]
    },
    "history": [
      {
        "_id": "507f191e810c19729de860ea",
        "date": "2030-01-23T23:00:00.123Z",
        "userId": "507f191e810c19729de860ea",
        "type": "created"
      }
    ],
    "expiresAt": "2030-01-23T23:00:00.123Z"
  }
}

ticketTransfer.transferred

The data of the ticket transfer transferred webhook event.

Required attributes

Name
ticketTransfer
Type
TicketTransferResource
Description
The associated ticket transfer which has been expired
Required nested attributes (9)
Name
_id
Type
string
Description
The ID of the ticket transfer.
Name
secret
Type
string
Description
The secret token of the ticket transfer.
Name
ticketIds
Type
array<string>
Description
The ID of the tickets that ticket transfer belongs to.
Name
eventId
Type
string
Description
The ID of the event the ticket transfer belongs to.
Name
sellerId
Type
string
Description
The ID of the seller that ticket transfer belongs to.
Name
status
Type
enum(CREATED, REJECTED, TRANSFERRED, EXPIRED)
Description
The status of the ticket ticket transfer.
Name
origin
Type
enum(customer, stubhub)
Description
The origin of the ticket transfer.
Name
createdAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket transfer was created.
Name
updatedAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket transfer was updated.
Optional nested attributes (6)
Name
groupEventId
Type
string
Description
The ID of the group event the ticket transfer belongs to. Only filled in season card case.
Name
recipient
Type
object
Description
Required nested attributes (1)
Name
email
Type
string email
Description
The email of the ticket transfer recipient.
Optional nested attributes (2)
Name
phone
Type
string
Description
The phone number of the ticket transfer recipient.
Name
customerId
Type
string
Description
The ID of the ticket transfer recipient.
Name
sender
Type
object
Description
Optional nested attributes (4)
Name
email
Type
string email
Description
The email of the ticket transfer sender.
Name
customerId
Type
string
Description
The ID of the ticket transfer sender.
Name
firstname
Type
string
Description
The first name of the ticket transfer sender.
Name
lastname
Type
string
Description
The last name ticket transfer sender.
Name
outcome
Type
object
Description
The object representing result of the completed ticket transfer
Optional nested attributes (1)
Name
tickets
Type
array<object>
Description
The array of objects having transfered and origin tickets.
Required nested attributes (2)
Name
ticketId
Type
string
Description
The ID of the transfered ticket.
Name
originTicketId
Type
string
Description
The ID of the origin ticket.
Name
history
Type
array<object>
Description
An array of history entry items of the ticket transfer.
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the ticket transfer history entry.
Name
date
Type
string date-time
Description
The date of the history entry.
Optional nested attributes (2)
Name
userId
Type
string
Description
The ID of the user of the ticket transfer history entry.
Name
type
Type
enum(created, rejected, transferred, expired)
Description
The type of the ticket transfer history entry.
Name
expiresAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket transfer will be expired.

Example

{
  "ticketTransfer": {
    "_id": "507f191e810c19729de860ea",
    "secret": "4b5fb736-45fd-4895-b497-124a2360c7e6",
    "ticketIds": [
      "string"
    ],
    "eventId": "507f191e810c19729de860ea",
    "sellerId": "507f191e810c19729de860ea",
    "status": "CREATED",
    "origin": "customer",
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z",
    "groupEventId": "507f191e810c19729de860ea",
    "recipient": {
      "email": "random@mail.com",
      "phone": "string",
      "customerId": "507f191e810c19729de860ea"
    },
    "sender": {
      "email": "random@mail.com",
      "customerId": "507f191e810c19729de860ea",
      "firstname": "string",
      "lastname": "Robot"
    },
    "outcome": {
      "tickets": [
        {
          "ticketId": "507f191e810c19729de860ea",
          "originTicketId": "507f191e810c19729de860ea"
        }
      ]
    },
    "history": [
      {
        "_id": "507f191e810c19729de860ea",
        "date": "2030-01-23T23:00:00.123Z",
        "userId": "507f191e810c19729de860ea",
        "type": "created"
      }
    ],
    "expiresAt": "2030-01-23T23:00:00.123Z"
  }
}

ticketTransfer.expired

The data of the ticket transfer expired webhook event.

Required attributes

Name
ticketTransfer
Type
TicketTransferResource
Description
The associated ticket transfer which has been expired
Required nested attributes (9)
Name
_id
Type
string
Description
The ID of the ticket transfer.
Name
secret
Type
string
Description
The secret token of the ticket transfer.
Name
ticketIds
Type
array<string>
Description
The ID of the tickets that ticket transfer belongs to.
Name
eventId
Type
string
Description
The ID of the event the ticket transfer belongs to.
Name
sellerId
Type
string
Description
The ID of the seller that ticket transfer belongs to.
Name
status
Type
enum(CREATED, REJECTED, TRANSFERRED, EXPIRED)
Description
The status of the ticket ticket transfer.
Name
origin
Type
enum(customer, stubhub)
Description
The origin of the ticket transfer.
Name
createdAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket transfer was created.
Name
updatedAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket transfer was updated.
Optional nested attributes (6)
Name
groupEventId
Type
string
Description
The ID of the group event the ticket transfer belongs to. Only filled in season card case.
Name
recipient
Type
object
Description
Required nested attributes (1)
Name
email
Type
string email
Description
The email of the ticket transfer recipient.
Optional nested attributes (2)
Name
phone
Type
string
Description
The phone number of the ticket transfer recipient.
Name
customerId
Type
string
Description
The ID of the ticket transfer recipient.
Name
sender
Type
object
Description
Optional nested attributes (4)
Name
email
Type
string email
Description
The email of the ticket transfer sender.
Name
customerId
Type
string
Description
The ID of the ticket transfer sender.
Name
firstname
Type
string
Description
The first name of the ticket transfer sender.
Name
lastname
Type
string
Description
The last name ticket transfer sender.
Name
outcome
Type
object
Description
The object representing result of the completed ticket transfer
Optional nested attributes (1)
Name
tickets
Type
array<object>
Description
The array of objects having transfered and origin tickets.
Required nested attributes (2)
Name
ticketId
Type
string
Description
The ID of the transfered ticket.
Name
originTicketId
Type
string
Description
The ID of the origin ticket.
Name
history
Type
array<object>
Description
An array of history entry items of the ticket transfer.
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the ticket transfer history entry.
Name
date
Type
string date-time
Description
The date of the history entry.
Optional nested attributes (2)
Name
userId
Type
string
Description
The ID of the user of the ticket transfer history entry.
Name
type
Type
enum(created, rejected, transferred, expired)
Description
The type of the ticket transfer history entry.
Name
expiresAt
Type
string date-time
Description
An ISO Timestamp indicating when the ticket transfer will be expired.

Example

{
  "ticketTransfer": {
    "_id": "507f191e810c19729de860ea",
    "secret": "4b5fb736-45fd-4895-b497-124a2360c7e6",
    "ticketIds": [
      "string"
    ],
    "eventId": "507f191e810c19729de860ea",
    "sellerId": "507f191e810c19729de860ea",
    "status": "CREATED",
    "origin": "customer",
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z",
    "groupEventId": "507f191e810c19729de860ea",
    "recipient": {
      "email": "random@mail.com",
      "phone": "string",
      "customerId": "507f191e810c19729de860ea"
    },
    "sender": {
      "email": "random@mail.com",
      "customerId": "507f191e810c19729de860ea",
      "firstname": "string",
      "lastname": "Robot"
    },
    "outcome": {
      "tickets": [
        {
          "ticketId": "507f191e810c19729de860ea",
          "originTicketId": "507f191e810c19729de860ea"
        }
      ]
    },
    "history": [
      {
        "_id": "507f191e810c19729de860ea",
        "date": "2030-01-23T23:00:00.123Z",
        "userId": "507f191e810c19729de860ea",
        "type": "created"
      }
    ],
    "expiresAt": "2030-01-23T23:00:00.123Z"
  }
}

scan.created

The data of the scan created webhook event.

Required attributes

Name
scan
Type
object
Description
The associated scan which has been created
Required nested attributes (6)
Name
ticketId
Type
string
Description
The ID of the ticket
Name
eventId
Type
string
Description
The ID of the event
Name
barcode
Type
string
Description
The barcode
Name
ticketTypeId
Type
string
Description
The ID of the ticket type
Name
type
Type
enum(checkin, checkout)
Description
The scan type
Name
scanResult
Type
enum(approved, declined)
Description
The scan result
Optional nested attributes (6)
Name
time
Type
string date-time
Description
The date of the scan
Name
parentEventId
Type
string
Description
The ID of parent event
Name
name
Type
string
Description
The name on ticket
Name
ticketName
Type
string
Description
The ticket type name
Name
deviceId
Type
string
Description
The ID of the device
Name
sellerId
Type
string
Description
The ID of the seller

Example

{
  "scan": {
    "ticketId": "507f191e810c19729de860ea",
    "eventId": "507f191e810c19729de860ea",
    "barcode": "wbf7tkmy",
    "ticketTypeId": "507f191e810c19729de860ea",
    "type": "checkin",
    "scanResult": "approved",
    "time": "2030-01-23T23:00:00.123Z",
    "parentEventId": "507f191e810c19729de860ea",
    "name": "Some fancy Name",
    "ticketName": "string",
    "deviceId": "507f191e810c19729de860ea",
    "sellerId": "507f191e810c19729de860ea"
  }
}

subscription.created

The data of the subscription created event.

Required attributes

Name
subscription
Type
SubscriptionResource
Description
Required nested attributes (7)
Name
_id
Type
string
Description
The ID of the subscription
Name
sellerId
Type
string
Description
The ID of the seller of the subscription
Name
status
Type
enum(DRAFT, ACTIVE, INCOMPLETE, CANCELED, ARCHIVED, PENDING-CANCELLATION)
Description
The status of the subscription
Name
customerId
Type
string
Description
The ID of the customer of the subscription
Name
planId
Type
string
Description
The ID of the plan of the subscription
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
An ISO 4217 3-character code of the currency
Name
items
Type
array<SubscriptionItemResource>
Description
The origin information of the subscription
Required nested attributes (4)
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.
Name
ticketId
Type
string
Description
The ticket ID of the item
Optional nested attributes (19)
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
planVariantId
Type
string
Description
The plan variant ID of the item
Optional nested attributes (20)
Name
customerPaymentMethodId
Type
string
Description
The ID of the payment method of the subscription
Name
origin
Type
object
Description
The origin information of the subscription
Required nested attributes (1)
Name
eventId
Type
string
Description
The ID of the event of the origin
Optional nested attributes (1)
Name
shopId
Type
string
Description
The ID of the shop of the origin
Name
billing
Type
object
Description
The billing information of the subscription
Required nested attributes (1)
Name
cycles
Type
array<object>
Description
An array of billing cycles
Required nested attributes (3)
Name
start
Type
string date-time
Description
An ISO timestamp indicating when the billing start is
Name
end
Type
string date-time
Description
An ISO timestamp indicating when the billing end is
Name
status
Type
enum(FAILED, SCHEDULED, BILLED, CANCELED)
Description
The status of the billing
Optional nested attributes (3)
Name
due
Type
string date-time
Description
An ISO timestamp indicating when the billing due is
Name
transactionId
Type
string
Description
Name
isMinimumInterval
Type
boolean
Description
Name
consents
Type
array<object>
Description
An array of granted consents
Required nested attributes (2)
Name
type
Type
enum(autorenewal)
Description
The type of the subscription consent
Name
granted
Type
string date-time
Description
The date when the consent was granted
Name
payment
Type
object
Description
The payment of the subscription
Required nested attributes (2)
Name
anchor
Type
string date-time
Description
The anchor date of the payment
Name
schedules
Type
array<object>
Description
Required nested attributes (3)
Name
status
Type
enum(SCHEDULED, PENDING, SUCCEEDED, FAILED, REFUNDED)
Description
The status of the payment schedule resource
Name
total
Type
number float
Description
The total to be charged of the payment schedule
Name
billingCycleId
Type
string
Description
The Billing Cycle ID of the payment schedule
Optional nested attributes (5)
Name
due
Type
string date-time
Description
An ISO timestamp indicating when the due of the payment schedule is
Name
paymentId
Type
string
Description
The Payment ID of the payment schedule
Name
paymentRequestId
Type
string
Description
The Payment Request ID of the payment schedule
Name
attempts
Type
array<object>
Description
An array of payment schedule attempts
Required nested attributes (5)
Name
_id
Type
string
Description
The ID of the payment schedule attempt
Name
date
Type
string date-time
Description
The date of the payment schedule attempt
Name
status
Type
enum(SCHEDULED, PENDING, SUCCEEDED, FAILED, REFUNDED)
Description
The status of the payment schedule attempt
Name
paymentRequestId
Type
string
Description
The Payment Request ID of the payment schedule attempt
Name
paymentMethodId
Type
string
Description
The Payment Method ID of the payment schedule attempt
Name
nextAttempt
Type
string date-time
Description
An ISO timestamp indicating when the next attempt of the payment schedule is
Name
cycles
Type
array<object>
Description
An array of applied cycles on the subscription
Optional nested attributes (2)
Name
cycleId
Type
string
Description
The cycle ID of the applied cycle
Name
appliedAt
Type
string date-time
Description
An ISO timestamp indicating when the cycle was applied
Name
history
Type
array<object>
Description
An array of history items indicating changes on the subscription
Optional nested attributes (4)
Name
type
Type
enum(subscription.created, subscription.status_changed, subscription.cycle_applied, subscription.cycle_failed, subscription.billing_cycle_applied, subscription.payment_method_changed, subscription.item_changed, subscription.item_deleted, subscription.consent_granted, subscription.consent_revoked, subscription.upgraded)
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 if the history item comes from a non-subscription-holders
Name
data
Type
object
Description
The data of the history item
Name
transactionId
Type
string
Description
The ID of the transaction of the subscription
Name
startAt
Type
string date-time
Description
An ISO timestamp indicating when the subscription starts
Name
cancelAt
Type
string date-time
Description
An ISO timestamp indicating when the subscription cancels
Name
canceledAt
Type
string date-time
Description
An ISO timestamp indicating when the subscription was canceled
Name
company
Type
string
Description
The company of the subscription holder
Name
firstname
Type
string
Description
The first name of the subscription holder
Name
lastname
Type
string
Description
The last name of the subscription holder
Name
name
Type
string
Description
The name of the subscription holder
Name
email
Type
string email
Description
The email of the subscription holder
Name
phone
Type
string
Description
The phone number of the subscription holder
Name
address
Type
object
Description
The address information of the subscription holder
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
secret
Type
string date-time
Description
The secret token of the subscription
Name
attributes
Type
object
Description

Example

{
  "subscription": {
    "_id": "507f191e810c19729de860ea",
    "sellerId": "507f191e810c19729de860ea",
    "status": "DRAFT",
    "customerId": "507f191e810c19729de860ea",
    "planId": "507f191e810c19729de860ea",
    "currency": "EUR",
    "items": [
      {
        "amount": 1,
        "price": 10.5,
        "ticketTypeId": "507f191e810c19729de860ea",
        "ticketId": "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"
            }
          ]
        },
        "planVariantId": "507f191e810c19729de860ea"
      }
    ],
    "customerPaymentMethodId": "507f191e810c19729de860ea",
    "origin": {
      "eventId": "507f191e810c19729de860ea",
      "shopId": "507f191e810c19729de860ea"
    },
    "billing": {
      "cycles": [
        {
          "start": "2030-01-23T23:00:00.123Z",
          "end": "2030-01-23T23:00:00.123Z",
          "status": "FAILED",
          "due": "2030-01-23T23:00:00.123Z",
          "transactionId": "507f191e810c19729de860ea",
          "isMinimumInterval": true
        }
      ]
    },
    "consents": [
      {
        "type": "autorenewal",
        "granted": "2030-01-23T23:00:00.123Z"
      }
    ],
    "payment": {
      "anchor": "2030-01-23T23:00:00.123Z",
      "schedules": [
        {
          "status": "SCHEDULED",
          "total": 10.5,
          "billingCycleId": "507f191e810c19729de860ea",
          "due": "2030-01-23T23:00:00.123Z",
          "paymentId": "507f191e810c19729de860ea",
          "paymentRequestId": "507f191e810c19729de860ea",
          "attempts": [
            {
              "_id": "507f191e810c19729de860ea",
              "date": "2030-01-23T23:00:00.123Z",
              "status": "SCHEDULED",
              "paymentRequestId": "507f191e810c19729de860ea",
              "paymentMethodId": "507f191e810c19729de860ea"
            }
          ],
          "nextAttempt": "2030-01-23T23:00:00.123Z"
        }
      ]
    },
    "cycles": [
      {
        "cycleId": "507f191e810c19729de860ea",
        "appliedAt": "2030-01-23T23:00:00.123Z"
      }
    ],
    "history": [
      {
        "type": "subscription.created",
        "date": "2030-01-23T23:00:00.123Z",
        "userId": "507f191e810c19729de860ea",
        "data": {}
      }
    ],
    "transactionId": "507f191e810c19729de860ea",
    "startAt": "2030-01-23T23:00:00.123Z",
    "cancelAt": "2030-01-23T23:00:00.123Z",
    "canceledAt": "2030-01-23T23:00:00.123Z",
    "company": "vivenu GmbH",
    "firstname": "string",
    "lastname": "Robot",
    "name": "Some fancy Name",
    "email": "random@mail.com",
    "phone": "string",
    "address": {
      "fullAddress": "string",
      "street": "Speditionsstr",
      "line2": "string",
      "postal": "40221",
      "city": "Düsseldorf",
      "country": "DE",
      "state": "string"
    },
    "secret": "2030-01-23T23:00:00.123Z",
    "attributes": {}
  }
}

subscription.updated

The data of the subscription updated event.

Required attributes

Name
subscription
Type
SubscriptionResource
Description
Required nested attributes (7)
Name
_id
Type
string
Description
The ID of the subscription
Name
sellerId
Type
string
Description
The ID of the seller of the subscription
Name
status
Type
enum(DRAFT, ACTIVE, INCOMPLETE, CANCELED, ARCHIVED, PENDING-CANCELLATION)
Description
The status of the subscription
Name
customerId
Type
string
Description
The ID of the customer of the subscription
Name
planId
Type
string
Description
The ID of the plan of the subscription
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
An ISO 4217 3-character code of the currency
Name
items
Type
array<SubscriptionItemResource>
Description
The origin information of the subscription
Required nested attributes (4)
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.
Name
ticketId
Type
string
Description
The ticket ID of the item
Optional nested attributes (19)
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
planVariantId
Type
string
Description
The plan variant ID of the item
Optional nested attributes (20)
Name
customerPaymentMethodId
Type
string
Description
The ID of the payment method of the subscription
Name
origin
Type
object
Description
The origin information of the subscription
Required nested attributes (1)
Name
eventId
Type
string
Description
The ID of the event of the origin
Optional nested attributes (1)
Name
shopId
Type
string
Description
The ID of the shop of the origin
Name
billing
Type
object
Description
The billing information of the subscription
Required nested attributes (1)
Name
cycles
Type
array<object>
Description
An array of billing cycles
Required nested attributes (3)
Name
start
Type
string date-time
Description
An ISO timestamp indicating when the billing start is
Name
end
Type
string date-time
Description
An ISO timestamp indicating when the billing end is
Name
status
Type
enum(FAILED, SCHEDULED, BILLED, CANCELED)
Description
The status of the billing
Optional nested attributes (3)
Name
due
Type
string date-time
Description
An ISO timestamp indicating when the billing due is
Name
transactionId
Type
string
Description
Name
isMinimumInterval
Type
boolean
Description
Name
consents
Type
array<object>
Description
An array of granted consents
Required nested attributes (2)
Name
type
Type
enum(autorenewal)
Description
The type of the subscription consent
Name
granted
Type
string date-time
Description
The date when the consent was granted
Name
payment
Type
object
Description
The payment of the subscription
Required nested attributes (2)
Name
anchor
Type
string date-time
Description
The anchor date of the payment
Name
schedules
Type
array<object>
Description
Required nested attributes (3)
Name
status
Type
enum(SCHEDULED, PENDING, SUCCEEDED, FAILED, REFUNDED)
Description
The status of the payment schedule resource
Name
total
Type
number float
Description
The total to be charged of the payment schedule
Name
billingCycleId
Type
string
Description
The Billing Cycle ID of the payment schedule
Optional nested attributes (5)
Name
due
Type
string date-time
Description
An ISO timestamp indicating when the due of the payment schedule is
Name
paymentId
Type
string
Description
The Payment ID of the payment schedule
Name
paymentRequestId
Type
string
Description
The Payment Request ID of the payment schedule
Name
attempts
Type
array<object>
Description
An array of payment schedule attempts
Required nested attributes (5)
Name
_id
Type
string
Description
The ID of the payment schedule attempt
Name
date
Type
string date-time
Description
The date of the payment schedule attempt
Name
status
Type
enum(SCHEDULED, PENDING, SUCCEEDED, FAILED, REFUNDED)
Description
The status of the payment schedule attempt
Name
paymentRequestId
Type
string
Description
The Payment Request ID of the payment schedule attempt
Name
paymentMethodId
Type
string
Description
The Payment Method ID of the payment schedule attempt
Name
nextAttempt
Type
string date-time
Description
An ISO timestamp indicating when the next attempt of the payment schedule is
Name
cycles
Type
array<object>
Description
An array of applied cycles on the subscription
Optional nested attributes (2)
Name
cycleId
Type
string
Description
The cycle ID of the applied cycle
Name
appliedAt
Type
string date-time
Description
An ISO timestamp indicating when the cycle was applied
Name
history
Type
array<object>
Description
An array of history items indicating changes on the subscription
Optional nested attributes (4)
Name
type
Type
enum(subscription.created, subscription.status_changed, subscription.cycle_applied, subscription.cycle_failed, subscription.billing_cycle_applied, subscription.payment_method_changed, subscription.item_changed, subscription.item_deleted, subscription.consent_granted, subscription.consent_revoked, subscription.upgraded)
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 if the history item comes from a non-subscription-holders
Name
data
Type
object
Description
The data of the history item
Name
transactionId
Type
string
Description
The ID of the transaction of the subscription
Name
startAt
Type
string date-time
Description
An ISO timestamp indicating when the subscription starts
Name
cancelAt
Type
string date-time
Description
An ISO timestamp indicating when the subscription cancels
Name
canceledAt
Type
string date-time
Description
An ISO timestamp indicating when the subscription was canceled
Name
company
Type
string
Description
The company of the subscription holder
Name
firstname
Type
string
Description
The first name of the subscription holder
Name
lastname
Type
string
Description
The last name of the subscription holder
Name
name
Type
string
Description
The name of the subscription holder
Name
email
Type
string email
Description
The email of the subscription holder
Name
phone
Type
string
Description
The phone number of the subscription holder
Name
address
Type
object
Description
The address information of the subscription holder
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
secret
Type
string date-time
Description
The secret token of the subscription
Name
attributes
Type
object
Description

Example

{
  "subscription": {
    "_id": "507f191e810c19729de860ea",
    "sellerId": "507f191e810c19729de860ea",
    "status": "DRAFT",
    "customerId": "507f191e810c19729de860ea",
    "planId": "507f191e810c19729de860ea",
    "currency": "EUR",
    "items": [
      {
        "amount": 1,
        "price": 10.5,
        "ticketTypeId": "507f191e810c19729de860ea",
        "ticketId": "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"
            }
          ]
        },
        "planVariantId": "507f191e810c19729de860ea"
      }
    ],
    "customerPaymentMethodId": "507f191e810c19729de860ea",
    "origin": {
      "eventId": "507f191e810c19729de860ea",
      "shopId": "507f191e810c19729de860ea"
    },
    "billing": {
      "cycles": [
        {
          "start": "2030-01-23T23:00:00.123Z",
          "end": "2030-01-23T23:00:00.123Z",
          "status": "FAILED",
          "due": "2030-01-23T23:00:00.123Z",
          "transactionId": "507f191e810c19729de860ea",
          "isMinimumInterval": true
        }
      ]
    },
    "consents": [
      {
        "type": "autorenewal",
        "granted": "2030-01-23T23:00:00.123Z"
      }
    ],
    "payment": {
      "anchor": "2030-01-23T23:00:00.123Z",
      "schedules": [
        {
          "status": "SCHEDULED",
          "total": 10.5,
          "billingCycleId": "507f191e810c19729de860ea",
          "due": "2030-01-23T23:00:00.123Z",
          "paymentId": "507f191e810c19729de860ea",
          "paymentRequestId": "507f191e810c19729de860ea",
          "attempts": [
            {
              "_id": "507f191e810c19729de860ea",
              "date": "2030-01-23T23:00:00.123Z",
              "status": "SCHEDULED",
              "paymentRequestId": "507f191e810c19729de860ea",
              "paymentMethodId": "507f191e810c19729de860ea"
            }
          ],
          "nextAttempt": "2030-01-23T23:00:00.123Z"
        }
      ]
    },
    "cycles": [
      {
        "cycleId": "507f191e810c19729de860ea",
        "appliedAt": "2030-01-23T23:00:00.123Z"
      }
    ],
    "history": [
      {
        "type": "subscription.created",
        "date": "2030-01-23T23:00:00.123Z",
        "userId": "507f191e810c19729de860ea",
        "data": {}
      }
    ],
    "transactionId": "507f191e810c19729de860ea",
    "startAt": "2030-01-23T23:00:00.123Z",
    "cancelAt": "2030-01-23T23:00:00.123Z",
    "canceledAt": "2030-01-23T23:00:00.123Z",
    "company": "vivenu GmbH",
    "firstname": "string",
    "lastname": "Robot",
    "name": "Some fancy Name",
    "email": "random@mail.com",
    "phone": "string",
    "address": {
      "fullAddress": "string",
      "street": "Speditionsstr",
      "line2": "string",
      "postal": "40221",
      "city": "Düsseldorf",
      "country": "DE",
      "state": "string"
    },
    "secret": "2030-01-23T23:00:00.123Z",
    "attributes": {}
  }
}

subscription.payment.succeeded

The data of the subscription payment succeeded event.

Required attributes

Name
subscription
Type
SubscriptionResource
Description
Required nested attributes (7)
Name
_id
Type
string
Description
The ID of the subscription
Name
sellerId
Type
string
Description
The ID of the seller of the subscription
Name
status
Type
enum(DRAFT, ACTIVE, INCOMPLETE, CANCELED, ARCHIVED, PENDING-CANCELLATION)
Description
The status of the subscription
Name
customerId
Type
string
Description
The ID of the customer of the subscription
Name
planId
Type
string
Description
The ID of the plan of the subscription
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
An ISO 4217 3-character code of the currency
Name
items
Type
array<SubscriptionItemResource>
Description
The origin information of the subscription
Required nested attributes (4)
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.
Name
ticketId
Type
string
Description
The ticket ID of the item
Optional nested attributes (19)
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
planVariantId
Type
string
Description
The plan variant ID of the item
Optional nested attributes (20)
Name
customerPaymentMethodId
Type
string
Description
The ID of the payment method of the subscription
Name
origin
Type
object
Description
The origin information of the subscription
Required nested attributes (1)
Name
eventId
Type
string
Description
The ID of the event of the origin
Optional nested attributes (1)
Name
shopId
Type
string
Description
The ID of the shop of the origin
Name
billing
Type
object
Description
The billing information of the subscription
Required nested attributes (1)
Name
cycles
Type
array<object>
Description
An array of billing cycles
Required nested attributes (3)
Name
start
Type
string date-time
Description
An ISO timestamp indicating when the billing start is
Name
end
Type
string date-time
Description
An ISO timestamp indicating when the billing end is
Name
status
Type
enum(FAILED, SCHEDULED, BILLED, CANCELED)
Description
The status of the billing
Optional nested attributes (3)
Name
due
Type
string date-time
Description
An ISO timestamp indicating when the billing due is
Name
transactionId
Type
string
Description
Name
isMinimumInterval
Type
boolean
Description
Name
consents
Type
array<object>
Description
An array of granted consents
Required nested attributes (2)
Name
type
Type
enum(autorenewal)
Description
The type of the subscription consent
Name
granted
Type
string date-time
Description
The date when the consent was granted
Name
payment
Type
object
Description
The payment of the subscription
Required nested attributes (2)
Name
anchor
Type
string date-time
Description
The anchor date of the payment
Name
schedules
Type
array<object>
Description
Required nested attributes (3)
Name
status
Type
enum(SCHEDULED, PENDING, SUCCEEDED, FAILED, REFUNDED)
Description
The status of the payment schedule resource
Name
total
Type
number float
Description
The total to be charged of the payment schedule
Name
billingCycleId
Type
string
Description
The Billing Cycle ID of the payment schedule
Optional nested attributes (5)
Name
due
Type
string date-time
Description
An ISO timestamp indicating when the due of the payment schedule is
Name
paymentId
Type
string
Description
The Payment ID of the payment schedule
Name
paymentRequestId
Type
string
Description
The Payment Request ID of the payment schedule
Name
attempts
Type
array<object>
Description
An array of payment schedule attempts
Required nested attributes (5)
Name
_id
Type
string
Description
The ID of the payment schedule attempt
Name
date
Type
string date-time
Description
The date of the payment schedule attempt
Name
status
Type
enum(SCHEDULED, PENDING, SUCCEEDED, FAILED, REFUNDED)
Description
The status of the payment schedule attempt
Name
paymentRequestId
Type
string
Description
The Payment Request ID of the payment schedule attempt
Name
paymentMethodId
Type
string
Description
The Payment Method ID of the payment schedule attempt
Name
nextAttempt
Type
string date-time
Description
An ISO timestamp indicating when the next attempt of the payment schedule is
Name
cycles
Type
array<object>
Description
An array of applied cycles on the subscription
Optional nested attributes (2)
Name
cycleId
Type
string
Description
The cycle ID of the applied cycle
Name
appliedAt
Type
string date-time
Description
An ISO timestamp indicating when the cycle was applied
Name
history
Type
array<object>
Description
An array of history items indicating changes on the subscription
Optional nested attributes (4)
Name
type
Type
enum(subscription.created, subscription.status_changed, subscription.cycle_applied, subscription.cycle_failed, subscription.billing_cycle_applied, subscription.payment_method_changed, subscription.item_changed, subscription.item_deleted, subscription.consent_granted, subscription.consent_revoked, subscription.upgraded)
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 if the history item comes from a non-subscription-holders
Name
data
Type
object
Description
The data of the history item
Name
transactionId
Type
string
Description
The ID of the transaction of the subscription
Name
startAt
Type
string date-time
Description
An ISO timestamp indicating when the subscription starts
Name
cancelAt
Type
string date-time
Description
An ISO timestamp indicating when the subscription cancels
Name
canceledAt
Type
string date-time
Description
An ISO timestamp indicating when the subscription was canceled
Name
company
Type
string
Description
The company of the subscription holder
Name
firstname
Type
string
Description
The first name of the subscription holder
Name
lastname
Type
string
Description
The last name of the subscription holder
Name
name
Type
string
Description
The name of the subscription holder
Name
email
Type
string email
Description
The email of the subscription holder
Name
phone
Type
string
Description
The phone number of the subscription holder
Name
address
Type
object
Description
The address information of the subscription holder
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
secret
Type
string date-time
Description
The secret token of the subscription
Name
attributes
Type
object
Description

Example

{
  "subscription": {
    "_id": "507f191e810c19729de860ea",
    "sellerId": "507f191e810c19729de860ea",
    "status": "DRAFT",
    "customerId": "507f191e810c19729de860ea",
    "planId": "507f191e810c19729de860ea",
    "currency": "EUR",
    "items": [
      {
        "amount": 1,
        "price": 10.5,
        "ticketTypeId": "507f191e810c19729de860ea",
        "ticketId": "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"
            }
          ]
        },
        "planVariantId": "507f191e810c19729de860ea"
      }
    ],
    "customerPaymentMethodId": "507f191e810c19729de860ea",
    "origin": {
      "eventId": "507f191e810c19729de860ea",
      "shopId": "507f191e810c19729de860ea"
    },
    "billing": {
      "cycles": [
        {
          "start": "2030-01-23T23:00:00.123Z",
          "end": "2030-01-23T23:00:00.123Z",
          "status": "FAILED",
          "due": "2030-01-23T23:00:00.123Z",
          "transactionId": "507f191e810c19729de860ea",
          "isMinimumInterval": true
        }
      ]
    },
    "consents": [
      {
        "type": "autorenewal",
        "granted": "2030-01-23T23:00:00.123Z"
      }
    ],
    "payment": {
      "anchor": "2030-01-23T23:00:00.123Z",
      "schedules": [
        {
          "status": "SCHEDULED",
          "total": 10.5,
          "billingCycleId": "507f191e810c19729de860ea",
          "due": "2030-01-23T23:00:00.123Z",
          "paymentId": "507f191e810c19729de860ea",
          "paymentRequestId": "507f191e810c19729de860ea",
          "attempts": [
            {
              "_id": "507f191e810c19729de860ea",
              "date": "2030-01-23T23:00:00.123Z",
              "status": "SCHEDULED",
              "paymentRequestId": "507f191e810c19729de860ea",
              "paymentMethodId": "507f191e810c19729de860ea"
            }
          ],
          "nextAttempt": "2030-01-23T23:00:00.123Z"
        }
      ]
    },
    "cycles": [
      {
        "cycleId": "507f191e810c19729de860ea",
        "appliedAt": "2030-01-23T23:00:00.123Z"
      }
    ],
    "history": [
      {
        "type": "subscription.created",
        "date": "2030-01-23T23:00:00.123Z",
        "userId": "507f191e810c19729de860ea",
        "data": {}
      }
    ],
    "transactionId": "507f191e810c19729de860ea",
    "startAt": "2030-01-23T23:00:00.123Z",
    "cancelAt": "2030-01-23T23:00:00.123Z",
    "canceledAt": "2030-01-23T23:00:00.123Z",
    "company": "vivenu GmbH",
    "firstname": "string",
    "lastname": "Robot",
    "name": "Some fancy Name",
    "email": "random@mail.com",
    "phone": "string",
    "address": {
      "fullAddress": "string",
      "street": "Speditionsstr",
      "line2": "string",
      "postal": "40221",
      "city": "Düsseldorf",
      "country": "DE",
      "state": "string"
    },
    "secret": "2030-01-23T23:00:00.123Z",
    "attributes": {}
  }
}

subscription.payment.failed

The data of the subscription payment failed event.

Required attributes

Name
subscription
Type
SubscriptionResource
Description
Required nested attributes (7)
Name
_id
Type
string
Description
The ID of the subscription
Name
sellerId
Type
string
Description
The ID of the seller of the subscription
Name
status
Type
enum(DRAFT, ACTIVE, INCOMPLETE, CANCELED, ARCHIVED, PENDING-CANCELLATION)
Description
The status of the subscription
Name
customerId
Type
string
Description
The ID of the customer of the subscription
Name
planId
Type
string
Description
The ID of the plan of the subscription
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
An ISO 4217 3-character code of the currency
Name
items
Type
array<SubscriptionItemResource>
Description
The origin information of the subscription
Required nested attributes (4)
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.
Name
ticketId
Type
string
Description
The ticket ID of the item
Optional nested attributes (19)
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
planVariantId
Type
string
Description
The plan variant ID of the item
Optional nested attributes (20)
Name
customerPaymentMethodId
Type
string
Description
The ID of the payment method of the subscription
Name
origin
Type
object
Description
The origin information of the subscription
Required nested attributes (1)
Name
eventId
Type
string
Description
The ID of the event of the origin
Optional nested attributes (1)
Name
shopId
Type
string
Description
The ID of the shop of the origin
Name
billing
Type
object
Description
The billing information of the subscription
Required nested attributes (1)
Name
cycles
Type
array<object>
Description
An array of billing cycles
Required nested attributes (3)
Name
start
Type
string date-time
Description
An ISO timestamp indicating when the billing start is
Name
end
Type
string date-time
Description
An ISO timestamp indicating when the billing end is
Name
status
Type
enum(FAILED, SCHEDULED, BILLED, CANCELED)
Description
The status of the billing
Optional nested attributes (3)
Name
due
Type
string date-time
Description
An ISO timestamp indicating when the billing due is
Name
transactionId
Type
string
Description
Name
isMinimumInterval
Type
boolean
Description
Name
consents
Type
array<object>
Description
An array of granted consents
Required nested attributes (2)
Name
type
Type
enum(autorenewal)
Description
The type of the subscription consent
Name
granted
Type
string date-time
Description
The date when the consent was granted
Name
payment
Type
object
Description
The payment of the subscription
Required nested attributes (2)
Name
anchor
Type
string date-time
Description
The anchor date of the payment
Name
schedules
Type
array<object>
Description
Required nested attributes (3)
Name
status
Type
enum(SCHEDULED, PENDING, SUCCEEDED, FAILED, REFUNDED)
Description
The status of the payment schedule resource
Name
total
Type
number float
Description
The total to be charged of the payment schedule
Name
billingCycleId
Type
string
Description
The Billing Cycle ID of the payment schedule
Optional nested attributes (5)
Name
due
Type
string date-time
Description
An ISO timestamp indicating when the due of the payment schedule is
Name
paymentId
Type
string
Description
The Payment ID of the payment schedule
Name
paymentRequestId
Type
string
Description
The Payment Request ID of the payment schedule
Name
attempts
Type
array<object>
Description
An array of payment schedule attempts
Required nested attributes (5)
Name
_id
Type
string
Description
The ID of the payment schedule attempt
Name
date
Type
string date-time
Description
The date of the payment schedule attempt
Name
status
Type
enum(SCHEDULED, PENDING, SUCCEEDED, FAILED, REFUNDED)
Description
The status of the payment schedule attempt
Name
paymentRequestId
Type
string
Description
The Payment Request ID of the payment schedule attempt
Name
paymentMethodId
Type
string
Description
The Payment Method ID of the payment schedule attempt
Name
nextAttempt
Type
string date-time
Description
An ISO timestamp indicating when the next attempt of the payment schedule is
Name
cycles
Type
array<object>
Description
An array of applied cycles on the subscription
Optional nested attributes (2)
Name
cycleId
Type
string
Description
The cycle ID of the applied cycle
Name
appliedAt
Type
string date-time
Description
An ISO timestamp indicating when the cycle was applied
Name
history
Type
array<object>
Description
An array of history items indicating changes on the subscription
Optional nested attributes (4)
Name
type
Type
enum(subscription.created, subscription.status_changed, subscription.cycle_applied, subscription.cycle_failed, subscription.billing_cycle_applied, subscription.payment_method_changed, subscription.item_changed, subscription.item_deleted, subscription.consent_granted, subscription.consent_revoked, subscription.upgraded)
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 if the history item comes from a non-subscription-holders
Name
data
Type
object
Description
The data of the history item
Name
transactionId
Type
string
Description
The ID of the transaction of the subscription
Name
startAt
Type
string date-time
Description
An ISO timestamp indicating when the subscription starts
Name
cancelAt
Type
string date-time
Description
An ISO timestamp indicating when the subscription cancels
Name
canceledAt
Type
string date-time
Description
An ISO timestamp indicating when the subscription was canceled
Name
company
Type
string
Description
The company of the subscription holder
Name
firstname
Type
string
Description
The first name of the subscription holder
Name
lastname
Type
string
Description
The last name of the subscription holder
Name
name
Type
string
Description
The name of the subscription holder
Name
email
Type
string email
Description
The email of the subscription holder
Name
phone
Type
string
Description
The phone number of the subscription holder
Name
address
Type
object
Description
The address information of the subscription holder
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
secret
Type
string date-time
Description
The secret token of the subscription
Name
attributes
Type
object
Description

Example

{
  "subscription": {
    "_id": "507f191e810c19729de860ea",
    "sellerId": "507f191e810c19729de860ea",
    "status": "DRAFT",
    "customerId": "507f191e810c19729de860ea",
    "planId": "507f191e810c19729de860ea",
    "currency": "EUR",
    "items": [
      {
        "amount": 1,
        "price": 10.5,
        "ticketTypeId": "507f191e810c19729de860ea",
        "ticketId": "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"
            }
          ]
        },
        "planVariantId": "507f191e810c19729de860ea"
      }
    ],
    "customerPaymentMethodId": "507f191e810c19729de860ea",
    "origin": {
      "eventId": "507f191e810c19729de860ea",
      "shopId": "507f191e810c19729de860ea"
    },
    "billing": {
      "cycles": [
        {
          "start": "2030-01-23T23:00:00.123Z",
          "end": "2030-01-23T23:00:00.123Z",
          "status": "FAILED",
          "due": "2030-01-23T23:00:00.123Z",
          "transactionId": "507f191e810c19729de860ea",
          "isMinimumInterval": true
        }
      ]
    },
    "consents": [
      {
        "type": "autorenewal",
        "granted": "2030-01-23T23:00:00.123Z"
      }
    ],
    "payment": {
      "anchor": "2030-01-23T23:00:00.123Z",
      "schedules": [
        {
          "status": "SCHEDULED",
          "total": 10.5,
          "billingCycleId": "507f191e810c19729de860ea",
          "due": "2030-01-23T23:00:00.123Z",
          "paymentId": "507f191e810c19729de860ea",
          "paymentRequestId": "507f191e810c19729de860ea",
          "attempts": [
            {
              "_id": "507f191e810c19729de860ea",
              "date": "2030-01-23T23:00:00.123Z",
              "status": "SCHEDULED",
              "paymentRequestId": "507f191e810c19729de860ea",
              "paymentMethodId": "507f191e810c19729de860ea"
            }
          ],
          "nextAttempt": "2030-01-23T23:00:00.123Z"
        }
      ]
    },
    "cycles": [
      {
        "cycleId": "507f191e810c19729de860ea",
        "appliedAt": "2030-01-23T23:00:00.123Z"
      }
    ],
    "history": [
      {
        "type": "subscription.created",
        "date": "2030-01-23T23:00:00.123Z",
        "userId": "507f191e810c19729de860ea",
        "data": {}
      }
    ],
    "transactionId": "507f191e810c19729de860ea",
    "startAt": "2030-01-23T23:00:00.123Z",
    "cancelAt": "2030-01-23T23:00:00.123Z",
    "canceledAt": "2030-01-23T23:00:00.123Z",
    "company": "vivenu GmbH",
    "firstname": "string",
    "lastname": "Robot",
    "name": "Some fancy Name",
    "email": "random@mail.com",
    "phone": "string",
    "address": {
      "fullAddress": "string",
      "street": "Speditionsstr",
      "line2": "string",
      "postal": "40221",
      "city": "Düsseldorf",
      "country": "DE",
      "state": "string"
    },
    "secret": "2030-01-23T23:00:00.123Z",
    "attributes": {}
  }
}

bundle.created

The data of the bundle created webhook event.

Required attributes

Name
bundle
Type
object
Description
The associated bundle which has been created
Required nested attributes (8)
Name
_id
Type
string
Description
The ID of the bundle
Name
active
Type
boolean
Description
Whether the bundle is active
Name
name
Type
string
Description
The name of the bundle
Name
description
Type
string
Description
The description of the bundle
Name
components
Type
array<object>
Description
The components of the bundle
Required nested attributes (4)
Name
name
Type
string
Description
The ID of the bundle component
Name
options
Type
array<oneOf>
Description
Options for the bundle component
One of — Only one of the following types
Required attributes
Name
type
Type
enum(pricetype)
Description
Name
priceType
Type
object
Description
Required nested attributes (2)
Name
priceTableId
Type
string
Description
The ID of the price table of the bundle component option
Name
priceTypeId
Type
string
Description
The ID of the price type of the bundle component option
Optional attributes
Name
_id
Type
string
Description
The ID of the option
Name
price
Type
number float
Description
The price of the bundle component option
Name
minQuantity
Type
number float
Description
Minimum quantity of the bundle component
Name
maxQuantity
Type
number float
Description
Maximum quantity of the bundle component
Optional nested attributes (2)
Name
_id
Type
string
Description
The ID of the bundle component
Name
localization
Type
object
Description
Localization of the bundle component for multiple languages
Name
triggers
Type
array<object>
Description
The triggers of the bundle
Optional nested attributes (3)
Name
_id
Type
string
Description
The ID of the bundle component
Name
type
Type
string
Description
Name
target
Type
object
Description
Required nested attributes (1)
Name
componentId
Type
string
Description
The component which should trigger the bundle
Name
sellerId
Type
string
Description
The ID of the seller of the bundle
Name
showOnlyTotalPrice
Type
boolean
Description
Whether to show the total only
Optional nested attributes (4)
Name
image
Type
string
Description
The image of the bundle
Name
createdAt
Type
string date-time
Description
An ISO timestamp indicating when the product was created
Name
updatedAt
Type
string date-time
Description
An ISO timestamp indicating when the product was updated
Name
localization
Type
object
Description
Localization of the bundle for multiple languages

Example

{
  "bundle": {
    "_id": "507f191e810c19729de860ea",
    "active": true,
    "name": "Some fancy Name",
    "description": "string",
    "components": [
      {
        "name": "Some fancy Name",
        "options": [
          {
            "type": "pricetype",
            "priceType": {
              "priceTableId": "507f191e810c19729de860ea",
              "priceTypeId": "507f191e810c19729de860ea"
            },
            "_id": "507f191e810c19729de860ea",
            "price": 10.5
          }
        ],
        "minQuantity": 10.5,
        "maxQuantity": 10.5,
        "_id": "507f191e810c19729de860ea",
        "localization": {}
      }
    ],
    "triggers": [
      {
        "_id": "507f191e810c19729de860ea",
        "type": "string",
        "target": {
          "componentId": "507f191e810c19729de860ea"
        }
      }
    ],
    "sellerId": "507f191e810c19729de860ea",
    "showOnlyTotalPrice": true,
    "image": "https://your-url/image.png",
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z",
    "localization": {}
  }
}

bundle.updated

The data of the bundle updated webhook event.

Required attributes

Name
bundle
Type
object
Description
The associated bundle which has been updated
Required nested attributes (8)
Name
_id
Type
string
Description
The ID of the bundle
Name
active
Type
boolean
Description
Whether the bundle is active
Name
name
Type
string
Description
The name of the bundle
Name
description
Type
string
Description
The description of the bundle
Name
components
Type
array<object>
Description
The components of the bundle
Required nested attributes (4)
Name
name
Type
string
Description
The ID of the bundle component
Name
options
Type
array<oneOf>
Description
Options for the bundle component
One of — Only one of the following types
Required attributes
Name
type
Type
enum(pricetype)
Description
Name
priceType
Type
object
Description
Required nested attributes (2)
Name
priceTableId
Type
string
Description
The ID of the price table of the bundle component option
Name
priceTypeId
Type
string
Description
The ID of the price type of the bundle component option
Optional attributes
Name
_id
Type
string
Description
The ID of the option
Name
price
Type
number float
Description
The price of the bundle component option
Name
minQuantity
Type
number float
Description
Minimum quantity of the bundle component
Name
maxQuantity
Type
number float
Description
Maximum quantity of the bundle component
Optional nested attributes (2)
Name
_id
Type
string
Description
The ID of the bundle component
Name
localization
Type
object
Description
Localization of the bundle component for multiple languages
Name
triggers
Type
array<object>
Description
The triggers of the bundle
Optional nested attributes (3)
Name
_id
Type
string
Description
The ID of the bundle component
Name
type
Type
string
Description
Name
target
Type
object
Description
Required nested attributes (1)
Name
componentId
Type
string
Description
The component which should trigger the bundle
Name
sellerId
Type
string
Description
The ID of the seller of the bundle
Name
showOnlyTotalPrice
Type
boolean
Description
Whether to show the total only
Optional nested attributes (4)
Name
image
Type
string
Description
The image of the bundle
Name
createdAt
Type
string date-time
Description
An ISO timestamp indicating when the product was created
Name
updatedAt
Type
string date-time
Description
An ISO timestamp indicating when the product was updated
Name
localization
Type
object
Description
Localization of the bundle for multiple languages

Example

{
  "bundle": {
    "_id": "507f191e810c19729de860ea",
    "active": true,
    "name": "Some fancy Name",
    "description": "string",
    "components": [
      {
        "name": "Some fancy Name",
        "options": [
          {
            "type": "pricetype",
            "priceType": {
              "priceTableId": "507f191e810c19729de860ea",
              "priceTypeId": "507f191e810c19729de860ea"
            },
            "_id": "507f191e810c19729de860ea",
            "price": 10.5
          }
        ],
        "minQuantity": 10.5,
        "maxQuantity": 10.5,
        "_id": "507f191e810c19729de860ea",
        "localization": {}
      }
    ],
    "triggers": [
      {
        "_id": "507f191e810c19729de860ea",
        "type": "string",
        "target": {
          "componentId": "507f191e810c19729de860ea"
        }
      }
    ],
    "sellerId": "507f191e810c19729de860ea",
    "showOnlyTotalPrice": true,
    "image": "https://your-url/image.png",
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z",
    "localization": {}
  }
}

product.created

The data of the product created webhook event.

Required attributes

Name
product
Type
object
Description
Required nested attributes (4)
Name
_id
Type
string
Description
The ID of the product
Name
name
Type
string
Description
The name of the product
Name
type
Type
enum(voucher, product, donation, membership, addOn)
Description
The type of the product
Name
sellerId
Type
string
Description
The ID of the seller of the product
Optional nested attributes (13)
Name
active
Type
boolean
Description
Whether the product is active and can be distributed
Name
isFulfillable
Type
boolean
Description
Whether the product can be delivered
Name
image
Type
string
Description
The image of the product
Name
description
Type
string
Description
The description of the product
Name
variants
Type
array<object>
Description
An array of variants of the product
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the product variant of the product
Name
taxable
Type
boolean
Description
Whether the product is taxable or not
Optional nested attributes (10)
Name
name
Type
string
Description
The Name of the product variant, defaults to product name if not specified
Name
description
Type
string
Description
A description of the variant
Name
priceType
Type
enum(fixed, range)
Description
Name
price
Type
number float
Description
The price of the product
Name
priceRange
Type
object
Description
Optional nested attributes (2)
Name
min
Type
number float
Description
The minimum price of the product
Name
max
Type
number float
Description
The maximum price of the product
Name
taxRate
Type
number float
Description
The tax rate of the product
Name
compareAtPrice
Type
number float
Description
The recommended retail price to compare with the actual price.
Name
taxServiceTypeId
Type
string
Description
The ID of the tax service of the product
Name
gtin
Type
string
Description
Name
localization
Type
object
Description
Localization of the product for multiple languages
Name
categoryIds
Type
array<string>
Description
An array of categories to which the product belongs
Name
voucherSettings
Type
object
Description
If the product is of type voucher
Optional nested attributes (5)
Name
limitedValidityPeriod
Type
boolean
Description
Whether the voucher should expire
Name
validityConfig
Type
object
Description
Optional nested attributes (3)
Name
amount
Type
number float
Description
Name
type
Type
number float
Description
Name
untilEndOfPeriod
Type
boolean
Description
Name
pdfImage
Type
string
Description
A marketing image printed onto voucher pdf
Name
disclaimer
Type
string
Description
A disclaimer text printed onto voucher pdf
Name
documentTemplateSettings
Type
object
Description
Optional nested attributes (1)
Name
templates
Type
array<object>
Description
Required nested attributes (4)
Name
templateId
Type
string
Description
The ID of the document template
Name
format
Type
enum(A4, LETTER, LEGAL, BOARDING-PASS, PLASTIC-CARD, CARD, LABEL, CUSTOM, APPLE, GOOGLE)
Description
The format of document template for the dimensions.
Name
target
Type
enum(thermal, digital, wallet)
Description
The target of document template for which targets it should be used.
Name
type
Type
enum(ticket, invoice, voucher, member-card, header-card)
Description
The type of document template for which document it should be used. ticket = The document template will be used on tickets. invoice = The document template will be used on invoices.
Name
addOnSettings
Type
object
Description
Optional nested attributes (2)
Name
optOutDescription
Type
string
Description
The description that is shown to the user if he decides to not buy the addOn
Name
localization
Type
object
Description
Localization of the addOnSettings for multiple languages
Name
donationSettings
Type
object
Description
Settings for donation products
Required nested attributes (2)
Name
campaignId
Type
string
Description
The ID of the fundraise campaign
Name
fundId
Type
string
Description
The ID of the donation fund
Name
meta
Type
object
Description
Custom key-value data. Metadata is useful for storing additional, structured information on an object.
Name
localization
Type
object
Description
Localization of the product for multiple languages
Name
createdAt
Type
string date-time
Description
An ISO timestamp indicating when the product was created
Name
updatedAt
Type
string date-time
Description
An ISO timestamp indicating when the product was updated

Example

{
  "product": {
    "_id": "507f191e810c19729de860ea",
    "name": "Some fancy Name",
    "type": "voucher",
    "sellerId": "507f191e810c19729de860ea",
    "active": true,
    "isFulfillable": true,
    "image": "https://your-url/image.png",
    "description": "string",
    "variants": [
      {
        "_id": "507f191e810c19729de860ea",
        "taxable": true,
        "name": "Some fancy Name",
        "description": "string",
        "priceType": "fixed",
        "price": 10.5,
        "priceRange": {
          "min": 10.5,
          "max": 10.5
        },
        "taxRate": 10.5,
        "compareAtPrice": 10.5,
        "taxServiceTypeId": "507f191e810c19729de860ea",
        "gtin": "string",
        "localization": {}
      }
    ],
    "categoryIds": [
      "string"
    ],
    "voucherSettings": {
      "limitedValidityPeriod": true,
      "validityConfig": {
        "amount": 10.5,
        "type": 10.5,
        "untilEndOfPeriod": true
      },
      "pdfImage": "string",
      "disclaimer": "string",
      "documentTemplateSettings": {
        "templates": [
          {
            "templateId": "507f191e810c19729de860ea",
            "format": "A4",
            "target": "thermal",
            "type": "ticket"
          }
        ]
      }
    },
    "addOnSettings": {
      "optOutDescription": "string",
      "localization": {}
    },
    "donationSettings": {
      "campaignId": "507f191e810c19729de860ea",
      "fundId": "507f191e810c19729de860ea"
    },
    "meta": {},
    "localization": {},
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z"
  }
}

product.updated

The data of the product updated webhook event.

Required attributes

Name
product
Type
object
Description
Required nested attributes (4)
Name
_id
Type
string
Description
The ID of the product
Name
name
Type
string
Description
The name of the product
Name
type
Type
enum(voucher, product, donation, membership, addOn)
Description
The type of the product
Name
sellerId
Type
string
Description
The ID of the seller of the product
Optional nested attributes (13)
Name
active
Type
boolean
Description
Whether the product is active and can be distributed
Name
isFulfillable
Type
boolean
Description
Whether the product can be delivered
Name
image
Type
string
Description
The image of the product
Name
description
Type
string
Description
The description of the product
Name
variants
Type
array<object>
Description
An array of variants of the product
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the product variant of the product
Name
taxable
Type
boolean
Description
Whether the product is taxable or not
Optional nested attributes (10)
Name
name
Type
string
Description
The Name of the product variant, defaults to product name if not specified
Name
description
Type
string
Description
A description of the variant
Name
priceType
Type
enum(fixed, range)
Description
Name
price
Type
number float
Description
The price of the product
Name
priceRange
Type
object
Description
Optional nested attributes (2)
Name
min
Type
number float
Description
The minimum price of the product
Name
max
Type
number float
Description
The maximum price of the product
Name
taxRate
Type
number float
Description
The tax rate of the product
Name
compareAtPrice
Type
number float
Description
The recommended retail price to compare with the actual price.
Name
taxServiceTypeId
Type
string
Description
The ID of the tax service of the product
Name
gtin
Type
string
Description
Name
localization
Type
object
Description
Localization of the product for multiple languages
Name
categoryIds
Type
array<string>
Description
An array of categories to which the product belongs
Name
voucherSettings
Type
object
Description
If the product is of type voucher
Optional nested attributes (5)
Name
limitedValidityPeriod
Type
boolean
Description
Whether the voucher should expire
Name
validityConfig
Type
object
Description
Optional nested attributes (3)
Name
amount
Type
number float
Description
Name
type
Type
number float
Description
Name
untilEndOfPeriod
Type
boolean
Description
Name
pdfImage
Type
string
Description
A marketing image printed onto voucher pdf
Name
disclaimer
Type
string
Description
A disclaimer text printed onto voucher pdf
Name
documentTemplateSettings
Type
object
Description
Optional nested attributes (1)
Name
templates
Type
array<object>
Description
Required nested attributes (4)
Name
templateId
Type
string
Description
The ID of the document template
Name
format
Type
enum(A4, LETTER, LEGAL, BOARDING-PASS, PLASTIC-CARD, CARD, LABEL, CUSTOM, APPLE, GOOGLE)
Description
The format of document template for the dimensions.
Name
target
Type
enum(thermal, digital, wallet)
Description
The target of document template for which targets it should be used.
Name
type
Type
enum(ticket, invoice, voucher, member-card, header-card)
Description
The type of document template for which document it should be used. ticket = The document template will be used on tickets. invoice = The document template will be used on invoices.
Name
addOnSettings
Type
object
Description
Optional nested attributes (2)
Name
optOutDescription
Type
string
Description
The description that is shown to the user if he decides to not buy the addOn
Name
localization
Type
object
Description
Localization of the addOnSettings for multiple languages
Name
donationSettings
Type
object
Description
Settings for donation products
Required nested attributes (2)
Name
campaignId
Type
string
Description
The ID of the fundraise campaign
Name
fundId
Type
string
Description
The ID of the donation fund
Name
meta
Type
object
Description
Custom key-value data. Metadata is useful for storing additional, structured information on an object.
Name
localization
Type
object
Description
Localization of the product for multiple languages
Name
createdAt
Type
string date-time
Description
An ISO timestamp indicating when the product was created
Name
updatedAt
Type
string date-time
Description
An ISO timestamp indicating when the product was updated

Example

{
  "product": {
    "_id": "507f191e810c19729de860ea",
    "name": "Some fancy Name",
    "type": "voucher",
    "sellerId": "507f191e810c19729de860ea",
    "active": true,
    "isFulfillable": true,
    "image": "https://your-url/image.png",
    "description": "string",
    "variants": [
      {
        "_id": "507f191e810c19729de860ea",
        "taxable": true,
        "name": "Some fancy Name",
        "description": "string",
        "priceType": "fixed",
        "price": 10.5,
        "priceRange": {
          "min": 10.5,
          "max": 10.5
        },
        "taxRate": 10.5,
        "compareAtPrice": 10.5,
        "taxServiceTypeId": "507f191e810c19729de860ea",
        "gtin": "string",
        "localization": {}
      }
    ],
    "categoryIds": [
      "string"
    ],
    "voucherSettings": {
      "limitedValidityPeriod": true,
      "validityConfig": {
        "amount": 10.5,
        "type": 10.5,
        "untilEndOfPeriod": true
      },
      "pdfImage": "string",
      "disclaimer": "string",
      "documentTemplateSettings": {
        "templates": [
          {
            "templateId": "507f191e810c19729de860ea",
            "format": "A4",
            "target": "thermal",
            "type": "ticket"
          }
        ]
      }
    },
    "addOnSettings": {
      "optOutDescription": "string",
      "localization": {}
    },
    "donationSettings": {
      "campaignId": "507f191e810c19729de860ea",
      "fundId": "507f191e810c19729de860ea"
    },
    "meta": {},
    "localization": {},
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z"
  }
}

product.deleted

The data of the product deleted webhook event.

Required attributes

Name
product
Type
object
Description
Required nested attributes (4)
Name
_id
Type
string
Description
The ID of the product
Name
name
Type
string
Description
The name of the product
Name
type
Type
enum(voucher, product, donation, membership, addOn)
Description
The type of the product
Name
sellerId
Type
string
Description
The ID of the seller of the product
Optional nested attributes (13)
Name
active
Type
boolean
Description
Whether the product is active and can be distributed
Name
isFulfillable
Type
boolean
Description
Whether the product can be delivered
Name
image
Type
string
Description
The image of the product
Name
description
Type
string
Description
The description of the product
Name
variants
Type
array<object>
Description
An array of variants of the product
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the product variant of the product
Name
taxable
Type
boolean
Description
Whether the product is taxable or not
Optional nested attributes (10)
Name
name
Type
string
Description
The Name of the product variant, defaults to product name if not specified
Name
description
Type
string
Description
A description of the variant
Name
priceType
Type
enum(fixed, range)
Description
Name
price
Type
number float
Description
The price of the product
Name
priceRange
Type
object
Description
Optional nested attributes (2)
Name
min
Type
number float
Description
The minimum price of the product
Name
max
Type
number float
Description
The maximum price of the product
Name
taxRate
Type
number float
Description
The tax rate of the product
Name
compareAtPrice
Type
number float
Description
The recommended retail price to compare with the actual price.
Name
taxServiceTypeId
Type
string
Description
The ID of the tax service of the product
Name
gtin
Type
string
Description
Name
localization
Type
object
Description
Localization of the product for multiple languages
Name
categoryIds
Type
array<string>
Description
An array of categories to which the product belongs
Name
voucherSettings
Type
object
Description
If the product is of type voucher
Optional nested attributes (5)
Name
limitedValidityPeriod
Type
boolean
Description
Whether the voucher should expire
Name
validityConfig
Type
object
Description
Optional nested attributes (3)
Name
amount
Type
number float
Description
Name
type
Type
number float
Description
Name
untilEndOfPeriod
Type
boolean
Description
Name
pdfImage
Type
string
Description
A marketing image printed onto voucher pdf
Name
disclaimer
Type
string
Description
A disclaimer text printed onto voucher pdf
Name
documentTemplateSettings
Type
object
Description
Optional nested attributes (1)
Name
templates
Type
array<object>
Description
Required nested attributes (4)
Name
templateId
Type
string
Description
The ID of the document template
Name
format
Type
enum(A4, LETTER, LEGAL, BOARDING-PASS, PLASTIC-CARD, CARD, LABEL, CUSTOM, APPLE, GOOGLE)
Description
The format of document template for the dimensions.
Name
target
Type
enum(thermal, digital, wallet)
Description
The target of document template for which targets it should be used.
Name
type
Type
enum(ticket, invoice, voucher, member-card, header-card)
Description
The type of document template for which document it should be used. ticket = The document template will be used on tickets. invoice = The document template will be used on invoices.
Name
addOnSettings
Type
object
Description
Optional nested attributes (2)
Name
optOutDescription
Type
string
Description
The description that is shown to the user if he decides to not buy the addOn
Name
localization
Type
object
Description
Localization of the addOnSettings for multiple languages
Name
donationSettings
Type
object
Description
Settings for donation products
Required nested attributes (2)
Name
campaignId
Type
string
Description
The ID of the fundraise campaign
Name
fundId
Type
string
Description
The ID of the donation fund
Name
meta
Type
object
Description
Custom key-value data. Metadata is useful for storing additional, structured information on an object.
Name
localization
Type
object
Description
Localization of the product for multiple languages
Name
createdAt
Type
string date-time
Description
An ISO timestamp indicating when the product was created
Name
updatedAt
Type
string date-time
Description
An ISO timestamp indicating when the product was updated

Example

{
  "product": {
    "_id": "507f191e810c19729de860ea",
    "name": "Some fancy Name",
    "type": "voucher",
    "sellerId": "507f191e810c19729de860ea",
    "active": true,
    "isFulfillable": true,
    "image": "https://your-url/image.png",
    "description": "string",
    "variants": [
      {
        "_id": "507f191e810c19729de860ea",
        "taxable": true,
        "name": "Some fancy Name",
        "description": "string",
        "priceType": "fixed",
        "price": 10.5,
        "priceRange": {
          "min": 10.5,
          "max": 10.5
        },
        "taxRate": 10.5,
        "compareAtPrice": 10.5,
        "taxServiceTypeId": "507f191e810c19729de860ea",
        "gtin": "string",
        "localization": {}
      }
    ],
    "categoryIds": [
      "string"
    ],
    "voucherSettings": {
      "limitedValidityPeriod": true,
      "validityConfig": {
        "amount": 10.5,
        "type": 10.5,
        "untilEndOfPeriod": true
      },
      "pdfImage": "string",
      "disclaimer": "string",
      "documentTemplateSettings": {
        "templates": [
          {
            "templateId": "507f191e810c19729de860ea",
            "format": "A4",
            "target": "thermal",
            "type": "ticket"
          }
        ]
      }
    },
    "addOnSettings": {
      "optOutDescription": "string",
      "localization": {}
    },
    "donationSettings": {
      "campaignId": "507f191e810c19729de860ea",
      "fundId": "507f191e810c19729de860ea"
    },
    "meta": {},
    "localization": {},
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z"
  }
}