Ready to Learn?Ex Libris products all provide open APIs


Scan-in operation on item.


This web service allows to perform a Scan-in operation on an item.

Resource URL
POST /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}
Try it now!

The full WADL documentation is available here.

URL Parameters

ParameterTypeDescription
mms_idxs:stringThe Bib Record ID.
holding_idxs:stringThe Holding Record ID.
item_pidxs:stringThe Item ID.

Query string Parameters

ParameterTypeRequiredDescription
opxs:string Required The operation that is to be performed. Currently, only option is: scan.
external_idxs:string Optional. Default: false External ID. Options: true or false.
request_idxs:string Required The request ID. Needed when item is not yet bound to a single request and there are multiple requests which scanned item can fulfill.
libraryxs:string Required The library code of the given circulation desk or department where the action is being performed.
circ_deskxs:string Required The circulation desk where the action is being performed.
departmentxs:string Required The department where the action is being performed.
work_order_typexs:string Required The work order type which is to be performed, or is being performed on the scanned in item.
statusxs:string Required The work order status to which we want to move the item. Optional input is defined by the work order type.
donexs:string Optional. Default: false Work order processing is completed on the item. Options: true or false.
auto_print_slipxs:string Optional. Default: false Automatically print a slip. Options: true or false.
place_on_hold_shelfxs:string Optional. Default: false Place on hold shelf. Options: true or false.
confirmxs:string Optional. Default: false Confirm the action on the item. Options: true or false.
register_in_house_usexs:string Optional. Default: true Register in house uses. Options: true or false.

Body Parameters None

Output This method returns a Item object.
For detailed documentation see here.

Possible Error Codes
CodeMessage
401652General Error - An error has occurred while processing the request.