Update Item
const url = 'https://api.wink.travel/api/managing-entity//studio/items/card-inventory-1';const options = { method: 'PUT', headers: {'Wink-Version': '2.0', 'Content-Type': 'application/json'}, body: '{"name":"","customizationIdentifier":"","descriptions":[""],"keywords":[""],"inventoryType":"HOTEL","channelInventoryType":"GUEST_ROOM","supplierIdentifier":"","channelInventoryIdentifier":"","multimedias":[""],"animate":false,"animateDelay":"","sort":"MEMBER","displayType":"NATIVE"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://api.wink.travel/api/managing-entity//studio/items/card-inventory-1 \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data '{ "name": "", "customizationIdentifier": "", "descriptions": [ "" ], "keywords": [ "" ], "inventoryType": "HOTEL", "channelInventoryType": "GUEST_ROOM", "supplierIdentifier": "", "channelInventoryIdentifier": "", "multimedias": [ "" ], "animate": false, "animateDelay": "", "sort": "MEMBER", "displayType": "NATIVE" }'Update an existing card
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”AffiliateAccount identifier to update item for
Update inventory with this identifier.
Example
card-inventory-1Header Parameters
Section titled “Header Parameters ”Request Body required
Section titled “Request Body required ”object
Descriptive name of this item for seller use
Example
My fave travel inventoryWhich configuration to use with this item
Example
customization-configuration-1Title and description of inventory.
object
Use as title or short text description
Example
An example titleLonger text description
Example
This is a longer description in the specified language.Indicate which language this description is written in.
Example
enWhether it was user or system generated.
Example
SYSTEMThe md5 hash of the name, description and language.
The type of inventory being offer up for sale
Example
HOTELChannel 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.
Example
GUEST_ROOMSupplier / Hotel identifier that owns this inventory.
Example
hotel-1The channel inventory record identifier describing the relationship between supplier and seller.
Example
channel-inventory-1Reference identifiers to Cloudinary media assets
object
Document identifier
Example
image-1Use this identifier to communicate with Cloudinary.
Example
cloudinary-image-1Whether Cloudinary media is a VIDEO or IMAGE.
Example
IMAGECurrently ONLY using Cloudinary to store all image / video assets.
Example
CLOUDINARYSort allows you to control how you want to sort this record in a list of media records.
Example
10Media angle
Example
-90Media width in pixels.
Example
2560Media height in pixels.
Example
1600Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Example
trueLocalized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Example
An example titleLonger text description
Example
This is a longer description in the specified language.Indicate which language this description is written in.
Example
enWhether it was user or system generated.
Example
SYSTEMThe md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Example
LIFESTYLE_HEALTH_FITNESSWhether image has attribution properties
object
URL to contributor
Example
https://maps.google.com/maps/contrib/111628493169070103594Name of contributor
Example
Samuel AdamsTrue if media width is greater or equal to height
Example
trueCreate 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
falseControls animation delay in milliseconds.
Example
500The specific badge to display over the image on the Web Component.
Example
POPULARITYIndicate which initial values to display first on the front-facing card
Example
NATIVEResponses
Section titled “ Responses ”OK
object
Document UUID
Datetime this record was first created
Datetime this record was last updated
Version property that shows how many times this document has been persisted. Document will not persist if the version property is less than current version property in the system. Result in an optimistic locking exception.
AffiliateAccount / Owner identifier
Descriptive name of this item for seller use
Which configuration to use with this item
Title and description of inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Availability status
Url sell status
The type of inventory being offer up for sale
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.
Supplier / Hotel identifier that owns this inventory.
The channel inventory record identifier describing the relationship between supplier and seller.
Reference identifiers to Cloudinary media assets
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
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.
Controls animation delay in milliseconds.
The specific badge to display over the image on the Web Component.
Indicate which initial values to display first on the front-facing card
Example
{ "id": "", "createdDate": "", "lastUpdate": "", "version": "", "ownerIdentifier": "", "name": "", "customizationIdentifier": "", "descriptions": "", "keywords": [ "" ], "status": "ACTIVE", "inventoryStatus": "ACTIVE", "inventoryType": "HOTEL", "channelInventoryType": "GUEST_ROOM", "supplierIdentifier": "", "channelInventoryIdentifier": "", "multimedias": [ "" ], "animate": false, "animateDelay": "", "sort": "MEMBER", "displayType": "NATIVE"}Bad Request
object
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }}object
object
object
object
object
object
object
object
Unauthorized
object
object
Forbidden
object
object
Internal Server Error
object
Example generated
{}