Skip to content
Wink

Register External ID Mapping

POST
/api/property-embeddings/external/mappings
 
curl --request POST \
  --url https://api.wink.travel/api/property-embeddings/external/mappings \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data null

Register a mapping from a partner external ID to a property. Requires a well-known identifier (hotelCode, urlName, or placeId) for bootstrap.

Parameters

Section titled “ Parameters ”

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

Register a mapping from a partner external ID to a property

object
bootstrapNamespace
required

Well-known namespace for bootstrap resolution (HOTEL_CODE, URL_NAME, or PLACE_ID)

string
""
Allowed values: HOTEL_CODE URL_NAME PLACE_ID PARTNER
bootstrapId
required

Well-known identifier value

string
"" >= 1 characters
Example 
IN00011
externalId
required

Partner’s own identifier for this property

string
"" >= 1 characters
Example 
BKG-12345

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Created

Media type application/json
object
id

Document UUID

string
""
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
""
hotelId

Internal hotel identifier in the property_embeddings vector store

string
""
namespace

Partner namespace (e.g. ‘booking.com’, ‘expedia’, ‘tripadvisor’)

string
""
externalId

The partner’s identifier for this property within their namespace

string
""
ownerIdentifier

OAuth2 application identifier of the partner that registered this mapping

string
""
Example 
{
  "id": "",
  "createdDate": "",
  "lastUpdate": "",
  "version": "",
  "hotelId": "",
  "namespace": "",
  "externalId": "",
  "ownerIdentifier": ""
}

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