This method will start an order if needed, and then add items to the order.
Parameters
appKey
string
A key identifying the application making the call
userKey
string
A key identifying the user making the call
corpOrgID
int
The corp organization ID
buyerTypeID
int
The buyer type ID
customerID
long
optional
The customer ID
memberID
long
optional
The member ID
orderID
long
optional when first starting order
The order ID
transactionID
long
optional when first starting order
The transaction ID
inventoryGroupID
int
optional
The inventory group ID to access non-default or restricted inventory
items
json object array
The list of item data json objects which needs to be added to the order. Parameter should be passed in POST body.
Examples:
Events – [{‘Type’: 1, ‘ID’: {EVENTID}, ‘Quantity’: {QUANTITY}, ‘TierID’: {TIERID}, ‘PriceType’: ‘{PRICETYPE}’, ‘PromoCode’: ‘{Empty string if none – PROMOCODE}’, ‘VariableAmount’: {Optional – VARIABLEAMOUNT}}]
Catalog – [{‘Type’: 2, ‘ID’: {ProductID}, ‘Quantity’: {QUANTITY}, ‘SkuID’: {SKUID}, ‘PriceType’: ‘{PRICETYPE}’, ‘PromoCode’: ‘{Empty string if none – PROMOCODE}’, ‘VariableAmount’: {Optional – VARIABLEAMOUNT}}]
Membership – [{‘Type’: 9, ‘ID’: {MembershipID}, ‘Quantity’: {QUANTITY}, ‘PriceType’: ‘{PRICETYPE}’, ‘RenewalID’: ‘{Optional - MEMBERID}’ ‘PromoCode’: ‘{Empty string if none – PROMOCODE}’, ‘VariableAmount’: {Optional – VARIABLEAMOUNT}}]
Donation – [{‘Type’: 11, ‘ID’: {DonationID}, ‘Quantity’: {QUANTITY}, ‘PriceType’: {DOLLARAMOUNT}}]
Gift Card/Certificate – [{‘Type’: 12, ‘ID’: {GiftProgramID}, ‘Quantity’: {QUANTITY}, ‘PriceType’: {DOLLARAMOUNT}}]
Examples:
Events – [{‘Type’: 1, ‘ID’: {EVENTID}, ‘Quantity’: {QUANTITY}, ‘TierID’: {TIERID}, ‘PriceType’: ‘{PRICETYPE}’, ‘PromoCode’: ‘{Empty string if none – PROMOCODE}’, ‘VariableAmount’: {Optional – VARIABLEAMOUNT}}]
Catalog – [{‘Type’: 2, ‘ID’: {ProductID}, ‘Quantity’: {QUANTITY}, ‘SkuID’: {SKUID}, ‘PriceType’: ‘{PRICETYPE}’, ‘PromoCode’: ‘{Empty string if none – PROMOCODE}’, ‘VariableAmount’: {Optional – VARIABLEAMOUNT}}]
Membership – [{‘Type’: 9, ‘ID’: {MembershipID}, ‘Quantity’: {QUANTITY}, ‘PriceType’: ‘{PRICETYPE}’, ‘RenewalID’: ‘{Optional - MEMBERID}’ ‘PromoCode’: ‘{Empty string if none – PROMOCODE}’, ‘VariableAmount’: {Optional – VARIABLEAMOUNT}}]
Donation – [{‘Type’: 11, ‘ID’: {DonationID}, ‘Quantity’: {QUANTITY}, ‘PriceType’: {DOLLARAMOUNT}}]
Gift Card/Certificate – [{‘Type’: 12, ‘ID’: {GiftProgramID}, ‘Quantity’: {QUANTITY}, ‘PriceType’: {DOLLARAMOUNT}}]
Return Values
An order data structure with the following fields
OrderID
long
The order ID
OrderNumber
string
The order number
TransactionID
long
The transaction ID
OpenDateTime
datetime
The date/time the transaction was started
OpenDate
YYYY-MM-DDThh:mm:ss string (ISO 8601)
The date/time the transaction was started formatted as YYYY-MM-DDThh:mm:ss
CloseDateTime
datetime
The date/time the transaction was finalized
CloseDate
YYYY-MM-DDThh:mm:ss string (ISO 8601)
The date/time the transaction was finalized formatted as YYYY-MM-DDThh:mm:ss
ExpirationDateTime
datetime
The date/time the transaction is set to expire
ExpirationDate
YYYY-MM-DDThh:mm:ss string (ISO 8601)
The date/time the transaction is set to expire formatted as YYYY-MM-DDThh:mm:ss
Expired
bool
An indicator that the transaction has expired
InProcess
bool
An indicator that the transaction is in process
BuyerTypeID
int
The buyer type ID for the order
CustomerID
long
The customer ID for the order
ContactCustomerID
long
The contact customer ID for the order
Subtotal
decimal
The current order total excluding fees
OrderTotal
decimal
The current order total including fees
ItemCount
int
The current number of items in the order
ItemSummary
list
The list of items currently in the order
Type
int
The type of item on the order (1 – Event, 2 – Product, 9 – Membership, 11 – Donation, 12 – Gift Card)
ID
long
The ID of the item
Quantity
int
The quantity of this item in the order
Description
string
A short description of the item
Barcode
string
A barcode for the item if available
SeatDetail
string
Seat detail for the item if available
Name
string
Name of the Item
PriceType
string
Type of price
PromoCode
string
Promotion Code
TierID
long
Price Tier ID
TierName
string
Price Tier Name
VenueName
string
The name of the venue (Event type only)
StartDate
datetime
The start date of the event (Event type only)
StartDateTime
YYYY-MM-DDThh:mm:ss string (ISO 8601)
The start date/time of the event formatted as YYYY-MM-DDThh:mm:ss (Event type only)
Prices
list
The list of price levels for this item
Category
string
The price category name
Type
string
The price category type (Base, Tax, TicketFee, ServiceFee)
Amount
decimal
The price amount
VariableAmount
decimal
Variable dollar amount if used
PaymentTotal
decimal
The current payment total applied on the order
RemainingBalance
decimal
The current payment total remaining on the order
CashPaymentID
int
The Payment Method ID of Cash payments if allowed (-1 if not)
TransferURL
string
Checkout URL
Errors
ApplicationKeyMissing
1000
Required parameter appkey is missing or invalid
UserCredentialsMissing
1001
Required user credentials are missing or invalid
SecurityInsufficient
1002
User security does not permit access to the requested function
RequiredParameter
1028
Required parameter is missing
DefaultWebServiceGroupRequired
1010
Default web service group must be set up
RequiredBuyerTypeInfoMissing
1030
Required buyer type is invalid
MemberNotValid
1025
Membership currently not valid
MemberRenewalRequired
1024
Membership renewal required
MemberExpired
1023
Membership expired
CustomerNotFound
1021
Customer not found
OrderTransactionInvalid
1031
Order/Transaction information is invalid
InvalidTicketRequest
1032
Invalid ticket request
TransactionExpired
1035
Transaction expired
TransactionClosed
1036
Transaction closed
InvalidTicketQtyRequest
1033
Invalid ticket quantities
InvalidPromoCode
1034
Invalid promo code
AutoAssignFailed
1037
The tickets could not be auto assigned
CompAutoAssignFailed
1038
The extra assignment policy tickets could not be auto assigned
ItemNotOnSale
1041
The requested item is not currently on sale
Example Request
https://prod1.agileticketing.net/api/sales.svc/json/OrderAddItems?appkey={APPKEY}&userkey={USERKEY}&corporgid={CORPORGID}&buyertypeid={BUYERTYPEID}&customerid={CUSTOMERID}&orderid={ORDERID}&transactionid={TRANSACTIONID}&
Post Body – “items”: “[{‘Type’: 1, ‘ID’: {EVENTID}, ‘Quantity’: {QUANTITY}, ‘TierID’: {TIERID}, ‘PriceType’: ‘{PRICETYPE}’}]”
Example JSON Response
{
"OrderID":9223372036854775807,
"OrderNumber":"String content",
"TransactionID":9223372036854775807,
"OpenDateTime":"\/Date(928167600000-0500)\/",
"OpenDate":"YYYY-MM-DDThh:mm:ss",
"CloseDateTime":"\/Date(928167600000-0500)\/",
"CloseDate":"YYYY-MM-DDThh:mm:ss",
"ExpirationDateTime":"\/Date(928167600000-0500)\/",
"ExpirationDate":"YYYY-MM-DDThh:mm:ss",
"Expired":true,
"InProcess":true,
"BuyerTypeID":2147483647,
"CustomerID":9223372036854775807,
"ContactCustomerID":9223372036854775807,
"Subtotal":12678967.543233,
"OrderTotal":12678967.543233,
"ItemCount":2147483647,
"ItemSummary":[{
"Type":2147483647,
"ID":9223372036854775807,
"Quantity":2147483647,
"Description":"String content",
"Barcode":"String content",
"SeatDetail":"String content",
"Name":"String content",
"PriceType":"String content",
"PromoCode":"String content",
"TierID":9223372036854775807,
"TierName":"String content",
"VenueName":"String content",
"StartDate":"\/Date(928167600000-0500)\/",
"StartDateTime": "YYYY-MM-DDThh:mm:ss",
"Prices":[{
"Category":"String content",
"Type":"String content",
"Amount":12678967.543233
}],
"VariableAmount":12678967.543233
}],
"PaymentTotal":12678967.543233,
"RemainingBalance":12678967.543233,
"CashPaymentID":2147483647,
"TransferURL":"String content"
}
Example XML Response
<Order xmlns="http://www.agiletix.com/api">
<OrderID>9223372036854775807</OrderID>
<OrderNumber>String content</OrderNumber>
<TransactionID>9223372036854775807</TransactionID>
<OpenDateTime>1999-05-31T11:20:00</OpenDateTime>
<OpenDate>1999-05-31T11:20:00</OpenDate>
<CloseDateTime>1999-05-31T11:20:00</CloseDateTime>
<CloseDate>1999-05-31T11:20:00</CloseDate>
<ExpirationDateTime>1999-05-31T11:20:00</ExpirationDateTime>
<ExpirationDate>1999-05-31T11:20:00</ExpirationDate>
<Expired>true</Expired>
<InProcess>true</InProcess>
<BuyerTypeID>2147483647</BuyerTypeID>
<CustomerID>9223372036854775807</CustomerID>
<ContactCustomerID>9223372036854775807</ContactCustomerID>
<Subtotal>12678967.543233</Subtotal>
<OrderTotal>12678967.543233</OrderTotal>
<ItemCount>2147483647</ItemCount>
<ItemSummary>
<Item>
<Type>2147483647</Type>
<ID>9223372036854775807</ID>
<Quantity>2147483647</Quantity>
<Description>String content</Description>
<Barcode>String content</Barcode>
<SeatDetail>String content</SeatDetail>
<Name>String content</Name>
<PriceType>String content</PriceType>
<PromoCode>String content</PromoCode>
<TierID>9223372036854775807</TierID>
<TierName>String content</TierName>
<VenueName>String content</VenueName>
<StartDate>1999-05-31T11:20:00</StartDate>
<StartDateTime>2030-05-07T21:00:00</StartDateString>
<Prices>
<Price>
<Category>String content</Category>
<Type>String content</Type>
<Amount>12678967.543233</Amount>
</Price>
</Prices>
<VariableAmount>12678967.543233</VariableAmount>
</Item>
</ItemSummary>
<PaymentTotal>12678967.543233</PaymentTotal>
<RemainingBalance>12678967.543233</RemainingBalance>
<CashPaymentID>2147483647</CashPaymentID>
<TransferURL>String content</TransferURL>
</Order>
Comments