API Docs

Ex Libris Developer Network Alma Documentation REST APIs API Docs

Receive an Existing Item

Resource URL
API Description
URL Parameters
Query string Parameters
Body Parameters
Output
Possible Error Codes

This web service updates an item to be considered received. If no payload is sent, the item information will not be changed besides the receive action. If an item object is sent in the payload, the item information will be updated accordingly.

TRY IT NOW

Resource URL

POST /almaws/v1/acq/po-lines/{po_line_id}/items/{item_id}

API Description

WADL documentation: Download
Swagger (OpenAPI) documentation: Download

URL Parameters

Parameter	Type	Description
`po_line_id`	xs:string	The PO-Line number.
`item_id`	xs:string	The item ID.

Querystring Parameters

Parameter	Type	Required	Description
`op`	xs:string	Required	The operation to perform on the item. Currently, the only option is 'receive'
`receive_date`	xs:string	Optional.	The receive date. Default value is current time. Expected Format: YYYY-MM-DDZ
`department`	xs:string	Optional.	The code of the department where the item is being received. If not supplied, a random department will be chosen from the owning library's acquisition departments.
`department_library`	xs:string	Optional.	The library code of the department where the item is being received.

Body Parameters

The item info for updating the item. If no update is required, an empty item object must be sent (e.g. <item />). See doc

Output

This method returns a Item object. See doc

Possible Error Codes

Code	Message
40166411	Param value is invalid.
401875	Failed to find the department.
401871	Failed to find the PO Line.
401877	Failed to receive PO Line (with error message).