Register external ID mapping
const url = 'https://api.wink.travel/api/property-embeddings/external/mappings';const options = { method: 'POST', headers: { 'Wink-Version': '2.0', Authorization: 'Bearer <token>', 'Content-Type': 'application/json' }, body: 'null'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.wink.travel/api/property-embeddings/external/mappings \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data nullLinks a partner’s own external identifier to a Wink property, bootstrapped from a well-known identifier (HOTEL_CODE, URL_NAME, or PLACE_ID). After registration, the partner can use their externalId in all query and contribution operations.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Header Parameters
Section titled “Header Parameters ”Request Body required
Section titled “Request Body required ”Register a mapping from a partner external ID to a property, bootstrapped from a well-known identifier
object
Well-known namespace for bootstrap resolution (must be HOTEL_CODE, URL_NAME, or PLACE_ID; not PARTNER)
Example
HOTEL_CODEWell-known identifier value in the bootstrap namespace
Example
TH00042Partner’s own identifier for this property (internal to partner’s system)
Example
BOOKING-987654Responses
Section titled “ Responses ”Mapping registered successfully; returns the PropertyExternalIdMapping document
object
Document UUID
Datetime this record was first created
Datetime this record was last updated
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.
Internal hotel identifier in the property_embeddings vector store
Partner namespace (always PARTNER for externally registered mappings)
The partner’s identifier for this property within their namespace
OAuth2 application (client) identifier of the partner that registered this mapping
Example
{ "id": "", "createdDate": "", "lastUpdate": "", "version": "", "hotelId": "", "namespace": "", "externalId": "", "ownerIdentifier": ""}Invalid request (bootstrapNamespace must not be PARTNER)
Missing or invalid JWT authentication
Forbidden
object
object
Property not found for the given bootstrapNamespace and bootstrapId
object
Document UUID
Datetime this record was first created
Datetime this record was last updated
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.
Internal hotel identifier in the property_embeddings vector store
Partner namespace (always PARTNER for externally registered mappings)
The partner’s identifier for this property within their namespace
OAuth2 application (client) identifier of the partner that registered this mapping
Example
{ "id": "", "createdDate": "", "lastUpdate": "", "version": "", "hotelId": "", "namespace": "", "externalId": "", "ownerIdentifier": ""}Mapping for this externalId already exists
object
Document UUID
Datetime this record was first created
Datetime this record was last updated
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.
Internal hotel identifier in the property_embeddings vector store
Partner namespace (always PARTNER for externally registered mappings)
The partner’s identifier for this property within their namespace
OAuth2 application (client) identifier of the partner that registered this mapping
Example
{ "id": "", "createdDate": "", "lastUpdate": "", "version": "", "hotelId": "", "namespace": "", "externalId": "", "ownerIdentifier": ""}Internal Server Error
object
Example generated
{}