POST /v1/deals

Create a deal

Creates a deal at stage "lead" with the next number of the tenant. Supports Idempotency-Key. Requires scope write:deals.

Автентифікація: заголовок Authorization: Bearer rv_live_... (API-ключі та scopes)
Потрібний scope: write:deals

Опис операції, параметрів і полів походить зі специфікації OpenAPI (openapi.json) і подається англійською, як у самому API.

Параметри

Поле	Де	Тип	Обов’язк.	Опис
`idempotency-key`	header	`string`	ні	Makes a retry of this POST safe for 24 hours: the same key and body returns the stored response (Idempotent-Replay: true).

Тіло запиту

Поле	Тип	Обов’язк.
`contactId`	`string (uuid)`	ні
`requestId`	`string (uuid)`	ні
`offerId`	`string (uuid)`	ні
`listingId`	`string (uuid)`	ні
`vehicleId`	`string (uuid)`	ні
`vehicle`	`object`	ні
`vehicle.vin`	`string \| null`	ні
`vehicle.make`	`string \| null`	ні
`vehicle.model`	`string \| null`	ні
`vehicle.trim`	`string \| null`	ні
`vehicle.year`	`integer \| null`	ні
`vehicle.body`	`"sedan" \| "hatchback" \| "wagon" \| "suv" \| "crossover" \| "coupe" \| "convertible" \| "minivan" \| "van" \| "pickup" \| "truck" \| "motorcycle" \| "other" \| null`	ні
`vehicle.fuel`	`"petrol" \| "diesel" \| "hybrid" \| "phev" \| "ev" \| "lpg" \| "cng" \| "hydrogen" \| "other" \| null`	ні
`vehicle.engine`	`string \| null`	ні
`vehicle.engineCc`	`integer \| null`	ні
`vehicle.powerKw`	`integer \| null`	ні
`vehicle.gearbox`	`"manual" \| "automatic" \| "cvt" \| "robot" \| "other" \| null`	ні
`vehicle.mileageKm`	`integer \| null`	ні
`vehicle.color`	`string \| null`	ні
`vehicle.source`	`string`	ні
`vehicle.sourceUrl`	`string \| null (uri)`	ні
`vehicle.lotId`	`string \| null`	ні
`vehicle.titleStatus`	`"clean" \| "salvage" \| "rebuilt" \| "flood" \| "junk" \| "parts_only" \| "certificate" \| "unknown" \| null`	ні
`type`	`"full_service" \| "auction_only" \| "logistics_only" \| "resale"`	ні
`route`	`"sea" \| "land"`	ні
`currency`	`"UAH" \| "USD" \| "EUR" \| "PLN" \| "GEL"`	ні
`managerId`	`string (uuid)`	ні
`feeModel`	`"fixed" \| "percent"`	ні
`feeValue`	`number \| string`	ні
`destinationCountry`	`string`	ні
`destinationCity`	`string`	ні
`note`	`string`	ні
`notifyClient`	`boolean`	ні
`budget`	`number \| string`	ні
`requirements`	`string`	ні
`deposit`	`object`	ні
`deposit.amount`	`number \| string`	ні
`deposit.dueDate`	`string (date)`	ні

Відповіді

201

The created deal.

application/json · Схема: DealCreated

Поле	Тип	Обов’язк.	Опис
`deal`	`object`	так
`deal.id`	`string (uuid)`	так
`deal.number`	`string`	так
`deal.status`	`"lead" \| "consult" \| "contract_signed" \| "deposit_paid" \| "searching" \| "bid_approved" \| "won" \| "paid_to_auction" \| "pickup_scheduled" \| "at_us_warehouse" \| "loaded" \| "in_transit_sea" \| "at_eu_port" \| "inland_to_border" \| "customs_clearing" \| "customs_cleared" \| "certification" \| "registration" \| "ready_for_handover" \| "handed_over" \| "closed" \| "lost" \| "cancelled" \| "on_hold" \| "dispute"`	так
`deal.pausedFrom`	`"lead" \| "consult" \| "contract_signed" \| "deposit_paid" \| "searching" \| "bid_approved" \| "won" \| "paid_to_auction" \| "pickup_scheduled" \| "at_us_warehouse" \| "loaded" \| "in_transit_sea" \| "at_eu_port" \| "inland_to_border" \| "customs_clearing" \| "customs_cleared" \| "certification" \| "registration" \| "ready_for_handover" \| "handed_over" \| "closed" \| "lost" \| "cancelled" \| "on_hold" \| "dispute" \| null`	так
`deal.type`	`"full_service" \| "auction_only" \| "logistics_only" \| "resale"`	так
`deal.route`	`"sea" \| "land"`	так
`deal.currency`	`"UAH" \| "USD" \| "EUR" \| "PLN" \| "GEL"`	так
`deal.contactId`	`string (uuid)`	так
`deal.managerId`	`string \| null (uuid)`	так
`deal.vehicleId`	`string \| null (uuid)`	так
`deal.destinationCountry`	`string \| null`	так
`deal.destinationCity`	`string \| null`	так
`deal.etaDelivery`	`string \| null`	так	ISO 8601 date-time (UTC).
`deal.stageDates`	`object`	так	stage -> time of entering it.
`deal.trackingToken`	`string (uuid)`	так	Token of the public tracking page (Track).
`deal.trackingEnabled`	`boolean`	так
`deal.lostReason`	`string \| null`	так
`deal.closedAt`	`string \| null`	так	ISO 8601 date-time (UTC).
`deal.createdAt`	`string`	так	ISO 8601 date-time (UTC).
`deal.updatedAt`	`string`	так	ISO 8601 date-time (UTC).
`taskIds`	`string (uuid)[]`	так