Follow

API Method - Order Void

This method will attempt to Void an Order. It will require that the order has voidable payment methods.
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
orderID
 
long
The order ID
transactionID
 
long
The transaction ID
includeItemSummary
 
bool
 
optional
Indicates that this method should include a high level item summary
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
Empty list since the order was just voided
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
OrderTransactionInvalid
 
1031
Order/Transaction information is invalid
OrderVoidInvalid
 
1043
This order is not currently voidable
Example Request
https://prod1.agileticketing.net/sales.svc/json/OrderVoid?appkey={APPKEY}&userkey={USERKEY}&corporgid={CORPORGID}&orderid={ORDERID}&transactionid={TRANSACTIONID}&includeitemsummary={INCLUDEITEMSUMMARY}
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":[],
	"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>
  </ItemSummary>
  <PaymentTotal>12678967.543233</PaymentTotal>
  <RemainingBalance>12678967.543233</RemainingBalance>
  <CashPaymentID>2147483647</CashPaymentID>
  <TransferURL>String content</TransferURL>
</Order>
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments