Skip to content

Latest commit

 

History

History
189 lines (149 loc) · 6.78 KB

inventory.md

File metadata and controls

189 lines (149 loc) · 6.78 KB
Raw

Mews API Operations: Inventory

Set inventory

This method can be used to update the 'rate plan - space type' mapping relations in the connection.

  • All mapping relations need to be sent.
  • Mapping relations that are defined in Mews for the connection, but missing in the call, are deleted.
  • It is possible to create a new rate-space category combination for the rates and space categories that are already in Mews.
  • It is impossible to add a new rate or space category.

Request

[PlatformAddress]/api/channelManager/v1/setInventory

{
    "clientToken": "[Channel manager client token]",
    "connectionToken": "[Token of a concrete connection]",
    "inventoryMappings": [
        {
            "ratePlanCode": "FF",
            "spaceTypeCode": "KD"
        },
        {
            "ratePlanCode": "FF",
            "spaceTypeCode": "QD"
        }
    ]
}
Property Type Contract Description
clientToken string required Client token of the channel manager.
connectionToken string required Token of a concrete connection.
inventoryMappings Inventory Mappings collection required Defines all rate plan - space type mapping relations.

Response

Synchronous simple response is expected.

Request ARI update

[async] This method allows the channel manager to request an ARI data update for certain space types and rate plans in addition to the changes automatically sent in the Delta update. The requested data will be sent by Mews asynchronously via push operations to the channel manager side API in the next Delta update.

Request

[PlatformAddress]/api/channelManager/v1/requestAriUpdate

{
    "clientToken": "[Channel manager client token]",
    "connectionToken": "[Token of a concrete connection]",
    "from": "2018-01-01",
    "to": "2018-02-01",
    "ariType": [
        1,
        2,
        3
    ],
    "spaceTypeCodes": [
        "KD",
        "QD"
    ],
    "ratePlanCodes": [
        "FF"
    ]
}
Property Type Contract Description
clientToken string required Client token of the channel manager.
connectionToken string required Token of a concrete connection.
from string required Start of requested update in format "yyyy-MM-dd".
to string required End of requested update in format "yyyy-MM-dd" (included).
ariType int collection optional ARI Types to be updated. Blank means all, empty [] means none. Currently not supported, always requests updates for all.
spaceTypeCodes string collection optional Space types to be updated. Blank means all, empty [] means none. Currently not supported, always requests updates for all.
ratePlanCodes string collection optional Rate plans to be updated. Blank means all, empty [] means none. Currently not supported, always requests updates for all..

ARI Types

Code Description
1 Availability
2 Prices
3 Restrictions

Response

Simple response will determine whether the ARI update was accepted for processing or not.

Confirm availability update

Request

[PlatformAddress]/api/channelManager/v1/processAvailabilityConfirmation

{
    "clientToken": "[Channel manager client token]",
    "connectionToken": "[Token of a concrete connection]",
    "relatedMessageId": "[Id of message which request relates to]",
    "success": false,
    "errors":[{
      "code":10,
      "message":"Invalid category code",
      "categoryCode":"XYZ"
   }]
}
Property Type Contract Description
clientToken string required Client token of the channel manager.
connectionToken string required Token of a concrete connection.
relatedMessageId string required Id of message which requests relates to.
success bool required Determinines the result of the operation.
errors array of Error optional In case of "success": false, this property holds information about the errors that occurred.

Response

Synchronous simple response is expected.

Confirm price update

Request

[PlatformAddress]/api/channelManager/v1/processRateConfirmation

{
    "clientToken": "[Channel manager client token]",
    "connectionToken": "[Token of a concrete connection]",
    "relatedMessageId": "[Id of message which request relates to]",
    "success": false,
    "errors":[{
      "code": 9,
      "message": "Invalid rate code",
      "categoryCode": "ABC"
   }]
}
Property Type Contract Description
clientToken string required Client token of the channel manager.
connectionToken string required Token of a concrete connection.
relatedMessageId string required Id of message which requests relates to.
success bool required Determinines the result of the operation.
errors array of Error optional In case of "success": false, this property holds information about the errors that occurred.

Response

Synchronous simple response is expected.

Confirm restriction update

Request

[PlatformAddress]/api/channelManager/v1/processRestrictionConfirmation

{
    "clientToken": "[Channel manager client token]",
    "connectionToken": "[Token of a concrete connection]",
    "relatedMessageId": "[Id of message which request relates to]",
    "success": false,
    "errors":[{
      "code": 9,
      "message": "Invalid rate code",
      "rateCode": "ABC"
   }]
}
Property Type Contract Description
clientToken string required Client token of the channel manager.
connectionToken string required Token of a concrete connection.
relatedMessageId string required Id of message which requests relates to.
success bool required Determinines the result of the operation.
errors array of Error optional In case of "success": false, this property holds information about the errors that occurred.

Response

Synchronous simple response is expected.