TABLE OF CONTENTS
Order Update
POST /v2/b2b/orders/update
Request Parameters
An OrderUpdate Input JSON Object
Response
A Response Order JSON Object
OrderUpdate Object
| Field | Description |
| orderId | The unique ID of the order object. Read only. |
| orderPosTransactionUUID | Transaction ID |
| accountContactId | Contact ID for the account or organization |
| notes | |
| orderItems | |
| orderItems[x].orderItemId | |
| orderItems[x].eventId | Event ID of the orderItem |
| orderItems[x].itemType | Limit Order Items to those that support the specified item type. Valid item types are:
|
| orderItems[x].itemTypeId | |
| orderItems[x].quantity | Total number of items |
| noEmail | Set to true if you do not want to send the email. Default is to send the email. |
| sendEmailToAll | flag to send email to all |
| payment | |
| payment.acmeToken | Unique token for the payment from ACME |
| payment.paymentProcessorToken | Token from the payment processor |
| payment.paymentProcessorFingerPrint | |
| payment.ccLastFourDigits | Last four digits of credit card used |
| payment.creditCardBrand | Credit card Brand (e.g. Visa, Mastercard, American Express) |
| payment.externalChargeId | ID from the external management like Salesforce |
| payment.paymentId | |
| payment.manualEntryCardNumber | 16 digits card number |
| payment.cvc | 3 digit security code |
| payment.encTrack1 | |
| payment.encTrack2 | |
| payment.encmp | |
| payment.ksn | |
| payment.devSN | |
| payment.mpStatus | |
| payment.magTekCardType | |
| payment.encryptionBlockKey | |
| payment.expDate | Credit Card Expiration Date |
| payment.chargeAmount | Total Amount charged in the card |
| payment.postTransactionUUID | Transaction ID |
| payment.terminalId | ID of the point of sale terminal associated with the payment |
| payment.creditCardVerificationData | |
| payment.marketCode | |
| payment.terminalCapabilities | |
| payment.paymentPresentationTypeEnum | |
| payment.firstName | |
| payment.lastName | |
| payment.contactEmail | |
| payment.phoneNumber | |
| payment.address | |
| payment.checkNumber | |
| payment.checkDate | |
| payment.voucherNumber | |
| payment.giftCardNumber | |
| payment.expressTransactionId | |
| payment.debit | |
| payment.paymentType | |
| Email of the order contact | |
| contactFirstName | First name of the order contact |
| contactLastName | Last name of the order contact |
| zipCode | Zip/Post code of the order contact |
| phoneNumber | Phone of the order contact |
| incidentReasonCode | |
| terminalId | ID of the POS sales terminal |
| billingFirstName | First name of the billing contact |
| billingLastName | Last name of the billing contact |
| billingEmail | Email address of the billing contact |
| billingAddress1 | Address line 1 of the billing contact |
| billingAddress2 | Address line 2 of the billing contact |
| billingCountry | Country of the billing contact |
| billingCity | City of the billing contact |
| billingZipCode | Zip/Postcode of the billing contact |
| billingState | State/Province of the billing contact |
| billingPhoneNumber | Phone of the billing contact |
| organizationId | Unique database ID of the organization associated with the order |
| accountName | Organization name associated with the order |
OrderResult Object
| Field | Description |
| id | Order Id |
| tenantId | |
| organizationId | |
| organizationName | |
| visitorId | Visitor is an internal only field - ACME - do not use |
| tempVisitorId | Visitor is an internal only field - ACME - do not use |
| contactFirstName | |
| contactLastName | |
| address1 | |
| address2 | |
| country | |
| city | |
| state | |
| zipCode | |
| billingEmail | |
| billingFirstName | |
| billingLastName | |
| billingAddress1 | |
| billingAddress2 | |
| billingCountry | |
| billingCity | |
| billingZipCode | |
| billingState | |
| billingPhoneNumber | |
| phoneNumber | |
| orderNumber | |
| discountedOriginalTotalAmount | Original Total Amount after Discount |
| originalTotalAmount | Original Total Amount |
| discountedTotalAmount | Total Amount After Discount |
| totalAmount | Total Amount |
| paidAmount | |
| balanceAmount | Balance of Total to be paid |
| refundAmount | Amount being refunded |
| saleChannel | Limit events to those that support the specified sale channel. Valid sale channels are:
|
| checkInStatus | Limit check in status to those that support the specified status. Valid check in status are:
|
| orderExceptionCodeId | Exception Code |
| orderExceptionCodeName | |
| notes | |
| postUUID | |
| creationDate | Order Creation Date |
| orderItems | |
| orderItems[x].orderItemId | |
| orderItems[x].eventId | Event Id of the orderItem |
| orderItems[x].itemType | Limit Order Items to those that support the specified item type. Valid item types are:
|
| orderItems[x].itemTypeId | |
| orderItems[x].quantity | Number of tickets of the orderItem |
| createdOn | Order Creation Date |
| createdBy | |
| updatedOn | |
| updatedBy | |
| paymentDueDate | |
| ticketDelivery | Limit Ticket Delivery to those that support the specified ticket delivery. Valid item types are:
|
| ticketExpiredDays | Days since the ticket expired |
| legacy | |
| hiddenEventDate | |
| membershipId | Membership Id if the order is a membership purchase |
| couponId | Coupon applied during the purchase |
| ccLastFourDigits | Last four digits of the credit card |
| paymentId | |
| accountContactId | |
| orderRequestId | |
| invoiceAfter | |
| customerId | |
| obfuscated |
Refund vs Canceling using Order Update
Refund:
This API can be used to avail refund.
When we send a request with orderItems[x].quantity less than the actual ordered quantity it will result in a refund.
Cancel:
Similar to the Refund. If the orderItems is voided by setting orderItems[x].quantity as 0, it will result in the order cancellation.
Example of Order Update result in Refund and Cancel:
This is an order with Order ID: 26644388 paid an order $400 for 4 tickets costing $100 each
NOTE: If you cancel the order by updating the order items to have quantity = 0, this will not trigger the refund email. If you would like to trigger a refund email, please use the Refund API. The order update will send the Order Confirmation email.
Now when we use the Update API as follows
/v2/b2b/orders/update
Body
{
"orderId": "26644388",
"orderItems": [
{
"orderItemId": "38042229",
"quantity": 0
}
]
}Response
{
"id": "26644388",
"tenantId": 107,
"visitorId": "1076467",
"email": "michele+bradClarke@acmeticketing.com",
"billingEmail": "michele+bradClarke@acmeticketing.com",
"contactFirstName": "Brad",
"contactLastName": "Clarke",
"billingFirstName": "Brad",
"billingLastName": "Clarke",
"orderNumber": "100130807",
"discountedTotalAmount": "0.00",
"totalAmount": "0.00",
"discountedOriginalTotalAmount": "400.00",
"originalTotalAmount": "400.00",
"paidAmount": "400.00",
"balanceAmount": "0.00",
"refundAmount": "400.00",
"saleChannel": "Customer Rep",
"checkInStatus": "NotCheckedIn",
"creationDate": "2020-05-29T16:15:15-07:00",
"paymentDueDate": "2020-05-29T16:15:15-07:00",
"createdOn": "2020-05-29T16:15:15-07:00",
"createdBy": "2258",
"updatedOn": "2020-06-01T19:19:09-07:00",
"updatedBy": "340",
"ticketDelivery": "willCall",
"legacy": false,
"hideEventDate": false,
"invoiceAfter": false,
"customerId": 4762835,
"obfuscated": false
}The above response shows that the amount $400 has been refunded and so the order is cancelled.
Resending the Order Confirmation email
This email is used to resend the Order Confirmation email.
POST /v2/b2b/orders/{orderId}/emailRequest Parameters
An EmailUpdate Input JSON Object
Response
A Response Order JSON Object
Resend Email Object
| Field | Type | Description | Required |
| string | The email address you want the Order Confirmation to be sent to. NOTE: if contact email does not exist it will be updated with this value. | Yes | |
| sendemail | boolean | Send the Order Confirmation email if true | No; default is false |
{
"email":"name@acmeticketing.com",
"sendEmail":true
}
{
"email":"name@acmeticketing.com",
"sendEmail":true
}