Prerequisites
- A buyer already exists (see Buyer onboarding).
Keep the
buyerUuidfrom the upsert response. - You have a unique
externalOrderId— your system’s identifier for the deal.
Create an order
Response
Idempotent upsert
Orders are keyed on(sellerId, externalOrderId):
| Scenario | Result |
|---|---|
| First POST with key X | Order created, 201 |
| Second POST with key X, identical body | Cached response returned, 200 |
| Second POST with key X, different body | 422 Unprocessable Entity — idempotency key reused with different payload |
Different Idempotency-Key, same externalOrderId, identical body | Existing order returned, 200 |
Different Idempotency-Key, same externalOrderId, different body | 409 Conflict — use PATCH to update |
Single-VIN vs multi-VIN orders
For the Santander pilot and most direct dealer integrations, orders are single-VIN —vins is always an array of length 1.
Multi-VIN orders (fleet deals where one invoice covers multiple vehicles)
require the allowMultiVinOrders capability flag. Without it, arrays of
length > 1 are rejected with 403.
Compliance state on multi-VIN orders is tracked per-VIN inside the
transport module. Some VINs may be delivered while others are still in
transit; the order’s overall status reflects the aggregate.
Look up orders
By UUID
GET /partners/{sellerId}/orders/{uuid} returns the canonical record. Use
If-None-Match with the previous ETag to get 304 Not Modified when the
order hasn’t changed.
By VIN
VIN is not globally unique — the same VIN may appear in multiple historical orders (buyback, resale).GET /partners/{sellerId}/orders?vin=WVWZZZ1JZXW000001
returns all matches scoped to your authorized partners.
By filters
page, size, sort=createdAt,desc) applies. See
Pagination for details.
Update an order
PATCH /partners/{sellerId}/orders/{uuid} for mutable fields
(responsibleContact, purchaseDate). Requires If-Match header with the
current version for optimistic concurrency.
Cancel an order
Upload order-level documents
ORDER_PURCHASING_CONTRACT is the supported type:
Next
Invoice & Payment
Submit commercial data for the transaction.
Compliance rollup
Track transaction state across all modules.