The Patron API - Checkouts and Renewals

Checking an item out uses the endpoints listed below. To check in an item, see the Item API.

The Patron API contains methods for checking out items, retrieving checkout data, and renewing a checked-out item. Using these endpoints, you can:

The Try it out! links below take you to the corresponding section in the interactive documentation, where you can view the model, model schema, and parameters for each available operation.

Get a Checkout by Checkout ID

To use this endpoint, your key must be assigned the Patrons Read role. See Administering Sierra API Client Keys in the Sierra WebHelp for more information.

GET /v6/patrons/checkouts/{checkoutId}

Returns a single Checkout object.

Try it out!

Request to Renew a Checkout

To use this endpoint, your key must be assigned the Patrons Write role. See Administering Sierra API Client Keys in the Sierra WebHelp for more information.

POST /v6/patrons/checkouts/{checkoutId}/renewal

Places a checkout renewal request for the specified checkout ID.

Try it out!

Get Checkout Data for a Single Patron Record

To use this endpoint, your key must be assigned the Patrons Read role. See Administering Sierra API Client Keys in the Sierra WebHelp for more information.

GET /v6/patrons/{id}/checkouts

Returns all checkout data for a specified patron record.

Try it out!

Check Out an Item by Patron and Item Barcode

This endpoint is available in Sierra 5.2 and later. To use this endpoint, your key must be assigned the Patrons Write role. See Administering Sierra API Client Keys in the Sierra WebHelp for more information.

POST /v6/patrons/checkout

Checks out an item to a patron using the specified patron and item barcodes. This functionality supports patron self-checkout using selfcheck kiosks and mobile applications.

This endpoint requires a CheckoutPatch request object. The following example shows the JSON structure used to check an item out.

{

"patronBarcode": "21517000214658",

"itemBarcode": "31517000744785"

}

If the library uses patron PIN verification, you also must include the patronPin field. For example:

{

"patronBarcode": "21517000214658",

"itemBarcode": "31517000744785",

"patronPin": "3505"

}

If the checkout is successful, Sierra API returns a checkout record ID. For example:

{

"id": "https://example-library.edu/iii/sierra-api/v6/patrons/checkouts/22035"

}

If the checkout is not successful, Sierra API returns an error message.

Try it out!