The lifecycle of a reservation is represented by the diagram below using the BPMN notation.
This diagram refers to events that are emitted as part of the event stream. See the entity model and the webhook.
Reservation creation
When a reservation is created via Associate App, and the reservation.created event is emitted. When an associate adds the item(s) in the reservation to the cart and follows through with the checkout process, or unreserves the item(s) in the reservation, a reservation.updated event is emitted.
To see what these events contain, see the reservation.created and reservation.updated event request payload examples in the Event stream webhook.
Click here to download the BPMN image
Confirmation of pending reservations
When a reservation is created via the Create reservation API (such as when a customer reserves an item online to pick it up in the store during in-store checkout), a reservation is created in Pending status in NewStore and is available in Associate App. A push notification is sent to associates via the app, and the reservation.created event is created.
The associate can accept or reject the reservation, and a reservation.updated event is emitted in both situations.
When the associate accepts the reservation and follows through with the checkout process, an email is sent to the customer notifying them of the reservation being accepted. When the reservation is rejected, the item(s) in the reservation is unreserved and an email is sent to the customer notifying them of the rejection of the reservation.
Note
Email notifications about acceptance or rejection of reservations are only sent to customers if notifications are enabled for your business. For more information, see the Reservation configuration API or the configuration guide.
Click here to download the BPMN image
To see what the reservation.created and reservation.updated events contain, see the request payload examples in the Event stream webhook.
Related topics