Locations and proximity alerts
The customer walks past your store and their card pops up on the lock screen with a message: "10% off today, just round the corner". You send nothing. The phone triggers it, based on the locations stored in the pass.
How it works
- You declare locations: latitude, longitude, and a relevant text (the message shown).
- eldo wallet writes them into the passes.
- When the customer enters the area, Apple Wallet or Google Wallet suggests the pass on the lock screen with that text.
Endpoints
| Need | Endpoint |
|---|---|
| List the loyalty card locations | GET/wallet-locations |
| Add a location | POST/wallet-locations |
| Edit, delete | PATCH/wallet-locations/{id}, DELETE/wallet-locations/{id} |
| Locations for an event, transit or hotel | locations (or location) field on the template: POST/events, POST/transits, POST/hotels |
- curl
- SDK Node.js
- nodejs
- php
- python
- java
- csharp
- go
- ruby
- CURL
curl -L 'https://api-v2.test.eldowallet.fr/wallet-locations' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-lang: en' \
-H 'Authorization: Bearer <token>' \
-d '{
"latitude": 43.2965,
"longitude": 5.3698,
"relevantText": "Our Old Port store is just steps away."
}'
Messages by time of day
A location can carry several texts, each with its own time slot: relevantTextList, with relevantText, startTime and endTime.
Example: "Free coffee before 10 am" in the morning, "Happy hour until 7 pm" in the afternoon, same spot.
Limits
- A maximum number of locations per wallet. Beyond it, the API returns
MAX_WALLET_LOCATIONS_REACHED. Apple Wallet itself only uses 10 locations per pass. - It is not a push. The system decides whether to show the pass based on distance, phone usage and the customer’s settings. Do not rely on it for critical information.
- The customer stays in control. They can turn off pass suggestions on the lock screen.
More than 10 stores
Pick the 10 places that matter most: flagship stores, stations, shopping centres. The rest will not show on iPhone.