27th January 2026
GET /resale-listingsandGET /resale-listing:- Added new filtering options:
eventId,customerId,createdAfter,createdBefore,status, andwithTrashed. - Added new attributes to resale listing responses:
eventId,orderId,createdAt,closedAt,onSaleFrom, andonSaleUntil. - Added new attributes to resale contract responses:
currencyId,price,totalPrice,displayTotal, andsoldAt. - Added ability to include
events,orders,resaleContracts.replacingOrderItem, andresaleContracts.payoutTransaction.
- Added new filtering options:
GET /resale-listingsandGET /resale-listing: Added ability to includeresaleContracts.payoutWalletTransactionto retrieve wallet transaction details for sold resale contracts.- Added
bundledItems(id + quantity) to GET /sale-items and GET /sale-item when bundle data is present.
20th January 2026
- Added support for all item types in the GET /order-items
typefilter parameter. Previously onlyticket,product, andguestListwere accepted. Now accepts all 14 item types includingseason_ticket,fee,bundle,gift_voucher, and more. Refer to the endpoint documentation for the full list.
6th January 2026
- Breaking: GET /wallets and GET /wallet endpoints now return
customerIdinstead ofuserIdin the response attributes. This is consistent with all other API endpoints that provide customerIds instead of userIds.
22nd December 2025
- Updated
DELETE /resale-listingsto properly cancel resale listings with validation. Response now includescontractsCancelled,contractsSold, andcontractsFrozencounts. Sold and frozen contracts are preserved; only unsold, unfrozen contracts are cancelled.
19th December 2025
- Added
eventIdas a filter to the GET /orders endpoint to retrieve only orders that contain items from the given event ID. - Added a new
orderItemIdfilter to GET /v1/wallets/transactions endpoint. - Added a new
sourceattribute to theWalletTransactionsentity from GET /v1/wallets/transactions to detail the source of the wallet transaction.
17th December 2025
- Added new GET /wallets and GET /wallet endpoints to retrieve wallets registered within a company (NB: wallets power our account balance functionality).
- Added a new GET /v1/wallets/transactions endpoint to list all recent transactions across wallets (or for a specific wallet)
- Added POST /v1/wallets/transactions/confirm to allow confirmation of pending transactions. Pending transactions are typically used for resale, order modifications, and other internal processes that deposit money into wallets.
- Added POST /v1/wallets/payouts/initiate to allow initiation of an external payout from a wallet. Unlike cashouts, payouts are not capped at the mount of topups purchased. This endpoint allows for a full payout of the account balance, regardless of source of funds.
- Added POST /v1/wallets/payouts/confirm to confirm when an initiated payout has been completed. This is an important step where external parties need to also verify that the payout was handled correctly.
- Removed deprecated endpoints
POST /v1/wallets/nfc-downloadandPOST /v1/wallets/nfc-download/confirmas these are no longer in use or supported. - Add GET /v1/resale/listings index endpoint to return all available resale listings
- Payload updats to POST /v1/resale/listings to support creation of multiple item listings
- Added a new
authenticationProvidersrelationship that can be included on both GET /customers and GET /customer to determine the related customer SSO IDs.
3rd December 2025
- Added a new
orderColumnattribute to GET /sale-items endpoint, which reflects the sort order defined in admin, and used in the ticket shop.
20th November 2025
- Added a new
DELETE /customersendpoint to support customer data deletion requests & accommodate data retention policies.
11th November 2025
- On GET /events and GET /event we now return the
isCancelledattribute to indicate that an event has been marked as cancelled.
4th November 2025
- Added a new
DELETE /customersendpoint to support customer data deletion requests & accommodate data retention policies. - We now return all fees, resale fees, fulfilment fees, and protection fees via the GET /v1/order-items endpoint
- When returning fees via the GET /v1/order-items endpoint we also provide access to the
producingOrderItemIdfield which allows consumers to reference the order item that generated that specific fee. Where this isnullthe fee applies to the whole basket. - Added the ability to retrieve orders from the GET /v1/order endpoint using the reference, rather than the ID.
16th October 2025
- Introduced access control scanning / pairing restrictions to items that belong to an order which is currently being modified, or resold.
- GET /v1/entry/tickets receives a new status (
variable.status) optionlocked, which indicates that the order is currently being modified. Items with this status should be considered temporarily invalid for scanning. The status of these items could return tosoldorrefundedin the future. - Added
POST /v1/resale-contractsto create a resale contract, which allows an order item to be resold - Added
GET /v1/resale-contractto get a resale contract for an order item or by ID - Added
POST /v1/resale-contracts/deleteto delete a resale contract for an order item or a resale contract ID - Added
replacedOrderItemtoGET v1/order-items,GET v1/order-itemandGET v1/orderto return the original order item for resold and modified order items.
2nd October 2025
- Added a new
cancelExistingBasketparameter to POST /v1/basket-items which allows expiring a basket and adding items to a new basket in a single request. - Added a new endpoint DELETE /v1/baskets for expiring baskets.
- Added
parentSaleItemIdto GET /v1/sale-items for identifying add-ons. - Added a new
unformattedproperty to the GET /v1/event-statistics endpoint to prevent humanizing/formatting numerical statistics.
12th September 2025
- Adding
billingDetailsobject to the GET /v1/config endpoint.
14th August 2025
- POST /v1/basket-items now accepts order item ID as well as sale item ID to add a resale item to basket. The
resaleFeeSellerContributionhas also been added and can be pasesed inpointOfSaleData
21st July 2025
- Updated POST /tickets/pair to accept an
event-idproperty in order to scope the possible list of matching order items. This is particularly useful for any users that re-use barcodes across events or schedules.
30th June 2025
- Replace now unused
applyOncePerOrderandoneUsePerCustomerattributes from discount code endpoints with the newmaxUsesPerOrderandmaxUsesPerCustomer
5th June 2025
- Update POST /basket-items to return a
startBasketUrllink to enter checkout for the basket, ifgenerateBasketUrlis set to true on the request
2nd June 2025
- Add
salePeriodsto includes on GET /events and GET /event
19th May 2025
- Updated GET /events and GET /event to include a new seating plan
embedUrl. - Updated GET /events and GET /event to include
eventSchedules.startDateandeventSchedules.endDate.
14th April 2025
- Updated POST /zones/check and POST /zones/scan to return a
statusDetailfield to embelish adeniedresponse. Currently this only returnshistoricBarcodein the event a barcode has been scanned that has since been superceded by a new barcode following a transfer. - Updated GET /entry/tickets to return a
historicBarcodeslist within thevariableportion of a ticket, which lists all previous barcodes of the ticket, in order to determine whether the customer is attempting to scan an old (possibly resold) ticket.
31st January 2025
- GET /events, GET /activated-events, and GET /future-events now provide the company default header + thumbnail URL if the event does not have any media configured.
6th January 2025
- Added POST /customer-groups/customers to add customers to a manual customer group
- Added POST /customer-groups/customers/delete to remove customers from a manual customer group
18th December 2024
- GET /order-items now correctly returns items from fully cancelled/refunded orders. Previously it would include refunded items if the order was only partially refunded.
13th December 2024
- The customer update endpoint will now preserve existing customer address fields as long as no new address data is provided. Prior to this change, customer address fields would be cleared if no address data was provided within the payload.
3rd October 2024
- Added
minPriceandmaxPriceto GET /events and GET /event as additional opt-in attributes - Updated the
lastUpdatedfilter on GET /events so that it now considers pricing, venue & item updates.
5th September 2024
- Added
appleWalletPassUrlto GET /orders, GET /order, GET /order-items and GET /order-item for easy access to download an Apple Wallet pkpass file for each order item.
29th August 2024
- Added
reserverNameto GET /orders, GET /order, and addnamedHolderto the items within the same endpoints, as well as the GET /order-items endpoint - Added
phoneandphoneCodeas fields that can be sent to POST /customers/update and POST /customers - Added
gatewayReferenceto transactions GET /transactions, GET /orders and GET /order - Allow balance refunds and cancellations, as well as standard refunds on POST /order-items/refund and POST /orders/refund using the new
typeattribute in the request
24th July 2024
- Added the
scheduleIdto the returned fields on GET /events and GET /event endpoints - Added
eventSchedulesas a possible include on GET /events and GET /event endpoints - Added a new filter to GET /events to allow filtering by
scheduleId. Providing a null, zero, or empty value will return events that are outside of a schedule. - Added a new filter to GET /events to allow grouping of events by their respective schedule (
groupScheduledEvents). Events without a schedule continue to be returned individually.
19th June 2024
- Added
historicalBarcodesto the include parameter for the below endpoints. New barcodes are generated when an order item is transfered or a barcode change is manually performed. This will return all historical barcodes associated with the order item. - Added
variablePriceEnabled,variablePriceMin, andvariablePriceMaxto GET /sale-item and GET /sale-items endpoints to indicate whether pricing is a customer selection. - Added
customPriceEnabledandcustomPriceRequiredto the documentation for GET /sale-item and GET /sale-items to indicate whether prices can be defined by staff users in mobile applications. - Marked the
GET /entry-tickets, POST /orders/upload,POST /wallets/nfc-download, andPOST /wallets/nfc-download/confirmendpoints as deprecated and likely to be removed in a future version of the API. Anyone using these endpoints should review the documentation to understand alternative provisions for the functionality being removed. - A display issue with the related space data for order items has been updated to return the seat/space name correctly, rather than the fully formatted string. This is a breaking change for anyone relying on the broken data previously being returned.
- Resolved an issue with access to tickets that were sold by a parent company for a child company event on GET /zones/items, GET /order-item and GET /order-items.
20th May 2024
- Ignore empty data capture responses on the
v1/data-capture-responsesendpoint
15th May 2024
-
Added
transactionsto the include parameter for the following endpoints: -
Improved consistency of currency attributes across various endpoints:
-
Added
currencyIdto: -
Added
currencyCodeto: -
Added
currencySymbolto:- GET /basket
POST /basket/discount- GET /order-item
- GET /order-items
- POST /basket-items
- GET /sale-item
- GET /sale-items
-
Added
feeCurrencyIdto: -
Added
feeCurrencyCodeto: -
Added
feeCurrencySymbolto:
-
Added
-
New Feature Added support for processing deposit payments:
- POST /v1/checkout/create-payment-intent and POST /v1/orders/complete both feature a new
paymentPlanparameter for processing online/offline deposit payments. - The orders API now features a new
paidfield in the response to indicate how much of the overall order total has been paid for. This applies to:
- POST /v1/checkout/create-payment-intent and POST /v1/orders/complete both feature a new
-
Added
pointOfSalewithtypeandnameattributes to the endpoints: -
Added the
itemType(slug),typeName, anditemNamefor order items when including ‘orderItems’ and on the endpoints: -
Added
discountCodesandaccessCodesas optional includes to the endpoints: -
Added
deliveryAddressoptional include to GET /v1/order -
Added
deliveryAddressesoptional include to GET /v1/orders -
Added
priceBandto GET /v1/order and GET /v1/orders included order items -
Added
priceBandsoptional include to GET /v1/order-item and GET /v1/order-items -
Added
countryIsoandcountryIso3country codes to customer, venue, billing, and delivery addresses -
Added optional include for
spaces,spaceAreas,spaceBlocks,spaceGates,spaceRows,spaceStairs,spaceStands,spaceTablesto the GET /v1/order-item and GET /v1/order-items endpoints -
Added optional include for
spacesto the GET /v1/order and GET /v1/orders endpoints -
Added
fullSpaceNameattribute to the order items returned by POST /v1/orders/complete -
Added the
itemType(slug),typeName, anditemNamefor order items when including ‘orderItems’ and on the endpoints: -
The POST /v1/basket-items endpoint will now force a payment method of
ewallet-onlinewhen using token/custom currencies to complete the order.
5th April 2024
The following endpoints now accept a decimal percentage for the discount amount value.
6th March 2024
- GET /v1/activated-events will no longer return any events that are in draft status
-
New Feature Added support for processing and refunding split payments:
- POST /v1/basket-items and POST /v1/orders/complete both feature a new
splitpayment method with an accompanyingpaymentSplitsparameter for processing offline split payments. - POST /v1/checkout/create-payment-intent optionally accepts a new
paymentSplitsparameter for processing online payment splits. - POST /v1/orders/refund can be supplied with a
refundSplitsparameter for manual allocation of refunds to payment methods.
- POST /v1/basket-items and POST /v1/orders/complete both feature a new
- GET /v1/report now allows an increased limit of 1000 when being run asynchronously
- Add new endpoint GET /v1/sale-item to retrieve a single sale item
12th February 2024
- The GET /orders endpoint now allows for the retrieval of orders in failed reservation states (cancelled, expired, failed, and rejected), through the use of the
withReservationsquery parameter. - The GET /order endpoint now allows for the retrieval of orders in failed reservation reservation states as above.
1st February 2024
- The GET /order endpoint now allows for the retrieval of orders in reservation state.
- The GET /orders endpoint now allows for the retrieval of orders in reservation state, through the use of the
withReservationsquery parameter.
23rd January 2024
- The GET /sale-items and GET /event-tickets endpoints now include the following attributes for
timeslots:hasUnlimitedStocktotalStockcurrentStockhideWhenOffSalehideWhenOutOfStockonSaleFromonSaleUntil
- The Order Item (GET /v1/order-item) and Order Items (GET /v1/order-items) endpoints now allow for retrieving order items using a specific order ID
- The Sale Items (GET /v1/sale-items) endpoint now allows for retrieving sale items using a specific inventory item ID
- The Order Item (GET /v1/order-item) and Order Items (GET /v1/order-items) endpoints now allow for
dataCaptureFieldsto be included alonsidedataCaptureResponses
22nd January 2024
- The add to basket (
POST v1/basket-items) endpoint now accepts thespaceIdto which a sale item should be associated on a seated event. - The add to basket (
POST v1/basket-items) endpoint now permits you to provide the same sale item ID in multiple basket items, allowing each to utilise different item settings.
21st January 2024
- The
v1/zones/scanandv1/zones/checkendpoints now return the order reference in the responseg - Prices are now returned in all available currencies on the get event tickets (
GET v1/event-tickets) endpoint - The default event currency is now returned on the get events (
v1/events) endpoint
8th January 2024
- The Add to basket endpoint (POST /v1/basket-items) received an update in error response status code from 403 to 422 when attempting to add a child company sale item to a parent company basket without global transactions enabled.
3rd January 2024
- The GET /v1/order-items and GET /v1/order-item endpoints now contain additional tax breakdowns, tax rates, and conditional tax fields.
- The GET /v1/order-items and GET /v1/order-item endpoints will return the order status of the associated order when specifying that the order should be included in the response.
- The GET /v1/orders and GET /v1/order endpoints now contain additional tax breakdowns, tax rates, and conditional tax fields for any included order items.
21st November 2023
- The POST /v1/guestdata endpoint now contains the email and order reference for each entry in
content.guests - The GET /v1/entry/tickets now has the email in each
stableobject - The GET /v1/zones/items now returns the order reference in each element, and the query now searches the barcode and order reference, as well as customer name and email
3rd November 2023
- The GET /v1/event-medias and GET /v1/event-media/generate-link endpoints have been added to enable integrations with event media. The GET /v1/event-media/generate-link allows for you to retrieve hosted URLs from which customers can directly download their tickets.
- The GET /v1/orders endpoint has been updated to include the
downloadUrlof the order, from which a customer can download their tickets using default event media
30th October 2023
- Added new
seatingPlanproperty to the Retrieve Events and Retrieve Event endpoints. This currently includes a singlebestAvailableSeatsEnabledoption.
10th October 2023
- The GET /v1/events endpoint now surfaces the owning company’s
live_modein relationship data. - A new filter (
hideDemoMode) has been added to GET /v1/events which allows consumers to exclude any events belonging to demo companies from the response. - A new filter (
hideChildEvents) has been added to GET /v1/events which allows consumer to exclude child company events from the response.
9th October 2023
- The GET /v1/orders and GET /v1/order endpoint can now return a full
customerobject. This value will be included in the response whencustomersis given as anincludeparameter.
6th October 2023
- The GET /v1/events endpoint now surfaces the
organiserName,organiserEmailandorganiserPhoneattributes.
4th October 2023
- The GET /v1/event-tickets endpoint added a new
tickets.*.seatingPlanAreasarray, which includes seating plan area ID’s for which that sale item can be bought. This new property was added to facilitate the ability to book best available seats for specific areas via the API. - Additionally, the
tickets.*.seatingPlanAreasproperty can be filtered to only include areas with availability by passing an additional query paramcheckAreaAvailability=true.
26th September 2023
- Breaking Removed the
tokenparam from GET /customer as we’ve since replaced theSESScustomertokencookie with acustomer_idcookie.
14th September 2023
- Added new GET /venues endpoint to retrieve a list of venues.
- Added a new POST /venues endpoint to allow venues to be created.
- Added a new
venueparameter to the event create/update payloads, allowing event venues to be created on the fly at the point of event creation/update.
12th September 2023
- Added multi language support. Clients can now optionally specify a preferred language for the request using the
Accept-Languageheader.- If the given language is enabled against the company, the request payload and respective response data will be treated as local to the specified language.
- If the given language is not enabled against the company, or is otherwise invalid, the companies fallback language will be used.
- Responses will also now include the
Content-Languageheader, which indicates the language of the response.
4th September 2023
- Added a new
/event-statisticsendpoint for retrieving real-time event sales data for a single event.
1st September 2023
- Added a new
offlineparameter to POST /orders/complete endpoint to facilitate offline e-wallet top-ups.
7th August 2023
- Added a new GET /companies endpoint to retrieve companies the authenticated user is associated to.
11th July 2023
- Added a new GET /seating-plan-areas endpoint to retrieve seating plan areas by
eventId.
6th July 2023
- Added
only_on_saleflag to the events endpoint to return only events that can be sold via the current sales channel (box office, or kiosk).
18th May 2023
- Added
status,statusSlug, andstatusIdto any Order entities returned via GET /orders or GET /order endpoints. - Added
currencyIdto Order entities returned via GET /orders and GET /order endpoints. - Added
currencyIdandtopupCurrencyIdto Order Item entities returned via GET /orders, GET /order, or GET /order-items endpoints. - The GET /order endpoint now allows you to retrieve orders that are refunded, partially refunded, or cancelled.
10th May 2023
- Updated
GET /entry-ticketsto also return season tickets for the given event.
9th March 2023
- Added
currentStockandonSaleattributes to GET /event-tickets and GET /sale-items endpoints. - Add
descriptionto GET /events - Added a temporary cache in front of GET /orders, GET /activated-events, GET /config, GET /currencies, GET /customers, GET /events, GET /event, GET /future-events, GET /sale-items, GET /shops,
GET /zone/items,GET /zones. Identical requests sent within a 60-second timeframe will be retrieved from cache.
1st February 2023
- Added
onSaleFromandonSaleUntildates to GET /sale-items and GET /event-tickets endpoints. - Added an optional
redirectquery param to POST /admin-users/single-sign-on and POST /customers/single-sign-on to allow control over the final redirection.
12th December 2022
- Following the introduction of tax breakdowns in shop orders, the tax breakdown details are now provided via GET /order-items and GET /orders.
- The currency ID of any collected fees is now included in GET /order-items for use when any transactions take place in custom currencies.
- It is now possible to retrieve topup and cashless product purchases via GET /order-items.
- When retrieving cashless product purchases via GET /order-items it’s possible to specify that the shop should be included in the response.
6th December 2022
- Removed the
skuparameter from the POST /basket-items endpoint, in favour of using topup IDs directly (as returned by GET /sale-items) - Added a
currencyIdparameter to the POST /basket-items endpoint to specify the basket currency, rather than relying on the customer’s previously selected currency or the company default. - Added a global
X-NU-CURRENCY-IDheader that will change the selected currency for that request only. This is useful for retrieving sale items with the correct pricing. - Added a new
feeCurrencyIdvalue to any order responses via GET /orders, which represents the currency any fees should be displayed in. This is significant with cashless products as the fees will be in a companies default currency when cashless is setup to use a token currency.
5th December 2022
- Added the
bundledWitharray on GET /sale-items to return the list of sale item IDs that come bundled with an item. - Added the
bundleLeadOrderItemIdto the GET /orders andGET /orders/:idendpoints, to highlight where an order item is being purchased as part of a bundle.
28th November 2022
- Added
isCustomto the currencies returned from GET /currencies, to identify which currencies are custom token currencies. - Added
topupTokenAmountto the sale item details returned from GET /sale-items, andGET /itemsto detail how many tokens a topup will add to a users basket. This value will be null if cashless settings do not use a custom token currenciy.
4th November 2022
- Added
subunitto GET /currencies to complement our new support for non-2DP currencies.
28th October 2022
- Added UUID to the
initiate wallet downloadendpoint to ensure idempotency between requests.
19th October 2022
- Allowed the transaction source to be recorded for cashouts via the
POST /wallets/cashoutsendpoint. - Allowed the transaction source to be recorded for topups and cashouts via the POST /orders/upload endpoint.
22nd September 2022
- Major Feature Added
onlyandexceptparams throughout the API allowing for precise control over which fields are returned in the payload. Applies to the following endpoints:- GET /company/users
- GET /company/user
- GET /customers
- GET /customer
- GET /discount-codes
- GET /discount-code
- GET /event-tickets
- GET /events
- GET /event
- GET /inventory-items
- GET /order-items
- GET /order-items
- GET /orders
- GET /order
- GET /sale-items
- GET /transactions
- GET /countries
- GET /currencies
- GET /shops
- GET /shop
- GET /zones/all
- Breaking The
tagCategoryrelationship was renamed totagCategorieson the Events API, to match the plural case naming convention of all other resource types. - Breaking The question fields have moved from the
dataCaptureResponsesresource to a newdataCaptureQuestionsinclude to reduce overall payload sizes on the Customers API. - Breaking The
currenciesrelationship is no longer included by default on GET /transactions, you must now explicitly request to includecurrencies. - Added
deletedAtattribute to GET /customers and GET /customer - Added
lastUpdatedparameter to GET /transactions, along with addingcreatedAt,updatedAtandmetadatakeys to thetransactionItemsinclude payload - Correctly pull through the
deletedAttimestamp in the Company Users API - Fix: Filter out internal & null questions when retrieving data capture responses via the Customers API
- Fix: 500 error when
withTrashedis set totrueon the Orders API - Fix: Allow passing timestamps to GET /transactions
19th September 2022
- Added a global response header to all requests:
X-Runtimewhich returns the total execution time, in seconds, for any given API in call. This value can be observed to adjust the rate of API calls according to performance degradation over a period of time.
7th September 2022
- Added an optional
regionfield to POST /customers and POST /customers/update. - Added
isHidden,isPublished,pageDisplayDate,pageDisplayLocation,pagePricingDisplayfields to GET /events and GET /event. - Added an optional
notifyCustomerflag to/POST /order-item-approve.
11th August 2022
- Added
thumbnailImage,pageHeaderImage, andmetaImageMedia Resources to the following endpoints in our Events API:- GET /activated-events - This endpoint does currently have
media.header-image,media.list-thumbnail, andmedia.meta-imageattributes, but these are now considered deprecated. For backwards compatibility these attributes will remain in the response. - GET /events
- GET /future-events - This endpoint does currently have
media.header-image,media.list-thumbnail, andmedia.meta-imageattributes, but these are now considered deprecated. For backwards compatibility these attributes will remain in the response.
- GET /activated-events - This endpoint does currently have
- Added the ability to include event media by passing
imagesin theincludeparameter of the GET /event endpoint. - Added
includeto the/basket-itemsendpoint to allow the inclusion of a user’s wallet info, after a cashless transaction has completed automatically. - Added GET /countries for retrieving country IDs and metadata.
21st July 2022
- Fixed an issue where events could be created without a timezone. If no timezone is specified, it now falls back to the timezone stored against the current company.
- Added
itemNameanditemIdto the/orderendpoint’s order item response data. - Added
refundedAmount,isValid,requiresApproval,approvedAt,rejectedAt, andcancelledAtto any order item response data inside orders. - Added cursor pagination to the
/ordersendpoint, allowing for a streamed pagination approach, based on thelastUpdatedtimestamp provided. - Added a
containsparameter to the/ordersendpoint, allowing you to filter orders that contain only the specified item types. - Added
customerSsoIdparameter to POST/basket-itemsand POST/orders/complete - Improved feedback & error handling on POST
/order-item/approve - Allow disabling both the order confirmation AND the guest list approved confirmation in POST
/basket-items
30th June 2022
- Added
uuidparameter to the POST /basket-items endpoint to provide idempotency functionality when auto completing orders. - Added the
imageproperty to all sale items returned via the/sale-itemsendpoint. - Added
itemNotesandorderNotesto the GET /entry/tickets endpoint. - Added
orderNotesto the POST /guestdata response. - Added the ability to
includeorder item notes in the GET /order-items and GET /order-item endpoints - Added
orders.*.notesandorders.*.items.*.notesto the GET /orders endpoint. - Added
notesanditems.*.notesto the GET /order endpoint. - The Events API now respects the Visibility Groups & Permissions of the API user & applies the correct filtering.
- Changed
content.const.typein GET /entry/tickets to be the current item name and addedcontent.const.typeDuringSalewhich contains the item name at point-of-sale. - Updated the
/customers/getendpoint to return therefundable_balance_onlineandrefundable_balance_offlinein any included wallets.
27th May 2022
- Added GET /currencies to retrieve all company currencies.
- Added GET /shops to retrieve all cashless shops for a company, that this user has access to.
- Added GET /shop to retrieve a single cashless shop, if the user has access to it.
- Added
cashless_productas a permitted type for GET /sale-items. - Added
shopIdparameter to the GET /sale-items endpoint, allowing for the items relating to a specific shop to be retrieved. - Updated GET /sale-items to return all inventory sale items across events and shops, when no types are explicitly provided.
- Added
categoriesas a new relationship for responses via GET /sale-items. - Added the following new fields to the GET /sale-items response:
shopIdcategoriescustomPriceEnabledcustomPriceRequired- Added support for retrieving customers using an
nfcIdvia GET /customers. - Added support for retrieving order items using an
nfcIdvia GET /order-items. - As a side effect, the
nfcIdis now surfaced in the order item response. - Added
ewallet-onlineas a permitted payment method when auto completing a basket via POST /basket-items. - Added
nfcIdas a permitted parameter when completing a basket via POST /basket-items allowing the order to be linked to an NFC tag. - Added POST /wallets/cashout to create a cash-out from a cashless wallet, for a user.
- Added
POST /wallets/nfc-downloadandPOST /wallets/nfc-download/confirmendpoints to handle the 2-step process of downloading wallet balances to an NFC media item. - Added POST /orders/upload endpoint to allow for bulk uploading offline orders for reconciliation.
- Added support for offline zone entry controls with the following new additions to the API:
- Added
includeZonesflag to the GET /entry/tickets endpoint, which returns a newzoneDatakey including zone IDs each item is eligible for entry, as well as any previous scans associated with the order item. - Updated POST /entry/tickets endpoint to accept
uuid,zoneId,latitude,longitude,scanas optional extra keys per item
- Added
- Added
companiesto GET /event and GET /events as an optional relationship include. - Added
latitudeandlongitudeto GET /event and GET /events when including thevenuesrelationship. - Added GET /basket/data-capture endpoint for retrieving data capture questions for a given basket.
- Added the following attributes to
DataCaptureFieldJSON:API Resource:assignedToEntityassignedToIdquestionIdsourceEntityTypesourceEntityIdorderColumncreatedAtupdatedAtdeletedAtThese attributes will appear on GET /event andGET/basket/data-capture
- Added
customerId,customerNameandcustomerEmailtoGET /basket-itemsas an optional alternative tobasketId - New endpoint POST /order-item/approve will allow you to approve or reject existing order items
28th February 2022
- Added
includeProductsas an option to GET /entry/tickets to include product barcodes in the valid tickets list. - Automatically include valid addon tickets in GET /entry/tickets.
- Accept product/addon product/addon ticket barcodes in POST /entry/tickets.
- Added the
interacPresentoption to POST /checkout/create-payment-intent to support Interac payments in Canada. - Added a
dataLastSynchronisedattribute to GET /report to signify when the report data was generated. - Added a
refreshquery parameter to GET /report to clear any cached report data and regenerate the report. - Added a
headersattribute to GET /report - Added
tagsandtagCategoriesto GET /event as data that can be included - Added
tagCategoriesto GET /events as data that can be included
24th January 2022
- Added
country,city, andregionto our Customer Resource, meaning this information is available directly via the GET /customers and GET /customer, and any other endpoint in which customers can beincludevia a resource relationship. - Standardised date formats across the entire API. The following dates have been changed:
- GET /activated-events
*.startfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ*.endfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- POST /discount-codes/buy-x-get-y
data.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.validFromfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.validTofrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- POST /discount-codes/buy-x-get-y/update
data.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.validFromfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.validTofrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- POST /company/users
data.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (companyUsers, visibilityGroups and roles)included.*.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (companyUsers, visibilityGroups and roles)included.*.attributes.acceptedTermsAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (companyUsers)included.*.attributes.acceptedPrivacyAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (companyUsers)included.*.attributes.acceptedEmailOptInAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (companyUsers)
- POST /company/users/update
data.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (companyUsers, visibilityGroups and roles)included.*.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (companyUsers, visibilityGroups and roles)included.*.attributes.acceptedTermsAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (companyUsers)included.*.attributes.acceptedPrivacyAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (companyUsers)included.*.attributes.acceptedEmailOptInAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (companyUsers)
- GET /company/users
data.*.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.*.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (companyUsers, visibilityGroups and roles)included.*.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (companyUsers, visibilityGroups and roles)included.*.attributes.acceptedTermsAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (companyUsers)included.*.attributes.acceptedPrivacyAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (companyUsers)included.*.attributes.acceptedEmailOptInAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (companyUsers)
- GET /company/user
data.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (companyUsers, visibilityGroups and roles)included.*.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (companyUsers, visibilityGroups and roles)included.*.attributes.acceptedTermsAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (companyUsers)included.*.attributes.acceptedPrivacyAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (companyUsers)included.*.attributes.acceptedEmailOptInAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (companyUsers)
- POST /orders/complete
datefrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZitems.*.eventStartDatefrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZitems.*.eventEndDatefrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- GET /customers
data.*.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.*.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.*.meta.lastUpdatedfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (companies and dataCaptureResponses)included.*.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (companies and dataCaptureResponses)
- POST /customers/update
data.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- POST /customers
data.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- GET /customer
data.*.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.*.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.*.meta.lastUpdatedfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (companies and dataCaptureResponses)included.*.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (companies and dataCaptureResponses)
- POST /data-capture-responses
data.*.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.*.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- GET /discount-codes
data.*.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.*.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.*.attributes.validFromfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.*.attributes.validTofrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- GET /discount-code
data.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.validFromfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.validTofrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- GET /entry/tickets
content.*.stable.validFromfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZcontent.*.stable.validTofrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZcontent.*.variable.scannedOnfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZcontent.*.variable.scannedOnfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZlistEndTimefrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- GET /event-tickets
tickets.*.validFromfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZtickets.*.validTofrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZtickets.*.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZtickets.*.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- GET /events
events.*.endfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZevents.*.startfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZevents.*.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZevents.*.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZevents.*.meta.lastUpdatedfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZevents.*.tags.*.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZevents.*.tags.*.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- GET /event
data.attributes.startDatefrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.endDatefrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- POST /events
data.attributes.startDatefrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.endDatefrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (eventSettings, eventStreams, tags, venues)included.*.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (eventSettings, eventStreams, tags, venues)
- POST /events/update
data.attributes.startDatefrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.endDatefrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (eventSettings, eventStreams, tags, venues)included.*.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (eventSettings, eventStreams, tags, venues)
- POST /discount-codes/fixed
data.attributes.validFromfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.validTofrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- POST /discount-codes/fixed/update
data.attributes.validFromfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.validTofrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- GET /inventory-items
data.*.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.*.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- GET /order-items
data.*.attributes.approvedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.*.attributes.rejectedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.*.attributes.cancelledAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.*.attributes.validFromfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.*.attributes.validTofrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.*.meta.lastUpdatedfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (customers, items, saleItems)included.*.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (customers, items, saleItems)included.*.attributes.startDatefrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (events)included.*.attributes.endDatefrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (events)included.*.attributes.expiresAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (orders)included.*.attributes.completedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (orders)
- GET /order-item
data.attributes.approvedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.rejectedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.cancelledAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.validFromfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.validTofrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.meta.lastUpdatedfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (customers, items, saleItems)included.*.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (customers, items, saleItems)included.*.attributes.startDatefrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (events)included.*.attributes.endDatefrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (events)included.*.attributes.expiresAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (orders)included.*.attributes.completedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ (orders)
- GET /orders
orders.*.datefrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZorders.*.items.*.eventStartDatefrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZorders.*.items.*.eventEndDatefrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- GET /order
datefrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZitems.*.eventStartDatefrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZitems.*.eventEndDatefrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- POST /discount-codes/percentage
data.attributes.validFromfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.validTofrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- POST /discount-codes/percentage/update
data.attributes.validFromfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.validTofrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- POST /events/charities
data.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- POST /events/charities/update
data.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.onSaleFromfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.onSaleTofrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.validFromfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.validUntilfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- POST /events/guest-lists
data.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- POST /events/guest-lists/update
data.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.onSaleFromfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.onSaleTofrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.validFromfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.validUntilfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- POST /events/products
data.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- POST /events/products/update
data.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.onSaleFromfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.onSaleTofrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.validFromfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.validUntilfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- POST /events/tickets
data.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- POST /events/tickets/update
data.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.onSaleFromfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.onSaleTofrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.validFromfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.attributes.validUntilfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZincluded.*.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- GET /sale-items
saleItems.*.validFromfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZsaleItems.*.validUntilfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZsaleItems.*.onSaleFromfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZsaleItems.*.onSaleTofrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZsaleItems.*.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZsaleItems.*.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZtimeslots.*.startAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZtimeslots.*.endAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- GET /transactions
data.*.attributes.createdAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZdata.*.attributes.updatedAtfrom YYYY-MM-DD HH:MM:SS to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- GET /zones/all
*.openingDatefrom YYYY-MM-DDTHH:mm:ss+HH:mm to YYYY-MM-DDTHH:mm:ss.SSSSSSZ*.closingDatefrom YYYY-MM-DDTHH:mm:ss+HH:mm to YYYY-MM-DDTHH:mm:ss.SSSSSSZ*.createdAtfrom YYYY-MM-DDTHH:mm:ss+HH:mm to YYYY-MM-DDTHH:mm:ss.SSSSSSZ*.updatedAtfrom YYYY-MM-DDTHH:mm:ss+HH:mm to YYYY-MM-DDTHH:mm:ss.SSSSSSZ*.deletedAtfrom YYYY-MM-DDTHH:mm:ss+HH:mm to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- POST /zones/scan
lastScannedInfrom YYYY-MM-DDTHH:mm:ss+HH:mm to YYYY-MM-DDTHH:mm:ss.SSSSSSZlastScannedOutfrom YYYY-MM-DDTHH:mm:ss+HH:mm to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- POST /zones/check
lastScannedInfrom YYYY-MM-DDTHH:mm:ss+HH:mm to YYYY-MM-DDTHH:mm:ss.SSSSSSZlastScannedOutfrom YYYY-MM-DDTHH:mm:ss+HH:mm to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- POST /tickets/pair
lastScannedInfrom YYYY-MM-DDTHH:mm:ss+HH:mm to YYYY-MM-DDTHH:mm:ss.SSSSSSZlastScannedOutfrom YYYY-MM-DDTHH:mm:ss+HH:mm to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- GET /zones/items
*.lastScannedInfrom YYYY-MM-DDTHH:mm:ss+HH:mm to YYYY-MM-DDTHH:mm:ss.SSSSSSZ*.lastScannedInfrom YYYY-MM-DDTHH:mm:ss+HH:mm to YYYY-MM-DDTHH:mm:ss.SSSSSSZ*.lastScannedInfrom YYYY-MM-DDTHH:mm:ss+HH:mm to YYYY-MM-DDTHH:mm:ss.SSSSSSZ*.lastScannedInfrom YYYY-MM-DDTHH:mm:ss+HH:mm to YYYY-MM-DDTHH:mm:ss.SSSSSSZ*.lastScannedInfrom YYYY-MM-DDTHH:mm:ss+HH:mm to YYYY-MM-DDTHH:mm:ss.SSSSSSZ
- GET /activated-events
- Added a
withTrashedrequest parameter along with adeletedAtattribute in the body of responses allowing you to retrieve deleted records from the following endpoints: - This
withTrashedparameter acts as a global setting, meaning that all deleted resources will be returned, including any related resources appearing in theincludedattribute in the response.
18th November 2021
- Added an array of Timeslot data to the GET /activated-events endpoint
- Improved order search by adding a
queryparameter to the[GET /orders](/api-reference/orders/retrieve-orders) endpoint, meaning you can now search orders by customer email, customer full name, order reference or event name. - New endpoint POST /guestdata added, which allows you to synchronise all guest list data to your access control device
- New endpoint PUT /guestdata created, which allows you to update the current number of guests that have attended (for a particular guest list order item).
- Added new
permissionsattribute to the GET /activated-events endpoint, containing information on whether the authenticated user can or cannot edit the event. - Added a new
hideAttendeesattribute to the GET /zones/all endpoint, allowing for us to control if the attendees tab in the access control app is or is not visible.
