Purchase Intents

Endpoints

The Purchase Intent object

Attributes

_id

Required

string

status

Required

string

newcompletecanceled

approvalStatus

Required

string

awaitingapprovedrejected

sellerId

Required

string

eventId

Required

string

regularPrice

Required

number float

realPrice

Required

number float

currency

Required

string

EURUSDGBPAUDCHFTHBILSCOPMXNDKKNOKSEKQARCADISKGTQINRDOPSGDPLNSARTTDZARKYDHKDCZKKRWJPYNZDAEDMADTWD

innerCharge

Required

number float

outerCharge

Required

number float

tickets

Required

array

tickets[].amount

Required

integer

The amount of the cart item.

tickets[].price

Required

number float

The single piece price of the cart item.

tickets[].ticketTypeId

Required

string

The ID of the ticket type of the cart item.

Optional Attributes

Collapse all

tickets[].type

Optional

string

The type of the cart item.

ticket

tickets[]._id

Optional

string

The ID of the cart item.

tickets[].name

Optional

string

The name of the cart item.

tickets[].netPrice

Optional

number float

The single piece net price of the cart item.

tickets[].taxRate

Optional

number float

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

tickets[].triggeredBy

Optional

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

One of

Only one of the following types

tickets[].bundleInfo

Optional

object

Optional Attributes

Collapse all

tickets[].bundleInfo.bundleId

Optional

string

tickets[].bundleInfo.componentId

Optional

string

tickets[].bundleInfo.optionId

Optional

string

tickets[].categoryRef

Optional

string

The category reference of the ticket type.

tickets[].seatingInfo

Optional

object

The associated seating object.

tickets[].seatingInfo._type

Required

number float

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

67

tickets[].seatingInfo.statusId

Required

string

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

Optional Attributes

Collapse all

tickets[].seatingInfo._id

Optional

string

The ID of the seating object.

tickets[].seatingInfo.categoryId

Optional

string

The ID of the category containing the seating object.

tickets[].seatingInfo.name

Optional

string

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

tickets[].seatingInfo.seatType

Optional

string

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

handicapped

tickets[].seatingInfo.sectionName

Optional

string

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

tickets[].seatingInfo.groupName

Optional

string

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

tickets[].seatingInfo.rowName

Optional

string

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

tickets[].seatingInfo.seatName

Optional

string

If _type == 6. The seat name.

tickets[].seatingInfo.gate

Optional

string

The entry gate associated with the seating object.

tickets[].asHardTicket

Optional

boolean

Whether this ticket is a hard ticket.

tickets[].triggeredAutomations

Optional

boolean

Whether the cart item triggered automations.

tickets[].meta

Optional

object

Meta data which is propagated to the ticket.

secret

Required

string

createdAt

Required

string date-time

updatedAt

Required

string date-time

Optional Attributes

Collapse all

rejectionReason

Optional

string

company

Optional

string

firstname

Optional

string

lastname

Optional

string

name

Optional

string

Optional

string email

customerId

Optional

string

address

Optional

object

Optional Attributes

Collapse all

address.street

Optional

string

The street of the address. Street name including number.

address.line2

Optional

string

The additional field of the address.

address.postal

Optional

string

The postal code of the address.

address.city

Optional

string

The city of the address.

address.country

Optional

string

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

address.state

Optional

string

The state of the address. If applicable

deliveryAddress

Optional

object

Optional Attributes

Collapse all

deliveryAddress.street

Optional

string

The street of the address. Street name including number.

deliveryAddress.line2

Optional

string

The additional field of the address.

deliveryAddress.postal

Optional

string

The postal code of the address.

deliveryAddress.city

Optional

string

The city of the address.

deliveryAddress.country

Optional

string

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

deliveryAddress.state

Optional

string

The state of the address. If applicable

deliveryAddress.name

Optional

string

The name of the person receiving delivery.

shopId

Optional

string

strategyId

Optional

string

vouchers

Optional

array<string>

appliedCoupons

Optional

array

One of

Only one of the following types

innerFeeComponents

Optional

One of

Only one of the following types

outerFeeComponents

Optional

One of

Only one of the following types

products

Optional

array

products[].type

Required

string

The type of the cart item.

product

products[].amount

Required

integer

The amount of the cart item.

products[].price

Required

number float

The single piece price of the cart item.

products[].productVariantId

Required

string

The ID of the product variant.

Optional Attributes

Collapse all

products[]._id

Optional

string

The ID of the cart item.

products[].name

Optional

string

The name of the cart item.

products[].netPrice

Optional

number float

The single piece net price of the cart item.

products[].taxRate

Optional

number float

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

products[].triggeredBy

Optional

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

One of

Only one of the following types

products[].bundleInfo

Optional

object

Optional Attributes

Collapse all

products[].bundleInfo.bundleId

Optional

string

products[].bundleInfo.componentId

Optional

string

products[].bundleInfo.optionId

Optional

string

products[].isFulfillable

Optional

boolean

Whether the product can be delivered

additionalItems

Optional

array

One of

Only one of the following types

additionalItems[].itemId

Required

string

The ID of the item.

additionalItems[].type

Required

string

The type of the additional item.

bundle

additionalItems[].netPrice

Required

number float

The single piece net price of the additional item.

additionalItems[].price

Required

number float

The single piece price of the additional item.

additionalItems[].taxRate

Required

number float

The tax rate to be applied to this additional item.

Optional Attributes

Collapse all

additionalItems[].taxInfo

Optional

object

The tax info details.

Optional Attributes

Collapse all

additionalItems[].taxInfo.serviceTypeId

Optional

string

The ID of the service type.

additionalItems[].taxInfo.exceptionId

Optional

string

The ID of the exception.

additionalItems[].taxInfo.proceedsAccountId

Optional

string

The ID of the proceeds account.

additionalItems[].taxInfo.proceedsAccountCode

Optional

string

The code of the proceeds account.

additionalItems[].taxInfo.taxItems

Optional

array

The array of tax items.

additionalItems[].taxInfo.taxItems[].taxTypeId

Required

string

additionalItems[].taxInfo.taxItems[].rate

Required

number float

additionalItems[].taxInfo.taxItems[].perUnit

Required

number float

additionalItems[].taxInfo.taxItems[].total

Required

number float

Optional Attributes

Collapse all

additionalItems[].taxInfo.taxItems[].name

Optional

string

additionalItems[].taxInfo.taxItems[].taxPayableAccountId

Optional

string

additionalItems[].taxInfo.taxItems[].taxPayableAccountCode

Optional

string

additionalItems[].data

Optional

object

additionalItems[].data.bundleId

Required

string

The ID of the bundle.

extraFields

Optional

object

expiresAt

Optional

string date-time

transactionId

Optional

string

outcome

Optional

object

Optional Attributes

Collapse all

outcome.checkoutId

Optional

string

restrictedCompletion

Optional

array<string>

Specifies how the customer can complete their purchase intent

cancellationStrategy

Optional

string

notAllowedcancellationAllowed

seatingReservationToken

Optional

string

salesChannelId

Optional

string

Optional Attributes

Collapse all

history[].type

Optional

string

The type of the history item.

purchaseIntent.createdpurchaseIntent.approvedpurchaseIntent.rejectedpurchaseIntent.updatedpurchaseIntent.expiredpurchaseIntent.completedpurchaseIntent.canceledpurchaseIntent.commented

history[].date

Optional

string date-time

An ISO timestamp indicating the date of the history item.

history[].userId

Optional

string

The user ID of the history item.

history[].data

Optional

object

The data of the history item

deposit

Optional

object

Information for the deposit paid, if there was any

deposit.amount

Required

number float

The amount paid for the deposit

deposit.paymentId

Required

string

The id of the payment for the deposit

deposit.balanceTransactionId

Required

string

The id of the transaction for the deposit

__v

Optional

integer

Was this section helpful?

Yes No

{
  "_id": "string",
  "status": "new",
  "approvalStatus": "awaiting",
  "rejectionReason": "string",
  "company": "string",
  "firstname": "string",
  "lastname": "string",
  "name": "string",
  "email": "[email protected]",
  "customerId": "string",
  "address": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string"
  },
  "deliveryAddress": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "string"
  },
  "sellerId": "string",
  "eventId": "string",
  "shopId": "string",
  "strategyId": "string",
  "vouchers": [
    "string"
  ],
  "appliedCoupons": [
    []
  ],
  "regularPrice": 10.5,
  "realPrice": 10.5,
  "currency": "EUR",
  "innerFeeComponents": [],
  "innerCharge": 10.5,
  "outerFeeComponents": [],
  "outerCharge": 10.5,
  "tickets": [
    {
      "type": "ticket",
      "_id": "string",
      "name": "string",
      "amount": 1,
      "netPrice": 10.5,
      "price": 10.5,
      "taxRate": 10.5,
      "triggeredBy": "string",
      "bundleInfo": {
        "bundleId": "string",
        "componentId": "string",
        "optionId": "string"
      },
      "ticketTypeId": "string",
      "categoryRef": "string",
      "seatingInfo": {
        "_id": "string",
        "_type": 6,
        "categoryId": "string",
        "statusId": "string",
        "name": "string",
        "seatType": "handicapped",
        "sectionName": "string",
        "groupName": "string",
        "rowName": "string",
        "seatName": "string",
        "gate": "string"
      },
      "asHardTicket": true,
      "triggeredAutomations": true,
      "meta": {}
    }
  ],
  "products": [
    {
      "type": "product",
      "_id": "string",
      "name": "string",
      "amount": 1,
      "netPrice": 10.5,
      "price": 10.5,
      "taxRate": 10.5,
      "triggeredBy": "string",
      "bundleInfo": {
        "bundleId": "string",
        "componentId": "string",
        "optionId": "string"
      },
      "productVariantId": "string",
      "isFulfillable": true
    }
  ],
  "additionalItems": [],
  "extraFields": {},
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "secret": "string",
  "transactionId": "string",
  "outcome": {
    "checkoutId": "string"
  },
  "restrictedCompletion": [
    "POS"
  ],
  "cancellationStrategy": "cancellationAllowed",
  "seatingReservationToken": "string",
  "salesChannelId": "string",
  "meta": {},
  "history": [],
  "deposit": {
    "amount": 10.5,
    "paymentId": "string",
    "balanceTransactionId": "string"
  },
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "__v": 1
}

Create a PurchaseIntent

Payload

eventId

Required

string

tickets

Required

array

tickets[].amount

Required

integer

The amount of the cart item.

tickets[].price

Required

number float

The single piece price of the cart item.

tickets[].ticketTypeId

Required

string

The ID of the ticket type of the cart item.

Optional Attributes

Collapse all

tickets[].type

Optional

string

The type of the cart item.

ticket

tickets[]._id

Optional

string

The ID of the cart item.

tickets[].name

Optional

string

The name of the cart item.

tickets[].netPrice

Optional

number float

The single piece net price of the cart item.

tickets[].taxRate

Optional

number float

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

tickets[].triggeredBy

Optional

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

One of

Only one of the following types

tickets[].bundleInfo

Optional

object

Optional Attributes

Collapse all

tickets[].bundleInfo.bundleId

Optional

string

tickets[].bundleInfo.componentId

Optional

string

tickets[].bundleInfo.optionId

Optional

string

tickets[].categoryRef

Optional

string

The category reference of the ticket type.

tickets[].seatingInfo

Optional

object

The associated seating object.

tickets[].seatingInfo._type

Required

number float

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

67

tickets[].seatingInfo.statusId

Required

string

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

Optional Attributes

Collapse all

tickets[].seatingInfo._id

Optional

string

The ID of the seating object.

tickets[].seatingInfo.categoryId

Optional

string

The ID of the category containing the seating object.

tickets[].seatingInfo.name

Optional

string

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

tickets[].seatingInfo.seatType

Optional

string

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

handicapped

tickets[].seatingInfo.sectionName

Optional

string

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

tickets[].seatingInfo.groupName

Optional

string

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

tickets[].seatingInfo.rowName

Optional

string

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

tickets[].seatingInfo.seatName

Optional

string

If _type == 6. The seat name.

tickets[].seatingInfo.gate

Optional

string

The entry gate associated with the seating object.

tickets[].asHardTicket

Optional

boolean

Whether this ticket is a hard ticket.

tickets[].triggeredAutomations

Optional

boolean

Whether the cart item triggered automations.

tickets[].meta

Optional

object

Meta data which is propagated to the ticket.

Optional Attributes

Collapse all

customerId

Optional

string

shopId

Optional

string

products

Optional

array

products[].type

Required

string

The type of the cart item.

product

products[].amount

Required

integer

The amount of the cart item.

products[].price

Required

number float

The single piece price of the cart item.

products[].productVariantId

Required

string

The ID of the product variant.

Optional Attributes

Collapse all

products[]._id

Optional

string

The ID of the cart item.

products[].name

Optional

string

The name of the cart item.

products[].netPrice

Optional

number float

The single piece net price of the cart item.

products[].taxRate

Optional

number float

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

products[].triggeredBy

Optional

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

One of

Only one of the following types

products[].bundleInfo

Optional

object

Optional Attributes

Collapse all

products[].bundleInfo.bundleId

Optional

string

products[].bundleInfo.componentId

Optional

string

products[].bundleInfo.optionId

Optional

string

products[].isFulfillable

Optional

boolean

Whether the product can be delivered

extraFields

Optional

object

seatingReservationToken

Optional

string

Get a PurchaseIntent

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "_id": "string",
  "status": "new",
  "approvalStatus": "awaiting",
  "rejectionReason": "string",
  "company": "string",
  "firstname": "string",
  "lastname": "string",
  "name": "string",
  "email": "[email protected]",
  "customerId": "string",
  "address": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string"
  },
  "deliveryAddress": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "string"
  },
  "sellerId": "string",
  "eventId": "string",
  "shopId": "string",
  "strategyId": "string",
  "vouchers": [
    "string"
  ],
  "appliedCoupons": [
    []
  ],
  "regularPrice": 10.5,
  "realPrice": 10.5,
  "currency": "EUR",
  "innerFeeComponents": [],
  "innerCharge": 10.5,
  "outerFeeComponents": [],
  "outerCharge": 10.5,
  "tickets": [
    {
      "type": "ticket",
      "_id": "string",
      "name": "string",
      "amount": 1,
      "netPrice": 10.5,
      "price": 10.5,
      "taxRate": 10.5,
      "triggeredBy": "string",
      "bundleInfo": {
        "bundleId": "string",
        "componentId": "string",
        "optionId": "string"
      },
      "ticketTypeId": "string",
      "categoryRef": "string",
      "seatingInfo": {
        "_id": "string",
        "_type": 6,
        "categoryId": "string",
        "statusId": "string",
        "name": "string",
        "seatType": "handicapped",
        "sectionName": "string",
        "groupName": "string",
        "rowName": "string",
        "seatName": "string",
        "gate": "string"
      },
      "asHardTicket": true,
      "triggeredAutomations": true,
      "meta": {}
    }
  ],
  "products": [
    {
      "type": "product",
      "_id": "string",
      "name": "string",
      "amount": 1,
      "netPrice": 10.5,
      "price": 10.5,
      "taxRate": 10.5,
      "triggeredBy": "string",
      "bundleInfo": {
        "bundleId": "string",
        "componentId": "string",
        "optionId": "string"
      },
      "productVariantId": "string",
      "isFulfillable": true
    }
  ],
  "additionalItems": [],
  "extraFields": {},
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "secret": "string",
  "transactionId": "string",
  "outcome": {
    "checkoutId": "string"
  },
  "restrictedCompletion": [
    "POS"
  ],
  "cancellationStrategy": "cancellationAllowed",
  "seatingReservationToken": "string",
  "salesChannelId": "string",
  "meta": {},
  "history": [],
  "deposit": {
    "amount": 10.5,
    "paymentId": "string",
    "balanceTransactionId": "string"
  },
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "__v": 1
}

Get all PurchaseIntents

Query

customerId

Optional

string

The customer id to filter for

status

Optional

string

The status to filter for

approvalStatus

Optional

string

The approval status to filter for

name

Optional

string

The name to filter for

eventId

Optional

string

The event id to filter for

shopId

Optional

string

The secret shop id to filter for

createdAtStart

Optional

string

An ISO timestamp from which to filter for

createdAtEnd

Optional

string

An ISO timestamp until which to filter for

top

Optional

integer

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

skip

Optional

integer

The number of objects to skip for the requested result

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "rows": [
    {
      "_id": "string",
      "status": "new",
      "approvalStatus": "awaiting",
      "rejectionReason": "string",
      "company": "string",
      "firstname": "string",
      "lastname": "string",
      "name": "string",
      "email": "[email protected]",
      "customerId": "string",
      "address": {
        "street": "string",
        "line2": "string",
        "postal": "string",
        "city": "string",
        "country": "string",
        "state": "string"
      },
      "deliveryAddress": {
        "street": "string",
        "line2": "string",
        "postal": "string",
        "city": "string",
        "country": "string",
        "state": "string",
        "name": "string"
      },
      "sellerId": "string",
      "eventId": "string",
      "shopId": "string",
      "strategyId": "string",
      "vouchers": [
        "string"
      ],
      "appliedCoupons": [
        []
      ],
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "currency": "EUR",
      "innerFeeComponents": [],
      "innerCharge": 10.5,
      "outerFeeComponents": [],
      "outerCharge": 10.5,
      "tickets": [
        {
          "type": "ticket",
          "_id": "string",
          "name": "string",
          "amount": 1,
          "netPrice": 10.5,
          "price": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "string",
            "componentId": "string",
            "optionId": "string"
          },
          "ticketTypeId": "string",
          "categoryRef": "string",
          "seatingInfo": {
            "_id": "string",
            "_type": 6,
            "categoryId": "string",
            "statusId": "string",
            "name": "string",
            "seatType": "handicapped",
            "sectionName": "string",
            "groupName": "string",
            "rowName": "string",
            "seatName": "string",
            "gate": "string"
          },
          "asHardTicket": true,
          "triggeredAutomations": true,
          "meta": {}
        }
      ],
      "products": [
        {
          "type": "product",
          "_id": "string",
          "name": "string",
          "amount": 1,
          "netPrice": 10.5,
          "price": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "string",
            "componentId": "string",
            "optionId": "string"
          },
          "productVariantId": "string",
          "isFulfillable": true
        }
      ],
      "additionalItems": [],
      "extraFields": {},
      "expiresAt": "2030-01-23T23:00:00.123Z",
      "secret": "string",
      "transactionId": "string",
      "outcome": {
        "checkoutId": "string"
      },
      "restrictedCompletion": [
        "POS"
      ],
      "cancellationStrategy": "cancellationAllowed",
      "seatingReservationToken": "string",
      "salesChannelId": "string",
      "meta": {},
      "history": [],
      "deposit": {
        "amount": 10.5,
        "paymentId": "string",
        "balanceTransactionId": "string"
      },
      "createdAt": "2030-01-23T23:00:00.123Z",
      "updatedAt": "2030-01-23T23:00:00.123Z",
      "__v": 1
    }
  ],
  "total": 1
}

Set approval status

Payload

Optional Attributes

Collapse all

approvalStatus

Optional

string

awaitingapprovedrejected

rejectionReason

Optional

string

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "approvalStatus": "awaiting",
  "rejectionReason": "string"
}

{
  "_id": "string",
  "status": "new",
  "approvalStatus": "awaiting",
  "rejectionReason": "string",
  "company": "string",
  "firstname": "string",
  "lastname": "string",
  "name": "string",
  "email": "[email protected]",
  "customerId": "string",
  "address": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string"
  },
  "deliveryAddress": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "string"
  },
  "sellerId": "string",
  "eventId": "string",
  "shopId": "string",
  "strategyId": "string",
  "vouchers": [
    "string"
  ],
  "appliedCoupons": [
    []
  ],
  "regularPrice": 10.5,
  "realPrice": 10.5,
  "currency": "EUR",
  "innerFeeComponents": [],
  "innerCharge": 10.5,
  "outerFeeComponents": [],
  "outerCharge": 10.5,
  "tickets": [
    {
      "type": "ticket",
      "_id": "string",
      "name": "string",
      "amount": 1,
      "netPrice": 10.5,
      "price": 10.5,
      "taxRate": 10.5,
      "triggeredBy": "string",
      "bundleInfo": {
        "bundleId": "string",
        "componentId": "string",
        "optionId": "string"
      },
      "ticketTypeId": "string",
      "categoryRef": "string",
      "seatingInfo": {
        "_id": "string",
        "_type": 6,
        "categoryId": "string",
        "statusId": "string",
        "name": "string",
        "seatType": "handicapped",
        "sectionName": "string",
        "groupName": "string",
        "rowName": "string",
        "seatName": "string",
        "gate": "string"
      },
      "asHardTicket": true,
      "triggeredAutomations": true,
      "meta": {}
    }
  ],
  "products": [
    {
      "type": "product",
      "_id": "string",
      "name": "string",
      "amount": 1,
      "netPrice": 10.5,
      "price": 10.5,
      "taxRate": 10.5,
      "triggeredBy": "string",
      "bundleInfo": {
        "bundleId": "string",
        "componentId": "string",
        "optionId": "string"
      },
      "productVariantId": "string",
      "isFulfillable": true
    }
  ],
  "additionalItems": [],
  "extraFields": {},
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "secret": "string",
  "transactionId": "string",
  "outcome": {
    "checkoutId": "string"
  },
  "restrictedCompletion": [
    "POS"
  ],
  "cancellationStrategy": "cancellationAllowed",
  "seatingReservationToken": "string",
  "salesChannelId": "string",
  "meta": {},
  "history": [],
  "deposit": {
    "amount": 10.5,
    "paymentId": "string",
    "balanceTransactionId": "string"
  },
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "__v": 1
}

Cancel a purchase intent

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "_id": "string",
  "status": "new",
  "approvalStatus": "awaiting",
  "rejectionReason": "string",
  "company": "string",
  "firstname": "string",
  "lastname": "string",
  "name": "string",
  "email": "[email protected]",
  "customerId": "string",
  "address": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string"
  },
  "deliveryAddress": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "string"
  },
  "sellerId": "string",
  "eventId": "string",
  "shopId": "string",
  "strategyId": "string",
  "vouchers": [
    "string"
  ],
  "appliedCoupons": [
    []
  ],
  "regularPrice": 10.5,
  "realPrice": 10.5,
  "currency": "EUR",
  "innerFeeComponents": [],
  "innerCharge": 10.5,
  "outerFeeComponents": [],
  "outerCharge": 10.5,
  "tickets": [
    {
      "type": "ticket",
      "_id": "string",
      "name": "string",
      "amount": 1,
      "netPrice": 10.5,
      "price": 10.5,
      "taxRate": 10.5,
      "triggeredBy": "string",
      "bundleInfo": {
        "bundleId": "string",
        "componentId": "string",
        "optionId": "string"
      },
      "ticketTypeId": "string",
      "categoryRef": "string",
      "seatingInfo": {
        "_id": "string",
        "_type": 6,
        "categoryId": "string",
        "statusId": "string",
        "name": "string",
        "seatType": "handicapped",
        "sectionName": "string",
        "groupName": "string",
        "rowName": "string",
        "seatName": "string",
        "gate": "string"
      },
      "asHardTicket": true,
      "triggeredAutomations": true,
      "meta": {}
    }
  ],
  "products": [
    {
      "type": "product",
      "_id": "string",
      "name": "string",
      "amount": 1,
      "netPrice": 10.5,
      "price": 10.5,
      "taxRate": 10.5,
      "triggeredBy": "string",
      "bundleInfo": {
        "bundleId": "string",
        "componentId": "string",
        "optionId": "string"
      },
      "productVariantId": "string",
      "isFulfillable": true
    }
  ],
  "additionalItems": [],
  "extraFields": {},
  "expiresAt": "2030-01-23T23:00:00.123Z",
  "secret": "string",
  "transactionId": "string",
  "outcome": {
    "checkoutId": "string"
  },
  "restrictedCompletion": [
    "POS"
  ],
  "cancellationStrategy": "cancellationAllowed",
  "seatingReservationToken": "string",
  "salesChannelId": "string",
  "meta": {},
  "history": [],
  "deposit": {
    "amount": 10.5,
    "paymentId": "string",
    "balanceTransactionId": "string"
  },
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "__v": 1
}

The Purchase Intent Strategy object

Attributes

name

Required

string

Name of the strategy

availabilityStrategy

Required

One of

Only one of the following types

availabilityStrategy.createTickets

Required

boolean

availabilityStrategy.checkAvailability

Required

boolean

Whether the availability of the requested tickets should be checked when creating a purchase intent

availabilityStrategy.withoutSeats

Required

boolean

availabilityStrategy.createValidTickets

Required

boolean

expirationStrategy

Required

object

Optional Attributes

Collapse all

expirationStrategy.hoursBeforeEvent

Optional

number float

Purchase intents are only valid outside of the defined period before the event

expirationStrategy.hoursAfterCreation

Optional

number float

Purchase intents are only valid in the defined period after creation

expirationStrategy.expiresAt

Optional

string date-time

Purchase intents are only valid until the defined date

needsApproval

Required

boolean

Purchase intent needs approval of the seller before considered valid

sellerId

Required

string

The ID of the seller of the strategy

Optional Attributes

Collapse all

deposit

Optional

object

deposit.method

Required

string

Optional Attributes

Collapse all

deposit.value

Optional

number float

restrictedCompletion

Optional

array<string>

Specifies how the customer can complete their purchase intent

cancellationStrategy

Optional

string

notAllowedcancellationAllowed

createdAt

Optional

string date-time

An ISO timestamp indicating when the strategy was created

updatedAt

Optional

string date-time

An ISO timestamp indicating when the strategy was updated

Was this section helpful?

Yes No

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

Create PurchaseIntent Strategies

Payload

name

Required

string

Name of the strategy

availabilityStrategy

Required

One of

Only one of the following types

availabilityStrategy.createTickets

Required

boolean

availabilityStrategy.checkAvailability

Required

boolean

Whether the availability of the requested tickets should be checked when creating a purchase intent

availabilityStrategy.withoutSeats

Required

boolean

availabilityStrategy.createValidTickets

Required

boolean

expirationStrategy

Required

object

Optional Attributes

Collapse all

expirationStrategy.hoursBeforeEvent

Optional

number float

Purchase intents are only valid outside of the defined period before the event

expirationStrategy.hoursAfterCreation

Optional

number float

Purchase intents are only valid in the defined period after creation

expirationStrategy.expiresAt

Optional

string date-time

Purchase intents are only valid until the defined date

needsApproval

Required

boolean

Purchase intent needs approval of the seller before considered valid

Optional Attributes

Collapse all

deposit

Optional

object

deposit.method

Required

string

Optional Attributes

Collapse all

deposit.value

Optional

number float

restrictedCompletion

Optional

array<string>

Specifies how the customer can complete their purchase intent

cancellationStrategy

Optional

string

notAllowedcancellationAllowed

201

Created

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "name": "string",
  "availabilityStrategy": {
    "createTickets": true,
    "checkAvailability": true,
    "createValidTickets": true
  },
  "expirationStrategy": {
    "hoursBeforeEvent": 10.5,
    "hoursAfterCreation": 10.5,
    "expiresAt": "2030-01-23T23:00:00.123Z"
  },
  "needsApproval": true,
  "deposit": {
    "method": "string",
    "value": 10.5
  },
  "restrictedCompletion": [
    "POS"
  ],
  "cancellationStrategy": "cancellationAllowed"
}

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

Get a PurchaseIntent Strategy

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

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

Update a PurchaseIntent Strategy

Payload

Optional Attributes

Collapse all

name

Optional

string

Name of the strategy

availabilityStrategy

Optional

One of

Only one of the following types

availabilityStrategy.createTickets

Required

boolean

availabilityStrategy.checkAvailability

Required

boolean

Whether the availability of the requested tickets should be checked when creating a purchase intent

availabilityStrategy.withoutSeats

Required

boolean

availabilityStrategy.createValidTickets

Required

boolean

expirationStrategy

Optional

object

Optional Attributes

Collapse all

expirationStrategy.hoursBeforeEvent

Optional

number float

Purchase intents are only valid outside of the defined period before the event

expirationStrategy.hoursAfterCreation

Optional

number float

Purchase intents are only valid in the defined period after creation

expirationStrategy.expiresAt

Optional

string date-time

Purchase intents are only valid until the defined date

needsApproval

Optional

boolean

Purchase intent needs approval of the seller before considered valid

deposit

Optional

object

deposit.method

Required

string

Optional Attributes

Collapse all

deposit.value

Optional

number float

restrictedCompletion

Optional

array<string>

Specifies how the customer can complete their purchase intent

cancellationStrategy

Optional

string

notAllowedcancellationAllowed

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "name": "string",
  "availabilityStrategy": {
    "createTickets": true,
    "checkAvailability": true,
    "createValidTickets": true
  },
  "expirationStrategy": {
    "hoursBeforeEvent": 10.5,
    "hoursAfterCreation": 10.5,
    "expiresAt": "2030-01-23T23:00:00.123Z"
  },
  "needsApproval": true,
  "deposit": {
    "method": "string",
    "value": 10.5
  },
  "restrictedCompletion": [
    "POS"
  ],
  "cancellationStrategy": "cancellationAllowed"
}

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