Create a part exchange
POST/part-exchanges
Adds a part exchange from a registration, as the website's Sell Your
Vehicle and Value My Car forms do: the registration is looked up and
the vehicle details filled in from it. make, model,
derivative, colour and vin are used only when the lookup does
not answer. Optionally attaches it to an enquiry; an enquiry that
already has a part exchange is refused (409
enquiry_has_part_exchange). Scope part_exchanges:write.
Request
Responses
- 201
- 401
- 403
- 409
- 422
- 429
The part exchange.
Response Headers
This request's id. Quote it to support.
Requests allowed per minute for this key.
Requests left in the current minute.
true when this is the stored response to an earlier request with the same Idempotency-Key.
No key, or one that cannot be used. Codes: missing_api_key,
invalid_api_key, api_key_revoked, api_key_expired,
key_owner_inactive.
Response Headers
This request's id. Quote it to support.
Bearer.
The key may not do this. Codes: insufficient_scope,
scope_not_permitted_for_owner, plan_not_entitled,
secret_key_required, publishable_key_required,
secret_key_in_browser, origin_not_allowed, ip_not_allowed,
branch_move_not_permitted, plan_stock_cap_reached,
sandbox_stock_cap_reached, not_available_in_sandbox,
theme_builder_not_enabled.
Response Headers
This request's id. Quote it to support.
The record's state does not allow this, or an Idempotency-Key clash.
Codes: idempotency_key_reused, idempotency_key_in_use,
external_id_taken, stock_busy, vehicle_in_deal,
vehicle_has_purchase_order, customer_has_enquiries,
enquiry_has_invoiced_order, enquiry_has_part_exchange,
deal_closed, deal_sold, deal_has_no_enquiry,
deal_has_no_vehicle, job_card_paid.
Response Headers
This request's id. Quote it to support.
The request was not valid. Code validation_failed, with errors
keyed by field; also body_not_received (a multipart body that
never arrived), webhook_endpoint_limit_reached,
vehicle_not_created, request_refused and
theme_publish_blocked (with errors.routes and errors.findings).
Response Headers
This request's id. Quote it to support.
Too many requests. Code rate_limited; wait Retry-After seconds. On POST /theme-generations, also theme_generation_quota_exceeded, when the dealer's monthly theme generations are used up (no Retry-After).
Response Headers
This request's id. Quote it to support.
Requests allowed per minute for this key.
Requests left in the current minute.
Seconds to wait before retrying.