Vending Machine Integration
Access to a testing environment is available on request.
Relevo's open platform approach allows us to work in almost all environments. Especially in large enterprise locations, return points are not always supervised and therefore not all items will be returned correctly. Lots of Relevo partners do already use Return Vending Machines to take reusable items back automatically and we work with a large variety of vending machine providers to ensure a smooth experience for partners and Relevo Users.
Goals
When deploying Return Vending Machines, we usually want to achieve three things:
Secured return of Relevos
No employee hours dedicated towards return of items
Always accessible and ready
To achieve this, Relevo developed a standardized way for Return Vending Machines of interacting with reusable items through RFiD or QR codes. When looking at security of returns, we want to first make sure that the presented item is an actual Relevo item. Only then should the Return Vending Machine accept the item back.
Requirements
For Return Vending Machines, our list of requirements is pretty short and simple. We allow for some variation in the process, which is also reflected in the process below.
Relevo integration data
Partner Key
Partner ID
Location ID(s)
External QR code scanner on the machine
Alternatively RFiD scanner in the machine
Hatch or holding mechanism that prevents any item from entering the inner part
Internet connectivity for simple HTTP API calls
Bin or box that is able to handle food waste or liquids
Process
Tutorial
Depending on the capabilities of your Return Vending Machine (RVM), not all steps in this tutorial may be necessary. For example:
Some machines may not support verifying whether the item presented outside matches what is placed inside.
Relevo discourages validating the Relevo User ID to ensure returns are as effortless as possible for everyone.
Follow only the relevant steps for your setup to create a smooth and enjoyable experience for your guests.
Verify the Relevo User ID (Optional)
If you choose to restrict machine interaction to Relevo users, you can verify their Relevo User ID. Users can either enter their Relevo User ID manually or scan their QR code (prefixed with rlv://).
API Request
200: Ok, user does exist and is allowed to interact with partners.
403: Forbidden, user does exist but is not allowed to interact with partners.
404: Not Found, user does not exist.
API Response
If you receive back a 200 HTTP Status code, then you can proceed with the flow.
Verify the Status of the Item (Optional)
To ensure the item belongs to the Relevo system and is eligible for return, validate it using its QR code and your RVM's location ID.
API Request
200: Request okay, see the response to verify if the item is valid and can be returned to the point of sale.
Check the JSON response and only proceed when boolean is true
API Response
Proceed only if you receive a 200 OK response and "isValid": true. Otherwise, errors may occur during the return process.
Return the Item
Complete the return by sending the item's unique ID (uId) or its full QR code. If successful, the item will be automatically returned and assigned to your specified location.
API Request
200: Request okay, see response to verify that sent items have been assigned.
Check the JSON response and only proceed when your item got assigned
API Response
Proceed only if your item appears in the
assignedItemsarray.If errors occur, review the
notAssignedItemsarray and communicate issues to users in their preferred language using theX-localizationheader in the request.
By following these steps, you can seamlessly integrate Relevo's reusable system with your RVM while ensuring a hassle-free experience for your guests. Let us know if further assistance is needed!
Last updated
Was this helpful?