Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

API Details

Method

Dev / Test Endpoint

Certification Testing Notes

Publisher APIs

Get Publisher List 

GET

(Mandatory)

https://

smx-pilot

tpi-subscriberx.

dev

preprod.siteminderlabs.com/inventory/v1/publishers

Get a list of publishers (PMSs) connected to subscribing application

Get List of Hotels for Selected Publisher

GET

(Mandatory)

https://

smx

tpi-

pilot-

subscriberx.

dev

preprod.siteminderlabs.com/inventory/v1/publishers/{publisherCode}/hotels

Get a list of hotels connected to the selected publisher (PMS) and subscribing application

Room Type APIs

Get List of Room Types for selected Publisher and Hotel (Mandatory)

https://tpi-subscriberx.preprod.siteminderlabs.com/inventory/v1/publishers/{publisherCode}​/hotel​s/{hotelCode}​/roomTypes

Lists all the Room Types for a specific hotel and publisher PMS

Get Room Type details by Room Type Code

https://tpi-subscriberx.preprod.siteminderlabs.com/inventory/v1/publishers/{publisherCode}​/hotel​s/{hotelCode}​/roomTypes/{roomTypeCode}​

Repeat this for each Room Type Code. Please note that a number of fields for rate plans is optional and may not be provided by all PMSs. 

Rate Plan APIs

Get List of Rate Plans for one Hotel

GET

(Mandatory)

https://

smx

tpi-

pilot-

subscriberx.

dev

preprod.siteminderlabs.com/inventory/v1/

publisher​s

publishers/{publisherCode}​/hotel​s/{hotelCode}​/ratePlans

Lists all the Rate Plans for a specific hotel and publisher PMS

Get Rate Plan Details by Rate Plan Code

GET

https://

smx-pilot

tpi-subscriberx.

dev

preprod.siteminderlabs.com/inventory/v1/

publisher​s

publishers/{publisherCode}​/hotel​s/{hotelCode}​/ratePlans​/{ratePlanCode}

Repeat this for each Rate Plan Code. Please note that a number of fields for rate plans is optional and may not be provided by all PMSs. 

Get Rate Pricing for a single date by Rate Plan Code

GET

https://

smx-pilot

tpi-subscriberx.

dev

preprod.siteminderlabs.com/inventory/v1/publishers/{publisherCode}/hotels/{hotelCode}/ratePlans/{ratePlanCode}/rates?startDate=2020-01-01

Repeat for each rate plan code for current date

Repeat for each rate plan code for a date in the future

Get Rate Pricing for a date range (maximum of 30 days) by Rate Plan Code

GET

https://

smx

tpi-

pilot-

subscriberx.

dev

preprod.siteminderlabs.com/inventory/v1/publishers/{publisherCode}/hotels/{hotelCode}/ratePlans/{ratePlanCode}/rates?startDate=2020-01-01&range=30

Repeat for each rate plan code for current date and range of 30 

Repeat or each rate plan code for current date and range of 30 to cover 1 full year

API Details

Method

Dev / Test Endpoint

Certification Testing Notes

Availability

,

and Restrictions

and Inventory

APIs

Get Availability

, Restrictions

and

Inventory for a single date for a hotel

GET

https://smx-pilot-subscriberx.dev.siteminderlabs.com/inventory/v1/publishers/{publisherCode}/hotels/{hotelCode}/availability?startDate=2020-01-01

Repeat this test for multiple dates one date at a time

Get Availability,

Restrictions

and Inventory for a date range (maximum of 30 days)

for a

hotel

GET

https://smx-pilot-subscriberx.dev.siteminderlabs.com/inventory/v1/publishers/{publisherCode}/hotels/{hotelCode}/availability?startDate=2020-01-01&range=30

Repeat this test from current date for 1 full year

Get Availability, Restrictions and Inventory for a

single date for a Room Type

GET

https://

smx-pilot

tpi-subscriberx.

dev

preprod.siteminderlabs.com/inventory/v1/publishers/{publisherCode}/hotels/{hotelCode}/roomTypes/{roomTypeCode}/availability?startDate=2020-01-01

Repeat this test for multiple dates one date at a time

Repeat test for each room type code for one date at a time

Get Availability

,

and Restrictions

and Inventory

for a date range (maximum of 30 days) for a Room Type

GET

https://

smx-pilot

tpi-subscriberx.

dev

preprod.siteminderlabs.com/inventory/v1/publishers/{publisherCode}/hotels/{hotelCode}/roomTypes/{roomTypeCode}/availability?startDate=2020-01-01&range=30

Repeat this test from current date for 1 full year

Repeat test for each room type code for 1 full year

Get Availability

,

and Restrictions

and Inventory

for a single date for a Rate Plan Code

GET

https://

smx-pilot

tpi-subscriberx.

dev

preprod.siteminderlabs.com/inventory/v1/publishers/{publisherCode}/hotels/{hotelCode}/ratePlans/{ratePlanCode}/availability?startDate=2020-01-01

Repeat this test for multiple dates one date at a time

Repeat test for each rate plan code for one date at a time

Get Availability

,

and Restrictions

and Inventory

for a date range (maximum of 30 days) for a Rate Plan Code

GET

https://

smx-pilot

tpi-subscriberx.

dev

preprod.siteminderlabs.com/inventory/v1/publishers/{publisherCode}/hotels/{hotelCode}/ratePlans/{ratePlanCode}/availability?startDate=2020-01-01&range=30

Repeat this test from current date for 1 full year

Repeat test for each rate plan code for 1 full year

Additional Information on ARI APIs:

  • Rate limiting has not been applied to the APIs, these will be included post certification.

  • Limit to a maximum of 30 queries a minute for one property during testing.