Tech Blog

Common APIs for Real Time Ordering integrations with vendors

The following are common APIs for Acquisitions Vendor Integration.
This is a supplement to the following:

Real Time Acquisition General Overview
Instructions for Institutions
Instructions for vendors
General overview of ExLibris APIs methodology

In the following cases
1. Replace the API key 972y26499l369k with your actual API key.
2. Replace https://api-eu.hosted.exlibrisgroup.com with your geographic location as described in section “Calling Alma APIs” here.

APIs:

GET details on the environment you are connected to:

https://api-eu.hosted.exlibrisgroup.com/almaws/v1/conf/general?apikey=972y26499l369k

GET a list of all libraries in the institution including code and name:

https://api-eu.hosted.exlibrisgroup.com/almaws/v1/conf/libraries?apikey=972y26499l369k

GET details on one specific library which has code MAIN

https://api-eu.hosted.exlibrisgroup.com/almaws/v1/conf/libraries/MAIN?apikey=972y26499l369k

GET a list of locations for one specific library which has code MAIN

https://api-eu.hosted.exlibrisgroup.com/almaws/v1/conf/libraries/MAIN/locations?lang=en&apikey=972y26499l369k

GET details of location with code STACK in library with code MAIN

https://api-eu.hosted.exlibrisgroup.com/almaws/v1/conf/libraries/MAIN/locations/STACK?lang=en&apikey=972y26499l369k

GET a list of all funds in institution for current fiscal year with fund code and other details

https://api-eu.hosted.exlibrisgroup.com/almaws/v1/acq/funds?limit=10&offset=0&apikey=972y26499l369k

GET a list of all funds in institution and available for library with code MAIN for current fiscal year with fund code and other details

https://api-eu.hosted.exlibrisgroup.com/almaws/v1/acq/funds?limit=10&offset=0&library=MAIN&apikey=972y26499l369k

GET a list of all vendors in the institution

https://api-eu.hosted.exlibrisgroup.com/almaws/v1/acq/vendors?status=ALL&type=ALL&limit=10&offset=0&apikey=972y26499l369k

GET a list of all active vendors in the institution

https://api-eu.hosted.exlibrisgroup.com/almaws/v1/acq/vendors?status=active&type=ALL&limit=10&offset=0&apikey=972y26499l369k

GET a list of all active vendors in the institution which have string ‘Erasmus’ in name or code

https://api-eu.hosted.exlibrisgroup.com/almaws/v1/acq/vendors?status=active&type=ALL&q=~Erasmus&limit=10&offset=0&apikey=972y26499l369k

GET details on vendor with code “Erasmus”

https://api-eu.hosted.exlibrisgroup.com/almaws/v1/acq/vendors/Erasmus?apikey=972y26499l369k

GET details for POL with POL number “TRI-44386”

https://api-eu.hosted.exlibrisgroup.com/almaws/v1/acq/po-lines/TRI-44386?apikey=972y26499l369k

POST (Create) an order (POL Purchase Order Line)

https://api-eu.hosted.exlibrisgroup.com/almaws/v1/acq/po-lines?apikey=972y26499l369k

For representation (content type) application/xml:

Use xml below to create an order for title “Libraries in the ancient world” by author “Smith, John” with ISBN 9782018090110”. One item is ordered in Main Library (code MAIN) Open Stacks location (code STACK).

Other details are:

Field in xml

Value

Meaning

Library owner code

MAIN

Main Library

Vendor code

Erasmus

Erasmus Boekhandel

Type

PRINTED_BOOK_OT

Printed Book One Time

Vendor Account

Main Account

 

Price

61.30 USD

 

Fund Code

Humanities

 

Material Type

BOOK

 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<po_line>
  <owner>MAIN</owner>
  <type>PRINTED_BOOK_OT</type>
  <vendor>Erasmus</vendor>
  <vendor_account>Main Account</vendor_account>
  <rush>false</rush>
  <price>
    <sum>61.30</sum>
    <currency desc="US Dollar">USD</currency>
  </price>
  <vendor_reference_number>026499369</vendor_reference_number>
  <vendor_reference_number_type>SLI</vendor_reference_number_type>
  <resource_metadata>
    <mms_id></mms_id>
    <title>Libraries in the ancient world</title>
    <author>Smith, John</author>
    <isbn>9782018090110</isbn>
    <publisher>Libraries Ltd.</publisher>
    <publication_place>Amsterdam</publication_place>
    <publication_year>2018</publication_year>
    <vendor_title_number>21356130</vendor_title_number>
    <system_control_numbers>
      <system_control_number>0547136408</system_control_number>
    </system_control_numbers>
  </resource_metadata>
  <fund_distributions>
    <fund_distribution>
      <fund_code>Humanities</fund_code>
      <amount>
        <sum>61.30</sum>
        <currency desc="US Dollar">USD</currency>
      </amount>
    </fund_distribution>
  </fund_distributions>
  <reporting_code/>
  <notes>
    <note>
      <note_text>Created from API by Yoel</note_text>
    </note>
  </notes>
  <material_type>BOOK</material_type>
 <locations>
   <location>
     <quantity>1</quantity>
       <library>MAIN</library>
       <shelving_location>STACK</shelving_location>
   </location>
 </locations>
</po_line>

Leave a Reply