This is a guideline on which endpoints you need to integrate a webshop with the viresmo API.

This guide will also point out some possible hurdles when implementing and breaking changes that might happen in the future.

Getting the Shops

An organisation within the viresmo platform can have multiple shops, this is to support larger businesses with multiple shops/locations.

To ensure you link the correct webshop or shop location of the webshop to the correct shop inside the viresmo platform you should use the GET endpoint to list the shops: https://api.viresmo.com/documentation/static/index.html#/shops/get_v1_shops

The resulting data can also be used to show the address of the shop on order completion, ...

Creating a reservation

Once a customer has completed an order in the webshop a reservation should be created, a reservation is used in the platform to reserve a box and keep track of any actions for a certain order. This reservation should contain the content of the order in the extraInformation field as well as any data on the customer and when the customer would like to pick up the order. The webshop is responsible for ensuring the customers can pick time slot without all customers picking the same one.

Based on this data the employee of the shop can prepare the order, reserve a box and dispatch a notification through email and text message to the customer.

Creating a reservation: https://api.viresmo.com/documentation/static/index.html#/reservations/post_v1_reservations

Minimal recommended data to create a reservation:

• email
• firstname, lastname
• language
• externalOrderId (this is not required but very useful to cross-reference between webshop and viresmo for the employees)
• pickupDateTime (when the customer comes to pick up the order)