Search
const url = 'https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/extranet/sales/inventory/grid';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/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/extranet/sales/inventory/grid \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data nullReturns a paged, filtered and sorted page of inventory for the given property based on the supplied grid State (paging, sorting and filter criteria) in the request body.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The property ID to retrieve inventory grid for
Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69Header Parameters
Section titled “Header Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”Filter grid by state request body
Pagination, sorting, filtering, and grouping state used to query a paged result set.
object
Descriptors used for filtering result set
object
Descriptors used for filtering the result set
A single field-level filter criterion that specifies what to match and how to compare it.
object
Field name to filter on
Example
hotel.nameMake filter comparison case insensitive. Default: Case sensitive
Example
trueFilter operator to use on field
Example
startsWithValue to filter dataset against
Example
Happy ResExample
{ "field": "hotel.name", "ignoreCase": true, "operator": "startsWith", "value": "Happy Res"}Whether to filter inclusively or exclusively
Example
andExample
{ "filters": [ { "field": "hotel.name", "ignoreCase": true, "operator": "startsWith", "value": "Happy Res" } ], "logic": "and"}Descriptors to group result sets by.
Descriptor that defines how a result set should be grouped, including sort direction and optional aggregate calculations.
object
Primitive aggregate data points
Descriptor that defines an aggregate function to apply to a specific field in a grouped result set.
object
Aggregate function
Example
countField to run aggregate function on
Example
hotel.bookingsExample
{ "aggregate": "count", "field": "hotel.bookings"}Group sort direction
Example
ascField to group data set on
Example
createdDateExample
{ "aggregates": [ { "aggregate": "count", "field": "hotel.bookings" } ], "dir": "asc", "field": "createdDate"}Number of records to be skipped by the pager.
Example
0Descriptors used for sorting result set.
Descriptor that defines the sort direction and field for ordering a result set.
object
Descriptors used for sorting result set
Example
ascData set field to sort on
Example
hotel.nameExample
{ "dir": "asc", "field": "hotel.name"}Number of records to take.
Example
10Example
{ "filter": { "filters": [ { "field": "hotel.name", "ignoreCase": true, "operator": "startsWith", "value": "Happy Res" } ], "logic": "and" }, "group": [ { "aggregates": [ { "aggregate": "count", "field": "hotel.bookings" } ], "dir": "asc", "field": "createdDate" } ], "skip": 0, "sort": [ { "dir": "asc", "field": "hotel.name" } ], "take": 10}Responses
Section titled “Responses”Paginated inventory records matching the supplied filter criteria
Owned pagination envelope: a page of content plus flat page metadata.
object
The elements on this page.
Lightweight projection of a bookable inventory item, used by consumers outside the inventory module.
object
Defaults to property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
Whether inventory can be booked
Whether this is commissionable or not
Datetime this record was first created
Whether this inventory is enabled or not
Unique identifier for this record.
Main image of inventory
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Inventory type identifier
Name of inventory as hotel is seeing it
Name of inventory as traveler is seeing it
Inventory type
Datetime this record was last updated
Location
object
Best price of the room type or facility ancillary in platform currency
object
Monetary amount value
ISO 4217 currency code
Best price of the room type or facility ancillary
object
Monetary amount value
ISO 4217 currency code
Level of expensiveness.
Quantity
Parent sales channel
object
A way to blacklist a specific channel a property doesn’t want to send blocking to.
System override by supplier to disable channel. E.g. Platform disables supplier.
Amount of sales commission earned through this channel and all its children [unless configured at the child level].
Datetime this record was first created
Flag the supplier can use to enable / disable this channel
Unique identifier for this record.
Datetime this record was last updated
A specific identifier for the company / corporation / travel agency that is retrieving the rates
Name of the owner / affiliate. Hotel booking customization when it’s the booking customization.
Percent discount on this channel and all its children [unless configured at the child level].
Promotion bundles for this channel
A lightweight projection of a promotion bundle containing the full set of qualifying conditions and metadata.
object
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Datetime this record was first created
Optional bundle-level descriptions. When populated, these replace the aggregated item descriptions in offerDetails.
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Whether this promotion ancillary is enabled or not.
Hotel identifier.
Unique identifier for this record.
Promotions that go together to make up this ancillary.
object
Restrict promotion to users who want to book in advance.
object
Maximum days in advance of stay start date when the booking may be made. Set to 0 for no maximum.
Minimum days in advance of stay start date when the booking must be made. Set to 0 for no minimum.
Restrict promotion to specific days of the week the guest is arriving.
object
The days of the week when this rate is available for guests to arrive on
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Restrict promotion to specific days of the week the promotion is available.
object
The days of the week when this rate is available for booking
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
A date range during which a promotion is not available (blackout period).
object
Start date when the promotion is not available (inclusive).
End date when the promotion is not available (inclusive).
Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific city.
object
City details (obtained via geonames) to restrict the promotion by guest location.
object
City name
Continent code
Continent name
Country ISO code
Country name
GeoNameLightweight identifiers taken from https://geonames.org.
Locale code
Sub-division 1 code
Sub-division 1 name
Sub-division 2 code
Sub-division 2 name
Timezone
Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific continent.
object
Two-letter continent code (e.g. NA, EU, AS)
Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific country.
object
Country (obtained via geonames) to restrict the promotion by guest location.
object
Continent code (two-letter ISO)
Continent name
Country ISO 3166-1 alpha-2 code
Country name
GeoNames identifier
Datetime this record was first created
Restrict promotion to specific days of the week the guest is departing.
object
The days of the week when the guest is allowed to depart
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Whether this promotion is enabled or not.
Qualifier that restricts a promotion to guests within a circular geographic area defined by a center point and radius.
object
Latitude of the center point for the geo-location radius check.
Longitude of the center point for the geo-location radius check.
Radius in kilometers around the center point within which the guest must be located.
Unique identifier of the property this promotion belongs to.
Unique identifier for this record.
Qualifier that restricts a promotion to guests whose IP address falls within a specified IPv4 range.
object
Ending IP address of the range (inclusive).
Starting IP address of the range (inclusive).
Restrict promotion to users who want to book a room close to the date.
object
Number of seconds before the arrival date when the promotion becomes active (last-minute bookings).
Datetime this record was last updated
Restrict promotion to users who want to stay a certain number of days.
object
Maximum number of nights. Set to 0 for no maximum.
Minimum number of nights for promotion to apply. Set to 0 for no minimum.
The discount or premium amount and its type (fixed or percentage).
object
A localized amount, always non-negative. Direction (surcharge vs. discount) is determined by which field this charge is assigned to, not the sign of this value.
object
Monetary amount value
ISO 4217 currency code
A fraction between 0 and 1 (inclusive) representing a percentage of the total stay amount for an early check-in or late check-out, e.g. 0.25 for 25%. Direction (surcharge vs. discount) is determined by which field this charge is assigned to, not the sign of this value.
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
Internal name of promotion.
Restrict promotion to either prepaid / non-prepaid rates.
object
True to apply only to prepaid rates, false to apply only to pay-at-property rates.
This determines whether this discount should be applied per night, per stay or per person - per night
Qualifier that restricts a promotion to guests who enter a specific promotional code at checkout.
object
Promo code that guests must enter to access this promotion.
Restrict promotion to either refundable / non-refundable rates.
object
True to apply only to refundable rates, false to apply only to non-refundable rates.
Restrict promotion to specific days of the week the guest has to stay.
object
The days of the week the user has to stay on to get this rate
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Restrict promotion by restricting to how many rooms the user wants.
object
Maximum number of rooms in the booking. Leave null or 0 for no upper limit.
Minimum number of rooms in the booking for this promotion to apply.
Qualifier that restricts a promotion to bookings made within a specific date window.
object
Promotion is available when the booking is made on or after this date (inclusive).
Promotion is available when the booking is made on or before this date (inclusive).
Rate qualifier that restricts a promotion to guests whose stay falls within a specific date range.
object
Promotion applies when guest’s stay starts on or after this date (inclusive).
Promotion applies when guest’s stay starts on or before this date (inclusive).
Qualifier that restricts a promotion to guests whose system timezone matches the specified IANA timezone name.
object
IANA timezone name of the booker’s location (e.g. Asia/Bangkok).
Set whether you want the price to go up or down when the rules of this promotion have been satisfied.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Datetime this record was last updated
Optional: override the combined discount of all bundle items with a single fixed or percentage amount.
object
A localized amount, always non-negative. Direction (surcharge vs. discount) is determined by which field this charge is assigned to, not the sign of this value.
object
Monetary amount value
ISO 4217 currency code
A fraction between 0 and 1 (inclusive) representing a percentage of the total stay amount for an early check-in or late check-out, e.g. 0.25 for 25%. Direction (surcharge vs. discount) is determined by which field this charge is assigned to, not the sign of this value.
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
Internal name of promotion ancillary.
Determines whether this discount should be applied per night, per stay or per person - per night; Required if amount override is not null
Required if manual override modifier is not null
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Promotions for this channel
A lightweight projection of a special rate (promotion) containing all qualifying conditions and metadata.
object
Restrict promotion to users who want to book in advance.
object
Maximum days in advance of stay start date when the booking may be made. Set to 0 for no maximum.
Minimum days in advance of stay start date when the booking must be made. Set to 0 for no minimum.
Restrict promotion to specific days of the week the guest is arriving.
object
The days of the week when this rate is available for guests to arrive on
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Restrict promotion to specific days of the week the promotion is available.
object
The days of the week when this rate is available for booking
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
A date range during which a promotion is not available (blackout period).
object
Start date when the promotion is not available (inclusive).
End date when the promotion is not available (inclusive).
Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific city.
object
City details (obtained via geonames) to restrict the promotion by guest location.
object
City name
Continent code
Continent name
Country ISO code
Country name
GeoNameLightweight identifiers taken from https://geonames.org.
Locale code
Sub-division 1 code
Sub-division 1 name
Sub-division 2 code
Sub-division 2 name
Timezone
Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific continent.
object
Two-letter continent code (e.g. NA, EU, AS)
Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific country.
object
Country (obtained via geonames) to restrict the promotion by guest location.
object
Continent code (two-letter ISO)
Continent name
Country ISO 3166-1 alpha-2 code
Country name
GeoNames identifier
Datetime this record was first created
Restrict promotion to specific days of the week the guest is departing.
object
The days of the week when the guest is allowed to depart
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Whether this promotion is enabled or not.
Qualifier that restricts a promotion to guests within a circular geographic area defined by a center point and radius.
object
Latitude of the center point for the geo-location radius check.
Longitude of the center point for the geo-location radius check.
Radius in kilometers around the center point within which the guest must be located.
Unique identifier of the property this promotion belongs to.
Unique identifier for this record.
Qualifier that restricts a promotion to guests whose IP address falls within a specified IPv4 range.
object
Ending IP address of the range (inclusive).
Starting IP address of the range (inclusive).
Restrict promotion to users who want to book a room close to the date.
object
Number of seconds before the arrival date when the promotion becomes active (last-minute bookings).
Datetime this record was last updated
Restrict promotion to users who want to stay a certain number of days.
object
Maximum number of nights. Set to 0 for no maximum.
Minimum number of nights for promotion to apply. Set to 0 for no minimum.
The discount or premium amount and its type (fixed or percentage).
object
A localized amount, always non-negative. Direction (surcharge vs. discount) is determined by which field this charge is assigned to, not the sign of this value.
object
Monetary amount value
ISO 4217 currency code
A fraction between 0 and 1 (inclusive) representing a percentage of the total stay amount for an early check-in or late check-out, e.g. 0.25 for 25%. Direction (surcharge vs. discount) is determined by which field this charge is assigned to, not the sign of this value.
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
Internal name of promotion.
Restrict promotion to either prepaid / non-prepaid rates.
object
True to apply only to prepaid rates, false to apply only to pay-at-property rates.
This determines whether this discount should be applied per night, per stay or per person - per night
Qualifier that restricts a promotion to guests who enter a specific promotional code at checkout.
object
Promo code that guests must enter to access this promotion.
Restrict promotion to either refundable / non-refundable rates.
object
True to apply only to refundable rates, false to apply only to non-refundable rates.
Restrict promotion to specific days of the week the guest has to stay.
object
The days of the week the user has to stay on to get this rate
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Restrict promotion by restricting to how many rooms the user wants.
object
Maximum number of rooms in the booking. Leave null or 0 for no upper limit.
Minimum number of rooms in the booking for this promotion to apply.
Qualifier that restricts a promotion to bookings made within a specific date window.
object
Promotion is available when the booking is made on or after this date (inclusive).
Promotion is available when the booking is made on or before this date (inclusive).
Rate qualifier that restricts a promotion to guests whose stay falls within a specific date range.
object
Promotion applies when guest’s stay starts on or after this date (inclusive).
Promotion applies when guest’s stay starts on or before this date (inclusive).
Qualifier that restricts a promotion to guests whose system timezone matches the specified IANA timezone name.
object
IANA timezone name of the booker’s location (e.g. Asia/Bangkok).
Set whether you want the price to go up or down when the rules of this promotion have been satisfied.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Whether the sales channel is a self-acquiring entity.
What type of segment of channel is this.
Channel is owned by this supplier identifier.
Name of property / supplier that owns this channel
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Whether this is the first page.
Whether this is the last page.
Zero-based index of this page.
Number of elements on this page.
The requested page size.
Total number of elements across all pages.
Total number of pages for the current page size.
Example
{ "content": [ { "address": { "city": { "country": { "continent": "AS", "countryCode": "TH", "geoNameId": "1605651", "name": "Thailand" }, "geoNameId": "1609350", "name": "Bangkok" }, "countryCode": "TH", "line1": "9 Thanon Krung Thonburi", "postalCode": "10600", "state": "Bangkok" }, "bookable": true, "commissionable": true, "createdDate": "2026-01-14T09:30:00", "enabled": true, "id": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "image": { "descriptions": [ { "description": "Spacious deluxe room with panoramic city views", "language": "en", "title": "Deluxe City View Room" } ], "identifier": "the-siam-residences/deluxe-room-city-view", "isLandscape": true, "multimediaIdentifier": "2b4d6f8a-0c2e-4a6b-8d0f-2c4e6a8b0d2f", "published": true, "sort": 10, "type": "IMAGE" }, "inventoryIdentifier": "6f9b4c8d-1e5a-4b3c-9d2e-8a7f0c1b5e43", "inventoryName": "Deluxe Room with City View", "inventoryNameInEnglish": "Deluxe City View Room", "inventoryType": "GUEST_ROOM", "lastUpdate": "2026-03-10T14:15:00", "location": { "coordinates": [ 100.5581533, 13.7370197 ], "type": "Point" }, "lowestDisplayPrice": { "amount": 125, "currency": "USD" }, "lowestPrice": { "amount": 4500, "currency": "THB" }, "pricePoint": "THREE", "quantity": 50, "salesChannel": { "channelDisabled": false, "enabled": true, "identifier": "7a0c5d9e-2f6b-4c1a-8e4d-3b9f1a0c6d52", "ownerIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "ownerName": "The Siam Residences", "subType": "DIRECT", "supplierIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "supplierName": "The Siam Residences, Bangkok" } } ], "first": true, "last": false, "number": 0, "numberOfElements": 20, "size": 20, "totalElements": 1234, "totalPages": 62}Bad Request — missing or invalid request parameter or body
object
object
Example
Unauthorized — authentication is required or the session has expired
object
object
Example
Forbidden — authenticated but lacking the required permission or scope
object
object
Example
Not Found — the requested resource does not exist
object
object
Example
Method Not Allowed — the HTTP verb is not supported on this endpoint
object
object
Example
Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version
object
object
Example
Unsupported Media Type — use application/json
object
object
Example
Internal Server Error — an unexpected failure occurred on the server
object
object
Example
Service Unavailable — a downstream dependency is unreachable