Show Affiliates

POST

/api/managing-entity/{managingEntityIdentifier}/extranet/sales/affiliate/grid

const url = 'https://api.wink.travel/api/managing-entity/hotel-1/extranet/sales/affiliate/grid';
const options = {
  method: 'POST',
  headers: {'Wink-Version': '2.0', 'Content-Type': 'application/json'},
  body: '{"skip":0,"take":30,"sort":"","filter":"","group":""}'
};

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/managing-entity/hotel-1/extranet/sales/affiliate/grid \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "skip": 0, "take": 30, "sort": "", "filter": "", "group": "" }'

Retrieve page of affiliates.

Parameters

Path Parameters

managingEntityIdentifier

required

string

Display affiliates to this specified property

Example

hotel-1

Header Parameters

Wink-Version

string

default: 2.0.0

Allowed values: 2.0

Request Body^required

application/json

object

skip

Number of records to be skipped by the pager.

integer format: int32

Example

take

Number of records to take.

integer format: int32

default: 30 >= 1 <= 180

Example

sort

Descriptors used for sorting result set.

Array<object>

object

dir

Descriptors used for sorting result set

string

Allowed values: asc desc

Example

asc

field

Data set field to sort on

string

Example

hotel.name

filter

Descriptors used for filtering result set

object

logic

Whether to filter inclusively or exclusively

string

Allowed values: and or

Example

and

filters

Descriptors used for filtering the result set

Array<object>

object

field

required

Field name to filter on

string

"" >= 1 characters

Example

hotel.name

operator

required

Filter operator to use on field

string

Allowed values: neq eq contains doesnotcontain isnull isnotnull isempty isnotempty startswith endswith gte lte gt lt in nin

Example

startsWith

value

Value to filter dataset against

Example

Happy Res

ignoreCase

Make filter comparison case insensitive. Default: Case sensitive

boolean

Example

true

group

Descriptors to group result sets by.

Array<object>

object

field

Field to group data set on

string

Example

createdDate

dir

Group sort direction

string

Allowed values: asc desc

Example

asc

aggregates

Primitive aggregate data points

Array<object>

object

field

Field to run aggregate function on

string

Example

hotel.bookings

aggregate

Aggregate function

string

Allowed values: count sum average min max

Example

count

Responses

200

application/json

object

totalPages

integer format: int32

totalElements

integer format: int64

size

integer format: int32

content

Array<object>

object

ownerIdentifier

The company ID.

string

type

The company type

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

ownerName

The company name

string

urlName

The company url slug

string

continent

The company continent

string

country

The company country

string

countryGeoNameId

The company country geo name ID

string

city

The company city

string

cityGeoNameId

The company city geo name ID

string

ownerImageId

The company image ID

string

description

string

onlinePresence

Array<object>

Online presence of account.

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

The type of audience you have on this network.

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

number

currency

required

string

>= 1 characters

bookings

integer format: int64

totalPriceAmount

number format: double

averageBookingAmount

number format: double

currencyCode

string

number

integer format: int32

numberOfElements

integer format: int32

sort

object

empty

boolean

unsorted

boolean

sorted

boolean

first

boolean

last

boolean

pageable

object

offset

integer format: int64

sort

object

empty

boolean

unsorted

boolean

sorted

boolean

pageSize

integer format: int32

paged

boolean

pageNumber

integer format: int32

unpaged

boolean

empty

boolean

Example

{
  "content": [
    {
      "ownerIdentifier": "",
      "type": "TRIP_PAY",
      "ownerName": "",
      "urlName": "",
      "continent": "",
      "country": "",
      "countryGeoNameId": "",
      "city": "",
      "cityGeoNameId": "",
      "ownerImageId": "",
      "onlinePresence": [
        ""
      ],
      "annualTravelSpendInDollars": ""
    }
  ]
}

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

Unauthorized

*/*

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

403

Forbidden

*/*

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

500

Internal Server Error

object

Example ^generated

{}

Show Affiliates

Parameters

Path Parameters

Example

Header Parameters

Request Body required

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Responses

200

Example

400

Example generated

401

403

500

Example generated

Request Body^required

Example ^generated

Example ^generated