SupportProduct Documentation
    • Introduction
    • URL Structure
    • API Key
    • Errors
    • Versioning
    • Pagination
    • Replication
    • Performance
    • Rate Limits
    • Webhooks
  • System Services
    • Companies
    • Hello World
  • Accounts
  • Ticketing
    • Getting started
    • Catalog
    • Capacity
    • Tickets
    • Reservations
    • Schedule
  • Memberships
    • Catalog
    • Membership
    • Member
    • Card
    • Payment Method
    • Lifecycle
    • Miscellaneous
    • Points
  • Speedgate
  • Attraction Wallet
  • POS
    • POS Sale
    • POS Unit
    • POS Store
    • Salesperson
    • External POS Sale
    • Global POS Entry
  • Inventory
    • Barcodes
    • Items
    • Item Ledger Entries
    • Item Categories
    • Item Variants
    • Item Translations
  • Coupon
  • Vouchers
    • Vouchers
  • Ecommerce
    • Sales Documents
  • Finance
    • General Ledger Account
    • General Ledger Entries
    • General Ledger Journal
  • Customers
    • Customers
  • PDF Designer
LogoLogo
SupportProduct Documentation
TicketingCapacity

GET
https://api.npretail.app/:tenant/:environment/:company/ticket/capacity/search
GET
/:tenant/:environment/:company/ticket/capacity/search
1curl -G https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%20International%20Ltd./ticket/capacity/search \
2     -H "Authorization: Bearer <apiKey>" \
3     -d itemNumber=31001 \
4     -d referenceDate=2024-10-15 \
5     -d quantity=2
Try it
200ExampleCapacity1
1[
2  {
3    "capacityControl": "sales",
4    "code": "CASTLE",
5    "default": true,
6    "discountPct": 0,
7    "included": "mandatory",
8    "quantity": 2,
9    "referenceDate": "2024-10-15",
10    "schedules": [
11      {
12        "allocatable": true,
13        "allocationModel": "capacity",
14        "remainingCapacity": 10,
15        "explanation": "Schedule is allocatable",
16        "schedule": {
17          "externalNumber": 452,
18          "code": "MORNING",
19          "startDate": "2024-10-15",
20          "startTime": "09:00",
21          "endDate": "2024-10-15",
22          "endTime": "12:00",
23          "duration": 10800,
24          "description": "Morning schedule",
25          "arrivalFromTime": "08:30",
26          "arrivalUntilTime": "10:00"
27        },
28        "price": {
29          "pricingOption": "fixed",
30          "adjustmentAmount": 0,
31          "adjustmentPct": 0,
32          "adjustedUnitPrice": 100,
33          "adjustedTotalPrice": 200
34        },
35        "sales": {
36          "salesFromDate": "2024-10-11",
37          "salesFromTime": "00:00",
38          "salesUntilDate": "2024-10-17",
39          "salesUntilTime": "23:59"
40        }
41      },
42      {
43        "allocatable": true,
44        "allocationModel": "capacity",
45        "remainingCapacity": 12,
46        "explanation": "Schedule is allocatable",
47        "schedule": {
48          "externalNumber": 489,
49          "code": "EVENING",
50          "startDate": "2024-10-15",
51          "startTime": "17:00",
52          "endDate": "2024-10-15",
53          "endTime": "20:00",
54          "duration": 10800,
55          "description": "Evening schedule",
56          "arrivalFromTime": "16:30",
57          "arrivalUntilTime": "18:00"
58        },
59        "price": {
60          "pricingOption": "fixed",
61          "adjustmentAmount": 0,
62          "adjustmentPct": 0,
63          "adjustedUnitPrice": 100,
64          "adjustedTotalPrice": 200
65        },
66        "sales": {
67          "salesFromDate": "2024-10-11",
68          "salesFromTime": "00:00",
69          "salesUntilDate": "2024-10-17",
70          "salesUntilTime": "23:59"
71        }
72      }
73    ],
74    "unitPrice": 100,
75    "unitPriceIncludesVat": true,
76    "vatPct": 25
77  }
78]
Was this page helpful?
Previous

Introduction

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

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path Parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired
Your Business Central Company. [More details.](/paths#3-company)

Headers

x-api-versiondateOptional
Used for API versioning. [More details.](/versioning)

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.

Response

Returns a list of available capacities for the specified ticket item number.
capacityControlenum
Indicates the type of capacity control for the admission. None implies that there is no capacity control. Sales implies that the capacity is controlled by the number of tickets sold. Admitted implies that the capacity is controlled by the number of tickets admitted. Full implies that the capacity is admitted and departed.
Allowed values:
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.
Allowed values:
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.
customerNumberstring or null
The customer number of the user making the request. The customer number affects pricing.
customerNumberstringOptional
The customer number of the user making the request. The customer number affects pricing.
An item or product number defined in the ticketing system
A date to use as a reference for the capacity search. If not specified, the current date will be used.
The number of tickets to reserved
Returns a list of available capacities for the specified ticket item number.

Used for API versioning. More details.

Your Business Central Company. More details.

A unique code that identifies a specific admission.

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.