GET /v1/deals/{id}
Get a deal
Get a deal
The deal with its contact, vehicle, stage history, SLA and the transitions available to this key. Deals of other tenants are 404. Requires scope write:deals.
- Автентифікація: заголовок
Authorization: Bearer rv_live_...(API-ключі та scopes) - Потрібний scope:
write:deals
openapi.json) і подається англійською, як у самому API.Параметри
| Поле | Де | Тип | Обов’язк. | Опис |
|---|---|---|---|---|
id | path | string (uuid) | так | Resource id (UUID). |
Відповіді
200
The deal.
application/json · Схема: DealDetail
| Поле | Тип | Обов’язк. | Опис |
|---|---|---|---|
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). |
contact | object | так | |
contact.id | string (uuid) | так | |
contact.fullName | string | так | |
contact.phones | string[] | так | |
contact.emails | string[] | так | |
contact.telegramUsername | string | null | так | |
manager | object | так | |
manager.id | string (uuid) | так | |
manager.name | string | так | |
vehicle | object | так | |
vehicle.id | string (uuid) | так | |
vehicle.vin | string | null | так | |
vehicle.make | string | null | так | |
vehicle.model | string | null | так | |
vehicle.trim | string | null | так | |
vehicle.year | integer | null | так | |
vehicle.body | string | null | так | |
vehicle.fuel | string | null | так | |
vehicle.gearbox | string | null | так | |
vehicle.engineCc | integer | null | так | |
vehicle.mileageKm | integer | null | так | |
vehicle.color | string | null | так | |
vehicle.sourceUrl | string | null | так | |
vehicle.lotId | string | null | так | |
stages | object[] | так | |
stages[].fromStatus | "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 | ні | |
stages[].toStatus | "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" | ні | |
stages[].at | string | ні | ISO 8601 date-time (UTC). |
stages[].note | string | null | ні | |
transitions | object[] | так | Transitions available to this API key now (a stage may be restricted to other roles). |
transitions[].to | "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" | ні | |
transitions[].kind | string | null | ні | |
transitions[].ok | boolean | ні | false: not possible right now, see missing / reasonKey. |
transitions[].missing | string[] | ні | Requirement keys that are not met yet, e.g. "vehicle.vin". |
transitions[].reasonKey | string | null | ні | |
transitions[].reasonRequired | boolean | ні | A note is required for this transition. |
sla | object | так | |
sla.status | string | так | ok | warning | breached | none. |
sla.slaDays | number | null | так | |
sla.daysInStage | number | так | |
sla.daysLeft | number | null | так | |
sla.daysOverdue | number | так |
400
Invalid request parameters or body (code validation_error).
application/problem+json · Схема: Problem
401
Missing, malformed, unknown, revoked or expired API key (code unauthorized).
application/problem+json · Схема: Problem
403
The API key lacks the scope required by this endpoint (code insufficient_scope).
application/problem+json · Схема: Problem
404
No such deal in this tenant.
application/problem+json · Схема: Problem
429
Rate limit exceeded for the tenant plan (code rate_limited). Wait Retry-After seconds.
application/problem+json · Схема: Problem