Page Comparison

References

...

• user_primary_id: The ID of the requesting user.

• request_type: HOLD

• pickup_location_type: LIBRARY

• pickup_location_library: The pickup location library code. (Note: Alma does not provide a direct API endpoint to create pickup locations dynamically. Pickup locations are defined and configured in the Alma interface by library administrators.)

• material_type (optional): Used in fulfillment policies.

• request_status: Not Started (Enum: [In Process, On Hold Shelf, Not Started, History])

Hold request example

http
POST https://api-na.hosted.exlibrisgroup.com/almaws/v1/bibs/123456789/holdings/987654321/items/567890123/requests?apikey={your_api_key}
{
  "user_primary_id": "patron123",
  "request_type": "HOLD",
  "pickup_location_type": "LIBRARY",
  "pickup_location_library": "Main Library",
  "comment": "Requesting for research purposes."
}

...

• The actual record: XML string describing the record

  • suppress_from_publishing: tbd

For more details on creating a holding record, refer to Create holding record

...