Skip to content
Wink

Create

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

Submits a new relationship request from the company to a supplier and returns the persisted request once created.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
managingEntityIdentifier
required
string
""

Create property request and associate it with this company identifier

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 ”

Relationship request payload specifying the target supplier and any proposed commission or pricing terms for the new channel partnership

Media type application/json

A request for relationship between two parties.

object
requestType
required

Type of relationship request

string
""
Allowed values: DIRECT_CONNECTION
Example 
DIRECT_CONNECTION
supplierIdentifier
required

Supplier identifier the relationship request targets

string format: uuid
"" >= 1 characters
Example 
e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18
introductoryMessage
required

Introductory message from the requester explaining the purpose of the connection request.

string
"" >= 1 characters
Example 
We are interested in partnering with your property to offer discounted rates to our clientele.
Example 
{
  "requestType": "DIRECT_CONNECTION",
  "supplierIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18",
  "introductoryMessage": "We are interested in partnering with your property to offer discounted rates to our clientele."
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Sales channel relationship request successfully created

Media type application/json

Represents a relationship request from an affiliate/owner to a supplier

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
""
status
required

Status of the relationship request

string
""
Allowed values: REQUESTING REJECTED
requestType
required

Type of relationship request

string
""
Allowed values: DIRECT_CONNECTION
supplierIdentifier
required

Supplier identifier receiving this relationship request

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

Name of the property/supplier receiving the request

string
"" >= 1 characters
subType
required

Type of entity initiating the relationship request

string
""
Allowed values: TRIP_PAY FACILITATOR DIRECT APPLICATION HOTEL TRAVELIKO CORPORATE TRAVEL_AGENT INFLUENCER BLOGGER DESTINATION CHANNEL_MANAGER PROPERTY_MANAGEMENT_SYSTEM CENTRAL_RESERVATION_SYSTEM GOOGLE_HOTEL_API MANAGEMENT_COMPANY CHAIN BRAND EVENT_ORGANIZER OTHER
ownerIdentifier
required

Unique identifier of the owner/affiliate initiating the request

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

Name of the owner/affiliate initiating the request

string
"" >= 1 characters
introductoryMessage
required

Message from requester explaining the purpose and benefits of the proposed relationship

string
"" >= 1 characters
key
additional properties
""
Example

400

Section titled “400 ”

Bad Request — missing or invalid request parameter or body

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

401

Section titled “401 ”

Unauthorized — authentication is required or the session has expired

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

403

Section titled “403 ”

Forbidden — authenticated but lacking the required permission or scope

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

404

Section titled “404 ”

Not Found — the requested resource does not exist

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

405

Section titled “405 ”

Method Not Allowed — the HTTP verb is not supported on this endpoint

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

415

Section titled “415 ”

Unsupported Media Type — use application/json

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

500

Section titled “500 ”

Internal Server Error — an unexpected failure occurred on the server

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

503

Section titled “503 ”

Service Unavailable — a downstream dependency is unreachable

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example