Update


/v2/b2b/orders/update


Body

        A OrderUpdate Input JSON Object

Response

        A Response Order JSON Object


JSON Objects

OrderUpdate Input JSON Object

FieldDescriptionNotes
orderId

orderPosTransactionUUIDTransaction Id
accountContactIdContact Id for the account or organization
notes

orderItems

orderItems[x].orderItemId

orderItems[x].eventIdEvent Id of the orderItem

orderItems[x].itemTypeLimit Order Items to those that support the specified item type. Valid item types are:
  • Event
  • Inventory
  • Combo 
  • ComboInventory
  • RebookingFee
  • MembershipPurchase
  • MembershipRenewal
  • MembershipUpgrade
  • MembershipDowngrade
  • MembershipCancel
  • MembershipPostTermRenewal
  • MembershipRejoin
  • MembershipRenewalUpgrade
  • MembershipPostTermRenewalUpgrade
  • MembershipRejoinUpgrade
  • MembershipPostTermRenewalDowngrade
  • MembershipRejoinDowngrade
  • MembershipRenewalDowngrade
  • MembershipPurchaseConversion
  • MembershipReplacement
  • Donation


orderItems[x].itemTypeId


orderItems[x].quantity
Number of orders for the same order item

noEmailflag to send no email
sendEmailToAllflag 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
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 terminal in the venue
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

contactFirstName
contactLastName
zipCode
phoneNumber
incidentReasonCode

terminalIdId of the terminal in the venue

billingFirstName
billingLastName
billingEmail
billingAddress1
billingAddress2

billingCountry

billingCity

billingZipCode

billingState

billingPhoneNumber

accountId

accountName


Order Result JSON Object

FieldDescriptionNotes
idOrder Id
tenantId

organizationId

organizationName

visitorId

tempVisitorId

email

contactFirstName

contactLastName

address1

address2

country

city

state

zipCode

billingEmail

billingFirstName


billingLastName


billingAddress1

billingAddress2

billingCountry

billingCity

billingZipCode


billingState

billingPhoneNumber

phoneNumber

orderNumber

discountedOriginalTotalAmountOriginal Total Amount after Discount

originalTotalAmountOriginal Total Amount
discountedTotalAmountTotal Amount After Discount
totalAmountTotal Amount
paidAmount

balanceAmountBalance of Total to be paid
refundAmountAmount being refunded

saleChannelLimit events to those that support the specified sale channel. Valid sale channels are:
  • online
  • pointOfSale
  • insideSalesIndividual 
  • customerRep
  • salesForce




checkInStatusLimit check in status to those that support the specified status. Valid check in status  are:
  • NotCheckedIn
  • CheckedIn
  • PartiallyCheckedIn 


orderExceptionCodeIdException Code 
orderExceptionCodeName

notes

postUUID

creationDateOrder 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:
  • Event
  • Inventory
  • Combo 
  • ComboInventory
  • RebookingFee
  • MembershipPurchase
  • MembershipRenewal
  • MembershipUpgrade
  • MembershipDowngrade
  • MembershipCancel
  • MembershipPostTermRenewal
  • MembershipRejoin
  • MembershipRenewalUpgrade
  • MembershipPostTermRenewalUpgrade
  • MembershipRejoinUpgrade
  • MembershipPostTermRenewalDowngrade
  • MembershipRejoinDowngrade
  • MembershipRenewalDowngrade
  • MembershipPurchaseConversion
  • MembershipReplacement
  • Donation


orderItems[x].itemTypeId


orderItems[x].quantity
Number of tickets of the orderItem
createdOnOrder Creation Date
createdBy

updatedOn

updatedBy

paymentDueDate

ticketDeliveryLimit Ticket Delivery to those that support the specified ticket delivery. Valid item types are:
  • print
  • willCall


ticketExpiredDaysDays since the ticket expired
legacy

hiddenEventDate

membershipIdMembership Id if the order is a membership purchase
couponIdCoupon applied during the purchase
ccLastFourDigitsLast four digits of the credit card
paymentId


accountContactId

orderRequestId

invoiceAfter

customerId

obfuscated




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 eachNow 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.