Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Unique identifier of the preorder to retrieve.
Query Parameters
Key to identify and authenticate the OEM admin.
Response
Successfully retrieved the preorder details.
The date the reservation fee was paid for this preorder
The full name of the buyer (copied from the buyer object at time of preorder creation).
The id of the checkout cart that this preorder was created from
How much the buyer paid at preorder checkout towards the vehicle
The name of the base model
The mutually exclusive external (OEM-facing) status that a preorder can be in. Used in the OEM Admin Portal to filter preorders.
PENDING_INVITATION
, AWAITING_CONVERSION
, CANCELED
The id of the checkout session that this preorder was created from. Helpful for tying together a single payment intent across multiple preorders.
The status of the preorder. Initialized as null, but set to AWAITING_CONVERSION when the preorder payment is successfully processed.
CANCELED
, AWAITING_CONVERSION
, CONVERTED
Represents a payment made towards a vehicle.
(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.
(optional) The custom sku of the order we create in their e-comm system.
The id of the checkout cart that this preorder was converted into.