{ "openapi" : "3.1.0", "info" : { "title" : "Wink API", "description" : "Welcome to the Wink API — a programmer-friendly way to manage, sell and book travel\ninventory on the Wink platform. See the **Overview** page (under **API**) for the full\nintroduction, intended audience, testing, and versioning.\n# Studio API\nEndpoints for resellers and content creators: browse suppliers and inventory, curate it\n(lists, maps, grids, customization), manage sales channels, and report.\n\n", "contact" : { "name" : "Contact", "email" : "hi@wink.travel" }, "version" : "0.0.0-TEST", "x-logo" : { "backgroundColor" : "#FFFFFF", "altText" : "wink", "url" : "https://res.cloudinary.com/traveliko/image/upload/c_scale,h_129/v1653285543/wink/logo_text_white.svg" } }, "externalDocs" : { "description" : "Documentation", "url" : "https://wink.travel/getting-started/how-to-use/" }, "servers" : [ { "url" : "https://api.wink.travel", "description" : "Endpoint" } ], "tags" : [ { "name" : "Saved Search", "description" : "Consists of search filters that produce a list of supplier / inventory when queried.", "externalDocs" : { "description" : "Try it in Scalar", "url" : "https://api.wink.travel/scalar#studio/tag/saved-search" } }, { "name" : "Browse: Supplier", "description" : "Before you can sell travel inventory, you need to find it. Discover travel inventory that fits your niche and your audience.", "externalDocs" : { "description" : "Try it in Scalar", "url" : "https://api.wink.travel/scalar#studio/tag/browse-supplier" } }, { "name" : "Catalog", "description" : "Show all available inventories you have created and that can be consumed by our Web Components" }, { "name" : "Available Suppliers", "description" : "Browse and discover properties available for partnership. Affiliates can search, filter, and retrieve supplier details for integration with their distribution networks.", "externalDocs" : { "description" : "Try it in Scalar", "url" : "https://api.wink.travel/scalar#studio/tag/available-suppliers" } }, { "name" : "Catalog", "description" : "Before you can sell travel inventory, you need to find it. Discover travel inventory that fits your niche and your audience.", "externalDocs" : { "description" : "Try it in Scalar", "url" : "https://api.wink.travel/scalar#studio/tag/catalog" } }, { "name" : "Ranked Grid", "description" : "Pageable grids based on searching for blocking by a specific score type and a region.", "externalDocs" : { "description" : "Try it in Scalar", "url" : "https://api.wink.travel/scalar#studio/tag/ranked-grid" } }, { "name" : "Connect with supplier", "description" : "Account relationships are initiated by either affiliate or company and allows for companys to give sales channel specific pricing to affiliates on an individual basis.", "externalDocs" : { "description" : "Try it in Scalar", "url" : "https://api.wink.travel/scalar#studio/tag/connect-with-supplier" } }, { "name" : "Browse: Inventory", "description" : "Before you can sell travel inventory, you need to find it. Discover travel inventorythat fits your niche and your audience.", "externalDocs" : { "description" : "Try it in Scalar", "url" : "https://api.wink.travel/scalar#studio/tag/browse-inventory" } }, { "name" : "Sales Channel", "description" : "Displays relationships between affiliates and suppliers.", "externalDocs" : { "description" : "Try it in Scalar", "url" : "https://api.wink.travel/scalar#studio/tag/sales-channel" } }, { "name" : "Grid", "description" : "Consumable grids based on curated lists and saved searches.", "externalDocs" : { "description" : "Try it in Scalar", "url" : "https://api.wink.travel/scalar#studio/tag/grid" } }, { "name" : "Link: Supplier", "description" : "Supplier links are a direct link to supplier homepage that also includes OpenGraph friendly metadata.", "externalDocs" : { "description" : "Try it in Scalar", "url" : "https://api.wink.travel/scalar#studio/tag/link-supplier" } }, { "name" : "Curated List", "description" : "Consists of supplier / inventoryIDs in a specific order", "externalDocs" : { "description" : "Try it in Scalar", "url" : "https://api.wink.travel/scalar#studio/tag/curated-list" } }, { "name" : "Analytics", "description" : "Retrieve and analyze booking metrics, including property performance, affiliate overview, revenue trends, and detailed time-series analytics." }, { "name" : "Link: Inventory", "description" : "Links are the simplest form of travel inventory and can be shared everywhere and contains OpenGraph metadata. The same links can also be used with our ad banner Web Component.", "externalDocs" : { "description" : "Try it in Scalar", "url" : "https://api.wink.travel/scalar#studio/tag/link-inventory" } }, { "name" : "Card", "description" : "Single travel inventory record a seller has configured and made available for sale.", "externalDocs" : { "description" : "Try it in Scalar", "url" : "https://api.wink.travel/scalar#studio/tag/card" } }, { "name" : "Map", "description" : "Configure and manage maps, map data and overlays that you wish to display to your users.", "externalDocs" : { "description" : "Try it in Scalar", "url" : "https://api.wink.travel/scalar#studio/tag/map" } }, { "name" : "Analytics", "description" : "Create and track the analytics data sets you created and find interesting.", "externalDocs" : { "description" : "Try it in Scalar", "url" : "https://api.wink.travel/scalar#studio/tag/analytics" } } ], "paths" : { "/api/managing-entity/{managingEntityIdentifier}/studio/shareable-link/supplier/{supplierUrlIdentifier}" : { "get" : { "tags" : [ "Link: Supplier" ], "summary" : "Show", "description" : "Retrieves a single shareable supplier link by its identifier, ensuring it belongs to the specified managing entity.", "operationId" : "show-supplier-url", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier (the owner of the shareable link)", "required" : true, "schema" : { "type" : "string" }, "example" : "d2c8f3a9-4b1e-4c7a-9d3f-5b8a2e6c1d04" }, { "name" : "supplierUrlIdentifier", "in" : "path", "description" : "Shareable supplier link identifier", "required" : true, "schema" : { "type" : "string" }, "example" : "7c9a2e5f-3d8b-4a1c-b6e2-8f0d1c4a9b3e" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Returns the shareable supplier link with OpenGraph metadata and customization settings", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SellableSupplierUrlLightweight_ManagingEntity" }, "example" : { "animate" : false, "animateDelay" : 500, "createdDate" : "2026-01-14T09:30:00", "customizationIdentifier" : "8f2d4a9c-1e7b-4f3d-a5c8-9d1b6e2c0a47", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "facebookAppId" : "198273987219", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "keywords" : [ "luxury" ], "lastUpdate" : "2026-02-03T16:45:12", "multimedias" : [ { "angle" : null, "attribution" : [ ], "category" : "2", "descriptions" : [ { "description" : "Elegant lobby of The Siam Residences", "language" : "en", "title" : "Lobby Entrance" } ], "height" : 1600, "identifier" : "the-siam-residences/lobby-entrance", "isLandscape" : true, "lifestyleType" : null, "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "source" : "CLOUDINARY", "type" : "IMAGE", "width" : 2560 } ], "name" : "The Siam Residences, Bangkok", "ownerIdentifier" : "d2c8f3a9-4b1e-4c7a-9d3f-5b8a2e6c1d04", "supplierIdentifier" : "7c9a2e5f-3d8b-4a1c-b6e2-8f0d1c4a9b3e", "twitterAccount" : "@thesiamresidences", "uniqueId" : "HBDG87f2", "userIdentifier" : "4a1d7c2e-5f9b-4e3a-b8c1-6d2f8a0e3c5b", "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] }, "put" : { "tags" : [ "Link: Supplier" ], "summary" : "Update", "description" : "Updates an existing shareable supplier link with the provided details. The link's unique shareable URL identifier remains unchanged. The last update timestamp is automatically set to the current time.", "operationId" : "update-supplier-url", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier (the owner of the shareable link)", "required" : true, "schema" : { "type" : "string" }, "example" : "d2c8f3a9-4b1e-4c7a-9d3f-5b8a2e6c1d04" }, { "name" : "supplierUrlIdentifier", "in" : "path", "description" : "Shareable supplier link identifier to update", "required" : true, "schema" : { "type" : "string" }, "example" : "7c9a2e5f-3d8b-4a1c-b6e2-8f0d1c4a9b3e" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Updated supplier link configuration with revised OpenGraph metadata, branding, or supplier targeting", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpsertSellableSupplierUrlRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Updated shareable supplier link with the new settings applied; the unique URL identifier and owner remain unchanged", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SellableSupplierUrlLightweight_ManagingEntity" }, "example" : { "animate" : false, "animateDelay" : 500, "createdDate" : "2026-01-14T09:30:00", "customizationIdentifier" : "8f2d4a9c-1e7b-4f3d-a5c8-9d1b6e2c0a47", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "facebookAppId" : "198273987219", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "keywords" : [ "luxury" ], "lastUpdate" : "2026-02-03T16:45:12", "multimedias" : [ { "angle" : null, "attribution" : [ ], "category" : "2", "descriptions" : [ { "description" : "Elegant lobby of The Siam Residences", "language" : "en", "title" : "Lobby Entrance" } ], "height" : 1600, "identifier" : "the-siam-residences/lobby-entrance", "isLandscape" : true, "lifestyleType" : null, "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "source" : "CLOUDINARY", "type" : "IMAGE", "width" : 2560 } ], "name" : "The Siam Residences, Bangkok", "ownerIdentifier" : "d2c8f3a9-4b1e-4c7a-9d3f-5b8a2e6c1d04", "supplierIdentifier" : "7c9a2e5f-3d8b-4a1c-b6e2-8f0d1c4a9b3e", "twitterAccount" : "@thesiamresidences", "uniqueId" : "HBDG87f2", "userIdentifier" : "4a1d7c2e-5f9b-4e3a-b8c1-6d2f8a0e3c5b", "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] }, "delete" : { "tags" : [ "Link: Supplier" ], "summary" : "Delete", "description" : "Permanently removes the shareable supplier link. The unique shareable URL will no longer be accessible after deletion.", "operationId" : "remove-supplier-url", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier (the owner of the shareable link)", "required" : true, "schema" : { "type" : "string" }, "example" : "d2c8f3a9-4b1e-4c7a-9d3f-5b8a2e6c1d04" }, { "name" : "supplierUrlIdentifier", "in" : "path", "description" : "Shareable supplier link identifier to delete", "required" : true, "schema" : { "type" : "string" }, "example" : "7c9a2e5f-3d8b-4a1c-b6e2-8f0d1c4a9b3e" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Shareable supplier link permanently removed; returns the deleted link's final state", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SellableSupplierUrlLightweight_ManagingEntity" }, "example" : { "animate" : false, "animateDelay" : 500, "createdDate" : "2026-01-14T09:30:00", "customizationIdentifier" : "8f2d4a9c-1e7b-4f3d-a5c8-9d1b6e2c0a47", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "facebookAppId" : "198273987219", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "keywords" : [ "luxury" ], "lastUpdate" : "2026-02-03T16:45:12", "multimedias" : [ { "angle" : null, "attribution" : [ ], "category" : "2", "descriptions" : [ { "description" : "Elegant lobby of The Siam Residences", "language" : "en", "title" : "Lobby Entrance" } ], "height" : 1600, "identifier" : "the-siam-residences/lobby-entrance", "isLandscape" : true, "lifestyleType" : null, "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "source" : "CLOUDINARY", "type" : "IMAGE", "width" : 2560 } ], "name" : "The Siam Residences, Bangkok", "ownerIdentifier" : "d2c8f3a9-4b1e-4c7a-9d3f-5b8a2e6c1d04", "supplierIdentifier" : "7c9a2e5f-3d8b-4a1c-b6e2-8f0d1c4a9b3e", "twitterAccount" : "@thesiamresidences", "uniqueId" : "HBDG87f2", "userIdentifier" : "4a1d7c2e-5f9b-4e3a-b8c1-6d2f8a0e3c5b", "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/shareable-link/inventory/{sellerUrlIdentifier}" : { "get" : { "tags" : [ "Link: Inventory" ], "summary" : "Show", "description" : "Retrieves a single shareable inventory link by its identifier, scoped to the owning managing entity with all OpenGraph metadata and media settings.", "operationId" : "show-seller-url", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier that owns the shareable link", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "sellerUrlIdentifier", "in" : "path", "description" : "Shareable link identifier to retrieve", "required" : true, "schema" : { "type" : "string" }, "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Shareable inventory link found with complete OpenGraph metadata and media settings", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SellableInventoryUrlLightweight_ManagingEntity" }, "example" : { "animate" : true, "animateDelay" : 1000, "channelInventoryIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "channelInventoryType" : "GUEST_ROOM", "createdDate" : "2026-01-14T09:30:00", "customizationIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "facebookAppId" : "19827398721938798237", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "inventoryStatus" : "ACTIVE", "inventoryType" : "GUEST_ROOM", "keywords" : [ "bali" ], "lastUpdate" : "2026-02-03T16:45:12", "multimedias" : [ { "angle" : null, "attribution" : [ ], "category" : "2", "descriptions" : [ { "description" : "Elegant lobby of The Siam Residences", "language" : "en", "title" : "Lobby Entrance" } ], "height" : 1600, "identifier" : "the-siam-residences/lobby-entrance", "isLandscape" : true, "lifestyleType" : null, "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "source" : "CLOUDINARY", "type" : "IMAGE", "width" : 2560 } ], "name" : "My Bali Villa", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "status" : "ACTIVE", "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "theme" : "THEME_1", "transactionalItemIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "twitterAccount" : "@travelikoworld", "uniqueId" : "HBDG87f2", "userIdentifier" : "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] }, "put" : { "tags" : [ "Link: Inventory" ], "summary" : "Update", "description" : "Updates the identified shareable inventory link with new metadata, media, theming, or inventory selection from the request body.", "operationId" : "update-seller-url", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier that owns the shareable link", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "sellerUrlIdentifier", "in" : "path", "description" : "Shareable link identifier to update", "required" : true, "schema" : { "type" : "string" }, "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Updated inventory link configuration including OpenGraph metadata, media selection, and theming", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpsertSellableInventoryUrlRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Shareable inventory link updated successfully with the new metadata, media, and inventory selection", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SellableInventoryUrlLightweight_ManagingEntity" }, "example" : { "animate" : true, "animateDelay" : 1000, "channelInventoryIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "channelInventoryType" : "GUEST_ROOM", "createdDate" : "2026-01-14T09:30:00", "customizationIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "facebookAppId" : "19827398721938798237", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "inventoryStatus" : "ACTIVE", "inventoryType" : "GUEST_ROOM", "keywords" : [ "bali" ], "lastUpdate" : "2026-02-03T16:45:12", "multimedias" : [ { "angle" : null, "attribution" : [ ], "category" : "2", "descriptions" : [ { "description" : "Elegant lobby of The Siam Residences", "language" : "en", "title" : "Lobby Entrance" } ], "height" : 1600, "identifier" : "the-siam-residences/lobby-entrance", "isLandscape" : true, "lifestyleType" : null, "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "source" : "CLOUDINARY", "type" : "IMAGE", "width" : 2560 } ], "name" : "My Bali Villa", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "status" : "ACTIVE", "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "theme" : "THEME_1", "transactionalItemIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "twitterAccount" : "@travelikoworld", "uniqueId" : "HBDG87f2", "userIdentifier" : "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] }, "delete" : { "tags" : [ "Link: Inventory" ], "summary" : "Delete", "description" : "Permanently removes the identified shareable inventory link belonging to the managing entity. This action cannot be undone.", "operationId" : "remove-seller-url", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier that owns the shareable link", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "sellerUrlIdentifier", "in" : "path", "description" : "Shareable link identifier to delete", "required" : true, "schema" : { "type" : "string" }, "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Shareable inventory link permanently removed; the deleted document is returned as confirmation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SellableInventoryUrlLightweight_ManagingEntity" }, "example" : { "animate" : true, "animateDelay" : 1000, "channelInventoryIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "channelInventoryType" : "GUEST_ROOM", "createdDate" : "2026-01-14T09:30:00", "customizationIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "facebookAppId" : "19827398721938798237", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "inventoryStatus" : "ACTIVE", "inventoryType" : "GUEST_ROOM", "keywords" : [ "bali" ], "lastUpdate" : "2026-02-03T16:45:12", "multimedias" : [ { "angle" : null, "attribution" : [ ], "category" : "2", "descriptions" : [ { "description" : "Elegant lobby of The Siam Residences", "language" : "en", "title" : "Lobby Entrance" } ], "height" : 1600, "identifier" : "the-siam-residences/lobby-entrance", "isLandscape" : true, "lifestyleType" : null, "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "source" : "CLOUDINARY", "type" : "IMAGE", "width" : 2560 } ], "name" : "My Bali Villa", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "status" : "ACTIVE", "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "theme" : "THEME_1", "transactionalItemIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "twitterAccount" : "@travelikoworld", "uniqueId" : "HBDG87f2", "userIdentifier" : "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/ranked-grids/{listIdentifier}" : { "get" : { "tags" : [ "Ranked Grid" ], "summary" : "Show", "description" : "Loads a single ranked grid owned by the managing entity. Returns 404 if the grid does not exist. Requires MARKETING:READ permission.", "operationId" : "show-seller-inventory-ranked-list", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "listIdentifier", "in" : "path", "description" : "Ranked grid identifier", "required" : true, "schema" : { "type" : "string" }, "example" : "8f3a2c6e-1d5b-4a7f-9e2c-0b4d6a1f8e5c" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "The ranked grid matching the supplied identifier", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SellableRankedListLightweight_ManagingEntity" }, "example" : { "animate" : false, "animateDelay" : 500, "createdDate" : "2026-01-14T09:30:00", "customizationIdentifier" : "7d2e4f1a-6c8b-4a9e-b3d5-1e7f2a0c5b8d", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "displayType" : "NATIVE", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "keywords" : [ "luxury" ], "lastUpdate" : "2026-02-03T16:45:12", "lookup" : { "cityName" : "Bangkok", "countryCode" : "TH", "countryName" : "Thailand", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "languageCode" : "en", "location" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "Point" }, "name" : "The Siam Residences", "ownerName" : "The Siam Residences", "subCountryName" : "Bangkok", "subSubCountryName" : "Khlong San District", "type" : "HOTEL", "typeIdentifier" : "a1f3c9d2-7e4b-4a0c-8d5e-2b9f1a6c3e78", "urlName" : "the-siam-residences-bangkok-thailand" }, "name" : "Featured Luxury Resorts Bangkok", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "sort" : "MEMBER", "status" : "ACTIVE", "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] }, "put" : { "tags" : [ "Ranked Grid" ], "summary" : "Update", "description" : "Replaces the stored ranked grid identified by its identifier with the supplied values. Requires MARKETING:WRITE permission.", "operationId" : "update-seller-inventory-ranked-list", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "listIdentifier", "in" : "path", "description" : "Ranked grid identifier", "required" : true, "schema" : { "type" : "string" }, "example" : "8f3a2c6e-1d5b-4a7f-9e2c-0b4d6a1f8e5c" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Updated ranked grid definition with revised name, score type, region, or display configuration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpsertSellableRankedListRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Ranked grid successfully updated with the supplied values", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SellableRankedListLightweight_ManagingEntity" }, "example" : { "animate" : false, "animateDelay" : 500, "createdDate" : "2026-01-14T09:30:00", "customizationIdentifier" : "7d2e4f1a-6c8b-4a9e-b3d5-1e7f2a0c5b8d", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "displayType" : "NATIVE", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "keywords" : [ "luxury" ], "lastUpdate" : "2026-02-03T16:45:12", "lookup" : { "cityName" : "Bangkok", "countryCode" : "TH", "countryName" : "Thailand", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "languageCode" : "en", "location" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "Point" }, "name" : "The Siam Residences", "ownerName" : "The Siam Residences", "subCountryName" : "Bangkok", "subSubCountryName" : "Khlong San District", "type" : "HOTEL", "typeIdentifier" : "a1f3c9d2-7e4b-4a0c-8d5e-2b9f1a6c3e78", "urlName" : "the-siam-residences-bangkok-thailand" }, "name" : "Featured Luxury Resorts Bangkok", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "sort" : "MEMBER", "status" : "ACTIVE", "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] }, "delete" : { "tags" : [ "Ranked Grid" ], "summary" : "Delete", "description" : "Removes the ranked grid identified by its identifier from the managing entity. Requires MARKETING:WRITE permission.", "operationId" : "remove-seller-inventory-ranked-list", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "listIdentifier", "in" : "path", "description" : "Ranked grid identifier", "required" : true, "schema" : { "type" : "string" }, "example" : "8f3a2c6e-1d5b-4a7f-9e2c-0b4d6a1f8e5c" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "The ranked grid that was successfully deleted", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SellableRankedListLightweight_ManagingEntity" }, "example" : { "animate" : false, "animateDelay" : 500, "createdDate" : "2026-01-14T09:30:00", "customizationIdentifier" : "7d2e4f1a-6c8b-4a9e-b3d5-1e7f2a0c5b8d", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "displayType" : "NATIVE", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "keywords" : [ "luxury" ], "lastUpdate" : "2026-02-03T16:45:12", "lookup" : { "cityName" : "Bangkok", "countryCode" : "TH", "countryName" : "Thailand", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "languageCode" : "en", "location" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "Point" }, "name" : "The Siam Residences", "ownerName" : "The Siam Residences", "subCountryName" : "Bangkok", "subSubCountryName" : "Khlong San District", "type" : "HOTEL", "typeIdentifier" : "a1f3c9d2-7e4b-4a0c-8d5e-2b9f1a6c3e78", "urlName" : "the-siam-residences-bangkok-thailand" }, "name" : "Featured Luxury Resorts Bangkok", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "sort" : "MEMBER", "status" : "ACTIVE", "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/map/{mapIdentifier}" : { "get" : { "tags" : [ "Map" ], "summary" : "Show", "description" : "Retrieve a single map configuration by its UUID, scoped to the owning managing entity.", "operationId" : "show-inventory-map", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "UUID of the managing entity that owns the map.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "mapIdentifier", "in" : "path", "description" : "UUID of the map to retrieve.", "required" : true, "schema" : { "type" : "string" }, "example" : "f8a3d7e1-2b6c-4f9a-8c15-3e7d1a9c5b42" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Map configuration matching the given identifier", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InventoryMapLightweight_ManagingEntity" }, "example" : { "center" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "Point" }, "circles" : [ { "radius" : 2.5 } ], "customizationIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "displayType" : "NATIVE", "draggable" : true, "identifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "initialZoomLevel" : 15, "mapHeight" : 500, "mapMarkerColor" : "cc2138", "mapStyle" : "normal", "name" : "Premium Hotels in Southeast Asia", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "type" : "LIST", "typeIdentifier" : "7a0c5d9e-2f6b-4c1a-8e4d-3b9f1a0c6d52", "zoomable" : true } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] }, "put" : { "tags" : [ "Map" ], "summary" : "Update", "description" : "Modify an existing map configuration with the supplied settings.", "operationId" : "update-inventory-map", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "UUID of the managing entity that owns the map.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "mapIdentifier", "in" : "path", "description" : "UUID of the map to update.", "required" : true, "schema" : { "type" : "string" }, "example" : "f8a3d7e1-2b6c-4f9a-8c15-3e7d1a9c5b42" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Updated map configuration including name, center coordinates, zoom level, style and the list of inventory items to display as markers", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpsertInventoryMapRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Updated map configuration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InventoryMapLightweight_ManagingEntity" }, "example" : { "center" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "Point" }, "circles" : [ { "radius" : 2.5 } ], "customizationIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "displayType" : "NATIVE", "draggable" : true, "identifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "initialZoomLevel" : 15, "mapHeight" : 500, "mapMarkerColor" : "cc2138", "mapStyle" : "normal", "name" : "Premium Hotels in Southeast Asia", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "type" : "LIST", "typeIdentifier" : "7a0c5d9e-2f6b-4c1a-8e4d-3b9f1a0c6d52", "zoomable" : true } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] }, "delete" : { "tags" : [ "Map" ], "summary" : "Delete", "description" : "Permanently remove a map configuration and all its associated data.", "operationId" : "remove-inventory-map", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "UUID of the managing entity that owns the map.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "mapIdentifier", "in" : "path", "description" : "UUID of the map to delete.", "required" : true, "schema" : { "type" : "string" }, "example" : "f8a3d7e1-2b6c-4f9a-8c15-3e7d1a9c5b42" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Deleted map configuration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InventoryMapLightweight_ManagingEntity" }, "example" : { "center" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "Point" }, "circles" : [ { "radius" : 2.5 } ], "customizationIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "displayType" : "NATIVE", "draggable" : true, "identifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "initialZoomLevel" : 15, "mapHeight" : 500, "mapMarkerColor" : "cc2138", "mapStyle" : "normal", "name" : "Premium Hotels in Southeast Asia", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "type" : "LIST", "typeIdentifier" : "7a0c5d9e-2f6b-4c1a-8e4d-3b9f1a0c6d52", "zoomable" : true } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/items/{inventoryIdentifier}" : { "get" : { "tags" : [ "Card" ], "summary" : "Show", "description" : "Returns a single inventory card by its identifier, scoped to the owning managing entity. Responds 404 when no matching item is found. Requires MARKETING:READ.", "operationId" : "show-seller-inventory-item", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "AffiliateAccount identifier to retrieve item for", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "inventoryIdentifier", "in" : "path", "description" : "Retrieve inventory with this identifier", "required" : true, "schema" : { "type" : "string" }, "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "The requested sellable inventory item", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SellableItemLightweight_ManagingEntity" }, "example" : { "animate" : false, "animateDelay" : 800, "channelInventoryIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "channelInventoryType" : "GUEST_ROOM", "customizationIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "displayType" : "NATIVE", "identifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "inventoryStatus" : "ACTIVE", "inventoryType" : "HOTEL", "keywords" : [ "luxury-accommodation" ], "multimedias" : [ { "angle" : null, "attribution" : [ ], "category" : "2", "descriptions" : [ { "description" : "Elegant lobby of The Siam Residences", "language" : "en", "title" : "Lobby Entrance" } ], "height" : 1600, "identifier" : "the-siam-residences/lobby-entrance", "isLandscape" : true, "lifestyleType" : null, "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "source" : "CLOUDINARY", "type" : "IMAGE", "width" : 2560 } ], "name" : "Deluxe Room with Spa Access", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "sort" : "POPULARITY", "status" : "ACTIVE", "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] }, "put" : { "tags" : [ "Card" ], "summary" : "Update", "description" : "Updates an existing inventory card identified by its inventory identifier for the given managing entity. Requires MARKETING:WRITE on the account.", "operationId" : "update-seller-inventory-item", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "AffiliateAccount identifier to update item for", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "inventoryIdentifier", "in" : "path", "description" : "Update inventory with this identifier", "required" : true, "schema" : { "type" : "string" }, "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Updated inventory card definition with revised display details, media, and channel configuration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpsertSellableItemRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Updated sellable inventory item", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SellableItemLightweight_ManagingEntity" }, "example" : { "animate" : false, "animateDelay" : 800, "channelInventoryIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "channelInventoryType" : "GUEST_ROOM", "customizationIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "displayType" : "NATIVE", "identifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "inventoryStatus" : "ACTIVE", "inventoryType" : "HOTEL", "keywords" : [ "luxury-accommodation" ], "multimedias" : [ { "angle" : null, "attribution" : [ ], "category" : "2", "descriptions" : [ { "description" : "Elegant lobby of The Siam Residences", "language" : "en", "title" : "Lobby Entrance" } ], "height" : 1600, "identifier" : "the-siam-residences/lobby-entrance", "isLandscape" : true, "lifestyleType" : null, "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "source" : "CLOUDINARY", "type" : "IMAGE", "width" : 2560 } ], "name" : "Deluxe Room with Spa Access", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "sort" : "POPULARITY", "status" : "ACTIVE", "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] }, "delete" : { "tags" : [ "Card" ], "summary" : "Delete", "description" : "Permanently removes an inventory card by its identifier from the given managing entity. Requires MARKETING:WRITE on the account.", "operationId" : "remove-seller-inventory-item", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "AffiliateAccount identifier to delete item from", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "inventoryIdentifier", "in" : "path", "description" : "Delete inventory with this identifier", "required" : true, "schema" : { "type" : "string" }, "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "The sellable inventory item that was permanently deleted", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SellableItemLightweight_ManagingEntity" }, "example" : { "animate" : false, "animateDelay" : 800, "channelInventoryIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "channelInventoryType" : "GUEST_ROOM", "customizationIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "displayType" : "NATIVE", "identifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "inventoryStatus" : "ACTIVE", "inventoryType" : "HOTEL", "keywords" : [ "luxury-accommodation" ], "multimedias" : [ { "angle" : null, "attribution" : [ ], "category" : "2", "descriptions" : [ { "description" : "Elegant lobby of The Siam Residences", "language" : "en", "title" : "Lobby Entrance" } ], "height" : 1600, "identifier" : "the-siam-residences/lobby-entrance", "isLandscape" : true, "lifestyleType" : null, "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "source" : "CLOUDINARY", "type" : "IMAGE", "width" : 2560 } ], "name" : "Deluxe Room with Spa Access", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "sort" : "POPULARITY", "status" : "ACTIVE", "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/grids/{listIdentifier}" : { "get" : { "tags" : [ "Grid" ], "summary" : "Show", "description" : "Retrieves a single curated or saved-search grid by its identifier, scoped to the owning managing entity; returns 404 if not found.", "operationId" : "show-seller-inventory-list", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier that owns the grid.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "listIdentifier", "in" : "path", "description" : "Grid identifier to retrieve.", "required" : true, "schema" : { "type" : "string" }, "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "The curated or saved-search grid matching the given identifier.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SellableListLightweight_ManagingEntity" }, "example" : { "animate" : false, "animateDelay" : 500, "createdDate" : "2026-01-14T09:30:00", "customizationIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "displayType" : "NATIVE", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "keywords" : [ "bangkok", "luxury" ], "lastUpdate" : "2026-02-03T16:45:12", "listIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "listType" : "LIST", "name" : "Luxury Bangkok Properties", "sellerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "sort" : "MEMBER", "status" : "ACTIVE", "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] }, "put" : { "tags" : [ "Grid" ], "summary" : "Update", "description" : "Updates the identified curated or saved-search grid owned by the managing entity with the values in the request body. Returns the updated grid.", "operationId" : "update-seller-inventory-list", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier that owns the grid.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "listIdentifier", "in" : "path", "description" : "Grid identifier to update.", "required" : true, "schema" : { "type" : "string" }, "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Updated grid definition with revised name, display settings, or inventory/search configuration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpsertSellableListRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "The curated or saved-search grid after applying the requested updates.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SellableListLightweight_ManagingEntity" }, "example" : { "animate" : false, "animateDelay" : 500, "createdDate" : "2026-01-14T09:30:00", "customizationIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "displayType" : "NATIVE", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "keywords" : [ "bangkok", "luxury" ], "lastUpdate" : "2026-02-03T16:45:12", "listIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "listType" : "LIST", "name" : "Luxury Bangkok Properties", "sellerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "sort" : "MEMBER", "status" : "ACTIVE", "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] }, "delete" : { "tags" : [ "Grid" ], "summary" : "Delete", "description" : "Permanently removes the identified curated or saved-search grid belonging to the managing entity. Returns the deleted grid.", "operationId" : "remove-seller-inventory-list", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier that owns the grid.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "listIdentifier", "in" : "path", "description" : "Grid identifier to delete.", "required" : true, "schema" : { "type" : "string" }, "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "The curated or saved-search grid that was permanently removed.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SellableListLightweight_ManagingEntity" }, "example" : { "animate" : false, "animateDelay" : 500, "createdDate" : "2026-01-14T09:30:00", "customizationIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "displayType" : "NATIVE", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "keywords" : [ "bangkok", "luxury" ], "lastUpdate" : "2026-02-03T16:45:12", "listIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "listType" : "LIST", "name" : "Luxury Bangkok Properties", "sellerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "sort" : "MEMBER", "status" : "ACTIVE", "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/static-list" : { "get" : { "tags" : [ "Curated List" ], "summary" : "Show all", "description" : "Retrieve every list owned by the managing entity, optionally hydrating each one with its inventory items.", "operationId" : "show-curated-lists", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Show curated lists owned by this owner identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "withItems", "in" : "query", "description" : "Indicate whether to include all the list items in the result", "required" : false, "schema" : { "type" : "boolean", "default" : false }, "example" : false }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "All curated lists owned by the managing entity", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/StaticListWrapper_ManagingEntity" } }, "example" : [ { "items" : [ ], "list" : { "enabled" : true, "id" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "managingEntityIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "name" : "Top Hotels in Bangkok" } } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] }, "post" : { "tags" : [ "Curated List" ], "summary" : "Create", "description" : "Create a new list and seed it with the inventory item supplied in the request.", "operationId" : "create-curated-list", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Create curated list owned by this owner identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "New list metadata together with the first inventory item to seed the list with", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateStaticListAndAddItemRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Newly created curated list with its seeded inventory items", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StaticListWrapper_ManagingEntity" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/dynamic-list" : { "get" : { "tags" : [ "Saved Search" ], "summary" : "List", "description" : "Returns every saved search owned by the managing entity.", "operationId" : "show-saved-searches", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "List searches owned by this managing entity.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "List of saved searches for the managing entity.", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DynamicListLightweight_ManagingEntity" } }, "example" : [ { "aggregateReviewRating" : 8, "architecturalStyles" : 50, "cities" : [ "1609350" ], "continents" : [ "AS" ], "countries" : [ "1605651" ], "createdDate" : "2026-01-14T09:30:00", "hotelCategories" : 1, "hotelStars" : 5, "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "inventoryName" : "Deluxe Suite", "inventoryTypes" : [ "GUEST_ROOM" ], "lastUpdate" : "2026-02-03T16:45:12", "lifestyles" : "LIFESTYLE_RELAX", "locationCategories" : 1701, "name" : "Bangkok Luxury Hotels", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "primaryOrderBy" : "4", "propertyName" : "The Siam", "radiusInMeters" : 5000, "segmentCategories" : 7, "showChildFriendly" : false, "showDirectOnly" : false, "showEcoFriendly" : false, "showPetFriendly" : false, "showPopular" : false, "version" : 3 } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] }, "post" : { "tags" : [ "Saved Search" ], "summary" : "Create", "description" : "Creates a new saved search whose filters resolve to a live list of suppliers/inventory when queried.", "operationId" : "create-saved-search", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Create search owned by this managing entity.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Dynamic list definition including filter criteria, sorting rules and display settings", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpsertDynamicListRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Saved search created successfully.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DynamicListLightweight_ManagingEntity" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/supplier/{supplierManagingEntityIdentifier}" : { "get" : { "tags" : [ "Available Suppliers" ], "summary" : "Get supplier details", "description" : "Retrieve complete details for a specific supplier, including property information, location, ratings, amenities, and availability metrics.", "operationId" : "show-supplier", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Unique identifier of the managing entity (account) making the request.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "supplierManagingEntityIdentifier", "in" : "path", "description" : "Unique identifier of the supplier (property) to retrieve.", "required" : true, "schema" : { "type" : "string" }, "example" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PropertyAggregateLightweight_ManagingEntity" }, "example" : { "activities" : 3, "addOns" : 5, "address" : { "city" : "Bangkok", "countryCode" : "TH", "line1" : "3/2 Khao Road", "postalCode" : "10300", "state" : "Bangkok" }, "aggregateGreendexRating" : 7.0, "aggregateReviewRating" : 8.7, "architecturalStyle" : "7", "attractions" : 5, "available" : true, "bookings" : 6054, "brand" : "The Siam Residences", "chain" : "The Siam Collection", "currencyCode" : "THB", "descriptions" : [ { "description" : "An elegant riverside sanctuary in the heart of Bangkok.", "language" : "en", "title" : "Luxury Riverside Retreat" } ], "hotelAmenityCodes" : [ "1", "7" ], "hotelCategory" : "45", "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "images" : [ { "identifier" : "the-siam-residences/lobby-entrance", "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "type" : "IMAGE" } ], "lifestyleTypes" : [ "LIFESTYLE_HEALTH_FITNESS" ], "localName" : "เดอะสยาม เรสซิเดนซ์", "location" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "Point" }, "locationCategory" : "34", "meetingRooms" : 2, "name" : "The Siam Residences, Bangkok", "numberOfRooms" : 32, "places" : 9, "propertyAccessibilityCodes" : [ "1" ], "propertySecurityCodes" : [ "7" ], "reservations" : { "email" : "reservations@thesiamresidences.com", "firstName" : "Somchai", "lastName" : "Phattanapong", "phone" : "+66-2-123-4567" }, "restaurants" : 2, "score" : 70, "segmentCategory" : "7", "socials" : [ { "handle" : "thesiamresidences", "platform" : "INSTAGRAM" } ], "spas" : 1, "starRating" : 5, "thirdPartyReviews" : [ ], "totalReviews" : 989, "uniqueId" : "siam-residences-bkk", "urlName" : "the-siam-residences-bangkok-thailand", "videos" : [ ], "whenBuilt" : "1927" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/supplier/list" : { "get" : { "tags" : [ "Available Suppliers" ], "summary" : "List recently added suppliers", "description" : "Retrieve a paginated list of the most recently added suppliers. Useful for discovering new properties. Limited to 100 entries per request.", "operationId" : "show-latest-supplier", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Unique identifier of the managing entity (account) viewing suppliers.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "page", "in" : "query", "description" : "Zero-based page number for pagination.", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 0 }, "example" : 0 }, { "name" : "size", "in" : "query", "description" : "Number of results per page (max 100).", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 20, "maximum" : 100 }, "example" : 20 }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PropertyAggregateLightweight_ManagingEntity" } }, "example" : [ { "activities" : 3, "addOns" : 5, "address" : { "city" : "Bangkok", "countryCode" : "TH", "line1" : "3/2 Khao Road", "postalCode" : "10300", "state" : "Bangkok" }, "aggregateGreendexRating" : 7.0, "aggregateReviewRating" : 8.7, "architecturalStyle" : "7", "attractions" : 5, "available" : true, "bookings" : 6054, "brand" : "The Siam Residences", "chain" : "The Siam Collection", "currencyCode" : "THB", "descriptions" : [ { "description" : "An elegant riverside sanctuary in the heart of Bangkok.", "language" : "en", "title" : "Luxury Riverside Retreat" } ], "hotelAmenityCodes" : [ "1", "7" ], "hotelCategory" : "45", "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "images" : [ { "identifier" : "the-siam-residences/lobby-entrance", "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "type" : "IMAGE" } ], "lifestyleTypes" : [ "LIFESTYLE_HEALTH_FITNESS" ], "localName" : "เดอะสยาม เรสซิเดนซ์", "location" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "Point" }, "locationCategory" : "34", "meetingRooms" : 2, "name" : "The Siam Residences, Bangkok", "numberOfRooms" : 32, "places" : 9, "propertyAccessibilityCodes" : [ "1" ], "propertySecurityCodes" : [ "7" ], "reservations" : { "email" : "reservations@thesiamresidences.com", "firstName" : "Somchai", "lastName" : "Phattanapong", "phone" : "+66-2-123-4567" }, "restaurants" : 2, "score" : 70, "segmentCategory" : "7", "socials" : [ { "handle" : "thesiamresidences", "platform" : "INSTAGRAM" } ], "spas" : 1, "starRating" : 5, "thirdPartyReviews" : [ ], "totalReviews" : 989, "uniqueId" : "siam-residences-bkk", "urlName" : "the-siam-residences-bangkok-thailand", "videos" : [ ], "whenBuilt" : "1927" } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/supplier/country/list" : { "get" : { "tags" : [ "Available Suppliers" ], "summary" : "List supplier countries", "description" : "Retrieve a list of distinct countries where active suppliers are located. Useful for geographic filtering and market exploration.", "operationId" : "show-unique-country-list", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Unique identifier of the managing entity (account) making the request.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/KeyValuePair_ManagingEntity" } }, "example" : [ { "label" : "Hotel & Resort", "value" : "HOTEL" } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/supplier/city/list" : { "get" : { "tags" : [ "Available Suppliers" ], "summary" : "List supplier cities", "description" : "Retrieve a list of distinct cities where active suppliers are located. Useful for geographic filtering in the supplier browser.", "operationId" : "show-unique-city-list", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Unique identifier of the managing entity (account) making the request.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/KeyValuePair_ManagingEntity" } }, "example" : [ { "label" : "Hotel & Resort", "value" : "HOTEL" } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/shareable-link/supplier/list" : { "get" : { "tags" : [ "Link: Supplier" ], "summary" : "Show all", "description" : "Retrieves all shareable supplier links owned by the specified managing entity. Each link is a unique, shareable URL with OpenGraph metadata and customization settings.", "operationId" : "show-supplier-urls", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier (the owner of the shareable links)", "required" : true, "schema" : { "type" : "string" }, "example" : "d2c8f3a9-4b1e-4c7a-9d3f-5b8a2e6c1d04" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successfully retrieved the list of shareable supplier links for the managing entity", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SellableSupplierUrlLightweight_ManagingEntity" } }, "example" : [ { "animate" : false, "animateDelay" : 500, "createdDate" : "2026-01-14T09:30:00", "customizationIdentifier" : "8f2d4a9c-1e7b-4f3d-a5c8-9d1b6e2c0a47", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "facebookAppId" : "198273987219", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "keywords" : [ "luxury" ], "lastUpdate" : "2026-02-03T16:45:12", "multimedias" : [ { "angle" : null, "attribution" : [ ], "category" : "2", "descriptions" : [ { "description" : "Elegant lobby of The Siam Residences", "language" : "en", "title" : "Lobby Entrance" } ], "height" : 1600, "identifier" : "the-siam-residences/lobby-entrance", "isLandscape" : true, "lifestyleType" : null, "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "source" : "CLOUDINARY", "type" : "IMAGE", "width" : 2560 } ], "name" : "The Siam Residences, Bangkok", "ownerIdentifier" : "d2c8f3a9-4b1e-4c7a-9d3f-5b8a2e6c1d04", "supplierIdentifier" : "7c9a2e5f-3d8b-4a1c-b6e2-8f0d1c4a9b3e", "twitterAccount" : "@thesiamresidences", "uniqueId" : "HBDG87f2", "userIdentifier" : "4a1d7c2e-5f9b-4e3a-b8c1-6d2f8a0e3c5b", "version" : 3 } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/shareable-link/inventory/{channelInventoryIdentifier}/media/list" : { "get" : { "tags" : [ "Link: Inventory" ], "summary" : "Available media", "description" : "Returns the media (images and other assets) associated with the given channel inventory identifier, available for use when composing a shareable link. Users can chosoe from property and inventory media to construct an inventory link.", "operationId" : "show-inventory-media", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier that owns the inventory", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "channelInventoryIdentifier", "in" : "path", "description" : "Channel inventory identifier whose media should be listed", "required" : true, "schema" : { "type" : "string" }, "example" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "List of media items (images and assets) available for the given channel inventory, for use when composing a shareable link", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SimpleMultimedia_ManagingEntity" } }, "example" : [ { "angle" : null, "attribution" : [ ], "category" : "2", "descriptions" : [ { "description" : "Elegant lobby of The Siam Residences", "language" : "en", "title" : "Lobby Entrance" } ], "height" : 1600, "identifier" : "the-siam-residences/lobby-entrance", "isLandscape" : true, "lifestyleType" : null, "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "source" : "CLOUDINARY", "type" : "IMAGE", "width" : 2560 } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/shareable-link/inventory/list" : { "get" : { "tags" : [ "Link: Inventory" ], "summary" : "Show all", "description" : "Lists all shareable inventory links owned by the given managing entity, including their OpenGraph metadata for social sharing.", "operationId" : "show-seller-urls", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier that owns the shareable links", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "List of shareable inventory links with OpenGraph metadata owned by the managing entity", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SellableInventoryUrlLightweight_ManagingEntity" } }, "example" : [ { "animate" : true, "animateDelay" : 1000, "channelInventoryIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "channelInventoryType" : "GUEST_ROOM", "createdDate" : "2026-01-14T09:30:00", "customizationIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "facebookAppId" : "19827398721938798237", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "inventoryStatus" : "ACTIVE", "inventoryType" : "GUEST_ROOM", "keywords" : [ "bali" ], "lastUpdate" : "2026-02-03T16:45:12", "multimedias" : [ { "angle" : null, "attribution" : [ ], "category" : "2", "descriptions" : [ { "description" : "Elegant lobby of The Siam Residences", "language" : "en", "title" : "Lobby Entrance" } ], "height" : 1600, "identifier" : "the-siam-residences/lobby-entrance", "isLandscape" : true, "lifestyleType" : null, "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "source" : "CLOUDINARY", "type" : "IMAGE", "width" : 2560 } ], "name" : "My Bali Villa", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "status" : "ACTIVE", "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "theme" : "THEME_1", "transactionalItemIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "twitterAccount" : "@travelikoworld", "uniqueId" : "HBDG87f2", "userIdentifier" : "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "version" : 3 } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/sales-channel/supplier/{supplierManagingEntityIdentifier}" : { "get" : { "tags" : [ "Sales Channel" ], "summary" : "Show", "description" : "Loads the single sales channel linking the affiliate to the given supplier, or 404 if none exists.", "operationId" : "show-sales-channel", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Affiliate/managing entity identifier", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "supplierManagingEntityIdentifier", "in" : "path", "description" : "Supplier/property identifier", "required" : true, "schema" : { "type" : "string" }, "example" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "The sales channel linking this affiliate to the specified supplier", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SalesChannelLightweight_ManagingEntity" }, "example" : { "blacklisted" : false, "channelDisabled" : false, "commission" : 0.2, "createdDate" : "2026-01-14T09:30:00", "enabled" : true, "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "lastUpdate" : "2026-02-03T16:45:12", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "ownerName" : "The Siam Residences", "percentDiscount" : 0.15, "rateModifierBundles" : [ { "aggregatedItemDescriptions" : [ { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" } ], "createdDate" : "2026-01-14T09:30:00", "descriptions" : [ { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" } ], "effectiveDescriptions" : [ { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" } ], "enabled" : true, "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "items" : [ { "addOnIdentifiers" : [ "880e8400-e29b-41d4-a716-446655440333" ], "blackoutDates" : [ { "effectiveDate" : "2026-04-13", "expireDate" : "2026-04-15" } ], "cityRateQualifiers" : [ { "city" : { "countryCode" : "TH", "geoNameId" : "1609350", "latitude" : 13.7563, "longitude" : 100.5018, "name" : "Bangkok" } } ], "continentRateQualifiers" : [ { "continent" : "NA" } ], "countryRateQualifiers" : [ { "country" : { "continentCode" : "AS", "geoNameId" : "1609350", "isoAlpha2" : "TH", "isoAlpha3" : "THA", "name" : "Thailand" } } ], "createdDate" : "2026-01-14T09:30:00", "descriptions" : [ { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" } ], "enabled" : true, "geoLocationRateQualifiers" : [ { "latitude" : 13.7563, "longitude" : 100.5018, "radiusInKilometers" : 50 } ], "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "ipRangeRateQualifiers" : [ { "endIPRange" : "192.168.1.255", "startIPRange" : "192.168.1.0" } ], "lastUpdate" : "2026-02-03T16:45:12", "masterRateIdentifiers" : [ "770e8400-e29b-41d4-a716-446655440222" ], "name" : "Early bird", "pricingType" : "PER_PERSON_PER_NIGHT", "promotionRateQualifiers" : [ { "promotion" : "EARLYBIRD2026" } ], "ratePlanIdentifiers" : [ "990e8400-e29b-41d4-a716-446655440444" ], "sellDateRateQualifiers" : [ { "effectiveDate" : "2026-05-01", "expireDate" : "2026-08-31" } ], "stayDateRateQualifiers" : [ { "effectiveDate" : "2026-06-01", "expireDate" : "2026-08-31" } ], "timezoneRateQualifiers" : [ { "timezone" : "Asia/Bangkok" } ], "type" : "DISCOUNT", "version" : 3 } ], "lastUpdate" : "2026-02-03T16:45:12", "name" : "Early bird - Long Term", "pricingType" : "PER_NIGHT", "type" : "DISCOUNT", "version" : 3 } ], "rateModifiers" : [ { "addOnIdentifiers" : [ "880e8400-e29b-41d4-a716-446655440333" ], "blackoutDates" : [ { "effectiveDate" : "2026-04-13", "expireDate" : "2026-04-15" } ], "cityRateQualifiers" : [ { "city" : { "countryCode" : "TH", "geoNameId" : "1609350", "latitude" : 13.7563, "longitude" : 100.5018, "name" : "Bangkok" } } ], "continentRateQualifiers" : [ { "continent" : "NA" } ], "countryRateQualifiers" : [ { "country" : { "continentCode" : "AS", "geoNameId" : "1609350", "isoAlpha2" : "TH", "isoAlpha3" : "THA", "name" : "Thailand" } } ], "createdDate" : "2026-01-14T09:30:00", "descriptions" : [ { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" } ], "enabled" : true, "geoLocationRateQualifiers" : [ { "latitude" : 13.7563, "longitude" : 100.5018, "radiusInKilometers" : 50 } ], "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "ipRangeRateQualifiers" : [ { "endIPRange" : "192.168.1.255", "startIPRange" : "192.168.1.0" } ], "lastUpdate" : "2026-02-03T16:45:12", "masterRateIdentifiers" : [ "770e8400-e29b-41d4-a716-446655440222" ], "name" : "Early bird", "pricingType" : "PER_PERSON_PER_NIGHT", "promotionRateQualifiers" : [ { "promotion" : "EARLYBIRD2026" } ], "ratePlanIdentifiers" : [ "990e8400-e29b-41d4-a716-446655440444" ], "sellDateRateQualifiers" : [ { "effectiveDate" : "2026-05-01", "expireDate" : "2026-08-31" } ], "stayDateRateQualifiers" : [ { "effectiveDate" : "2026-06-01", "expireDate" : "2026-08-31" } ], "timezoneRateQualifiers" : [ { "timezone" : "Asia/Bangkok" } ], "type" : "DISCOUNT", "version" : 3 } ], "selfAcquires" : false, "subType" : "DIRECT", "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "supplierName" : "The Siam Residences, Bangkok", "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/sales-channel/request/{salesChannelRequestIdentifier}/re-apply" : { "get" : { "tags" : [ "Connect with supplier" ], "summary" : "Re-apply", "description" : "Re-submits a previously rejected relationship request; permitted only once the 90-day cool-off period has elapsed.", "operationId" : "re-apply-supplier-request", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Re-apply relationship request owned by this company identifier", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "salesChannelRequestIdentifier", "in" : "path", "description" : "Re-apply relationship request with this identifier", "required" : true, "schema" : { "type" : "string" }, "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "The re-applied sales channel relationship request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SalesChannelRequestLightweight" }, "example" : { "createdDate" : "2026-01-14T09:30:00", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "introductoryMessage" : "We represent a travel agency network with strong demand for your properties and would like to establish a partnership to offer exclusive rates to our members.", "lastUpdate" : "2026-02-03T16:45:12", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "ownerName" : "The Siam Residences", "requestType" : "DIRECT_CONNECTION", "status" : "REQUESTING", "subType" : "APPLICATION", "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "supplierName" : "The Siam Residences, Bangkok", "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/sales-channel/request/supplier/{supplierManagingEntityIdentifier}" : { "get" : { "tags" : [ "Connect with supplier" ], "summary" : "Show by supplier", "description" : "Returns the single relationship request between the given company and a specific supplier managing entity.", "operationId" : "show-supplier-request", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Show property request for this company identifier", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "supplierManagingEntityIdentifier", "in" : "path", "description" : "Show property request for this supplier identifier", "required" : true, "schema" : { "type" : "string" }, "example" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "The sales channel relationship request between the company and the specified supplier", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SalesChannelRequestLightweight" }, "example" : { "createdDate" : "2026-01-14T09:30:00", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "introductoryMessage" : "We represent a travel agency network with strong demand for your properties and would like to establish a partnership to offer exclusive rates to our members.", "lastUpdate" : "2026-02-03T16:45:12", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "ownerName" : "The Siam Residences", "requestType" : "DIRECT_CONNECTION", "status" : "REQUESTING", "subType" : "APPLICATION", "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "supplierName" : "The Siam Residences, Bangkok", "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/sales-channel/request/list" : { "get" : { "tags" : [ "Connect with supplier" ], "summary" : "List", "description" : "Returns all sales-channel relationship requests owned by the given company, across every supplier.", "operationId" : "show-supplier-requests", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Show all property requests for this company identifier", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "List of all sales channel relationship requests initiated by the company", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SalesChannelRequestLightweight_ManagingEntity" } }, "example" : [ { "createdDate" : "2026-01-14T09:30:00", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "introductoryMessage" : "We represent a travel agency network with strong demand for your properties and would like to establish a partnership to offer exclusive rates to our members.", "lastUpdate" : "2026-02-03T16:45:12", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "ownerName" : "The Siam Residences", "requestType" : "DIRECT_CONNECTION", "status" : "REQUESTING", "subType" : "APPLICATION", "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "supplierName" : "The Siam Residences, Bangkok", "version" : 3 } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/ranked-grids/list" : { "get" : { "tags" : [ "Ranked Grid" ], "summary" : "Show all", "description" : "Returns every ranked grid owned by the given managing entity. Requires MARKETING:READ permission.", "operationId" : "show-seller-inventory-ranked-lists", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "All ranked grids belonging to the managing entity, possibly empty", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SellableRankedListLightweight_ManagingEntity" } }, "example" : [ { "animate" : false, "animateDelay" : 500, "createdDate" : "2026-01-14T09:30:00", "customizationIdentifier" : "7d2e4f1a-6c8b-4a9e-b3d5-1e7f2a0c5b8d", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "displayType" : "NATIVE", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "keywords" : [ "luxury" ], "lastUpdate" : "2026-02-03T16:45:12", "lookup" : { "cityName" : "Bangkok", "countryCode" : "TH", "countryName" : "Thailand", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "languageCode" : "en", "location" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "Point" }, "name" : "The Siam Residences", "ownerName" : "The Siam Residences", "subCountryName" : "Bangkok", "subSubCountryName" : "Khlong San District", "type" : "HOTEL", "typeIdentifier" : "a1f3c9d2-7e4b-4a0c-8d5e-2b9f1a6c3e78", "urlName" : "the-siam-residences-bangkok-thailand" }, "name" : "Featured Luxury Resorts Bangkok", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "sort" : "MEMBER", "status" : "ACTIVE", "version" : 3 } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/map/markers/{listType}/{listIdentifier}" : { "get" : { "tags" : [ "Map" ], "summary" : "Show markers", "description" : "Retrieve all inventory markers for a curated list or dynamic search, priced in the requested currency.", "operationId" : "show-inventory-map-map-markers", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "UUID of the managing entity that owns the list.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "listIdentifier", "in" : "path", "description" : "UUID of the curated list or dynamic search.", "required" : true, "schema" : { "type" : "string" }, "example" : "9b7e4c3a-1f6d-4e8a-b2f9-5d3c0a8e7b61" }, { "name" : "listType", "in" : "path", "description" : "Type of list: LIST (curated) or SEARCH (dynamic filter).", "required" : true, "schema" : { "type" : "string", "description" : "Presentation mode for a list-based sellable inventory", "enum" : [ "LIST", "SEARCH" ] }, "example" : "LIST" }, { "name" : "displayCurrency", "in" : "query", "description" : "ISO 4217 currency code for pricing display.", "required" : false, "schema" : { "type" : "string", "default" : "USD" }, "example" : "USD" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Inventory markers for the specified curated list or dynamic search", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/InventoryMapMarker_ManagingEntity" } }, "example" : [ { "channelInventoryIdentifier" : "7a0c5d9e-2f6b-4c1a-8e4d-3b9f1a0c6d52", "inventoryIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "inventoryName" : "Deluxe Ocean View Suite", "inventoryType" : "GUEST_ROOM", "lowestDisplayPrice" : { "amount" : 4500.0, "currency" : "THB" }, "point" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "Point" }, "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "supplierName" : "The Siam Residences" } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/map/marker/{channelInventoryIdentifier}" : { "get" : { "tags" : [ "Map" ], "summary" : "Show marker", "description" : "Retrieve the map marker for a specific channel inventory item.", "operationId" : "show-inventory-map-map-marker", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "UUID of the managing entity that owns the inventory.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "channelInventoryIdentifier", "in" : "path", "description" : "UUID of the channel inventory item to display as a marker.", "required" : true, "schema" : { "type" : "string" }, "example" : "9b7e4c3a-1f6d-4e8a-b2f9-5d3c0a8e7b61" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Map marker for the specified channel inventory item", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InventoryMapMarker_ManagingEntity" }, "example" : { "channelInventoryIdentifier" : "7a0c5d9e-2f6b-4c1a-8e4d-3b9f1a0c6d52", "inventoryIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "inventoryName" : "Deluxe Ocean View Suite", "inventoryType" : "GUEST_ROOM", "lowestDisplayPrice" : { "amount" : 4500.0, "currency" : "THB" }, "point" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "Point" }, "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "supplierName" : "The Siam Residences" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/map/list" : { "get" : { "tags" : [ "Map" ], "summary" : "Show all", "description" : "Retrieve all map configurations owned by the specified managing entity.", "operationId" : "show-inventory-maps", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "UUID of the managing entity that owns the maps.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Map configurations owned by the managing entity", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/InventoryMapLightweight_ManagingEntity" } }, "example" : [ { "center" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "Point" }, "circles" : [ { "radius" : 2.5 } ], "customizationIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "displayType" : "NATIVE", "draggable" : true, "identifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "initialZoomLevel" : 15, "mapHeight" : 500, "mapMarkerColor" : "cc2138", "mapStyle" : "normal", "name" : "Premium Hotels in Southeast Asia", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "type" : "LIST", "typeIdentifier" : "7a0c5d9e-2f6b-4c1a-8e4d-3b9f1a0c6d52", "zoomable" : true } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/items/list" : { "get" : { "tags" : [ "Card" ], "summary" : "Show all", "description" : "Returns every sellable inventory item owned by the given managing entity. Requires MARKETING:READ on the account.", "operationId" : "show-seller-inventory-items-for-company", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "AffiliateAccount identifier to retrieve items for", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "All sellable inventory items owned by the managing entity", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SellableItemLightweight_ManagingEntity" } }, "example" : [ { "animate" : false, "animateDelay" : 800, "channelInventoryIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "channelInventoryType" : "GUEST_ROOM", "customizationIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "displayType" : "NATIVE", "identifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "inventoryStatus" : "ACTIVE", "inventoryType" : "HOTEL", "keywords" : [ "luxury-accommodation" ], "multimedias" : [ { "angle" : null, "attribution" : [ ], "category" : "2", "descriptions" : [ { "description" : "Elegant lobby of The Siam Residences", "language" : "en", "title" : "Lobby Entrance" } ], "height" : 1600, "identifier" : "the-siam-residences/lobby-entrance", "isLandscape" : true, "lifestyleType" : null, "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "source" : "CLOUDINARY", "type" : "IMAGE", "width" : 2560 } ], "name" : "Deluxe Room with Spa Access", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "sort" : "POPULARITY", "status" : "ACTIVE", "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18" } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/items/inventory/{channelInventoryIdentifier}/media/list" : { "get" : { "tags" : [ "Card" ], "summary" : "Available card media", "description" : "Returns all media assets associated with the given channel inventory identifier. Requires MARKETING:READ on the account.", "operationId" : "show-inventory-media_1", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "AffiliateAccount identifier to retrieve items for", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "channelInventoryIdentifier", "in" : "path", "description" : "Retrieve media for this channel inventory identifier", "required" : true, "schema" : { "type" : "string" }, "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "All media assets associated with the channel inventory item", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SimpleMultimedia_ManagingEntity" } }, "example" : [ { "angle" : null, "attribution" : [ ], "category" : "2", "descriptions" : [ { "description" : "Elegant lobby of The Siam Residences", "language" : "en", "title" : "Lobby Entrance" } ], "height" : 1600, "identifier" : "the-siam-residences/lobby-entrance", "isLandscape" : true, "lifestyleType" : null, "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "source" : "CLOUDINARY", "type" : "IMAGE", "width" : 2560 } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/grids/list" : { "get" : { "tags" : [ "Grid" ], "summary" : "Show all", "description" : "Lists all curated and saved-search grids owned by the managing entity.", "operationId" : "show-seller-inventory-lists", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier that owns the grids.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "All curated and saved-search grids belonging to the managing entity.", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SellableListLightweight_ManagingEntity" } }, "example" : [ { "animate" : false, "animateDelay" : 500, "createdDate" : "2026-01-14T09:30:00", "customizationIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "displayType" : "NATIVE", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "keywords" : [ "bangkok", "luxury" ], "lastUpdate" : "2026-02-03T16:45:12", "listIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "listType" : "LIST", "name" : "Luxury Bangkok Properties", "sellerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "sort" : "MEMBER", "status" : "ACTIVE", "version" : 3 } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/embeddable-inventory/list" : { "get" : { "tags" : [ "Catalog" ], "summary" : "Show consumable", "description" : "Lists the managing entity's campaign inventory that can be rendered by Wink Web Components.", "operationId" : "show-embeddable-inventory", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Show campaigns for this company", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CampaignInventory_ManagingEntity" } }, "example" : [ { "id" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "layout" : "HOTEL", "name" : "The Siam Residences – Deluxe Pool Villa", "placeholderImageUrl" : "https://res.cloudinary.com/traveliko/image/upload/v1619343662/wp/grey-card.svg" } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/browse/supplier/{supplierManagingEntityIdentifier}/sales-channel/{salesChannelIdentifier}" : { "get" : { "tags" : [ "Browse: Supplier" ], "summary" : "Show", "description" : "Loads a single supplier's aggregate details for a given sales channel, priced in the requested display currency.", "operationId" : "show-inventory-supplier", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Browse inventory supplier on behalf of this owner identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "owner-1" }, { "name" : "supplierManagingEntityIdentifier", "in" : "path", "description" : "Browse inventory supplier on behalf of this supplier identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "supplier-1" }, { "name" : "salesChannelIdentifier", "in" : "path", "description" : "Browse inventory supplier on behalf of this sales channel identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "sales-channel-1" }, { "name" : "displayCurrency", "in" : "query", "description" : "Indicate which currency to display prices in.", "required" : false, "schema" : { "type" : "string", "default" : "USD" }, "example" : "USD" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InventorySupplierAggregateLightweight_ManagingEntity" }, "example" : { "hotel" : { "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "name" : "The Siam Residences, Bangkok", "uniqueId" : "siam01", "urlName" : "the-siam-residences-bangkok" }, "lowestDisplayPrice" : { "amount" : 125.0, "currency" : "USD" }, "lowestPrice" : { "amount" : 4500.0, "currency" : "THB" }, "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" } } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/browse/supplier/list" : { "get" : { "tags" : [ "Browse: Supplier" ], "summary" : "Show latest", "description" : "Returns the most recently available inventory suppliers, paged and priced in the requested display currency.", "operationId" : "show-latest-inventory-supplier-list", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Browse inventory supplier on behalf of this owner identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "owner-1" }, { "name" : "page", "in" : "query", "description" : "Skip to page.", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 0 }, "example" : 0 }, { "name" : "size", "in" : "query", "description" : "Skip to page.", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 20, "maximum" : 100 }, "example" : 20 }, { "name" : "displayCurrency", "in" : "query", "description" : "Indicate which currency to display prices in.", "required" : false, "schema" : { "type" : "string", "default" : "USD" }, "example" : "USD" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/InventorySupplierAggregateLightweight_ManagingEntity" } }, "example" : [ { "hotel" : { "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "name" : "The Siam Residences, Bangkok", "uniqueId" : "siam01", "urlName" : "the-siam-residences-bangkok" }, "lowestDisplayPrice" : { "amount" : 125.0, "currency" : "USD" }, "lowestPrice" : { "amount" : 4500.0, "currency" : "THB" }, "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" } } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/browse/supplier/grid/{dynamicListIdentifier}" : { "get" : { "tags" : [ "Browse: Supplier" ], "summary" : "By saved search", "description" : "Returns a paginated supplier set produced by running a previously saved dynamic list, identified by its list identifier.", "operationId" : "show-dynamic-seller-inventory-by-id", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Browse inventory supplier on behalf of this owner identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "owner-1" }, { "name" : "dynamicListIdentifier", "in" : "path", "description" : "Browse inventory supplier on behalf of this dynamic list identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "dynamic-list-1" }, { "name" : "page", "in" : "query", "description" : "Skip to page.", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 0 }, "example" : 0 }, { "name" : "size", "in" : "query", "description" : "Skip to page.", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 20, "maximum" : 100 }, "example" : 20 }, { "name" : "displayCurrency", "in" : "query", "description" : "Indicate which currency to display prices in.", "required" : false, "schema" : { "type" : "string", "default" : "USD" }, "example" : "USD" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageResponseInventorySupplierAggregateLightweight_ManagingEntity" }, "example" : { "content" : [ { "hotel" : { "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "name" : "The Siam Residences, Bangkok", "uniqueId" : "siam01", "urlName" : "the-siam-residences-bangkok" }, "lowestDisplayPrice" : { "amount" : 125.0, "currency" : "USD" }, "lowestPrice" : { "amount" : 4500.0, "currency" : "THB" }, "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 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/browse/supplier/country/list" : { "get" : { "tags" : [ "Browse: Supplier" ], "summary" : "Available countries", "description" : "Returns the distinct countries covered by inventory the affiliate can browse.", "operationId" : "show-countries-for-inventory-supplier", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "List countries for inventory on behalf of this owner identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "owner-1" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/KeyValuePair_ManagingEntity" } }, "example" : [ { "label" : "Hotel & Resort", "value" : "HOTEL" } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/browse/supplier/continent/list" : { "get" : { "tags" : [ "Browse: Supplier" ], "summary" : "Available continents", "description" : "Returns the distinct continents covered by inventory the affiliate can browse.", "operationId" : "show-continent-for-inventory-supplier", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "List countries for inventory on behalf of this owner identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "owner-1" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/KeyValuePair_ManagingEntity" } }, "example" : [ { "label" : "Hotel & Resort", "value" : "HOTEL" } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/browse/supplier/city/list" : { "get" : { "tags" : [ "Browse: Supplier" ], "summary" : "Available cities", "description" : "Returns the distinct cities covered by inventory the affiliate can browse.", "operationId" : "show-cities-for-inventory", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "List cities for inventory on behalf of this owner identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "owner-1" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/KeyValuePair_ManagingEntity" } }, "example" : [ { "label" : "Hotel & Resort", "value" : "HOTEL" } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/browse/inventory/list" : { "get" : { "tags" : [ "Browse: Inventory" ], "summary" : "Show latest", "description" : "Returns the most recently published inventory available to the affiliate, priced in the requested currency.", "operationId" : "show-latest-inventory", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Browse inventory on behalf of this owner identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "owner-1" }, { "name" : "page", "in" : "query", "description" : "Skip to page.", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 0 }, "example" : 0 }, { "name" : "size", "in" : "query", "description" : "Skip to page.", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 20, "maximum" : 100 }, "example" : 20 }, { "name" : "displayCurrency", "in" : "query", "description" : "Indicate which currency to display prices in.", "required" : false, "schema" : { "type" : "string", "default" : "USD" }, "example" : "USD" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/InventoryAggregateLightweight_ManagingEntity" } }, "example" : [ { "address" : { "address1" : "20 Soi Ton Son", "address2" : null, "city" : "Bangkok", "countryCode" : "TH", "county" : null, "postalCode" : "10330", "state" : null }, "bookable" : true, "commissionable" : true, "createdDate" : "2026-01-14T09:30:00", "enabled" : true, "hotel" : { "currencyCode" : "THB", "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "name" : "The Siam Residences, Bangkok", "starRating" : "5", "uniqueId" : "siam01", "urlName" : "the-siam-residences-bangkok-thailand" }, "id" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "image" : { "descriptions" : [ { "description" : "Spacious city view room", "language" : "en", "title" : "Deluxe Room" } ], "identifier" : "the-siam-residences/deluxe-room-city-view", "isLandscape" : true, "multimediaIdentifier" : "9d4e2b7a-3f1c-4d5b-8a6e-2c0f9b3d1e47", "published" : true, "sort" : 1, "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.0, "currency" : "USD" }, "lowestPrice" : { "amount" : 4500.0, "currency" : "THB" }, "pricePoint" : "THREE", "quantity" : 24, "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" } } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/browse/inventory/grid/{dynamicListIdentifier}" : { "get" : { "tags" : [ "Browse: Inventory" ], "summary" : "By saved search", "description" : "Returns a paginated grid by replaying a previously saved dynamic list definition.", "operationId" : "show-dynamic-seller-inventory-by-id_1", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Browse inventory on behalf of this owner identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "owner-1" }, { "name" : "dynamicListIdentifier", "in" : "path", "description" : "Browse inventory on behalf of this dynamic list identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "dynamic-list-1" }, { "name" : "page", "in" : "query", "description" : "Skip to page.", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 0 }, "example" : 0 }, { "name" : "size", "in" : "query", "description" : "Limit the size of results.", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 20, "maximum" : 100 }, "example" : 20 }, { "name" : "displayCurrency", "in" : "query", "description" : "Indicate which currency to display prices in.", "required" : false, "schema" : { "type" : "string", "default" : "USD" }, "example" : "USD" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageResponseInventoryAggregateLightweight_ManagingEntity" }, "example" : { "content" : [ { "address" : { "address1" : "20 Soi Ton Son", "address2" : null, "city" : "Bangkok", "countryCode" : "TH", "county" : null, "postalCode" : "10330", "state" : null }, "bookable" : true, "commissionable" : true, "createdDate" : "2026-01-14T09:30:00", "enabled" : true, "hotel" : { "currencyCode" : "THB", "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "name" : "The Siam Residences, Bangkok", "starRating" : "5", "uniqueId" : "siam01", "urlName" : "the-siam-residences-bangkok-thailand" }, "id" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "image" : { "descriptions" : [ { "description" : "Spacious city view room", "language" : "en", "title" : "Deluxe Room" } ], "identifier" : "the-siam-residences/deluxe-room-city-view", "isLandscape" : true, "multimediaIdentifier" : "9d4e2b7a-3f1c-4d5b-8a6e-2c0f9b3d1e47", "published" : true, "sort" : 1, "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.0, "currency" : "USD" }, "lowestPrice" : { "amount" : 4500.0, "currency" : "THB" }, "pricePoint" : "THREE", "quantity" : 24, "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 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/browse/inventory/country/list" : { "get" : { "tags" : [ "Browse: Inventory" ], "summary" : "Available countries", "description" : "Lists the countries that have inventory available to this affiliate, for use as filter facets.", "operationId" : "show-countries-for-inventory", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "List countries for inventory on behalf of this owner identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "owner-1" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/KeyValuePair_ManagingEntity" } }, "example" : [ { "label" : "Hotel & Resort", "value" : "HOTEL" } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/browse/inventory/continent/list" : { "get" : { "tags" : [ "Browse: Inventory" ], "summary" : "Available continents", "description" : "Lists the continents that have inventory available to this affiliate, for use as filter facets.", "operationId" : "show-continents-for-inventory", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "List countries for inventory on behalf of this owner identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "owner-1" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/KeyValuePair_ManagingEntity" } }, "example" : [ { "label" : "Hotel & Resort", "value" : "HOTEL" } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/browse/inventory/city/list" : { "get" : { "tags" : [ "Browse: Inventory" ], "summary" : "Available cities", "description" : "Lists the cities that have inventory available to this affiliate, for use as filter facets.", "operationId" : "show-cities-for-inventory-for-affiliate", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "List cities for inventoryon behalf of this owner identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "owner-1" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/KeyValuePair_ManagingEntity" } }, "example" : [ { "label" : "Hotel & Resort", "value" : "HOTEL" } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/browse/category/list" : { "get" : { "tags" : [ "Catalog" ], "summary" : "Show all", "description" : "Lists the search categories present across the affiliate's active inventory, for use as browse facets.", "operationId" : "show-search-category-list", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "The property ID to list search categories for", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Search category facets derived from the affiliate's active inventory", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SearchCategory_ManagingEntity" } }, "example" : [ { "count" : 15, "identifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "key" : "GRE", "type" : "HOTEL", "value" : "GRE-001" } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/analytics/shares/list" : { "get" : { "tags" : [ "Analytics" ], "summary" : "Share trends", "description" : "Returns time-series line charts of share activity for the given managing entity; requires ANALYTICS:READ permission.", "operationId" : "show-share-analytics", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier (UUID)", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Time-series line charts of share activity for the managing entity", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LineChart_Authenticated_Entity" } }, "example" : [ { "identifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "legend" : { "data" : [ "Revenue", "Refunds" ] }, "series" : [ { "data" : [ 120000, 95000, 148000, 210000, 175000, 230000 ], "name" : "Revenue" }, { "data" : [ 5000, 3200, 7800, 4100, 6500, 2900 ], "name" : "Refunds" } ], "title" : { "text" : "Monthly Booking Revenue" }, "xAxis" : { "data" : [ "Jan", "Feb", "Mar", "Apr", "May", "Jun" ] } } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/analytics/shares/lifetime" : { "get" : { "tags" : [ "Analytics" ], "summary" : "Share lifetime totals", "description" : "Returns the aggregate, lifetime share metrics for the given managing entity; requires ANALYTICS:READ permission.", "operationId" : "show-aggregate-share-analytics", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier (UUID)", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Lifetime aggregate share metrics (views, clicks, shares) for the managing entity", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AggregateSharesProjection_Authenticated_Entity" }, "example" : { "clicks" : 387, "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "shares" : 52, "views" : 1420 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/booking/overview" : { "get" : { "tags" : [ "Analytics" ], "summary" : "Booking summary", "description" : "Returns aggregated sales metrics summarizing the affiliate company's current booking status, including confirmed, pending, and cancelled bookings.", "operationId" : "show-booking-overview", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Affiliate/company identifier (UUID)", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Aggregated booking overview for the affiliate company", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GroupedBookingSalesMetrics_SupplierDetails" }, "example" : { "averageBookingAmount" : 4511.9, "bookings" : 42, "currencyCode" : "THB", "totalPriceAmount" : 189500.0, "type" : "BY_PROPERTY", "typeIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "typeName" : "The Siam Residences, Bangkok" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/static-list/{listIdentifier}/item/{itemIdentifier}" : { "put" : { "tags" : [ "Curated List" ], "summary" : "Move item", "description" : "Relocate an item to a target list, removing it from its original list.", "operationId" : "move-inventory-to-curated-list", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Move inventory to curated list owned by this owner identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "listIdentifier", "in" : "path", "description" : "List identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, { "name" : "itemIdentifier", "in" : "path", "description" : "Item identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Target list identifier to which the item should be moved, removing it from the current list", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CopyMoveStaticListItemRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Moved list item now residing in the target list", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StaticListItemLightweight_ManagingEntity" }, "example" : { "createdDate" : "2026-01-14T09:30:00", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "item" : { "commissionable" : true, "enabled" : true, "identifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "image" : "https://res.cloudinary.com/wink/image/upload/v1/property/the-siam-residences.jpg", "inventoryIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "inventoryNameInEnglish" : "The Siam Residences, Bangkok", "inventoryType" : "GUEST_ROOM", "location" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "POINT" }, "lowestDisplayPrice" : 450.0, "lowestPrice" : 450.0, "pricePoint" : "THREE" }, "lastUpdate" : "2026-02-03T16:45:12", "parent" : { "createdDate" : "2026-01-14T09:30:00", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "lastUpdate" : "2026-02-03T16:45:12", "name" : "Top 3 hotels in Chiang Mai", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "type" : "NORMAL", "version" : 3 }, "sort" : 0, "status" : "ACTIVE", "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] }, "post" : { "tags" : [ "Curated List" ], "summary" : "Copy item", "description" : "Duplicate an item into a target list, leaving the original item in place.", "operationId" : "copy-inventory-to-curated-list", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Copy inventory to curated list owned by this owner identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "listIdentifier", "in" : "path", "description" : "List identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, { "name" : "itemIdentifier", "in" : "path", "description" : "Item identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Target list identifier into which the item should be copied while leaving the original in place", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CopyMoveStaticListItemRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Newly created copy of the list item in the target list", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StaticListItemLightweight_ManagingEntity" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] }, "delete" : { "tags" : [ "Curated List" ], "summary" : "Remove item", "description" : "Delete a single item from a list by the item's unique identifier.", "operationId" : "remove-inventory-from-curated-list", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Remove inventory from curated list owned by this owner identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "listIdentifier", "in" : "path", "description" : "List identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, { "name" : "itemIdentifier", "in" : "path", "description" : "Item identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Deleted list item", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StaticListItemLightweight_ManagingEntity" }, "example" : { "createdDate" : "2026-01-14T09:30:00", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "item" : { "commissionable" : true, "enabled" : true, "identifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "image" : "https://res.cloudinary.com/wink/image/upload/v1/property/the-siam-residences.jpg", "inventoryIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "inventoryNameInEnglish" : "The Siam Residences, Bangkok", "inventoryType" : "GUEST_ROOM", "location" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "POINT" }, "lowestDisplayPrice" : 450.0, "lowestPrice" : 450.0, "pricePoint" : "THREE" }, "lastUpdate" : "2026-02-03T16:45:12", "parent" : { "createdDate" : "2026-01-14T09:30:00", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "lastUpdate" : "2026-02-03T16:45:12", "name" : "Top 3 hotels in Chiang Mai", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "type" : "NORMAL", "version" : 3 }, "sort" : 0, "status" : "ACTIVE", "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/supplier/grid" : { "post" : { "tags" : [ "Available Suppliers" ], "summary" : "Search suppliers by grid criteria", "description" : "Return a paginated list of available suppliers filtered by the supplied search and filter criteria. Results include property details, location, ratings, and availability metrics.", "operationId" : "browse-suppliers", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Unique identifier of the managing entity (account) performing the search.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Grid state containing pagination, sorting, and filter criteria used to search and narrow the supplier results", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/State_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageResponsePropertyAggregateLightweight_ManagingEntity" }, "example" : { "content" : [ { "activities" : 3, "addOns" : 5, "address" : { "city" : "Bangkok", "countryCode" : "TH", "line1" : "3/2 Khao Road", "postalCode" : "10300", "state" : "Bangkok" }, "aggregateGreendexRating" : 7.0, "aggregateReviewRating" : 8.7, "architecturalStyle" : "7", "attractions" : 5, "available" : true, "bookings" : 6054, "brand" : "The Siam Residences", "chain" : "The Siam Collection", "currencyCode" : "THB", "descriptions" : [ { "description" : "An elegant riverside sanctuary in the heart of Bangkok.", "language" : "en", "title" : "Luxury Riverside Retreat" } ], "hotelAmenityCodes" : [ "1", "7" ], "hotelCategory" : "45", "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "images" : [ { "identifier" : "the-siam-residences/lobby-entrance", "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "type" : "IMAGE" } ], "lifestyleTypes" : [ "LIFESTYLE_HEALTH_FITNESS" ], "localName" : "เดอะสยาม เรสซิเดนซ์", "location" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "Point" }, "locationCategory" : "34", "meetingRooms" : 2, "name" : "The Siam Residences, Bangkok", "numberOfRooms" : 32, "places" : 9, "propertyAccessibilityCodes" : [ "1" ], "propertySecurityCodes" : [ "7" ], "reservations" : { "email" : "reservations@thesiamresidences.com", "firstName" : "Somchai", "lastName" : "Phattanapong", "phone" : "+66-2-123-4567" }, "restaurants" : 2, "score" : 70, "segmentCategory" : "7", "socials" : [ { "handle" : "thesiamresidences", "platform" : "INSTAGRAM" } ], "spas" : 1, "starRating" : 5, "thirdPartyReviews" : [ ], "totalReviews" : 989, "uniqueId" : "siam-residences-bkk", "urlName" : "the-siam-residences-bangkok-thailand", "videos" : [ ], "whenBuilt" : "1927" } ], "first" : true, "last" : false, "number" : 0, "numberOfElements" : 20, "size" : 20, "totalElements" : 1234, "totalPages" : 62 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/static-list/{listIdentifier}/item" : { "post" : { "tags" : [ "Curated List" ], "summary" : "Add item", "description" : "Append a travel-inventory item to an existing list identified by its identifier.", "operationId" : "add-inventory-to-curated-list", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Add inventory to curated list owned by this owner identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "listIdentifier", "in" : "path", "description" : "List identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Inventory item to append to the list, identified by its channel inventory type and identifier", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AddStaticListItemRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Newly created list item record", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StaticListItemLightweight_ManagingEntity" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/static-list/{listIdentifier}/item/supplier" : { "post" : { "tags" : [ "Curated List" ], "summary" : "Add supplier item", "description" : "Append a supplier to an existing list, resolved to its best-priced room for the caller's location. Returns the lighter StaticListItemLightweight projection, like the sibling /item endpoint.", "operationId" : "add-supplier-to-curated-list", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Add inventory to curated list owned by this owner identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "listIdentifier", "in" : "path", "description" : "List identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Supplier identifier whose best-priced room will be resolved and appended to the list", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AddStaticListSupplierRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Newly created list item record resolved from the supplier", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StaticListItemLightweight_ManagingEntity" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/static-list/supplier" : { "post" : { "tags" : [ "Curated List" ], "summary" : "Create from supplier", "description" : "Create a new list seeded with a supplier item resolved to its best-priced room for the caller's location.", "operationId" : "create-curated-supplier-list", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Create curated list owned by this owner identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "New list metadata together with the supplier identifier whose best-priced room will seed the list", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateStaticListAndAddSupplierRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Newly created curated list seeded with the resolved supplier inventory item", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StaticListWrapper_ManagingEntity" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/shareable-link/supplier" : { "post" : { "tags" : [ "Link: Supplier" ], "summary" : "Create", "description" : "Creates a new shareable supplier link owned by the specified managing entity. The authenticated user is recorded as the creator. The link will be assigned a unique shareable URL identifier.", "operationId" : "create-supplier-url", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier (the owner of the new shareable link)", "required" : true, "schema" : { "type" : "string" }, "example" : "d2c8f3a9-4b1e-4c7a-9d3f-5b8a2e6c1d04" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Supplier link configuration including the target supplier identifier, OpenGraph metadata, and branding settings", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpsertSellableSupplierUrlRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Newly created shareable supplier link with generated unique URL identifier and ACTIVE status", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SellableSupplierUrlLightweight_ManagingEntity" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/shareable-link/inventory" : { "post" : { "tags" : [ "Link: Inventory" ], "summary" : "Create", "description" : "Creates a new shareable inventory link for the managing entity with OpenGraph metadata, media selection, and theming. The link is attributed to the authenticated user.", "operationId" : "create-seller-url", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier for which to create the shareable link", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Inventory link configuration including OpenGraph metadata, media selection, and theming for the new shareable link", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpsertSellableInventoryUrlRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Shareable inventory link created successfully and attributed to the authenticated user", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SellableInventoryUrlLightweight_ManagingEntity" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/sales-channel/request" : { "post" : { "tags" : [ "Connect with supplier" ], "summary" : "Create", "description" : "Submits a new relationship request from the company to a supplier and returns the persisted request once created.", "operationId" : "create-supplier-request", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Create property request and associate it with this company identifier", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Relationship request payload specifying the target supplier and any proposed commission or pricing terms for the new channel partnership", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpsertSalesChannelRequestRequest" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Sales channel relationship request successfully created", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SalesChannelRequestLightweight" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/sales-channel/grid" : { "post" : { "tags" : [ "Sales Channel" ], "summary" : "Show grid", "description" : "Returns a paginated, filterable grid of the affiliate's sales channels.", "operationId" : "browse-sales-channels", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Affiliate/managing entity identifier", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Pageable grid state including page number, page size, sort fields, and optional filters to narrow the affiliate's sales channel results", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/State_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Paginated list of sales channels for the affiliate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageResponseSalesChannelLightweight_ManagingEntity" }, "example" : { "content" : [ { "blacklisted" : false, "channelDisabled" : false, "commission" : 0.2, "createdDate" : "2026-01-14T09:30:00", "enabled" : true, "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "lastUpdate" : "2026-02-03T16:45:12", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "ownerName" : "The Siam Residences", "percentDiscount" : 0.15, "rateModifierBundles" : [ { "aggregatedItemDescriptions" : [ { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" } ], "createdDate" : "2026-01-14T09:30:00", "descriptions" : [ { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" } ], "effectiveDescriptions" : [ { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" } ], "enabled" : true, "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "items" : [ { "addOnIdentifiers" : [ "880e8400-e29b-41d4-a716-446655440333" ], "blackoutDates" : [ { "effectiveDate" : "2026-04-13", "expireDate" : "2026-04-15" } ], "cityRateQualifiers" : [ { "city" : { "countryCode" : "TH", "geoNameId" : "1609350", "latitude" : 13.7563, "longitude" : 100.5018, "name" : "Bangkok" } } ], "continentRateQualifiers" : [ { "continent" : "NA" } ], "countryRateQualifiers" : [ { "country" : { "continentCode" : "AS", "geoNameId" : "1609350", "isoAlpha2" : "TH", "isoAlpha3" : "THA", "name" : "Thailand" } } ], "createdDate" : "2026-01-14T09:30:00", "descriptions" : [ { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" } ], "enabled" : true, "geoLocationRateQualifiers" : [ { "latitude" : 13.7563, "longitude" : 100.5018, "radiusInKilometers" : 50 } ], "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "ipRangeRateQualifiers" : [ { "endIPRange" : "192.168.1.255", "startIPRange" : "192.168.1.0" } ], "lastUpdate" : "2026-02-03T16:45:12", "masterRateIdentifiers" : [ "770e8400-e29b-41d4-a716-446655440222" ], "name" : "Early bird", "pricingType" : "PER_PERSON_PER_NIGHT", "promotionRateQualifiers" : [ { "promotion" : "EARLYBIRD2026" } ], "ratePlanIdentifiers" : [ "990e8400-e29b-41d4-a716-446655440444" ], "sellDateRateQualifiers" : [ { "effectiveDate" : "2026-05-01", "expireDate" : "2026-08-31" } ], "stayDateRateQualifiers" : [ { "effectiveDate" : "2026-06-01", "expireDate" : "2026-08-31" } ], "timezoneRateQualifiers" : [ { "timezone" : "Asia/Bangkok" } ], "type" : "DISCOUNT", "version" : 3 } ], "lastUpdate" : "2026-02-03T16:45:12", "name" : "Early bird - Long Term", "pricingType" : "PER_NIGHT", "type" : "DISCOUNT", "version" : 3 } ], "rateModifiers" : [ { "addOnIdentifiers" : [ "880e8400-e29b-41d4-a716-446655440333" ], "blackoutDates" : [ { "effectiveDate" : "2026-04-13", "expireDate" : "2026-04-15" } ], "cityRateQualifiers" : [ { "city" : { "countryCode" : "TH", "geoNameId" : "1609350", "latitude" : 13.7563, "longitude" : 100.5018, "name" : "Bangkok" } } ], "continentRateQualifiers" : [ { "continent" : "NA" } ], "countryRateQualifiers" : [ { "country" : { "continentCode" : "AS", "geoNameId" : "1609350", "isoAlpha2" : "TH", "isoAlpha3" : "THA", "name" : "Thailand" } } ], "createdDate" : "2026-01-14T09:30:00", "descriptions" : [ { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" } ], "enabled" : true, "geoLocationRateQualifiers" : [ { "latitude" : 13.7563, "longitude" : 100.5018, "radiusInKilometers" : 50 } ], "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "ipRangeRateQualifiers" : [ { "endIPRange" : "192.168.1.255", "startIPRange" : "192.168.1.0" } ], "lastUpdate" : "2026-02-03T16:45:12", "masterRateIdentifiers" : [ "770e8400-e29b-41d4-a716-446655440222" ], "name" : "Early bird", "pricingType" : "PER_PERSON_PER_NIGHT", "promotionRateQualifiers" : [ { "promotion" : "EARLYBIRD2026" } ], "ratePlanIdentifiers" : [ "990e8400-e29b-41d4-a716-446655440444" ], "sellDateRateQualifiers" : [ { "effectiveDate" : "2026-05-01", "expireDate" : "2026-08-31" } ], "stayDateRateQualifiers" : [ { "effectiveDate" : "2026-06-01", "expireDate" : "2026-08-31" } ], "timezoneRateQualifiers" : [ { "timezone" : "Asia/Bangkok" } ], "type" : "DISCOUNT", "version" : 3 } ], "selfAcquires" : false, "subType" : "DIRECT", "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "supplierName" : "The Siam Residences, Bangkok", "version" : 3 } ], "first" : true, "last" : false, "number" : 0, "numberOfElements" : 20, "size" : 20, "totalElements" : 1234, "totalPages" : 62 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/ranked-grids" : { "post" : { "tags" : [ "Ranked Grid" ], "summary" : "Create", "description" : "Persists a new ranked grid for the managing entity and returns the created record. Requires MARKETING:WRITE permission.", "operationId" : "create-seller-inventory-ranked-list", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Ranked grid definition including name, score type, geographic region, and display configuration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpsertSellableRankedListRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Ranked grid successfully created and persisted", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SellableRankedListLightweight_ManagingEntity" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/map" : { "post" : { "tags" : [ "Map" ], "summary" : "Create", "description" : "Create a new map configuration owned by the specified managing entity with the supplied settings.", "operationId" : "create-inventory-map", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "UUID of the managing entity that will own the map.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Map configuration including name, center coordinates, zoom level, style and the list of inventory items to display as markers", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpsertInventoryMapRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Map configuration created successfully", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InventoryMapLightweight_ManagingEntity" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/map/supplier" : { "post" : { "tags" : [ "Map" ], "summary" : "Create (supplier)", "description" : "Create a new map centered on a supplier property with a single marker, priced to its best-available rate for the requested inventory type.", "operationId" : "create-inventory-map-for-supplier", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "UUID of the managing entity that will own the map.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Supplier map request including the property identifier, inventory type and optional display settings used to center and price the map marker", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpsertSupplierInventoryMapRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Supplier map configuration created successfully", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InventoryMapLightweight_ManagingEntity" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/items" : { "post" : { "tags" : [ "Card" ], "summary" : "Create from inventory", "description" : "Creates a new inventory card for the given managing entity from the supplied request. Requires MARKETING:WRITE and returns 201 with the created item.", "operationId" : "create-seller-inventory-item", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "AffiliateAccount identifier to create item for", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Inventory card definition including inventory type, display details, media, and channel configuration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpsertSellableItemRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Newly created sellable inventory item", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SellableItemLightweight_ManagingEntity" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/items/supplier" : { "post" : { "tags" : [ "Card" ], "summary" : "Create from supplier", "description" : "Creates an inventory card sourced from a supplier, resolving the best-priced option for the inventory type using the caller's geo-IP location and a default near-term itinerary. Requires MARKETING:WRITE and returns 201.", "operationId" : "create-supplier-seller-inventory-item", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "AffiliateAccount identifier to create item for", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Supplier-sourced inventory card request specifying the supplier identifier and the channel inventory type to resolve", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpsertSupplierSellableItemRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Newly created sellable inventory item sourced from supplier data", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SellableItemLightweight_ManagingEntity" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/grids" : { "post" : { "tags" : [ "Grid" ], "summary" : "Create", "description" : "Creates a new curated or saved-search grid for the managing entity from the supplied request. Returns the created grid with its assigned identifier.", "operationId" : "create-seller-inventory-list", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Managing entity identifier that will own the new grid.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Grid definition including name, display settings, and the curated inventory list or saved search configuration", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpsertSellableListRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Newly created curated or saved-search grid with its assigned identifier.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SellableListLightweight_ManagingEntity" } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/browse/supplier/grid" : { "post" : { "tags" : [ "Browse: Supplier" ], "summary" : "Search", "description" : "Returns a paginated set of inventory suppliers matching the dynamic search criteria in the request body.", "operationId" : "show-suppliers-for-dynamic-seller-inventory", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Browse inventory supplier suppliers on behalf of this owner identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "owner-1" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Dynamic list filter and sort criteria used to search inventory suppliers for the affiliate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DynamicSellerListRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageResponseInventorySupplierAggregateLightweight_ManagingEntity" }, "example" : { "content" : [ { "hotel" : { "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "name" : "The Siam Residences, Bangkok", "uniqueId" : "siam01", "urlName" : "the-siam-residences-bangkok" }, "lowestDisplayPrice" : { "amount" : 125.0, "currency" : "USD" }, "lowestPrice" : { "amount" : 4500.0, "currency" : "THB" }, "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 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/browse/inventory/grid" : { "post" : { "tags" : [ "Browse: Inventory" ], "summary" : "Search", "description" : "Returns a paginated grid of sellable inventory matching the supplied filter and sort criteria.", "operationId" : "show-dynamic-seller-inventory", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Browse inventory on behalf of this owner identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "owner-1" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Dynamic list filter and sort criteria used to search sellable inventory for the affiliate", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DynamicSellerListRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageResponseInventoryAggregateLightweight_ManagingEntity" }, "example" : { "content" : [ { "address" : { "address1" : "20 Soi Ton Son", "address2" : null, "city" : "Bangkok", "countryCode" : "TH", "county" : null, "postalCode" : "10330", "state" : null }, "bookable" : true, "commissionable" : true, "createdDate" : "2026-01-14T09:30:00", "enabled" : true, "hotel" : { "currencyCode" : "THB", "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "name" : "The Siam Residences, Bangkok", "starRating" : "5", "uniqueId" : "siam01", "urlName" : "the-siam-residences-bangkok-thailand" }, "id" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "image" : { "descriptions" : [ { "description" : "Spacious city view room", "language" : "en", "title" : "Deluxe Room" } ], "identifier" : "the-siam-residences/deluxe-room-city-view", "isLandscape" : true, "multimediaIdentifier" : "9d4e2b7a-3f1c-4d5b-8a6e-2c0f9b3d1e47", "published" : true, "sort" : 1, "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.0, "currency" : "USD" }, "lowestPrice" : { "amount" : 4500.0, "currency" : "THB" }, "pricePoint" : "THREE", "quantity" : 24, "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 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/booking/analytics" : { "post" : { "tags" : [ "Analytics" ], "summary" : "Aggregate bookings", "description" : "Computes comprehensive booking and revenue analytics aggregated across all of the affiliate company's properties over the specified period.", "operationId" : "show-affiliate-booking-analytics", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Affiliate/company identifier (UUID)", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Analysis period and filters", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BookingOverviewRequest_Supplier" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Booking analytics aggregated across all properties of the affiliate company", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BookingAnalytics_Supplier" }, "example" : { "charts" : [ { "identifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "legend" : { "data" : [ "Bookings" ] }, "series" : [ { "data" : [ 12, 18, 25, 30, 22, 40 ], "name" : "Bookings" } ], "title" : { "text" : "Monthly Bookings" }, "xAxis" : { "data" : [ "Jan", "Feb", "Mar", "Apr", "May", "Jun" ] } } ] } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/static-list/{listIdentifier}" : { "put" : { "tags" : [ "Curated List" ], "summary" : "Update", "description" : "Update an existing list's metadata, identified by its unique identifier.", "operationId" : "update-curated-list", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Update curated list owned by this owner identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "listIdentifier", "in" : "path", "description" : "List identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Updated list metadata such as name and description; does not modify the list's existing items", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpsertStaticListRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Updated curated list with its current inventory items", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StaticListWrapper_ManagingEntity" }, "example" : { "items" : [ ], "list" : { "enabled" : true, "id" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "managingEntityIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "name" : "Top Hotels in Bangkok" } } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] }, "delete" : { "tags" : [ "Curated List" ], "summary" : "Remove", "description" : "Delete an entire list, including all of its items, by its identifier.", "operationId" : "remove-curated-list", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Remove curated list owned by this owner identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "listIdentifier", "in" : "path", "description" : "List identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Deleted curated list", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StaticListLightweight_ManagingEntity" }, "example" : { "createdDate" : "2026-01-14T09:30:00", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "lastUpdate" : "2026-02-03T16:45:12", "name" : "Top 3 hotels in Chiang Mai", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "type" : "NORMAL", "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/dynamic-list/{listIdentifier}" : { "put" : { "tags" : [ "Saved Search" ], "summary" : "Update", "description" : "Updates an existing saved search identified by its identifier with the supplied filters.", "operationId" : "update-saved-search", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Update search owned by this managing entity.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "listIdentifier", "in" : "path", "description" : "Saved search identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Updated dynamic list definition with revised filter criteria, sorting rules and display settings", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpsertDynamicListRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Saved search updated successfully.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DynamicListLightweight_ManagingEntity" }, "example" : { "aggregateReviewRating" : 8, "architecturalStyles" : 50, "cities" : [ "1609350" ], "continents" : [ "AS" ], "countries" : [ "1605651" ], "createdDate" : "2026-01-14T09:30:00", "hotelCategories" : 1, "hotelStars" : 5, "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "inventoryName" : "Deluxe Suite", "inventoryTypes" : [ "GUEST_ROOM" ], "lastUpdate" : "2026-02-03T16:45:12", "lifestyles" : "LIFESTYLE_RELAX", "locationCategories" : 1701, "name" : "Bangkok Luxury Hotels", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "primaryOrderBy" : "4", "propertyName" : "The Siam", "radiusInMeters" : 5000, "segmentCategories" : 7, "showChildFriendly" : false, "showDirectOnly" : false, "showEcoFriendly" : false, "showPetFriendly" : false, "showPopular" : false, "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] }, "delete" : { "tags" : [ "Saved Search" ], "summary" : "Remove", "description" : "Permanently removes the saved search identified by its identifier.", "operationId" : "remove-saved-search-for-affiliate", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Remove search owned by this managing entity.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "listIdentifier", "in" : "path", "description" : "Saved search identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Saved search removed and the deleted record returned.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DynamicListLightweight_ManagingEntity" }, "example" : { "aggregateReviewRating" : 8, "architecturalStyles" : 50, "cities" : [ "1609350" ], "continents" : [ "AS" ], "countries" : [ "1605651" ], "createdDate" : "2026-01-14T09:30:00", "hotelCategories" : 1, "hotelStars" : 5, "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "inventoryName" : "Deluxe Suite", "inventoryTypes" : [ "GUEST_ROOM" ], "lastUpdate" : "2026-02-03T16:45:12", "lifestyles" : "LIFESTYLE_RELAX", "locationCategories" : 1701, "name" : "Bangkok Luxury Hotels", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "primaryOrderBy" : "4", "propertyName" : "The Siam", "radiusInMeters" : 5000, "segmentCategories" : 7, "showChildFriendly" : false, "showDirectOnly" : false, "showEcoFriendly" : false, "showPetFriendly" : false, "showPopular" : false, "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/static-list/{listIdentifier}/sort" : { "patch" : { "tags" : [ "Curated List" ], "summary" : "Re-order items", "description" : "Apply a new display order to the items within an existing list.", "operationId" : "sort-curated-list-items", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Sort curated list items owned by this owner identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "listIdentifier", "in" : "path", "description" : "List identifier.", "required" : true, "schema" : { "type" : "string" }, "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } } ], "requestBody" : { "description" : "Ordered list of item identifiers defining the new display sequence for the list", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SortStaticListItemsRequest_ManagingEntity" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Reordered list items in their new display order", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/StaticListItemLightweight_ManagingEntity" } }, "example" : [ { "createdDate" : "2026-01-14T09:30:00", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "item" : { "commissionable" : true, "enabled" : true, "identifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "image" : "https://res.cloudinary.com/wink/image/upload/v1/property/the-siam-residences.jpg", "inventoryIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "inventoryNameInEnglish" : "The Siam Residences, Bangkok", "inventoryType" : "GUEST_ROOM", "location" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "POINT" }, "lowestDisplayPrice" : 450.0, "lowestPrice" : 450.0, "pricePoint" : "THREE" }, "lastUpdate" : "2026-02-03T16:45:12", "parent" : { "createdDate" : "2026-01-14T09:30:00", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "lastUpdate" : "2026-02-03T16:45:12", "name" : "Top 3 hotels in Chiang Mai", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "type" : "NORMAL", "version" : 3 }, "sort" : 0, "status" : "ACTIVE", "version" : 3 } ] } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } }, "/api/managing-entity/{managingEntityIdentifier}/studio/sales-channel/request/{salesChannelRequestIdentifier}" : { "delete" : { "tags" : [ "Connect with supplier" ], "summary" : "Delete", "description" : "Removes the relationship request identified by its sales-channel request identifier.", "operationId" : "remove-supplier-request", "parameters" : [ { "name" : "managingEntityIdentifier", "in" : "path", "description" : "Remove property request owned by this company identifier", "required" : true, "schema" : { "type" : "string" }, "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, { "name" : "salesChannelRequestIdentifier", "in" : "path", "description" : "Remove property request with this identifier", "required" : true, "schema" : { "type" : "string" }, "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51" }, { "name" : "Wink-Version", "in" : "header", "schema" : { "type" : "string", "default" : "2.0.0", "enum" : [ "2.0" ] } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string", "enum" : [ "application/json" ], "default" : null } } ], "responses" : { "400" : { "description" : "Bad Request — missing or invalid request parameter or body", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized — authentication is required or the session has expired", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "403" : { "description" : "Forbidden — authenticated but lacking the required permission or scope", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found — the requested resource does not exist", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "405" : { "description" : "Method Not Allowed — the HTTP verb is not supported on this endpoint", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "409" : { "description" : "Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "415" : { "description" : "Unsupported Media Type — use application/json", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error — an unexpected failure occurred on the server", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "503" : { "description" : "Service Unavailable — a downstream dependency is unreachable", "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "The removed sales channel relationship request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SalesChannelRequestLightweight" }, "example" : { "createdDate" : "2026-01-14T09:30:00", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "introductoryMessage" : "We represent a travel agency network with strong demand for your properties and would like to establish a partnership to offer exclusive rates to our members.", "lastUpdate" : "2026-02-03T16:45:12", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "ownerName" : "The Siam Residences", "requestType" : "DIRECT_CONNECTION", "status" : "REQUESTING", "subType" : "APPLICATION", "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "supplierName" : "The Siam Residences, Bangkok", "version" : 3 } } } } }, "security" : [ { "oauth2ClientCredentials" : [ ] } ] } } }, "components" : { "schemas" : { "ProblemDetail" : { "type" : "object", "properties" : { "detail" : { "type" : "string" }, "instance" : { "type" : "string", "format" : "uri" }, "properties" : { "additionalProperties" : { }, "type" : "object" }, "status" : { "type" : "integer", "format" : "int32" }, "title" : { "type" : "string" }, "type" : { "type" : "string", "format" : "uri" } } }, "UpsertStaticListRequest_ManagingEntity" : { "type" : "object", "description" : "Use this object to update the name of your curated list.", "example" : { "name" : "Top 3 hotels in Chiang Mai" }, "properties" : { "name" : { "type" : "string", "description" : "Name of curated list", "example" : "Top 3 hotels in Chiang Mai", "minLength" : 1 } }, "required" : [ "name" ] }, "CustomMonetaryAmount" : { "type" : "object", "description" : "Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed", "example" : { "amount" : 1250.0, "currency" : "USD" }, "properties" : { "amount" : { "type" : "number", "description" : "Monetary amount value", "example" : 1250.0 }, "currency" : { "type" : "string", "description" : "ISO 4217 currency code", "example" : "USD", "minLength" : 1, "pattern" : "^[A-Z]{3}$" } }, "required" : [ "amount", "currency" ] }, "GeoJsonPoint_ManagingEntity" : { "type" : "object", "properties" : { "coordinates" : { "type" : "array", "items" : { "type" : "number", "format" : "double" } }, "type" : { "type" : "string" }, "x" : { "type" : "number", "format" : "double" }, "y" : { "type" : "number", "format" : "double" } } }, "MediaAuthorAttribution_ManagingEntity" : { "type" : "object", "example" : { "name" : "Samuel Adams", "url" : "https://maps.google.com/maps/contrib/111628493169070103594" }, "properties" : { "name" : { "type" : "string", "description" : "Name of contributor", "example" : "Samuel Adams", "minLength" : 1 }, "url" : { "type" : "string", "format" : "uri", "description" : "URL to contributor", "example" : "https://maps.google.com/maps/contrib/111628493169070103594" } }, "required" : [ "name" ] }, "SalesChannelRef_ManagingEntity" : { "type" : "object", "properties" : { "blacklisted" : { "type" : "boolean" }, "channelDisabled" : { "type" : "boolean" }, "commission" : { "type" : "number", "format" : "float" }, "enabled" : { "type" : "boolean" }, "id" : { "type" : "string" }, "ownerIdentifier" : { "type" : "string" }, "ownerName" : { "type" : "string" }, "percentDiscount" : { "type" : "number", "format" : "float" }, "selfAcquires" : { "type" : "boolean" }, "subType" : { "type" : "string", "description" : "Type of entity that manages, facilitates, or administers properties, bookings, or payments on the Wink Platform", "enum" : [ "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" ] }, "supplierIdentifier" : { "type" : "string" }, "supplierName" : { "type" : "string" } } }, "SimpleDescription_ManagingEntity" : { "type" : "object", "description" : "Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.", "example" : { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" }, "properties" : { "creator" : { "type" : "string", "default" : "USER", "description" : "Whether it was user or system generated.", "enum" : [ "SYSTEM", "USER" ], "example" : "SYSTEM" }, "description" : { "type" : "string", "description" : "Longer text description", "example" : "This is a longer description in the specified language.", "maxLength" : 2147483647, "minLength" : 1 }, "hashMismatch" : { "type" : "boolean", "readOnly" : true }, "language" : { "type" : "string", "default" : "en", "description" : "Indicate which language this description is written in.", "example" : "en", "maxLength" : 2, "minLength" : 2, "pattern" : "^[a-z]{2}(-[A-Z]{2})?$" }, "md5ContentHash" : { "type" : "string", "description" : "The md5 hash of the name, description and language.", "example" : "d41d8cd98f00b204e9800998ecf8427e" }, "name" : { "type" : "string", "description" : "Use as title or short text description", "example" : "An example title" } }, "required" : [ "description", "language", "name" ] }, "SimpleMultimedia_ManagingEntity" : { "type" : "object", "description" : "Multimedia that contains less information than Multimedia object", "example" : { "angle" : null, "attribution" : [ ], "category" : "2", "descriptions" : [ { "description" : "Elegant lobby of The Siam Residences", "language" : "en", "title" : "Lobby Entrance" } ], "height" : 1600, "identifier" : "the-siam-residences/lobby-entrance", "isLandscape" : true, "lifestyleType" : null, "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "source" : "CLOUDINARY", "type" : "IMAGE", "width" : 2560 }, "properties" : { "angle" : { "type" : "string", "description" : "Media angle", "example" : "-90" }, "attribution" : { "type" : "array", "description" : "Whether image has attribution properties", "items" : { "$ref" : "#/components/schemas/MediaAuthorAttribution_ManagingEntity" } }, "category" : { "type" : "string", "description" : "Supported OTA specification `PIC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", "example" : "1" }, "descriptions" : { "type" : "array", "description" : "Localized media captions to give user some context about where this media was taken.", "items" : { "$ref" : "#/components/schemas/SimpleDescription_ManagingEntity" } }, "height" : { "type" : "integer", "format" : "int32", "description" : "Media height in pixels.", "example" : 1600, "minimum" : 1 }, "identifier" : { "type" : "string", "description" : "Use this identifier to communicate with Cloudinary.", "example" : "cloudinary-image-1", "minLength" : 1 }, "isLandscape" : { "type" : "boolean", "description" : "True if media width is greater or equal to height", "example" : true }, "lifestyleType" : { "type" : "string", "description" : "Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.", "enum" : [ "LIFESTYLE_HEALTH_FITNESS", "LIFESTYLE_RELAX", "LIFESTYLE_ADULT_ONLY", "LIFESTYLE_ADVENTURE", "LIFESTYLE_BUSINESS", "LIFESTYLE_LGBT", "LIFESTYLE_SINGLE_PARENT", "LIFESTYLE_SOLO_FEMALE", "LIFESTYLE_BEAUTY", "LIFESTYLE_FOODIE", "LIFESTYLE_FAMILY", "LIFESTYLE_ROMANCE", "LIFESTYLE_COUPLE", "LIFESTYLE_SOLO", "LIFESTYLE_BACKPACKER", "LIFESTYLE_SHOPPING", "LIFESTYLE_SPORTS", "LIFESTYLE_MOUNTAIN", "LIFESTYLE_BEACH", "LIFESTYLE_CITY", "LIFESTYLE_COUNTRY", "LIFESTYLE_CULTURE", "LIFESTYLE_ECO" ], "example" : "LIFESTYLE_HEALTH_FITNESS" }, "multimediaIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Document identifier", "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "minLength" : 1 }, "published" : { "type" : "boolean", "default" : false, "description" : "Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.", "example" : true }, "sort" : { "type" : "integer", "format" : "int32", "default" : 999, "description" : "Sort allows you to control how you want to sort this record in a list of media records.", "example" : 10 }, "source" : { "type" : "string", "default" : "CLOUDINARY", "description" : "Currently ONLY using Cloudinary to store all image / video assets.", "enum" : [ "YOUTUBE", "CLOUDINARY" ], "example" : "CLOUDINARY" }, "type" : { "type" : "string", "description" : "Whether Cloudinary media is a VIDEO or IMAGE.", "enum" : [ "IMAGE", "VIDEO", "AUDIO", "RAW" ], "example" : "IMAGE" }, "width" : { "type" : "integer", "format" : "int32", "description" : "Media width in pixels.", "example" : 2560, "minimum" : 1 } }, "required" : [ "height", "identifier", "multimediaIdentifier", "sort", "source", "type", "width" ] }, "StaticListItemInventory_ManagingEntity" : { "type" : "object", "description" : "A snapshot of a sales channel inventory item stored within a curated list, capturing pricing, location, and availability at the time of addition.", "example" : { "commissionable" : true, "enabled" : true, "identifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "image" : "https://res.cloudinary.com/wink/image/upload/v1/property/the-siam-residences.jpg", "inventoryIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "inventoryNameInEnglish" : "The Siam Residences, Bangkok", "inventoryType" : "GUEST_ROOM", "location" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "POINT" }, "lowestDisplayPrice" : 450.0, "lowestPrice" : 450.0, "pricePoint" : "THREE" }, "properties" : { "commissionable" : { "type" : "boolean", "default" : false, "description" : "Whether this is commissionable or not", "example" : true }, "enabled" : { "type" : "boolean", "default" : true, "description" : "Whether this inventory is enabled or not", "example" : true }, "identifier" : { "type" : "string", "format" : "uuid", "description" : "Channel Inventory identifier", "example" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29" }, "image" : { "$ref" : "#/components/schemas/SimpleMultimedia_ManagingEntity", "description" : "Main image of inventory", "example" : "https://res.cloudinary.com/wink/image/upload/v1/property/the-siam-residences.jpg" }, "inventoryIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Inventory type identifier", "example" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "minLength" : 1 }, "inventoryNameInEnglish" : { "type" : "string", "description" : "Name of inventory as traveler is seeing it", "example" : "The Siam Residences, Bangkok", "minLength" : 1 }, "inventoryType" : { "type" : "string", "description" : "Inventory type", "enum" : [ "GUEST_ROOM", "ADD_ON", "MEETING_ROOM", "RESTAURANT", "SPA", "ATTRACTION", "PLACE", "ACTIVITY" ], "example" : "GUEST_ROOM" }, "location" : { "$ref" : "#/components/schemas/GeoJsonPoint_ManagingEntity", "description" : "Location", "example" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "POINT" } }, "lowestDisplayPrice" : { "$ref" : "#/components/schemas/CustomMonetaryAmount", "description" : "Best price of the room type or facility ancillary in platform currency", "example" : 450.0 }, "lowestPrice" : { "$ref" : "#/components/schemas/CustomMonetaryAmount", "description" : "Best price of the room type or facility ancillary", "example" : 450.0 }, "pricePoint" : { "type" : "string", "default" : "THREE", "description" : "Level of expensiveness.", "enum" : [ "HALF", "ONE", "ONE_HALF", "TWO", "TWO_HALF", "THREE", "THREE_HALF", "FOUR", "FOUR_HALF", "FIVE" ], "example" : "THREE" }, "salesChannel" : { "$ref" : "#/components/schemas/SalesChannelRef_ManagingEntity", "description" : "Parent sales channel" } }, "required" : [ "commissionable", "enabled", "identifier", "image", "inventoryIdentifier", "inventoryNameInEnglish", "inventoryType", "location", "pricePoint", "salesChannel" ] }, "StaticListItemLightweight_ManagingEntity" : { "type" : "object", "description" : "A single travel inventory entry within a curated list, linking a sales channel inventory item to its parent list.", "example" : { "createdDate" : "2026-01-14T09:30:00", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "item" : { "commissionable" : true, "enabled" : true, "identifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "image" : "https://res.cloudinary.com/wink/image/upload/v1/property/the-siam-residences.jpg", "inventoryIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "inventoryNameInEnglish" : "The Siam Residences, Bangkok", "inventoryType" : "GUEST_ROOM", "location" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "POINT" }, "lowestDisplayPrice" : 450.0, "lowestPrice" : 450.0, "pricePoint" : "THREE" }, "lastUpdate" : "2026-02-03T16:45:12", "parent" : { "createdDate" : "2026-01-14T09:30:00", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "lastUpdate" : "2026-02-03T16:45:12", "name" : "Top 3 hotels in Chiang Mai", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "type" : "NORMAL", "version" : 3 }, "sort" : 0, "status" : "ACTIVE", "version" : 3 }, "properties" : { "createdDate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was first created", "example" : "2026-01-14T09:30:00", "readOnly" : true }, "id" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier for this record.", "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, "item" : { "$ref" : "#/components/schemas/StaticListItemInventory_ManagingEntity", "description" : "Channel inventory" }, "lastUpdate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was last updated", "example" : "2026-02-03T16:45:12", "readOnly" : true }, "parent" : { "$ref" : "#/components/schemas/StaticListLightweight_ManagingEntity", "description" : "Parent list" }, "sort" : { "type" : "integer", "format" : "int32", "description" : "Sort key for controlling display order within the list (0-based)", "example" : 0 }, "status" : { "type" : "string", "description" : "Availability status of this list item; defaults to ACTIVE", "enum" : [ "ACTIVE", "INACTIVE", "REMOVED" ], "example" : "ACTIVE" }, "version" : { "type" : [ "integer", "null" ], "format" : "int64", "description" : "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.", "example" : 3 } }, "required" : [ "item", "parent" ] }, "StaticListLightweight_ManagingEntity" : { "type" : "object", "description" : "A curated list is a bucket that holds any type of travel inventory.", "example" : { "createdDate" : "2026-01-14T09:30:00", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "lastUpdate" : "2026-02-03T16:45:12", "name" : "Top 3 hotels in Chiang Mai", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "type" : "NORMAL", "version" : 3 }, "properties" : { "createdDate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was first created", "example" : "2026-01-14T09:30:00", "readOnly" : true }, "id" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier for this record.", "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "minLength" : 1 }, "lastUpdate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was last updated", "example" : "2026-02-03T16:45:12", "readOnly" : true }, "name" : { "type" : "string", "description" : "Name of curated list", "example" : "Top 3 hotels in Chiang Mai", "minLength" : 1 }, "ownerIdentifier" : { "type" : "string", "format" : "uuid", "description" : "List creator", "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "minLength" : 1 }, "type" : { "type" : "string", "description" : "Every affiliate starts out with a `Favorite` list. All other lists will be of type `NORMAL`", "enum" : [ "FAVORITE", "NORMAL" ], "example" : "NORMAL" }, "version" : { "type" : [ "integer", "null" ], "format" : "int64", "description" : "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.", "example" : 3 } }, "required" : [ "id", "name", "ownerIdentifier", "type" ] }, "StaticListWrapper_ManagingEntity" : { "type" : "object", "description" : "Contains both the curated list and all its items.", "example" : { "items" : [ ], "list" : { "enabled" : true, "id" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "managingEntityIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "name" : "Top Hotels in Bangkok" } }, "properties" : { "items" : { "type" : "array", "description" : "Travel inventory items contained in list", "items" : { "$ref" : "#/components/schemas/StaticListItemLightweight_ManagingEntity" } }, "list" : { "$ref" : "#/components/schemas/StaticListLightweight_ManagingEntity", "description" : "Curated list object" } }, "required" : [ "list" ] }, "CopyMoveStaticListItemRequest_ManagingEntity" : { "type" : "object", "description" : "Request to copy or move a list item to a target curated list.", "example" : { "targetListIdentifier" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, "properties" : { "targetListIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Target list identifier to copy or move the item to.", "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" } }, "required" : [ "targetListIdentifier" ] }, "UpsertSellableSupplierUrlRequest_ManagingEntity" : { "type" : "object", "description" : "Request to create or update a shareable supplier link with OpenGraph metadata and customization", "example" : { "animate" : false, "animateDelay" : 500, "customizationIdentifier" : "8f2d4a9c-1e7b-4f3d-a5c8-9d1b6e2c0a47", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "facebookAppId" : "198273987219", "keywords" : [ "luxury" ], "multimedias" : [ { "angle" : null, "attribution" : [ ], "category" : "2", "descriptions" : [ { "description" : "Elegant lobby of The Siam Residences", "language" : "en", "title" : "Lobby Entrance" } ], "height" : 1600, "identifier" : "the-siam-residences/lobby-entrance", "isLandscape" : true, "lifestyleType" : null, "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "source" : "CLOUDINARY", "type" : "IMAGE", "width" : 2560 } ], "name" : "The Siam Residences, Bangkok", "supplierIdentifier" : "7c9a2e5f-3d8b-4a1c-b6e2-8f0d1c4a9b3e", "twitterAccount" : "@thesiamresidences" }, "properties" : { "animate" : { "type" : "boolean", "default" : false, "description" : "When true, renders selected images as an animated GIF (requires at least 2 images)" }, "animateDelay" : { "type" : "integer", "format" : "int32", "default" : -1, "description" : "Animation frame delay in milliseconds (-1 = no animation)", "example" : 500 }, "customizationIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Customization configuration identifier (controls the visual theme and styling)", "example" : "8f2d4a9c-1e7b-4f3d-a5c8-9d1b6e2c0a47", "minLength" : 1 }, "descriptions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SimpleDescription_ManagingEntity", "description" : "Localized link title and description (one entry per language/locale)" }, "maxItems" : 2147483647, "minItems" : 1 }, "facebookAppId" : { "type" : "string", "description" : "Facebook App ID for OpenGraph metadata when the link is shared", "example" : "198273987219" }, "keywords" : { "type" : "array", "items" : { "type" : "string", "description" : "Search keywords for metadata and social sharing", "example" : "luxury" } }, "multimedias" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SimpleMultimedia_ManagingEntity", "description" : "Hero images to display on the shareable link" } }, "name" : { "type" : "string", "description" : "Display name for this shareable link (internal reference, not shown to end users)", "example" : "The Siam Residences, Bangkok", "minLength" : 1 }, "supplierIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Property or supplier identifier (the entity whose inventory is promoted)", "example" : "7c9a2e5f-3d8b-4a1c-b6e2-8f0d1c4a9b3e", "minLength" : 1 }, "theme" : { "type" : "string", "description" : "Visual theme controlling the appearance of the shareable link banner", "enum" : [ "THEME_1" ] }, "twitterAccount" : { "type" : "string", "description" : "Twitter account handle for OpenGraph metadata when the link is shared", "example" : "@thesiamresidences" } }, "required" : [ "customizationIdentifier", "descriptions", "keywords", "name", "supplierIdentifier" ] }, "SellableSupplierUrlLightweight_ManagingEntity" : { "type" : "object", "description" : "Shareable supplier link with full details", "example" : { "animate" : false, "animateDelay" : 500, "createdDate" : "2026-01-14T09:30:00", "customizationIdentifier" : "8f2d4a9c-1e7b-4f3d-a5c8-9d1b6e2c0a47", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "facebookAppId" : "198273987219", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "keywords" : [ "luxury" ], "lastUpdate" : "2026-02-03T16:45:12", "multimedias" : [ { "angle" : null, "attribution" : [ ], "category" : "2", "descriptions" : [ { "description" : "Elegant lobby of The Siam Residences", "language" : "en", "title" : "Lobby Entrance" } ], "height" : 1600, "identifier" : "the-siam-residences/lobby-entrance", "isLandscape" : true, "lifestyleType" : null, "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "source" : "CLOUDINARY", "type" : "IMAGE", "width" : 2560 } ], "name" : "The Siam Residences, Bangkok", "ownerIdentifier" : "d2c8f3a9-4b1e-4c7a-9d3f-5b8a2e6c1d04", "supplierIdentifier" : "7c9a2e5f-3d8b-4a1c-b6e2-8f0d1c4a9b3e", "twitterAccount" : "@thesiamresidences", "uniqueId" : "HBDG87f2", "userIdentifier" : "4a1d7c2e-5f9b-4e3a-b8c1-6d2f8a0e3c5b", "version" : 3 }, "properties" : { "animate" : { "type" : "boolean", "default" : false, "description" : "When true, renders selected images as an animated GIF (requires at least 2 images)" }, "animateDelay" : { "type" : "integer", "format" : "int32", "default" : -1, "description" : "Animation frame delay in milliseconds (-1 = no animation)", "example" : 500 }, "createdDate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was first created", "example" : "2026-01-14T09:30:00", "readOnly" : true }, "customizationIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Customization configuration identifier (controls the visual theme and styling)", "example" : "8f2d4a9c-1e7b-4f3d-a5c8-9d1b6e2c0a47", "minLength" : 1 }, "descriptions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SimpleDescription_ManagingEntity", "description" : "Localized link title and description (one entry per language/locale)" }, "maxItems" : 2147483647, "minItems" : 1 }, "facebookAppId" : { "type" : "string", "description" : "Facebook App ID for OpenGraph metadata when the link is shared", "example" : "198273987219" }, "id" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier for this record.", "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, "keywords" : { "type" : "array", "items" : { "type" : "string", "description" : "Search keywords for metadata and social sharing", "example" : "luxury" }, "maxItems" : 2147483647, "minItems" : 1 }, "lastUpdate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was last updated", "example" : "2026-02-03T16:45:12", "readOnly" : true }, "multimedias" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SimpleMultimedia_ManagingEntity", "description" : "Hero images to display on the shareable link" }, "maxItems" : 2147483647, "minItems" : 1 }, "name" : { "type" : "string", "description" : "Display name for this shareable link (internal reference, not shown to end users)", "example" : "The Siam Residences, Bangkok", "minLength" : 1 }, "ownerIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Managing entity (owner) of this shareable link", "example" : "d2c8f3a9-4b1e-4c7a-9d3f-5b8a2e6c1d04", "minLength" : 1 }, "status" : { "type" : "string", "description" : "Current status of the shareable link (ACTIVE, INACTIVE, ARCHIVED, etc.)", "enum" : [ "ACTIVE", "INACTIVE", "REMOVED" ] }, "supplierIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Property or supplier identifier (the entity whose inventory is promoted)", "example" : "7c9a2e5f-3d8b-4a1c-b6e2-8f0d1c4a9b3e", "minLength" : 1 }, "theme" : { "type" : "string", "description" : "Visual theme controlling the appearance of the shareable link banner", "enum" : [ "THEME_1" ] }, "twitterAccount" : { "type" : "string", "description" : "Twitter account handle for OpenGraph metadata when the link is shared", "example" : "@thesiamresidences" }, "uniqueId" : { "type" : "string", "description" : "Unique identifier that generates the shareable URL slug (e.g., share.wink.travel/HBDG87f2)", "example" : "HBDG87f2", "minLength" : 1 }, "userIdentifier" : { "type" : "string", "format" : "uuid", "description" : "User (account) identifier", "example" : "4a1d7c2e-5f9b-4e3a-b8c1-6d2f8a0e3c5b", "minLength" : 1 }, "version" : { "type" : [ "integer", "null" ], "format" : "int64", "description" : "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.", "example" : 3 } }, "required" : [ "customizationIdentifier", "descriptions", "keywords", "multimedias", "name", "ownerIdentifier", "status", "supplierIdentifier", "uniqueId", "userIdentifier" ] }, "UpsertSellableInventoryUrlRequest_ManagingEntity" : { "type" : "object", "description" : "Upserts a SellableInventoryUrl entity", "example" : { "animate" : true, "animateDelay" : 1000, "channelInventoryIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "customizationIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "facebookAppId" : "19827398721938798237", "inventoryType" : "GUEST_ROOM", "keywords" : [ "bali" ], "multimedias" : [ { "angle" : null, "attribution" : [ ], "category" : "2", "descriptions" : [ { "description" : "Elegant lobby of The Siam Residences", "language" : "en", "title" : "Lobby Entrance" } ], "height" : 1600, "identifier" : "the-siam-residences/lobby-entrance", "isLandscape" : true, "lifestyleType" : null, "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "source" : "CLOUDINARY", "type" : "IMAGE", "width" : 2560 } ], "name" : "My Bali Villa", "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "theme" : "THEME_1", "transactionalItemIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "twitterAccount" : "@travelikoworld" }, "properties" : { "animate" : { "type" : "boolean", "default" : false, "description" : "Create an animated gif instead of a list of images", "example" : true }, "animateDelay" : { "type" : "integer", "format" : "int32", "default" : -1, "description" : "Animation delay in milliseconds", "example" : 1000 }, "channelInventoryIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Selected inventory record identifier", "example" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "minLength" : 1 }, "customizationIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Customization identifier for link styling and branding", "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "minLength" : 1 }, "descriptions" : { "type" : "array", "description" : "Localized link descriptions", "items" : { "$ref" : "#/components/schemas/SimpleDescription_ManagingEntity" }, "maxItems" : 2147483647, "minItems" : 1 }, "facebookAppId" : { "type" : "string", "description" : "Facebook APP ID is used with OpenGraph data", "example" : "19827398721938798237" }, "inventoryType" : { "type" : "string", "description" : "Inventory type", "enum" : [ "HOTEL", "GUEST_ROOM", "MEETING_ROOM", "RESTAURANT", "SPA", "ADD_ON", "ATTRACTION", "ACTIVITY", "PLACE" ], "example" : "GUEST_ROOM" }, "keywords" : { "type" : "array", "items" : { "type" : "string", "description" : "Keywords", "example" : "bali" } }, "multimedias" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SimpleMultimedia_ManagingEntity", "description" : "The selected media for this url." } }, "name" : { "type" : "string", "description" : "Descriptive name of this url for seller use only", "example" : "My Bali Villa", "minLength" : 1 }, "supplierIdentifier" : { "type" : "string", "format" : "uuid", "description" : "The entity supplying the inventory. Usually a hotel.", "example" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "minLength" : 1 }, "theme" : { "type" : "string", "description" : "Url theme controls the look and feel of the ad banner.", "enum" : [ "THEME_1" ], "example" : "THEME_1" }, "transactionalItemIdentifier" : { "type" : "string", "format" : "uuid", "description" : "In use by ancillary items only. Not used for room type or property. The transactional item on the ancillary to retrieve pricing for. If left empty, will find the cheapest priced item.", "example" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29" }, "twitterAccount" : { "type" : "string", "description" : "Twitter account is used with OpenGraph data", "example" : "@travelikoworld" } }, "required" : [ "channelInventoryIdentifier", "customizationIdentifier", "descriptions", "inventoryType", "name", "supplierIdentifier", "theme" ] }, "SellableInventoryUrlLightweight_ManagingEntity" : { "type" : "object", "description" : "Seller URL", "example" : { "animate" : true, "animateDelay" : 1000, "channelInventoryIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "channelInventoryType" : "GUEST_ROOM", "createdDate" : "2026-01-14T09:30:00", "customizationIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "facebookAppId" : "19827398721938798237", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "inventoryStatus" : "ACTIVE", "inventoryType" : "GUEST_ROOM", "keywords" : [ "bali" ], "lastUpdate" : "2026-02-03T16:45:12", "multimedias" : [ { "angle" : null, "attribution" : [ ], "category" : "2", "descriptions" : [ { "description" : "Elegant lobby of The Siam Residences", "language" : "en", "title" : "Lobby Entrance" } ], "height" : 1600, "identifier" : "the-siam-residences/lobby-entrance", "isLandscape" : true, "lifestyleType" : null, "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "source" : "CLOUDINARY", "type" : "IMAGE", "width" : 2560 } ], "name" : "My Bali Villa", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "status" : "ACTIVE", "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "theme" : "THEME_1", "transactionalItemIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "twitterAccount" : "@travelikoworld", "uniqueId" : "HBDG87f2", "userIdentifier" : "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "version" : 3 }, "properties" : { "animate" : { "type" : "boolean", "default" : false, "description" : "Create an animated gif instead of a list of images", "example" : true }, "animateDelay" : { "type" : "integer", "format" : "int32", "default" : -1, "description" : "Animation delay in milliseconds", "example" : 1000 }, "channelInventoryIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Selected inventory record identifier", "example" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "minLength" : 1 }, "channelInventoryType" : { "type" : "string", "description" : "Channel inventory type is a subset of inventory type in that it does not include the `HOTEL` type. THe way it works is, as a seller you might want to sell a guest room but instead of showing the price of that guest room, you would like to display the best room type price for the property.", "enum" : [ "GUEST_ROOM", "ADD_ON", "MEETING_ROOM", "RESTAURANT", "SPA", "ATTRACTION", "PLACE", "ACTIVITY" ], "example" : "GUEST_ROOM" }, "createdDate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was first created", "example" : "2026-01-14T09:30:00", "readOnly" : true }, "customizationIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Customization identifier for link styling and branding", "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "minLength" : 1 }, "descriptions" : { "type" : "array", "description" : "Localized link descriptions", "items" : { "$ref" : "#/components/schemas/SimpleDescription_ManagingEntity" }, "maxItems" : 2147483647, "minItems" : 1 }, "facebookAppId" : { "type" : "string", "description" : "Facebook APP ID is used with OpenGraph data", "example" : "19827398721938798237" }, "id" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier for this record.", "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, "inventoryStatus" : { "type" : "string", "description" : "Url sell status", "enum" : [ "ACTIVE", "INACTIVE", "REMOVED" ], "example" : "ACTIVE" }, "inventoryType" : { "type" : "string", "description" : "Inventory type", "enum" : [ "HOTEL", "GUEST_ROOM", "MEETING_ROOM", "RESTAURANT", "SPA", "ADD_ON", "ATTRACTION", "ACTIVITY", "PLACE" ], "example" : "GUEST_ROOM" }, "keywords" : { "type" : "array", "description" : "Keywords", "example" : [ "bali" ], "items" : { "type" : "string" }, "maxItems" : 2147483647, "minItems" : 1 }, "lastUpdate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was last updated", "example" : "2026-02-03T16:45:12", "readOnly" : true }, "multimedias" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SimpleMultimedia_ManagingEntity", "description" : "Image entries" }, "maxItems" : 2147483647, "minItems" : 1 }, "name" : { "type" : "string", "description" : "Descriptive name of this url for seller use only", "example" : "My Bali Villa", "minLength" : 1 }, "ownerIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Managing entity (affiliate account) identifier", "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "minLength" : 1 }, "status" : { "type" : "string", "description" : "Url sell status", "enum" : [ "ACTIVE", "INACTIVE", "REMOVED" ], "example" : "ACTIVE" }, "supplierIdentifier" : { "type" : "string", "format" : "uuid", "description" : "The entity supplying the inventory. Usually a hotel.", "example" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "minLength" : 1 }, "theme" : { "type" : "string", "description" : "Url theme controls the look and feel of the ad banner.", "enum" : [ "THEME_1" ], "example" : "THEME_1" }, "transactionalItemIdentifier" : { "type" : "string", "format" : "uuid", "description" : "In use by ancillary items only. Not used for room type or property. The transactional item on the ancillary to retrieve pricing for. If left empty, will find the cheapest priced item.", "example" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29" }, "twitterAccount" : { "type" : "string", "description" : "Twitter account is used with OpenGraph data", "example" : "@travelikoworld" }, "uniqueId" : { "type" : "string", "description" : "Unique link id", "example" : "HBDG87f2", "minLength" : 1 }, "userIdentifier" : { "type" : "string", "format" : "uuid", "description" : "User (account) identifier", "example" : "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "minLength" : 1 }, "version" : { "type" : [ "integer", "null" ], "format" : "int64", "description" : "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.", "example" : 3 } }, "required" : [ "channelInventoryIdentifier", "channelInventoryType", "customizationIdentifier", "descriptions", "inventoryStatus", "inventoryType", "keywords", "multimedias", "name", "ownerIdentifier", "status", "supplierIdentifier", "theme", "uniqueId", "userIdentifier" ] }, "LookupLightweight_ManagingEntity" : { "type" : "object", "description" : "Lightweight representation of a lookup entry used for search auto-complete and inventory discovery", "example" : { "cityName" : "Bangkok", "countryCode" : "TH", "countryName" : "Thailand", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "languageCode" : "en", "location" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "Point" }, "name" : "The Siam Residences", "ownerName" : "The Siam Residences", "subCountryName" : "Bangkok", "subSubCountryName" : "Khlong San District", "type" : "HOTEL", "typeIdentifier" : "a1f3c9d2-7e4b-4a0c-8d5e-2b9f1a6c3e78", "urlName" : "the-siam-residences-bangkok-thailand" }, "properties" : { "cityName" : { "type" : "string", "description" : "Name of the closest city where this lookup entry is located", "example" : "Bangkok" }, "countryCode" : { "type" : "string", "description" : "ISO 3166-1 alpha-2 country code", "example" : "TH" }, "countryName" : { "type" : "string", "description" : "Country name where this lookup entry is located", "example" : "Thailand" }, "createdDate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was first created", "example" : "2026-01-14T09:30:00", "readOnly" : true }, "id" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier for this record.", "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, "languageCode" : { "type" : "string", "description" : "Language code for the lookup name (ISO 639-1 format)", "example" : "en" }, "lastUpdate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was last updated", "example" : "2026-02-03T16:45:12", "readOnly" : true }, "location" : { "$ref" : "#/components/schemas/GeoJsonPoint_ManagingEntity", "description" : "Geo-location", "example" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "POINT" } }, "lowercaseName" : { "type" : "string", "description" : "Lowercase version of the name, used for regex-based search operations. Extranet surfaces only.", "example" : "bangkok" }, "name" : { "type" : "string", "description" : "Human-readable name of the lookup entry", "example" : "Bangkok" }, "origin" : { "type" : "boolean", "description" : "Whether this is the primary/original lookup entry for this resource (true) or a variant like an alternate language or name (false). Extranet surfaces only.", "example" : true }, "ownerIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Identifier of the owner (supplier) that created or manages this lookup entry. Extranet surfaces only — not serialized on public or partner endpoints.", "example" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18" }, "ownerName" : { "type" : "string", "description" : "Name of the owner (supplier) that created this lookup entry", "example" : "The Siam Residences, Bangkok" }, "ownerType" : { "type" : "string", "description" : "Type of owner that created this lookup (TRAVELIKO for platform-managed entries, HOTEL for supplier-created entries). Extranet surfaces only.", "enum" : [ "TRAVELIKO", "HOTEL" ], "example" : "TRAVELIKO" }, "sort" : { "type" : "integer", "format" : "int32", "description" : "Platform-specific sort order (lower values sort first: CITY=1, ISLAND=2, HOTEL=3, others vary). Extranet surfaces only.", "example" : 1 }, "subCountryName" : { "type" : "string", "description" : "State or province where this lookup entry is located", "example" : "Bangkok" }, "subSubCountryName" : { "type" : "string", "description" : "County or district where this lookup entry is located", "example" : "Khlong San District" }, "type" : { "type" : "string", "description" : "Type of lookup (CITY, HOTEL, ACTIVITY, SPA, RESTAURANT, ATTRACTION, ISLAND, COUNTRY, PLACE, MEETING_ROOM)", "enum" : [ "CITY", "ISLAND", "HOTEL", "SPA", "MEETING_ROOM", "RESTAURANT", "ATTRACTION", "ACTIVITY", "PLACE", "COUNTRY" ], "example" : "CITY" }, "typeIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier for the lookup type resource (e.g., hotel ID, city geoname ID)", "example" : "1609350" }, "urlName" : { "type" : "string", "description" : "URL-friendly slug that uniquely identifies this lookup within its type and location", "example" : "bangkok-thailand" }, "version" : { "type" : [ "integer", "null" ], "format" : "int64", "description" : "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.", "example" : 3 } }, "required" : [ "location" ] }, "UpsertSellableRankedListRequest_ManagingEntity" : { "type" : "object", "example" : { "animate" : false, "animateDelay" : 500, "customizationIdentifier" : "7d2e4f1a-6c8b-4a9e-b3d5-1e7f2a0c5b8d", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "displayType" : "NATIVE", "keywords" : [ "luxury" ], "lookup" : { "cityName" : "Bangkok", "countryCode" : "TH", "countryName" : "Thailand", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "languageCode" : "en", "location" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "Point" }, "name" : "The Siam Residences", "ownerName" : "The Siam Residences", "subCountryName" : "Bangkok", "subSubCountryName" : "Khlong San District", "type" : "HOTEL", "typeIdentifier" : "a1f3c9d2-7e4b-4a0c-8d5e-2b9f1a6c3e78", "urlName" : "the-siam-residences-bangkok-thailand" }, "name" : "Featured Luxury Resorts Bangkok", "sort" : "MEMBER" }, "properties" : { "animate" : { "type" : "boolean", "default" : false, "description" : "Create an animated gif instead of a list of images", "example" : false }, "animateDelay" : { "type" : "integer", "format" : "int32", "default" : -1, "description" : "Controls animation delay in milliseconds; -1 to disable", "example" : 500 }, "customizationIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Customization identifier", "example" : "7d2e4f1a-6c8b-4a9e-b3d5-1e7f2a0c5b8d", "minLength" : 1 }, "descriptions" : { "type" : "array", "description" : "Contains custom title and description of grid", "items" : { "$ref" : "#/components/schemas/SimpleDescription_ManagingEntity" }, "maxItems" : 2147483647, "minItems" : 1 }, "displayType" : { "type" : "string", "default" : "NATIVE", "description" : "Indicate which initial values to display first on the front-facing card", "enum" : [ "NATIVE", "HOTEL", "ROOM" ], "example" : "NATIVE" }, "keywords" : { "type" : "array", "items" : { "type" : "string", "description" : "Keywords for SEO purposes", "example" : "luxury" }, "maxItems" : 2147483647, "minItems" : 1 }, "lookup" : { "$ref" : "#/components/schemas/LookupLightweight_ManagingEntity", "description" : "The destination to display ranked inventory from." }, "name" : { "type" : "string", "description" : "Descriptive name of this list for seller use only", "example" : "Featured Luxury Resorts Bangkok", "minLength" : 1 }, "sort" : { "type" : "string", "description" : "Determines which badge to show on the Web Component. Is also used to sort properties for search grids.", "enum" : [ "RECOMMENDED", "PRICE_LOW_TO_HIGH", "PRICE_HIGH_TO_LOW", "ECO" ], "example" : "MEMBER" } }, "required" : [ "customizationIdentifier", "descriptions", "keywords", "lookup", "name" ] }, "SellableRankedListLightweight_ManagingEntity" : { "type" : "object", "description" : "Lightweight projection of a ranked sellable list used in listings and event payloads, containing all display and configuration fields without audit metadata", "example" : { "animate" : false, "animateDelay" : 500, "createdDate" : "2026-01-14T09:30:00", "customizationIdentifier" : "7d2e4f1a-6c8b-4a9e-b3d5-1e7f2a0c5b8d", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "displayType" : "NATIVE", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "keywords" : [ "luxury" ], "lastUpdate" : "2026-02-03T16:45:12", "lookup" : { "cityName" : "Bangkok", "countryCode" : "TH", "countryName" : "Thailand", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "languageCode" : "en", "location" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "Point" }, "name" : "The Siam Residences", "ownerName" : "The Siam Residences", "subCountryName" : "Bangkok", "subSubCountryName" : "Khlong San District", "type" : "HOTEL", "typeIdentifier" : "a1f3c9d2-7e4b-4a0c-8d5e-2b9f1a6c3e78", "urlName" : "the-siam-residences-bangkok-thailand" }, "name" : "Featured Luxury Resorts Bangkok", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "sort" : "MEMBER", "status" : "ACTIVE", "version" : 3 }, "properties" : { "animate" : { "type" : "boolean", "default" : false, "description" : "Create an animated gif instead of a list of images", "example" : false }, "animateDelay" : { "type" : "integer", "format" : "int32", "default" : -1, "description" : "Controls animation delay in milliseconds; -1 to disable", "example" : 500 }, "createdDate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was first created", "example" : "2026-01-14T09:30:00", "readOnly" : true }, "customizationIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Customization identifier", "example" : "7d2e4f1a-6c8b-4a9e-b3d5-1e7f2a0c5b8d", "minLength" : 1 }, "descriptions" : { "type" : "array", "description" : "Contains custom title and description of grid", "items" : { "$ref" : "#/components/schemas/SimpleDescription_ManagingEntity" }, "maxItems" : 2147483647, "minItems" : 1 }, "displayType" : { "type" : "string", "default" : "NATIVE", "description" : "Indicate which initial values to display first on the front-facing card", "enum" : [ "NATIVE", "HOTEL", "ROOM" ], "example" : "NATIVE" }, "id" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier for this record.", "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, "keywords" : { "type" : "array", "items" : { "type" : "string", "description" : "Keywords for SEO purposes", "example" : "luxury" }, "maxItems" : 2147483647, "minItems" : 1 }, "lastUpdate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was last updated", "example" : "2026-02-03T16:45:12", "readOnly" : true }, "lookup" : { "$ref" : "#/components/schemas/LookupLightweight_ManagingEntity", "description" : "The destination to display ranked inventory from." }, "name" : { "type" : "string", "description" : "Descriptive name of this list for seller use only", "example" : "Featured Luxury Resorts Bangkok", "minLength" : 1 }, "ownerIdentifier" : { "type" : "string", "format" : "uuid", "description" : "AffiliateAccount identifier", "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "minLength" : 1 }, "sort" : { "type" : "string", "description" : "Determines which badge to show on the Web Component. Is also used to sort properties for search grids.", "enum" : [ "RECOMMENDED", "PRICE_LOW_TO_HIGH", "PRICE_HIGH_TO_LOW", "ECO" ], "example" : "MEMBER" }, "status" : { "type" : "string", "default" : "ACTIVE", "description" : "Status", "enum" : [ "ACTIVE", "INACTIVE", "REMOVED" ], "example" : "ACTIVE" }, "version" : { "type" : [ "integer", "null" ], "format" : "int64", "description" : "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.", "example" : 3 } }, "required" : [ "customizationIdentifier", "descriptions", "keywords", "lookup", "name", "ownerIdentifier", "status" ] }, "ConfigurableGeoJsonCircle_ManagingEntity" : { "type" : "object", "description" : "A way to persist a GeoJSON circle", "example" : { "radius" : 2.5 }, "properties" : { "point" : { "$ref" : "#/components/schemas/GeoJsonPoint_ManagingEntity", "description" : "Circle center point" }, "radius" : { "type" : "number", "format" : "double", "description" : "Circle radius from center", "example" : 2.5 } }, "required" : [ "point", "radius" ] }, "ConfigurableGeoJsonPoint_ManagingEntity" : { "type" : "object", "description" : "A way to persist a GeoJSON map point", "properties" : { "point" : { "$ref" : "#/components/schemas/GeoJsonPoint_ManagingEntity", "description" : "A GeoJSON point" } }, "required" : [ "point" ] }, "ConfigurableGeoJsonPolygon_ManagingEntity" : { "type" : "object", "description" : "A way to persist a GeoJSON polygon", "properties" : { "polygon" : { "$ref" : "#/components/schemas/GeoJsonPolygon_ManagingEntity", "description" : "A GeoJSON polygon" } }, "required" : [ "polygon" ] }, "ConfigurableGeoJsonRectangle_ManagingEntity" : { "type" : "object", "description" : "A way to persist a GeoJSON rectangle", "properties" : { "rectangle" : { "$ref" : "#/components/schemas/GeoJsonRectangle_ManagingEntity", "description" : "A GeoJSON rectangle" } }, "required" : [ "rectangle" ] }, "GeoJsonLineString_ManagingEntity" : { "type" : "object", "properties" : { "coordinates" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Point_ManagingEntity" } }, "type" : { "type" : "string" } } }, "GeoJsonPolygon_ManagingEntity" : { "type" : "object", "properties" : { "coordinates" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GeoJsonLineString_ManagingEntity" } }, "points" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Point_ManagingEntity" } }, "type" : { "type" : "string" } } }, "GeoJsonRectangle_ManagingEntity" : { "type" : "object", "description" : "A geographic bounding rectangle defined by south-west and north-east GeoJSON points", "properties" : { "northEast" : { "$ref" : "#/components/schemas/GeoJsonPoint_ManagingEntity", "description" : "North-east corner of the geographic bounding rectangle" }, "southWest" : { "$ref" : "#/components/schemas/GeoJsonPoint_ManagingEntity", "description" : "South-west corner of the geographic bounding rectangle" } }, "required" : [ "northEast", "southWest" ] }, "Point_ManagingEntity" : { "type" : "object", "properties" : { "x" : { "type" : "number", "format" : "double" }, "y" : { "type" : "number", "format" : "double" } } }, "UpsertInventoryMapRequest_ManagingEntity" : { "type" : "object", "description" : "Request to create or update a map configuration for displaying inventory", "example" : { "center" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "Point" }, "circles" : [ { "radius" : 2.5 } ], "customizationIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "displayType" : "NATIVE", "draggable" : true, "initialZoomLevel" : 15, "mapHeight" : 500, "mapMarkerColor" : "cc2138", "mapStyle" : "normal", "name" : "Premium Hotels in Southeast Asia", "type" : "LIST", "typeIdentifier" : "7a0c5d9e-2f6b-4c1a-8e4d-3b9f1a0c6d52", "zoomable" : true }, "properties" : { "center" : { "$ref" : "#/components/schemas/GeoJsonPoint_ManagingEntity", "description" : "GeoJSON point defining map center (longitude, latitude)", "example" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "Point" } }, "circles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConfigurableGeoJsonCircle_ManagingEntity", "description" : "Optional circular overlay regions on the map" } }, "customizationIdentifier" : { "type" : "string", "format" : "uuid", "description" : "UUID of the customization context (e.g., Wink Links, channel manager)", "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "minLength" : 1 }, "displayType" : { "type" : "string", "default" : "NATIVE", "description" : "Which data to display initially (NATIVE, MODIFIED, or AFFILIATE)", "enum" : [ "NATIVE", "HOTEL", "ROOM" ], "example" : "NATIVE" }, "draggable" : { "type" : "boolean", "default" : true, "description" : "Allow users to pan the map by dragging", "example" : true }, "initialZoomLevel" : { "type" : "integer", "format" : "int32", "description" : "Initial zoom level (0-21, where 0 shows the entire world)", "example" : 15, "maximum" : 21, "minimum" : 0 }, "mapHeight" : { "type" : "integer", "format" : "int32", "description" : "Height of the embedded map in pixels", "example" : 500, "minimum" : 1 }, "mapMarkerColor" : { "type" : "string", "description" : "Hexadecimal color code for map markers", "enum" : [ "cc2138" ], "example" : "cc2138" }, "mapStyle" : { "type" : "string", "description" : "Map visual style (normal, clean, or bluish)", "enum" : [ "normal", "clean", "bluish" ], "example" : "normal" }, "markers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConfigurableGeoJsonPoint_ManagingEntity", "description" : "Optional custom markers to display on the map" } }, "name" : { "type" : "string", "description" : "Display name for this map", "example" : "Premium Hotels in Southeast Asia", "minLength" : 1 }, "polygons" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConfigurableGeoJsonPolygon_ManagingEntity", "description" : "Optional polygonal overlay regions on the map" } }, "rectangles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConfigurableGeoJsonRectangle_ManagingEntity", "description" : "Optional rectangular overlay regions on the map" } }, "type" : { "type" : "string", "description" : "Category of inventory being displayed (SINGLE, LIST, or SEARCH)", "enum" : [ "SINGLE", "LIST", "SEARCH" ], "example" : "LIST" }, "typeIdentifier" : { "type" : "string", "format" : "uuid", "description" : "UUID of the inventory source: single channel inventory, curated list, or dynamic search", "example" : "7a0c5d9e-2f6b-4c1a-8e4d-3b9f1a0c6d52", "minLength" : 1 }, "zoomable" : { "type" : "boolean", "default" : true, "description" : "Allow users to zoom in and out", "example" : true } }, "required" : [ "center", "customizationIdentifier", "displayType", "draggable", "initialZoomLevel", "mapHeight", "mapMarkerColor", "mapStyle", "name", "type", "typeIdentifier", "zoomable" ] }, "InventoryMapLightweight_ManagingEntity" : { "type" : "object", "example" : { "center" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "Point" }, "circles" : [ { "radius" : 2.5 } ], "customizationIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "displayType" : "NATIVE", "draggable" : true, "identifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "initialZoomLevel" : 15, "mapHeight" : 500, "mapMarkerColor" : "cc2138", "mapStyle" : "normal", "name" : "Premium Hotels in Southeast Asia", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "type" : "LIST", "typeIdentifier" : "7a0c5d9e-2f6b-4c1a-8e4d-3b9f1a0c6d52", "zoomable" : true }, "properties" : { "center" : { "$ref" : "#/components/schemas/GeoJsonPoint_ManagingEntity", "description" : "GeoJSON point defining map center (longitude, latitude)", "example" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "Point" } }, "circles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConfigurableGeoJsonCircle_ManagingEntity", "description" : "Optional circular overlay regions on the map" } }, "customizationIdentifier" : { "type" : "string", "format" : "uuid", "description" : "UUID of the customization context (e.g., Wink Links, channel manager)", "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "minLength" : 1 }, "displayType" : { "type" : "string", "default" : "NATIVE", "description" : "Which data to display initially (NATIVE, MODIFIED, or AFFILIATE)", "enum" : [ "NATIVE", "HOTEL", "ROOM" ], "example" : "NATIVE" }, "draggable" : { "type" : "boolean", "default" : true, "description" : "Allow users to pan the map by dragging", "example" : true }, "identifier" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier of this map (assigned by server)", "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "minLength" : 1 }, "initialZoomLevel" : { "type" : "integer", "format" : "int32", "description" : "Initial zoom level (0-21, where 0 shows the entire world)", "example" : 15, "maximum" : 21, "minimum" : 0 }, "mapHeight" : { "type" : "integer", "format" : "int32", "description" : "Height of the embedded map in pixels", "example" : 500, "minimum" : 1 }, "mapMarkerColor" : { "type" : "string", "description" : "Hexadecimal color code for map markers", "enum" : [ "cc2138" ], "example" : "cc2138" }, "mapStyle" : { "type" : "string", "description" : "Map visual style (normal, clean, or bluish)", "enum" : [ "normal", "clean", "bluish" ], "example" : "normal" }, "markers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConfigurableGeoJsonPoint_ManagingEntity", "description" : "Optional custom markers to display on the map" } }, "name" : { "type" : "string", "description" : "Display name for this map", "example" : "Premium Hotels in Southeast Asia", "minLength" : 1 }, "ownerIdentifier" : { "type" : "string", "format" : "uuid", "description" : "UUID of the managing entity that owns this map", "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "minLength" : 1 }, "polygons" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConfigurableGeoJsonPolygon_ManagingEntity", "description" : "Optional polygonal overlay regions on the map" } }, "rectangles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConfigurableGeoJsonRectangle_ManagingEntity", "description" : "Optional rectangular overlay regions on the map" } }, "type" : { "type" : "string", "description" : "Category of inventory being displayed (SINGLE, LIST, or SEARCH)", "enum" : [ "SINGLE", "LIST", "SEARCH" ], "example" : "LIST" }, "typeIdentifier" : { "type" : "string", "format" : "uuid", "description" : "UUID of the inventory source: single channel inventory, curated list, or dynamic search", "example" : "7a0c5d9e-2f6b-4c1a-8e4d-3b9f1a0c6d52", "minLength" : 1 }, "zoomable" : { "type" : "boolean", "default" : true, "description" : "Allow users to zoom in and out", "example" : true } }, "required" : [ "center", "customizationIdentifier", "displayType", "draggable", "identifier", "initialZoomLevel", "mapHeight", "mapMarkerColor", "mapStyle", "name", "ownerIdentifier", "type", "typeIdentifier", "zoomable" ] }, "UpsertSellableItemRequest_ManagingEntity" : { "type" : "object", "description" : "Request payload for creating or updating a sellable item, specifying the inventory, display configuration, and media assets to associate with the listing.", "example" : { "animate" : false, "animateDelay" : 800, "channelInventoryIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "channelInventoryType" : "GUEST_ROOM", "customizationIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "displayType" : "NATIVE", "inventoryType" : "HOTEL", "keywords" : [ "luxury-accommodation" ], "multimedias" : [ { "angle" : null, "attribution" : [ ], "category" : "2", "descriptions" : [ { "description" : "Elegant lobby of The Siam Residences", "language" : "en", "title" : "Lobby Entrance" } ], "height" : 1600, "identifier" : "the-siam-residences/lobby-entrance", "isLandscape" : true, "lifestyleType" : null, "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "source" : "CLOUDINARY", "type" : "IMAGE", "width" : 2560 } ], "name" : "Deluxe Room with Spa Access", "sort" : "POPULARITY", "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18" }, "properties" : { "animate" : { "type" : "boolean", "default" : false, "description" : "Create an animated gif instead of a list of images. Feature currently not available. Feel free to enable and it will become available at a later date.", "example" : false }, "animateDelay" : { "type" : "integer", "format" : "int32", "description" : "Controls animation delay in milliseconds", "example" : 800 }, "channelInventoryIdentifier" : { "type" : "string", "format" : "uuid", "description" : "The channel inventory record identifier describing the relationship between supplier and seller", "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "minLength" : 1 }, "channelInventoryType" : { "type" : "string", "description" : "Channel inventory type is a subset of inventory type in that it does not include the `HOTEL` type. THe way it works is, as a seller you might want to sell a guest room but instead of showing the price of that guest room, you would like to display the best room type price for the property.", "enum" : [ "GUEST_ROOM", "ADD_ON", "MEETING_ROOM", "RESTAURANT", "SPA", "ATTRACTION", "PLACE", "ACTIVITY" ], "example" : "GUEST_ROOM" }, "customizationIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Which configuration to use with this item", "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "minLength" : 1 }, "descriptions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SimpleDescription_ManagingEntity", "description" : "Title and description of inventory." }, "maxItems" : 2147483647, "minItems" : 1 }, "displayType" : { "type" : "string", "default" : "NATIVE", "description" : "Indicate which initial values to display first on the front-facing card", "enum" : [ "NATIVE", "HOTEL", "ROOM" ], "example" : "NATIVE" }, "inventoryType" : { "type" : "string", "description" : "The type of inventory being offer up for sale", "enum" : [ "HOTEL", "GUEST_ROOM", "MEETING_ROOM", "RESTAURANT", "SPA", "ADD_ON", "ATTRACTION", "ACTIVITY", "PLACE" ], "example" : "HOTEL" }, "keywords" : { "type" : "array", "items" : { "type" : "string", "description" : "Keywords describing this item for discovery", "example" : "luxury-accommodation" }, "maxItems" : 2147483647, "minItems" : 1 }, "multimedias" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SimpleMultimedia_ManagingEntity", "description" : "Reference identifiers to Cloudinary media assets" }, "maxItems" : 2147483647, "minItems" : 1 }, "name" : { "type" : "string", "description" : "Descriptive name of this item for seller use", "example" : "Deluxe Room with Spa Access", "minLength" : 1 }, "sort" : { "type" : "string", "description" : "The specific badge to display over the image on the Web Component.", "enum" : [ "RECOMMENDED", "PRICE_LOW_TO_HIGH", "PRICE_HIGH_TO_LOW", "ECO" ], "example" : "POPULARITY" }, "supplierIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Supplier / Hotel identifier that owns this inventory", "example" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "minLength" : 1 } }, "required" : [ "channelInventoryIdentifier", "channelInventoryType", "customizationIdentifier", "descriptions", "displayType", "inventoryType", "keywords", "multimedias", "name", "supplierIdentifier" ] }, "SellableItemLightweight_ManagingEntity" : { "type" : "object", "description" : "Lightweight projection of a sellable item, carrying all display and inventory configuration fields needed by consumers without requiring the full document model.", "example" : { "animate" : false, "animateDelay" : 800, "channelInventoryIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "channelInventoryType" : "GUEST_ROOM", "customizationIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "displayType" : "NATIVE", "identifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "inventoryStatus" : "ACTIVE", "inventoryType" : "HOTEL", "keywords" : [ "luxury-accommodation" ], "multimedias" : [ { "angle" : null, "attribution" : [ ], "category" : "2", "descriptions" : [ { "description" : "Elegant lobby of The Siam Residences", "language" : "en", "title" : "Lobby Entrance" } ], "height" : 1600, "identifier" : "the-siam-residences/lobby-entrance", "isLandscape" : true, "lifestyleType" : null, "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "source" : "CLOUDINARY", "type" : "IMAGE", "width" : 2560 } ], "name" : "Deluxe Room with Spa Access", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "sort" : "POPULARITY", "status" : "ACTIVE", "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18" }, "properties" : { "animate" : { "type" : "boolean", "default" : false, "description" : "Create an animated gif instead of a list of images. Feature currently not available. Feel free to enable and it will become available at a later date.", "example" : false }, "animateDelay" : { "type" : "integer", "format" : "int32", "description" : "Controls animation delay in milliseconds", "example" : 800 }, "channelInventoryIdentifier" : { "type" : "string", "format" : "uuid", "description" : "The channel inventory record identifier describing the relationship between supplier and seller", "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "minLength" : 1 }, "channelInventoryType" : { "type" : "string", "description" : "Channel inventory type is a subset of inventory type in that it does not include the `HOTEL` type. THe way it works is, as a seller you might want to sell a guest room but instead of showing the price of that guest room, you would like to display the best room type price for the property.", "enum" : [ "GUEST_ROOM", "ADD_ON", "MEETING_ROOM", "RESTAURANT", "SPA", "ATTRACTION", "PLACE", "ACTIVITY" ], "example" : "GUEST_ROOM" }, "customizationIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Which configuration to use with this item", "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "minLength" : 1 }, "descriptions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SimpleDescription_ManagingEntity", "description" : "Title and description of inventory." }, "maxItems" : 2147483647, "minItems" : 1 }, "displayType" : { "type" : "string", "default" : "NATIVE", "description" : "Indicate which initial values to display first on the front-facing card", "enum" : [ "NATIVE", "HOTEL", "ROOM" ], "example" : "NATIVE" }, "identifier" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier of this sellable item", "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "minLength" : 1 }, "inventoryStatus" : { "type" : "string", "description" : "Url sell status", "enum" : [ "ACTIVE", "INACTIVE", "REMOVED" ], "example" : "ACTIVE" }, "inventoryType" : { "type" : "string", "description" : "The type of inventory being offer up for sale", "enum" : [ "HOTEL", "GUEST_ROOM", "MEETING_ROOM", "RESTAURANT", "SPA", "ADD_ON", "ATTRACTION", "ACTIVITY", "PLACE" ], "example" : "HOTEL" }, "keywords" : { "type" : "array", "items" : { "type" : "string", "description" : "Keywords describing this item for discovery", "example" : "luxury-accommodation" }, "maxItems" : 2147483647, "minItems" : 1 }, "multimedias" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SimpleMultimedia_ManagingEntity", "description" : "Reference identifiers to Cloudinary media assets" }, "maxItems" : 2147483647, "minItems" : 1 }, "name" : { "type" : "string", "description" : "Descriptive name of this item for seller use", "example" : "Deluxe Room with Spa Access", "minLength" : 1 }, "ownerIdentifier" : { "type" : "string", "format" : "uuid", "description" : "AffiliateAccount / Owner identifier", "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "minLength" : 1 }, "sort" : { "type" : "string", "description" : "The specific badge to display over the image on the Web Component.", "enum" : [ "RECOMMENDED", "PRICE_LOW_TO_HIGH", "PRICE_HIGH_TO_LOW", "ECO" ], "example" : "POPULARITY" }, "status" : { "type" : "string", "default" : "ACTIVE", "description" : "Availability status", "enum" : [ "ACTIVE", "INACTIVE", "REMOVED" ], "example" : "ACTIVE" }, "supplierIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Supplier / Hotel identifier that owns this inventory", "example" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "minLength" : 1 } }, "required" : [ "channelInventoryIdentifier", "channelInventoryType", "customizationIdentifier", "descriptions", "displayType", "identifier", "inventoryStatus", "inventoryType", "keywords", "multimedias", "name", "ownerIdentifier", "status", "supplierIdentifier" ] }, "UpsertSellableListRequest_ManagingEntity" : { "type" : "object", "description" : "Request payload for creating or updating a sellable list configuration, supplying all display, localization, and inventory settings", "example" : { "animate" : false, "animateDelay" : 500, "customizationIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "displayType" : "NATIVE", "keywords" : [ "bangkok", "luxury" ], "listIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "listType" : "LIST", "name" : "Luxury Bangkok Properties", "sort" : "MEMBER" }, "properties" : { "animate" : { "type" : "boolean", "default" : false, "description" : "Generate an animated GIF from multiple images instead of a static grid (requires at least 2 images)", "example" : false }, "animateDelay" : { "type" : "integer", "format" : "int32", "default" : -1, "description" : "Delay between animation frames in milliseconds; -1 disables animation", "example" : 500 }, "customizationIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Customization configuration identifier", "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "minLength" : 1 }, "descriptions" : { "type" : "array", "description" : "Localized title and description of grid (at least one entry in English required)", "items" : { "$ref" : "#/components/schemas/SimpleDescription_ManagingEntity" }, "maxItems" : 2147483647, "minItems" : 1 }, "displayType" : { "type" : "string", "default" : "NATIVE", "description" : "Initial display format on the front-facing card (NATIVE or alternative format)", "enum" : [ "NATIVE", "HOTEL", "ROOM" ], "example" : "NATIVE" }, "keywords" : { "type" : "array", "description" : "Keywords and metadata tags for SEO and filtering", "example" : [ "bangkok", "luxury" ], "items" : { "type" : "string" }, "maxItems" : 2147483647, "minItems" : 1 }, "listIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Inventory record identifier for the curated list, saved search, or channel", "example" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "minLength" : 1 }, "listType" : { "type" : "string", "description" : "Type of inventory being curated (LIST, SEARCH, CHANNEL)", "enum" : [ "SINGLE", "LIST", "SEARCH" ], "example" : "LIST" }, "name" : { "type" : "string", "description" : "Descriptive name of this grid for seller use only", "example" : "Luxury Bangkok Properties", "minLength" : 1 }, "sort" : { "type" : "string", "description" : "Badge type and sort order for display on web component (MEMBER, BEST_VALUE, TOP_RATED, etc.)", "enum" : [ "RECOMMENDED", "PRICE_LOW_TO_HIGH", "PRICE_HIGH_TO_LOW", "ECO" ], "example" : "MEMBER" } }, "required" : [ "customizationIdentifier", "descriptions", "displayType", "keywords", "listIdentifier", "listType", "name" ] }, "SellableListLightweight_ManagingEntity" : { "type" : "object", "description" : "Lightweight projection of a sellable list used in listings and event payloads, containing all display and configuration fields without audit metadata", "example" : { "animate" : false, "animateDelay" : 500, "createdDate" : "2026-01-14T09:30:00", "customizationIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "displayType" : "NATIVE", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "keywords" : [ "bangkok", "luxury" ], "lastUpdate" : "2026-02-03T16:45:12", "listIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "listType" : "LIST", "name" : "Luxury Bangkok Properties", "sellerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "sort" : "MEMBER", "status" : "ACTIVE", "version" : 3 }, "properties" : { "animate" : { "type" : "boolean", "default" : false, "description" : "Generate an animated GIF from multiple images instead of a static grid (requires at least 2 images)", "example" : false }, "animateDelay" : { "type" : "integer", "format" : "int32", "default" : -1, "description" : "Delay between animation frames in milliseconds; -1 disables animation", "example" : 500 }, "createdDate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was first created", "example" : "2026-01-14T09:30:00", "readOnly" : true }, "customizationIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Customization configuration identifier", "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "minLength" : 1 }, "descriptions" : { "type" : "array", "description" : "Localized title and description of grid (at least one entry in English required)", "items" : { "$ref" : "#/components/schemas/SimpleDescription_ManagingEntity" }, "maxItems" : 2147483647, "minItems" : 1 }, "displayType" : { "type" : "string", "default" : "NATIVE", "description" : "Initial display format on the front-facing card (NATIVE or alternative format)", "enum" : [ "NATIVE", "HOTEL", "ROOM" ], "example" : "NATIVE" }, "id" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier for this record.", "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, "keywords" : { "type" : "array", "description" : "Keywords and metadata tags for SEO and filtering", "example" : [ "bangkok", "luxury" ], "items" : { "type" : "string" }, "maxItems" : 2147483647, "minItems" : 1 }, "lastUpdate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was last updated", "example" : "2026-02-03T16:45:12", "readOnly" : true }, "listIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Inventory record identifier for the curated list, saved search, or channel", "example" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "minLength" : 1 }, "listType" : { "type" : "string", "description" : "Type of inventory being curated (LIST, SEARCH, CHANNEL)", "enum" : [ "SINGLE", "LIST", "SEARCH" ], "example" : "LIST" }, "name" : { "type" : "string", "description" : "Descriptive name of this grid for seller use only", "example" : "Luxury Bangkok Properties", "minLength" : 1 }, "sellerIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Managing entity (account owner) identifier", "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "minLength" : 1 }, "sort" : { "type" : "string", "description" : "Badge type and sort order for display on web component (MEMBER, BEST_VALUE, TOP_RATED, etc.)", "enum" : [ "RECOMMENDED", "PRICE_LOW_TO_HIGH", "PRICE_HIGH_TO_LOW", "ECO" ], "example" : "MEMBER" }, "status" : { "type" : "string", "default" : "ACTIVE", "description" : "Current status of the grid (ACTIVE, INACTIVE, ARCHIVED)", "enum" : [ "ACTIVE", "INACTIVE", "REMOVED" ], "example" : "ACTIVE" }, "version" : { "type" : [ "integer", "null" ], "format" : "int64", "description" : "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.", "example" : 3 } }, "required" : [ "customizationIdentifier", "descriptions", "displayType", "keywords", "listIdentifier", "listType", "name", "sellerIdentifier", "status" ] }, "UpsertDynamicListRequest_ManagingEntity" : { "type" : "object", "description" : "Request payload to create or update a dynamic inventory search list with filter criteria and sort preferences.", "example" : { "aggregateReviewRating" : 8, "architecturalStyles" : 50, "cities" : [ "1609350" ], "continents" : [ "AS" ], "countries" : [ "1605651" ], "hotelCategories" : 1, "hotelStars" : 5, "inventoryName" : "Deluxe Suite", "inventoryTypes" : [ "GUEST_ROOM" ], "lifestyles" : "LIFESTYLE_RELAX", "locationCategories" : 1701, "name" : "Bangkok Luxury Hotels", "primaryOrderBy" : "4", "propertyName" : "The Siam", "radiusInMeters" : 5000, "segmentCategories" : 7, "showChildFriendly" : false, "showDirectOnly" : false, "showEcoFriendly" : false, "showPetFriendly" : false, "showPopular" : false }, "properties" : { "aggregateReviewRating" : { "type" : "integer", "format" : "int32", "description" : "Filter on aggregate review score the hotel has", "example" : 8 }, "architecturalStyles" : { "type" : "array", "description" : "Supported OTA specification `ARC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", "example" : 50, "items" : { "type" : "string" } }, "cities" : { "type" : "array", "description" : "City filter", "items" : { "type" : "string", "description" : "Filter on GeoNameId of city", "example" : "1609350" } }, "continents" : { "type" : "array", "description" : "Continent filter", "items" : { "type" : "string", "description" : "Filter on standardized continent codes", "example" : "AS" } }, "countries" : { "type" : "array", "description" : "Country filter", "items" : { "type" : "string", "description" : "Filter on GeoNameId of country", "example" : "1605651" } }, "hotelCategories" : { "type" : "array", "description" : "Supported OTA specification `PCT` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", "example" : 1, "items" : { "type" : "string" } }, "hotelStars" : { "type" : "integer", "format" : "int32", "description" : "Filter on number of stars the hotel has.", "example" : 5 }, "inventoryName" : { "type" : "string", "description" : "Regex expression filter matching on inventory name", "example" : "Deluxe Suite" }, "inventoryTypes" : { "type" : "array", "description" : "Filter on inventory types", "items" : { "type" : "string", "description" : "Type of sellable travel inventory on the Wink platform", "enum" : [ "GUEST_ROOM", "ADD_ON", "MEETING_ROOM", "RESTAURANT", "SPA", "ATTRACTION", "PLACE", "ACTIVITY" ], "example" : "GUEST_ROOM" } }, "lifestyles" : { "type" : "array", "description" : "Filter on lifestyles", "example" : "LIFESTYLE_RELAX", "items" : { "type" : "string", "description" : "Specific lifestyle preference type used to match travelers with suitable inventory", "enum" : [ "LIFESTYLE_HEALTH_FITNESS", "LIFESTYLE_RELAX", "LIFESTYLE_ADULT_ONLY", "LIFESTYLE_ADVENTURE", "LIFESTYLE_BUSINESS", "LIFESTYLE_LGBT", "LIFESTYLE_SINGLE_PARENT", "LIFESTYLE_SOLO_FEMALE", "LIFESTYLE_BEAUTY", "LIFESTYLE_FOODIE", "LIFESTYLE_FAMILY", "LIFESTYLE_ROMANCE", "LIFESTYLE_COUPLE", "LIFESTYLE_SOLO", "LIFESTYLE_BACKPACKER", "LIFESTYLE_SHOPPING", "LIFESTYLE_SPORTS", "LIFESTYLE_MOUNTAIN", "LIFESTYLE_BEACH", "LIFESTYLE_CITY", "LIFESTYLE_COUNTRY", "LIFESTYLE_CULTURE", "LIFESTYLE_ECO" ] } }, "locationCategories" : { "type" : "array", "description" : "Supported OTA specification `LOC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", "example" : 1701, "items" : { "type" : "string" } }, "name" : { "type" : "string", "description" : "Name of dynamic list for when user want to persist it", "example" : "Bangkok Luxury Hotels", "minLength" : 1 }, "nearPoint" : { "$ref" : "#/components/schemas/GeoJsonPoint_ManagingEntity", "description" : "Find hotels close to certain location" }, "primaryOrderBy" : { "type" : "string", "description" : "Control how you want the search results sorted. Options are: \n\n- 1: Inventory name\n- 2: Price: High to low\n- 3: Price: Low to high\n- 4: Commission: High to low\n- 5: Commission: Low to high\n- 6: Discount: High to low\n- 7: Discount: Low to high\n", "example" : "4" }, "propertyName" : { "type" : "string", "description" : "Regex expression filter matching on property name.", "example" : "The Siam" }, "radiusInMeters" : { "type" : "integer", "format" : "int64", "default" : 0, "description" : "Use this in conjunction with `nearPoint`. Control the distance from point we are searching for.", "example" : 5000 }, "segmentCategories" : { "type" : "array", "description" : "Supported OTA specification `SEG` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", "example" : 7, "items" : { "type" : "string" } }, "showChildFriendly" : { "type" : "boolean", "default" : false, "description" : "Filter on child-friendly hotels", "example" : false }, "showDirectOnly" : { "type" : "boolean", "default" : false, "description" : "Filter on direct inventory", "example" : false }, "showEcoFriendly" : { "type" : "boolean", "default" : false, "description" : "Filter on eco-friendly hotels", "example" : false }, "showPetFriendly" : { "type" : "boolean", "default" : false, "description" : "Filter on pet-friendly hotels", "example" : false }, "showPopular" : { "type" : "boolean", "default" : false, "description" : "Filter on hotel that has had a certain amount of bookings", "example" : false } }, "required" : [ "name" ] }, "DynamicListLightweight_ManagingEntity" : { "type" : "object", "description" : "Lightweight projection of a saved dynamic inventory search, including all filter criteria and sort preferences.", "example" : { "aggregateReviewRating" : 8, "architecturalStyles" : 50, "cities" : [ "1609350" ], "continents" : [ "AS" ], "countries" : [ "1605651" ], "createdDate" : "2026-01-14T09:30:00", "hotelCategories" : 1, "hotelStars" : 5, "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "inventoryName" : "Deluxe Suite", "inventoryTypes" : [ "GUEST_ROOM" ], "lastUpdate" : "2026-02-03T16:45:12", "lifestyles" : "LIFESTYLE_RELAX", "locationCategories" : 1701, "name" : "Bangkok Luxury Hotels", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "primaryOrderBy" : "4", "propertyName" : "The Siam", "radiusInMeters" : 5000, "segmentCategories" : 7, "showChildFriendly" : false, "showDirectOnly" : false, "showEcoFriendly" : false, "showPetFriendly" : false, "showPopular" : false, "version" : 3 }, "properties" : { "aggregateReviewRating" : { "type" : "integer", "format" : "int32", "description" : "Filter on aggregate review score the hotel has", "example" : 8 }, "architecturalStyles" : { "type" : "array", "description" : "Supported OTA specification `ARC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", "example" : 50, "items" : { "type" : "string" } }, "cities" : { "type" : "array", "description" : "City filter", "items" : { "type" : "string", "description" : "Filter on GeoNameId of city", "example" : "1609350" } }, "continents" : { "type" : "array", "description" : "Continent filter", "items" : { "type" : "string", "description" : "Filter on standardized continent codes", "example" : "AS" } }, "countries" : { "type" : "array", "description" : "Country filter", "items" : { "type" : "string", "description" : "Filter on GeoNameId of country", "example" : "1605651" } }, "createdDate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was first created", "example" : "2026-01-14T09:30:00", "readOnly" : true }, "hotelCategories" : { "type" : "array", "description" : "Supported OTA specification `PCT` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", "example" : 1, "items" : { "type" : "string" } }, "hotelStars" : { "type" : "integer", "format" : "int32", "description" : "Filter on number of stars the hotel has.", "example" : 5 }, "id" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier for this record.", "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, "inventoryName" : { "type" : "string", "description" : "Regex expression filter matching on inventory name", "example" : "Deluxe Suite" }, "inventoryTypes" : { "type" : "array", "description" : "Filter on inventory types", "items" : { "type" : "string", "description" : "Type of sellable travel inventory on the Wink platform", "enum" : [ "GUEST_ROOM", "ADD_ON", "MEETING_ROOM", "RESTAURANT", "SPA", "ATTRACTION", "PLACE", "ACTIVITY" ], "example" : "GUEST_ROOM" } }, "lastUpdate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was last updated", "example" : "2026-02-03T16:45:12", "readOnly" : true }, "lifestyles" : { "type" : "array", "description" : "Filter on lifestyles", "example" : "LIFESTYLE_RELAX", "items" : { "type" : "string", "description" : "Specific lifestyle preference type used to match travelers with suitable inventory", "enum" : [ "LIFESTYLE_HEALTH_FITNESS", "LIFESTYLE_RELAX", "LIFESTYLE_ADULT_ONLY", "LIFESTYLE_ADVENTURE", "LIFESTYLE_BUSINESS", "LIFESTYLE_LGBT", "LIFESTYLE_SINGLE_PARENT", "LIFESTYLE_SOLO_FEMALE", "LIFESTYLE_BEAUTY", "LIFESTYLE_FOODIE", "LIFESTYLE_FAMILY", "LIFESTYLE_ROMANCE", "LIFESTYLE_COUPLE", "LIFESTYLE_SOLO", "LIFESTYLE_BACKPACKER", "LIFESTYLE_SHOPPING", "LIFESTYLE_SPORTS", "LIFESTYLE_MOUNTAIN", "LIFESTYLE_BEACH", "LIFESTYLE_CITY", "LIFESTYLE_COUNTRY", "LIFESTYLE_CULTURE", "LIFESTYLE_ECO" ] } }, "locationCategories" : { "type" : "array", "description" : "Supported OTA specification `LOC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", "example" : 1701, "items" : { "type" : "string" } }, "name" : { "type" : "string", "description" : "Name of dynamic list for when user want to persist it", "example" : "Bangkok Luxury Hotels", "minLength" : 1 }, "nearPoint" : { "$ref" : "#/components/schemas/GeoJsonPoint_ManagingEntity", "description" : "Find hotels close to certain location" }, "ownerIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Entity identifier of record creator", "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "minLength" : 1 }, "primaryOrderBy" : { "type" : "string", "description" : "Control how you want the search results sorted. Options are:\n\n- 1: Inventory name\n- 2: Price: High to low\n- 3: Price: Low to high\n- 4: Commission: High to low\n- 5: Commission: Low to high\n- 6: Discount: High to low\n- 7: Discount: Low to high\n", "example" : "4" }, "propertyName" : { "type" : "string", "description" : "Regex expression filter matching on property name.", "example" : "The Siam" }, "radiusInMeters" : { "type" : "integer", "format" : "int64", "default" : 0, "description" : "Use this in conjunction with `nearPoint`. Control the distance from point we are searching for.", "example" : 5000 }, "segmentCategories" : { "type" : "array", "description" : "Supported OTA specification `SEG` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", "example" : 7, "items" : { "type" : "string" } }, "showChildFriendly" : { "type" : "boolean", "default" : false, "description" : "Filter on child-friendly hotels", "example" : false }, "showDirectOnly" : { "type" : "boolean", "default" : false, "description" : "Filter on direct inventory", "example" : false }, "showEcoFriendly" : { "type" : "boolean", "default" : false, "description" : "Filter on eco-friendly hotels", "example" : false }, "showPetFriendly" : { "type" : "boolean", "default" : false, "description" : "Filter on pet-friendly hotels", "example" : false }, "showPopular" : { "type" : "boolean", "default" : false, "description" : "Filter on hotel that has had a certain amount of bookings", "example" : false }, "version" : { "type" : [ "integer", "null" ], "format" : "int64", "description" : "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.", "example" : 3 } }, "required" : [ "name", "ownerIdentifier" ] }, "AggregateDescriptor_ManagingEntity" : { "type" : "object", "description" : "Descriptor that defines an aggregate function to apply to a specific field in a grouped result set.", "example" : { "aggregate" : "count", "field" : "hotel.bookings" }, "properties" : { "aggregate" : { "type" : "string", "description" : "Aggregate function", "enum" : [ "count", "sum", "average", "min", "max" ], "example" : "count" }, "field" : { "type" : "string", "description" : "Field to run aggregate function on", "example" : "hotel.bookings" } } }, "CompositeFilterDescriptor_ManagingEntity" : { "type" : "object", "description" : "Top-level filter container that combines one or more field-level filter descriptors using a logical operator.", "example" : { "filters" : [ { "field" : "hotel.name", "ignoreCase" : true, "operator" : "startsWith", "value" : "Happy Res" } ], "logic" : "and" }, "properties" : { "filters" : { "type" : "array", "description" : "Descriptors used for filtering the result set", "items" : { "$ref" : "#/components/schemas/FilterDescriptor_ManagingEntity" } }, "logic" : { "type" : "string", "description" : "Whether to filter inclusively or exclusively", "enum" : [ "and", "or" ], "example" : "and" } } }, "FilterDescriptor_ManagingEntity" : { "type" : "object", "description" : "A single field-level filter criterion that specifies what to match and how to compare it.", "example" : { "field" : "hotel.name", "ignoreCase" : true, "operator" : "startsWith", "value" : "Happy Res" }, "properties" : { "field" : { "type" : "string", "description" : "Field name to filter on", "example" : "hotel.name", "minLength" : 1 }, "ignoreCase" : { "type" : "boolean", "description" : "Make filter comparison case insensitive. Default: Case sensitive ", "example" : true }, "operator" : { "type" : "string", "description" : "Filter operator to use on field", "enum" : [ "neq", "eq", "contains", "doesnotcontain", "isnull", "isnotnull", "isempty", "isnotempty", "startswith", "endswith", "gte", "lte", "gt", "lt", "in", "nin" ], "example" : "startsWith" }, "value" : { "description" : "Value to filter dataset against", "example" : "Happy Res" } }, "required" : [ "field", "operator" ] }, "GroupDescriptor_ManagingEntity" : { "type" : "object", "description" : "Descriptor that defines how a result set should be grouped, including sort direction and optional aggregate calculations.", "example" : { "aggregates" : [ { "aggregate" : "count", "field" : "hotel.bookings" } ], "dir" : "asc", "field" : "createdDate" }, "properties" : { "aggregates" : { "type" : "array", "description" : "Primitive aggregate data points", "items" : { "$ref" : "#/components/schemas/AggregateDescriptor_ManagingEntity" } }, "dir" : { "type" : "string", "description" : "Group sort direction", "enum" : [ "asc", "desc" ], "example" : "asc" }, "field" : { "type" : "string", "description" : "Field to group data set on", "example" : "createdDate" } } }, "SortDescriptor_ManagingEntity" : { "type" : "object", "description" : "Descriptor that defines the sort direction and field for ordering a result set.", "example" : { "dir" : "asc", "field" : "hotel.name" }, "properties" : { "dir" : { "type" : "string", "description" : "Descriptors used for sorting result set", "enum" : [ "asc", "desc" ], "example" : "asc" }, "field" : { "type" : "string", "description" : "Data set field to sort on", "example" : "hotel.name" } } }, "State_ManagingEntity" : { "type" : "object", "description" : "Pagination, sorting, filtering, and grouping state used to query a paged result set.", "example" : { "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 }, "properties" : { "filter" : { "$ref" : "#/components/schemas/CompositeFilterDescriptor_ManagingEntity", "description" : "Descriptors used for filtering result set" }, "group" : { "type" : "array", "description" : "Descriptors to group result sets by.", "items" : { "$ref" : "#/components/schemas/GroupDescriptor_ManagingEntity" } }, "skip" : { "type" : "integer", "format" : "int32", "default" : 0, "description" : "Number of records to be skipped by the pager.", "example" : 0, "minimum" : 0 }, "sort" : { "type" : "array", "description" : "Descriptors used for sorting result set.", "items" : { "$ref" : "#/components/schemas/SortDescriptor_ManagingEntity" } }, "take" : { "type" : "integer", "format" : "int32", "default" : 30, "description" : "Number of records to take.", "example" : 10, "maximum" : 180, "minimum" : 1 } } }, "Contact_ManagingEntity" : { "type" : "object", "example" : { "email" : "johnsmith@email.com", "firstName" : "Alexandra", "fullName" : "Alexandra Beaumont", "lastName" : "Beaumont", "phoneNumber" : "+12125551212", "secondaryEmail" : "johnsmith2@email.com", "summary" : "John Smith (johnsmith@gmail.com / +12125551212)" }, "properties" : { "email" : { "type" : "string", "format" : "email", "description" : "Contact E-mail", "example" : "johnsmith@email.com" }, "firstName" : { "type" : "string", "description" : "Contact first name", "example" : "Alexandra" }, "fullName" : { "type" : "string", "description" : "First and last name", "example" : "Alexandra Beaumont", "readOnly" : true }, "lastName" : { "type" : "string", "description" : "Contact last name", "example" : "Beaumont" }, "phoneNumber" : { "type" : "string", "description" : "Contact phone number", "example" : "+12125551212", "pattern" : "^\\+?[1-9]\\d{1,14}$" }, "secondaryEmail" : { "type" : "string", "format" : "email", "description" : "Contact secondary Email", "example" : "johnsmith2@email.com" }, "summary" : { "type" : "string", "description" : "Summary", "example" : "John Smith (johnsmith@gmail.com / +12125551212)", "readOnly" : true } } }, "CountryLightweight_ManagingEntity" : { "type" : "object", "description" : "Country", "example" : "{\n \"iso\": \"TH\",\n \"iso3\": \"THA\",\n \"isoNumeric\": 764,\n \"fips\": \"TH\",\n \"name\": \"Thailand\",\n \"capital\": \"Bangkok\",\n \"area\": 514000.0,\n \"population\": 69428524,\n \"continent\": \"AS\",\n \"topLevelDomain\": \".th\",\n \"currencyCode\": \"THB\",\n \"currencyName\": \"Baht\",\n \"phone\": \"66\",\n \"postalCodeFormat\": \"#####\",\n \"postalCodeRegEx\": \"^(\\d{5})$\",\n \"languages\": [\"th\"],\n \"geoNameId\": \"1605651\",\n \"neighbors\": [\"LA\", \"MM\", \"KH\", \"MY\"]\n}", "properties" : { "capital" : { "type" : "string", "description" : "Country capital", "example" : "Washington" }, "continent" : { "type" : "string", "description" : "Continent code", "example" : "NA" }, "currencyCode" : { "type" : "string", "description" : "Currency code", "example" : "USD", "pattern" : "^[A-Z]{3}$" }, "currencyName" : { "type" : "string", "description" : "Currency name", "example" : "Dollar" }, "geoNameId" : { "type" : "string", "description" : "Country GeoNames identifier", "example" : "6252001" }, "iso" : { "type" : "string", "description" : "ISO code", "example" : "US" }, "name" : { "type" : "string", "description" : "Country name", "example" : "United States" } } }, "GeneralManager_ManagingEntity" : { "type" : "object", "description" : "General manager related data.", "example" : { "descriptions" : [ { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" } ], "image" : { "angle" : null, "attribution" : [ ], "category" : "2", "descriptions" : [ { "description" : "Elegant lobby of The Siam Residences", "language" : "en", "title" : "Lobby Entrance" } ], "height" : 1600, "identifier" : "the-siam-residences/lobby-entrance", "isLandscape" : true, "lifestyleType" : null, "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "source" : "CLOUDINARY", "type" : "IMAGE", "width" : 2560 }, "name" : "Jane Doe" }, "properties" : { "descriptions" : { "type" : "array", "description" : "Localized welcome message from GM.", "items" : { "$ref" : "#/components/schemas/LocalizedDescription_ManagingEntity" } }, "image" : { "$ref" : "#/components/schemas/SimpleMultimedia_ManagingEntity", "description" : "Profile image of the general manager." }, "name" : { "type" : "string", "description" : "Name of GM currently managing the property.", "example" : "Jane Doe" } }, "required" : [ "name" ] }, "GeoNameLightweight_ManagingEntity" : { "type" : "object", "description" : "GeoNames have been created at [https://geonames.org](https://geonames.org) and contain geographical destinations we use as geoname data to associate travel inventory with a location.", "example" : { "admin1Code" : "40", "admin2Code" : "2401", "admin3Code" : "", "admin4Code" : "", "alternateCountryCodes" : [ ], "alternateNames" : [ "Krung Thep", "BKK" ], "asciiName" : "Bangkok", "country" : { "area" : 514000.0, "capital" : "Bangkok", "continent" : "AS", "currencyCode" : "THB", "currencyName" : "Baht", "fips" : "TH", "geoNameId" : "1605651", "iso" : "TH", "iso3" : "THA", "isoNumeric" : 764, "languages" : [ "th" ], "name" : "Thailand", "neighbors" : [ "LA", "MM", "KH", "MY" ], "phone" : "66", "population" : 69428524, "postalCodeFormat" : "#####", "postalCodeRegEx" : "^(\\d{5})$", "topLevelDomain" : ".th" }, "countryCode" : "TH", "digitalElevationModel" : "3", "elevation" : 5, "featureClass" : "P", "featureCode" : "PPLC", "geoNameId" : "1609350", "location" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "POINT" }, "modificationDate" : "2023-06-15", "name" : "Bangkok", "population" : 10539415, "radiusInMeters" : 50000, "subCountry" : { "asciiName" : "Bangkok", "code" : "TH.40", "countryCode" : "TH", "geoNameId" : "1609350", "name" : "Bangkok", "subCountryCode" : "40" }, "subSubCountry" : { "asciiName" : "Bangkok District", "code" : "TH.40.2401", "countryCode" : "TH", "geoNameId" : "1609352", "name" : "Bangkok District", "subCountryCode" : "40", "subSubCountryCode" : "2401" }, "timezone" : "Asia/Bangkok", "type" : "CITY", "urlName" : "bangkok-thailand" }, "properties" : { "asciiName" : { "type" : "string", "description" : "Ascii name of city", "example" : "New York City" }, "country" : { "$ref" : "#/components/schemas/CountryLightweight_ManagingEntity", "description" : "Country", "example" : "TH" }, "countryCode" : { "type" : "string", "description" : "ISO 3166-1 alpha-2 country code for the country this location belongs to", "example" : "TH", "pattern" : "^[A-Z]{2}$" }, "featureCode" : { "type" : "string", "description" : "GeoNames specific feature code identifying the place type (e.g. PPL=populated place, PPLC=national capital, ISL=island)", "example" : "PPLA" }, "geoNameId" : { "type" : "string", "description" : "GeoName identifier", "example" : "5128581" }, "location" : { "$ref" : "#/components/schemas/GeoJsonPoint_ManagingEntity", "description" : "Coordinate points of the city", "example" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "POINT" } }, "name" : { "type" : "string", "description" : "Name of city", "example" : "New York City" }, "subCountry" : { "$ref" : "#/components/schemas/SubCountryLightweight_ManagingEntity", "description" : "Country sub division", "example" : "NY" }, "subSubCountry" : { "$ref" : "#/components/schemas/SubSubCountryLightweight_ManagingEntity", "description" : "Country sub sub division", "example" : "New York County" }, "timezone" : { "type" : "string", "description" : "IANA timezone identifier for the location", "example" : "America/New_York" }, "type" : { "type" : "string", "description" : "GeoNameLightweight type", "enum" : [ "CITY", "ISLAND", "OTHER" ], "example" : "CITY" }, "urlName" : { "type" : "string", "description" : "Url name", "example" : "new-york-city-united-states", "pattern" : "^[a-z0-9][a-z0-9-]*[a-z0-9]$" } } }, "LocalizedDescription_ManagingEntity" : { "type" : "object", "description" : "Simplified localized description containing text content and its language code.", "example" : { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" }, "properties" : { "creator" : { "type" : "string", "default" : "USER", "description" : "Whether it was user or system generated.", "enum" : [ "SYSTEM", "USER" ], "example" : "SYSTEM" }, "description" : { "type" : "string", "description" : "Longer text description", "example" : "This is a longer description in the specified language.", "maxLength" : 2147483647, "minLength" : 1 }, "hashMismatch" : { "type" : "boolean", "readOnly" : true }, "language" : { "type" : "string", "default" : "en", "description" : "Indicate which language this description is written in.", "example" : "en", "maxLength" : 2, "minLength" : 2, "pattern" : "^[a-z]{2}(-[A-Z]{2})?$" }, "md5ContentHash" : { "type" : "string", "description" : "The md5 hash of the name, description and language.", "example" : "d41d8cd98f00b204e9800998ecf8427e" } }, "required" : [ "description", "language" ] }, "PageResponsePropertyAggregateLightweight_ManagingEntity" : { "type" : "object", "description" : "Owned pagination envelope: a page of content plus flat page metadata.", "example" : { "content" : [ { "activities" : 3, "addOns" : 5, "address" : { "city" : "Bangkok", "countryCode" : "TH", "line1" : "3/2 Khao Road", "postalCode" : "10300", "state" : "Bangkok" }, "aggregateGreendexRating" : 7.0, "aggregateReviewRating" : 8.7, "architecturalStyle" : "7", "attractions" : 5, "available" : true, "bookings" : 6054, "brand" : "The Siam Residences", "chain" : "The Siam Collection", "currencyCode" : "THB", "descriptions" : [ { "description" : "An elegant riverside sanctuary in the heart of Bangkok.", "language" : "en", "title" : "Luxury Riverside Retreat" } ], "hotelAmenityCodes" : [ "1", "7" ], "hotelCategory" : "45", "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "images" : [ { "identifier" : "the-siam-residences/lobby-entrance", "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "type" : "IMAGE" } ], "lifestyleTypes" : [ "LIFESTYLE_HEALTH_FITNESS" ], "localName" : "เดอะสยาม เรสซิเดนซ์", "location" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "Point" }, "locationCategory" : "34", "meetingRooms" : 2, "name" : "The Siam Residences, Bangkok", "numberOfRooms" : 32, "places" : 9, "propertyAccessibilityCodes" : [ "1" ], "propertySecurityCodes" : [ "7" ], "reservations" : { "email" : "reservations@thesiamresidences.com", "firstName" : "Somchai", "lastName" : "Phattanapong", "phone" : "+66-2-123-4567" }, "restaurants" : 2, "score" : 70, "segmentCategory" : "7", "socials" : [ { "handle" : "thesiamresidences", "platform" : "INSTAGRAM" } ], "spas" : 1, "starRating" : 5, "thirdPartyReviews" : [ ], "totalReviews" : 989, "uniqueId" : "siam-residences-bkk", "urlName" : "the-siam-residences-bangkok-thailand", "videos" : [ ], "whenBuilt" : "1927" } ], "first" : true, "last" : false, "number" : 0, "numberOfElements" : 20, "size" : 20, "totalElements" : 1234, "totalPages" : 62 }, "properties" : { "content" : { "type" : "array", "description" : "The elements on this page.", "items" : { "$ref" : "#/components/schemas/PropertyAggregateLightweight_ManagingEntity" } }, "first" : { "type" : "boolean", "description" : "Whether this is the first page.", "example" : true }, "last" : { "type" : "boolean", "description" : "Whether this is the last page.", "example" : false }, "number" : { "type" : "integer", "format" : "int32", "description" : "Zero-based index of this page.", "example" : 0 }, "numberOfElements" : { "type" : "integer", "format" : "int32", "description" : "Number of elements on this page.", "example" : 20 }, "size" : { "type" : "integer", "format" : "int32", "description" : "The requested page size.", "example" : 20 }, "totalElements" : { "type" : "integer", "format" : "int64", "description" : "Total number of elements across all pages.", "example" : 1234 }, "totalPages" : { "type" : "integer", "format" : "int32", "description" : "Total number of pages for the current page size.", "example" : 62 } } }, "PropertyAggregateLightweight_ManagingEntity" : { "type" : "object", "description" : "Lightweight projection of a property aggregate, used for search results, listings, and map markers where not all property details are required.", "example" : { "activities" : 3, "addOns" : 5, "address" : { "city" : "Bangkok", "countryCode" : "TH", "line1" : "3/2 Khao Road", "postalCode" : "10300", "state" : "Bangkok" }, "aggregateGreendexRating" : 7.0, "aggregateReviewRating" : 8.7, "architecturalStyle" : "7", "attractions" : 5, "available" : true, "bookings" : 6054, "brand" : "The Siam Residences", "chain" : "The Siam Collection", "currencyCode" : "THB", "descriptions" : [ { "description" : "An elegant riverside sanctuary in the heart of Bangkok.", "language" : "en", "title" : "Luxury Riverside Retreat" } ], "hotelAmenityCodes" : [ "1", "7" ], "hotelCategory" : "45", "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "images" : [ { "identifier" : "the-siam-residences/lobby-entrance", "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "type" : "IMAGE" } ], "lifestyleTypes" : [ "LIFESTYLE_HEALTH_FITNESS" ], "localName" : "เดอะสยาม เรสซิเดนซ์", "location" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "Point" }, "locationCategory" : "34", "meetingRooms" : 2, "name" : "The Siam Residences, Bangkok", "numberOfRooms" : 32, "places" : 9, "propertyAccessibilityCodes" : [ "1" ], "propertySecurityCodes" : [ "7" ], "reservations" : { "email" : "reservations@thesiamresidences.com", "firstName" : "Somchai", "lastName" : "Phattanapong", "phone" : "+66-2-123-4567" }, "restaurants" : 2, "score" : 70, "segmentCategory" : "7", "socials" : [ { "handle" : "thesiamresidences", "platform" : "INSTAGRAM" } ], "spas" : 1, "starRating" : 5, "thirdPartyReviews" : [ ], "totalReviews" : 989, "uniqueId" : "siam-residences-bkk", "urlName" : "the-siam-residences-bangkok-thailand", "videos" : [ ], "whenBuilt" : "1927" }, "properties" : { "activities" : { "type" : "integer", "format" : "int32", "default" : 0, "description" : "Number of activites property has listed on its profile.", "example" : 3 }, "addOns" : { "type" : "integer", "format" : "int32", "default" : 0, "description" : "Number of add-ons property has on its profile.", "example" : 5 }, "address" : { "$ref" : "#/components/schemas/SimpleAddress_ManagingEntity", "description" : "Property address." }, "aggregateGreendexRating" : { "type" : "number", "format" : "float", "default" : "0.0", "description" : "Aggregate Green Index score if the property has answered our questionnaire available in the Extranet.", "example" : 7.0 }, "aggregateReviewRating" : { "type" : "number", "format" : "float", "default" : "0.0", "description" : "Aggregate score based on all current user reviews.", "example" : 7.8 }, "architecturalStyle" : { "type" : "string", "description" : "Supported OTA specification `ARC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", "example" : "7" }, "attractions" : { "type" : "integer", "format" : "int32", "default" : 0, "description" : "Number of attractions property has listed on its profile.", "example" : 5 }, "available" : { "type" : "boolean", "description" : "Whether property is available", "example" : true }, "bookings" : { "type" : "integer", "format" : "int64", "default" : 0, "description" : "Number of bookings for this property on the wink.travel platform.", "example" : 6054 }, "brand" : { "type" : "string", "description" : "Name of hotel brand", "example" : "Hotel brand" }, "chain" : { "type" : "string", "description" : "Name of hotel chain if applicable.", "example" : "Hotel chain" }, "city" : { "$ref" : "#/components/schemas/GeoNameLightweight_ManagingEntity", "description" : "City location" }, "currencyCode" : { "type" : "string", "description" : "Currency code for property.", "example" : "THB", "pattern" : "^[A-Z]{3}$" }, "descriptions" : { "type" : "array", "description" : "Short and long welcome text", "items" : { "$ref" : "#/components/schemas/SimpleDescription_ManagingEntity" } }, "generalManager" : { "$ref" : "#/components/schemas/GeneralManager_ManagingEntity", "description" : "General manager of the property." }, "hotelAmenityCodes" : { "type" : "array", "description" : "Supported OTA specification `HAC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", "example" : [ "1", "7" ], "items" : { "type" : "string" } }, "hotelCategory" : { "type" : "string", "description" : "Supported OTA specification `PCT` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", "example" : "45" }, "hotelIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Unique hotel record identifier.", "example" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18" }, "images" : { "type" : "array", "description" : "Property images.", "items" : { "$ref" : "#/components/schemas/SimpleMultimedia_ManagingEntity" } }, "lastUpdate" : { "type" : "string", "format" : "date-time", "description" : "Timestamp of the last update to this property aggregate record." }, "lifestyleTypes" : { "type" : "array", "items" : { "type" : "string", "description" : "A list of lifestyles the property associates with.", "enum" : [ "LIFESTYLE_HEALTH_FITNESS", "LIFESTYLE_RELAX", "LIFESTYLE_ADULT_ONLY", "LIFESTYLE_ADVENTURE", "LIFESTYLE_BUSINESS", "LIFESTYLE_LGBT", "LIFESTYLE_SINGLE_PARENT", "LIFESTYLE_SOLO_FEMALE", "LIFESTYLE_BEAUTY", "LIFESTYLE_FOODIE", "LIFESTYLE_FAMILY", "LIFESTYLE_ROMANCE", "LIFESTYLE_COUPLE", "LIFESTYLE_SOLO", "LIFESTYLE_BACKPACKER", "LIFESTYLE_SHOPPING", "LIFESTYLE_SPORTS", "LIFESTYLE_MOUNTAIN", "LIFESTYLE_BEACH", "LIFESTYLE_CITY", "LIFESTYLE_COUNTRY", "LIFESTYLE_CULTURE", "LIFESTYLE_ECO" ], "example" : "LIFESTYLE_HEALTH_FITNESS" } }, "localName" : { "type" : "string", "description" : "Hotel local name if different from the trade name or if it is the local language.", "example" : "Det Beste Hotellet" }, "location" : { "$ref" : "#/components/schemas/GeoJsonPoint_ManagingEntity", "description" : "Geo-location", "example" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "POINT" } }, "locationCategory" : { "type" : "string", "description" : "Supported OTA specification `LOC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", "example" : "34" }, "meetingRooms" : { "type" : "integer", "format" : "int32", "default" : 0, "description" : "Number of meeting rooms property has on its profile.", "example" : 2 }, "name" : { "type" : "string", "description" : "Hotel trade name", "example" : "The Siam Residences, Bangkok" }, "numberOfRooms" : { "type" : "integer", "format" : "int32", "default" : 0, "description" : "Number of rooms / keys for this property.", "example" : 32 }, "places" : { "type" : "integer", "format" : "int32", "default" : 0, "description" : "Number of places property has listed on its profile.", "example" : 9 }, "policy" : { "$ref" : "#/components/schemas/PropertyPolicy_ManagingEntity", "description" : "Basic property policy record." }, "propertyAccessibilityCodes" : { "type" : "array", "description" : "Supported OTA specification `PHY` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", "example" : [ "1", "7" ], "items" : { "type" : "string" } }, "propertySecurityCodes" : { "type" : "array", "description" : "Supported OTA specification `SEC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", "example" : [ "1", "7" ], "items" : { "type" : "string" } }, "reservations" : { "$ref" : "#/components/schemas/Contact_ManagingEntity", "description" : "Contact details for reservations desk" }, "restaurants" : { "type" : "integer", "format" : "int32", "default" : 0, "description" : "Number of restaurants property has on its profile.", "example" : 2 }, "score" : { "type" : "integer", "format" : "int32", "default" : 0, "description" : "Demand score (0-100) derived from booking volume and review rating. Recomputed monthly; used to rank properties in search results.", "example" : 70 }, "segmentCategory" : { "type" : "string", "description" : "Supported OTA specification `SEG` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", "example" : "7" }, "socials" : { "type" : "array", "description" : "Property's social network accounts", "items" : { "$ref" : "#/components/schemas/Social_ManagingEntity" } }, "spas" : { "type" : "integer", "format" : "int32", "default" : 0, "description" : "Number of spas property has on its profile.", "example" : 1 }, "starRating" : { "type" : "integer", "format" : "int32", "description" : "Official or self-designated property star rating. Note that in some regions there are 6-star hotels. They are the same as 5-star hotels everywhere else.", "example" : 5, "maximum" : 6, "minimum" : 0 }, "thirdPartyReviews" : { "type" : "array", "description" : "Array of awards and third party reviews given to property by certified / non-certified providers.", "items" : { "$ref" : "#/components/schemas/TravelInventoryRecognition_ManagingEntity" } }, "totalReviews" : { "type" : "integer", "format" : "int32", "default" : 0, "description" : "Count of total reviews left by users at this property.", "example" : 989 }, "uniqueId" : { "type" : "string", "description" : "Event shorter name", "example" : "abc123", "minLength" : 1 }, "urlName" : { "type" : "string", "description" : "Unique URL-friendly name slug of hotel", "example" : "the-siam-residences-bangkok-thailand", "pattern" : "^[a-z0-9][a-z0-9-]*[a-z0-9]$" }, "videos" : { "type" : "array", "description" : "Property videos.", "items" : { "$ref" : "#/components/schemas/SimpleMultimedia_ManagingEntity" } }, "whenBuilt" : { "type" : "string", "description" : "Year the property was constructed.", "example" : "1927" } }, "required" : [ "uniqueId" ] }, "PropertyPolicy_ManagingEntity" : { "type" : "object", "description" : "Outlines basic policies for the property.", "example" : { "checkInTime" : "14:00", "checkOutTime" : "10:00", "childrenAllowed" : true, "childrenMinimumAge" : 6, "internetAvailability" : "YES", "internetConnectionLocation" : "ENTIRE_PROPERTY", "internetConnectionType" : "WIFI", "parkingAccess" : "PRIVATE", "parkingAvailability" : "YES", "petCharge" : { "amount" : 500.0, "currency" : "THB" }, "petMaxWeightInKilos" : 10, "petsAllowed" : true }, "properties" : { "checkInTime" : { "type" : "string", "description" : "When the guest can check in.", "example" : "14:00", "minLength" : 1 }, "checkOutTime" : { "type" : "string", "description" : "When the guest has to check out.", "example" : "10:00", "minLength" : 1 }, "childrenAllowed" : { "type" : "boolean", "default" : false, "description" : "Indicates whether property allows children", "example" : true }, "childrenMinimumAge" : { "type" : "integer", "format" : "int32", "description" : "When a property allows children, it can also indicate what the minimum age is for children to be allowed.", "example" : 6 }, "internetAvailability" : { "type" : "string", "description" : "Indicates the availability of internet on the property.", "enum" : [ "YES", "NO", "YES_PAID" ], "example" : "YES" }, "internetConnectionLocation" : { "type" : "string", "description" : "Indicates where internet is available in and around the property.", "enum" : [ "ENTIRE_PROPERTY", "PUBLIC_AREAS", "ALL_ROOMS", "SOME_ROOMS", "BUSINESS_CENTER" ], "example" : "ENTIRE_PROPERTY" }, "internetConnectionType" : { "type" : "string", "description" : "Indicates how guests can access the Internet on the property.", "enum" : [ "WIFI", "CABLE" ], "example" : "WIFI" }, "parkingAccess" : { "type" : "string", "description" : "Indicates what type of parking is available at the property.", "enum" : [ "PRIVATE", "PUBLIC" ], "example" : "PRIVATE" }, "parkingAvailability" : { "type" : "string", "description" : "Indicates whether parking is available at the property.", "enum" : [ "YES", "NO", "YES_PAID" ], "example" : "YES" }, "petCharge" : { "$ref" : "#/components/schemas/CustomMonetaryAmount", "description" : "If pets are allowed, property can tell travelers if there is a charge applicable for the pet." }, "petMaxWeightInKilos" : { "type" : "integer", "format" : "int32", "description" : "If pets are allowed, property can further limit on weight.", "example" : 10 }, "petsAllowed" : { "type" : "boolean", "default" : false, "description" : "Indicates whether pets are allowed on the property. Note: There are thousand different kinds of pets. Just because the property allows small dogs does not mean the guest can bring a python. Always best to check with property.", "example" : true } }, "required" : [ "checkInTime", "checkOutTime", "childrenAllowed", "internetAvailability", "parkingAvailability", "petsAllowed" ] }, "SimpleAddress_ManagingEntity" : { "type" : "object", "description" : "Address information", "example" : { "address1" : "234 Near da beach", "address2" : "Pebble #5001", "city" : "Bangkok", "country" : "United States", "countryCode" : "TH", "county" : "Alameda county", "fullAddress" : "11 At home, Suite 3C, New York City, NY 10010, United States", "postalCode" : "90210", "state" : "CA" }, "properties" : { "address1" : { "type" : "string", "description" : "Address line 1", "example" : "234 Near da beach" }, "address2" : { "type" : "string", "description" : "Address line 2", "example" : "Pebble #5001" }, "city" : { "type" : "string", "description" : "City name", "example" : "Bangkok" }, "country" : { "type" : "string", "description" : "Country", "example" : "United States", "readOnly" : true }, "countryCode" : { "type" : "string", "description" : "Country", "example" : "TH", "pattern" : "^[A-Z]{2}$" }, "county" : { "type" : "string", "description" : "County", "example" : "Alameda county" }, "fullAddress" : { "type" : "string", "description" : "Address 1, Address 2, City, State, Postal / Zip code, Country", "example" : "11 At home, Suite 3C, New York City, NY 10010, United States", "readOnly" : true }, "postalCode" : { "type" : "string", "description" : "Postal / zip code", "example" : "90210" }, "state" : { "type" : "string", "description" : "State", "example" : "CA" } } }, "Social_ManagingEntity" : { "type" : "object", "description" : "Social network", "example" : { "location" : "https://www.instagram.com/thesiamresidences", "type" : "INSTAGRAM" }, "properties" : { "location" : { "type" : "string", "description" : "URL or social network identifier to social network profile", "example" : "https://www.instagram.com/thesiamresidences" }, "type" : { "type" : "string", "description" : "Type of social network.", "enum" : [ "FACEBOOK", "INSTAGRAM", "SKYPE", "TRIP_ADVISOR", "TWITTER", "GOOGLE_PLUS", "WHATSAPP", "LINE", "WECHAT", "VIBER", "SNAPCHAT", "WEIBO", "RENREN", "WEBSITE", "QQ", "TIKTOK" ], "example" : "INSTAGRAM" } } }, "SubCountryLightweight_ManagingEntity" : { "type" : "object", "description" : "Country subdivision such as a state or province", "example" : { "asciiName" : "New York", "geoNameId" : "5128638", "name" : "New York" }, "properties" : { "asciiName" : { "type" : "string", "description" : "Sub-country ascii name", "example" : "New York" }, "geoNameId" : { "type" : "string", "description" : "Sub-country GeoNames identifier", "example" : "5128638" }, "name" : { "type" : "string", "description" : "Sub-country name", "example" : "New York" } } }, "SubSubCountryLightweight_ManagingEntity" : { "type" : "object", "description" : "Lightweight representation of a second-level country subdivision such as a county or district", "example" : { "asciiName" : "New York County", "geoNameId" : "5128594", "name" : "New York County" }, "properties" : { "asciiName" : { "type" : "string", "description" : "ASCII-transliterated name of the county or district, safe for URLs and sorting", "example" : "New York County" }, "geoNameId" : { "type" : "string", "description" : "GeoNames.org unique identifier for this subdivision", "example" : "5128594" }, "name" : { "type" : "string", "description" : "Official name of the county or district in its local script", "example" : "New York County" } } }, "TravelInventoryRecognition_ManagingEntity" : { "type" : "object", "description" : "Recognition for the ancillary blocking.", "example" : { "category" : "AWARD", "date" : "2026-01-14", "identifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "maxRating" : 10.0, "officialAppointmentInd" : true, "provider" : "Michelin", "rating" : 8.5, "ratingSymbol" : "*", "type" : "PERCENT_RATING" }, "properties" : { "category" : { "type" : "string", "description" : "Recognition category.", "enum" : [ "THIRD_PARTY_REVIEW", "PUBLICATION", "AWARD" ], "example" : "AWARD" }, "date" : { "type" : "string", "format" : "date", "description" : "The date the award was received", "example" : "2020-10-24" }, "identifier" : { "type" : "string", "format" : "uuid", "description" : "Recognition identifier.", "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "minLength" : 1 }, "maxRating" : { "type" : "number", "format" : "float", "description" : "Use this to let hotels indicate what the total score for this award is.", "example" : 10 }, "officialAppointmentInd" : { "type" : "boolean", "description" : "When true, this indicates the property has received official permission from the award provider to use the rating in publications and marketing materials; when false this permission has not been granted.", "example" : true }, "provider" : { "type" : "string", "description" : "The name of the entity that administers this recognition.", "example" : "Michelin", "minLength" : 1 }, "rating" : { "type" : "number", "format" : "float", "description" : "The actual award or rating received by the hotel facility.", "example" : 8.5, "minimum" : 0.0 }, "ratingSymbol" : { "type" : "string", "description" : "Provides the symbol used in the rating. Used in conjunction with the Rating.", "example" : "*" }, "type" : { "type" : "string", "description" : "Type of rating system the recognition operated on. This allows us to display the score properly.", "enum" : [ "STAR_RATING", "NUMERIC_RATING", "PERCENT_RATING" ], "example" : "PERCENT_RATING" } }, "required" : [ "category", "identifier", "maxRating", "provider", "rating", "type" ] }, "CreateStaticListAndAddItemRequest_ManagingEntity" : { "type" : "object", "description" : "Request to create a new curated list and optionally seed it with inventory items.", "example" : { "channelInventoryIdentifiers" : [ "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29" ], "name" : "Top 3 Hotels in Chiang Mai" }, "properties" : { "channelInventoryIdentifiers" : { "type" : "array", "description" : "Optionally add channel inventory identifiers to the list upon creation.", "items" : { "type" : "string", "example" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29" } }, "name" : { "type" : "string", "description" : "Name of curated list", "example" : "Top 3 Hotels in Chiang Mai", "minLength" : 1 } }, "required" : [ "name" ] }, "AddStaticListItemRequest_ManagingEntity" : { "type" : "object", "description" : "Request to append a travel-inventory item to an existing curated list.", "example" : { "channelInventoryIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29" }, "properties" : { "channelInventoryIdentifier" : { "type" : "string", "format" : "uuid", "description" : "The inventory ID", "example" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "minLength" : 1 } }, "required" : [ "channelInventoryIdentifier" ] }, "AddStaticListSupplierRequest_ManagingEntity" : { "type" : "object", "description" : "Request to append a supplier to an existing curated list, resolved to its best-priced inventory.", "example" : { "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18" }, "properties" : { "supplierIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Supplier identifier", "example" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "minLength" : 1 } }, "required" : [ "supplierIdentifier" ] }, "CreateStaticListAndAddSupplierRequest_ManagingEntity" : { "type" : "object", "description" : "Request to create a new curated list seeded with a supplier resolved to its best-priced inventory.", "example" : { "channelInventoryType" : "GUEST_ROOM", "name" : "Top 3 Hotels in Chiang Mai", "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18" }, "properties" : { "channelInventoryType" : { "type" : "string", "description" : "Inventory type of the supplier item to resolve.", "enum" : [ "GUEST_ROOM", "ADD_ON", "MEETING_ROOM", "RESTAURANT", "SPA", "ATTRACTION", "PLACE", "ACTIVITY" ], "example" : "GUEST_ROOM" }, "name" : { "type" : "string", "description" : "Name of curated list", "example" : "Top 3 Hotels in Chiang Mai", "minLength" : 1 }, "supplierIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Supplier identifier to seed the list with.", "example" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "minLength" : 1 } }, "required" : [ "channelInventoryType", "name", "supplierIdentifier" ] }, "UpsertSalesChannelRequestRequest" : { "type" : "object", "description" : "A request for relationship between two parties.", "example" : { "introductoryMessage" : "We are interested in partnering with your property to offer discounted rates to our clientele.", "requestType" : "DIRECT_CONNECTION", "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18" }, "properties" : { "introductoryMessage" : { "type" : "string", "description" : "Introductory message from the requester explaining the purpose of the connection request.", "example" : "We are interested in partnering with your property to offer discounted rates to our clientele.", "minLength" : 1 }, "requestType" : { "type" : "string", "description" : "Type of relationship request", "enum" : [ "DIRECT_CONNECTION" ], "example" : "DIRECT_CONNECTION" }, "supplierIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Supplier identifier the relationship request targets", "example" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "minLength" : 1 } }, "required" : [ "introductoryMessage", "requestType", "supplierIdentifier" ] }, "SalesChannelRequestLightweight" : { "type" : "object", "description" : "A request for relationship between two parties.", "example" : { "createdDate" : "2026-01-14T09:30:00", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "introductoryMessage" : "We represent a travel agency network with strong demand for your properties and would like to establish a partnership to offer exclusive rates to our members.", "lastUpdate" : "2026-02-03T16:45:12", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "ownerName" : "The Siam Residences", "requestType" : "DIRECT_CONNECTION", "status" : "REQUESTING", "subType" : "APPLICATION", "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "supplierName" : "The Siam Residences, Bangkok", "version" : 3 }, "properties" : { "createdDate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was first created", "example" : "2026-01-14T09:30:00", "readOnly" : true }, "id" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier for this record.", "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, "introductoryMessage" : { "type" : "string", "description" : "Message from requester explaining the purpose and benefits of the proposed relationship", "example" : "We represent a travel agency network with strong demand for your properties and would like to establish a partnership to offer exclusive rates to our members.", "minLength" : 1 }, "lastUpdate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was last updated", "example" : "2026-02-03T16:45:12", "readOnly" : true }, "ownerIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier of the owner/affiliate initiating the request", "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "minLength" : 1 }, "ownerName" : { "type" : "string", "description" : "Name of the owner/affiliate initiating the request", "example" : "The Siam Residences", "minLength" : 1 }, "requestType" : { "type" : "string", "description" : "Type of relationship request", "enum" : [ "DIRECT_CONNECTION" ], "example" : "DIRECT_CONNECTION" }, "status" : { "type" : "string", "description" : "Status of the relationship request", "enum" : [ "REQUESTING", "REJECTED" ], "example" : "REQUESTING" }, "subType" : { "type" : "string", "description" : "Type of entity initiating the relationship request", "enum" : [ "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" ], "example" : "APPLICATION" }, "supplierIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Supplier identifier receiving this relationship request", "example" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "minLength" : 1 }, "supplierName" : { "type" : "string", "description" : "Name of the property/supplier receiving the request", "example" : "The Siam Residences, Bangkok", "minLength" : 1 }, "version" : { "type" : [ "integer", "null" ], "format" : "int64", "description" : "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.", "example" : 3 } }, "required" : [ "introductoryMessage", "ownerIdentifier", "ownerName", "requestType", "status", "subType", "supplierIdentifier", "supplierName" ] }, "AdvanceBookingRateQualifier_ManagingEntity" : { "description" : "Qualifier that restricts a promotion to bookings made within a specific advance window before the stay start date." }, "ArrivalDaysOfWeekRateQualifier_ManagingEntity" : { "description" : "Qualifier that restricts a promotion to guests arriving on specific days of the week." }, "AvailableDaysOfWeekRateQualifier_ManagingEntity" : { "description" : "Qualifier that restricts a promotion to specific days of the week when it is available for booking." }, "BlackoutDate" : { "type" : "object", "description" : "A date range during which a promotion is not available (blackout period).", "example" : { "effectiveDate" : "2026-04-13", "expireDate" : "2026-04-15" }, "properties" : { "effectiveDate" : { "type" : "string", "format" : "date", "description" : "Start date when the promotion is not available (inclusive).", "example" : "2026-04-13" }, "expireDate" : { "type" : "string", "format" : "date", "description" : "End date when the promotion is not available (inclusive).", "example" : "2026-04-15" } }, "required" : [ "effectiveDate", "expireDate" ] }, "CityRateQualifierLightweight" : { "type" : "object", "description" : "Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific city.", "example" : { "city" : { "countryCode" : "TH", "geoNameId" : "1609350", "latitude" : 13.7563, "longitude" : 100.5018, "name" : "Bangkok" } }, "properties" : { "city" : { "$ref" : "#/components/schemas/GeoIpLightweight", "description" : "City details (obtained via geonames) to restrict the promotion by guest location." } }, "required" : [ "city" ] }, "ContinentRateQualifier" : { "type" : "object", "description" : "Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific continent.", "example" : { "continent" : "NA" }, "properties" : { "continent" : { "type" : "string", "description" : "Two-letter continent code (e.g. NA, EU, AS)", "example" : "NA", "minLength" : 1 } }, "required" : [ "continent" ] }, "CountryRateQualifier" : { "type" : "object", "description" : "Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific country.", "example" : { "country" : { "continentCode" : "AS", "geoNameId" : "1609350", "isoAlpha2" : "TH", "isoAlpha3" : "THA", "name" : "Thailand" } }, "properties" : { "country" : { "$ref" : "#/components/schemas/GeoNameCountry", "description" : "Country (obtained via geonames) to restrict the promotion by guest location." } }, "required" : [ "country" ] }, "DepartureDaysOfWeekRateQualifier_ManagingEntity" : { "description" : "Qualifier that restricts a promotion to guests departing on specific days of the week." }, "GeoIpLightweight" : { "type" : "object", "description" : "Uses MaxMind's city lite db to persist GeoIpLightweight objects in our own db.", "example" : { "cityName" : "Bangkok", "continentCode" : "AS", "continentName" : "Asia", "countryIsoCode" : "TH", "countryName" : "Thailand", "geoNameId" : "1609350", "localeCode" : "en", "subDivision1Code" : "10", "subDivision1Name" : "Bangkok", "subDivision2Code" : "1001", "subDivision2Name" : "Phra Nakhon", "timezone" : "Asia/Bangkok" }, "properties" : { "cityName" : { "type" : "string", "description" : "City name", "example" : "New York", "minLength" : 1 }, "continentCode" : { "type" : "string", "description" : "Continent code", "example" : "NA", "minLength" : 1 }, "continentName" : { "type" : "string", "description" : "Continent name", "example" : "North America", "minLength" : 1 }, "countryIsoCode" : { "type" : "string", "description" : "Country ISO code", "example" : "US", "minLength" : 1, "pattern" : "^[A-Z]{2}$" }, "countryName" : { "type" : "string", "description" : "Country name", "example" : "United States", "minLength" : 1 }, "geoNameId" : { "type" : "string", "description" : "GeoNameLightweight identifiers taken from [https://geonames.org](https://geonames.org).", "example" : "8798734", "minLength" : 1 }, "localeCode" : { "type" : "string", "description" : "Locale code", "example" : "en", "minLength" : 1, "pattern" : "^[a-z]{2}(-[A-Z]{2})?$" }, "subDivision1Code" : { "type" : "string", "description" : "Sub-division 1 code", "example" : "NY" }, "subDivision1Name" : { "type" : "string", "description" : "Sub-division 1 name", "example" : "NY" }, "subDivision2Code" : { "type" : "string", "description" : "Sub-division 2 code", "example" : "Kings" }, "subDivision2Name" : { "type" : "string", "description" : "Sub-division 2 name", "example" : "Kings County" }, "timezone" : { "type" : "string", "description" : "Timezone", "example" : "America/New_York", "minLength" : 1 } }, "required" : [ "cityName", "continentCode", "continentName", "countryIsoCode", "countryName", "geoNameId", "localeCode", "timezone" ] }, "GeoLocationRateQualifier" : { "type" : "object", "description" : "Qualifier that restricts a promotion to guests within a circular geographic area defined by a center point and radius.", "example" : { "latitude" : 13.7563, "longitude" : 100.5018, "radiusInKilometers" : 50 }, "properties" : { "latitude" : { "type" : "number", "format" : "double", "description" : "Latitude of the center point for the geo-location radius check.", "example" : 13.7563 }, "longitude" : { "type" : "number", "format" : "double", "description" : "Longitude of the center point for the geo-location radius check.", "example" : 100.5018 }, "radiusInKilometers" : { "type" : "integer", "format" : "int32", "description" : "Radius in kilometers around the center point within which the guest must be located.", "example" : 50 } }, "required" : [ "latitude", "longitude", "radiusInKilometers" ] }, "GeoNameCountry" : { "type" : "object", "description" : "Country geographic data from GeoNames", "example" : { "continentCode" : "AS", "continentName" : "Asia", "countryIsoCode" : "TH", "countryName" : "Thailand", "geoNameId" : "1609350" }, "properties" : { "continentCode" : { "type" : "string", "description" : "Continent code (two-letter ISO)", "example" : "AS" }, "continentName" : { "type" : "string", "description" : "Continent name", "example" : "Asia" }, "countryIsoCode" : { "type" : "string", "description" : "Country ISO 3166-1 alpha-2 code", "example" : "TH", "pattern" : "^[A-Z]{2}$" }, "countryName" : { "type" : "string", "description" : "Country name", "example" : "Thailand" }, "geoNameId" : { "type" : "string", "description" : "GeoNames identifier", "example" : "1609350" } } }, "IPRangeRateQualifier" : { "type" : "object", "description" : "Qualifier that restricts a promotion to guests whose IP address falls within a specified IPv4 range.", "example" : { "endIPRange" : "192.168.1.255", "startIPRange" : "192.168.1.0" }, "properties" : { "endIPRange" : { "type" : "string", "description" : "Ending IP address of the range (inclusive).", "example" : "192.168.1.255", "minLength" : 1 }, "startIPRange" : { "type" : "string", "description" : "Starting IP address of the range (inclusive).", "example" : "192.168.1.0", "minLength" : 1 } }, "required" : [ "endIPRange", "startIPRange" ] }, "LengthOfStayRateQualifier_ManagingEntity" : { "description" : "Qualifier that restricts a promotion to stays within a specified minimum and maximum length of stay (in nights)." }, "LocalizedDescription" : { "type" : "object", "description" : "Simplified localized description containing text content and its language code.", "example" : { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" }, "properties" : { "creator" : { "type" : "string", "default" : "USER", "description" : "Whether it was user or system generated.", "enum" : [ "SYSTEM", "USER" ], "example" : "SYSTEM" }, "description" : { "type" : "string", "description" : "Longer text description", "example" : "This is a longer description in the specified language.", "maxLength" : 2147483647, "minLength" : 1 }, "hashMismatch" : { "type" : "boolean", "readOnly" : true }, "language" : { "type" : "string", "default" : "en", "description" : "Indicate which language this description is written in.", "example" : "en", "maxLength" : 2, "minLength" : 2, "pattern" : "^[a-z]{2}(-[A-Z]{2})?$" }, "md5ContentHash" : { "type" : "string", "description" : "The md5 hash of the name, description and language.", "example" : "d41d8cd98f00b204e9800998ecf8427e" } }, "required" : [ "description", "language" ] }, "MinutesBeforeBookingStartDateRateQualifier_ManagingEntity" : { "description" : "Qualifier that restricts a promotion to last-minute bookings made within a specified number of seconds before the stay start date." }, "PageResponseSalesChannelLightweight_ManagingEntity" : { "type" : "object", "description" : "Owned pagination envelope: a page of content plus flat page metadata.", "example" : { "content" : [ { "blacklisted" : false, "channelDisabled" : false, "commission" : 0.2, "createdDate" : "2026-01-14T09:30:00", "enabled" : true, "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "lastUpdate" : "2026-02-03T16:45:12", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "ownerName" : "The Siam Residences", "percentDiscount" : 0.15, "rateModifierBundles" : [ { "aggregatedItemDescriptions" : [ { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" } ], "createdDate" : "2026-01-14T09:30:00", "descriptions" : [ { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" } ], "effectiveDescriptions" : [ { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" } ], "enabled" : true, "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "items" : [ { "addOnIdentifiers" : [ "880e8400-e29b-41d4-a716-446655440333" ], "blackoutDates" : [ { "effectiveDate" : "2026-04-13", "expireDate" : "2026-04-15" } ], "cityRateQualifiers" : [ { "city" : { "countryCode" : "TH", "geoNameId" : "1609350", "latitude" : 13.7563, "longitude" : 100.5018, "name" : "Bangkok" } } ], "continentRateQualifiers" : [ { "continent" : "NA" } ], "countryRateQualifiers" : [ { "country" : { "continentCode" : "AS", "geoNameId" : "1609350", "isoAlpha2" : "TH", "isoAlpha3" : "THA", "name" : "Thailand" } } ], "createdDate" : "2026-01-14T09:30:00", "descriptions" : [ { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" } ], "enabled" : true, "geoLocationRateQualifiers" : [ { "latitude" : 13.7563, "longitude" : 100.5018, "radiusInKilometers" : 50 } ], "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "ipRangeRateQualifiers" : [ { "endIPRange" : "192.168.1.255", "startIPRange" : "192.168.1.0" } ], "lastUpdate" : "2026-02-03T16:45:12", "masterRateIdentifiers" : [ "770e8400-e29b-41d4-a716-446655440222" ], "name" : "Early bird", "pricingType" : "PER_PERSON_PER_NIGHT", "promotionRateQualifiers" : [ { "promotion" : "EARLYBIRD2026" } ], "ratePlanIdentifiers" : [ "990e8400-e29b-41d4-a716-446655440444" ], "sellDateRateQualifiers" : [ { "effectiveDate" : "2026-05-01", "expireDate" : "2026-08-31" } ], "stayDateRateQualifiers" : [ { "effectiveDate" : "2026-06-01", "expireDate" : "2026-08-31" } ], "timezoneRateQualifiers" : [ { "timezone" : "Asia/Bangkok" } ], "type" : "DISCOUNT", "version" : 3 } ], "lastUpdate" : "2026-02-03T16:45:12", "name" : "Early bird - Long Term", "pricingType" : "PER_NIGHT", "type" : "DISCOUNT", "version" : 3 } ], "rateModifiers" : [ { "addOnIdentifiers" : [ "880e8400-e29b-41d4-a716-446655440333" ], "blackoutDates" : [ { "effectiveDate" : "2026-04-13", "expireDate" : "2026-04-15" } ], "cityRateQualifiers" : [ { "city" : { "countryCode" : "TH", "geoNameId" : "1609350", "latitude" : 13.7563, "longitude" : 100.5018, "name" : "Bangkok" } } ], "continentRateQualifiers" : [ { "continent" : "NA" } ], "countryRateQualifiers" : [ { "country" : { "continentCode" : "AS", "geoNameId" : "1609350", "isoAlpha2" : "TH", "isoAlpha3" : "THA", "name" : "Thailand" } } ], "createdDate" : "2026-01-14T09:30:00", "descriptions" : [ { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" } ], "enabled" : true, "geoLocationRateQualifiers" : [ { "latitude" : 13.7563, "longitude" : 100.5018, "radiusInKilometers" : 50 } ], "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "ipRangeRateQualifiers" : [ { "endIPRange" : "192.168.1.255", "startIPRange" : "192.168.1.0" } ], "lastUpdate" : "2026-02-03T16:45:12", "masterRateIdentifiers" : [ "770e8400-e29b-41d4-a716-446655440222" ], "name" : "Early bird", "pricingType" : "PER_PERSON_PER_NIGHT", "promotionRateQualifiers" : [ { "promotion" : "EARLYBIRD2026" } ], "ratePlanIdentifiers" : [ "990e8400-e29b-41d4-a716-446655440444" ], "sellDateRateQualifiers" : [ { "effectiveDate" : "2026-05-01", "expireDate" : "2026-08-31" } ], "stayDateRateQualifiers" : [ { "effectiveDate" : "2026-06-01", "expireDate" : "2026-08-31" } ], "timezoneRateQualifiers" : [ { "timezone" : "Asia/Bangkok" } ], "type" : "DISCOUNT", "version" : 3 } ], "selfAcquires" : false, "subType" : "DIRECT", "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "supplierName" : "The Siam Residences, Bangkok", "version" : 3 } ], "first" : true, "last" : false, "number" : 0, "numberOfElements" : 20, "size" : 20, "totalElements" : 1234, "totalPages" : 62 }, "properties" : { "content" : { "type" : "array", "description" : "The elements on this page.", "items" : { "$ref" : "#/components/schemas/SalesChannelLightweight_ManagingEntity" } }, "first" : { "type" : "boolean", "description" : "Whether this is the first page.", "example" : true }, "last" : { "type" : "boolean", "description" : "Whether this is the last page.", "example" : false }, "number" : { "type" : "integer", "format" : "int32", "description" : "Zero-based index of this page.", "example" : 0 }, "numberOfElements" : { "type" : "integer", "format" : "int32", "description" : "Number of elements on this page.", "example" : 20 }, "size" : { "type" : "integer", "format" : "int32", "description" : "The requested page size.", "example" : 20 }, "totalElements" : { "type" : "integer", "format" : "int64", "description" : "Total number of elements across all pages.", "example" : 1234 }, "totalPages" : { "type" : "integer", "format" : "int32", "description" : "Total number of pages for the current page size.", "example" : 62 } } }, "PrepayRateQualifier_ManagingEntity" : { "description" : "Qualifier that restricts a promotion to either prepaid or pay-at-property rates." }, "PromotionRateQualifier" : { "type" : "object", "description" : "Qualifier that restricts a promotion to guests who enter a specific promotional code at checkout.", "example" : { "promotion" : "EARLYBIRD2026" }, "properties" : { "promotion" : { "type" : "string", "description" : "Promo code that guests must enter to access this promotion.", "example" : "EARLYBIRD2026", "minLength" : 1 } }, "required" : [ "promotion" ] }, "RefundableRateQualifier_ManagingEntity" : { "description" : "Qualifier that restricts a promotion to either refundable or non-refundable rates." }, "RequiredDaysOfWeekRateQualifier_ManagingEntity" : { "description" : "Qualifier that restricts a promotion to stays that include specific required days of the week." }, "RoomRangeRateQualifier_ManagingEntity" : { "description" : "Qualifier that restricts a promotion to bookings with a specified minimum and/or maximum number of rooms." }, "SalesChannelLightweight_ManagingEntity" : { "type" : "object", "description" : "Lightweight projection of a SalesChannel representing a configured distribution relationship between a supplier and an affiliate.", "example" : { "blacklisted" : false, "channelDisabled" : false, "commission" : 0.2, "createdDate" : "2026-01-14T09:30:00", "enabled" : true, "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "lastUpdate" : "2026-02-03T16:45:12", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "ownerName" : "The Siam Residences", "percentDiscount" : 0.15, "rateModifierBundles" : [ { "aggregatedItemDescriptions" : [ { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" } ], "createdDate" : "2026-01-14T09:30:00", "descriptions" : [ { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" } ], "effectiveDescriptions" : [ { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" } ], "enabled" : true, "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "items" : [ { "addOnIdentifiers" : [ "880e8400-e29b-41d4-a716-446655440333" ], "blackoutDates" : [ { "effectiveDate" : "2026-04-13", "expireDate" : "2026-04-15" } ], "cityRateQualifiers" : [ { "city" : { "countryCode" : "TH", "geoNameId" : "1609350", "latitude" : 13.7563, "longitude" : 100.5018, "name" : "Bangkok" } } ], "continentRateQualifiers" : [ { "continent" : "NA" } ], "countryRateQualifiers" : [ { "country" : { "continentCode" : "AS", "geoNameId" : "1609350", "isoAlpha2" : "TH", "isoAlpha3" : "THA", "name" : "Thailand" } } ], "createdDate" : "2026-01-14T09:30:00", "descriptions" : [ { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" } ], "enabled" : true, "geoLocationRateQualifiers" : [ { "latitude" : 13.7563, "longitude" : 100.5018, "radiusInKilometers" : 50 } ], "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "ipRangeRateQualifiers" : [ { "endIPRange" : "192.168.1.255", "startIPRange" : "192.168.1.0" } ], "lastUpdate" : "2026-02-03T16:45:12", "masterRateIdentifiers" : [ "770e8400-e29b-41d4-a716-446655440222" ], "name" : "Early bird", "pricingType" : "PER_PERSON_PER_NIGHT", "promotionRateQualifiers" : [ { "promotion" : "EARLYBIRD2026" } ], "ratePlanIdentifiers" : [ "990e8400-e29b-41d4-a716-446655440444" ], "sellDateRateQualifiers" : [ { "effectiveDate" : "2026-05-01", "expireDate" : "2026-08-31" } ], "stayDateRateQualifiers" : [ { "effectiveDate" : "2026-06-01", "expireDate" : "2026-08-31" } ], "timezoneRateQualifiers" : [ { "timezone" : "Asia/Bangkok" } ], "type" : "DISCOUNT", "version" : 3 } ], "lastUpdate" : "2026-02-03T16:45:12", "name" : "Early bird - Long Term", "pricingType" : "PER_NIGHT", "type" : "DISCOUNT", "version" : 3 } ], "rateModifiers" : [ { "addOnIdentifiers" : [ "880e8400-e29b-41d4-a716-446655440333" ], "blackoutDates" : [ { "effectiveDate" : "2026-04-13", "expireDate" : "2026-04-15" } ], "cityRateQualifiers" : [ { "city" : { "countryCode" : "TH", "geoNameId" : "1609350", "latitude" : 13.7563, "longitude" : 100.5018, "name" : "Bangkok" } } ], "continentRateQualifiers" : [ { "continent" : "NA" } ], "countryRateQualifiers" : [ { "country" : { "continentCode" : "AS", "geoNameId" : "1609350", "isoAlpha2" : "TH", "isoAlpha3" : "THA", "name" : "Thailand" } } ], "createdDate" : "2026-01-14T09:30:00", "descriptions" : [ { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" } ], "enabled" : true, "geoLocationRateQualifiers" : [ { "latitude" : 13.7563, "longitude" : 100.5018, "radiusInKilometers" : 50 } ], "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "ipRangeRateQualifiers" : [ { "endIPRange" : "192.168.1.255", "startIPRange" : "192.168.1.0" } ], "lastUpdate" : "2026-02-03T16:45:12", "masterRateIdentifiers" : [ "770e8400-e29b-41d4-a716-446655440222" ], "name" : "Early bird", "pricingType" : "PER_PERSON_PER_NIGHT", "promotionRateQualifiers" : [ { "promotion" : "EARLYBIRD2026" } ], "ratePlanIdentifiers" : [ "990e8400-e29b-41d4-a716-446655440444" ], "sellDateRateQualifiers" : [ { "effectiveDate" : "2026-05-01", "expireDate" : "2026-08-31" } ], "stayDateRateQualifiers" : [ { "effectiveDate" : "2026-06-01", "expireDate" : "2026-08-31" } ], "timezoneRateQualifiers" : [ { "timezone" : "Asia/Bangkok" } ], "type" : "DISCOUNT", "version" : 3 } ], "selfAcquires" : false, "subType" : "DIRECT", "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "supplierName" : "The Siam Residences, Bangkok", "version" : 3 }, "properties" : { "blacklisted" : { "type" : "boolean", "description" : "A way to blacklist a specific channel a property doesn't want to send blocking to.", "example" : false }, "channelDisabled" : { "type" : "boolean", "description" : "System override by supplier to disable channel. E.g. Platform disables supplier.", "example" : false }, "commission" : { "type" : "number", "format" : "float", "description" : "Amount of sales commission earned through this channel and all its children [unless configured at the child level].", "example" : 0.2, "maximum" : 1.0, "minimum" : 0.0 }, "createdDate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was first created", "example" : "2026-01-14T09:30:00", "readOnly" : true }, "enabled" : { "type" : "boolean", "default" : true, "description" : "Flag the supplier can use to enable / disable this channel", "example" : true }, "id" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier for this record.", "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "minLength" : 1 }, "lastUpdate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was last updated", "example" : "2026-02-03T16:45:12", "readOnly" : true }, "ownerIdentifier" : { "type" : "string", "format" : "uuid", "description" : "A specific identifier for the company / corporation / travel agency that is retrieving the rates", "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, "ownerName" : { "type" : "string", "description" : "Name of the owner / affiliate. `Hotel booking customization` when it's the booking customization.", "example" : "The Siam Residences" }, "percentDiscount" : { "type" : "number", "format" : "float", "description" : "Percent discount on this channel and all its children [unless configured at the child level].", "example" : 0.15, "maximum" : 1.0, "minimum" : 0.0 }, "rateModifierBundles" : { "type" : "array", "description" : "Promotion bundles for this channel", "items" : { "$ref" : "#/components/schemas/SpecialRateBundleLightweight_ManagingEntity" } }, "rateModifiers" : { "type" : "array", "description" : "Promotions for this channel", "items" : { "$ref" : "#/components/schemas/SpecialRateLightweight_ManagingEntity" } }, "selfAcquires" : { "type" : "boolean", "description" : "Whether the sales channel is a self-acquiring entity.", "example" : false }, "subType" : { "type" : "string", "description" : "What type of segment of channel is this.", "enum" : [ "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" ], "example" : "DIRECT" }, "supplierIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Channel is owned by this supplier identifier.", "example" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "minLength" : 1 }, "supplierName" : { "type" : "string", "description" : "Name of property / supplier that owns this channel", "example" : "The Siam Residences, Bangkok", "minLength" : 1 }, "version" : { "type" : [ "integer", "null" ], "format" : "int64", "description" : "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.", "example" : 3 } }, "required" : [ "blacklisted", "id", "subType", "supplierIdentifier", "supplierName" ] }, "SellDateRateQualifier" : { "type" : "object", "description" : "Qualifier that restricts a promotion to bookings made within a specific date window.", "example" : { "effectiveDate" : "2026-05-01", "expireDate" : "2026-08-31" }, "properties" : { "effectiveDate" : { "type" : "string", "format" : "date", "description" : "Promotion is available when the booking is made on or after this date (inclusive).", "example" : "2026-05-01" }, "expireDate" : { "type" : "string", "format" : "date", "description" : "Promotion is available when the booking is made on or before this date (inclusive).", "example" : "2026-08-31" } }, "required" : [ "effectiveDate", "expireDate" ] }, "SpecialRateBundleLightweight_ManagingEntity" : { "type" : "object", "description" : "A lightweight projection of a promotion bundle containing the full set of qualifying conditions and metadata.", "example" : { "aggregatedItemDescriptions" : [ { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" } ], "createdDate" : "2026-01-14T09:30:00", "descriptions" : [ { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" } ], "effectiveDescriptions" : [ { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" } ], "enabled" : true, "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "items" : [ { "addOnIdentifiers" : [ "880e8400-e29b-41d4-a716-446655440333" ], "blackoutDates" : [ { "effectiveDate" : "2026-04-13", "expireDate" : "2026-04-15" } ], "cityRateQualifiers" : [ { "city" : { "countryCode" : "TH", "geoNameId" : "1609350", "latitude" : 13.7563, "longitude" : 100.5018, "name" : "Bangkok" } } ], "continentRateQualifiers" : [ { "continent" : "NA" } ], "countryRateQualifiers" : [ { "country" : { "continentCode" : "AS", "geoNameId" : "1609350", "isoAlpha2" : "TH", "isoAlpha3" : "THA", "name" : "Thailand" } } ], "createdDate" : "2026-01-14T09:30:00", "descriptions" : [ { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" } ], "enabled" : true, "geoLocationRateQualifiers" : [ { "latitude" : 13.7563, "longitude" : 100.5018, "radiusInKilometers" : 50 } ], "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "ipRangeRateQualifiers" : [ { "endIPRange" : "192.168.1.255", "startIPRange" : "192.168.1.0" } ], "lastUpdate" : "2026-02-03T16:45:12", "masterRateIdentifiers" : [ "770e8400-e29b-41d4-a716-446655440222" ], "name" : "Early bird", "pricingType" : "PER_PERSON_PER_NIGHT", "promotionRateQualifiers" : [ { "promotion" : "EARLYBIRD2026" } ], "ratePlanIdentifiers" : [ "990e8400-e29b-41d4-a716-446655440444" ], "sellDateRateQualifiers" : [ { "effectiveDate" : "2026-05-01", "expireDate" : "2026-08-31" } ], "stayDateRateQualifiers" : [ { "effectiveDate" : "2026-06-01", "expireDate" : "2026-08-31" } ], "timezoneRateQualifiers" : [ { "timezone" : "Asia/Bangkok" } ], "type" : "DISCOUNT", "version" : 3 } ], "lastUpdate" : "2026-02-03T16:45:12", "name" : "Early bird - Long Term", "pricingType" : "PER_NIGHT", "type" : "DISCOUNT", "version" : 3 }, "properties" : { "aggregatedItemDescriptions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LocalizedDescription_ManagingEntity" } }, "createdDate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was first created", "example" : "2026-01-14T09:30:00", "readOnly" : true }, "descriptions" : { "type" : "array", "description" : "Optional bundle-level descriptions. When populated, these replace the aggregated item descriptions in offerDetails.", "items" : { "$ref" : "#/components/schemas/LocalizedDescription_ManagingEntity" } }, "effectiveDescriptions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LocalizedDescription_ManagingEntity" } }, "enabled" : { "type" : "boolean", "default" : true, "description" : "Whether this promotion ancillary is enabled or not.", "example" : true }, "hasFixedDiscountModifier" : { "type" : "boolean" }, "hasPercentDiscountModifier" : { "type" : "boolean" }, "hotelIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Hotel identifier.", "example" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "minLength" : 1 }, "id" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier for this record.", "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "minLength" : 1 }, "isValid" : { "type" : "boolean", "writeOnly" : true }, "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SpecialRateLightweight_ManagingEntity", "description" : "Promotions that go together to make up this ancillary." }, "minItems" : 1 }, "lastUpdate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was last updated", "example" : "2026-02-03T16:45:12", "readOnly" : true }, "modifierOverride" : { "$ref" : "#/components/schemas/VariableCharge_ManagingEntity", "description" : "Optional: override the combined discount of all bundle items with a single fixed or percentage amount." }, "name" : { "type" : "string", "description" : "Internal name of promotion ancillary.", "example" : "Early bird - Long Term", "minLength" : 1 }, "pricingType" : { "type" : "string", "description" : "Determines whether this discount should be applied per night, per stay or per person - per night; Required if amount override is not null", "enum" : [ "PER_STAY", "PER_DAY", "PER_NIGHT", "PER_USE", "PER_HOUR", "PER_PERSON", "PER_PERSON_PER_NIGHT", "PER_PERSON_PER_HOUR", "PER_ADULT", "PER_ADULT_PER_NIGHT", "PER_ADULT_PER_HOUR", "PER_CHILD", "PER_CHILD_PER_NIGHT", "PER_CHILD_PER_HOUR" ], "example" : "PER_NIGHT" }, "type" : { "type" : "string", "description" : "Required if manual override modifier is not null", "enum" : [ "PREMIUM", "DISCOUNT" ], "example" : "DISCOUNT" }, "version" : { "type" : [ "integer", "null" ], "format" : "int64", "description" : "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.", "example" : 3 } }, "required" : [ "enabled", "hotelIdentifier", "id", "items", "name" ] }, "SpecialRateLightweight_ManagingEntity" : { "type" : "object", "description" : "A lightweight projection of a special rate (promotion) containing all qualifying conditions and metadata.", "example" : { "addOnIdentifiers" : [ "880e8400-e29b-41d4-a716-446655440333" ], "blackoutDates" : [ { "effectiveDate" : "2026-04-13", "expireDate" : "2026-04-15" } ], "cityRateQualifiers" : [ { "city" : { "countryCode" : "TH", "geoNameId" : "1609350", "latitude" : 13.7563, "longitude" : 100.5018, "name" : "Bangkok" } } ], "continentRateQualifiers" : [ { "continent" : "NA" } ], "countryRateQualifiers" : [ { "country" : { "continentCode" : "AS", "geoNameId" : "1609350", "isoAlpha2" : "TH", "isoAlpha3" : "THA", "name" : "Thailand" } } ], "createdDate" : "2026-01-14T09:30:00", "descriptions" : [ { "creator" : "USER", "description" : "This is a longer description in the specified language.", "language" : "en", "md5ContentHash" : "d41d8cd98f00b204e9800998ecf8427e" } ], "enabled" : true, "geoLocationRateQualifiers" : [ { "latitude" : 13.7563, "longitude" : 100.5018, "radiusInKilometers" : 50 } ], "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "ipRangeRateQualifiers" : [ { "endIPRange" : "192.168.1.255", "startIPRange" : "192.168.1.0" } ], "lastUpdate" : "2026-02-03T16:45:12", "masterRateIdentifiers" : [ "770e8400-e29b-41d4-a716-446655440222" ], "name" : "Early bird", "pricingType" : "PER_PERSON_PER_NIGHT", "promotionRateQualifiers" : [ { "promotion" : "EARLYBIRD2026" } ], "ratePlanIdentifiers" : [ "990e8400-e29b-41d4-a716-446655440444" ], "sellDateRateQualifiers" : [ { "effectiveDate" : "2026-05-01", "expireDate" : "2026-08-31" } ], "stayDateRateQualifiers" : [ { "effectiveDate" : "2026-06-01", "expireDate" : "2026-08-31" } ], "timezoneRateQualifiers" : [ { "timezone" : "Asia/Bangkok" } ], "type" : "DISCOUNT", "version" : 3 }, "properties" : { "addOnIdentifiers" : { "type" : "array", "items" : { "type" : "string", "format" : "uuid", "description" : "Add-on identifier", "example" : "880e8400-e29b-41d4-a716-446655440333" } }, "advanceBookingRateQualifier" : { "$ref" : "#/components/schemas/AdvanceBookingRateQualifier_ManagingEntity", "description" : "Restrict promotion to users who want to book in advance." }, "arrivalDaysOfWeekRateQualifier" : { "$ref" : "#/components/schemas/ArrivalDaysOfWeekRateQualifier_ManagingEntity", "description" : "Restrict promotion to specific days of the week the guest is arriving." }, "availableDaysOfWeekRateQualifier" : { "$ref" : "#/components/schemas/AvailableDaysOfWeekRateQualifier_ManagingEntity", "description" : "Restrict promotion to specific days of the week the promotion is available." }, "blackoutDates" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BlackoutDate" } }, "cityRateQualifiers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CityRateQualifierLightweight" } }, "continentRateQualifiers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ContinentRateQualifier" } }, "countryRateQualifiers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CountryRateQualifier" } }, "createdDate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was first created", "example" : "2026-01-14T09:30:00", "readOnly" : true }, "departureDaysOfWeekRateQualifier" : { "$ref" : "#/components/schemas/DepartureDaysOfWeekRateQualifier_ManagingEntity", "description" : "Restrict promotion to specific days of the week the guest is departing." }, "descriptions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LocalizedDescription" }, "minItems" : 1 }, "enabled" : { "type" : "boolean", "default" : true, "description" : "Whether this promotion is enabled or not.", "example" : true }, "geoLocationRateQualifiers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GeoLocationRateQualifier" } }, "hotelIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier of the property this promotion belongs to.", "example" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "minLength" : 1 }, "id" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier for this record.", "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "minLength" : 1 }, "ipRangeRateQualifiers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IPRangeRateQualifier" } }, "lastMinuteRateQualifier" : { "$ref" : "#/components/schemas/MinutesBeforeBookingStartDateRateQualifier_ManagingEntity", "description" : "Restrict promotion to users who want to book a room close to the date." }, "lastUpdate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was last updated", "example" : "2026-02-03T16:45:12", "readOnly" : true }, "lengthOfStayRateQualifier" : { "$ref" : "#/components/schemas/LengthOfStayRateQualifier_ManagingEntity", "description" : "Restrict promotion to users who want to stay a certain number of days." }, "masterRateIdentifiers" : { "type" : "array", "items" : { "type" : "string", "format" : "uuid", "description" : "Master rate identifier", "example" : "770e8400-e29b-41d4-a716-446655440222" } }, "modifier" : { "$ref" : "#/components/schemas/VariableCharge_ManagingEntity", "description" : "The discount or premium amount and its type (fixed or percentage)." }, "name" : { "type" : "string", "description" : "Internal name of promotion.", "example" : "Early bird", "minLength" : 1 }, "prepayRateQualifier" : { "$ref" : "#/components/schemas/PrepayRateQualifier_ManagingEntity", "description" : "Restrict promotion to either prepaid / non-prepaid rates." }, "pricingType" : { "type" : "string", "description" : "This determines whether this discount should be applied per night, per stay or per person - per night", "enum" : [ "PER_STAY", "PER_DAY", "PER_NIGHT", "PER_USE", "PER_HOUR", "PER_PERSON", "PER_PERSON_PER_NIGHT", "PER_PERSON_PER_HOUR", "PER_ADULT", "PER_ADULT_PER_NIGHT", "PER_ADULT_PER_HOUR", "PER_CHILD", "PER_CHILD_PER_NIGHT", "PER_CHILD_PER_HOUR" ], "example" : "PER_PERSON_PER_NIGHT" }, "promotionRateQualifiers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PromotionRateQualifier" } }, "ratePlanIdentifiers" : { "type" : "array", "items" : { "type" : "string", "format" : "uuid", "description" : "Rate plan identifier", "example" : "990e8400-e29b-41d4-a716-446655440444" } }, "refundableRateQualifier" : { "$ref" : "#/components/schemas/RefundableRateQualifier_ManagingEntity", "description" : "Restrict promotion to either refundable / non-refundable rates." }, "requiredDaysOfWeekRateQualifier" : { "$ref" : "#/components/schemas/RequiredDaysOfWeekRateQualifier_ManagingEntity", "description" : "Restrict promotion to specific days of the week the guest has to stay." }, "roomRangeRateQualifier" : { "$ref" : "#/components/schemas/RoomRangeRateQualifier_ManagingEntity", "description" : "Restrict promotion by restricting to how many rooms the user wants." }, "sellDateRateQualifiers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SellDateRateQualifier" } }, "stayDateRateQualifiers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/StayDateRateQualifier" } }, "timezoneRateQualifiers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TimezoneRateQualifier" } }, "type" : { "type" : "string", "description" : "Set whether you want the price to go up or down when the rules of this promotion have been satisfied.", "enum" : [ "PREMIUM", "DISCOUNT" ], "example" : "DISCOUNT" }, "version" : { "type" : [ "integer", "null" ], "format" : "int64", "description" : "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.", "example" : 3 } }, "required" : [ "descriptions", "enabled", "hotelIdentifier", "id", "modifier", "name", "pricingType", "type" ] }, "StayDateRateQualifier" : { "type" : "object", "description" : "Rate qualifier that restricts a promotion to guests whose stay falls within a specific date range.", "example" : { "effectiveDate" : "2026-06-01", "expireDate" : "2026-08-31" }, "properties" : { "effectiveDate" : { "type" : "string", "format" : "date", "description" : "Promotion applies when guest's stay starts on or after this date (inclusive).", "example" : "2026-06-01" }, "expireDate" : { "type" : "string", "format" : "date", "description" : "Promotion applies when guest's stay starts on or before this date (inclusive).", "example" : "2026-08-31" } }, "required" : [ "effectiveDate", "expireDate" ] }, "TimezoneRateQualifier" : { "type" : "object", "description" : "Qualifier that restricts a promotion to guests whose system timezone matches the specified IANA timezone name.", "example" : { "timezone" : "Asia/Bangkok" }, "properties" : { "timezone" : { "type" : "string", "description" : "IANA timezone name of the booker's location (e.g. Asia/Bangkok).", "example" : "Asia/Bangkok", "minLength" : 1 } }, "required" : [ "timezone" ] }, "VariableCharge_ManagingEntity" : { }, "UpsertSupplierInventoryMapRequest_ManagingEntity" : { "type" : "object", "description" : "Request to create a map for a single supplier property", "example" : { "circles" : [ { "radius" : 2.5 } ], "customizationIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "displayType" : "NATIVE", "draggable" : true, "initialZoomLevel" : 15, "mapHeight" : 500, "mapMarkerColor" : "cc2138", "mapStyle" : "normal", "name" : "Premium Hotels in Southeast Asia", "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "type" : "GUEST_ROOM", "zoomable" : true }, "properties" : { "circles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConfigurableGeoJsonCircle_ManagingEntity", "description" : "Optional circular overlay regions on the map" } }, "customizationIdentifier" : { "type" : "string", "format" : "uuid", "description" : "UUID of the customization context (e.g., Wink Links, channel manager)", "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "minLength" : 1 }, "displayType" : { "type" : "string", "default" : "NATIVE", "description" : "Which data to display initially (NATIVE, MODIFIED, or AFFILIATE)", "enum" : [ "NATIVE", "HOTEL", "ROOM" ], "example" : "NATIVE" }, "draggable" : { "type" : "boolean", "default" : true, "description" : "Allow users to pan the map by dragging", "example" : true }, "initialZoomLevel" : { "type" : "integer", "format" : "int32", "description" : "Initial zoom level (0-21, where 0 shows the entire world)", "example" : 15, "maximum" : 21, "minimum" : 0 }, "mapHeight" : { "type" : "integer", "format" : "int32", "description" : "Height of the embedded map in pixels", "example" : 500, "minimum" : 1 }, "mapMarkerColor" : { "type" : "string", "description" : "Hexadecimal color code for map markers", "enum" : [ "cc2138" ], "example" : "cc2138" }, "mapStyle" : { "type" : "string", "description" : "Map visual style (normal, clean, or bluish)", "enum" : [ "normal", "clean", "bluish" ], "example" : "normal" }, "markers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConfigurableGeoJsonPoint_ManagingEntity", "description" : "Optional custom markers to display on the map" } }, "name" : { "type" : "string", "description" : "Display name for this map", "example" : "Premium Hotels in Southeast Asia", "minLength" : 1 }, "polygons" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConfigurableGeoJsonPolygon_ManagingEntity", "description" : "Optional polygonal overlay regions on the map" } }, "rectangles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConfigurableGeoJsonRectangle_ManagingEntity", "description" : "Optional rectangular overlay regions on the map" } }, "supplierIdentifier" : { "type" : "string", "format" : "uuid", "description" : "UUID of the supplier property to display on the map", "example" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "minLength" : 1 }, "type" : { "type" : "string", "description" : "Type of inventory to display from the supplier (GUEST_ROOM, ACTIVITY, SPA, etc.)", "enum" : [ "GUEST_ROOM", "ADD_ON", "MEETING_ROOM", "RESTAURANT", "SPA", "ATTRACTION", "PLACE", "ACTIVITY" ], "example" : "GUEST_ROOM" }, "zoomable" : { "type" : "boolean", "default" : true, "description" : "Allow users to zoom in and out", "example" : true } }, "required" : [ "customizationIdentifier", "displayType", "draggable", "initialZoomLevel", "mapHeight", "mapMarkerColor", "mapStyle", "name", "supplierIdentifier", "type", "zoomable" ] }, "UpsertSupplierSellableItemRequest_ManagingEntity" : { "type" : "object", "description" : "Request payload used by a supplier to create or update a sellable item on their own channel, omitting the channelInventoryIdentifier which is resolved by the system.", "example" : { "animate" : false, "animateDelay" : 800, "channelInventoryType" : "GUEST_ROOM", "customizationIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "descriptions" : [ { "creator" : "USER", "description" : "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language" : "en", "md5ContentHash" : "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name" : "Deluxe River View Suite" } ], "displayType" : "NATIVE", "inventoryType" : "HOTEL", "keywords" : [ "luxury-accommodation" ], "multimedias" : [ { "angle" : null, "attribution" : [ ], "category" : "2", "descriptions" : [ { "description" : "Elegant lobby of The Siam Residences", "language" : "en", "title" : "Lobby Entrance" } ], "height" : 1600, "identifier" : "the-siam-residences/lobby-entrance", "isLandscape" : true, "lifestyleType" : null, "multimediaIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published" : true, "sort" : 10, "source" : "CLOUDINARY", "type" : "IMAGE", "width" : 2560 } ], "name" : "Deluxe Room with Spa Access", "sort" : "POPULARITY", "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18" }, "properties" : { "animate" : { "type" : "boolean", "default" : false, "description" : "Create an animated gif instead of a list of images. Feature currently not available. Feel free to enable and it will become available at a later date.", "example" : false }, "animateDelay" : { "type" : "integer", "format" : "int32", "description" : "Controls animation delay in milliseconds", "example" : 800 }, "channelInventoryType" : { "type" : "string", "description" : "Channel inventory type is a subset of inventory type in that it does not include the `HOTEL` type. THe way it works is, as a seller you might want to sell a guest room but instead of showing the price of that guest room, you would like to display the best room type price for the property.", "enum" : [ "GUEST_ROOM", "ADD_ON", "MEETING_ROOM", "RESTAURANT", "SPA", "ATTRACTION", "PLACE", "ACTIVITY" ], "example" : "GUEST_ROOM" }, "customizationIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Which configuration to use with this item", "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "minLength" : 1 }, "descriptions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SimpleDescription_ManagingEntity", "description" : "Title and description of inventory." }, "maxItems" : 2147483647, "minItems" : 1 }, "displayType" : { "type" : "string", "default" : "NATIVE", "description" : "Indicate which initial values to display first on the front-facing card", "enum" : [ "NATIVE", "HOTEL", "ROOM" ], "example" : "NATIVE" }, "inventoryType" : { "type" : "string", "description" : "The type of inventory being offer up for sale", "enum" : [ "HOTEL", "GUEST_ROOM", "MEETING_ROOM", "RESTAURANT", "SPA", "ADD_ON", "ATTRACTION", "ACTIVITY", "PLACE" ], "example" : "HOTEL" }, "keywords" : { "type" : "array", "items" : { "type" : "string", "description" : "Keywords describing this item for discovery", "example" : "luxury-accommodation" }, "maxItems" : 2147483647, "minItems" : 1 }, "multimedias" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SimpleMultimedia_ManagingEntity", "description" : "Reference identifiers to Cloudinary media assets" }, "maxItems" : 2147483647, "minItems" : 1 }, "name" : { "type" : "string", "description" : "Descriptive name of this item for seller use", "example" : "Deluxe Room with Spa Access", "minLength" : 1 }, "sort" : { "type" : "string", "description" : "The specific badge to display over the image on the Web Component.", "enum" : [ "RECOMMENDED", "PRICE_LOW_TO_HIGH", "PRICE_HIGH_TO_LOW", "ECO" ], "example" : "POPULARITY" }, "supplierIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Supplier / Hotel identifier that owns this inventory", "example" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "minLength" : 1 } }, "required" : [ "channelInventoryType", "customizationIdentifier", "descriptions", "displayType", "inventoryType", "keywords", "multimedias", "name", "supplierIdentifier" ] }, "DynamicSellerListRequest_ManagingEntity" : { "type" : "object", "description" : "Paginated search for travel inventory.", "example" : { "displayCurrency" : "THB", "list" : { "aggregateReviewRating" : 8, "architecturalStyles" : 7, "cities" : [ "1609350" ], "continents" : [ "AS" ], "countries" : [ "1605651" ], "hotelCategories" : 1, "hotelStars" : 5, "inventoryName" : "Deluxe Suite", "inventoryTypes" : [ "GUEST_ROOM" ], "locationCategories" : 1701, "name" : "Bangkok Luxury Hotels", "primaryOrderBy" : "4", "propertyName" : "The Siam", "radiusInMeters" : 5000, "segmentCategories" : 7, "showChildFriendly" : false, "showDirectOnly" : false, "showEcoFriendly" : false, "showPetFriendly" : false, "showPopular" : false }, "page" : 0, "size" : 24 }, "properties" : { "displayCurrency" : { "type" : "string", "default" : "USD", "description" : "Which currency to display the prices in.", "example" : "THB", "pattern" : "^[A-Z]{3}$" }, "list" : { "$ref" : "#/components/schemas/UpsertDynamicSellerListRequest_ManagingEntity", "description" : "Contains the caller's search criteria." }, "page" : { "type" : "integer", "format" : "int32", "default" : 0, "description" : "Which page to view out of total search results.", "example" : 0, "minimum" : 0 }, "size" : { "type" : "integer", "format" : "int32", "default" : 24, "description" : "How many result set to return at the time.", "example" : 24, "maximum" : 50, "minimum" : 1 } }, "required" : [ "list", "page", "size" ] }, "UpsertDynamicSellerListRequest_ManagingEntity" : { "type" : "object", "description" : "Request payload for a seller to create or update a dynamic inventory search list with filter criteria and sort preferences.", "example" : { "aggregateReviewRating" : 8, "architecturalStyles" : 7, "cities" : [ "1609350" ], "continents" : [ "AS" ], "countries" : [ "1605651" ], "hotelCategories" : 1, "hotelStars" : 5, "inventoryName" : "Deluxe Suite", "inventoryTypes" : [ "GUEST_ROOM" ], "locationCategories" : 1701, "name" : "Bangkok Luxury Hotels", "primaryOrderBy" : "4", "propertyName" : "The Siam", "radiusInMeters" : 5000, "segmentCategories" : 7, "showChildFriendly" : false, "showDirectOnly" : false, "showEcoFriendly" : false, "showPetFriendly" : false, "showPopular" : false }, "properties" : { "aggregateReviewRating" : { "type" : "integer", "format" : "int32", "description" : "Filter on aggregate review score the hotel has", "example" : 8 }, "architecturalStyles" : { "type" : "array", "description" : "Supported OTA specification `ARC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", "example" : 7, "items" : { "type" : "string" } }, "cities" : { "type" : "array", "description" : "City filter", "items" : { "type" : "string", "description" : "Filter on GeoNameId of city", "example" : "1609350" } }, "continents" : { "type" : "array", "description" : "Continent filter", "items" : { "type" : "string", "description" : "Filter on standardized continent codes", "example" : "AS" } }, "countries" : { "type" : "array", "description" : "Country filter", "items" : { "type" : "string", "description" : "Filter on GeoNameId of country", "example" : "1605651" } }, "hotelCategories" : { "type" : "array", "description" : "Supported OTA specification `PCT` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", "example" : 1, "items" : { "type" : "string" } }, "hotelStars" : { "type" : "integer", "format" : "int32", "description" : "Filter on number of stars the hotel has.", "example" : 5 }, "inventoryName" : { "type" : "string", "description" : "Regex expression filter matching on inventory name", "example" : "Deluxe Suite" }, "inventoryTypes" : { "type" : "array", "description" : "Filter on inventory types", "items" : { "type" : "string", "description" : "Type of sellable travel inventory on the Wink platform", "enum" : [ "GUEST_ROOM", "ADD_ON", "MEETING_ROOM", "RESTAURANT", "SPA", "ATTRACTION", "PLACE", "ACTIVITY" ], "example" : "GUEST_ROOM" } }, "lifestyles" : { "type" : "array", "description" : "Filter on lifestyles", "items" : { "type" : "string", "description" : "Specific lifestyle preference type used to match travelers with suitable inventory", "enum" : [ "LIFESTYLE_HEALTH_FITNESS", "LIFESTYLE_RELAX", "LIFESTYLE_ADULT_ONLY", "LIFESTYLE_ADVENTURE", "LIFESTYLE_BUSINESS", "LIFESTYLE_LGBT", "LIFESTYLE_SINGLE_PARENT", "LIFESTYLE_SOLO_FEMALE", "LIFESTYLE_BEAUTY", "LIFESTYLE_FOODIE", "LIFESTYLE_FAMILY", "LIFESTYLE_ROMANCE", "LIFESTYLE_COUPLE", "LIFESTYLE_SOLO", "LIFESTYLE_BACKPACKER", "LIFESTYLE_SHOPPING", "LIFESTYLE_SPORTS", "LIFESTYLE_MOUNTAIN", "LIFESTYLE_BEACH", "LIFESTYLE_CITY", "LIFESTYLE_COUNTRY", "LIFESTYLE_CULTURE", "LIFESTYLE_ECO" ] } }, "locationCategories" : { "type" : "array", "description" : "Supported OTA specification `LOC` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", "example" : 1701, "items" : { "type" : "string" } }, "name" : { "type" : "string", "description" : "Name of dynamic list for when user want to persist it", "example" : "Bangkok Luxury Hotels" }, "nearPoint" : { "$ref" : "#/components/schemas/GeoJsonPoint_ManagingEntity", "description" : "Find hotels close to certain location" }, "primaryOrderBy" : { "type" : "string", "description" : "Control how you want the search results sorted. Options are:\n\n- 1: Inventory name\n- 2: Price: High to low\n- 3: Price: Low to high\n- 4: Commission: High to low\n- 5: Commission: Low to high\n- 6: Discount: High to low\n- 7: Discount: Low to high\n", "example" : "4" }, "propertyName" : { "type" : "string", "description" : "Regex expression filter matching on property name.", "example" : "The Siam" }, "radiusInMeters" : { "type" : "integer", "format" : "int64", "default" : 0, "description" : "Use this in conjunction with `nearPoint`. Control the distance from point we are searching for.", "example" : 5000 }, "segmentCategories" : { "type" : "array", "description" : "Supported OTA specification `SEG` code. See [OTA geoname data](#operation/showAvailableCodesForCategory)", "example" : 7, "items" : { "type" : "string" } }, "showChildFriendly" : { "type" : "boolean", "default" : false, "description" : "Filter on child-friendly hotels", "example" : false }, "showDirectOnly" : { "type" : "boolean", "default" : false, "description" : "Filter on direct inventory", "example" : false }, "showEcoFriendly" : { "type" : "boolean", "default" : false, "description" : "Filter on eco-friendly hotels", "example" : false }, "showPetFriendly" : { "type" : "boolean", "default" : false, "description" : "Filter on pet-friendly hotels", "example" : false }, "showPopular" : { "type" : "boolean", "default" : false, "description" : "Filter on hotel that has had a certain amount of bookings", "example" : false } } }, "InventorySupplierAggregateLightweight_ManagingEntity" : { "type" : "object", "description" : "Lightweight aggregated view of inventory suppliers, combining a sales channel with a lightweight hotel summary (PropertyAggregateLightweight) and the lowest available price.", "example" : { "hotel" : { "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "name" : "The Siam Residences, Bangkok", "uniqueId" : "siam01", "urlName" : "the-siam-residences-bangkok" }, "lowestDisplayPrice" : { "amount" : 125.0, "currency" : "USD" }, "lowestPrice" : { "amount" : 4500.0, "currency" : "THB" }, "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" } }, "properties" : { "distanceInMeters" : { "type" : "number", "format" : "double", "description" : "Distance in metres from the searched point to the nearest inventory item, when the query was a near-point search." }, "hotel" : { "$ref" : "#/components/schemas/PropertyAggregateLightweight_ManagingEntity", "description" : "Combined property data." }, "lowestDisplayPrice" : { "$ref" : "#/components/schemas/CustomMonetaryAmount", "description" : "Best price of the room type or facility ancillary in platform currency" }, "lowestPrice" : { "$ref" : "#/components/schemas/CustomMonetaryAmount", "description" : "Best price of the room type or facility ancillary" }, "salesChannel" : { "$ref" : "#/components/schemas/SalesChannelLightweight_ManagingEntity", "description" : "Parent sales channel" } }, "required" : [ "hotel", "salesChannel" ] }, "PageResponseInventorySupplierAggregateLightweight_ManagingEntity" : { "type" : "object", "description" : "Owned pagination envelope: a page of content plus flat page metadata.", "example" : { "content" : [ { "hotel" : { "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "name" : "The Siam Residences, Bangkok", "uniqueId" : "siam01", "urlName" : "the-siam-residences-bangkok" }, "lowestDisplayPrice" : { "amount" : 125.0, "currency" : "USD" }, "lowestPrice" : { "amount" : 4500.0, "currency" : "THB" }, "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 }, "properties" : { "content" : { "type" : "array", "description" : "The elements on this page.", "items" : { "$ref" : "#/components/schemas/InventorySupplierAggregateLightweight_ManagingEntity" } }, "first" : { "type" : "boolean", "description" : "Whether this is the first page.", "example" : true }, "last" : { "type" : "boolean", "description" : "Whether this is the last page.", "example" : false }, "number" : { "type" : "integer", "format" : "int32", "description" : "Zero-based index of this page.", "example" : 0 }, "numberOfElements" : { "type" : "integer", "format" : "int32", "description" : "Number of elements on this page.", "example" : 20 }, "size" : { "type" : "integer", "format" : "int32", "description" : "The requested page size.", "example" : 20 }, "totalElements" : { "type" : "integer", "format" : "int64", "description" : "Total number of elements across all pages.", "example" : 1234 }, "totalPages" : { "type" : "integer", "format" : "int32", "description" : "Total number of pages for the current page size.", "example" : 62 } } }, "InventoryAggregateLightweight_ManagingEntity" : { "type" : "object", "description" : "Lightweight aggregated inventory record joining inventory data with a lightweight hotel summary (PropertyAggregateLightweight), used as the result of a MongoDB aggregation pipeline.", "example" : { "address" : { "address1" : "20 Soi Ton Son", "address2" : null, "city" : "Bangkok", "countryCode" : "TH", "county" : null, "postalCode" : "10330", "state" : null }, "bookable" : true, "commissionable" : true, "createdDate" : "2026-01-14T09:30:00", "enabled" : true, "hotel" : { "currencyCode" : "THB", "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "name" : "The Siam Residences, Bangkok", "starRating" : "5", "uniqueId" : "siam01", "urlName" : "the-siam-residences-bangkok-thailand" }, "id" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "image" : { "descriptions" : [ { "description" : "Spacious city view room", "language" : "en", "title" : "Deluxe Room" } ], "identifier" : "the-siam-residences/deluxe-room-city-view", "isLandscape" : true, "multimediaIdentifier" : "9d4e2b7a-3f1c-4d5b-8a6e-2c0f9b3d1e47", "published" : true, "sort" : 1, "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.0, "currency" : "USD" }, "lowestPrice" : { "amount" : 4500.0, "currency" : "THB" }, "pricePoint" : "THREE", "quantity" : 24, "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" } }, "properties" : { "address" : { "$ref" : "#/components/schemas/SimpleAddress_ManagingEntity", "description" : "Defaults to property address." }, "bookable" : { "type" : "boolean", "default" : true, "description" : "Whether inventory can be booked", "example" : true }, "commissionable" : { "type" : "boolean", "default" : false, "description" : "Whether this is commissionable or not", "example" : true }, "createdDate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was first created", "example" : "2026-01-14T09:30:00", "readOnly" : true }, "enabled" : { "type" : "boolean", "default" : true, "description" : "Whether this inventory is enabled or not", "example" : true }, "hotel" : { "$ref" : "#/components/schemas/PropertyAggregateLightweight_ManagingEntity", "description" : "Linked hotel" }, "id" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier for this record.", "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, "image" : { "$ref" : "#/components/schemas/SimpleMultimedia_ManagingEntity", "description" : "Main image of inventory" }, "inventoryIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Inventory type identifier", "example" : "6f9b4c8d-1e5a-4b3c-9d2e-8a7f0c1b5e43", "minLength" : 1 }, "inventoryName" : { "type" : "string", "description" : "Name of inventory as hotel is seeing it", "example" : "Deluxe Room with City View", "minLength" : 1 }, "inventoryNameInEnglish" : { "type" : "string", "description" : "Name of inventory as traveler is seeing it", "example" : "Deluxe City View Room", "minLength" : 1 }, "inventoryType" : { "type" : "string", "description" : "Inventory type", "enum" : [ "GUEST_ROOM", "ADD_ON", "MEETING_ROOM", "RESTAURANT", "SPA", "ATTRACTION", "PLACE", "ACTIVITY" ], "example" : "GUEST_ROOM" }, "lastUpdate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was last updated", "example" : "2026-02-03T16:45:12", "readOnly" : true }, "location" : { "$ref" : "#/components/schemas/GeoJsonPoint_ManagingEntity", "description" : "Location", "example" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "POINT" } }, "lowestDisplayPrice" : { "$ref" : "#/components/schemas/CustomMonetaryAmount", "description" : "Best price of the room type or facility ancillary in platform currency" }, "lowestPrice" : { "$ref" : "#/components/schemas/CustomMonetaryAmount", "description" : "Best price of the room type or facility ancillary" }, "pricePoint" : { "type" : "string", "default" : "THREE", "description" : "Level of expensiveness.", "enum" : [ "HALF", "ONE", "ONE_HALF", "TWO", "TWO_HALF", "THREE", "THREE_HALF", "FOUR", "FOUR_HALF", "FIVE" ], "example" : "THREE" }, "quantity" : { "type" : "integer", "format" : "int32", "default" : 0, "description" : "quantity", "example" : 100 }, "salesChannel" : { "$ref" : "#/components/schemas/SalesChannelLightweight_ManagingEntity", "description" : "Parent sales channel" }, "version" : { "type" : [ "integer", "null" ], "format" : "int64", "description" : "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.", "example" : 3 } }, "required" : [ "address", "bookable", "commissionable", "enabled", "image", "inventoryIdentifier", "inventoryName", "inventoryNameInEnglish", "inventoryType", "location", "pricePoint", "quantity", "salesChannel" ] }, "PageResponseInventoryAggregateLightweight_ManagingEntity" : { "type" : "object", "description" : "Owned pagination envelope: a page of content plus flat page metadata.", "example" : { "content" : [ { "address" : { "address1" : "20 Soi Ton Son", "address2" : null, "city" : "Bangkok", "countryCode" : "TH", "county" : null, "postalCode" : "10330", "state" : null }, "bookable" : true, "commissionable" : true, "createdDate" : "2026-01-14T09:30:00", "enabled" : true, "hotel" : { "currencyCode" : "THB", "hotelIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "name" : "The Siam Residences, Bangkok", "starRating" : "5", "uniqueId" : "siam01", "urlName" : "the-siam-residences-bangkok-thailand" }, "id" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "image" : { "descriptions" : [ { "description" : "Spacious city view room", "language" : "en", "title" : "Deluxe Room" } ], "identifier" : "the-siam-residences/deluxe-room-city-view", "isLandscape" : true, "multimediaIdentifier" : "9d4e2b7a-3f1c-4d5b-8a6e-2c0f9b3d1e47", "published" : true, "sort" : 1, "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.0, "currency" : "USD" }, "lowestPrice" : { "amount" : 4500.0, "currency" : "THB" }, "pricePoint" : "THREE", "quantity" : 24, "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 }, "properties" : { "content" : { "type" : "array", "description" : "The elements on this page.", "items" : { "$ref" : "#/components/schemas/InventoryAggregateLightweight_ManagingEntity" } }, "first" : { "type" : "boolean", "description" : "Whether this is the first page.", "example" : true }, "last" : { "type" : "boolean", "description" : "Whether this is the last page.", "example" : false }, "number" : { "type" : "integer", "format" : "int32", "description" : "Zero-based index of this page.", "example" : 0 }, "numberOfElements" : { "type" : "integer", "format" : "int32", "description" : "Number of elements on this page.", "example" : 20 }, "size" : { "type" : "integer", "format" : "int32", "description" : "The requested page size.", "example" : 20 }, "totalElements" : { "type" : "integer", "format" : "int64", "description" : "Total number of elements across all pages.", "example" : 1234 }, "totalPages" : { "type" : "integer", "format" : "int32", "description" : "Total number of pages for the current page size.", "example" : 62 } } }, "BookingOverviewRequest_Supplier" : { "type" : "object", "description" : "Request parameters for generating a booking overview analytics time series.", "example" : { "type" : "MONTH", "units" : 12 }, "properties" : { "type" : { "type" : "string", "description" : "The type of time series that should be used", "enum" : [ "HOUR", "DAY", "MONTH", "YEAR" ], "example" : "MONTH" }, "units" : { "type" : "integer", "format" : "int64", "description" : "How many units of the timeseries type should be used", "example" : 12 } }, "required" : [ "type" ] }, "BookingAnalytics_Supplier" : { "type" : "object", "description" : "Analytics data for a property's bookings, containing chart series for visualizing booking trends.", "example" : { "charts" : [ { "identifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "legend" : { "data" : [ "Bookings" ] }, "series" : [ { "data" : [ 12, 18, 25, 30, 22, 40 ], "name" : "Bookings" } ], "title" : { "text" : "Monthly Bookings" }, "xAxis" : { "data" : [ "Jan", "Feb", "Mar", "Apr", "May", "Jun" ] } } ] }, "properties" : { "charts" : { "type" : "array", "description" : "Interesting property-level chart data overview", "items" : { "$ref" : "#/components/schemas/LineChart_Supplier" } } }, "required" : [ "charts" ] }, "ChartCategoryAxis_Supplier" : { "type" : "object", "description" : "Configuration options for the category (X) axis of the chart, including the list of category names.", "properties" : { "data" : { "type" : "array", "description" : "The category names. The Chart creates a category for every item of the array.", "items" : { "type" : "string" } } }, "required" : [ "data" ] }, "ChartLegend_Supplier" : { "type" : "object", "description" : "The chart legend, containing the list of series names displayed in the legend.", "properties" : { "data" : { "type" : "array", "description" : "The legend labels, one entry per series.", "items" : { "type" : "string" } } }, "required" : [ "data" ] }, "ChartSeries_Supplier" : { "type" : "object", "description" : "A named data series for a chart, pairing a display name with its array of numeric data points.", "example" : { "name" : "Revenue" }, "properties" : { "data" : { "type" : "array", "description" : "The array of data items which represent the series data.\n\nYou can set it to:\n\n- Array of numbers. Supported when the series.type option is set to `area`, `bar`, `column`, `donut`, `pie`, `line`, or `waterfall`.\nThe Bubble series need arrays of three values—X value, Y value, and Size value—for example, [1, 1, 10]. The Scatter and ScatterLine series need arrays of two values—X value and Y value. The OHLC and Candlestick series need arrays of four values—open, high, low, and close. The RangeBar and RangeArea series need arrays of two values—the from and to value.", "items" : { "type" : "number" } }, "name" : { "type" : "string", "description" : "The name of the Chart series which is visible in the legend.", "example" : "Revenue" } }, "required" : [ "data", "name" ] }, "ChartTitle_Supplier" : { "type" : "object", "description" : "The title displayed at the top of the chart.", "example" : { "text" : "Monthly Booking Revenue" }, "properties" : { "text" : { "type" : "string", "description" : "The text content of the chart title.", "example" : "Monthly Booking Revenue" } }, "required" : [ "text" ] }, "LineChart_Supplier" : { "type" : "object", "description" : "A line chart data structure containing an identifier, title, legend, one or more series of data points, and category axis configuration.", "example" : { "identifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "legend" : { "data" : [ "Revenue", "Refunds" ] }, "series" : [ { "data" : [ 120000, 95000, 148000, 210000, 175000, 230000 ], "name" : "Revenue" }, { "data" : [ 5000, 3200, 7800, 4100, 6500, 2900 ], "name" : "Refunds" } ], "title" : { "text" : "Monthly Booking Revenue" }, "xAxis" : { "data" : [ "Jan", "Feb", "Mar", "Apr", "May", "Jun" ] } }, "properties" : { "identifier" : { "type" : "string", "format" : "uuid", "description" : "Unique line chart identifier", "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51" }, "legend" : { "$ref" : "#/components/schemas/ChartLegend_Supplier", "description" : "The configuration options for the chart legend." }, "series" : { "type" : "array", "description" : "The configuration of the chart series. The series type is determined by the value of the type field. If a type value is missing, the chart renders the type that is specified in `seriesDefaults`. Some options accept functions as arguments. These arguments are evaluated for each point which is supplied as a parameter. If no value is returned, the chart uses the `theme` or `seriesDefaults` values.", "items" : { "$ref" : "#/components/schemas/ChartSeries_Supplier" } }, "title" : { "$ref" : "#/components/schemas/ChartTitle_Supplier", "description" : "The configuration options for the chart title" }, "xAxis" : { "$ref" : "#/components/schemas/ChartCategoryAxis_Supplier", "description" : "The configuration options of the category axis.", "title" : "Category axis" }, "xaxis" : { "$ref" : "#/components/schemas/ChartCategoryAxis_Supplier" } }, "required" : [ "identifier", "legend", "series", "title", "xAxis" ] }, "SortStaticListItemsRequest_ManagingEntity" : { "type" : "object", "description" : "Request to apply a new display order to the items within a curated list.", "properties" : { "items" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int32" }, "description" : "Mapping of item identifier to sort position (0-based index)" } }, "required" : [ "items" ] }, "KeyValuePair_ManagingEntity" : { "type" : "object", "description" : "Immutable key-value pair associating a machine-readable value with a human-readable label.", "example" : { "label" : "Hotel & Resort", "value" : "HOTEL" }, "properties" : { "label" : { "type" : "string", "description" : "English readable text of the value.", "example" : "Readable text label", "minLength" : 1 }, "value" : { "type" : "string", "description" : "The value that should be persisted.", "example" : "id-1", "minLength" : 1 } }, "required" : [ "label", "value" ] }, "SalesChannelRequestLightweight_ManagingEntity" : { "type" : "object", "description" : "A request for relationship between two parties.", "example" : { "createdDate" : "2026-01-14T09:30:00", "id" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "introductoryMessage" : "We represent a travel agency network with strong demand for your properties and would like to establish a partnership to offer exclusive rates to our members.", "lastUpdate" : "2026-02-03T16:45:12", "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "ownerName" : "The Siam Residences", "requestType" : "DIRECT_CONNECTION", "status" : "REQUESTING", "subType" : "APPLICATION", "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "supplierName" : "The Siam Residences, Bangkok", "version" : 3 }, "properties" : { "createdDate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was first created", "example" : "2026-01-14T09:30:00", "readOnly" : true }, "id" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier for this record.", "example" : "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47" }, "introductoryMessage" : { "type" : "string", "description" : "Message from requester explaining the purpose and benefits of the proposed relationship", "example" : "We represent a travel agency network with strong demand for your properties and would like to establish a partnership to offer exclusive rates to our members.", "minLength" : 1 }, "lastUpdate" : { "type" : [ "string", "null" ], "format" : "date-time", "description" : "Datetime this record was last updated", "example" : "2026-02-03T16:45:12", "readOnly" : true }, "ownerIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier of the owner/affiliate initiating the request", "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "minLength" : 1 }, "ownerName" : { "type" : "string", "description" : "Name of the owner/affiliate initiating the request", "example" : "The Siam Residences", "minLength" : 1 }, "requestType" : { "type" : "string", "description" : "Type of relationship request", "enum" : [ "DIRECT_CONNECTION" ], "example" : "DIRECT_CONNECTION" }, "status" : { "type" : "string", "description" : "Status of the relationship request", "enum" : [ "REQUESTING", "REJECTED" ], "example" : "REQUESTING" }, "subType" : { "type" : "string", "description" : "Type of entity initiating the relationship request", "enum" : [ "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" ], "example" : "APPLICATION" }, "supplierIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Supplier identifier receiving this relationship request", "example" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "minLength" : 1 }, "supplierName" : { "type" : "string", "description" : "Name of the property/supplier receiving the request", "example" : "The Siam Residences, Bangkok", "minLength" : 1 }, "version" : { "type" : [ "integer", "null" ], "format" : "int64", "description" : "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.", "example" : 3 } }, "required" : [ "introductoryMessage", "ownerIdentifier", "ownerName", "requestType", "status", "subType", "supplierIdentifier", "supplierName" ] }, "InventoryMapMarker_ManagingEntity" : { "type" : "object", "description" : "Represents a single inventory item displayed as a marker on a map", "example" : { "channelInventoryIdentifier" : "7a0c5d9e-2f6b-4c1a-8e4d-3b9f1a0c6d52", "inventoryIdentifier" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "inventoryName" : "Deluxe Ocean View Suite", "inventoryType" : "GUEST_ROOM", "lowestDisplayPrice" : { "amount" : 4500.0, "currency" : "THB" }, "point" : { "coordinates" : [ 100.5581533, 13.7370197 ], "type" : "Point" }, "supplierIdentifier" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "supplierName" : "The Siam Residences" }, "properties" : { "channelInventoryIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier of the channel inventory or list item represented by this marker", "example" : "7a0c5d9e-2f6b-4c1a-8e4d-3b9f1a0c6d52" }, "inventoryIdentifier" : { "type" : "string", "format" : "uuid", "description" : "UUID of the specific inventory item (e.g., room type or add-on)", "example" : "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29" }, "inventoryName" : { "type" : "string", "description" : "Human-friendly name of the inventory item", "example" : "Deluxe Ocean View Suite" }, "inventoryType" : { "type" : "string", "description" : "Classification of the inventory (e.g., GUEST_ROOM, ADD_ON, RESTAURANT, ACTIVITY)", "enum" : [ "GUEST_ROOM", "ADD_ON", "MEETING_ROOM", "RESTAURANT", "SPA", "ATTRACTION", "PLACE", "ACTIVITY" ], "example" : "GUEST_ROOM" }, "lowestDisplayPrice" : { "$ref" : "#/components/schemas/CustomMonetaryAmount", "description" : "Lowest available price for this inventory in the user's requested currency", "example" : 450.0 }, "point" : { "$ref" : "#/components/schemas/GeoJsonPoint_ManagingEntity", "description" : "Geographic location coordinates as a GeoJSON Point (longitude, latitude)" }, "supplierIdentifier" : { "type" : "string", "format" : "uuid", "description" : "UUID of the supplier (hotel or property) owning this inventory", "example" : "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18" }, "supplierName" : { "type" : "string", "description" : "Display name of the supplier property", "example" : "The Siam Residences" } } }, "CampaignInventory_ManagingEntity" : { "type" : "object", "description" : "Sellable inventory item used in a campaign, representing a bookable offering shown to travelers", "example" : { "id" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "layout" : "HOTEL", "name" : "The Siam Residences – Deluxe Pool Villa", "placeholderImageUrl" : "https://res.cloudinary.com/traveliko/image/upload/v1619343662/wp/grey-card.svg" }, "properties" : { "id" : { "type" : "string" }, "layout" : { "type" : "string", "description" : "Visual layout template type for presenting sellable inventory", "enum" : [ "AD_BANNER", "MAP", "HOTEL", "GUEST_ROOM", "MEETING_ROOM", "SPA", "RESTAURANT", "ACTIVITY", "ATTRACTION", "PLACE", "ADD_ON", "LIST", "SEARCH", "RANKED" ] }, "name" : { "type" : "string" }, "placeholderImageUrl" : { "type" : "string" } } }, "SearchCategory_ManagingEntity" : { "type" : "object", "description" : "A single OTA search facet / category entry that groups inventory or hotels under a typed key-value code, along with the number of matching results.", "example" : { "count" : 15, "identifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "key" : "GRE", "type" : "HOTEL", "value" : "GRE-001" }, "properties" : { "count" : { "type" : "integer", "format" : "int64", "description" : "Quantity of items in this category.", "example" : 15 }, "identifier" : { "type" : "string", "format" : "uuid", "description" : "Unique search category identifier.", "example" : "7a0c5d9e-2f6b-4c1a-8e4d-3b9f1a0c6d52" }, "key" : { "type" : "string", "description" : "Usually the OTA inventory code.", "example" : "GRE", "minLength" : 1 }, "type" : { "type" : "string", "description" : "Type of search category.", "enum" : [ "HOTEL", "INVENTORY" ], "example" : "HOTEL" }, "value" : { "type" : "string", "description" : "Usually the OTA inventory code value.", "example" : "GRE-001", "minLength" : 1 } }, "required" : [ "key", "type", "value" ] }, "ChartCategoryAxis_Authenticated_Entity" : { "type" : "object", "description" : "Configuration options for the category (X) axis of the chart, including the list of category names.", "properties" : { "data" : { "type" : "array", "description" : "The category names. The Chart creates a category for every item of the array.", "items" : { "type" : "string" } } }, "required" : [ "data" ] }, "ChartLegend_Authenticated_Entity" : { "type" : "object", "description" : "The chart legend, containing the list of series names displayed in the legend.", "properties" : { "data" : { "type" : "array", "description" : "The legend labels, one entry per series.", "items" : { "type" : "string" } } }, "required" : [ "data" ] }, "ChartSeries_Authenticated_Entity" : { "type" : "object", "description" : "A named data series for a chart, pairing a display name with its array of numeric data points.", "example" : { "name" : "Revenue" }, "properties" : { "data" : { "type" : "array", "description" : "The array of data items which represent the series data.\n\nYou can set it to:\n\n- Array of numbers. Supported when the series.type option is set to `area`, `bar`, `column`, `donut`, `pie`, `line`, or `waterfall`.\nThe Bubble series need arrays of three values—X value, Y value, and Size value—for example, [1, 1, 10]. The Scatter and ScatterLine series need arrays of two values—X value and Y value. The OHLC and Candlestick series need arrays of four values—open, high, low, and close. The RangeBar and RangeArea series need arrays of two values—the from and to value.", "items" : { "type" : "number" } }, "name" : { "type" : "string", "description" : "The name of the Chart series which is visible in the legend.", "example" : "Revenue" } }, "required" : [ "data", "name" ] }, "ChartTitle_Authenticated_Entity" : { "type" : "object", "description" : "The title displayed at the top of the chart.", "example" : { "text" : "Monthly Booking Revenue" }, "properties" : { "text" : { "type" : "string", "description" : "The text content of the chart title.", "example" : "Monthly Booking Revenue" } }, "required" : [ "text" ] }, "LineChart_Authenticated_Entity" : { "type" : "object", "description" : "A line chart data structure containing an identifier, title, legend, one or more series of data points, and category axis configuration.", "example" : { "identifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "legend" : { "data" : [ "Revenue", "Refunds" ] }, "series" : [ { "data" : [ 120000, 95000, 148000, 210000, 175000, 230000 ], "name" : "Revenue" }, { "data" : [ 5000, 3200, 7800, 4100, 6500, 2900 ], "name" : "Refunds" } ], "title" : { "text" : "Monthly Booking Revenue" }, "xAxis" : { "data" : [ "Jan", "Feb", "Mar", "Apr", "May", "Jun" ] } }, "properties" : { "identifier" : { "type" : "string", "format" : "uuid", "description" : "Unique line chart identifier", "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51" }, "legend" : { "$ref" : "#/components/schemas/ChartLegend_Authenticated_Entity", "description" : "The configuration options for the chart legend." }, "series" : { "type" : "array", "description" : "The configuration of the chart series. The series type is determined by the value of the type field. If a type value is missing, the chart renders the type that is specified in `seriesDefaults`. Some options accept functions as arguments. These arguments are evaluated for each point which is supplied as a parameter. If no value is returned, the chart uses the `theme` or `seriesDefaults` values.", "items" : { "$ref" : "#/components/schemas/ChartSeries_Authenticated_Entity" } }, "title" : { "$ref" : "#/components/schemas/ChartTitle_Authenticated_Entity", "description" : "The configuration options for the chart title" }, "xAxis" : { "$ref" : "#/components/schemas/ChartCategoryAxis_Authenticated_Entity", "description" : "The configuration options of the category axis.", "title" : "Category axis" }, "xaxis" : { "$ref" : "#/components/schemas/ChartCategoryAxis_Authenticated_Entity" } }, "required" : [ "identifier", "legend", "series", "title", "xAxis" ] }, "AggregateSharesProjection_Authenticated_Entity" : { "type" : "object", "description" : "Lifetime aggregate share metrics for a managing entity, covering total views, click-throughs, and share events.", "example" : { "clicks" : 387, "ownerIdentifier" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "shares" : 52, "views" : 1420 }, "properties" : { "clicks" : { "type" : "integer", "format" : "int64", "description" : "Total number of click-through events.", "example" : 387 }, "ownerIdentifier" : { "type" : "string", "description" : "Affiliate identifier owning this analytics summary.", "example" : "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69" }, "shares" : { "type" : "integer", "format" : "int64", "description" : "Total number of share events (e.g. social share, copy-link).", "example" : 52 }, "views" : { "type" : "integer", "format" : "int64", "description" : "Total number of page/link views.", "example" : 1420 } }, "required" : [ "ownerIdentifier" ] }, "GroupedBookingSalesMetrics_SupplierDetails" : { "type" : "object", "description" : "Booking sales metrics grouped by a specific dimension (such as property or country), extending the base sales metrics with the group type, name, and identifier.", "example" : { "averageBookingAmount" : 4511.9, "bookings" : 42, "currencyCode" : "THB", "totalPriceAmount" : 189500.0, "type" : "BY_PROPERTY", "typeIdentifier" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "typeName" : "The Siam Residences, Bangkok" }, "properties" : { "averageBookingAmount" : { "type" : "number", "format" : "double", "description" : "Average booking value in the display currency.", "example" : 450.0 }, "bookings" : { "type" : "integer", "format" : "int64", "description" : "Total number of bookings in this metric set.", "example" : 42 }, "currencyCode" : { "type" : "string", "description" : "Currency code for the monetary amounts.", "example" : "USD", "pattern" : "^[A-Z]{3}$" }, "totalPriceAmount" : { "type" : "number", "format" : "double", "description" : "Total revenue from all bookings in the display currency.", "example" : 450.0 }, "type" : { "type" : "string", "description" : "The dimension by which sales metrics are grouped.", "enum" : [ "BY_TOTAL", "BY_COUNTRY", "BY_PROPERTY" ], "example" : "PROPERTY" }, "typeIdentifier" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier of the grouping entity.", "example" : "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51" }, "typeName" : { "type" : "string", "description" : "Display name of the grouping entity.", "example" : "The Siam Residences, Bangkok" } } } }, "securitySchemes" : { "oauth2ClientCredentials" : { "type" : "oauth2", "description" : "Every endpoint is protected with OAuth2 **client credentials**. Create an\n**Application** in your account to obtain a `clientId` and `clientSecret`, then\nexchange them for a short-lived bearer token.\n\n### 1. Request an access token\n`POST` to the **Token URL** below with `Content-Type: application/x-www-form-urlencoded`\nand a body of `grant_type=client_credentials` (optionally `scope=`).\nSend your credentials as HTTP Basic auth:\n`Authorization: Basic base64(clientId + \":\" + clientSecret)`.\n\n### 2. Call the API\nPass the returned token on every request: `Authorization: Bearer `.\n\nTokens carry only the scopes granted to your Application — request the least privilege\nyou need. There is no interactive authorize step and no refresh token for this flow;\nrequest a new token when the current one expires.", "name" : "Client Credentials", "flows" : { "clientCredentials" : { "tokenUrl" : "https://iam.wink.travel/oauth2/token", "scopes" : { "marketing.read" : "View your marketing & promotions.", "marketing.write" : "Create and update your marketing & promotions.", "marketing.remove" : "Delete your marketing & promotions.", "content.read" : "View your property content.", "content.write" : "Create and update your property content.", "content.remove" : "Delete your property content.", "analytics.read" : "View your analytics & reports.", "analytics.write" : "Create and update your analytics & reports.", "analytics.remove" : "Delete your analytics & reports." } } } } } } }