GET
/
preorder
/
{preorderId}
Retrieve details of a preorder
curl --request GET \
  --url https://api.ekhodealer.com/preorder/{preorderId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "datePurchased": 123,
  "buyerId": "<string>",
  "buyerFullName": "<string>",
  "oemId": "<string>",
  "checkoutCartId": "<string>",
  "orderFee": 123,
  "variantId": "<string>",
  "productId": "<string>",
  "name": "<string>",
  "specs": [
    {
      "name": "<string>",
      "price": 123,
      "option": "<string>"
    }
  ],
  "externalStatus": "PENDING_INVITATION",
  "vehicle": [
    {}
  ],
  "orderSessionId": "<string>",
  "ecommOrderId": 123,
  "sku": "<string>",
  "status": "CANCELED",
  "paymentInfo": {
    "id": "<string>",
    "baseAmount": 123,
    "amountReceived": 123,
    "processingFeeInc": true,
    "paymentType": "STANDARD_RESERVATION",
    "status": "processing",
    "platform": "brex",
    "recipient": "OEM",
    "receiptId": "<string>",
    "paymentIntentClientSecret": "<string>"
  },
  "accessories": [
    {
      "productId": "<string>",
      "name": "<string>",
      "basePrice": 123,
      "specs": [
        {
          "name": "<string>",
          "price": 123,
          "option": "<string>"
        }
      ],
      "imgUrl": "<string>",
      "description": "<string>",
      "count": 123,
      "variantId": "<string>"
    }
  ],
  "convertedCheckoutCartId": "<string>"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

preorderId
string
required

Unique identifier of the preorder to retrieve.

Query Parameters

oemKey
string
required

Key to identify and authenticate the OEM admin.

Response

Successfully retrieved the preorder details.

id
string
required
datePurchased
number
required

The date the reservation fee was paid for this preorder

buyerId
string
required
buyerFullName
string
required

The full name of the buyer (copied from the buyer object at time of preorder creation).

oemId
string
required
checkoutCartId
string
required

The id of the checkout cart that this preorder was created from

orderFee
number
required

How much the buyer paid at preorder checkout towards the vehicle

variantId
string
required
productId
string
required
name
string
required

The name of the base model

specs
object[]
required
externalStatus
enum<string>
required

The mutually exclusive external (OEM-facing) status that a preorder can be in. Used in the OEM Admin Portal to filter preorders.

Available options:
PENDING_INVITATION,
AWAITING_CONVERSION,
CANCELED
vehicle
object[]
required
orderSessionId
string
required

The id of the checkout session that this preorder was created from. Helpful for tying together a single payment intent across multiple preorders.

status
enum<string>
required

The status of the preorder. Initialized as null, but set to AWAITING_CONVERSION when the preorder payment is successfully processed.

Available options:
CANCELED,
AWAITING_CONVERSION,
CONVERTED
paymentInfo
object
required

Represents a payment made towards a vehicle.

ecommOrderId
number

(optional) The id of the order we created in their e-comm system. We use this to update the order at later points. Init as null.

sku
string

(optional) The custom sku of the order we create in their e-comm system.

accessories
object[]
convertedCheckoutCartId
string

The id of the checkout cart that this preorder was converted into.