Documentation Index
Fetch the complete documentation index at: https://docs.nuwebgroup.com/llms.txt
Use this file to discover all available pages before exploring further.
Overview
Basket links allow external systems to build a shopping basket through the API and generate a secure URL that takes a customer directly into the ticket shop with items already reserved. When the customer clicks the link, the basket is loaded into their session and they can proceed straight to checkout. This is useful for:- Third-party booking platforms that handle event selection but need to hand off to the ticket shop for payment
- Marketing campaigns with pre-configured item selections
- Custom integrations that build baskets programmatically
How It Works
1. Create a Basket via the API
An external system calls the API to add items to a basket, including thegenerateBasketUrl parameter set to true. The API response includes a startBasketUrl field β a cryptographically signed URL pointing to the ticket shop.
The API request can also include optional redirect URLs:
- Success redirect URL β where the customer is sent after completing checkout (receives
order_idandcustomer_idas query parameters) - Failure redirect URL β where the customer is sent if payment fails (receives
basket_idandcustomer_idas query parameters)
2. Customer Clicks the Link
When a customer clicks the basket link:- The system validates the signed URL and checks the basket is still active and not expired
- If the basket belongs to a registered customer, they are automatically logged in
- Any other active baskets the customer has are expired
- The pre-built basket is loaded into the customerβs session
- The customer is redirected to the basket page with all items ready
3. Customer Completes Checkout
From this point, the experience is identical to a normal purchase. The customer can:- Review the items in their basket
- Apply discount codes or access codes
- Add or remove items (unless the API request flagged items as non-modifiable)
- Proceed through checkout and payment
Security
Basket links use Laravelβs signed URL mechanism:- Each link contains a cryptographic signature that prevents tampering
- Links are validated before any basket data is accessed
- If a logged-in user tries to access a basket belonging to a different user, they are redirected with an error
- The internal confirmation step uses a 1-minute time-limited signature for additional security
Restrictions
- One purchase per link β once a basket is activated and the order completes, the link cannot be reused
- Expiry β if the basket expires (based on the configured basket timeout), the link becomes invalid
- Event cancellations β if any items in the basket are for a cancelled event, the link returns an error
- Customer context only β basket links are for customer use; they cannot be activated in box office mode
Related Pages
API Reference
Create baskets programmatically using the API.
Checkout
The checkout flow customers complete after clicking a basket link.
Basket
How the basket works, including timeouts and item management.
