Ignition Baskets API

An API for Basket’s operations, base path is https://ignition.ticketek.com.au/baskets

• Version: v1

Get current API’s version information

• GET /version

Request parameters

None

Response parameters

Name	Type	Required	Description
major	Integer	false	–
minor	Integer	false	–
build	Integer	false	–
revision	Integer	false	–

A specific basket within the collection of managed baskets

• GET /{id}

Request parameters

Name	Type	Required	Description
id	String	true	Unique identifier (guid) for a managed basket
CorrelationId	–	true	A unique identifier value (in header) that is attached to requests and messages that allow reference to a particular transaction or event chain
Authorization	String	true	a valid oauth token. ( prepend token with ‘Bearer ‘ )
x-api-key	String	true	API Key

Response parameters

Name	Type	Required	Description
id	String	false	–
orderId	String	false	–
expiry	Date	false	–
basketOfferId	String	false	–
deliveryAddress	DeliveryAddress	false	–

• DeliveryAddress

Name	Type	Required	Description
name	String	false	–
address	String	false	–
city	String	false	–
state	String	false	–
postCode	String	false	–
country	String	false	–
countryCode	String	false	–
areaCode	String	false	–
phone	String	false	–
email	String	false	–

Destroys a Basket with it’s seats and pricing offers

• DELETE /{id}

Request parameters

Name	Type	Required	Description
id	String	true	Unique identifier (guid) for a managed basket
CorrelationId	–	true	A unique identifier value (in header) that is attached to requests and messages that allow reference to a particular transaction or event chain
Authorization	String	true	a valid oauth token. ( prepend token with ‘Bearer ‘ )
x-api-key	String	true	API Key

Response parameters

None

Create a BasketOffer with seats and pricing for an offer request for a new basket.

• POST /

Request parameters

Name	Type	Required	Description
CorrelationId	–	true	A unique identifier value (in header) that is attached to requests and messages that allow reference to a particular transaction or event chain
Authorization	String	true	a valid oauth token. ( prepend token with ‘Bearer ‘ )
x-api-key	String	true	API Key
performanceCode	String	true	–
productId	String	true	Unique identifier of the product that is being requested for an offer.
seatsRequirements	Array<SeatsRequirementsRequest>	false	–
offerSelections	Array<OfferSelectionRequest>	false	–
area	String	true	–
aisle	Aisle	false	–
holdCode	String	false	–
seasonCode	String	false	–
channel	Integer	true	–
throttlingSessionId	String	false	–
autoReduce	Boolean	false	–
fees	Array<FeeRequest>	false	–
context	OfferRequestContext	false	–

• SeatsRequirementsRequest

Name	Type	Required	Description
area	String	false	–
section	String	false	–
row	String	false	–
name	String	false	–
venueId	String	false	–
selectionNumber	String	false	–
specialRequirements	Array<String>	false	–
additionalRequirements	String	false	–

• OfferSelectionRequest

Name	Type	Required	Description
productId	String	false	–
area	String	false	–
holdCode	String	false	–
fromAvails	Boolean	false	–
selectionNumber	String	false	–
seats	Array<SeatRequest>	false	–

• FeeRequest

Name	Type	Required	Description
type	Integer	false	–
code	String	false	–
amount	Integer	false	–

• OfferRequestContext

Name	Type	Required	Description
customerId	Integer	false	–
orderId	String	false	–

• SeatRequest

Name	Type	Required	Description
section	String	false	–
row	String	false	–
name	String	false	–

Response parameters

None

Create an Order for the sales purchase of an existing basket

• POST /{id}/purchase

Request parameters

Name	Type	Required	Description
id	String	true	Unique identifier (guid) for a managed basket
CorrelationId	–	true	A unique identifier value (in header) that is attached to requests and messages that allow reference to a particular transaction or event chain
Authorization	String	true	a valid oauth token. ( prepend token with ‘Bearer ‘ )
x-api-key	String	true	API Key
payment	PurchaseRequestPayment	true	–
customer	BasketCustomer	true	–
amount	Integer	true	–
amountPayFee	Integer	false	–
currency	String	false	–
optIns	Array<OptIn>	false	–
consents	Array<Consent>	false	–
fees	Array<Fee>	false	–
channel	String	true	–

• PurchaseRequestPayment

Name	Type	Required	Description
paymentData	PaymentData	false	–
configuration	PaymentProviderConfiguration	false	–
merchantId	String	false	–

• BasketCustomer

Name	Type	Required	Description
customerListId	Integer	false	–
aFile	String	false	–
firstName	String	false	–
lastName	String	false	–
phone	String	false	–
email	String	false	–
addressLine1	String	false	–
addressLine2	String	false	–
street	String	false	–
city	String	false	–
state	String	false	–
postCode	String	false	–
addressType	String	false	–
country	Country	false	–

• OptIn

Name	Type	Required	Description
id	Integer	false	–
selected	Boolean	false	–

• Consent

Name	Type	Required	Description
id	Integer	false	–
selected	Boolean	false	–

• Fee

Name	Type	Required	Description
id	Integer	false	–
name	String	false	–
code	String	false	–
type	Integer	false	–
typeName	String	false	–
description	String	false	–
total	Integer	false	–

• PaymentData

Name	Type	Required	Description
pspReference	String	false	–
paymentToken	String	false	–

• PaymentProviderConfiguration

Name	Type	Required	Description
method	String	false	–
tenant	String	false	–
provider	String	false	–

• Country

Name	Type	Required	Description
id	String	false	–
name	String	false	–

Response parameters

Name	Type	Required	Description
orderId	String	false	–
signInToken	String	false	–

Create a new Offer in a BasketOffer with seat dibs and pricing for an offer request

• POST /{id}/offers

Request parameters

Name	Type	Required	Description
id	String	true	Unique identifier (guid) for a managed basket
CorrelationId	–	true	A unique identifier value (in header) that is attached to requests and messages that allow reference to a particular transaction or event chain
Authorization	String	true	a valid oauth token. ( prepend token with ‘Bearer ‘ )
x-api-key	String	true	API Key
performanceCode	String	true	–
productId	String	true	Unique identifier of the product that is being requested for an offer.
seatsRequirements	Array<SeatsRequirementsRequest>	false	–
offerSelections	Array<OfferSelectionRequest>	false	–
area	String	true	–
aisle	Aisle	false	–
holdCode	String	false	–
seasonCode	String	false	–
channel	Integer	true	–
throttlingSessionId	String	false	–
autoReduce	Boolean	false	–
fees	Array<FeeRequest>	false	–
context	OfferRequestContext	false	–

• SeatsRequirementsRequest

Name	Type	Required	Description
area	String	false	–
section	String	false	–
row	String	false	–
name	String	false	–
venueId	String	false	–
selectionNumber	String	false	–
specialRequirements	Array<String>	false	–
additionalRequirements	String	false	–

• OfferSelectionRequest

Name	Type	Required	Description
productId	String	false	–
area	String	false	–
holdCode	String	false	–
fromAvails	Boolean	false	–
selectionNumber	String	false	–
seats	Array<SeatRequest>	false	–

• FeeRequest

Name	Type	Required	Description
type	Integer	false	–
code	String	false	–
amount	Integer	false	–

• OfferRequestContext

Name	Type	Required	Description
customerId	Integer	false	–
orderId	String	false	–

• SeatRequest

Name	Type	Required	Description
section	String	false	–
row	String	false	–
name	String	false	–

Response parameters

None

Delete the collection of Offers from a Basket

• DELETE /{id}/offers

Request parameters

Name	Type	Required	Description
id	String	true	Unique identifier (guid) for a managed basket
CorrelationId	–	true	A unique identifier value (in header) that is attached to requests and messages that allow reference to a particular transaction or event chain
Authorization	String	true	a valid oauth token. ( prepend token with ‘Bearer ‘ )
x-api-key	String	true	API Key

Response parameters

None