API Docs

__METHOD= POST . __PATH= /almaws/v1/acq/po-lines/{po_line_id}/items/{item_id} .

Receive an Existing Item

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.

Resource URL

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

API Description

URL Parameters

ParameterTypeDescription
po_line_idxs:stringThe PO-Line number.
item_idxs:stringThe item ID.

Querystring Parameters

ParameterTypeRequiredDescription
opxs:stringRequiredThe operation to perform on the item. Currently, the only option is 'receive'
receive_datexs:stringOptional.The receive date. Default value is current time. Expected Format: YYYY-MM-DDZ
departmentxs:stringOptional.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_libraryxs:stringOptional.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

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