ImportOS · Docs
API reference

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.

  • Authentication: header Authorization: Bearer rv_live_... (API keys and scopes)
  • Required scope: write:deals
Descriptions of the operation, parameters and fields come from the OpenAPI specification (openapi.json).

Parameters

FieldInTypeRequiredDescription
idpathstring (uuid)yesResource id (UUID).

Responses

200

The deal.

application/json · Schema: DealDetail

FieldTypeRequiredDescription
dealobjectyes
deal.idstring (uuid)yes
deal.numberstringyes
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"yes
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" | nullyes
deal.type"full_service" | "auction_only" | "logistics_only" | "resale"yes
deal.route"sea" | "land"yes
deal.currency"UAH" | "USD" | "EUR" | "PLN" | "GEL"yes
deal.contactIdstring (uuid)yes
deal.managerIdstring | null (uuid)yes
deal.vehicleIdstring | null (uuid)yes
deal.destinationCountrystring | nullyes
deal.destinationCitystring | nullyes
deal.etaDeliverystring | nullyesISO 8601 date-time (UTC).
deal.stageDatesobjectyesstage -> time of entering it.
deal.trackingTokenstring (uuid)yesToken of the public tracking page (Track).
deal.trackingEnabledbooleanyes
deal.lostReasonstring | nullyes
deal.closedAtstring | nullyesISO 8601 date-time (UTC).
deal.createdAtstringyesISO 8601 date-time (UTC).
deal.updatedAtstringyesISO 8601 date-time (UTC).
contactobjectyes
contact.idstring (uuid)yes
contact.fullNamestringyes
contact.phonesstring[]yes
contact.emailsstring[]yes
contact.telegramUsernamestring | nullyes
managerobjectyes
manager.idstring (uuid)yes
manager.namestringyes
vehicleobjectyes
vehicle.idstring (uuid)yes
vehicle.vinstring | nullyes
vehicle.makestring | nullyes
vehicle.modelstring | nullyes
vehicle.trimstring | nullyes
vehicle.yearinteger | nullyes
vehicle.bodystring | nullyes
vehicle.fuelstring | nullyes
vehicle.gearboxstring | nullyes
vehicle.engineCcinteger | nullyes
vehicle.mileageKminteger | nullyes
vehicle.colorstring | nullyes
vehicle.sourceUrlstring | nullyes
vehicle.lotIdstring | nullyes
stagesobject[]yes
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" | nullno
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"no
stages[].atstringnoISO 8601 date-time (UTC).
stages[].notestring | nullno
transitionsobject[]yesTransitions 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"no
transitions[].kindstring | nullno
transitions[].okbooleannofalse: not possible right now, see missing / reasonKey.
transitions[].missingstring[]noRequirement keys that are not met yet, e.g. "vehicle.vin".
transitions[].reasonKeystring | nullno
transitions[].reasonRequiredbooleannoA note is required for this transition.
slaobjectyes
sla.statusstringyesok | warning | breached | none.
sla.slaDaysnumber | nullyes
sla.daysInStagenumberyes
sla.daysLeftnumber | nullyes
sla.daysOverduenumberyes

400

Invalid request parameters or body (code validation_error).

application/problem+json · Schema: Problem

401

Missing, malformed, unknown, revoked or expired API key (code unauthorized).

application/problem+json · Schema: Problem

403

The API key lacks the scope required by this endpoint (code insufficient_scope).

application/problem+json · Schema: Problem

404

No such deal in this tenant.

application/problem+json · Schema: Problem

429

Rate limit exceeded for the tenant plan (code rate_limited). Wait Retry-After seconds.

application/problem+json · Schema: Problem

On this page