Skip to main content
API docs by Redocly

Legacy API (1.0.0)

Download OpenAPI specification:Download

URL: https://www.paciolan.com/ License: Paciolan ®

Legacy API specs

Catalog Service

Retrieve catalog items

The items endpoint returns a collection of items currently available for the specified sales policy.

N.B., The object returned is of the summaryItem class; to retrieve a complete item object, use the /catalog/item endpoint.

query Parameters
policyCode
string

Policy (control) code governing the sales policy for the requestor. If no other parameters are specified, all items listed in the policy will be returned, regardless of sales status.

startDate
string <date-time>

Start date in YYYY-MM-DDThh:mm:ssZ or YYYY-MM-DDThh:mm:ss±hh:mm format. Applicable to event items only. When specified, only those events with a start date on or after this date will be returned.

seasonCode
Array of strings

A season code may be specified to further filter output. This parameter may be repeated; when so done, the values will be logically OR'd.

facilityCode
string

A (single) facility code may be specified to further filter output.

itemBasis
string

An item basis may be specified to further filter output. Valid values are SINGLE, COMBO, MISCELLANEOUS, DONATION or GIFT_CERTIFICATE.

header Parameters
Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Responses

Request samples 

curl -X GET "https://connect-qfnq.paciolan.info/pdi/v1/catalog/items?policyCode=myPolicyCode&startDate=2023-08-15T00:00:00Z&seasonCode=season1&seasonCode=season2&facilityCode=myFacility&itemBasis=SINGLE" \
  -H "Accept: application/json" \
  -H "Accept-Encoding: gzip" \
  -H "User-Agent: YourApplication/1.0.0" \
  -H "PAC-API-Key: YOUR_API_KEY" \
  -H "PAC-Application-ID: reverse.domain.appid" \
  -H "PAC-Channel-Code: channelcode" \
  -H "PAC-Organization-ID: 12345"

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Retrieve catalog item by season and item code

The item details endpoint returns detailed item information for the requested item, as permitted by the specified sales policy.

path Parameters
season_code
required
string

Season code for the requested item.

item_code
required
string

Item code for the requested item.

query Parameters
policyCode
required
string

Policy (control) code governing the sales policy for the requestor.

header Parameters
Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Responses

Request samples 

curl -X GET "https://connect-qfnq.paciolan.info/pdi/v1/catalog/{season_code}/{item_code}?policyCode=myPolicyCode" \
  -H "Accept: application/json" \
  -H "Accept-Encoding: gzip" \
  -H "User-Agent: YourApplication/1.0.0" \
  -H "PAC-API-Key: YOUR_API_KEY" \
  -H "PAC-Application-ID: reverse.domain.appid" \
  -H "PAC-Channel-Code: channelcode" \
  -H "PAC-Organization-ID: 12345"

Response samples

Content type
application/json
{
  • "activity": {
    },
  • "season": {
    },
  • "code": "FB01",
  • "basis": "SINGLE",
  • "name": "Football Game 1",
  • "eventName": "",
  • "internetName": "",
  • "type": {
    },
  • "eventGroup": {
    },
  • "facility": {
    },
  • "configuration": {
    },
  • "priceTable": {
    },
  • "itemGroups": [
    ],
  • "class": {
    },
  • "startDate": "",
  • "endDate": "",
  • "onSale": true,
  • "nonAllocatable": {
    },
  • "keywords": [
    ],
  • "offers": [
    ]
}

Inventory Service

Retrieve inventory availability by season and item code

The availability endpoint returns summary availability information for the requested event (item code), as permitted by the specified sales policy.

path Parameters
season_code
required
string

Season code for the requested item.

item_code
required
string

Item code for the requested item.

query Parameters
policyCode
required
string

Policy (control) code governing the sales policy for the requestor.

seatStatusCode
string

Seat status code. When omitted, the availability response reflects all seat statuses the requestor has access to.

priceLevelsOnly
boolean

When true, omits sections from response (default is false).

header Parameters
Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Responses

Request samples 

curl -X GET "https://example.com/pdi/inventory/availability/{season_code}/{item_code}?policyCode=myPolicyCode&seatStatusCode=available&priceLevelsOnly=true" \
  -H "Accept: application/json" \
  -H "Accept-Encoding: gzip" \
  -H "User-Agent: YourApplication/1.0.0" \
  -H "PAC-API-Key: YOUR_API_KEY" \
  -H "PAC-Application-ID: reverse.domain.appid" \
  -H "PAC-Channel-Code: channelcode" \
  -H "PAC-Organization-ID: 12345"

Response samples

Content type
application/json
{
  • "season": {
    },
  • "item": {
    },
  • "availability": 1000,
  • "priceLevels": [
    ]
}

Retrieve inventory status by season and item code

The status endpoint returns seat status information for the requested event (item code) and section(s).

❗️ URL Encoding

Please ensure that all requests are properly URL encoded; i.e., all level:section values are properly URL encoded as level%3Asection.

❗️ A note on erroneous sections…

Specifying erroneous section(s) in a request will not result in an error; rather, the section(s) will simply not be returned in the response. This is purely for performance purposes.

path Parameters
season_code
required
string

Season code for the requested item.

item_code
required
string

Item code for the requested item.

query Parameters
policyCode
required
string

Policy (control) code governing the sales policy for the requestor.

section
string

One or more sections (level:section) for which seat status information should be returned.

header Parameters
Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Responses

Request samples 

curl -X GET "https://example.com/pdi/inventory/status/{season_code}/{item_code}?policyCode=myPolicyCode&section=level%3Asection" \
  -H "Accept: application/json" \
  -H "Accept-Encoding: gzip" \
  -H "User-Agent: YourApplication/1.0.0" \
  -H "PAC-API-Key: YOUR_API_KEY" \
  -H "PAC-Application-ID: reverse.domain.appid" \
  -H "PAC-Channel-Code: channelcode" \
  -H "PAC-Organization-ID: 12345"

Response samples

Content type
application/json
{
  • "season": {
    },
  • "item": {
    },
  • "priceLevels": [
    ]
}

Update seat status

The status (change) endpoint is used to manipulate seat status information for the requested event (item code).

path Parameters
season_code
required
string

Season code for the requested item.

item_code
required
string

Item code for the requested item.

query Parameters
policyCode
required
string

Policy (control) code governing the sales policy for the integrator.

debug
string
Default: "false"
Enum: "false" "true"

Enables detailed response logging. Use only when instructed by Paciolan Developer Support.

header Parameters
Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Request Body schema: application/json
Array
Array
section
string
Array of objects
seatStatus
string

Responses

Request samples

Content type
application/json
[
  • [
    ]
]

Response samples

Content type
application/json
{
  • "exceptions": [
    ],
  • "seatsUpdated": 2
}

Cart Service

Create a new cart

The create cart endpoint is used to create a new shopping cart by adding requesting a ticket offer (absent an existing cart ID).

query Parameters
policyCode
required
string

Policy (control) code governing the sales policy for the requestor.

header Parameters
Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

Content-Type
required
string
Default: application/json

The only supported request type for this endpoint is application/json.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Request Body schema: application/json
required
Schema not provided

Responses

Request samples 

curl -X POST "https://example.com/pdi/v:version/cart?policyCode=myPolicyCode" \
  -H "Accept: application/json" \
  -H "Accept-Encoding: gzip" \
  -H "Content-Type: application/json" \
  -H "User-Agent: YourApplication/1.0.0" \
  -H "PAC-API-Key: YOUR_API_KEY" \
  -H "PAC-Application-ID: reverse.domain.appid" \
  -H "PAC-Channel-Code: channelcode" \
  -H "PAC-Organization-ID: 12345"

Get cart by ID

The get cart endpoint is used to retrieve an existing cart.

The HTTP HEAD verb is also supported for this endpoint.

path Parameters
cart_id
required
string

The cart ID to be retrieved.

query Parameters
policyCode
required
string

Policy (control) code governing the sales policy for the requestor.

header Parameters
Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Responses

Request samples 

curl -X GET "https://example.com/pdi/v:version/cart/cart123?policyCode=myPolicyCode" \
  -H "Accept: application/json" \
  -H "Accept-Encoding: gzip" \
  -H "User-Agent: YourApplication/1.0.0" \
  -H "PAC-API-Key: YOUR_API_KEY" \
  -H "PAC-Application-ID: reverse.domain.appid" \
  -H "PAC-Channel-Code: channelcode" \
  -H "PAC-Organization-ID: 12345"

Response samples

Content type
application/json
{
  • "ID": 324139,
  • "account": "a",
  • "expiration": "2019-04-03T20:28:31Z",
  • "balance": 54,
  • "paid": 0,
  • "value": 54,
  • "comments": null,
  • "tags": [ ],
  • "offers": [
    ],
  • "charges": [
    ],
  • "userDefinedFields": [ ],
  • "saleCode": {
    },
  • "availableMarkCodes": [
    ],
  • "availableSurcharges": [
    ],
  • "availablePaymentMethods": [
    ],
  • "availableDeliveryMethods": [
    ],
  • "orders": [ ],
  • "transactions": [ ]
}

Delete a cart by ID

The delete cart endpoint is used to cancel a pending transaction. When a cart is deleted, all offers contained in the cart are cancelled, any related seats on counter hold are returned to available inventory and no financial transaction(s) are written to the back office ticketing system. No permanent record of the cart is persisted.

path Parameters
cart_id
required
integer

The cart ID to be deleted.

query Parameters
policyCode
required
string

Policy (control) code governing the sales policy for the requestor.

header Parameters
Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

If-Unmodified-Since
string <date-time>
Example: 2023-06-14T07:23:05.281+0000

The date/time value, in HTTP-date format, returned from the Last-Modified header from the last cart response.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Responses

Request samples 

curl -X DELETE "https://example.com/pdi/v{version}/cart/{cart_id}?policyCode=myPolicyCode" \
  -H "Accept: application/json" \
  -H "Accept-Encoding: gzip" \
  -H "If-Unmodified-Since: Wed, 11 Aug 2023 00:00:00 GMT" \
  -H "User-Agent: YourApplication/1.0.0" \
  -H "PAC-API-Key: YOUR_API_KEY" \
  -H "PAC-Application-ID: reverse.domain.appid" \
  -H "PAC-Channel-Code: channelcode" \
  -H "PAC-Organization-ID: 12345"

Complete cart checkout

The checkout API endpoint commits a cart to a sale and records a financial transaction.

path Parameters
cart_id
required
string

The cart ID of the pending cart to be completed.

query Parameters
policyCode
required
string

Policy (control) code governing the sales policy for the requestor.

header Parameters
Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

If-Unmodified-Since
string <date-time>
Example: 2023-06-14T07:23:05.281+0000

The date/time value, in HTTP-date format, returned from the Last-Modified header from the last cart response.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Request Body schema: application/json
required
required
object

Patron (may be null if permitted by policy). If null, the resultant transaction will be associated with a house account (i.e., an anonymous transaction).

account
required
string or null

Patron account. When a non-null value is provided, address, phoneNumber and emailAddress must be null. Used to associate the cart with an existing patron account.

lastName
string

Patron last name. Either patron last name or company name are required if a patron account number is not provided. Applicable to non-organization patron types.

firstName
string

Patron first name. Applicable to non-organization patron types.

middleInitial
string

Patron middle initial. Applicable to non-organization patron types.

companyName
string

Patron company name. Applicable to organization patron types.

isOrganization
boolean

Boolean to indicate if patron account is an organization patron type.

object

Patron address may be required based on policy.

type
required
string or null

Patron address type. If null, the policy default will be used.

address1
required
string

Patron address 1 is required if patron address is required.

address2
string

Patron address 2

address3
string

Patron address 3 (mapped to in care of in the back office)

address4
string

Patron address 4 (mapped to international address line in the back office)

locality
required
string

Patron address locality (city for most locales) is required if patron address is required.

region
required
string

Patron address region (state/province for most locales) is required if patron address is required.

postalCode
required
string

Patron postal code. Required if patron address is required.

countryCode
required
string

Patron address country code is required if patron address is required.

object

Patron phone number may be required based on policy.

type
required
string or null

Patron phone type. If null, the policy default will be used.

number
required
string

Patron phone number, unformatted, with all non-numeric characters removed. This field is required if phone number is required by policy.

formattedNumber
string

Patron phone number, formatted.

extension
string

Patron phone number extension.

countryCode
required
string

Patron phone number country code. This field is required if phone number is required by policy.

object

Patron email address. Required when creating a new patron account.

type
required
string or null

Patron email address type. If null, the policy default will be used.

address
required
string

Patron email address.

comments
string

Cart (order) comments. N.B., A single cart may result in multiple orders, thus comments may be duplicated across seasons/orders.

tags
Array of strings

Cart (order) tags. N.B., A single cart may result in multiple orders, thus tags may be duplicated across seasons/orders.

Array of objects

Collection of user-defined fields. Please consult with your client before implementing this property.

Array
index
number

User defined field index (1-9)

value
string

User defined field value

required
object

Delivery information

method
required
string

Delivery method (disposition)

emailAddress
string

Delivery email address (required for print at home or mobile deliveries)

ID
string

ID (required for card-based deliveries)

Array of objects

Collection of payments. Required for carts with a balance greater than zero.

Array
paymentMethod
required
string

Payment method (paymode)

cardholderName
string

Cardholder name. Required for card-based payments.

accountNumber
string

Card account number (PAN), unformatted, without spaces/dashes, numbers only. Required for card-based payments.

documentNumber
string

Document number. Required for gift certificate payments.

expirationMonth
number

Card expiration month. Required for card-based payments.

expirationYear
number

Card expiration year. Required for card-based payments.

cardVerificationNumber
number

Card verification number. Required for card-based payments.

billingAddress
string

Card billing address. Required for card-based payments.

billingPostalCode
string

Card billing postal code. Required for card-based payments.

billingCountryCode
string

Card billing country code. Required for card-based payments.

amount
number

Payment amount.

routingNumber
string

Routing number. Required for electronic check payments.

bankAccountNumber
string

Bank account number. Required for electronic check payments.

amount
required
number

Payment amount.

routingNumber
string

Routing number. Required for electronic check payments.

bankAccountNumber
string

Bank account number. Required for electronic check payments.

Responses

Request samples

Content type
application/json
{
  • "patron": {
    },
  • "comments": "string",
  • "tags": [
    ],
  • "userDefinedFields": [
    ],
  • "delivery": {
    },
  • "payments": [
    ],
  • "amount": 0,
  • "routingNumber": "string",
  • "bankAccountNumber": "string"
}

Response samples

Content type
application/json
{
  • "ID": 324139,
  • "account": "a",
  • "expiration": "2019-04-03T20:28:31Z",
  • "balance": 54,
  • "paid": 0,
  • "value": 54,
  • "comments": null,
  • "tags": [ ],
  • "offers": [
    ],
  • "charges": [
    ],
  • "userDefinedFields": [ ],
  • "saleCode": {
    },
  • "availableMarkCodes": [
    ],
  • "availableSurcharges": [
    ],
  • "availablePaymentMethods": [
    ],
  • "availableDeliveryMethods": [
    ],
  • "orders": [ ],
  • "transactions": [ ]
}

Create offer in cart

The add offer endpoint is used add an offer to an existing cart.

📘 Non-Allocatable Items

To request an offer for non-allocatable items, the seats collection must be omitted​.

example:

{
  "seasonCode": "FB16",
  "itemCode": "HOTDOG",
  "quantity": 1
}
path Parameters
cart_id
required
string

The cart ID of the cart to be modified.

query Parameters
policyCode
required
string

Policy (control) code governing the sales policy for the requestor.

header Parameters
Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

If-Unmodified-Since
string <date-time>
Example: 2023-06-14T07:23:05.281+0000

The date/time value, in HTTP-date format, returned from the Last-Modified header from the last cart response.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Request Body schema: application/json
required
seasonCode
required
string

Season code

itemCode
required
string

Item code

quantity
required
number

Quantity

referralSource
string

Marketing referral source

referralData
string

Marketing referral data

associatedCustomer
string

Associated customer (used to specify an alternate delivery customer for this offer)

willCallCustomer
string

Will call customer (used to specify an alternate will call customer for this offer)

markCode
string

Mark Code

itemPriority
number

Item priority

note
string

Offer note

Array of objects

Collection of seats (required for allocatable items, omitted for non-allocatable items)

Array
priceLevel
required
number

Price level

priceType
required
string

Price type

section
required
string or null

Section (level:section), must be null for "best available" requests

row
required
string or null

Row, must be null for "best available" requests

seat
required
string or null

Seat, must be null for "best available" requests

Responses

Request samples

Content type
application/json
{
  • "seasonCode": "string",
  • "itemCode": "string",
  • "quantity": 0,
  • "referralSource": "string",
  • "referralData": "string",
  • "associatedCustomer": "string",
  • "willCallCustomer": "string",
  • "markCode": "string",
  • "itemPriority": 0,
  • "note": "string",
  • "seats": [
    ]
}

Response samples

Content type
application/json
{
  • "ID": 324139,
  • "account": "a",
  • "expiration": "2019-04-03T20:28:31Z",
  • "balance": 54,
  • "paid": 0,
  • "value": 54,
  • "comments": null,
  • "tags": [ ],
  • "offers": [
    ],
  • "charges": [
    ],
  • "userDefinedFields": [ ],
  • "saleCode": {
    },
  • "availableMarkCodes": [
    ],
  • "availableSurcharges": [
    ],
  • "availablePaymentMethods": [
    ],
  • "availableDeliveryMethods": [
    ],
  • "orders": [ ],
  • "transactions": [ ]
}

Remove offer from cart

The delete offer endpoint is used to remove an offer from an existing cart. When an offer is removed, any related seats on counter hold are returned to available inventory. No permanent record of the offer is persisted.

path Parameters
cart_id
required
string

The cart ID of the cart to be modified.

offer_id
required
string

The offer ID of the offer to be removed.

query Parameters
policyCode
required
string

Policy (control) code governing the sales policy for the requestor.

header Parameters
Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

If-Unmodified-Since
string <date-time>
Example: 2023-06-14T07:23:05.281+0000

The date/time value, in HTTP-date format, returned from the Last-Modified header from the last cart response.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

Responses

Request samples 

# Example request to remove an offer from the cart
curl -X DELETE "https://connect.evenue.net/pdi/v{version}/cart/{cart_id}/offers/{offer_id}?policyCode=myPolicyCode" \
  -H "Accept: application/json" \
  -H "If-Unmodified-Since: Wed, 11 Aug 2023 00:00:00 GMT" \
  -H "User-Agent: YourApplication/1.0.0" \
  -H "PAC-API-Key: YOUR_API_KEY" \
  -H "PAC-Application-ID: reverse.domain.appid" \
  -H "PAC-Channel-Code: channelcode"

Modify offer in cart

The update offer endpoint is used to update an existing offer. The PATCH method is used to communicate a differential (partial) update. Alternately, the PUT method is also supported.

📘 Modifying Offers

A successful request to modify a cart offer will return an updated cart object in the response.

path Parameters
cart_id
required
string

The cart ID of the cart to be modified.

offer_id
required
string

The offer ID of the offer to be modified.

query Parameters
policyCode
required
string

Policy (control) code governing the sales policy for the requestor.

header Parameters
Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Content-Type
required
string
Default: application/json

The only supported request type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

If-Unmodified-Since
string <date-time>
Example: 2023-06-14T07:23:05.281+0000

The date/time value, in HTTP-date format, returned from the Last-Modified header from the last cart response.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Request Body schema: application/json
required
itemCode
string

Item code

Responses

Request samples

Content type
application/json
{
  • "itemCode": "string"
}

Response samples

Content type
application/json
{
  • "ID": 324139,
  • "account": "a",
  • "expiration": "2019-04-03T20:28:31Z",
  • "balance": 54,
  • "paid": 0,
  • "value": 54,
  • "comments": null,
  • "tags": [ ],
  • "offers": [
    ],
  • "charges": [
    ],
  • "userDefinedFields": [ ],
  • "saleCode": {
    },
  • "availableMarkCodes": [
    ],
  • "availableSurcharges": [
    ],
  • "availablePaymentMethods": [
    ],
  • "availableDeliveryMethods": [
    ],
  • "orders": [ ],
  • "transactions": [ ]
}

Modify offer in cart

The update offer endpoint is used to update an existing offer. The PUT method is used to communicate a complete (replacement) update. Alternately, the PATCH method is also supported - and the preferred mechanism by which to update cart offers.

📘 Modifying Offers

A successful request to modify a cart offer will return an updated cart object in the response.

path Parameters
cart_id
required
string

The cart ID of the cart to be modified.

offer_id
required
string

The offer ID of the offer to be modified.

query Parameters
policyCode
required
string

Policy (control) code governing the sales policy for the requestor.

header Parameters
Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

Content-Type
required
string
Default: application/json

The only supported request type for this endpoint is application/json.

If-Unmodified-Since
string <date-time>
Example: 2023-06-14T07:23:05.281+0000

The date/time value, in HTTP-date format, returned from the Last-Modified header from the last cart response.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Request Body schema: application/json
required
itemCode
string

Item code

Responses

Request samples

Content type
application/json
{
  • "itemCode": "string"
}

Response samples

Content type
application/json
{
  • "ID": 324139,
  • "account": "a",
  • "expiration": "2019-04-03T20:28:31Z",
  • "balance": 54,
  • "paid": 0,
  • "value": 54,
  • "comments": null,
  • "tags": [ ],
  • "offers": [
    ],
  • "charges": [
    ],
  • "userDefinedFields": [ ],
  • "saleCode": {
    },
  • "availableMarkCodes": [
    ],
  • "availableSurcharges": [
    ],
  • "availablePaymentMethods": [
    ],
  • "availableDeliveryMethods": [
    ],
  • "orders": [ ],
  • "transactions": [ ]
}

Ticket Service

Get ticket information

Retrieve information about a specific ticket based on its ID.

The get ticket endpoint returns ticket information for the specified ticket. The purpose of this endpoint is not to replace or supplement the (re)print endpoint(s); print attributes will not be returned by this service; neither is purpose of this endpoint to replace the (planned) patron and/or order API(s); the purpose of this API is to solely to allow integrators to retrieve detailed information about ticket(s) - which may further inform downstream API calls.

N.B., The HEAD HTTP method is also supported for this endpoint.

📘 Errata

  • Response compression is supported.
path Parameters
ticket_id
required
integer

The ID of the ticket to retrieve information for.

header Parameters
Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Responses

Request samples 

# Example request to get ticket information
curl -X GET "https://connect.evenue.net/pdi/v{version}/tickets/{ticket_id}" \
  -H "Accept: application/json" \
  -H "Accept-Encoding: gzip" \
  -H "User-Agent: YourApplication/1.0.0" \
  -H "PAC-API-Key: YOUR_API_KEY" \
  -H "PAC-Application-ID: reverse.domain.appid" \
  -H "PAC-Channel-Code: channelcode" \
  -H "PAC-Organization-ID: 12345"

Response samples

Content type
application/json
{
  • "ticketID": "1234567890123456",
  • "activity": "FB",
  • "season": "FB16",
  • "itemBasis": "COMBO",
  • "item": "FS16",
  • "event": "FB01",
  • "account": "23456789",
  • "customerBasis": "INDIVIDUAL",
  • "isOrganization": true,
  • "companyName": null,
  • "lastName": "Avalos",
  • "firstName": "Marty",
  • "associatedCustomer": null,
  • "barcode": "75813167566966",
  • "barcodeStatus": "VALID",
  • "isPrinted": true,
  • "isScanned": true,
  • "priceLevel": 1,
  • "priceType": "ADULT",
  • "priceTypeName": "Adult Ticket",
  • "seatingType": "RESERVED",
  • "section": "U:100",
  • "row": "AA",
  • "seat": "14",
  • "price": 1.23,
  • "itemCharge": null,
  • "itemChargeAmount": 0,
  • "itemFee": null,
  • "itemFeeAmount": 0,
  • "itemDiscount": null,
  • "itemDiscountAmount": 0,
  • "itemSurcharge": null,
  • "itemSurchargeAmount": 0,
  • "extendedPrice": 1.23,
  • "itemBalance": 0,
  • "itemOrderDate": "2016-11-23",
  • "itemPriority": 0,
  • "locationPreference": null,
  • "billPlan": null,
  • "mark": null,
  • "specialHandling": null,
  • "promoCode": null,
  • "isRrenewable": true,
  • "hasPendingPostSaleActivity": false,
  • "referralSource": null,
  • "referralData": null,
  • "groupCode": null,
  • "previousSeatStatus": "O",
  • "willCallCustomer": "12345678"
}

Get ticket information by barcode

Retrieve information about a specific ticket based on its barcode ID.

📘 Errata

  • Response compression is supported.
path Parameters
barcode
required
integer

The barcode ID of the ticket to retrieve information for.

header Parameters
Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Responses

Request samples 

# Example request to get ticket information by barcode
curl -X GET "https://connect.evenue.net/pdi/v{version}/tickets/barcode/{barcode}" \
  -H "Accept: application/json" \
  -H "Accept-Encoding: gzip" \
  -H "User-Agent: YourApplication/1.0.0" \
  -H "PAC-API-Key: YOUR_API_KEY" \
  -H "PAC-Application-ID: reverse.domain.appid" \
  -H "PAC-Channel-Code: channelcode" \
  -H "PAC-Organization-ID: 12345"

Response samples

Content type
application/json
{
  • "ticketID": "1234567890123456",
  • "activity": "FB",
  • "season": "FB16",
  • "itemBasis": "COMBO",
  • "item": "FS16",
  • "event": "FB01",
  • "account": "23456789",
  • "customerBasis": "INDIVIDUAL",
  • "isOrganization": true,
  • "companyName": null,
  • "lastName": "Avalos",
  • "firstName": "Marty",
  • "associatedCustomer": null,
  • "barcode": "75813167566966",
  • "barcodeStatus": "VALID",
  • "isPrinted": true,
  • "isScanned": true,
  • "priceLevel": 1,
  • "priceType": "ADULT",
  • "priceTypeName": "Adult Ticket",
  • "seatingType": "RESERVED",
  • "section": "U:100",
  • "row": "AA",
  • "seat": "14",
  • "price": 1.23,
  • "itemCharge": null,
  • "itemChargeAmount": 0,
  • "itemFee": null,
  • "itemFeeAmount": 0,
  • "itemDiscount": null,
  • "itemDiscountAmount": 0,
  • "itemSurcharge": null,
  • "itemSurchargeAmount": 0,
  • "extendedPrice": 1.23,
  • "itemBalance": 0,
  • "itemOrderDate": "2016-11-23",
  • "itemPriority": 0,
  • "locationPreference": null,
  • "billPlan": null,
  • "mark": null,
  • "specialHandling": null,
  • "promoCode": null,
  • "isRrenewable": true,
  • "hasPendingPostSaleActivity": false,
  • "referralSource": null,
  • "referralData": null,
  • "groupCode": null,
  • "previousSeatStatus": "O",
  • "willCallCustomer": "12345678"
}

Print ticket

Print a specific ticket based on its ticket ID. The print tickets endpoint allows for the fulfillment (printing) of individual tickets.

📘 Errata

  • The endpoint supports multiple media types, which may vary from one client to the next.
  • Media type support is not determined by delivery method (disposition) type, which is a variance from the traditional delivery model supported by our back office product(s).
  • Only those order lines with delivery assignments with a delivery method (disposition) of type traditional may be fulfilled by this API.

Response Object

N.B., Media types application/pdf and application/vnd.apple.pkpass return multi-part reponses, including an application/json payload which includes barcode only. Media type application/vnd.google-apps.pass will return a JSON that contains the jsonwebtoken used to create the Google Pay Pass. The following response object is returned for media type application/json native response(s) only:

path Parameters
ticket_id
required
string

The ticket ID to print.

query Parameters
policyCode
string

Policy (control) code governing the sales policy for the requestor.

format
string
Enum: "DESKTOP" "MOBILE" "BOTH"

Print format for PDF output; applicable for media type application/pdf only.

header Parameters
Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Request Body schema: application/json
Schema not provided

Responses

Request samples 

# Example request to print a ticket by ticket ID
curl -X POST "https://connect.evenue.net/pdi/v{version}/tickets/{ticketID}/print" \
  -H "Accept: application/json" \
  -H "Accept-Encoding: gzip" \
  -H "User-Agent: YourApplication/1.0.0" \
  -H "PAC-API-Key: YOUR_API_KEY" \
  -H "PAC-Application-ID: reverse.domain.appid" \
  -H "PAC-Channel-Code: channelcode" \
  -H "PAC-Organization-ID: 12345"

Response samples

Content type
application/json
{
  • "ticketID": "1234567890123456",
  • "activity": "FB",
  • "season": "FB16",
  • "itemBasis": "COMBO",
  • "item": "FS16",
  • "event": "FB01",
  • "account": "23456789",
  • "customerBasis": "INDIVIDUAL",
  • "isOrganization": true,
  • "companyName": null,
  • "lastName": "Avalos",
  • "firstName": "Marty",
  • "associatedCustomer": null,
  • "barcode": "75813167566966",
  • "barcodeStatus": "VALID",
  • "isPrinted": true,
  • "isScanned": true,
  • "priceLevel": 1,
  • "priceType": "ADULT",
  • "priceTypeName": "Adult Ticket",
  • "seatingType": "RESERVED",
  • "section": "U:100",
  • "row": "AA",
  • "seat": "14",
  • "price": 1.23,
  • "itemCharge": null,
  • "itemChargeAmount": 0,
  • "itemFee": null,
  • "itemFeeAmount": 0,
  • "itemDiscount": null,
  • "itemDiscountAmount": 0,
  • "itemSurcharge": null,
  • "itemSurchargeAmount": 0,
  • "extendedPrice": 1.23,
  • "itemBalance": 0,
  • "itemOrderDate": "2016-11-23",
  • "itemPriority": 0,
  • "locationPreference": null,
  • "billPlan": null,
  • "mark": null,
  • "specialHandling": null,
  • "promoCode": null,
  • "isRrenewable": true,
  • "hasPendingPostSaleActivity": false,
  • "referralSource": null,
  • "referralData": null,
  • "groupCode": null,
  • "previousSeatStatus": "O",
  • "willCallCustomer": "12345678"
}

Reprint ticket

Reprint a specific ticket based on its ticket ID. The reprint tickets endpoint allows for the reprinting of individual tickets.

N.B., Tickets that have been previously printed will be voided and new barcodes will be issued as a result.

📘 Errata

  • The endpoint supports multiple media types, which may vary from one client to the next.
  • Media type support is not determined by delivery method (disposition) type, which is a variance from the traditional delivery model supported by our back office product(s).
  • Only those order lines with delivery assignments with a delivery method (disposition) of type traditional may be reprinted by this API.

Response Object

N.B., Media types application/pdf and application/vnd.apple.pkpass return multi-part reponses, including an application/json payload which includes barcode only. Media type application/vnd.google-apps.pass will return a JSON that contains the jsonwebtoken used to create the Google Pay Pass. The following response object is returned for media type application/json native response(s) only:

path Parameters
ticket_id
required
string

The ticket ID to reprint.

query Parameters
policyCode
string

Policy (control) code governing the sales policy for the requestor.

format
string
Enum: "DESKTOP" "MOBILE" "BOTH"

Print format for PDF output; applicable for media type application/pdf only.

header Parameters
Authorization
required
string
Example: Basic dGVzdDp0ZXN0

Authorization with Basic Auth

Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Request Body schema: application/json
Schema not provided

Responses

Request samples 

# Example request to reprint a ticket by ticket ID
curl -X POST "https://connect.evenue.net/pdi/v{version}/tickets/{ticketID}/reprint" \
  -H "Accept: application/json" \
  -H "Accept-Encoding: gzip" \
  -H "User-Agent: YourApplication/1.0.0" \
  -H "PAC-API-Key: YOUR_API_KEY" \
  -H "PAC-Application-ID: reverse.domain.appid" \
  -H "PAC-Channel-Code: channelcode" \
  -H "PAC-Organization-ID: 12345"

Response samples

Content type
application/json
{
  • "ticketID": "1234567890123456",
  • "activity": "FB",
  • "season": "FB16",
  • "itemBasis": "COMBO",
  • "item": "FS16",
  • "event": "FB01",
  • "account": "23456789",
  • "customerBasis": "INDIVIDUAL",
  • "isOrganization": true,
  • "companyName": null,
  • "lastName": "Avalos",
  • "firstName": "Marty",
  • "associatedCustomer": null,
  • "barcode": "75813167566966",
  • "barcodeStatus": "VALID",
  • "isPrinted": true,
  • "isScanned": true,
  • "priceLevel": 1,
  • "priceType": "ADULT",
  • "priceTypeName": "Adult Ticket",
  • "seatingType": "RESERVED",
  • "section": "U:100",
  • "row": "AA",
  • "seat": "14",
  • "price": 1.23,
  • "itemCharge": null,
  • "itemChargeAmount": 0,
  • "itemFee": null,
  • "itemFeeAmount": 0,
  • "itemDiscount": null,
  • "itemDiscountAmount": 0,
  • "itemSurcharge": null,
  • "itemSurchargeAmount": 0,
  • "extendedPrice": 1.23,
  • "itemBalance": 0,
  • "itemOrderDate": "2016-11-23",
  • "itemPriority": 0,
  • "locationPreference": null,
  • "billPlan": null,
  • "mark": null,
  • "specialHandling": null,
  • "promoCode": null,
  • "isRrenewable": true,
  • "hasPendingPostSaleActivity": false,
  • "referralSource": null,
  • "referralData": null,
  • "groupCode": null,
  • "previousSeatStatus": "O",
  • "willCallCustomer": "12345678"
}

Void a ticket by ticket ID

Void a ticket based on the provided ticket ID.

The void tickets endpoint allows for the voiding of individual single tickets and cancellation of miscellaneous items and gift certificates. N.B., Single event tickets sold as part of a package and combo items cannot be voided.

path Parameters
ticket_id
required
integer

The ticket ID to void.

query Parameters
policyCode
string

Policy (control) code governing the sales policy for the void request.

header Parameters
Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Request Body schema: application/json
Schema not provided

Responses

Request samples 

# Example request to void a ticket by ticket ID
curl -X POST "https://connect.evenue.net/pdi/v{version}/{ticketID}/void" \
  -H "Accept: application/json" \
  -H "Accept-Encoding: gzip" \
  -H "User-Agent: YourApplication/1.0.0" \
  -H "PAC-API-Key: YOUR_API_KEY" \
  -H "PAC-Application-ID: reverse.domain.appid" \
  -H "PAC-Channel-Code: channelcode" \
  -H "PAC-Organization-ID: 12345"

Response samples

Content type
application/json
{
  • "seasonCode": "FB17",
  • "transaction": "FB17:17771"
}

Reissue ticket

Reissue a ticket based on its ticket ID. The reissue tickets endpoint allow for the reissue of individual tickets without voiding the existing barcode. Only tickets that have already been printed may be reissued.

Media type supported:

  • application/vnd.google-apps.pass → returns JSON array of { ticketId, jwt }
path Parameters
ticket_id
required
string

The ID of the ticket to reissue.

query Parameters
policyCode
required
string

Policy (control) code governing the sales policy for the requestor.

header Parameters
Accept
required
string
Default: application/vnd.google-apps.pass

Supported accept header for this endpoint:

  • application/vnd.google-apps.pass (Google Pay JWT - default)
Authorization
required
string
Example: Basic dGVzdDp0ZXN0

Authorization with Basic Auth

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Request Body schema: application/json
optional

Empty JSON body

Schema not provided

Responses

Request samples 

# Google Pay pass
curl -X POST "https://connect.evenue.net/pdi/v{version}/tickets/{ticket_id}/reissue?policyCode=SG_Control" \
  -H "Accept: application/vnd.google-apps.pass" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "PAC-API-Key: YOUR_API_KEY" \
  -H "PAC-Application-ID: reverse.domain.appid" \
  -H "PAC-Channel-Code: channelcode" \
  -H "PAC-Organization-ID: 12345"

Response samples

Content type
application/json
{
  • "tickets": [
    ]
}

Reprint Pass ticket

Reprint a specific ticket based on its ticket ID. The reprint tickets endpoint allows for the reprinting of individual tickets.

N.B., Tickets that have been previously printed will be voided and new barcodes will be issued as a result.

📘 Errata

  • Only those order lines with delivery assignments with a delivery method (disposition) of type traditional may be reprinted by this API.
path Parameters
ticket_id
required
string

The ticket ID to reprint pass.

query Parameters
policyCode
required
string

Policy (control) code governing the sales policy for the requestor.

passtype
required
string
Enum: "apple" "google"

Desired Pass Type.

header Parameters
Authorization
required
string
Example: Basic dGVzdDp0ZXN0

Authorization with Basic Auth

Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Request Body schema: application/json
optional

Empty JSON body

Schema not provided

Responses

Request samples 

# Example request to reprint a Google pass by ticket ID
curl -X POST "https://connect.evenue.net/pdi/v{version}/tickets/{ticketID}/reprint/pass?policyCode=SG_Control&passtype=google" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "PAC-API-Key: YOUR_API_KEY" \
  -H "PAC-Application-ID: reverse.domain.appid" \
  -H "PAC-Channel-Code: channelcode" \
  -H "PAC-Organization-ID: 12345"

Response samples

Content type
application/json
Example

Patron Service

Authenticate patron account

The patron auth endpoint is used to authenticate patrons against the e.Venue platform for self-service activities requiring downstream API calls. Integrators may use this service to implement their own authentication mechanism using native UI controls in a web or mobile application as permitted by a special license agreement.

📘 Errata

  • Our implementation supports AES-128 (CBC) and Blowfish encryption.
  • Encrypted passwords must be hex encoded in lowercase characters.
  • To ensure consistency with external implementations, the PKCS#5 padding mechanism should be used for the Blowfish cipher at 8-byte block sizes and the PKCS#7 padding mechanism should be used for the Blowfish and AES ciphers at 16-byte and larger block sizes.
query Parameters
distributorCode
string

Distributor code for the e.Venue distributor (property)

$ref
string

Username (email address) to authenticate

password
string

Password to authenticate (optionally encrypted, see errata below)

header Parameters
Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Content-Type
required
string
Default: application/json

The only supported request type for this endpoint is application/json.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Responses

Request samples 

# Example request to authenticate a patron account
curl -X POST "https://connect.evenue.net/pdi/v{version}/patron/auth" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "User-Agent: YourApplication/1.0.0" \
  -H "PAC-API-Key: YOUR_API_KEY" \
  -H "PAC-Application-ID: reverse.domain.appid" \
  -H "PAC-Channel-Code: channelcode" \
  -H "PAC-Organization-ID: 12345" \
  -d '{
    "distributorCode": "DISTRIBUTOR_CODE",
    "userName": "USERNAME",
    "password": "PASSWORD"
  }'

Response samples

Content type
application/json
{
  • "authenticated": true,
  • "account": "12345678"
}

Get patron orders for a specific season

The patron orders endpoint is used to retrieve the season order for the specified patron account.

path Parameters
account
required
string

Patron account ID

season
required
string

Season code

query Parameters
policyCode
string

Optional distributor policy to resolve transfer eligibility

header Parameters
Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Responses

Request samples 

# Example request to get patron orders
curl -X GET "https://connect.evenue.net/pdi/v{version}/patron/{account}/orders/{season}?policyCode=POLICY_CODE" \
  -H "Accept: application/json" \
  -H "Accept-Encoding: gzip" \
  -H "User-Agent: YourApplication/1.0.0" \
  -H "PAC-API-Key: YOUR_API_KEY" \
  -H "PAC-Application-ID: reverse.domain.appid" \
  -H "PAC-Channel-Code: channelcode" \
  -H "PAC-Organization-ID: 12345"

Response samples

Content type
application/json
{
  • "orderDate": "2017-08-09",
  • "orderItemValue": 750,
  • "orderPayments": 750,
  • "orderPriority": null,
  • "activity": {
    },
  • "season": {
    },
  • "tags": [
    ],
  • "userDefinedFields": [ ],
  • "orderCharges": [ ],
  • "orderLineItems": [
    ]
}

Get patron seasons

The patron seasons endpoint is used to retrieve a list of active seasons for the specified patron account.

📘 Compression

Compression is not supported for this endpoint.

path Parameters
account
required
string

Patron account ID

header Parameters
Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Responses

Request samples 

# Example request to get patron seasons
curl -X GET "https://connect.evenue.net/pdi/v{version}/patron/{account}/seasons" \
  -H "Accept: application/json" \
  -H "User-Agent: YourApplication/1.0.0" \
  -H "PAC-API-Key: YOUR_API_KEY" \
  -H "PAC-Application-ID: reverse.domain.appid" \
  -H "PAC-Channel-Code: channelcode" \
  -H "PAC-Organization-ID: 12345"

Response samples

Content type
application/json
{
  • "seasons": [
    ]
}

Batch Service

Get status of a batch by batch ID

The batch status endpoint returns status information for the requested batch job.

🚧 Export File Retention

Export files are scheduled for deletion shortly after they've been downloaded. Please plan accordingly.

Job Status Enumerations
SCHEDULED The job has been scheduled for processing.
ERROR An error has occurred.
PENDING Processing is underway, completion is pending.
COMPLETED The job is completed.
path Parameters
batch_id
required
string

The batch ID to retrieve status for.

header Parameters
Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Responses

Request samples 

# Example request to get batch status by batch ID
curl -X GET "https://connect.evenue.net/pdi/v{version}/batch/status/{batch_id}" \
  -H "Accept: application/json" \
  -H "User-Agent: YourApplication/1.0.0" \
  -H "PAC-API-Key: YOUR_API_KEY" \
  -H "PAC-Application-ID: reverse.domain.appid" \
  -H "PAC-Channel-Code: channelcode" \
  -H "PAC-Organization-ID: 12345"

Response samples

Content type
application/json
{}

Export orders as a batch

The batch order export endpoint is used to initiate the export of order line item data.

As with other batch export endpoints, a call to this endpoint initiates the generation of an export file. The initial API response will return a job ID that will be used in subsequent service calls(s) to retrieve job status and/or a download URL via the batch status endpoint.

📘 A note about items…

When an itemCode is provided, only those orders that contain the specified itemCode are returned.

If itemCode is a combo/package item (basis C), constituents of the package item will be also be returned.

If itemCode is a single/event (basis S) that was sold as part of a combo, containing combo items will be returned as well.

File Export Specification

The export file is tab-delimited (0x09) with each record terminated with carriage return, line feed (0x0D, 0x0A) characters. The resultant file is compressed via gzip and delivered with a .gz extension.

Index Column Name
01 account
02 isOrganization
03 companyName
04 lastName
05 firstName
06 email
07 mobile
08 currencyCode
09 season
10 orderID
11 sequence
12 item
13 itemBasis
14 qty
15 price
16 itemCharge
17 itemChargeAmount
18 itemFee
19 itemFeeAmount
20 itemDiscount
21 itemDiscountAmount
22 itemSurcharge
23 itemSurchargeAmount
24 extendedPrice
25 event
26 priceLevel
27 priceType
28 level
29 section
30 row
31 seat
32 barcode
33 renewable
34 itemBalance
35 itemDate
36 mark
37 disposition
38 specialHandling
39 itemGroup
40 priority
41 billPlan
42 priceTypeName
43 itemQuantity
44 ticketID
query Parameters
seasonCode
string

Season Code (either seasonCode or patron is required)

patron
string

Patron Account (either seasonCode or patron is required)

itemCode
string

Used to return only those orders that contain the specified item

since
string <date-time>

Used to return only those orders that have been updated since the date/time provided. Dates are in YYYY-MM-DDThh:mm:ssZ or YYYY-MM-DDThh:mm:ss±hh:mm format.

distributorCode
string

(Optional) distributor code, used to provide context for e-commerce email address resolution. Specify a value only when instructed by your integration analyst.

header Parameters
Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Responses

Request samples 

# Example request to export orders as a batch
curl -X GET "https://connect.evenue.net/pdi/v{version}/batch/export/orders" \
  -H "Accept: application/json" \
  -H "User-Agent: YourApplication/1.0.0" \
  -H "PAC-API-Key: YOUR_API_KEY" \
  -H "PAC-Application-ID: reverse.domain.appid" \
  -H "PAC-Channel-Code: channelcode" \
  -H "PAC-Organization-ID: 12345" \
  -G --data-urlencode "seasonCode=SEASON_CODE" --data-urlencode "patron=PATRON_ACCOUNT"

Response samples

Content type
application/json
{
  • "status": "SCHEDULED",
  • "batchID": "1529-27274785-37d4-46ec-bbe2-8755c686df77"
}

Manifest Service

Get manifest

Retrieve the requested manifest based on season, facility, and configuration codes. The configuration endpoint returns configuration information for the requested facility configuration.

N.B., Only those seats included in the facility configuration are returned.

• Areas are returned in the order in which they are assembled within a configuration. • Sections are returned in level/section order, as they are assembled within a configuration. • Rows are returned in row allocation order, as they are listed within the season's facility manifest. • Seats are returned in seat index order, as they are listed within the season's facility manifest.

The HTTP HEAD verb is also supported for this endpoint.

📘 Errata

The only supported media type for this endpoint is application/json. Response compression is required for this endpoint.

path Parameters
season_code
required
string

Season code for the requested manifest.

facility_code
required
string

Facility code for the requested manifest.

configuration_code
required
string

Configuration code for the requested manifest.

query Parameters
policyCode
string

Policy (control) code governing the policy for the requestor.

event
string

Event (item code) for an event-specific copy of the requested manifest.

header Parameters
Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Responses

Request samples 

# Example request to get the manifest
curl -X GET "https://connect.evenue.net/pdi/v{version}/manifest/{season_code}/{facility_code}/{configuration_code}?policyCode=myPolicyCode&event=myEventCode" \
  -H "Accept: application/json" \
  -H "Accept-Encoding: gzip" \
  -H "User-Agent: YourApplication/1.0.0" \
  -H "PAC-API-Key: YOUR_API_KEY" \
  -H "PAC-Application-ID: reverse.domain.appid" \
  -H "PAC-Channel-Code: channelcode" \
  -H "PAC-Organization-ID: 12345"

Response samples

Content type
application/json
{
  • "season": {
    },
  • "facility": {
    },
  • "configuration": {
    },
  • "capacity": 1234,
  • "priceLevels": [
    ]
}

Utilities

Get system information

The sysinfo endpoint returns back office system information.

header Parameters
Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Responses

Request samples 

# Example request to get system information
curl -X GET "https://connect.evenue.net/pdi/v{version}/util/sysinfo" \
  -H "Accept: application/json" \
  -H "User-Agent: YourApplication/1.0.0" \
  -H "PAC-API-Key: YOUR_API_KEY" \
  -H "PAC-Application-ID: reverse.domain.appid" \
  -H "PAC-Channel-Code: channelcode" \
  -H "PAC-Organization-ID: 12345"

Response samples

Content type
application/json
{
  • "PDIVersion": "7.20.175",
  • "AppVersion": "7.2.226",
  • "t.ResVersion": "7.20.150",
  • "backOfficeServerName": "dev2",
  • "backOfficeTimeZone": "PST",
  • "defaultCountryCode": "US",
  • "defaultCurrencyCode": "USD",
  • "organization": {
    }
}

Echo input data

This endpoint echoes the input data back to the client.

The echo endpoint echos the request received, including all HTTP headers. This endpoint is useful in troubleshooting other APIs insomuch that developers may direct any (arbitrary) request to this endpoint and the service will echo back the request received in its entirety, which is often helpful to identify JSON parsing issues or troubleshooting issues with object hierarchy or data types.

header Parameters
Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Pricing Service

Get seat pricing for a specific item

The pricing profile endpoint is used to retrieve seat-level pricing for the specified pricing profile.N.B., Only those seats included in the profile will be returned in the response unless includeAllSeats = true is specified in the request (in which case every seat specified in the facility configuration will be returned, regardless of whether or not the seats are specifically profiled).

Support for conditional GET and HEAD requests is enabled by means of the If-Modified-Since header; refer to the sample code (above) for examples.

path Parameters
profile_code
required
string

Profile code for the requested item

season_code
required
string

Season code for the requested item

item_code
required
string

Item code for the requested item

query Parameters
policyCode
required
string

Policy (control) code governing the sales policy for the requestor

includeAllSeats
boolean

When true, the endpoint will return all seats in the facility configuration for the specified item, otherwise only those seats included in the specified profile will be returned.

debug
boolean

Enables detailed response logging. Use only when instructed to do so by Paciolan Developer Support.

header Parameters
Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

PAC-Organization-ID
required
integer <int32>
Example: 999

The client's data account ID to pull events from.

Responses

Request samples 

# Example request to get seat pricing for a specific item
curl -X GET "https://connect.evenue.net/pdi/v{version}/{profile_code}/{season_code}/{item_code}" \
  -H "Accept: application/json" \
  -H "Accept-Encoding: gzip" \
  -H "User-Agent: YourApplication/1.0.0" \
  -H "PAC-API-Key: YOUR_API_KEY" \
  -H "PAC-Application-ID: reverse.domain.appid" \
  -H "PAC-Channel-Code: channelcode" \
  -H "PAC-Organization-ID: 12345"

Response samples

Content type
application/json
{
  • "pricingProfile": {
    },
  • "season": {
    },
  • "item": {
    },
  • "sections": [
    ]
}