API Docs
Rest Purchase Request
Contents
Overview
Purchase requests enable patrons to request that a library purchase an item.
The requester can request an item for any reason, for example: the library does not have a copy (there is no bibliographic record, or there is a bibliographic record but no inventory), or the library does not have enough copies or in the right format or edition, or the existing copy is damaged.
After creating a purchase request, the request will be reviewed by a staff user which will decide whether to purchase the item or reject the request.
To create purchase request for a user: POST /almaws/v1/users/id/purchase-requests/
To manage existing purchase requests: /almaws/v1/acq/purchase-requests
Data Dictionary
Click here to download rest_purchase_request.xsd
purchase_request
Description: Purchase request Object.
| Field | Type | Description | ||
|---|---|---|---|---|
request_ | string | Internal identifier of the request in Alma, generated by Alma. Should be used in subsequent queries regarding the request. Output parameter. | ||
created_ | date | The request creation date. Output parameter. | ||
last_ | date | Date by which the last change to the request was made. Output parameter. | ||
format | string with attr. | The type of PO line that will be created upon purchase request approval. Parallel to the "Material Type" field in Alma UI. Possible values are listed in 'PR_RequestedFormat' code table. Default is the default value defined in PR_RequestedFormat code table.
| ||
requested_ | string with attr. | When "format" field is P, possible codes are in the "PhysicalMaterialType" code table. When "format" field is E, possible codes are in the "electronicMaterialType" code table. | ||
requester | string with attr. | The primary identifier and full name of the requesting user. On POST, the user will be taken from the path and not from this field. | ||
notify_ | boolean | When true, Alma sends an email to the user when the item arrives at the library's receiving department. Optional. Default is False. | ||
hold_ | boolean | When true, Alma creates a hold request on the item for the user. Optional. Relevant only for physical items. Default is False. | ||
notify_ | boolean | When true, Alma sends a notification letter to the user when the order is sent to manual renewal. Optional. Relevant only for continuous orders. Default is False. | ||
notify_ | boolean | When true, Alma sends a notification letter to the user when the order is canceled. Optional. Default is False. | ||
created_ | string with attr. | The place in which the request was initiated. Output parameter. Possible values are listed in 'PPRSourceType' code table. For purchase requests created via API, this field will be populated with "API".
| ||
status | string with attr. | The status of the request. Output parameter.
| ||
owning_ | string with attr. | The library that should receive the item. See Get libraries API. | ||
estimated_ | amount | An estimated cost for the item, including the currency. | ||
fund | string with attr. | The fund code. See Get funds API. | ||
vendor | string with attr. | The vendor code from which to purchase the item. If vendor is supplied, vendor account should be suplied as well. | ||
vendor_ | string | The vendor account code. Must be a valid account of the vendor. | ||
email | string | The user Email | ||
approved_ | string | The primary identifier of the operator which made the approval. When op=approve, the value from this field will be used to indicate the staff user that performed the approval. | ||
requester_ | string | Any note to send to the user who will be approving or rejecting the request. | ||
reject_ | string with attr. | The reason the request was rejected, if any. When op=reject, the value from this field will be used to indicate the reject reason.
| ||
po_ | string with attr. | The request's related po line. Output parameter. | ||
resource_ | resource_metadata | In order to create a purchase request, the bibliographic information should be supplied. 2 ways are supported: 1. Supply mms_id - in this case the purchase request will be attached to this mms_id. No need to supply additional bibliographic information in this case (if supplied it will be ignored). 2. Supply bibliographic information - in this case title and citation_type are mandatory. Alma will try to match this information with an existing BIB record. The match routine is according to the definition of purchase_request_import_profile customer parameter. If no profile is specified in the parameter, the matching is based on the ISBN/ISSN in the purchase request. If a matching record is found in the repository, the purchase request is linked to this bibliographic record. If no match is found, a new bibliographic record is created. | ||
notes | notes | List of related notes. Optional. In the PUT action the incoming list will replace the existing list. If the incoming list is empty, the existing list will be deleted. | ||
locations | locations | Information about the locations in which the ordered items will be stored. Relevant only for Physical. See Get locations API. In the PUT action the incoming list will replace the existing list. If the incoming list is empty, the existing list will be deleted. |
amount
Description:
| Field | Type | Description | ||
|---|---|---|---|---|
sum | string | The sum. This can be a positive or negative number up to 14 digits with an optional decimal point. | ||
currency | string with attr. | The currency. Possible values are listed in 'Currency_CT' code table.
|
resource_metadata
Description:
In order to create a purchase request, the bibliographic information should be supplied.
2 ways are supported:
1. Supply mms_id - in this case the purchase request will be attached to this mms_id.
No need to supply additional bibliographic information in this case (if supplied it will be ignored).
2. Supply bibliographic information - in this case title and citation_type are mandatory.
Alma will try to match this information with an existing BIB record.
The match routine is according to the definition of purchase_request_import_profile customer parameter.
If no profile is specified in the parameter, the matching is based on the ISBN/ISSN in the purchase request.
If a matching record is found in the repository, the purchase request is linked to this bibliographic record.
If no match is found, a new bibliographic record is created.
| Field | Type | Description | ||
|---|---|---|---|---|
mms_ | string with attr. | mms_id. If supplied in the POST action, The purchase order will be created for this bibliographic record. | ||
citation_ | string with attr. | Type of the requested resource. For example, book or article. Mandatory when creating a request unless mms_id is supplied. Possible codes are listed in PR_CitationType code table: BOOK / JOURNAL.
| ||
title | string | The title. Mandatory in the POST action if mms_id was not supplied. | ||
author | string | Author of the requested resource. | ||
edition | string | The edition of the requested resource. | ||
isbn | string | isbn | ||
issn | string | issn | ||
lcc_ | string | The library of congress number of the book. | ||
other_ | string | A central identifier number, such as Online Computer Library Center (OCLC) number | ||
publisher | string | The Publisher of the item. | ||
publication_ | string | The publication place of the item. | ||
publication_ | string | The publication year of the item. | ||
bib_ | string | The note of the bibliographic record. | ||
volume | string | The volume number. |
locations
Description:
Information about the locations in which the ordered items will be stored.
Relevant only for physical.
See Get locations API.
In the PUT action the incoming list will replace the existing list.
If the incoming list is empty, the existing list will be deleted.
| Field | Type | Description |
|---|---|---|
location | location | Specific location Distributions. |
location
Description: Specific location Distributions.
| Field | Type | Description | ||
|---|---|---|---|---|
quantity | int | The quantity per location. | ||
library | string with attr. | The library which the location belongs to.
| ||
shelving_ | string | The location. |
Samples
XML
JSON
__