Skip to content
Wink

Create a map for a supplier

POST
/api/managing-entity/{managingEntityIdentifier}/studio/map/supplier
 
curl --request POST \
  --url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/studio/map/supplier \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data null

Create a new map centered on a supplier property with a single marker, priced to its best-available rate for the requested inventory type.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
managingEntityIdentifier
required
string
""

UUID of the managing entity that will own the map.

Example 
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69

Header Parameters

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

Request Body required

Section titled “Request Body required ”
Media type application/json

Request to create a map for a single supplier property

object
customizationIdentifier
required

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

string format: uuid
"" >= 1 characters
Example 
a2c8f1d4-5e9b-4a7c-9f23-6b1e8d4c2f05
name
required

Display name for this map

string
"" >= 1 characters
Example 
Premium Hotels in Southeast Asia
supplierIdentifier
required

UUID of the supplier property to display on the map

string format: uuid
"" >= 1 characters
Example 
7c5a2e9f-3d8b-4f1c-a6e2-8b4f0c9d3e71
type
required

Type of inventory to display from the supplier (GUEST_ROOM, ACTIVITY, SPA, etc.)

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

Allow users to pan the map by dragging

boolean
default: true
Example 
true
zoomable
required

Allow users to zoom in and out

boolean
default: true
Example 
true
initialZoomLevel
required

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

integer format: int32
"" <= 21
Example 
15
mapStyle
required

Map visual style (normal, clean, or bluish)

string
""
Allowed values: normal clean bluish
Example 
normal
mapMarkerColor
required

Hexadecimal color code for map markers

string
""
Allowed values: cc2138
Example 
cc2138
mapHeight
required

Height of the embedded map in pixels

integer format: int32
"" >= 1
Example 
500
displayType
required

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

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

Optional circular overlay regions on the map

object
radius
required

Circle radius from center

number format: double
""
Example 
2.5
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

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Created

Media type application/json
object
id

Document UUID

string format: uuid
""
createdDate

Datetime this record was first created

string format: date-time
""
lastUpdate

Datetime this record was last updated

string format: date-time
""
version

Version property that shows how many times this document has been persisted. Document will not persist if the version property is less than current version property in the system. Result in an optimistic locking exception.

integer format: int64
""
ownerIdentifier
required

Map owner identifier

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

Customization identifier

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

Name of map

string
"" >= 1 characters
typeIdentifier
required

Inventory type identifier. Either a single channel inventory identifier, a list identifier or a dynamic search identifier.

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

Type of inventory

string
""
Allowed values: SINGLE LIST SEARCH
center
required

Map center point

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

User can move around / pan the map

boolean
default: true
zoomable
required

User can zoom in/out of the map

boolean
default: true
initialZoomLevel
required

Valid Google maps zoom level

integer format: int32
"" <= 21
mapStyle
required

Map style

string
""
Allowed values: normal clean bluish
mapMarkerColor
required

Map marker color

string
""
Allowed values: cc2138
mapHeight
required

Map height in pixels

integer format: int32
"" >= 1
displayType
required

Indicate which initial values to display first on the front-facing card

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

A way to persist a GeoJSON circle

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>

Custom-defined rectangles

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>

Custom-defined markers

object
point
required

A GeoJSON point

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

Custom-defined polygons

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
Example 
{
  "id": "",
  "createdDate": "",
  "lastUpdate": "",
  "version": "",
  "ownerIdentifier": "",
  "customizationIdentifier": "",
  "name": "",
  "typeIdentifier": "",
  "type": "SINGLE",
  "center": "",
  "draggable": true,
  "zoomable": true,
  "initialZoomLevel": "",
  "mapStyle": "normal",
  "mapMarkerColor": "cc2138",
  "mapHeight": "",
  "displayType": "NATIVE",
  "circles": [
    null
  ],
  "rectangles": [
    ""
  ],
  "markers": [
    ""
  ],
  "polygons": [
    ""
  ]
}

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
{}