POST
/
checkoutCart_oncreate_v2
/
curl --request POST \
  --url https://api.ekhodealer.com/checkoutCart_oncreate_v2/ \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "variants": [
    {
      "variantConfigId": "variantConfigId",
      "metadata": {
        "randomField": "randomValue"
      }
    }
  ],
  "cancelUrl": "www.ekhodealer.com",
  "oemKey": "example-key",
  "oemId": "example-oem-id",
  "nativeDefaultCheckoutUrl": "https://www.rideoem.com/checkout",
  "registrationState": "AL",
  "items": {
    "itemId": [
      {
        "name": "Example Name",
        "price": 123
      }
    ]
  },
  "ecommUserId": "<string>",
  "ecommOrderId": "<string>",
  "ekhoCheckoutCartId": "<string>",
  "orderCreationType": "ORGANIC",
  "source": "facebook",
  "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>",
  "metadata": {
    "randomField": "randomValue"
  }
}'
{
  "checkoutUrl": "<string>",
  "ekhoCheckoutCartId": "<string>",
  "message": "<string>"
}

Body

application/json

The schema of the payload our checkoutCart_oncreate/ endpoint receives and enriches to create a CheckoutCart object

Response

200
application/json

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.