Skip to content
Wink

Get public map with markers

GET
/api/public/{managingEntityIdentifier}/map/{mapIdentifier}/markers
 
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 ”
managingEntityIdentifier
required
string
""

UUID of the managing entity that owns the map.

Example 
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69
mapIdentifier
required
string
""

UUID of the map to display.

Example 
f8a3d7e1-2b6c-4f9a-8c15-3e7d1a9c5b42

Header Parameters

Section titled “Header Parameters ”
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Complete map configuration with markers for public consumption

object
map
required

The map configuration and styling

object
identifier
required

Unique identifier of this map (assigned by server)

string format: uuid
"" >= 1 characters
ownerIdentifier
required

UUID of the managing entity that owns this map

string format: uuid
"" >= 1 characters
customizationIdentifier
required

UUID of the customization context (e.g., Wink Links, channel manager)

string format: uuid
"" >= 1 characters
name
required

Display name for this map

string
"" >= 1 characters
typeIdentifier
required

UUID of the inventory source: single channel inventory, curated list, or dynamic search

string format: uuid
"" >= 1 characters
type
required

Category of inventory being displayed (SINGLE, LIST, or SEARCH)

string
""
Allowed values: SINGLE LIST SEARCH
center
required

GeoJSON point defining map center (longitude, latitude)

object
x
number format: double
y
number format: double
type
string
coordinates
Array<number>
draggable
required

Allow users to pan the map by dragging

boolean
default: true
zoomable
required

Allow users to zoom in and out

boolean
default: true
initialZoomLevel
required

Initial zoom level (0-21, where 0 shows the entire world)

integer format: int32
"" <= 21
mapStyle
required

Map visual style (normal, clean, or bluish)

string
""
Allowed values: normal clean bluish
mapMarkerColor
required

Hexadecimal color code for map markers

string
""
Allowed values: cc2138
mapHeight
required

Height of the embedded map in pixels

integer format: int32
"" >= 1
displayType
required

Which data to display initially (NATIVE, MODIFIED, or AFFILIATE)

string
default: NATIVE
Allowed values: NATIVE HOTEL ROOM
circles
Array<object>

Optional circular overlay regions on the map

object
radius
required

Circle radius from center

number format: double
""
point
required

Circle center point

object
x
number format: double
y
number format: double
type
string
coordinates
Array<number>
rectangles
Array<object>

Optional rectangular overlay regions on the map

object
rectangle
required

A GeoJSON rectangle

object
southWest
required

A GeoJSON rectangle

object
x
number format: double
y
number format: double
type
string
coordinates
Array<number>
northEast
required

A GeoJSON rectangle

object
x
number format: double
y
number format: double
type
string
coordinates
Array<number>
markers
Array<object>

Optional custom markers to display on the map

object
point
required

A GeoJSON point

object
x
number format: double
y
number format: double
type
string
coordinates
Array<number>
polygons
Array<object>

Optional polygonal overlay regions on the map

object
polygon
required

A GeoJSON polygon

object
points
Array<object>
object
x
number format: double
y
number format: double
coordinates
Array<object>
object
type
string
coordinates
Array<object>
object
x
number format: double
y
number format: double
type
string
markers
required
Array<object>

Inventory items displayed as markers on the map

object
channelInventoryIdentifier
required

Unique identifier of the channel inventory or list item represented by this marker

string format: uuid
""
point
required

Geographic location coordinates as a GeoJSON Point (longitude, latitude)

object
x
number format: double
y
number format: double
type
string
coordinates
Array<number>
supplierIdentifier
required

UUID of the supplier (hotel or property) owning this inventory

string format: uuid
""
supplierName
required

Display name of the supplier property

string
""
inventoryIdentifier
required

UUID of the specific inventory item (e.g., room type or add-on)

string format: uuid
""
inventoryType
required

Classification of the inventory (e.g., GUEST_ROOM, ADD_ON, RESTAURANT, ACTIVITY)

string
""
Allowed values: GUEST_ROOM ADD_ON MEETING_ROOM RESTAURANT SPA ATTRACTION PLACE ACTIVITY
inventoryName
required

Human-friendly name of the inventory item

string
""
lowestDisplayPrice
required

Lowest available price for this inventory in the user’s requested currency

object
amount
required
number
currency
required
string
>= 1 characters
Example 
null

400

Section titled “400 ”

Bad Request

object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
Example generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  }
}

401

Section titled “401 ”

Unauthorized

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

403

Section titled “403 ”

Forbidden

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

500

Section titled “500 ”

Internal Server Error

object
Example generated
{}