Get Environment Info

Feature: Gift Cards

Editions: Cloud, Corporate*

You can query the environment endpoint to retrieve environmental information about your POS installation.

The endpoint contains several properties, some of which are only exposed if POS additional features are enabled.

Examples

List Enabled Features

Return the list of features that are enabled for your POS installation:

query MyQuery {
  environment {
    features
  }
}

Get Time Zone

Return the time zone of your POS installation.

query MyQuery {
  environment {
    timezone {
      id
    }
  }
}

Get POS Version

Return the POS version number of your POS installation. POS version numbers follow semantic versioning, which can be used to check API compatibility between different POS versions.

query MyQuery {
  environment {
    version {
      full
      major
      minor
    }
  }
}

Get Public Site Information

query MyQuery {
  environment {
    about {
      infoSiteTitle
      infoSiteUrl
      copyright
      email
      phone
      termsUrl
    }
  }
}

Return information about your service, as configured in the Configuration/POS Config/About Links page and displayed in POS public areas.

The about feature requires that the About feature is enabled.