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
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 anIdempotency-Key.
Propose a modification
addwithparentCartItemIdadds an option to a line.servicesadds a service before payment only (409 services_after_payment_unavailableafterwards).settingIdis the price setting of the service, returned byGET /services. A delivery also needsdeliveryAddress,deliveryLatanddeliveryLng: the distance is computed by the server.POST /modification/previewtakes the same body and writes nothing. It does not includeservicesin its amounts.GET /modification/equipmentlists what can be added.DELETE /modificationwithdraws a pending proposal.
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: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 anIdempotency-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.