Create a checkout cart (legacy)
This endpoint is an alias for /checkoutCart_oncreate_v2/ and maps to the same underlying implementation. This endpoint is used to determine whether or not we can facilitate a sale for a user (based on selected registration/titling state and cart items), and if so, to create a checkout cart for them. If we can’t facilitate a sale, we will redirect the user to the OEMs native checkout page. If we can facilitate a sale, we will redirect the user to the OEM’s Ekho Dealer Checkout page.
curl --request POST \
--url https://api.ekhodealer.com/checkoutCart_oncreate_v2/:legacy \
--header 'Content-Type: application/json' \
--data '{
"id": "<string>",
"cancelUrl": "<string>",
"oemKey": "<string>",
"oemId": "<string>",
"nativeDefaultCheckoutUrl": "https://www.rideoem.com/checkout",
"registrationState": "AL",
"items": [
{
"productId": "<string>",
"count": 123,
"name": "<string>",
"basePrice": 123,
"imgUrl": "<string>",
"specs": [
{
"name": "<string>",
"price": 123,
"option": "<string>",
"description": "<string>",
"id": "<string>"
}
],
"estimatedProductionTime": 123,
"estimatedDeliveryTime": 123,
"year": 123,
"id": "<string>",
"color": "<string>",
"totalPrice": 123,
"boltOnAccessories": [
"<string>"
],
"boltOnVehicleIds": [
"<string>"
],
"typeOfOrder": "ante_preorder",
"variantId": "<string>",
"description": "<string>",
"sku": "<string>",
"stage": "signOff",
"orderFee": 123,
"vipOrderFee": 123,
"vin": "<string>",
"odometerReading": 123,
"estimatedDeliveryDate": 123,
"estimatedProductionDate": 123,
"shippingFee": 123,
"pickUpFee": 123,
"preorderProdStart": "<string>",
"metadata": {
"existingPayments": [
{
"amount": 123,
"type": "PREORDER",
"recipient": "OEM",
"preorderId": "<string>",
"paymentIntentId": "<string>"
}
]
}
}
],
"boltOnsAlreadyAssigned": true,
"ecommUserId": "<string>",
"ecommOrderId": 123,
"ekhoCheckoutCartId": "<string>",
"orderCreationType": "ORGANIC",
"source": "<string>",
"linkUseType": "SINGLE_USE",
"customLinkConfig": {
"linkName": "<string>",
"checkoutPaymentOverride": {
"STANDARD_RESERVATION": {
"paymentTypeEnum": "STANDARD_RESERVATION"
},
"CHECKOUT_FULL_PAYMENT": {
"paymentTypeEnum": "CHECKOUT_FULL_PAYMENT",
"fullPaymentDiscountPerc": 123
},
"LOAN_DOWNPAYMENT": {
"paymentTypeEnum": "LOAN_DOWNPAYMENT",
"checkoutDownPaymentPerc": 123
}
},
"salespersonEmail": "<string>",
"prefilledInfo": {
"buyerFullName": "<string>",
"buyerPhone": "<string>",
"buyerEmail": "<string>",
"selectedPaymentOption": "STANDARD_RESERVATION",
"selectedDeliveryOption": "PICK_UP",
"selectedRegistrationOption": "EKHO",
"selectedPickUpLocationId": "<string>",
"shippingAddress": {
"addressString": "<string>",
"addressLineOne": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"county": "<string>",
"state": "<string>",
"zip": "<string>"
},
"registrationAddress": {
"addressString": "<string>",
"addressLineOne": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"county": "<string>",
"state": "<string>",
"zip": "<string>"
},
"mailingAddress": {
"addressString": "<string>",
"addressLineOne": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"county": "<string>",
"state": "<string>",
"zip": "<string>"
},
"regAddressSameAsShipping": true,
"mailingAddressSameAsShipping": true
}
},
"preorderId": "<string>",
"brandKey": "<string>",
"reqManulDeliveryUpdates": true
}'
{
"checkoutUrl": "<string>",
"ekhoCheckoutCartId": "<string>",
"message": "<string>"
}
Body
The schema of the payload our checkoutCart_oncreate/ endpoint receives and enriches to create a CheckoutCart object
Response
Successfully processed the checkout cart. Returns the checkoutUrl to redirect the user to to complete the checkout process. Can either be the OEMs native checkout page or our own checkout page, depending on whether or not Ekho is "turned on" in state the user wants to title their vehicle in AND whether or not there is at least 1 vehicle among the items
The response is of type object
.
curl --request POST \
--url https://api.ekhodealer.com/checkoutCart_oncreate_v2/:legacy \
--header 'Content-Type: application/json' \
--data '{
"id": "<string>",
"cancelUrl": "<string>",
"oemKey": "<string>",
"oemId": "<string>",
"nativeDefaultCheckoutUrl": "https://www.rideoem.com/checkout",
"registrationState": "AL",
"items": [
{
"productId": "<string>",
"count": 123,
"name": "<string>",
"basePrice": 123,
"imgUrl": "<string>",
"specs": [
{
"name": "<string>",
"price": 123,
"option": "<string>",
"description": "<string>",
"id": "<string>"
}
],
"estimatedProductionTime": 123,
"estimatedDeliveryTime": 123,
"year": 123,
"id": "<string>",
"color": "<string>",
"totalPrice": 123,
"boltOnAccessories": [
"<string>"
],
"boltOnVehicleIds": [
"<string>"
],
"typeOfOrder": "ante_preorder",
"variantId": "<string>",
"description": "<string>",
"sku": "<string>",
"stage": "signOff",
"orderFee": 123,
"vipOrderFee": 123,
"vin": "<string>",
"odometerReading": 123,
"estimatedDeliveryDate": 123,
"estimatedProductionDate": 123,
"shippingFee": 123,
"pickUpFee": 123,
"preorderProdStart": "<string>",
"metadata": {
"existingPayments": [
{
"amount": 123,
"type": "PREORDER",
"recipient": "OEM",
"preorderId": "<string>",
"paymentIntentId": "<string>"
}
]
}
}
],
"boltOnsAlreadyAssigned": true,
"ecommUserId": "<string>",
"ecommOrderId": 123,
"ekhoCheckoutCartId": "<string>",
"orderCreationType": "ORGANIC",
"source": "<string>",
"linkUseType": "SINGLE_USE",
"customLinkConfig": {
"linkName": "<string>",
"checkoutPaymentOverride": {
"STANDARD_RESERVATION": {
"paymentTypeEnum": "STANDARD_RESERVATION"
},
"CHECKOUT_FULL_PAYMENT": {
"paymentTypeEnum": "CHECKOUT_FULL_PAYMENT",
"fullPaymentDiscountPerc": 123
},
"LOAN_DOWNPAYMENT": {
"paymentTypeEnum": "LOAN_DOWNPAYMENT",
"checkoutDownPaymentPerc": 123
}
},
"salespersonEmail": "<string>",
"prefilledInfo": {
"buyerFullName": "<string>",
"buyerPhone": "<string>",
"buyerEmail": "<string>",
"selectedPaymentOption": "STANDARD_RESERVATION",
"selectedDeliveryOption": "PICK_UP",
"selectedRegistrationOption": "EKHO",
"selectedPickUpLocationId": "<string>",
"shippingAddress": {
"addressString": "<string>",
"addressLineOne": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"county": "<string>",
"state": "<string>",
"zip": "<string>"
},
"registrationAddress": {
"addressString": "<string>",
"addressLineOne": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"county": "<string>",
"state": "<string>",
"zip": "<string>"
},
"mailingAddress": {
"addressString": "<string>",
"addressLineOne": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"county": "<string>",
"state": "<string>",
"zip": "<string>"
},
"regAddressSameAsShipping": true,
"mailingAddressSameAsShipping": true
}
},
"preorderId": "<string>",
"brandKey": "<string>",
"reqManulDeliveryUpdates": true
}'
{
"checkoutUrl": "<string>",
"ekhoCheckoutCartId": "<string>",
"message": "<string>"
}