Retrieve details of a purchased vehicle

curl --request GET \
  --url https://api.ekhodealer.com/purchasedVehicle_onfetch_v2/{purchasedVehicleId} \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "productId": "<string>",
  "vehicleType": "Passenger",
  "buyerId": "<string>",
  "buyerFullName": "<string>",
  "lastActive": 123,
  "placedOrderId": "<string>",
  "orderFee": 123,
  "name": "<string>",
  "basePrice": 123,
  "basePriceWithSpecs": 123,
  "specs": [
    {
      "name": "<string>",
      "price": 123,
      "option": "<string>",
      "description": "<string>",
      "id": "<string>"
    }
  ],
  "imgUrl": "<string>",
  "description": "<string>",
  "oemId": "<string>",
  "typeOfOrder": "preorder",
  "dotVehicle": true,
  "datePurchased": 123,
  "stage": "signOff",
  "vehicleFulfillmentStatus": "FULFILLED",
  "fulfillmentDetails": {
    "vehicleTrackingReference": "<string>",
    "contactNumber": "<string>",
    "companyName": "<string>",
    "msoTrackingReference": "<string>",
    "msoSent": true
  },
  "grossInvoicePrice": 123,
  "sensitiveDataPurged": true,
  "variantId": "<string>",
  "sku": "<string>",
  "boltOnAccessories": [
    "<string>"
  ],
  "totalPrice": 123,
  "preDiscountTotalPrice": 123,
  "orderCreationType": "ORGANIC",
  "externalStatus": "UNCATEGORIZED",
  "estimatedProductionDate": 123,
  "estimatedDeliveryDate": 123,
  "year": 123,
  "pickUpInfo": {
    "pickUpLocationId": "<string>",
    "pickUpLocationName": "<string>",
    "addressLineOne": "<string>",
    "addressLineTwo": "<string>",
    "county": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>"
  },
  "deliveryInfo": {
    "addressLineOne": "<string>",
    "addressLineTwo": "<string>",
    "county": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "deliveryInstructions": "<string>",
    "poc": "<string>",
    "pocName": "<string>",
    "pocNumber": 123
  },
  "registrationDetails": {
    "tarProcess": "AUTOMATED",
    "registrationState": "<string>",
    "birthYear": 123
  },
  "additionalDues": {
    "fidelity": "initial",
    "total": 123,
    "taxTotal": 123,
    "feeTotal": 123,
    "deliveryEstimate": 123,
    "pickUpEstimate": 123,
    "taxEstimates": [
      {
        "feeType": "<string>",
        "name": "<string>",
        "value": 123
      }
    ],
    "feeEstimates": [
      {
        "feeType": "<string>",
        "name": "<string>",
        "value": 123
      }
    ]
  },
  "vin": "<string>",
  "odometerReading": 123,
  "odometerValidity": "Actual",
  "motorcycleEngineNumber": "<string>",
  "checkoutCartId": "<string>",
  "lastUpdated": 123,
  "lastNudged": 123,
  "vehicleInvoiceURL": "<string>",
  "metadata": {},
  "surveyData": {},
  "requiresAssemblyAfterDelivery": true,
  "paymentSelection": "nativeFinancing",
  "vehiclePaymentStatus": "RESERVATION_INITIATIED",
  "totalAmountReceived": 123
}

GET

purchasedVehicle_onfetch_v2

{purchasedVehicleId}

Retrieve details of a purchased vehicle

curl --request GET \
  --url https://api.ekhodealer.com/purchasedVehicle_onfetch_v2/{purchasedVehicleId} \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "productId": "<string>",
  "vehicleType": "Passenger",
  "buyerId": "<string>",
  "buyerFullName": "<string>",
  "lastActive": 123,
  "placedOrderId": "<string>",
  "orderFee": 123,
  "name": "<string>",
  "basePrice": 123,
  "basePriceWithSpecs": 123,
  "specs": [
    {
      "name": "<string>",
      "price": 123,
      "option": "<string>",
      "description": "<string>",
      "id": "<string>"
    }
  ],
  "imgUrl": "<string>",
  "description": "<string>",
  "oemId": "<string>",
  "typeOfOrder": "preorder",
  "dotVehicle": true,
  "datePurchased": 123,
  "stage": "signOff",
  "vehicleFulfillmentStatus": "FULFILLED",
  "fulfillmentDetails": {
    "vehicleTrackingReference": "<string>",
    "contactNumber": "<string>",
    "companyName": "<string>",
    "msoTrackingReference": "<string>",
    "msoSent": true
  },
  "grossInvoicePrice": 123,
  "sensitiveDataPurged": true,
  "variantId": "<string>",
  "sku": "<string>",
  "boltOnAccessories": [
    "<string>"
  ],
  "totalPrice": 123,
  "preDiscountTotalPrice": 123,
  "orderCreationType": "ORGANIC",
  "externalStatus": "UNCATEGORIZED",
  "estimatedProductionDate": 123,
  "estimatedDeliveryDate": 123,
  "year": 123,
  "pickUpInfo": {
    "pickUpLocationId": "<string>",
    "pickUpLocationName": "<string>",
    "addressLineOne": "<string>",
    "addressLineTwo": "<string>",
    "county": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>"
  },
  "deliveryInfo": {
    "addressLineOne": "<string>",
    "addressLineTwo": "<string>",
    "county": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "deliveryInstructions": "<string>",
    "poc": "<string>",
    "pocName": "<string>",
    "pocNumber": 123
  },
  "registrationDetails": {
    "tarProcess": "AUTOMATED",
    "registrationState": "<string>",
    "birthYear": 123
  },
  "additionalDues": {
    "fidelity": "initial",
    "total": 123,
    "taxTotal": 123,
    "feeTotal": 123,
    "deliveryEstimate": 123,
    "pickUpEstimate": 123,
    "taxEstimates": [
      {
        "feeType": "<string>",
        "name": "<string>",
        "value": 123
      }
    ],
    "feeEstimates": [
      {
        "feeType": "<string>",
        "name": "<string>",
        "value": 123
      }
    ]
  },
  "vin": "<string>",
  "odometerReading": 123,
  "odometerValidity": "Actual",
  "motorcycleEngineNumber": "<string>",
  "checkoutCartId": "<string>",
  "lastUpdated": 123,
  "lastNudged": 123,
  "vehicleInvoiceURL": "<string>",
  "metadata": {},
  "surveyData": {},
  "requiresAssemblyAfterDelivery": true,
  "paymentSelection": "nativeFinancing",
  "vehiclePaymentStatus": "RESERVATION_INITIATIED",
  "totalAmountReceived": 123
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

purchasedVehicleId

string

required

Unique identifier of the purchased vehicle to retrieve.

Query Parameters

oemKey

string

required

Key to identify and authenticate the OEM admin.

Response

Successfully retrieved the purchased vehicle details.

PurchasedVehicle interface Represents a purchased vehicle along with its associated data and metadata.

string

required

Unique identifier for the purchased vehicle

productId

string

required

The product id associated with this vehicle

buyerId

string

required

The id of the buyer

buyerFullName

string

required

The full name of the buyer (copied from the buyer object). DO NOT use this for T&R, instead use the names stored in registrationDetails

placedOrderId

string

required

The order id placed for this vehicle

orderFee

number

required

How much a buyer pays at checkout towards a vehicle. In case of full vehicle payment, this is the total price of the vehicle (without any taxes or fees included and minus any previous payments - like preorder fees). In case of financing, this is the standard down payment (not inclusive of preorder fees). In case of standard reservation, this is the reservation fee.

name

string

required

The name of the vehicle

basePrice

number

required

The base price of the vehicle

basePriceWithSpecs

number

required

The base price of the vehicle including the price of any specs

specs

object[]

required

Array of specs for the vehicle. Each spec includes name, price, option. Description and id are optional.

Show child attributes

imgUrl

string

required

description

string

required

oemId

string

required

typeOfOrder

enum<string>

required

Available options:

preorder,

buildToOrder,

inventoryOrder

dotVehicle

boolean

required

Indicates if the vehicle is DOT compliant

datePurchased

number

required

The date the reservation fee was paid for this vehicle (ms since epoch)

stage

enum<string>

required

What is the status of the order from a production standpoint?

Available options:

signOff,

pendingPaymentGuarantee,

pendingVerification,

production,

complete

vehicleFulfillmentStatus

enum<string>

required

A reflection of where the order is located in the fulfillment process

Available options:

FULFILLED,

UNFULFILLED,

READY_TO_FULFILL,

CANCELED,

ON_HOLD,

SHIPPED,

READY_FOR_PICK_UP

sensitiveDataPurged

boolean

required

Indicates whether sensitive data has been purged from this vehicle. Init as false.

variantId

string

required

The variant id of the vehicle

sku

string

required

The SKU of the vehicle

boltOnAccessories

string[]

required

An array with the document IDs of boltOn purchasedAccessories that have been assigned to this vehicle

totalPrice

number

required

The price of the vehicle plus the price of each bolt on accessory minus any discounts! Does not include taxes or fees.

preDiscountTotalPrice

number

required

The price of the vehicle plus the price of each bolt on accessory before any discounts are subtracted! Does not include taxes or fees.

orderCreationType

enum<string>

required

Determines the type of order this vehicle belongs to. Defaults to "ORGANIC".

Available options:

ORGANIC,

PREORDER,

EXISTINGORDER,

OEMORIGINATED,

ABANDONEDCART

externalStatus

enum<string>

required

The mutually exclusive external (OEM-facing) status that an "order" (purchasedVehicle object) can be in. Used in the OEM Admin Portal to filter orders.

Available options:

UNCATEGORIZED,

CANCELED,

ON_HOLD,

PENDING,

AWAITING_OEM_ACTION,

AWAITING_BUYER_OR_EKHO_ACTION,

KICK_OFF_FULFILLMENT,

FULFILLMENT_IN_PROGRESS,

FULFILLED

estimatedProductionDate

number

required

The estimated date of when this vehicle will be finished being produced in ms since epoch. Default initial value to purchasedDate + Vehicle.averageProductionTime

estimatedDeliveryDate

number

required

The estimated date of when this vehicle will be delivered (to the buyer or to the pick up location) in ms since epoch. Default initial value will be purchasedDate + Vehicle.totalLeadTime

vehicleType

enum<string>

The government vehicle type (aligns with our INTERNAL_VEHICLE_TYPE_ENUM)

Available options:

Passenger,

Motorcycle,

Truck,

Commercial,

Trailer,

Moped,

OHV,

Vessel

lastActive

number

The last time the buyer viewed the purchased vehicle's details page. Used for nudging.

fulfillmentDetails

object

The following optional properties are provided by the OEM at time of setting vehicleFulfillmentStatus to SHIPPED.

Show child attributes

grossInvoicePrice

number

The gross invoice price of the vehicle paid by Ekho to the client

year

number

The year of the vehicle model. This is only optional because of backwards compatibility. Gets injected at order creation time.

pickUpInfo

object

At time of check out, if this field is set, it means the buyer has opted for pick up.

Show child attributes

deliveryInfo

object

At time of check out, if this field is set, it means the buyer has opted for delivery.

Show child attributes

registrationDetails

object

Registration details object

Show child attributes

additionalDues

object

this object is deprecated and should only be present on old vehicles. New additional dues live in their own array

Show child attributes

vin

string

VIN must be input by the OEM at some point prior to delivery

odometerReading

number

Must be input by the OEM at some point prior to delivery, or can be auto set

odometerValidity

enum<string>

Indicates the odometer validity/condition. Can be autoset

Available options:

Actual,

ExceedsMechanicalLimits,

NotActual

motorcycleEngineNumber

string

Must be input by the OEM if the OEM is selling motorcycles

checkoutCartId

string

The id of the cart that was used to check out this vehicle. Optional

lastUpdated

number

date for when the vehicle has been last updated

lastNudged

number

the last date when the OEM has nudged the buyer (also updated when we send emails for VIN and odometer assigned)

vehicleInvoiceURL

string

URL to the vehicle invoice

metadata

object

An optional object that holds additional information about the vehicle. Example: { randomField: "randomValue" }

surveyData

object

answers to a Ekho-hosted survey surfaced in buyer portal

Show child attributes

requiresAssemblyAfterDelivery

boolean

true if the vehicle requires assembly after delivery (optional for backwards compatibility)

paymentSelection

enum<string>

Payment selection the buyer has chosen. Initially set during checkout and can be changed in financing. Init as null.

Available options:

nativeFinancing,

otherFinancing,

checkoutFullPayment,

cashEarly,

cash

vehiclePaymentStatus

enum<string>

The status of payment for this particular purchasedVehicle. Init as null.

Available options:

RESERVATION_INITIATIED,

NO_PAYMENTS,

RESERVATION_PAID,

DOWNPAYMENT_PAID,

FINANCING_GUARANTEED,

FULLY_PAID

totalAmountReceived

number

Running total of all money received by Ekho for this vehicle (post refunds). Not all money accounted here will necessarily be collected by Ekho. Initialized at 0.

Get Started

Essentials

Retrieve details of a purchased vehicle

Authorizations

Path Parameters

Query Parameters

Response