Show map
const url = 'https://api.wink.travel/api/public/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/map/f8a3d7e1-2b6c-4f9a-8c15-3e7d1a9c5b42/markers';const options = { method: 'GET', headers: {'Wink-Version': '2.0', Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.wink.travel/api/public/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/map/f8a3d7e1-2b6c-4f9a-8c15-3e7d1a9c5b42/markers \ --header 'Authorization: Bearer <token>' \ --header 'Wink-Version: 2.0'Load the publicly-accessible map configuration and all its markers for consumer display.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”UUID of the managing entity that owns the map.
Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69UUID of the map to display.
Example
f8a3d7e1-2b6c-4f9a-8c15-3e7d1a9c5b42Header Parameters
Section titled “Header Parameters ”Responses
Section titled “ Responses ”Map configuration with all inventory markers for consumer display
Complete map configuration with markers for public consumption
object
The map configuration and styling
object
Unique identifier of this map (assigned by server)
UUID of the managing entity that owns this map
UUID of the customization context (e.g., Wink Links, channel manager)
Display name for this map
UUID of the inventory source: single channel inventory, curated list, or dynamic search
Category of inventory being displayed (SINGLE, LIST, or SEARCH)
GeoJSON point defining map center (longitude, latitude)
object
Allow users to pan the map by dragging
Allow users to zoom in and out
Initial zoom level (0-21, where 0 shows the entire world)
Map visual style (normal, clean, or bluish)
Hexadecimal color code for map markers
Height of the embedded map in pixels
Which data to display initially (NATIVE, MODIFIED, or AFFILIATE)
Optional circular overlay regions on the map
object
Circle radius from center
Circle center point
object
Optional rectangular overlay regions on the map
object
A GeoJSON rectangle
object
South-west corner of the geographic bounding rectangle
object
North-east corner of the geographic bounding rectangle
object
Optional custom markers to display on the map
object
A GeoJSON point
object
Optional polygonal overlay regions on the map
object
A GeoJSON polygon
object
object
object
object
Inventory items displayed as markers on the map
Represents a single inventory item displayed as a marker on a map
object
Unique identifier of the channel inventory or list item represented by this marker
Geographic location coordinates as a GeoJSON Point (longitude, latitude)
object
UUID of the supplier (hotel or property) owning this inventory
Display name of the supplier property
UUID of the specific inventory item (e.g., room type or add-on)
Classification of the inventory (e.g., GUEST_ROOM, ADD_ON, RESTAURANT, ACTIVITY)
Human-friendly name of the inventory item
Lowest available price for this inventory in the user’s requested currency
object
Monetary amount value
ISO 4217 currency code
Example
{ "map": { "identifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "ownerIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "customizationIdentifier": "a2c8f1d4-5e9b-4a7c-9f23-6b1e8d4c2f05", "name": "Premium Hotels in Southeast Asia", "typeIdentifier": "7a0c5d9e-2f6b-4c1a-8e4d-3b9f1a0c6d52", "type": "LIST", "center": { "type": "Point", "coordinates": [ 100.5581533, 13.7370197 ] }, "draggable": true, "zoomable": true, "initialZoomLevel": 15, "mapStyle": "normal", "mapMarkerColor": "cc2138", "mapHeight": 500, "displayType": "NATIVE", "circles": [], "rectangles": [], "markers": [], "polygons": [] }, "markers": [ { "channelInventoryIdentifier": "9b7e4c3a-1f6d-4e8a-b2f9-5d3c0a8e7b61", "point": { "type": "Point", "coordinates": [ 100.5581533, 13.7370197 ] }, "supplierIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "supplierName": "The Siam Residences", "inventoryIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "inventoryType": "GUEST_ROOM", "inventoryName": "Deluxe Ocean View Suite", "lowestDisplayPrice": { "amount": 4500, "currency": "THB" } } ]}Bad Request — missing or invalid request parameter or body
object
object
Example
Unauthorized — authentication is required or the session has expired
object
object
Example
Forbidden — authenticated but lacking the required permission or scope
object
object
Example
Not Found — the requested resource does not exist
object
object
Example
Method Not Allowed — the HTTP verb is not supported on this endpoint
object
object
Example
Unsupported Media Type — use application/json
object
object
Example
Internal Server Error — an unexpected failure occurred on the server
object
object
Example
Service Unavailable — a downstream dependency is unreachable