Custom Region

Use the Custom Region API to create and customize regions.

API Information

Target Audience
Sabre Travel Network
Current Version
v1.0.0
Authentication
Sessionless Token
Methods/Endpoints
/v1.0.0/lists/supported/regions

In detail: Custom Region is a suite of APIs that can be used to create a custom region and associate to your desired country and/or airport codes. Your custom region can then be used as a filter in your Destination Finder API request (e.g. region=NewZealandPacific).

NOTE a given custom region (and all subsequent customizations) is mapped to and accessible by a single Pseudo City Code (PCC) in your token credentials when you get a token to call REST APIs, and cannot be shared or used by any other PCCs.

Ready to try the APIs?

Ready to get your hands dirty?

 Register Try the APIs

Ready to launch?

Ready to step up to the production level service? We're standing by to fit you for your spacesuit.

Request Production Key

Region Lookup

The Region Lookup endpoint returns a list of all Sabre regions.

API Information

Target Audience
Sabre Travel Network
Current Version
v1.0.0
Authentication
Sessionless Token
Methods/Endpoints
GET /v1.0.0/lists/supported/regions

Request

Requests do not have variations or parameters. The URI requests a list of all Sabre regions.

Response

Regions

Returns Sabre region information:

  • Links, array
  • Regions, array
Regions.Region

string

Name of the Sabre region

Sample value: Africa

Links

array

Contains links for each Sabre region:

  • self, object
  • linkTemplate, object
Links.self

object

Returns the URL of the request that generated the response

Links.linkTemplate

object

Formats an API request

Sample code

Request

GET https://api.havail.sabre.com/v1.0.0/lists/supported/regions

Response

{
    "Regions": [
        {
            "Region": "Africa",
            "Links": [
                {
                    "rel": "self",
                    "href": "https://api.havail.sabre.com/v1.0.0/lists/supported/regions/AFRICA"
                },
                {
                    "rel": "linkTemplate",
                    "href": "https://api.havail.sabre.com/<version>/lists/supported/regions/<name>"
                }
            ]
        },
        {
            "Region": "Asia Pacific",
            "Links": [
                {
                    "rel": "self",
                    "href": "https://api.havail.sabre.com/v1.0.0/lists/supported/regions/ASIA_PACIFIC"
                },
                {
                    "rel": "linkTemplate",
                    "href": "https://api.havail.sabre.com/<version>/lists/supported/regions/<name>"
                }
            ]
        },
        {
            "Region": "Europe",
            "Links": [
                {
                    "rel": "self",
                    "href": "https://api.havail.sabre.com/v1.0.0/lists/supported/regions/EUROPE"
                },
                {
                    "rel": "linkTemplate",
                    "href": "https://api.havail.sabre.com/<version>/lists/supported/regions/<name>"
                }
            ]
        },
        {
            "Region": "Latin America",
            "Links": [
                {
                    "rel": "self",
                    "href": "https://api.havail.sabre.com/v1.0.0/lists/supported/regions/LATIN_AMERICA"
                },
                {
                    "rel": "linkTemplate",
                    "href": "https://api.havail.sabre.com/<version>/lists/supported/regions<name>"
                }
            ]
        },
        {
            "Region": "Middle East",
            "Links": [
                {
                    "rel": "self",
                    "href": "https://api.havail.sabre.com/v1.0.0/lists/supported/regions/MIDDLE_EAST"
                },
                {
                    "rel": "linkTemplate",
                    "href": "https://api.havail.sabre.com/<version>/lists/supported/regions/<name>"
                }
            ]
        },
        {
            "Region": "North America",
            "Links": [
                {
                    "rel": "self",
                    "href": "https://api.havail.sabre.com/v1.0.0/lists/supported/regions/NORTH_AMERICA"
                },
                {
                    "rel": "linkTemplate",
                    "href": "https://api.havail.sabre.com/<version>/lists/supported/regions/<name>"
                }
            ]
        }
    ],
    "Links": [
        {
            "rel": "self",
            "href": "https://api.havail.sabre.com/v1.0.0/lists/supported/regions"
        },
        {
            "rel": "linkTemplate",
            "href": "https://api.havail.sabre.com/<version>/lists/supported/regions"
        }
    ]
}

Status Codes and Errors

An HTTP status code is always returned. For more information about HTTP status codes and error response formats, see Sabre APIs: errors.

HTTP 200

The request was successful.

Region Details Lookup

The Region Details Lookup endpoint returns the codes associated to a given Sabre region.

API Information

Target Audience
Sabre Travel Network
Current Version
v1.0.0
Authentication
Sessionless Token
Methods/Endpoints
GET /v1.0.0/lists/supported/regions/{name}

Request

Path Variable

name

required, path variable

Name of the Sabre region

Sample value: EUROPE

NOTE region names are not case sensitive

Response

Region

Returns the associated Sabre region details

  • Name, string
  • CountryCodes, array
  • AirportCodes, array
Region.Name

string

Name of the Sabre region

Region.CountryCodes

array

2-letter ISO 3166 country code

The country code(s) associated to the specified region

Region.AirportCodes

array

3-letter IATA airport code

The airport code(s) associated to the specified region

Links

array

Returns overall links array:

  • self, object
  • linkTemplate, object
Links.self

object

Returns the URL of the request that generated the response

Links.linkTemplate

object

Formats an API request

Sample code

Request

GET https://api.havail.sabre.com/v1.0.0/lists/supported/regions/EUROPE

Response

{
    "Region": {
        "Name": "Europe",
        "CountryCodes": [],
        "AirportCodes": [
            "AAQ",
            "ACE",
            "AER",
            "AGP",
            "ALC",
            "AMS",
            "ARN",
            "ATH",
            "AXD",
            .
            .
            .
            "TIV",
            "TRD",
            "TRN",
            "VCE",
            "VIE",
            "VLC",
            "VVO",
            "ZRH"
        ]
    },
    "Links": [
        {
            "rel": "self",
            "href": "https://api.havail.sabre.com/v1.0.0/lists/supported/regions/EUROPE"
        },
        {
            "rel": "linkTemplate",
            "href": "https://api.havail.sabre.com/<version>/lists/supported/regions/<name>"
        }
    ]
}

Status Codes and Errors

An HTTP status code is always returned. For more information about HTTP status codes and error response formats, see Sabre APIs: errors.

HTTP 200

The request was successful.

HTTP 404

No region named '{name}' is defined

Custom Region Lookup

The Custom Region Lookup endpoint returns a list of your custom regions.

Target Audience
Sabre Travel Network
Current Version
v1.0.0
Authentication
Sessionless Token
Methods/Endpoints
GET /v1.0.0/lists/supported/custom/regions

Request

Requests do not have variations or parameters. The URI requests a list of the custom regions that belong to the authenticating PCC.

Response

Regions

array

  • Links, array
  • Region, string
Regions.Region

string

Name of the custom region

Links

array

  • self, object
  • linkTemplate, object
Links.self

object

Returns the URL of the request that generated the response

Links.linkTemplate

object

Formats an API request

Sample code

Request

GET https://api.havail.sabre.com/v1.0.0/lists/supported/custom/regions

Response

        {
            "Regions": [
                {
                    "Region": "NewZealandPacific",
                    "Links": [
                        {
                            "rel": "self",
                            "href": "https://api.havail.sabre.com/v1.0.0/lists/supported/custom/regions/NEWZEALANDPACIFIC"
                        },
                        {
                            "rel": "linkTemplate",
                            "href": "https://api.havail.sabre.com/<version>/lists/supported/custom/regions/<name>"
                        }
                    ]
                }
            ],
            "Links": [
                {
                    "rel": "self",
                    "href": "https://api.havail.sabre.com/v1.0.0/lists/supported/custom/regions"
                },
                {
                    "rel": "linkTemplate",
                    "href": "https://api.havail.sabre.com/<version>/lists/supported/custom/regions"
                }
            ]
        }
        

Status Codes and Errors

An HTTP status code is always returned. For more information about HTTP status codes and error response formats, see Sabre APIs: errors.

HTTP 200

The request was successful.

Custom Region Details Lookup

The Custom Region Details Lookup endpoint returns the codes associated to your custom region.

API Information

Target Audience
Sabre Travel Network
Current Version
v1.0.0
Authentication
Sessionless Token
Methods/Endpoints
GET /v1.0.0/lists/supported/custom/regions/{name}

Request

Path Variable

name

required, path variable

Name of the custom region

NOTE region names are not case sensitive

Response

Region

Returns the associated custom region details:

  • Name, string
  • CountryCodes, array
  • AirportCodes, array
Region.Name

string

Name of the custom region

Region.CountryCodes

array

2-letter ISO 3166 country code

The country code(s) associated to the specified region

Region.AirportCodes

array

3-letter IATA airport code

The airport code(s) associated to the specified region

Links

array

  • self, object
  • linkTemplate, object
Links.self

object

Returns the URL of the request that generated the response

Links.linkTemplate

object

Formats an API request

Sample code

Request

GET https://api.havail.sabre.com/v1.0.0/lists/supported/custom/regions/NewZealandPacific

Response

        {
            "Region": {
                "Name": "NewZealandPacific",
                "CountryCodes": [],
                "AirportCodes": [
                    "AKL"
                ]
            },
            "Links": [
                {
                    "rel": "self",
                    "href": "https://api.havail.sabre.com/v1.0.0/lists/supported/custom/regions/NEWZEALANDPACIFIC"
                },
                {
                    "rel": "linkTemplate",
                    "href": "https://api.havail.sabre.com/<version>/lists/supported/custom/regions/<name>"
                }
            ]
        }
        

Status Codes and Errors

An HTTP status code is always returned. For more information about HTTP status codes and error response formats, see Sabre APIs: errors.

HTTP 200

The request was successful.

HTTP 404

No region named '{name}' is defined

Create Custom Region

The Create Custom Region endpoint gives you the ability to create a custom region.

NOTE We strongly recommend that you do not name a region with the same name as a Sabre region. Once a Sabre region is modified, any updates to the region will no longer be inherited, and it is entirely up to you to manually maintain that region, as the region will no longer inherit any new country codes that Sabre associates to the region in the future. For example, do not create a custom region of 'Africa' (which is a Sabre region). See the Region Lookup endpoint for a list of Sabre regions.

API Information

Target Audience
Sabre Travel Network
Current Version
v1.0.0
Authentication
Sessionless Token
Methods/Endpoints
POST /v1.0.0/lists/supported/custom/regions

Request

Request Body

Name

string, required

Name of the custom region to create

Sample value: NEWZEALANDPACIFIC

CountryCodes

array, optional*

2-letter ISO 3166 country code

*NOTE either airport or country codes are required

AirportCodes

array, optional*

3-letter IATA airport code

NOTE either airport or country codes are required

Response

Regions.Region

Returns the associated custom region details:

  • Name, string
  • CountryCodes, array
  • AirportCodes, array
Region.Name

string

Name of the custom region

NOTE region names are not case sensitive

Region.CountryCodes

array

2-letter ISO 3166 country code

The country code(s) associated to the specified region

Region.AirportCodes

array

3-letter IATA airport code

The country code(s) associated to the specified region

Links

array

  • self, object
  • linkTemplate, object
Links.self

object

Returns the URL of the request that generated the response

Links.linkTemplate

object

Formats an API request

Sample code

Request

POST https://api.havail.sabre.com/v1.0.0/lists/supported/custom/regions
{
        "Name": "NewZealandPacific",
        "AirportCodes": ["AKL"]
        }

Response

{
        "Region": {
            "Name": "NewZealandPacific",
            "CountryCodes": [],
            "AirportCodes": [
            "AKL"
            ]
        },
        "Links": [
            {
            "rel": "self",
            "href": "https://api.havail.sabre.com/v1.0.0/lists/supported/custom/regions"
            },
            {
            "rel": "linkTemplate",
            "href": "https://api.havail.sabre.com/<version>/lists/supported/custom/regions"
            }
        ]
        }

Status Codes and Errors

An HTTP status code is always returned. For more information about HTTP status codes and error response formats, see Sabre APIs: errors.

HTTP 201

The request was successful.

HTTP 400

Region {name} already exists

A region name must be specified.

A region name can contain: alphanumeric, space or underscore characters only.

A region AirportCodes list must contain valid airport codes.

A region CountryCodes list must contain valid country codes.

A region list must be specified: either CountryCodes or AirportCodes.

A CountryCodes region list must contain valid country codes.

A AirportCodes region list must contain valid country codes.

Region count cannot exceed {number} per PCC

Update Custom Region

The Update Custom Region endpoint gives you the ability to create or update your custom region.

API Information

Target Audience
Sabre Travel Network
Current Version
v1.0.0
Authentication
Sessionless Token
Methods/Endpoints
PUT /v1.0.0/lists/supported/custom/regions/{name}

Request

Path Variable

name

required, path variable

Name of the custom region to update

NOTE region names are not case sensitive

Request Body

Name

string, required

Name of the custom region to update

CountryCodes

array, optional*

2-letter ISO 3166 country code

*NOTE either airport or country codes are required

AirportCodes

array, optional*

3-letter IATA airport code

*NOTE either airport or country codes are required

Response

Regions.Region

array

Returns the associated custom region details:

  • Name, string
  • CountryCodes, array
  • AirportCodes, array
Region.Name

string

Name of the custom region

Region.CountryCodes

array

2-letter ISO 3166 country code

The country code(s) associated to the specified region

Region.AirportCodes

array

3-letter IATA airport code

The airport code(s) associated to the specified region

Links

array

  • self, object
  • linkTemplate, object
Links.self

object

Returns the URL of the request that generated the response

Links.linkTemplate

object

Formats an API request

Sample code

Request

PUT https://api.havail.sabre.com/v1.0.0/lists/supported/custom/regions/NewZealandPacific
        {
        "Name": "NewZealandPacific",
        "AirportCodes": ["AKL","GIS","NPE"]
        }            
        

Response

        {
        "Region": {
            "Name": "NewZealandPacific",
            "CountryCodes": [],
            "AirportCodes": [
            "AKL",
            "GIS",
            "NPE"
            ]
        },
        "Links": [
            {
            "rel": "self",
            "href": "https://api.havail.sabre.com/v1.0.0/lists/supported/custom/regions/NEWZEALANDPACIFIC"
            },
            {
            "rel": "linkTemplate",
            "href": "https://api.havail.sabre.com/<version>/lists/supported/custom/regions/<name>"
            }
        ]
        }            
        

Status Codes and Errors

An HTTP status code is always returned. For more information about HTTP status codes and error response formats, see Sabre APIs: errors.

HTTP 202

The request was successful.

HTTP 400

A region name must be specified.

A region name can contain: alphanumeric, space or underscore characters only.

A region AirportCodes list must contain valid airport codes.

A region CountryCodes list must contain valid country codes.

A region list must be specified: either CountryCodes or AirportCodes.

A CountryCodes region list must contain valid country codes.

A AirportCodes region list must contain valid country codes.

Region count cannot exceed {number} per PCC

Delete Custom Region

The Delete Custom Region endpoint gives you the ability to delete your custom region.

API Information

Target Audience
Sabre Travel Network
Current Version
v1.0.0
Authentication
Sessionless Token
Methods/Endpoints
DELETE /v1.0.0/lists/supported/custom/regions/{name}

Request

Path Variable

name

required, path variable

Name of the custom region to delete

NOTE region names are not case sensitive

Response

This request does not contain a response body. A general HTTP status code is always returned.

Sample code

Request

DELETE https://api.havail.sabre.com/v1.0.0/lists/supported/custom/regions/NewZealandPacific

Response

 204 No Content

Status Codes and Errors

An HTTP status code is always returned. For more information about HTTP status codes and error response formats, see Sabre APIs: errors.

HTTP 204

No Content returned. The request was successful.

HTTP 404

No region named '{name}' is defined

Docs Navigation