Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

EZRentOut Orders API

Rental orders, called baskets - draft, reserve, check out, and check in.

EZRentOut Orders API is one of 11 APIs that EZRentOut publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Orders. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 10 operations across 8 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://{subdomain}.ezrentout.com.

10 operations 8 paths 3 schemas 3 GET6 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://{subdomain}.ezrentout.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

EZRentOut Orders API declares 1 security scheme for authenticating requests. An API key is passed in the header as token (tokenAuth). By default, every request must be authenticated.

  • tokenAuth — Per-company access token generated in Settings (API must be enabled by the account owner). Sent in the token HTTP header on every request over HTTPS.

Paths & Operations 10

Across 8 paths, the API surfaces 10 operations — 3 GET, 6 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Orders 10

Rental orders, called baskets - draft, reserve, check out, and check in.

GET
/baskets.api
List orders
listOrders 1 param → 200401429
POST
/baskets.api
Create an order
createOrder body → 201401
GET
/baskets/{orderNum}.api
Get order details
getOrder 1 param → 200404
PATCH
/baskets/{orderNum}.api
Update an order
updateOrder 1 param body → 200
GET
/baskets/{orderNum}/history.api
Get order history
getOrderHistory 1 param → 200
PATCH
/baskets/{orderNum}/update_basket_from_show.api
Add assets, inventory, or stock to an order
addOrderLineItems 1 param body → 200
PATCH
/baskets/{orderNum}/reservation.api
Book (reserve) an order
reserveOrder 1 param → 200
PATCH
/baskets/{orderNum}/cancel_reservation.api
Cancel an order reservation
cancelOrderReservation 1 param → 200
PATCH
/baskets/{orderNum}/checkout.api
Rent out (check out) an order
checkoutOrder 1 param → 200
PATCH
/baskets/{orderNum}/checkin.api
Return (check in) an order
checkinOrder 1 param → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Order (8 properties), OrderInput (4 properties), Error (2 properties). Each schema is shown below with its type and property counts.

OrderInput
object
4 properties
Order
object
A rental order (basket).
8 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ezrentout-orders-api-openapi.yml Raw ↑

Other APIs EZRentOut publishes across the network.

EZRentOut Assets API
EZRentOut Availability API
EZRentOut Bundles API
EZRentOut Customers API
EZRentOut Inventory API
EZRentOut Locations API
EZRentOut Maintenance API
EZRentOut Members API
EZRentOut Payments API
EZRentOut Purchase Orders API