Skip to content

Show one

GET
/api/managing-entity/{managingEntityIdentifier}/extranet/sales/affiliate/{affiliateManagingEntityIdentifier}
curl --request GET \
--url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/extranet/sales/affiliate/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69 \
--header 'Authorization: Bearer <token>' \
--header 'Wink-Version: 2.0'

Retrieve a single affiliate’s company details and booking sales metrics by identifier.

managingEntityIdentifier
required
string
""

Managing entity identifier (UUID)

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

Affiliate managing entity identifier (UUID)

Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Company details and booking sales metrics for the requested affiliate

Media type application/json

Booking sales metrics for a managing entity, broken down by property and country.

object
managingEntity

The managing entity associated with these metrics.

object
identifier
required

Unique identifier of the managing entity.

string
""
city
required

Key-value pair representing the city (GeoNames ID and ASCII name) where the entity is located.

object
value
required

The value that should be persisted.

string
"" >= 1 characters
label
required

English readable text of the value.

string
"" >= 1 characters
country
required

Key-value pair representing the country of the entity.

object
value
required

The value that should be persisted.

string
"" >= 1 characters
label
required

English readable text of the value.

string
"" >= 1 characters
continent
required

Key-value pair representing the continent of the entity.

object
value
required

The value that should be persisted.

string
"" >= 1 characters
label
required

English readable text of the value.

string
"" >= 1 characters
name
required

Display name of the managing entity.

string
"" >= 1 characters
ownerName
required

Full name of the managing entity owner.

string
"" >= 1 characters
urlName
required

URL-friendly slug identifying the entity in public profiles and links.

string
"" >= 1 characters /^[a-z0-9][a-z0-9-]*[a-z0-9]$/
uniqueId
required

Human-friendly short unique identifier used in some public contexts.

string
"" >= 1 characters
description

Short description reflecting the entity’s brand and positioning.

string
""
type
required

Entity type: HOTEL, APPLICATION, TRAVEL_AGENT, INFLUENCER, etc.

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

Current lifecycle status of the managing entity.

string
""
Allowed values: PENDING_APPROVAL ACTIVE INACTIVE UNDER_REVIEW SUSPENDED REJECTED REMOVED
createdDate
required

Timestamp when the managing entity was created.

string format: date-time
""
lastUpdate
required

Timestamp of the most recent update to the managing entity.

string format: date-time
""
travelAgent

Travel agent-specific details; null for non-travel-agent entity types.

object
selfAcquires
required

Whether the agent is in charge of charging the property.

boolean
selfDisburses
required

Whether the agent is in charge of paying the property.

boolean
ownerImageId

Cloudinary image identifier for the owner’s profile picture or company logo.

string
""
onlinePresence
Array<object>

Online presence of entity.

object
type
required

List of all active accounts that could be used for selling or seeing a company’s reach.

string
""
Allowed values: WINK WEB_SITE PERSONAL_WEB_SITE CORPORATE_WEB_SITE FACEBOOK INSTAGRAM TWITTER_X LINKEDIN TIKTOK SNAPCHAT MASTODON THREADS HIVE_SOCIAL MEWE ELLO WHATSAPP TELEGRAM SIGNAL WECHAT LINE KAKAOTALK VIBER DISCORD SKYPE FACEBOOK_MESSENGER YOUTUBE TWITCH BILIBILI VIMEO DAILYMOTION KICK UPLIVE PINTEREST BEREAL VSCO IMGUR FLICKR FIVE_HUNDRED_PX REDDIT QUORA TUMBLR PLURK MEDIUM BLUESKY MINDS STEEMIT DIASPORA WHISPER YIK_YAK TELLONYM GOOGLE GITHUB SPOTIFY UPWORK SHOPIFY AMAZON PERSONAL_EMAIL WORK_EMAIL ONLY_FANS FANSLY
identifier
required

The url, account name or phone number that identifies this user with the specified network.

string
"" >= 1 characters
audiences
Array<string>
Allowed values: EVERYONE ADVENTURE BEACH BUSINESS CULTURAL_EXPERIENCE EDUCATION FAMILY FOOD_AND_CULINARY HIKING HISTORICAL_SITES HONEYMOON LUXURY MEDICAL_TOURISM MUSIC_AND_FESTIVALS NATURE_AND_WILDLIFE PHOTOGRAPHY PILGRIMAGE RELAXATION ROAD_TRIP ROMANCE SHOPPING SKIING SOLO_TRAVEL SPORTS_EVENTS VOLUNTEERING WELLNESS_AND_SPA CITY WILDLIFE
audienceSize

The size of your audience.

integer format: int64
""
sort

How you would like to order your accounts.

integer format: int32
""
disabled

Whether to disable this entry temporarily.

boolean
annualTravelSpendInDollars

How much user or company spends on travel per year.

object
amount
required

Monetary amount value

number
""
currency
required

ISO 4217 currency code

string
"" >= 1 characters /^[A-Z]{3}$/
total

Total aggregated sales metrics across all properties.

object
type

The dimension by which sales metrics are grouped.

string
""
Allowed values: BY_TOTAL BY_COUNTRY BY_PROPERTY
typeName

Display name of the grouping entity.

string
""
typeIdentifier

Unique identifier of the grouping entity.

string format: uuid
""
bookings

Total number of bookings in this metric set.

integer format: int64
""
totalPriceAmount

Total revenue from all bookings in the display currency.

number format: double
""
averageBookingAmount

Average booking value in the display currency.

number format: double
""
currencyCode

Currency code for the monetary amounts.

string
"" /^[A-Z]{3}$/
byPropertyList
Array<object>

Sales metrics grouped by individual property.

object
type

The dimension by which sales metrics are grouped.

string
""
Allowed values: BY_TOTAL BY_COUNTRY BY_PROPERTY
typeName

Display name of the grouping entity.

string
""
typeIdentifier

Unique identifier of the grouping entity.

string format: uuid
""
bookings

Total number of bookings in this metric set.

integer format: int64
""
totalPriceAmount

Total revenue from all bookings in the display currency.

number format: double
""
averageBookingAmount

Average booking value in the display currency.

number format: double
""
currencyCode

Currency code for the monetary amounts.

string
"" /^[A-Z]{3}$/
byCountryList
Array<object>

Sales metrics grouped by country.

object
type

The dimension by which sales metrics are grouped.

string
""
Allowed values: BY_TOTAL BY_COUNTRY BY_PROPERTY
typeName

Display name of the grouping entity.

string
""
typeIdentifier

Unique identifier of the grouping entity.

string format: uuid
""
bookings

Total number of bookings in this metric set.

integer format: int64
""
totalPriceAmount

Total revenue from all bookings in the display currency.

number format: double
""
averageBookingAmount

Average booking value in the display currency.

number format: double
""
currencyCode

Currency code for the monetary amounts.

string
"" /^[A-Z]{3}$/
key
additional properties
""
Example
{
"managingEntity": {
"identifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51",
"city": {
"key": "1609350",
"value": "Bangkok"
},
"country": {
"key": "1605651",
"value": "Thailand"
},
"continent": {
"key": "AS",
"value": "AS"
},
"name": "The Siam Residences",
"ownerName": "Alexandra Beaumont",
"urlName": "the-siam-residences",
"uniqueId": "siam-bkk",
"description": "Luxury boutique property on the Chao Phraya River.",
"type": "HOTEL",
"status": "ACTIVE",
"createdDate": "2026-01-15T10:30:00",
"lastUpdate": "2026-06-20T08:00:00",
"travelAgent": null,
"ownerImageId": "v1/property/the-siam-residences.jpg",
"onlinePresence": [],
"annualTravelSpendInDollars": null
},
"total": {
"type": "BY_TOTAL",
"typeName": "All Properties",
"typeIdentifier": "4d7c2b6e-9f3a-5b1c-8d0e-7a5b1c9d3e62",
"bookings": 120,
"totalPriceAmount": 54000,
"averageBookingAmount": 450,
"currencyCode": "USD"
},
"byPropertyList": [
{
"type": "BY_PROPERTY",
"typeName": "The Siam Residences, Bangkok",
"typeIdentifier": "5e8d3c7f-0a4b-6c2d-9e1f-8b6c2d0e4f73",
"bookings": 85,
"totalPriceAmount": 38250,
"averageBookingAmount": 450,
"currencyCode": "USD"
}
],
"byCountryList": [
{
"type": "BY_COUNTRY",
"typeName": "Thailand",
"typeIdentifier": "6f9e4d8a-1b5c-7d3e-0f2a-9c7d3e1f5a84",
"bookings": 120,
"totalPriceAmount": 54000,
"averageBookingAmount": 450,
"currencyCode": "USD"
}
]
}

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

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

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

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

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

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

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

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