Problem:

We need to update the edge/mod-patron API schemas to enable creation of delivery fulfillment holds (Requests), rather than the current "pick-up only" support. To do so, we must provide both support for the fields in hold creation payloads (instance and item) required to create a delivery request (fulfillment preference and delivery address), but also indicate to the edge client (eg. a discovery interface) whether the user indicated is permitted to place delivery requests based on their User Request Fulfillment preferences, what their default pickup location or delivery addresses are, and what other delivery addresses are available on their account. This story will address the former.

Requirements

• Extend the schema to include fulfillment preference for

  • /patron/account/{id}/instance/{instanceId}/hold and  

  • /patron/account/{id}/item/{itemId}/hold

    • fulfilmentPreference [sic] (see requests API documentation, currently enum of "Hold Shelf" and "Delivery", default "Hold Shelf" if not specified)

    • deliveryAddressTypeId (required if preference is "Delivery", UUID of Address Type, see requests API documentation)

Acceptance Criteria

• Edge client can include the user's expressed fulfillment preferences for both method ("Hold Shelf" or "Delivery") in the JSON body posted to the indicated endpoints to create a new request

• Edge client can include the user's indicated deliveryAddressType in the JSON object posted to the endpoints indicated to create a new request

• If the request creation fails because the user placing the request does not have delivery as an available fulfilmentPreference, this should be indicated in the error response to the client

====Original story draft below, for historical reference====

As a patron who is creating a request through EDS or an OPAC (e.g. Blacklight, VuFind)
I want to be able to select a fulfillment preference for my request (this can be hold shelf or, if allowed for my user, delivery) as well as an address for delivery
So that it is clear to FOLIO and circ staff that I need the request to be delivered and where it should be delivered to

Scenarios:

1. Scenario:

   • Given user has delivery enabled for their user record

   • When they create a request via discovery or OPAC

   • Then edgepatron should enable them to select a fulfillment preference (hold shelf or delivery) for their request

2. Scenario:

   • Given user does NOT have delivery enabled for their user record

   • When they create a request via discovery or OPAC

   • Then edgepatron should assume that fulfillment preference for the request is hold shelf

3. Scenario:

   • Given user has delivery enabled for their user record

   • When they create a request via discovery or OPAC

   • Then edgepatron should pass the fulfillment preference (hold shelf or delivery) for the user so it can be auto-selected when they create a request (this is just a convenience for the patron - they should be able to manually change their fulfillment preference, if they wish)

4. Scenario:

   • Given user is creating a request in discovery or OPAC

   • When fulfillment preference = delivery

   • Then edgepatron should pass:

     • The default delivery address for the user so it can be auto-selected when they create a request (this is just a convenience for the patron - they should be able to manually change their fulfillment preference, if they wish)

     • To enable users to change their delivery address, edgepatron should also pass all other address types from the user record

5. Scenario:

   • Given user is creating a request in discovery or OPAC

   • When fulfillment preference = holdshelf

   • Then edgepatron should pass the default pickup service point from the user record so it can be auto-selected when they create the request (this is just a convenience for the patron - they should be able to manually change their pickup service point, if they wish)

Mock-ups: There is no UI in scope for this user story, but understanding what UI is planned may help clarify the requirements. See attached deck.

Screencast: This screencast shows how user preferences interface with request creation in FOLIO: https://drive.google.com/file/d/1Z0x0XrIXRPFAqBKk-5jCT4ItabFlktja/view?usp=sharing