Common APIs for Acquisitions Vendor Integration /

Yoel Kortick

Senior Librarian

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 972y26499l369kwith your actual API key.
  2. Replace with your geographic location as described in section “Calling Alma APIs” here.

APIs:

GET details on the environment you are connected to:

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

GET details on one specific library which has code MAIN

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

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

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

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

GET a list of all vendors in the institution

GET a list of all active vendors in the institution

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

GET details on vendor with code “Erasmus”

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

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

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_typeSLI</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

Other details are:

Field in xml / Value / Meaning
Library owner code / ULINC / Main Library
Library of the item created / UARCV / Art Library
Location of the item created / GEN / General
Vendor code / JS / J and S Ltd.
Type / PRINTED_BOOK_OT / Printed Book One Time
Vendor Account / JS_MAIN
Price / 61.30 USD
Fund Code / LIS
Material Type / BOOK
First reporting code / y
Second Reporting Code / nfg
Third Reporting Code / u
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
po_line
<owner>ULINC</owner>
<type>PRINTED_BOOK_OT</type>
<vendor>JS</vendor>
<vendor_accountJS_MAIN</vendor_account
<rush>false</rush>
<price>
<sum>61.30</sum>
<currency desc="US Dollar">USD</currency>
</price>
<vendor_reference_number>0264993691</vendor_reference_number
<vendor_reference_number_typeSLI</vendor_reference_number_type
<resource_metadata
<mms_id</mms_id
<title>Libraries in the modernage</title>
<author>Smith, John</author>
<isbn>9782017102301</isbn>
<publisher>Libraries Ltd.</publisher>
<publication_place>Amsterdam</publication_place
<publication_year>2018</publication_year
<vendor_title_number>213561301</vendor_title_number
<system_control_numbers
<system_control_number>05471364081</system_control_number
</system_control_numbers
</resource_metadata
<fund_distributions
<fund_distribution
<fund_codeLIS</fund_code
<amount>
<sum>61.30</sum>
<currency desc="US Dollar">USD</currency>
</amount>
</fund_distribution
</fund_distributions
<reporting_code>y</reporting_code
<secondary_reporting_codenfg</secondary_reporting_code
<tertiary_reporting_code>u</tertiary_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>UARCV</library>
shelving_locationGEN</shelving_location
</location>
</locations>
</po_line