TABLE OF CONTENTS


B2B Checkout

Start by reviewing Checkout APIs - Best Practices and Security to increase security and reduce duplicate transaction.


Use this endpoint to facilitate back office checkout use cases.  Please note:

  • If you are building an e-commerce website, please use this B2C endpoint
  • If you would like to facilitate the following types of use cases, you can consider this API, however please note the sale channel will be InsideSalesIndividual:
    • Selling private events
    • Paying by cash, check, voucher


POST v2/b2b/orders/checkout


Request Parameters


Include a CheckoutB2BInput Object as the body of the request (see below)


Return Parameters


Returns a Order Object (see Orders)



CheckoutB2BInput Object


  • If the contact information is not fully populated (first name, last name and phone, email, or zip code):
    • It will be pulled from the membership primary cardholder in the case of a membership order
  • Billing information will be copied from contact information.
    • If the information exactly matches an existing customer, that customer will be associated with the order
    • Otherwise a new customer will be created


Field
Type
Description
Required
shoppingCartIdstringShopping cart id, if using shopping cart APIsif applicable
emailstringcontact email address
phoneNumberstringcontact phone number
contactFirstNamestring
contactLastNamestring
contactFullNamestring

zipCodestringcontact zip code
acmeTokenstringinternal use only
paymentProcessorTokenstringinternal use only
paymentProcessorFingerPrintstringinternal use only
ccLastFourDigitsstring

creditCardBrandCreditCardBrand
  • Visa
  • MasterCard
  • AmericanExpress
  • Discover
  • Jcb
  • DinersClub
giftCardNumberstringdeprecated
expDatestringCredit card expiration date (MMYY)yes
manualEntryCardNumberstringCredit card PANyes
cvcstringCredit card CVCyes
notesstringadd notes to an order
shoppingCartShoppingCartShopping cart object, if not using shopping cart APIsif applicable
checkoutFormsList<CheckoutForms>internal use only
paymentMethodPaymentMethod
  • CreditCard
  • Cash
  • Check
  • GiftCard
  • Voucher
  • Other

yes
paymentIdstringpayment id if paying with check, voucherif applicable
chargeAmountCurrency

ticketDeliveryTicketDelivery
  • print  (for print at home - requires email be sent)
  • willCall

noEmailboolean
  • true (don't send any emails)
  • false (send emails)

sendEmailToAllbooleansend emails to all emails on the order (not just billing) 
saleChannelSaleChannel
  • online
  • pointOfSale
  • reseller
  • insideSalesIndividual
  • kiosk
  • salesforce

By default this will be set to insideSalesIndividual
invoicebooleandeprecated



Sample Requests and Responses


Purchase a membership sample request


POST https://sand10-api.acmeticketing.net/v2/b2b/checkout

{
  "contactFirstName" : "contactFirstName",
  "contactLastName" : "contactLastName",
  "address1" : "contact address 1",
  "address2" : "contact address 2",
  "country" : "contact country",
  "city" : "contact city",
  "state" : "contact state",
  "zipCode" : "95148",
  "phoneNumber" : "408-222-2345",
  "contactEmail" : "john@acme.com",
  "notes" : "notes",
  "expDate" : "1220",
  "manualEntryCardNumber" : "4242424242424242",
  "cvc" : "123",
  "paymentMethod" : "CreditCard",
  "shoppingCart" : {
    "items": 
     [ {
    "itemType" : "MembershipPurchase",
    "quantity": 1,
    "membershipInfo" : {
      "membershipCategoryId" : "59b0abcf61a307524a6a37d6",
      "membershipOfferingId" : "46257da699a845b486363e2aec0642f5",
      "pricePointId" : "58123480969c6d59d976b8fa",
      "membershipCards" : [ {
        "cardType" : "primary",
        "name" : "Jon Doe",
        "email" : "doe@gmail.com",
        "firstName" : "John",
        "lastName" : "Doe",
        "prefix" : "Mr",
        "phoneNumber" : "408-222-3333",
        "streetAddress1" : "street1",
        "streetAddress2" : "street2",
        "city" : "city",
        "state" : "state",
        "zipCode" : "zip",
        "country" : "country",
        "orgName" : "Acme Inc",
        "deceased" : "no",
        "primaryCard" : "yes",
        "startDate" : "1969-12-31T19:00:01-05:00",
        "expirationDate" : "2030-01-18T22:14:07-05:00"
      } ],
      "waiveBenefits" : false,
      "notifyGiftRecipient" : false,
      "gift" : false
    }
  } ]
  }
}


Purchase a membership sample response


{
    "id": "27191831",
    "tenantId": 107,
    "contactFirstName": "contactFirstName",
    "contactLastName": "contactLastName",
    "billingFirstName": "contactFirstName",
    "billingLastName": "contactLastName",
    "billingAddress1": "contact address 1",
    "billingAddress2": "contact address 2",
    "billingCountry": "contact country",
    "billingCity": "contact city",
    "billingZipCode": "95148",
    "billingState": "contact state",
    "address1": "contact address 1",
    "address2": "contact address 2",
    "country": "contact country",
    "city": "contact city",
    "state": "contact state",
    "zipCode": "95148",
    "phoneNumber": "408-222-2345",
    "billingPhoneNumber": "408-222-2345",
    "orderNumber": "100121704",
    "discountedTotalAmount": "12.00",
    "totalAmount": "12.00",
    "discountedOriginalTotalAmount": "12.00",
    "originalTotalAmount": "12.00",
    "paidAmount": "12.00",
    "balanceAmount": "0.00",
    "refundAmount": "0.00",
    "saleChannel": "InsideSalesIndividual",
    "checkInStatus": "NotCheckedIn",
    "notes": "notes",
    "creationDate": "2020-06-24T20:02:50-07:00",
    "paymentDueDate": "2020-06-24T20:02:50-07:00",
    "orderItems": [
        {
            "itemId2": "46257da699a845b486363e2aec0642f5",
            "itemName": "Ind",
            "pricePointId": "58123480969c6d59d976b8fa",
            "pricePointName": "Adult",
            "itemDetailId": "3718678",
            "parentItemId": "38815687",
            "comboTemplateType": "fixedPrice",
            "basicOriginalQuantity": 1,
            "originalQuantity": 1,
            "basicQuantity": 1,
            "quantity": 1,
            "unitPrice": "12.00",
            "discountedUnitPrice": "12.00",
            "discountedOriginalAmount": "12.00",
            "originalAmount": "12.00",
            "discountedAmount": "12.00",
            "amount": "12.00",
            "balanceAmount": "0.00",
            "itemType": "MembershipPurchase",
            "itemTypeNg": "Event",
            "conversionStatus": "NoConversion",
            "itemId": "38815687"
        }
    ],
    "createdOn": "2020-06-24T20:02:50-07:00",
    "createdBy": "340",
    "updatedOn": "2020-06-24T20:02:51-07:00",
    "updatedBy": "340",
    "legacy": false,
    "hideEventDate": false,
    "membershipId": 3718678,
    "invoiceAfter": false,
    "customerId": 5381598,
    "obfuscated": false
}


Purchase an Auto Renew membership sample request. Things to note:

  • Auto Renew memberships must be processed with a credit card, even if there is no payment due, in order to generate a secure token for future processing. 
  • Auto Renew memberships not paid with credit card will result in subscriptions with no payment method attached. 
  • Optional Auto Renew memberships require the flag membershipInfo.isAutorenew (see B2C Purchase New Membership). If the flag is not included, the default value is false.


POST https://sand10-api.acmeticketing.net/v2/b2b/checkout

{
  "contactFirstName" : "optionalAutorenewFN",
  "contactLastName" : "optionalAutorenewLN",
  "address1" : "contact address 1",
  "address2" : "contact address 2",
  "country" : "contact country",
  "city" : "contact city",
  "state" : "contact state",
  "zipCode" : "95148",
  "phoneNumber" : "408-222-2345",
  "contactEmail" : "john@acme.com",
  "notes" : "notes",
  "expDate" : "1220",
  "manualEntryCardNumber" : "4242424242424242",
  "cvc" : "123",
  "paymentMethod" : "CreditCard",
  "shoppingCart" : {
    "items": 
     [ {
    "itemType" : "MembershipPurchase",
    "quantity": 1,
    "membershipInfo" : {
      "membershipCategoryId" : "59b0abcf61a307524a6a37d6",
      "membershipOfferingId" : "46257da699a845b486363e2aec0642f5",
      "pricePointId" : "58123480969c6d59d976b8fa",
      "membershipCards" : [ {
        "cardType" : "primary",
        "name" : "Jon Doe",
        "email" : "doe@gmail.com",
        "firstName" : "John",
        "lastName" : "Doe",
        "prefix" : "Mr",
        "phoneNumber" : "408-222-3333",
        "streetAddress1" : "street1",
        "streetAddress2" : "street2",
        "city" : "city",
        "state" : "state",
        "zipCode" : "zip",
        "country" : "country",
        "orgName" : "Acme Inc",
        "deceased" : "no",
        "primaryCard" : "yes",
        "startDate" : "1969-12-31T19:00:01-05:00",
        "expirationDate" : "2030-01-18T22:14:07-05:00"
      } ],
      "waiveBenefits" : false,
      "notifyGiftRecipient" : false,
      "gift" : false,
      "isAutorenew": true
    }
  } ]
  }
}




Purchase an add-on sample request


POST https://sand10-api.acmeticketing.net/v2/b2b/checkout

{
  "contactFirstName" : "contactFirstName",
  "contactLastName" : "contactLastName",
  "address1" : "contact address 1",
  "address2" : "contact address 2",
  "country" : "contact country",
  "city" : "contact city",
  "state" : "contact state",
  "zipCode" : "95148",
  "phoneNumber" : "408-222-2345",
  "contactEmail" : "john@acme.com",
  "notes" : "notes",
  "expDate" : "1220",
  "manualEntryCardNumber" : "4242424242424242",
  "cvc" : "123",
  "paymentMethod" : "CreditCard",
  "shoppingCart" : {
    "items": 
     [ 
       {
         "itemType":"Inventory",
        "inventoryId":"1",
        "quantity":1
        }
    ]
  } 
}


Purchase an add-on sample response


{
    "id": "27191833",
    "tenantId": 107,
    "contactFirstName": "contactFirstName",
    "contactLastName": "contactLastName",
    "billingFirstName": "contactFirstName",
    "billingLastName": "contactLastName",
    "billingAddress1": "contact address 1",
    "billingAddress2": "contact address 2",
    "billingCountry": "contact country",
    "billingCity": "contact city",
    "billingZipCode": "95148",
    "billingState": "contact state",
    "address1": "contact address 1",
    "address2": "contact address 2",
    "country": "contact country",
    "city": "contact city",
    "state": "contact state",
    "zipCode": "95148",
    "phoneNumber": "408-222-2345",
    "billingPhoneNumber": "408-222-2345",
    "orderNumber": "100121706",
    "discountedTotalAmount": "0.25",
    "totalAmount": "0.25",
    "discountedOriginalTotalAmount": "0.25",
    "originalTotalAmount": "0.25",
    "paidAmount": "0.25",
    "balanceAmount": "0.00",
    "refundAmount": "0.00",
    "saleChannel": "InsideSalesIndividual",
    "checkInStatus": "NotCheckedIn",
    "notes": "notes",
    "creationDate": "2020-06-24T20:11:51-07:00",
    "paymentDueDate": "2020-06-24T20:11:51-07:00",
    "orderItems": [
        {
            "parentItemId": "38815688",
            "comboTemplateType": "fixedPrice",
            "basicOriginalQuantity": 1,
            "originalQuantity": 1,
            "basicQuantity": 1,
            "quantity": 1,
            "unitPrice": "0.25",
            "discountedUnitPrice": "0.25",
            "discountedOriginalAmount": "0.25",
            "originalAmount": "0.25",
            "discountedAmount": "0.25",
            "amount": "0.25",
            "balanceAmount": "0.00",
            "itemType": "Inventory",
            "itemTypeNg": "Event",
            "inventoryId": 1,
            "inventoryName": "Be-uh",
            "conversionStatus": "NoConversion",
            "itemId": "38815688",
            "displayName": "Be-uh"
        }
    ],
    "createdOn": "2020-06-24T20:11:51-07:00",
    "createdBy": "340",
    "updatedOn": "2020-06-24T20:11:51-07:00",
    "updatedBy": "340",
    "legacy": false,
    "hideEventDate": false,
    "invoiceAfter": false,
    "customerId": 5381598,
    "obfuscated": false
}



Purchase a fixed donation sample request


POST https://sand10-api.acmeticketing.net/v2/b2b/checkout

{
  "contactFirstName" : "contactFirstName",
  "contactLastName" : "contactLastName",
  "address1" : "contact address 1",
  "address2" : "contact address 2",
  "country" : "contact country",
  "city" : "contact city",
  "state" : "contact state",
  "zipCode" : "95148",
  "phoneNumber" : "408-222-2345",
  "contactEmail" : "john@acme.com",
  "notes" : "notes",
  "expDate" : "1220",
  "manualEntryCardNumber" : "4242424242424242",
  "cvc" : "123",
  "paymentMethod" : "CreditCard",
  "shoppingCart" : {
    "items": 
     [ 
       {
         "itemType":"Inventory",
        "inventoryId":"1644",
        "quantity":1
        }
    ]
  } 
}


Purchase fixed donation sample response


{
    "id": "27191834",
    "tenantId": 107,
    "contactFirstName": "contactFirstName",
    "contactLastName": "contactLastName",
    "billingFirstName": "contactFirstName",
    "billingLastName": "contactLastName",
    "billingAddress1": "contact address 1",
    "billingAddress2": "contact address 2",
    "billingCountry": "contact country",
    "billingCity": "contact city",
    "billingZipCode": "95148",
    "billingState": "contact state",
    "address1": "contact address 1",
    "address2": "contact address 2",
    "country": "contact country",
    "city": "contact city",
    "state": "contact state",
    "zipCode": "95148",
    "phoneNumber": "408-222-2345",
    "billingPhoneNumber": "408-222-2345",
    "orderNumber": "100121707",
    "discountedTotalAmount": "30.00",
    "totalAmount": "30.00",
    "discountedOriginalTotalAmount": "30.00",
    "originalTotalAmount": "30.00",
    "paidAmount": "30.00",
    "balanceAmount": "0.00",
    "refundAmount": "0.00",
    "saleChannel": "InsideSalesIndividual",
    "checkInStatus": "NotCheckedIn",
    "notes": "notes",
    "creationDate": "2020-06-24T20:14:42-07:00",
    "paymentDueDate": "2020-06-24T20:14:42-07:00",
    "orderItems": [
        {
            "parentItemId": "38815689",
            "comboTemplateType": "fixedPrice",
            "basicOriginalQuantity": 1,
            "originalQuantity": 1,
            "basicQuantity": 1,
            "quantity": 1,
            "unitPrice": "30.00",
            "discountedUnitPrice": "30.00",
            "discountedOriginalAmount": "30.00",
            "originalAmount": "30.00",
            "discountedAmount": "30.00",
            "amount": "30.00",
            "balanceAmount": "0.00",
            "itemType": "Inventory",
            "itemTypeNg": "Donation",
            "inventoryId": 1644,
            "inventoryName": "$30",
            "conversionStatus": "NoConversion",
            "itemId": "38815689",
            "displayName": "$30"
        }
    ],
    "createdOn": "2020-06-24T20:14:42-07:00",
    "createdBy": "340",
    "updatedOn": "2020-06-24T20:14:43-07:00",
    "updatedBy": "340",
    "legacy": false,
    "hideEventDate": false,
    "invoiceAfter": false,
    "customerId": 5381598,
    "obfuscated": false
}



Purchase a variable donation sample request


POST https://sand10-api.acmeticketing.net/v2/b2b/checkout

{
  "contactFirstName" : "contactFirstName",
  "contactLastName" : "contactLastName",
  "address1" : "contact address 1",
  "address2" : "contact address 2",
  "country" : "contact country",
  "city" : "contact city",
  "state" : "contact state",
  "zipCode" : "95148",
  "phoneNumber" : "408-222-2345",
  "contactEmail" : "john@acme.com",
  "notes" : "notes",
  "expDate" : "1220",
  "manualEntryCardNumber" : "4242424242424242",
  "cvc" : "123",
  "paymentMethod" : "CreditCard",
  "shoppingCart" : {
    "items": 
     [ 
       {
         "itemType":"Inventory",
        "inventoryId":"2728",
        "amount": "12.34",
        "quantity":1
        }
    ]
  } 
}


Purchase variable donation sample response


{
    "id": "27191835",
    "tenantId": 107,
    "contactFirstName": "contactFirstName",
    "contactLastName": "contactLastName",
    "billingFirstName": "contactFirstName",
    "billingLastName": "contactLastName",
    "billingAddress1": "contact address 1",
    "billingAddress2": "contact address 2",
    "billingCountry": "contact country",
    "billingCity": "contact city",
    "billingZipCode": "95148",
    "billingState": "contact state",
    "address1": "contact address 1",
    "address2": "contact address 2",
    "country": "contact country",
    "city": "contact city",
    "state": "contact state",
    "zipCode": "95148",
    "phoneNumber": "408-222-2345",
    "billingPhoneNumber": "408-222-2345",
    "orderNumber": "100121708",
    "discountedTotalAmount": "12.34",
    "totalAmount": "12.34",
    "discountedOriginalTotalAmount": "12.34",
    "originalTotalAmount": "12.34",
    "paidAmount": "12.34",
    "balanceAmount": "0.00",
    "refundAmount": "0.00",
    "saleChannel": "InsideSalesIndividual",
    "checkInStatus": "NotCheckedIn",
    "notes": "notes",
    "creationDate": "2020-06-24T20:17:08-07:00",
    "paymentDueDate": "2020-06-24T20:17:08-07:00",
    "orderItems": [
        {
            "parentItemId": "38815690",
            "comboTemplateType": "fixedPrice",
            "basicOriginalQuantity": 1,
            "originalQuantity": 1,
            "basicQuantity": 1,
            "quantity": 1,
            "unitPrice": "12.34",
            "discountedUnitPrice": "12.34",
            "discountedOriginalAmount": "12.34",
            "originalAmount": "12.34",
            "discountedAmount": "12.34",
            "amount": "12.34",
            "balanceAmount": "0.00",
            "itemType": "Inventory",
            "itemTypeNg": "Donation",
            "inventoryId": 2728,
            "inventoryName": "Variable",
            "conversionStatus": "NoConversion",
            "itemId": "38815690",
            "displayName": "Variable"
        }
    ],
    "createdOn": "2020-06-24T20:17:08-07:00",
    "createdBy": "340",
    "updatedOn": "2020-06-24T20:17:09-07:00",
    "updatedBy": "340",
    "legacy": false,
    "hideEventDate": false,
    "invoiceAfter": false,
    "customerId": 5381598,
    "obfuscated": false
}