Checkout

POST /v2/b2b/orders/checkout

Body:

A Checkout Input JSON Object

Response:

The newly created order object.


Checkout JSON Objects

Checkout Input JSON Object

Field
Description
Notes
contactEmailEmail address of the customer.Required
phoneNumberPhone number of the customer.
contactFirstNameFirst name of the customer.Required
contactLastNameLast name of the customer.Required
address1

address2

city

state

country

zipCodeZip code of the customer.
ccLastFourDigitsLast four digits of the credit cardRequired
creditCardBrandType of credit card. One of Visa, MasterCard, AmericanExpress, Discover or JcbRequired
manualEntryCardNumberThe credit card number as a string
cvcThe credit card cvc number as a stringRequired
expDateMMyy format of the expiration date of the credit cardRequired
paymentIdId of the payment such as Check # or Voucher #
notesNotes about the order
billingFirstName

billingLastName

billingEmail

billingPhoneNumber

billingAddress1

billingAddress2

billingCountry

billingCity

billingZipCode

billingState

memberships

memberships[x].itemType

Type of membership operation such as

MembershipPurchase,

MembershipRenewal,

MembershipUpgrade,
MembershipDowngrade,
MembershipCancel,
MembershipPostTermRenewal,
MembershipRejoin,
MembershipRenewalUpgrade,
MembershipPostTermRenewalUpgrade,
MembershipRejoinUpgrade,
MembershipPostTermRenewalDowngrade,
MembershipRejoinDowngrade,
MembershipRenewalDowngrade,

MembershipPurchaseConversion,
MembershipReplacement
Required for membership
memberships[x].membershipInfoMembershipInfo Object
couponCode
The coupon code used for this order.


REQUEST For membership purchase:

POST https://sand6-api.acmeticketing.com/v2/b2b/orders/checkout

Sample Request
{
  "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" "0716",
  "manualEntryCardNumber" "4242424242424242",
  "cvc" "123",
  "paymentMethod" "CreditCard",
  "paymentId" "paymentId",
  "ccLastFourDigits" "4242",
  "creditCardBrand" "Visa",
  "chargeAmount" "120.00",
  "billingFirstName" "billingFirstName",
  "billingLastName" "billingLastName",
  "billingEmail" "doe@acme.com",
  "billingPhoneNumber" "408-222-2345",
  "billingAddress1" "billing address 1",
  "billingAddress2" "billing address 2",
  "billingCountry" "billing country",
  "billingCity" "billing city",
  "billingZipCode" "billing zip code",
  "billingState" "billing state",
  "memberships" : [ {
    "itemType" "MembershipPurchase",
    "membershipInfo" : {
      "membershipCategoryId" "57742a012095d87d690c39bc",
      "membershipOfferingId" "c831571c7e844b8092639c3583d9af15",
      "pricePointId" "54248ac8e4b01cd228b007a4",
      "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" "2038-01-18T22:14:07-05:00"
      } ],
      "waiveBenefits" false,
      "notifyGiftRecipient" false,
      "gift" false
    }
  } ]
}


RESPONSE:

Response for the above request
{
  "id""1186167",
  "tenantId": 107,
  "email""john@acme.com",
  "billingEmail""doe@acme.com",
  "contactFirstName""contactFirstName",
  "contactLastName""contactLastName",
  "billingFirstName""billingFirstName",
  "billingLastName""billingLastName",
  "billingAddress1""billing address 1",
  "billingAddress2""billing address 2",
  "billingCountry""billing country",
  "billingCity""billing city",
  "billingZipCode""billing zip code",
  "billingState""billing 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""52689522",
  "discountedTotalAmount""120.00",
  "totalAmount""150.00",
  "discountedOriginalTotalAmount""120.00",
  "originalTotalAmount""150.00",
  "paidAmount""150.00",
  "balanceAmount""0.00",
  "refundAmount""0.00",
  "saleChannel""InsideSalesIndividual",
  "checkInStatus""NotCheckedIn",
  "notes""notes",
  "creationDate""2016-07-21T16:37:34-07:00",
  "paymentDueDate""2016-07-21T16:37:34-07:00",
  "orderItems": [
    {
      "itemId""1521736",
      "itemName""1 year Individual",
      "pricePointId""54248ac8e4b01cd228b007a4",
      "pricePointName""Adult",
      "itemDetailId""180180",    ----------THIS IS THE MEMBERSHIP ID--------------------
      "parentItemId""1521736",
      "comboTemplateType""fixedPrice",
      "basicOriginalQuantity": 1,
      "originalQuantity": 1,
      "basicQuantity": 1,
      "quantity": 1,
      "unitPrice""150.00",
      "discountedUnitPrice""120.00",
      "discountedOriginalAmount""120.00",
      "originalAmount""150.00",
      "discountedAmount""120.00",
      "amount""150.00",
      "balanceAmount""0.00",
      "checkInDate"null,
      "itemType""MembershipPurchase"
    }
  ],
  "createdOn""2016-07-21T16:37:34-07:00",
  "createdBy""2285",
  "updatedOn""2016-07-21T16:37:35-07:00",
  "updatedBy""2285",
  "ticketDelivery"null,
  "legacy"false,
  "hideEventDate"false,
  "ccLastFourDigits""4242",
  "paymentId""paymentId"
}


Sample request to purchase Add On (membershipReplacementCard):

Add On Purchase - Sample request
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
{
  "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" "0716",
  "manualEntryCardNumber" "4242424242424242",
  "cvc" "123",
  "paymentMethod" "CreditCard",
  "paymentId" "paymentId",
  "ccLastFourDigits" "4242",
  "creditCardBrand" "Visa",
  "chargeAmount" "50.00",
  "billingFirstName" "billingFirstName",
  "billingLastName" "billingLastName",
  "billingEmail" "doe@acme.com",
  "billingPhoneNumber" "408-222-2345",
  "billingAddress1" "billing address 1",
  "billingAddress2" "billing address 2",
  "billingCountry" "billing country",
  "billingCity" "billing city",
  "billingZipCode" "billing zip code",
  "billingState" "billing state",
   "addons" : [
                {"itemType":"Inventory",
                 "inventoryId":"468",
                     "addonDetailId":"123", ********card ID***********
                     "quantity":1
                    }
        ]
        
        
}


SAMPLE RESPONSE

ADDON PURCHASE RESPONSE
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
{
  "id""1186356",
  "tenantId": 107,
  "email""john@acme.com",
  "billingEmail""doe@acme.com",
  "contactFirstName""contactFirstName",
  "contactLastName""contactLastName",
  "billingFirstName""billingFirstName",
  "billingLastName""billingLastName",
  "billingAddress1""billing address 1",
  "billingAddress2""billing address 2",
  "billingCountry""billing country",
  "billingCity""billing city",
  "billingZipCode""billing zip code",
  "billingState""billing 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""78783191",
  "discountedTotalAmount""50.00",
  "totalAmount""50.00",
  "discountedOriginalTotalAmount""50.00",
  "originalTotalAmount""50.00",
  "paidAmount""50.00",
  "balanceAmount""0.00",
  "refundAmount""0.00",
  "saleChannel""InsideSalesIndividual",
  "checkInStatus""NotCheckedIn",
  "notes""notes",
  "creationDate""2016-07-27T01:12:32-07:00",
  "paymentDueDate""2016-07-27T01:12:32-07:00",
  "orderItems": [
    {
      "itemId""1521927",
      "itemDetailId""123",   ************ card ID, corresponds to the addonDetailId in the request ***********
      "parentItemId""1521927",
      "comboTemplateType""fixedPrice",
      "basicOriginalQuantity": 1,
      "originalQuantity": 1,
      "basicQuantity": 1,
      "quantity": 1,
      "unitPrice""50.00",
      "discountedUnitPrice""50.00",
      "discountedOriginalAmount""50.00",
      "originalAmount""50.00",
      "discountedAmount""50.00",
      "amount""50.00",
      "balanceAmount""0.00",
      "checkInDate"null,
      "itemType""Inventory",
      "inventoryId": 468,
      "inventoryName""Membership Card Replacement",
      "displayName""Membership Card Replacement"
    }
  ],
  "createdOn""2016-07-27T01:12:32-07:00",
  "createdBy""2285",
  "updatedOn""2016-07-27T01:12:33-07:00",
  "updatedBy""2285",
  "ticketDelivery"null,
  "legacy"false,
  "hideEventDate"false,
  "ccLastFourDigits""4242",
  "paymentId""paymentId"
}


Sample request to purchase Add Ons (variable donation):

Variable Donation amount
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 {
  "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" "0716",
  "manualEntryCardNumber" "4242424242424242",
  "cvc" "123",
  "paymentMethod" "CreditCard",
  "paymentId" "paymentId",
  "ccLastFourDigits" "4242",
  "creditCardBrand" "Visa",
  "chargeAmount" "30.00",
  "billingFirstName" "billingFirstName",
  "billingLastName" "billingLastName",
  "billingEmail" "doe@acme.com",
  "billingPhoneNumber" "408-222-2345",
  "billingAddress1" "billing address 1",
  "billingAddress2" "billing address 2",
  "billingCountry" "billing country",
  "billingCity" "billing city",
  "billingZipCode" "billing zip code",
  "billingState" "billing state",
   "addons" : [
                {"itemType":"Inventory",
                 "inventoryId":"469",
                     "addonDetailId":"456", *************customer ID*************
                     "quantity":1,
                     "amount":"30.00"
                    }
        ]
        
        
}
Response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
{
  "id""1186363",
  "tenantId": 107,
  "email""john@acme.com",
  "billingEmail""doe@acme.com",
  "contactFirstName""contactFirstName",
  "contactLastName""contactLastName",
  "billingFirstName""billingFirstName",
  "billingLastName""billingLastName",
  "billingAddress1""billing address 1",
  "billingAddress2""billing address 2",
  "billingCountry""billing country",
  "billingCity""billing city",
  "billingZipCode""billing zip code",
  "billingState""billing 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""42990575",
  "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""2016-07-27T01:26:04-07:00",
  "paymentDueDate""2016-07-27T01:26:04-07:00",
  "orderItems": [
    {
      "itemId""1521928",
      "itemDetailId""456", **********customer ID******************
      "parentItemId""1521928",
      "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",
      "checkInDate"null,
      "itemType""Inventory",
      "inventoryId": 469,
      "inventoryName""Donation",
      "displayName""Donation"
    }
  ],
  "createdOn""2016-07-27T01:26:04-07:00",
  "createdBy""2285",
  "updatedOn""2016-07-27T01:26:04-07:00",
  "updatedBy""2285",
  "ticketDelivery"null,
  "legacy"false,
  "hideEventDate"false,
  "ccLastFourDigits""4242",
  "paymentId""paymentId"
}


Sample request to purchase Add On (fixed donation amount)

Fixed donation amount Add On
{
  "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" "0716",
  "manualEntryCardNumber" "4242424242424242",
  "cvc" "123",
  "paymentMethod" "CreditCard",
  "paymentId" "paymentId",
  "ccLastFourDigits" "4242",
  "creditCardBrand" "Visa",
  "chargeAmount" "20.00",
  "billingFirstName" "billingFirstName",
  "billingLastName" "billingLastName",
  "billingEmail" "doe@acme.com",
  "billingPhoneNumber" "408-222-2345",
  "billingAddress1" "billing address 1",
  "billingAddress2" "billing address 2",
  "billingCountry" "billing country",
  "billingCity" "billing city",
  "billingZipCode" "billing zip code",
  "billingState" "billing state",
   "addons" : [
                {"itemType":"Inventory"