TicketingAvailability

Get Capacity

Retrieve the capacity and availability for a ticket item number. Note that an item may have multiple admissions with different schedules and pricing.

Authentication

x-np-api-keystring
API Key authentication via header

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

Headers

x-api-versiondateOptional

Used for API versioning. More details.

Query parameters

itemNumberstringRequired
An item or product number defined in the ticketing system
referenceDatedateOptional
A date to use as a reference for the capacity search. If not specified, the current date will be used.
quantityintegerOptional
The number of tickets to reserved
admissionCodestringOptional
A unique code that identifies a specific admission.
customerNumberstringOptional
The customer number of the user making the request. The customer number affects pricing.

Response

Returns a list of available capacities for the specified ticket item number.
capacityControlenum

Admission-level configured capacity control. When capacity limits are set per schedule rather than per admission, the effective mode may vary across the admission’s schedules — use the capacityControl field on each entry in schedules[] for the per-schedule value.

codestring
A unique code that identifies a specific admission.
defaultboolean
Indicates if this admission is the default admission when there are multiple admission defined.
discountPctdouble
The discount percentage for the admission based either on the customer or the quantity of tickets.
includedenum

Indicates if the admission is mandatory or optional. mandatory implies that the admission can not be deselected. optionalNotSelected implies that you must opt-in to include the admission, while optionalAndSelected implies that the admission is optional and selected and you can opt-out. You opt-in or opt-out by including or excluding the admission in the reservation request.

quantityinteger
The number of tickets to reserved
referenceDatedate
A date to use as a reference for the capacity search. If not specified, the current date will be used.
scheduleslist of objects
unitPricedouble
The unit price of the ticket.
unitPriceIncludesVatboolean
Indicates if the unit price includes VAT.
vatPctdouble
The VAT percentage for the admission.
customerNumberstringOptional
The customer number of the user making the request. The customer number affects pricing.