ILL (Interlibrary loan) requests

The ILL (Interlibrary loan) requests module adds the ability to request and manage loans or copies of material from external sources. Patrons can submit a request via the OPAC from the Interlibrary loan requests tab of their account. Library staff can then review and process those requests. Alternatively, staff can place requests themselves from the staff interface.

Interlibrary loans module settings

To enable the Interlibrary loans module, set the ILLModule system preference to ‘Enable’.

Not

Only staff with the ill permission (or the superlibrarian permission) will be able to create and manage ILL requests.

Initial configuration

Before using the Interlibrary loans module, you will want to make sure you have reviewed all ILL-related configuration.

  • Backends: the ILL requests module can be configured for different types of requests and workflows. Koha uses ‘backends’ to process ILL requests depending on how the document should be supplied. Some backends are available as plugins. Others are documented on the Koha community wiki at https://wiki.koha-community.org/wiki/ILL_backends.

  • System preferences for interlibrary loans: the most important one is the ILLModule system preference, the master switch for the ILL module.

  • Staff permissions: library staff responsible for ILL requests need the ill permission (or the superlibrarian permission).

  • Patron categories settings: choose which patron categories can place ILL requests from the OPAC.

  • Custom request statuses: the ILL requests module uses system-defined statuses. In addition, you can create as ILL_STATUS_ALIAS authorized values custom statuses to match your ILL workflow.

  • Branch prefix: in the Interlibrary loans module, you can display ILL request IDs prefixed with a different code depending on the library the request is associated with. To configure this, update the <branch> elements (within <interlibrary_loans>) in the koha-conf.xml file on your server.

    • You can repeat <branch> and everything within it to configure a prefix for each of your libraries.

    • Example: to prefix the requests of the library whose code is CPL with ‘CPL’, FFL library requests with ‘FFL’ and LPL library requests with ‘LPL’.

      <branch>
         <!-- The code of this branch -->
         <code>CPL</code>
         <!-- An optional prefix for all ILL request IDs for this branch -->
         <prefix>CPL</prefix>
      </branch>
      <branch>
         <code>FFL</code>
         <prefix>FFL</prefix>
      </branch>
      <branch>
         <code>LPL</code>
         <prefix>LPL</prefix>
      </branch>
      
  • Staff comments: by default, these are hidden in the OPAC. To display them, update the <staff_request_comments> element (within <interlibrary_loans>) in the koha-conf.xml file on your server.

  • Reply date: by default, this information is hidden in the staff interface. To display it with your preferred label, update the <reply_date> element (within <interlibrary_loans>) in the koha-conf.xml file on your server.

ILL email notifications

Email notifications can be sent to library staff when a patron makes a request to modify (notice code: ILL_REQUEST_MODIFIED) or cancel (notice code: ILL_REQUEST_CANCEL) an existing request. Enable this feature using the ILLSendStaffNotices system preference.

The ILL staff email address can be configured per library in the Libraries settings. If there is no email for a library, the address in the ILLDefaultStaffEmail system preference will be used.

Notifications can be sent to patrons for updates on their requests:

  • ILL request update (notice code: ILL_REQUEST_UPDATE)

  • ILL request unavailable (notice code: ILL_REQUEST_UNAVAIL)

  • ILL request ready for pickup (notice code: ILL_PICKUP_READY)

The notifications are enabled from the patron categories default patron messaging preferences.

All notice templates can be customized in the Notices and slips tool.

Configuring partner libraries

If you have a network of partner libraries which permit ILL requests, you can send them requests directly from Koha.

  • Create a patron category to be assigned to partner libraries. You may want to give it the description ‘Interlibrary loan’ or ‘ILL partner library’ and a category type of ‘Organization’.

  • Select this category in the ILLPartnerCode system preference.

  • You will need to create a patron account with this patron category for each partner library. Each account must have an email address, as this will be the mechanism for sending the inter-library loan request.

Not

The request will be sent using the ILL_PARTNER_REQ notice template. The text can be customized from the Notices and slips tool.

You can now use the ‘Place request with partners’ option when managing requests.

Tüyo

You could use the ILLCheckAvailability system preference and associated plugins to search the catalogs of your partner libraries prior to placing an interlibrary loan request with them.

The ILL request workflow

This section summarises in flowchart form the journey of an ILL request and the statuses used by Koha. The following sections explain each step in detail.

Flowchart key:

  • Green rectangles: request status. The status code is in brackets.

  • Yellow ovals: actions in the staff interface.

  • Blue ovals: actions in the OPAC.

  • Black ovals: actions outside of Koha.

From the staff interface, staff place an ILL request - its status is New request (NEW). From the OPAC, a logged-in patron places an ILL request - its status is New request (NEW). From the OPAC, a patron who is not logged in places an ILL request - its status is Unauthenticated (UNAUTH). The next step is for staff to manage the request. Available routes depend on the request type and backend, options used by the library and title availability. Staff can choose to place the request via the backend - its status is usually Requested (REQ). Or staff can place the request with ILL partners - the status becomes Requested from partners (GENREQ). In either case, if the title cannot be provided, the next request status is Request reverted (REQREV). This can be done manually by staff or automatically by the backend. If the title can be provided and is a book, and if CirculatelLL is enabled, staff can check it out to the patron directly via the ILL request - the request status becomes Checked out (CHK). When the book is checked back in, the request status becomes Returned to library (RET). Whether the title has been provided or whether staff decided at any point that the request cannot be fulfilled, staff can manually complete the request. Backends can also automatically complete requests. The request status becomes Completed (COMP). Status aliases may be added for more information.

In addition to the actions illustrated above, patrons logged-in to the OPAC can request the cancellation of their request. This option is only available to them when the request status is ‘New request’. The status then changes to ‘Cancellation requested’. You may choose to either delete these requests or mark them ‘Completed’ with a custom status alias (ILL_STATUS_ALIAS authorized values), e.g. ‘Cancelled by patron’.

Creating ILL requests

To create ILL requests in the staff interface, go to the ILL requests module.

  1. Click the ‘New ILL request’ button.

    The "New ILL request" button is clicked; a menu for picking a backend is displayed, with options for PluginBackend and Standard.

    Not

    You will not see the drop-down options to select a backend if:

    In these cases, clicking the ‘New ILL request’ button will take you directly to step 3.

  2. Select a backend.

    Not

    The images shown here are for the Standard backend only.

    New ILL request page, with no request type selected, showing a section to add custom fields and another for patron options.

  3. Select a Type: Book, Chapter, Journal, Journal article, Thesis, Conference, DVD, Other, Generic resource. A different set of metadata fields will display for each request type.

    Showing the top part of the new ILL request page with the type "Book" selected; a section for Book details is displayed.

  4. Enter as much as information as you like.

  5. Custom fields: add a new custom field if needed; for example if you wish to add a note or if you are using the ‘Other’ type of request.

  6. Patron options:

    1. Card number, username or surname: type in the patron details.

    2. Destination library: select the library associated with the request.

  7. Click ‘Create’.

Not

If you have enabled the ILLHistoryCheck system preference and matching requests have been found, you will see the results of the history check at this stage.

Request history check page. The top section is entitled "You are attempting to place the following request". Displayed underneath are the author, backend, cardnumber, ISBN, library, title and type (book) for the request. The message "This request has already been placed by patron Mx Sam Page (20001010)" displays next, with a link to "Request 3 (Completed) on 10/04/2026". There are two buttons: Submit anyway; and, Cancel.

If you click ‘Submit anyway’, existing requests are ignored and the workflow progresses towards creating the request as usual. If you cancel, the request will not be created.

Not

If you have enabled the ILLCheckAvailability system preference and installed plugins for the staff interface, you will be presented with search results. If the title is found, follow the link to a relevant resource or proceed with the ILL request regardless. If no results are found, the ILL request is created.

Not

If you are using the AutoILLBackendPriority system preference, you will see the ‘Confirm request’ screen. Select a backend and click ‘Confirm’ to create the request.

On the ILL confirm request page, we can see three options, each in their own block: IncDocs, ReprintsDesk and Standard. Both IncDocs and ReprintsDesk show as 'Available'. IncDocs is ticked. Under the blocks is the message: 'The recommended source for your request is IncDocs'.

You can now manage your request or return to the list of all requests by clicking the ‘List requests’ button.

Viewing ILL requests

From the main ILL requests screen you can view, filter and sort your ILL requests.

Click on the ‘List requests’ button from other pages in the ILL module to return to this list.

Part of the ILL module homepage, showing a list of ILL requests.

Tüyo

You can customize this view.

There is a large amount of data available in the table; scroll right to see all the columns. You can define which columns are visible / hidden by default in the Table settings section of the Administration module (table id: ill-requests).

Use the filters on the left of the page to display a subset of requests based on your chosen criteria.

ILL requests filters; shows options for keyword, status, date placed between, updated between, library, patron.

Managing ILL requests

From the main ILL requests view, click on a request ID in the first column or on the ‘Manage request’ button in the final column. The request’s full details are displayed.

On the Manage ILL request page, we can see a row of buttons: Edit request; Confirm request; PLace request with partners; Delete request; Edit item metadata; Send notice to patron; Display supplier metadata; ILL request log. Below are the Request details with some of the following values: Patron = Sam Page ; Library = Ada Lovelace Library; Status = New request; Last updated; Request type = thesis; Author; Institution; Publication date; Title. At the bottom is a section to add comments.

Depending on the current status of the request and the backend used, you may see some or all of the buttons described in the next section.

From this screen, you can add comments to the request. You may want to use comments to keep track of work undertaken. Comments are read-only (they cannot be edited or deleted). They are only visible in the staff interface. If any comments have been added to a request, a number will appear in the ‘Comments’ column when viewing the full list of ILL requests.

Authenticated requests

Authenticated requests are requests linked to the Koha patron who requested the document. All requests placed in the staff interface or placed on the OPAC by patrons logged in to their account are authenticated requests.

New authenticated requests have the status ‘New request’. Staff can progress the requests straightaway by using some of the following buttons.

  • Edit request: to update the patron the request is associated with, which staff member is managing the request, the destination library.

    On the Edit request page, the Request details form includes the following fields and values: Patron ID = 13; Bibliographic record ID; Library = Ada Lovelace Library; Status = New request; Last updated = 10/04/2026 15:03; Request type = thesis; Cost = N/A; Price paid; Request ID = 4; Staff notes; OPAC notes.

    • OPAC and staff-only notes can be added from the edit screen.

    • If you have custom ILL statuses (managed through the ILL_STATUS_ALIAS authorized values category) you can apply one by editing the Status field.

  • Confirm request: to manually mark the request as ‘Requested’.

  • Place request with partners: for Koha to send a request to supply to a library. Using this option requires some prior configuration. The request status is then updated to ‘Requested from partners’.

    On the Place request with partner libraries page, we can see fields for: Filter partner libraries; Select partner libraries; Subject line; Email text. Underneath is a button labelled Send email.

    • Filter partner libraries: type keywords to narrow down the list of accounts displayed in the next field.

    • Select partner libraries: choose a recipient from the list of your ILL partners. Each account’s library code is shown in capital letters before the account name.

    • Subject line: you can customize the subject line of the email Koha will send.

    • Email text: you can customize the text of the email Koha will send.

    Not

    The default subject line and email text used here are defined in the ILL_PARTNER_REQ notice template in the Notices and slips tool.

  • Delete request: to fully delete the request. Details of deleted requests are not retained in the Koha database.

  • Edit item metadata: to update the metadata (title, author, etc.) for the title requested. This is useful when the information provided initially is incomplete or incorrect.

    Not

    Some backends may not allow updates to the metadata.

  • Send notice to patron: to send an update to the patron requesting the title.

    • ILL request ready for pickup: to alert the patron that their requested item is ready for collection. You can customize the notice text in the ILL_PICKUP_READY notice template in the Notices and slips tool.

    • ILL request unavailable: to inform the patron that your library will not be able to supply the requested title. You can customize the notice text in the ILL_REQUEST_UNAVAIL notice template in the Notices and slips tool.

  • Display supplier metadata: to view a text-only version of the details of the title requested. This may be useful in the cases where you need to quickly copy and paste this information outside of Koha.

  • ILL request log: to view a history of the actions on this request. For any information to be displayed here, the IllLog system preference needs to be set to ‘Log’.

    Request log showing entries for status changed and patron notice sent. For each entry, we see the date, time, name and card number of the user who performed the action, type of action and details. For example, the first entry reads: '03/06/2026 09:13 : Clara Birchwood (20001037) - Status changed: From "Requested from partners" to "Checked out".'

Other buttons you may see as you progress the request:

  • Switch provider: to select a different backend and request the title from another provider. This is useful when the the wrong backend was initially selected or when the provider has indicated they are unable to supply.

  • Revert request: to cancel the request placed with an external source. This button is visible when the request has a status of ‘Requested’ or ‘Requested from partners’. The status is updated to ‘Request reverted’.

  • Check out: to checkout the item supplied by a partner library directly to the patron who placed the request. The request status is updated to ‘Checked out’.

  • Mark completed: to update the status to ‘Completed’ when the request has been fulfilled and fully processed.

Unauthenticated requests

If the ILLOpacUnauthenticatedRequest system preference is set to ‘Allow’, patrons can place requests without being logged in or without having an account.

Version

This feature was first introduced in version 25.05 of Koha.

Requests placed in this way have the status ‘Unauthenticated’. Before they can be progressed, you need to link it to a patron record.

  1. From the main ILL requests view, identify a request with the status ‘Unauthenticated’.

  2. Click on the request ID in the first column or on the ‘Manage request’ button in the final column to view the request’s full details.

  3. Click the ‘Edit request’ button.

  4. The Unauthenticated request details section shows the details entered by the patron who placed the request. Use this to search for an existing patron.

    1. The ‘Patron ID’ field at the top of the page can be used as a patron quick search. Start typing the patron name to see suggestions.

      On the Edit request page, the Request details form includes the following fields and values: Patron ID = sam (underneath are two suggestions for patrons Sam Hawkins and Sam Page); Managed by; Bibliographic record ID = 440; Library = Riverside; Status = Unauthenticated; Last updated = 05/29/2026 12:26; Request type = book; Cost = N/A; Price paid; Request ID = 2; Staff notes; OPAC notes. Underneath is a section for Unauthenticated request details, displaying the following information: First name = Sam; Last name = Page; Email = sam.page@unauth.ill

    2. Alternatively, you can open the Patrons module in another browser tab and perform your search there.

    Uyarı

    If the patron who placed the unauthenticated request is not yet a library member, you will need to add a new patron record for them before progressing the ILL request.

  5. Whether you are searching a patron by name in the Patron ID field or pasting their card number in the field, you will need to select the correct patron from the suggestions. The field will then update to display the borrowernumber.

  6. Click ‘Submit’ to save your changes.

You can now manage the request in the same way as for other authenticated requests. The Unauthenticated request details section will stop displaying as it is not an unauthenticated request anymore.

Circulating ILL materials

If you have enabled the CirculateILL system preference, you can check out interlibrary loan books directly from the ILL request.

When you create a Book type request, a bibliographic record is created automatically based on the Fast Add MARC framework. These records include a link to the ILL request.

Once the request status is either Requested or Requested with partners, a ‘Check out’ button is displayed on the Manage request page. This enables you to check out the item either to the patron who made the request or an in-house statistical patron.

To check out an item:

  • Click the ‘Check out’ button.

  • On the Check out details page, select:

    • Statistical patron: this is optional. Leaving this blank will check out to the patron who made the request.

    • Item type: an item is automatically added to the bibliographic record that was previously created for the request. The barcode of the item is in the format ILL-requestid, e.g. ILL-123.

    • Library: the item’s home library.

    • Due date: if you do not specify a due date, one will be set according to the circulation rules.

  • Click ‘Submit’. This creates the item, checks it out and updates the ILL request status to ‘Checked out’.

When the item is checked back in, the ILL request status updates to ‘Returned to library’.

Marking requests as completed

Some backends will automatically update the request status to ‘Complete’.

For all other backends, you should complete the request manually by clicking the ‘Mark completed’ button on the Manage ILL request page.

  • If you do not have any ILL_STATUS_ALIAS authorized values defined, the request status will update to ‘Completed’.

  • If you have defined some ILL_STATUS_ALIAS authorized values, you will be prompted to select one.

    The following text appears above a drop-down menu: "Complete ILL request. Proceeding with this action will set this request to 'Completed'. You can select a status alias from the available options". Below are two buttons: Complete request; Cancel.

    Version

    The prompt for the status alias was first introduced in version 25.11 of Koha.

    You can still complete the request without selecting a status alias. Click ‘Complete request’ to confirm your choice. The request status will update to ‘Complete’ and your chosen status alias will be assigned to the request.

Tüyo

Consider using ILL_STATUS_ALIAS authorized values with either the ILLHiddenRequestStatuses system preference or the ILLRequestsTabs system preference to hide or separate some completed requests from the full list of ILL requests. This will be useful when you start having many completed requests.

Batch requests

Instead of creating requests one at a time, you can create requests for the same patron in a batch. This saves you time when the patron has sent library staff a list of titles, and will make it easier for staff to check the progress of these requests.

Not

This feature requires the use of unique identifiers (Pubmed ID or DOI). If a title does not have such identifier, you will not be able to request it as part of a batch.

To use this feature, you need:

  • An ILL backend that supports batch requests. The default Koha Standard backend does and so do some backend plugins, e.g. ReprintsDesk.

  • A metadata enrichment plugin, which will use the unique identifiers to retrieve the requested titles’ metadata. You can install one or more of these plugins, e.g.:

As soon as you have both an ILL backend that supports batch requests and at least one metadata enrichment plugin, you will see the batch options on the main ILL requests screen.

On the ILL requests page we see buttons to the left for New ILL request and Refresh; and to the right for New ILL requests batch and Batch requests.

Creating a batch

  1. From the main ILL requests screen, click the ‘New ILL requests batch’ button.

    The "New ILL requests batch" button is clicked; a menu for picking a backend is displayed, with options for PluginBackend and Standard.

    Not

    You will not see the drop-down options to select a backend if you have additional backends installed and you have selected some in the AutoILLBackendPriority system preference. In this case, clicking the ‘New ILL request’ button will take you directly to step 3.

  2. Select a backend. Only installed backends that support batch requests will be displayed in this list.

    Not

    The images shown here are for the Standard backend only.

  3. Enter a batch name, the details of the patron requesting the titles and select the library managing the batch.

  4. Click ‘Continue’: the patron account is now linked to the batch and the ‘Add batch items’ field appears.

    On the Add new batch modal, we see in the batch details section that the batch name is "Week 3 requests". The card number field is filled in and a library is selected. The next section is Add batch items; it has an input field with the tip "enter identifiers, one per line".

  5. In ‘Add batch items’, enter the the unique identifiers for the requested titles. Above the field is a reminder of which type of identifier (Pubmed ID or DOI) is accepted, depending on which metadata enrichment plugin(s) you have installed.

  6. Click ‘Process identifiers’: a list of titles is now displayed under the input field. The ‘Metadata’ column is progressively filled as items are processed.

    Not

    If you delete identifiers from the ‘Add batch items’ field after they have been processed, they will not disappear from the list. To clear titles added by mistake to the batch, click ‘Remove’ on each relevant line.

    The Add batch items input field contains two identifiers, one per line. A progress bar entitled Retrieving metadata indicates: "Items processed: 2 out of 2. Items failed: 0." The table underneath has columns for Identifier type, Identifier value, Metadata, Request ID and Request status. The last column contains 'Remove' buttons. Under the table are more buttons: Add items to batch, Finish and view batch, Cancel.

  7. If the titles to request are correct, click ‘Add items to batch’. This will create an ILL request for each title in the batch. The request IDs will be generated and the request status marked as ‘NEW’.

  8. Click ‘Finish and view batch’ to close the modal.

You can now manage the requests individually.

Managing batches

From the main ILL requests screen, click the ‘Batch requests’ button to view all batches.

A list of ILL requests batches, in a table where the column headers are: Batch ID, Name, Number of requests, Status, Patron, Library. There are three batches linked to two different libraries, with various statuses (Completed, In progress, New).

Click on a table header to re-order the rows by this column, in either ascending or descending order.

You can update a batch by clicking ‘Edit’. You will be able to:

  • change the batch name;

  • allocate the batch to another library;

  • update the batch status: New, In progress, Completed or Unknown;

  • add batch items (in the same way as when creating a batch).

An existing batch cannot be allocated to a different patron. If the wrong patron was originally selected, you will need to delete this batch and create a new one.

To view all requests within a batch, click on the batch name.

Tüyo

When viewing all ILL requests, make the Batch column visible in the table settings to clearly see which requests belong to a batch.

Reporting for ILL

To query ILL-related information in the Reports module, the main database tables are:

  • illrequests

  • illrequestattributes

Generic information about ILL-related transactions is stored in:

  • statistics

    • The statistics.type ‘illreq_created’ corresponds to the creation of an ILL request.

    • The statistics.type ‘illreq_comp’ corresponds to an ILL request being marked completed.

  • pseudonymized_transactions (if the Pseudonymization system preferences are in use)

    • The pseudonymized_transactions.transaction_type ‘illreq_created’ corresponds to the creation of an ILL request.

    • The pseudonymized_transactions.transaction_type ‘illreq_comp’ corresponds to an ILL request being marked completed.

Version

The recording of ILL transactions in the statistics and pseudonymized_transactions tables is a feature first introduced in version 25.11 of Koha.

Request statuses

Koha has a set of core ILL statuses, listed below (with status codes as stored in the illrequests table). Installed backends may use additional statuses.

  • New request (NEW)

  • Unauthenticated (UNAUTH)

  • Requested (REQ)

  • Requested from partners (GENREQ)

  • Request reverted (REQREV)

  • Cancellation requested – a patron has requested cancellation from the OPAC (CANCREQ)

  • Completed (COMP)

  • Checked out (CHK)

  • Returned to library (RET)