Skip to main content
Every action below behaves exactly like in your dashboard: the same emails, the same stock rules, the same checks.

List requests

status: todo (waiting for you), today, incoming, finished, all. Up to 50 items per page.
GET /rentals/{id} adds the equipment, services, amounts, contract, conversationId and the actions available right now. GET /rental/{id} (singular) stays available with its original format.

Accept or refuse

Accepting twice answers 200. POST /rentals/{id}/refuse takes an optional message and motif (equipment_unavailable, owner_unavailable, other). Refuse never cancels an accepted rental: it answers 409 already_accepted.

Cancel an accepted rental

Cancelling refunds the tenant. Read the consequences first, then send an Idempotency-Key.

Propose a modification

  • add with parentCartItemId adds an option to a line.
  • services adds a service before payment only (409 services_after_payment_unavailable afterwards). settingId is the price setting of the service, returned by GET /services. A delivery also needs deliveryAddress, deliveryLat and deliveryLng: the distance is computed by the server.
  • POST /modification/preview takes the same body and writes nothing. It does not include services in its amounts.
  • GET /modification/equipment lists what can be added. DELETE /modification withdraws a pending proposal.
The response holds outcome: applied, pending_tenant, pending_refund or unchanged.

Automatic cancellation

By default, a request without an answer is cancelled once its departure day has passed. You can cancel earlier:
Between 1 and 14 days, null to turn it off. It runs every night, so 1 means the night before departure. A request less than 24 hours old is never cancelled this way.

After the request

Deposit routes apply to rentals from your own storefront. Signing is not available through the API: each party signs on the signature page, with their code.

Quotes

GET /quotes, POST /quotes, GET|PATCH /quotes/{id}, POST /quotes/{id}/lines, PATCH|DELETE /quotes/{id}/lines/{lineId}, POST /quotes/{id}/services, DELETE /quotes/{id}/services/{lineId}, POST /quotes/{id}/send|extend|cancel, GET /quotes/{id}/pdf.

Idempotency

Send an Idempotency-Key header (128 characters at most) on writes. It is required on cancel and modification. The same key and body within 24 hours replays the first answer, with Idempotent-Replayed: true. The same key with another body answers 422 idempotency_conflict.