Each add-on app has its own REST API v1 reference page now. The key, limits, pagination and error format are the same for all of them: see the API overview.
Each app’s endpoints need that app. The API checks the app before anything else: on a store without it, its endpoints answer 403 with the code rentals_rest_app_not_installed and data.app naming the app. One key works for every app on the store.
| App | REST reference | Paths | data.app |
|---|---|---|---|
| E-Sign Contracts & Waivers | REST API reference: E-Sign Contracts & Waivers | /api/v1/contracts/… | contracts |
| Refundable Security Deposits | REST API reference: Refundable Security Deposits | /api/v1/deposits/… | deposits |
| Custom Fields (Fields, Waiver & ID) | REST API reference: Custom Fields | /api/v1/fields/… | fields |
| SI Request a Quote, Hide Price | REST API reference: Request a Quote | /api/v1/quotes/… | quotes |
| SI Subscriptions & Memberships | REST API reference: Subscriptions & Memberships | /api/v1/subs/… | subscriptions |
| SI Delivery Routing | REST API reference: Delivery Routing | /api/v1/routes/… | routes |
{"code": "rentals_rest_app_not_installed",
"message": "This store does not have the SI Request a Quote, Hide Price app installed, so its operations are not available.",
"data": {"app": "quotes", "status": 403}}The Rentals & Bookings endpoints are in REST API reference: bookings and availability and REST API reference: warehouse, stock and settings.
E-Sign Contracts & Waivers #
Signed agreements, their audit trail and PDF, verify and resend: REST API reference: E-Sign Contracts & Waivers.
Security Deposits #
An order’s deposits, refunds to the original payment method, automatic refunds and product deposit rules: REST API reference: Refundable Security Deposits.
Custom Fields #
Answers on orders, field groups, ID check status, definition imports and exports, answers exports: REST API reference: Custom Fields.
Quotes #
Quotes: list, create, change, send, cancel, reopen, convert, notes, messages and the PDF: REST API reference: Request a Quote.
Subscriptions & Memberships #
Subscriptions, plans, memberships and store credit, tiers, the rental queue and loans, gifts and analytics: REST API reference: Subscriptions & Memberships.
Delivery Routing #
Stops, routes, planning and sending a day, vehicles, drivers, proof of delivery, slots, reports and webhooks: REST API reference: Delivery Routing.
