Revision historyCopy link

The following updates have been made to the Lodging Supply GraphQL API schema, from newest to oldest updates:

May 2025

• The units query will be replaced by the unitsPaginated query, to provide filters and paginated results when retrieving a property's units. Stated differently, the units object under the property query will be replaced with the unitsPaginated object. The units query will be fully deprecated and unsupported in Q4 2025.

  Note that the units query retrieves active and inactive units. The unitsPaginated query returns only active units, by default. To retrieve active and inactive units using the unitsPaginated query, you must include the status filter (set to state: ALL).

  Old query:

  1query {
  2  property(id: $id, idSource: $idSource) {
  3    units {
  4      ids {
  5        id
  6        idSource
  7      }
  8      activeStatus {
  9        active
  10      }
  11      ...
  12    }
  13  }
  14}

  New query:

  1query {
  2  property(id: $id, idSource: $idSource) {
  3    unitsPaginated(
  4      cursor: $cursor, 
  5      filters: {
  6        status: $status
  7      },
  8      limit: $limit
  9    ) {
  10      elements {
  11        ids {
  12          id
  13          idSource
  14        }
  15        ...
  16      }
  17    }
  18  }
  19}

• The following limits are now in place for address fields:

  • Address line 1 - 2-80 characters are supported
  • Address line 2 - 1-80 characters are supported
  • City - 2-80 characters are supported
  • State or province - 2-40 characters are supported
  • Postal code - 6-20 characters are supported

February 2025

Special check-in instructions (specified by the Property API's SPECIAL_CHECKIN_INSTRUCTIONS field) are no longer considered as part of the HasCheckInInstructions checkpoint.

November 2022

Released the initial version of the property status capability of the Lodging Partner GraphQL API.