Expose Shared License, Distribution, and Negotiation Details in the license REST API
The Alma license REST API (POST/PUT/GET /almaws/v1/acq/licenses) does not expose several pieces of license configuration that are available in the Alma UI. This prevents end-to-end license provisioning via API and forces manual UI work after every API call.
Fields currently absent from the API:
At the top of the License Details form — the "Shared License" on/off setting, and the "Distribution" multi-select controlling which sections are shared with member institutions (Summary, License Terms, Notes, Attachments).
In the Negotiation Details tab that appears for shared licenses — per-member rows containing Member Name, Price per year, Price increase (percentage), Currency, Start date, End date, Order Status, Notes, and Available Content, plus the ability to add and remove members.
Notably, the public Alma license XSD documents a "negotiation_members" element, but it does not appear in actual GET responses even for licenses that clearly have members configured via the UI.
Impact: Consortial customers using the Network Zone cannot programmatically provision, update, or audit shared licenses or their per-member pricing. Every API-created license requires manual UI steps to configure sharing, distribution, and member-level pricing. External systems cannot read this data at all.
Request: Expose the Shared License / Distribution settings and the Negotiation Details member list as both readable and writable via the license API. The member list would likely be best modeled as a sub-resource (similar to /acq/licenses/{code}/amendments or /acq/licenses/{code}/attachments), so members can be created, updated, and deleted individually.
Related idea: "Add API support for licenses with type Negotiation" (https://ideas.exlibrisgroup.com/forums/308173-alma/suggestions/48119375) — this may be partially or fully addressed by implementing the above.
Kristen Fredericksen
shared this idea