ImportOS · Документація
Довідник API

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 (openapi.json) і подається англійською, як у самому API.

Параметри

ПолеДеТипОбов’язк.Опис
idpathstring (uuid)такResource id (UUID).

Відповіді

200

The deal.

application/json · Схема: DealDetail

ПолеТипОбов’язк.Опис
dealobjectтак
deal.idstring (uuid)так
deal.numberstringтак
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.contactIdstring (uuid)так
deal.managerIdstring | null (uuid)так
deal.vehicleIdstring | null (uuid)так
deal.destinationCountrystring | nullтак
deal.destinationCitystring | nullтак
deal.etaDeliverystring | nullтакISO 8601 date-time (UTC).
deal.stageDatesobjectтакstage -> time of entering it.
deal.trackingTokenstring (uuid)такToken of the public tracking page (Track).
deal.trackingEnabledbooleanтак
deal.lostReasonstring | nullтак
deal.closedAtstring | nullтакISO 8601 date-time (UTC).
deal.createdAtstringтакISO 8601 date-time (UTC).
deal.updatedAtstringтакISO 8601 date-time (UTC).
contactobjectтак
contact.idstring (uuid)так
contact.fullNamestringтак
contact.phonesstring[]так
contact.emailsstring[]так
contact.telegramUsernamestring | nullтак
managerobjectтак
manager.idstring (uuid)так
manager.namestringтак
vehicleobjectтак
vehicle.idstring (uuid)так
vehicle.vinstring | nullтак
vehicle.makestring | nullтак
vehicle.modelstring | nullтак
vehicle.trimstring | nullтак
vehicle.yearinteger | nullтак
vehicle.bodystring | nullтак
vehicle.fuelstring | nullтак
vehicle.gearboxstring | nullтак
vehicle.engineCcinteger | nullтак
vehicle.mileageKminteger | nullтак
vehicle.colorstring | nullтак
vehicle.sourceUrlstring | nullтак
vehicle.lotIdstring | nullтак
stagesobject[]так
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[].atstringніISO 8601 date-time (UTC).
stages[].notestring | nullні
transitionsobject[]так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[].kindstring | nullні
transitions[].okbooleanніfalse: not possible right now, see missing / reasonKey.
transitions[].missingstring[]ніRequirement keys that are not met yet, e.g. "vehicle.vin".
transitions[].reasonKeystring | nullні
transitions[].reasonRequiredbooleanніA note is required for this transition.
slaobjectтак
sla.statusstringтакok | warning | breached | none.
sla.slaDaysnumber | nullтак
sla.daysInStagenumberтак
sla.daysLeftnumber | nullтак
sla.daysOverduenumberтак

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

На цій сторінці