Property, Room Type, and Room API

API endpoint

In the request header, set Host to one of the following, depending on the region of your organization:

Authentication

Each API request must have an authorization header whose value is the access token retrieved from Login with Amazon (LWA).

Operations

The Property, Room Type, and Room API includes the following operations.

Manage properties

Create a property

Call POST /enterprise/hospitality/v1/properties to create a property.

This operation is available in the following countries.

Request format

POST /enterprise/hospitality/v1/properties HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

Request body

{
  "name": "{propertyName}",
  "organizationId": "amzn1.alexa.unit.did.{id}"
}

Request body parameters

Response header

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
Location: "/enterprise/hospitality/v1/properties/{propertyId}"

Response body

{
  "id": "amzn1.alexa.unit.did.{id}"
}

Response body parameters

Error response

HTTP/1.1 {ErrorCode}
{
    "message": "{ErrorMessage}"
}

Error response parameters

HTTP response codes

List properties

Call GET /enterprise/hospitality/v1/properties?organizationId={organizationId} to retrieve a list of properties under the organization that the user making the call has access to view.

This operation is available in the following countries.

Request format

GET /enterprise/hospitality/v1/properties?organizationId={organizationId}&maxResults={maxResults}&nextToken={nextToken} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

Request parameters

Request body

None.

Response header

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

Response body

{
   "properties": [
      {
         "id": "string",
         "organizationId": "string",
         "name": "string"
      }
   ],
   "paginationContext": {
      "nextToken": "string"
   }
}

Response body parameters

Error response

HTTP/1.1 {ErrorCode}
{
    "message": "{ErrorMessage}"
}

Error response parameters

HTTP response codes

Get a property

Call GET /enterprise/hospitality/v1/properties/{propertyId} to retrieve the metadata of a specific property provided the user making the call has access to view it.

This operation is available in the following countries.

Request format

GET /enterprise/hospitality/v1/properties/{propertyId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

Request path parameters

Request body

None.

Response header

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

Response body

{
   "id": "string",
   "organizationId": "string",
   "name": "string"
}

Response body parameters

Error response

HTTP/1.1 {ErrorCode}
{
    "message": "{ErrorMessage}"
}

Error response parameters

HTTP response codes

Update a property

Call PUT /enterprise/hospitality/v1/properties/{propertyId} to update the metadata of a specific property provided the user making the call has access to update it.

This operation is available in the following countries.

Request format

PUT /enterprise/hospitality/v1/properties/{propertyId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

Request path parameters

Request body

{
   "name": "string"
}

Request body parameters

Response header

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

Response body

None.

Error response

HTTP/1.1 {ErrorCode}
{
    "message": "{ErrorMessage}"
}

Error response parameters

HTTP response codes

Delete a property

Call DELETE /enterprise/hospitality/v1/properties/{propertyId} to delete a specific property provided the property doesn't have any units (room types or rooms) under it and the user making the call has access to delete it. If the property isn't empty, the delete operation returns HTTP status code 400.

This operation is available in the following countries.

Request format

DELETE /enterprise/hospitality/v1/properties/{propertyId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

Request path parameters

Request body

None.

Response header

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

Response body

None.

Error response

HTTP/1.1 {ErrorCode}
{
    "message": "{ErrorMessage}"
}

Error response parameters

HTTP response codes

Manage room types for a property

A room type is a unit used to group together rooms having some similarity, for example rooms of similar type like ocean-facing rooms, deluxe suites, or rooms on same floor.

Create a room type

Call POST /enterprise/hospitality/v1/roomTypes to create a room type under your property.

This operation is available in the following countries.

Request format

POST /enterprise/hospitality/v1/roomTypes HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

Request body

{
  "name": "{roomTypeName}",
  "propertyId": "amzn1.alexa.unit.did.{id}"
}

Request body parameters

Response header

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
Location: "/enterprise/hospitality/v1/roomTypes/{roomTypeId}"

Response body

{
  "id": "amzn1.alexa.unit.did.{id}"
}

Response body parameters

Error response

HTTP/1.1 {ErrorCode}
{
    "message": "{ErrorMessage}"
}

Error response parameters

HTTP response codes

List room types

Call GET /enterprise/hospitality/v1/roomTypes?propertyId={propertyId} to retrieve a list of room types under the property that the user making the call has access to view.

This operation is available in the following countries.

Request format

GET /enterprise/hospitality/v1/roomTypes?propertyId={propertyId}&maxResults={maxResults}&nextToken={nextToken} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

Request query parameters

Request body

None.

Response header

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

Response body

{
   "roomTypes": [
      {
         "id": "string",
         "name": "string",
         "propertyId": "string"
      }
   ],
   "paginationContext": {
      "nextToken": "string"
   }
}

Response body parameters

Error response

HTTP/1.1 {ErrorCode}
{
    "message": "{ErrorMessage}"
}

Error response parameters

HTTP response codes

Get a room type

Call GET /enterprise/hospitality/v1/roomTypes/{roomTypeId} to retrieve the metadata of a specific room type provided the user making the call has access to view it.

This operation is available in the following countries.

Request format

GET /enterprise/hospitality/v1/roomTypes/{roomTypeId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

Request path parameters

Request body

None.

Response header

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

Response body

{
   "id": "string",
   "name": "string",
   "propertyId": "string"
}

Response body parameters

Error response

HTTP/1.1 {ErrorCode}
{
    "message": "{ErrorMessage}"
}

Error response parameters

HTTP response codes

Update a room type

Call PUT /enterprise/hospitality/v1/roomTypes/{roomTypeId} to update the metadata of a specific room type provided the user making the call has access to update it.

This operation is available in the following countries.

Request format

PUT /enterprise/hospitality/v1/roomTypes/{roomTypeId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

Request path parameters

Request body

{
   "name": "string"
}

Request body parameters

Response header

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

Response body

None.

Error response

HTTP/1.1 {ErrorCode}
{
    "message": "{ErrorMessage}"
}

Error response parameters

HTTP response codes

Delete a room type

Call DELETE /enterprise/hospitality/v1/roomTypes/{roomTypeId} to delete a specific room type provided the room type doesn't have any rooms under it and the user making the call has access to delete it. If the room type isn't empty, the delete operation returns HTTP status code 400.

This operation is available in the following countries.

Request format

DELETE /enterprise/hospitality/v1/roomTypes/{roomTypeId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

Request path parameters

Request body

None.

Response header

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

Response body

None.

Error response

HTTP/1.1 {ErrorCode}
{
    "message": "{ErrorMessage}"
}

Error response parameters

HTTP response codes

Manage rooms under a room type

Create a room

Call POST /enterprise/hospitality/v1/rooms to create a new room under a room type.

A room name can contain letters or numbers and the following special characters, with no spaces or periods: _ - = # ; : ? @ &. The room name can't exceed 256 characters. Room names must be unique to a property, and they should be meaningful to your organization's users.

This operation is available in the following countries.

Request format

POST /enterprise/hospitality/v1/rooms HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

Request body

{
  "name": "{roomName}",
  "roomTypeId": "amzn1.alexa.unit.did.{id}"
}

Request body parameters

Response header

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json
Location: "/enterprise/hospitality/v1/rooms/{roomId}"

Response body

{
  "id": "amzn1.alexa.unit.did.{id}"
}

Response body parameters

Error response

HTTP/1.1 {ErrorCode}
{
    "message": "{ErrorMessage}"
}

Error response parameters

HTTP response codes

List rooms

Call GET /enterprise/hospitality/v1/rooms?roomTypeId={roomTypeId} to retrieve a list of rooms under a room type that the user making the call has access to view.

This operation is available in the following countries.

Request format

GET /enterprise/hospitality/v1/rooms?roomTypeId={roomTypeId}&maxResults={maxResults}&nextToken={nextToken} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

Request parameters

Request body

None.

Response header

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

Response body

{
   "rooms": [
      {
         "id": "string",
         "name": "string",
         "roomTypeId": "string"
      }
   ],
   "paginationContext": {
      "nextToken": "string"
   }
}

Response body parameters

Error response

HTTP/1.1 {ErrorCode}
{
    "message": "{ErrorMessage}"
}

Error response parameters

HTTP response codes

Get a room

Call GET /enterprise/hospitality/v1/rooms/{roomId} to retrieve the metadata of a specific room provided the user making the call has access to view it.

This operation is available in the following countries.

Request format

GET /enterprise/hospitality/v1/rooms/{roomId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

Request path parameters

Request body

None.

Response header

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

Response body

{
   "id": "string",
   "name": "string",
   "roomTypeId": "string"
}

Response body parameters

Error response

HTTP/1.1 {ErrorCode}
{
    "message": "{ErrorMessage}"
}

Error response parameters

HTTP response codes

Update a room

Call PUT /enterprise/hospitality/v1/rooms/{roomId} to update the metadata of a specific room provided the user making the call has access to update it.

This operation is available in the following countries.

Request format

PUT /enterprise/hospitality/v1/rooms/{roomId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

Request path parameters

Request body

{
   "name": "string"
}

Request body parameters

Response header

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

Response body

None.

Error response

HTTP/1.1 {ErrorCode}
{
    "message": "{ErrorMessage}"
}

Error response parameters

HTTP response codes

Delete a room

Call DELETE /enterprise/hospitality/v1/rooms/{roomId} to delete a specific room provided the user making the call has access to delete it. You can't delete a room that has endpoints associated with it. If the room has associated endpoints, the delete operation returns HTTP status code 400.

This operation is available in the following countries.

Request format

DELETE /enterprise/hospitality/v1/rooms/{roomId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

Request path parameters

Request body

None.

Response header

Host: api.amazonalexa.com
X-Amzn-RequestId: {request-id}
Content-Type: application/json

Response body

None.

Error response

HTTP/1.1 {ErrorCode}
{
    "message": "{ErrorMessage}"
}

Error response parameters

HTTP response codes

Related topics

• Get Started with Alexa Smart Properties APIs
• REST API Reference
• About Alexa Smart Properties

Last updated: Nov 28, 2023