Checkouts API

The Checkouts API is your path to borrowing, returning, and checking the status of titles.

Using the Checkouts API

Using POST, GET, and DELETE requests, you can use the Checkouts API to borrow, fulfill, and return titles.

Available endpoint actions

• GET user checkouts: This request returns a current list of the user's borrowed titles or finds a specific title they've borrowed.
• Check out (borrow) a title (POST): This request borrows a title on the user's behalf.
• Fulfill a checked out title (GET): This request redirects the user to an interface where they can choose a format and open a borrowed title.
• Return a title (DELETE): This request allows you to return a title on behalf of a user.

GET a list of a user's checkouts

Below is the example GET request sent to the /v1/patrons/me/checkouts endpoint.

The response includes a list of titles that the authenticated user currently has checked out.

Use the hypermedia links in the Checkouts response to make calls to other APIs for more information on a given title (like Metadata). You can also return a book on a user's behalf (via the earlyReturn action).

GET information about a specific checkout

To get information about a specific checkout, you can make a GET request to the checkouts endpoint with the reserveId or crossRefId (also called the titleId).

Checking out a title (POST)

You can borrow a title on a user's behalf by sending a POST request to the checkouts endpoint. This request must include the title's reserveId or crossRefId in the request body (as a name and value pair).

Fulfilling a checked out title (GET)

The downloadRedirect link (available in the GET and POST checkout responses) points to the OverDrive fulfillment interface, where your user can select a format for the title and open it.

Format options vary by title, by type of content (ebooks, audiobooks, etc.), and by type of library (public, school, law, etc.).

A successful request will return a "302 Found" response.

The fulfillment interface's UI is provided by OverDrive, but you can choose how it's displayed: as a new browser window, as a new tab, or in an iframe.

If using an iframe:

• Make sure scrolling is enabled, so all content and options appear.
• Note that users may be prompted to refresh the page if something goes wrong.

Returning a title (DELETE)

Titles are automatically returned once their lending period expires, but you can return a book on a user's behalf before then by making a DELETE request to the checkouts endpoint.

The response will show a "204 NoContent" message when the return has been completed successfully.

Note that if a user has selected the ebook-kindle format for a title and wants to return it early, they must go through Amazon. You’ll get a "400 BadRequest" error if a Kindle Book is returned via the checkouts endpoint.