30
User Guide GetMarketingTextRQRS API May 2018

User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

  • Upload
    others

  • View
    2

  • Download
    0

Embed Size (px)

Citation preview

Page 1: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

User Guide

GetMarketingTextRQRS API

May 2018

Page 2: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

© 2012-2018, Sabre Inc. All rights reserved.

This documentation is the confidential and proprietary intellectual

property of Sabre Inc. Any unauthorized use, reproduction,

preparation of derivative works, performance, or display of this

document, or software represented by this document, without the

express written permission of Sabre Inc. is strictly prohibited.

Sabre Travel Network and the Sabre Travel Network logo design

are trademarks and/or service marks of an affiliate of Sabre Inc.

All other trademarks, service marks, and trade names are owned

by their respective companies.

Page 3: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

D O C U M E N T R E V I S I O N I N F O R M A T I O N

The following information is to be included with all versions of the document.

Project Name GetMarketingText API

Project

Number

Prepared by Sabre Staff Date Prepared July 2015

Revised by Sabre Staff

Date Revised June 2017

Revision

Reason

• Updated attributes for GetMarketingTextRS/

BrandsMarketingTextResponse/

ResponseSource/

• Updated attributes for /GetMarketingTextRS/

BrandsMarketingTextResponse/

CarrierBrandsData/BrandProgram

Edition No. 1.0

Revised by

Date Revised

Revision

Reason

Edition No.

Revised by

Date Revised

Revision

Reason

Edition No.

Page 4: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

• • •

Page 5: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

User Guide May 2018 Table of Contents v

Table of Contents

1 G e t t i n g S t a r t e d

1.1 Introduction ......................................................................................................................................... 1-1 1.2 About This Guide ................................................................................................................................ 1-1 1.3 Customer Identification ....................................................................................................................... 1-1 1.4 Information Sources ............................................................................................................................ 1-1

2 G e t M a r k e t i n g T e x t R e q u e s t a n d R e s p o n s e S t r u c t u r e

2.1 Introduction ......................................................................................................................................... 2-1 2.2 GetMarketingTextRQ Structure .......................................................................................................... 2-1

2.2.1 Basic Characteristics ................................................................................................................. 2-1 2.2.2 Request Source ......................................................................................................................... 2-2 2.2.3 Marketing Text Criteria .............................................................................................................. 2-3

2.3 GetMarketingTextRS Structure ........................................................................................................... 2-3 2.3.1 Basic Characteristics ................................................................................................................. 2-4 2.3.2 Response Source ...................................................................................................................... 2-4 2.3.3 Carrier Brands Data................................................................................................................... 2-5 2.3.4 Brand ......................................................................................................................................... 2-6 2.3.5 MarketingText/Text .................................................................................................................... 2-7 2.3.6 Message .................................................................................................................................... 2-9

3 X M L E x a m p l e s

3.1 Introduction ......................................................................................................................................... 3-1 3.2 GetMarketingTextRQ With Specified Language and Program ID ....................................................... 3-1

3.2.1 GetMarketingTextRQ ................................................................................................................. 3-1 3.2.2 GetMarketingTextRS ................................................................................................................. 3-1

3.3 GetMarketingTextRQ With Specified Language and Carrier Code ..................................................... 3-3 3.3.1 GetMarketingTextRQ ................................................................................................................. 3-3 3.3.2 GetMarketingTextRS ................................................................................................................. 3-3

3.4 GetMarketingTextRQ With No Language and Program ID ................................................................. 3-6 3.4.1 GetMarketingTextRQ ................................................................................................................. 3-6 3.4.2 GetMarketingTextRS ................................................................................................................. 3-6

Page 6: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

vi Table of Contents User Guide May 2018

4 E r r o r C o d e s

4.1 Introduction ......................................................................................................................................... 4-1 4.2 Codes and Descriptions ...................................................................................................................... 4-1

G l o s s a r y

Page 7: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

User Guide May 2018 Introduction 1-1

1.1 I n t r o d u c t i o n

The GetMarketingText API obtains marketing text information for programs as well as basic details

about brands, such as, program ID, carrier, PCC, and dates.

If you want to utilize this API, please contact your account manager.

1.2 A b o u t T h i s G u i d e

The purpose of this user guide is to provide a description of the new branding API for Sabre users. It

describes how the branding service works and the restrictions that must be followed in order to create

a successful request. Included are examples of payloads both successful and containing errors.

This guide provides information about the Branded Fares web service. Each chapter is as follows:

• Chapter 1, “Getting Started” explains the purpose of the document, details critical information,

and provides a functional overview.

• Chapter 2, “GetMarketingText Request and Response Structure” contains descriptions of the

attributes and elements in the response schema.

• Chapter 4, “XML Examples” contains examples of the requests and response schemas.

• Chapter 5, “Error Codes” contains error codes and descriptions.

• Glossary provides a glossary of terms used in this document.

1.3 C u s t o m e r I d e n t i f i c a t i o n

The Branded Fares service can be used by:

• Sabre Airline Solutions customers – airlines using Interact or SabreSonic® CSS Web.

• Sabre Travel Network customers – travel agencies working on Sabre® Red Workspace™ and

other Sabre user interfaces.

• Third-party customers.

1.4 I n f o r m a t i o n S o u r c e s

Information about existing Branded Fares programs is available in the merchandising rule-based

tables, which is a knowledge base used by the services.

1 Getting Started 1

Page 8: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

1-2 Information Sources User Guide May 2018

Information is entered in the merchandising rule-based tables either via a load from ATPCO or

directly in the Sabre® system using the SabreSonic® CSS Merchandising Manager Branded Fares

application.

Page 9: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

User Guide May 2018 Introduction 2-1

2.1 I n t r o d u c t i o n

A successful GetMarketingText response contains general information about the brand and specific

marketing text information. For detailed information about what features are allowed for free and

which features have charges, you can view the MarketingText/Text parameter.

2.2 G e t M a r k e t i n g T e x t R Q S t r u c t u r e

GetMarketingTextRQ contains information about the requestor, as well as details of the request. If a

program is available for the indicated parameters, a payload containing the requested information is

returned. If no program for the specified parameters is available, an empty response is returned. If the

request contains incorrect information, an error is returned.

The GetMarketingText API contains security data necessary to verify if the requestor has access to

obtain marketing text information.

Note Mandatory elements are marked in red.

This section contains the following:

• Basic characteristics (see this page).

• Request source (see “Request Source,” page 2-2).

• Marketing text criteria (see “Marketing Text Criteria,” page 2-3).

2.2.1 B a s i c C h a r a c t e r i s t i c s

/GetMarketingTextRQ/

Attribute Description

version Indicates the version of the service used.

2 GetMarketingText Request and

Response Structure

2

Page 10: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

2-2 GetMarketingTextRQ Structure User Guide May 2018

2.2.2 R e q u e s t S o u r c e

/GetMarketingTextRQ/BrandsMarketingTextRequest/BrandingRequestSource/

Element Attribute Description

BrandingResourceRequest distributionChannel Attribute is added for future use.

pseudoCityCode Four-character alphanumeric code for the pseudo city. PCC is mandatory for Travel Network customers. For Airline Solutions customers, it is not required, but still can be used. The PCC, together with the geoLocation, is used to define the point of

sale eligibility for Travel Network customers.

This information is passed in the request and without any changes returned in the response.

iataNumber Seven-digit IATA number that can be used to verify if the requestor is entitled to use the program. For marketing text requests, this data is passed for information only; it is not checked, but copied without modifications into the response.

clientID Identifier of the requester.

The value is for information purposes only – no verification is made but the value is still checked for

being non empty.

requestType Attribute is for future use.

requestingCarrierGDS Identifier for who is requesting the marketing text information. It specifies either the carrier that made the request, or the GDS from which the request was made. This value is not checked against the rules

but copied into the response without modification.

geoLocation Three-character alpha code that identifies the city from which the airline or travel agency sent the request. If the information is not indicated in the request, ANCS will use its own logic to determine this value based on the PCC indicated in the request. In order to achieve this, the CUSTOMER table will be used. The requested value is under REQUESTCITY (A10). In the Merchandising Manager application, it is established using geographic criteria, such as: area, market, nation, state, subarea and zone. This value is not checked against the rules, but copied into the response

without modification.

departmentCode DepartmentCode and officeDesignator are both used by Airline Solutions customers in order to add specific point of sale restrictions to the branded fares program. It is possible to add the departmentCode in the Merchandising Manager application using three- to eight-character codes. DepartmentCode is an optional field in the service request, and it is mutually exclusive with officeDesignator attribute. This value is not checked, but copied to the response without changes.

Page 11: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

User Guide May 2018 GetMarketingTextRS Structure 2-3

Element Attribute Description

officeDesignator DepartmentCode and officeDesignator are both used by Airline Solutions customers in order to add specific point of sale restrictions to the branded fares program. OfficeDesignator is a five-character code, and it is an optional attribute available only for Airline Solutions customers. It can be set only via an ATPCO load and used as a restriction for specific point of sale. In the request, it is optional and mutually exclusive with the departmentCode field. This value is not checked and, if indicated in the request, it will be copied to the response without changes.

dutyCode Identifier for the function in which the agent is working. It is specified using one alphanumeric signs, plus the following special characters: ¥, ¤, *, -. This value is not checked and if indicated in the request it will be copied to the response without changes.

2.2.3 M a r k e t i n g T e x t C r i t e r i a

Marketing text criteria is used to specify the program (or programs) and carriers for which the

information is requested.

/GetMarketingTextRQ/BrandsMarketingTextRequest/MarketingTextCriteria/

Element Attribute Description

MarketingTextCriteria

carrier Carrier code of program owning carrier. If a carrier code is specified without programID, all programs for the specified

carrier will be returned.

programID Identifier for the program. If a specific ID is listed, the information returned will be limited to this one program. If this attribute is not present in the request, information will be

returned for all the programs for the requested carrier.

language Two-character code for the language. If this attribute is added, information regarding brand name, brand label, and marketing text will be returned in the specified language. Only if the element is not available in the specified language, all

translations will be returned.

Note Either a programID or carrier attribute must be specified for each request.

2.3 G e t M a r k e t i n g T e x t R S S t r u c t u r e

The GetMarketingTextRS contains information about requestor as well as detailed marketing

information for the requested program or programs.

This section includes the following:

Page 12: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

2-4 GetMarketingTextRS Structure User Guide May 2018

• Basic characteristics (see this page).

• Response source (see this page).

• Carrier brands data (see “Carrier Brands Data,” page 2-5).

• Brand (see “Brand,” page 2-6).

• Message (see “Message,” page 2-9).

2.3.1 B a s i c C h a r a c t e r i s t i c s

/GetMarketingTextRS/

Attribute Description

version Indicates the version of the service used.

2.3.2 R e s p o n s e S o u r c e

/GetMarketingTextRS/BrandsMarketingTextResponse/ResponseSource/

Element Attribute Description

ResponseSource distributionChannel Attribute is designed for future use.

pseudoCityCode Four-character alphanumeric code for the pseudo city. PCC is mandatory for Travel Network customers. For Airlines Solutions customers, it is not required, but still can be used. PCC together with the geoLocation is used to define the point of sale eligibility for Travel Network customers.

The same PCC as was indicated in the request must be returned.

iataNumber Seven-digit number that identifies the travel agency making the request. This must be the same as was indicated in the request.

clientID Identifier for the requester.

requestType Attribute is designed for future use.

requestingCarrierGDS Identifies for whom the branding response is returned. It specifies either the carrier that made the request, or the GDS from which the request was made. The value must be the same as in the request.

geoLocation Three-character alpha code that identifies the city from where the airline or travel agency sent the requests. If the information is not literally indicated in the request ANCS will use its own logic to determine this value based on the PCC indicated in the request. In order to achieve this, the CUSTOMER table will be used. The requested value is under REQUESTCITY (A10). In the Merchandising Manager application, it is established using geographic criteria, such as: area, market,

nation, state, subarea, and zone.

Page 13: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

User Guide May 2018 GetMarketingTextRS Structure 2-5

Element Attribute Description

departmentCode DepartmentCode and officeDesignator are both used by Airline Solutions customers in order to add specific point of sale restrictions to the branded fares program. It is possible to add the departmentCode in the Merchandising Manager application using three- to eight-characters codes. DepartmentCode is an optional field in the service request and it is mutually exclusive with officeDesignator attribute.

The value returned in the response must match what was indicated in the request.

officeDesignator DepartmentCode and officeDesignator are both used by Airline Solutions customer in order to add specific point of sale restrictions to the branded fares program. OfficeDesignator has five characters, and it is an optional attribute available only for Airlines Solutions customers. It can be set only via an ATPCO load and used as a restriction for specific POS. In the request, it is optional and mutually exclusive with the departmentCode field.

The value returned in the response must match what was indicated in the request.

dutyCode and functionCode Duty codes and function codes are used to identify the function in which the agent is working. It is specified using one alphanumeric sign, plus the following special characters: ¥, ¤, *, -. The value returned in the response must match what was indicated in the request.

2.3.3 C a r r i e r B r a n d s D a t a

Marketing text information for the requested program or programs is returned. If there was no

program ID in the request and all programs for a given carrier are returned, they are sorted in

ascending order by the program ID.

2.3.3.1 B r a n d P r o g r a m

/GetMarketingTextRS/BrandsMarketingTextResponse/CarrierBrandsData/BrandProgram

Attribute Description

programID Identifier for the program for which information is displayed.

dataSource Source of programs. If not present, defaults to S8.

programImageURL Program/Campaign URL

Page 14: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

2-6 GetMarketingTextRS Structure User Guide May 2018

Element Description

Vendor Source in which the program was defined. Valid values are:

• ATP – For programs defined via ATPCO.

• MMGR – For programs defined via Merchandising Manager.

Element Description

EffectiveDate First date when the program can be requested for display or sell (in YYYY-MM-DD format).

Element Description

DiscontinueDate Last date when the program can be requested for display or sell (in YYYY-MM-DD format).

Element Description

ProgramCode Identifier for the program.

Element Description

SystemCode System generated codes are returned in the branding service so that responses obtained from the new service are compatible with current CBAS responses.

Element Description

ProgramName Program name (English).

2.3.4 B r a n d

/GetMarketingTextRS/BrandsMarketingTextResponse/CarrierBrandsData/BrandProgram/

BrandsData/Brand/

Element Description

Identifier Ten-character alpha code for the brand. It is for internal purposes only.

Element Description

Code Two- to ten-character alpha code for the brand in a user-friendly way.

Element Description

Name Brand name in language specified in language attribute (maximum of 30 characters, including: alpha, numeric, blank, dash (-), and slash (/).

Page 15: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

User Guide May 2018 GetMarketingTextRS Structure 2-7

Element Description

Tier Order of the brand in the applicationthe rank it has in the program.

Element Attribute Description

BrandLabel URL address corresponding to the specified language.

brandLabelURL

language

Element Attribute Description

MarketingText

language Marketing text translation in the specified language.

MarketingText/Text For more information, see “Understanding Marketing Text Formatting Conventions” on this page.

2.3.5 U n d e r s t a n d i n g M a r k e t i n g T e x t F o r m a t t i n g C o n v e n t i o n s

Sabre requires that marketing text is provided in the following formats using the ATPCO text table

196 at the brand level so that OTA customers can easily consume and process the data. This format

allows OTA customers to parse the data and accurately decode and display the branded fare attributes

within their systems. This data must be placed in the Table 196 in the recurring segments of the

Record S8.

The recommended convention is as follows using the ATPCO Text Table 196 in the Branded Fares

application:

//SUB CODE/FEATURE APPLICATION/COMMERCIAL NAME//

Convention Description

Sub Code Three-character alphanumeric code that is filed in the S5 record. This can be an industry sub-code or a carrier defined sub-code.

Feature Application One-character alpha code that indicates if the service is:

• Free (F)

• Not offered and not displayed (N)

• Chargeable (C)

• Displayed, but not offered (D)

Commercial Name Textual description of the service within the brand.

Page 16: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

2-8 GetMarketingTextRS Structure User Guide May 2018

Brand Example

TEXT TABLE

//PSA/F/PRERESERVED SEAT//0CM/F/BONUS MILES//0BV/C/STANDBY//0BH/C/UNACCOMPANIED

MINOR//0CL/C/INTERNET ACCESS//0G6/F/PRIORITY

BOARDING//RFB/N/REFUNDS//CHB/N/TICKET CHANGES//0AV/F/ALCOHOLIC

DRINK//0AT/F/SNACK//0AW/F/NONALCOHOLIC DRINK//

For this example, the following features are included:

• A Pre-Reserved Seat is offered free of charge.

• Bonus Miles are offered free of charge.

• Standby options are available for a charge.

• Unaccompanied Minor is available for a charge.

• Internet Access is offered for a charge.

• Priority Boarding is offered free of charge.

• Refunds are not offered and not displayed.

• Ticket Changes are not offered and not displayed.

• Alcoholic Drink is offered free of charge.

• Snack is offered free of charge.

• Non-alcoholic drink is offered free of charge.

Brand Example

TEXT TABLE

//PSA/N/PRERESERVED SEAT//0CM/F/BONUS MILES//0BV/N/STANDBY//0BH/N/UNACCOMPANIED

MINOR//0CL/C/INTERNET ACCESS//0G6/N/PRIORITY

BOARDING//RFB/N/REFUNDS//CHB/N/TICKET CHANGES//0AV/C/ALCOHOLIC

DRINK//0AT/F/SNACK//0AW/F/NONALCOHOLIC DRINK//

For this example, the following features are included:

• A Pre-Reserved Seat is not offered and not displayed.

• Bonus Miles are offered free of charge.

• Standby options are not offered and not displayed.

• Unaccompanied Minor is not offered and not displayed.

• Internet Access is offered for a charge.

• Priority Boarding is not offered and not displayed.

• Refunds are not offered and not displayed.

Page 17: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

User Guide May 2018 GetMarketingTextRS Structure 2-9

• Ticket Changes are not offered and not displayed.

• Alcoholic Drink is offered for a charge.

• Snack is offered free of charge.

• Non-alcoholic drink is offered free of charge.

Note A maximum of 50 characters can be in a line, and up to 999 lines can be in a table.

2.3.6 M e s s a g e

This message is used to describe the reasons why the response did not contain a valid payload.

/GetMarketingTextRS/BrandsMarketingTextResponse/Message

Attribute Description

messageCode The value of this attribute will be “Error” when there was a mistake in the request sent.

failCode Type of issue that prohibited a successful response. Valid values are:

• 1000 – Application errors

• 2000 – Validation errors

• 3000 – Warnings

airlineCode Attribute is designed for future use. Airline codes are not returned.

Page 18: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

2-10 GetMarketingTextRS Structure User Guide May 2018

• • •

Page 19: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

User Guide May 2018 Introduction 3-1

3.1 I n t r o d u c t i o n

This chapter contains examples of requests and responses for the GetMarketingText API.

Note Marketing text responses will vary depending on the indicated language, program ID, and

carrier.

• GetMarketingTextRQ with specified language and program ID (see this page).

• GetMarketingTextRQ with specified language and carrier code (see “GetMarketingTextRQ With

Specified Language and Carrier Code,” page 3-3).

• GetMarketingTextRQ with no specified language and program ID (see “GetMarketingTextRQ

With No Language and Program ID,” page 3-6).

3.2 G e t M a r k e t i n g T e x t R Q W i t h S p e c i f i e d L a n g u a g e a n d

P r o g r a m I D

This section contains request and response examples of GetMarketingText with a specified language

and program ID as follows:

• GetMarketingTextRQ (see this page).

• GetMarketingTextRS (see this page).

3.2.1 G e t M a r k e t i n g T e x t R Q

<GetMarketingTextRQ xmlns:v1="http://stl.sabre.com/Merchandising/v1"

version="1.0">

<BrandsMarketingTextRequest>

<RequestSource clientID="K0" geoLocation="GAH"

requestingCarrierGDS="K0"/>

<MarketingTextCriteria language="EN" programID="40100"/>

<BrandsMarketingTextRequest>

<GetMarketingTextRQ>

3.2.2 G e t M a r k e t i n g T e x t R S

This response includes marketing text from the Merchandising Manager (MMGR) application. The

results in the Text element appear differently if the vendor is ATPCO (ATP). For an example of

marketing text from ATP, see GetMarketingTextRQ With Specified Language and Carrier Code on

page 3-3.

3 XML Examples 4

Page 20: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

3-2 GetMarketingTextRQ With Specified Language and Program ID User Guide May 2018

< <GetMarketingTextRS version="1.0" xmlns="http://stl.sabre.com/Merchandising/v1"

xmlns:omsg2="http://opentravel.org/common/message/v02"

xmlns:oc2="http://opentravel.org/common/v02"

xmlns:m0="http://stl.sabre.com/Merchandising/v0"

xmlns:stlp21="http://services.sabre.com/STL_Payload/v02_01">.

<BrandsMarketingTextResponse>

<ResponseSource clientID="K0" requestingCarrierGDS="K0"

geoLocation="GAH"/>

<CarrierBrandsData>

<BrandProgram programID="40100" dataSource="S8">

<Vendor>MMGR</Vendor>

<ProgramCode>EXT</ProgramCode>

<ProgramName>Extras</ProgramName>

<SystemCode>O</SystemCode>

<EffectiveDate>2015-05-05</EffectiveDate>

<DiscontinueDate>9999-12-31</DiscontinueDate>

<BrandsData>

<Brand>

<Identifier>43166</Identifier>

<Code>SV</Code>

<Name language="EN">Saver</Name>

<Tier>1</Tier>

<BrandLabel

brandLabelURL="https://www.worldwideair.com/en/information/... " language="EN"/>

<MarketingText language="EN">

<Text>

<![CDATA[<font><p>Booking

Changes - Fees and Conditions apply.</p></font><font><p>Booking Cancellations -

Fees and Conditions apply.</p></font><font><p>In-flight Entertainment - Included.

<font><p>Food and Beverage - Included.</p></font><font><p>Checked Baggage - 1

piece included (23kg). Additional may be purchased.</p></font><font><p>Extra

Legroom - Available for purchase.</p></font><font><p>Advance Seat Selection -

Included</p></font><font><p>Priority Check-in and Baggage -

No</p></font><font><p>Priority Boarding - No</p></font><font><p>Lounge Entry -

Membership available for purchase.</p></font>]]></Text>

</MarketingText>

</Brand>

<Brand>

<Identifier>43166</Identifier>

<Code>FL</Code>

<Name language="EN">Flexible</Name>

<Tier>2</Tier>

<BrandLabel

brandLabelURL="https://www.worldwideair.com/en/information/... " language="EN"/>

<MarketingText language="EN">

<Text>

<![CDATA[<font><p>Booking

Changes - Fees and Conditions apply.</p></font><font><p>Booking Cancellations -

Fees and Conditions apply.</p></font><font><p>In-flight Entertainment - Included.

</p></font><font><p>Food and Beverage - Included.</p></font><font><p>Checked

Baggage - 1 piece included (23kg). Additional may be

purchased.</p></font><font><p>Extra Legroom - Available for

purchase.</p></font><font><p>Advance Seat Selection -

Included</p></font><font><p>Priority Check-in and Baggage - Included (where

offered).</p></font><font><p>Priority Boarding - No</p></font><font><p>Lounge

Entry - Membership available for purchase.</p></font>]]></Text>

</MarketingText>

</Brand>

<Brand>

<Identifier>43166</Identifier>

<Code>PS</Code>

Page 21: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

User Guide May 2018 GetMarketingTextRQ With Specified Language and Carrier Code 3-3

<Name language="EN">Premium Saver</Name>

<Tier>3</Tier>

<BrandLabel

brandLabelURL="https://www.worldwideair.com/en/information/..." language="EN"/>

<MarketingText language="EN">

<Text>

<![CDATA[<font><p>Booking

Changes - Fees and Conditions apply.</p></font><font><p>Booking Cancellations -

Fees and Conditions apply.</p></font><font><p>In-flight Entertainment -

Included.</p></font><font><p>Food and Beverage -

Included.</p></font><font><p>Checked Baggage - 2 pieces included (32kg).

Additional may be purchased.</p></font><font><p>Premium Economy Seating - Extra

space and comfort.</p></font><font><p>Advance Seat Selection -

Included</p></font><font><p>Priority Check-in and Baggage - Included (where

offered).</p></font><font><p>Priority Boarding - Included (where

offered).</p></font><font><p>Lounge Entry - Membership available for

purchase.</p></font>]]></Text>

</MarketingText>

</Brand>

</CarrierBrandsData>

</BrandsMarketingTextResponse>

</GetMarketingTextRS>

3.3 G e t M a r k e t i n g T e x t R Q W i t h S p e c i f i e d L a n g u a g e a n d

C a r r i e r C o d e

This section contains request and response examples of GetMarketingText with a specified language

and carrier code as follows:

• GetMarketingTextRQ (see this page).

• GetMarketingTextRS (see this page).

3.3.1 G e t M a r k e t i n g T e x t R Q

<GetMarketingTextRQ version="1.0" xmlns="http://stl.sabre.com/Merchandising/v1">

<BrandsMarketingTextRequest>

<RequestSource clientID="INT" geoLocation="TXL"

requestingCarrierGDS="1S"/>

<MarketingTextCriteria programID="96353" language="EN"

carrier="K0"/>

</BrandsMarketingTextRequest>

</GetMarketingTextRQ>

3.3.2 G e t M a r k e t i n g T e x t R S

This response includes marketing text from ATPCO (ATP). The results in the Text element appear

differently if the vendor is the Merchandising Manager (MMGR) application. For more information

about marketing text conventions, see Understanding Marketing Text Formatting Conventions on

page 2-7.

Page 22: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

3-4 GetMarketingTextRQ With Specified Language and Carrier Code User Guide May 2018

<GetMarketingTextRS version="1.0" xmlns="http://stl.sabre.com/Merchandising/v1"

xmlns:omsg2="http://opentravel.org/common/message/v02"

xmlns:oc2="http://opentravel.org/common/v02"

xmlns:stlp21="http://services.sabre.com/STL_Payload/v02_01"

xmlns:m0="http://stl.sabre.com/Merchandising/v0">

<BrandsMarketingTextResponse>

<ResponseSource clientID="INT" requestingCarrierGDS="1S"

geoLocation="TXL"/>

<CarrierBrandsData>

<BrandProgram programID="96353" dataSource="S8">

<Vendor>ATP</Vendor>

<ProgramCode>WP</ProgramCode>

<ProgramName>WESTERN PROGRAM</ProgramName>

<SystemCode>E</SystemCode>

<EffectiveDate>2015-06-05</EffectiveDate>

<DiscontinueDate>9999-12-31</DiscontinueDate>

<BrandsData>

<Brand>

<Identifier>54464</Identifier>

<Code>A1</Code>

<Name language="EN">FLEXIBLE</Name>

<Tier>1</Tier>

<MarketingText language="EN">

<Text>

//0B5/F/SEAT ASSIGNMENT

//0LN/F/CARRYON HAND BAGGAGE

ALLOWANCE

//0C3/F/UPTO50LB 23KG BAGGAGE

//0C6/F/UPTO70LB 32KG BAGGAGE

//0IB/F/PREPAID 2ND TO 5TH ADD PC

23

//0IF/C/PREPAID 2ND TO 5TH ADD PC

32

//0BT/C/PET IN CABIN

//0BS/C/PET IN HOLD

//PEN/F/CHANGEABLE

//RFD/F/REFUNDABLE

//SET/C/SPARKLING WINE

//0AV/C/ALCOHOLIC DRINK CHAMPAIGN

//MAA/C/SCRAMBLED EGGS WITH BACON

//MAB/C/SPANISH OMELETTE

//MAC/C/CURRYWURST

//MNA/C/COLD HEALTHY BREAKFAST

//MNB/C/SCRAMBLED EGGS WITH BACON

</Text>

</MarketingText>

</Brand>

<Brand>

<Identifier>54465</Identifier>

<Code>A2</Code>

<Name language="EN">BASIC</Name>

<Tier>2</Tier>

<MarketingText language="EN">

<Text>

//0B5/C/SEAT ASSIGNMENT

//0LN/F/CARRYON HAND BAGGAGE

ALLOWANCE

//0C3/F/UPTO50LB 23KG BAGGAGE

//0C6/N/UPTO70LB 32KG BAGGAGE

//0IB/C/PREPAID 2ND TO 5TH ADD PC

23

Page 23: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

User Guide May 2018 GetMarketingTextRQ With Specified Language and Carrier Code 3-5

//0IF/C/PREPAID 2ND TO 5TH ADD PC

32

//0BT/C/PET IN CABIN

//0BS/C/PET IN HOLD

//PEN/C/CHANGEABLE

//RFD/N/REFUNDABLE

//SET/C/SPARKLING WINE

//MAA/C/SCRAMBLED EGGS WITH BACON

//MAB/C/SPANISH OMELETTE

//MAC/C/CURRYWURST

//MNA/C/COLD HEALTHY BREAKFAST

//MNB/C/SCRAMBLED EGGS WITH BACON

</Text>

</MarketingText>

</Brand>

<Brand>

<Identifier>54466</Identifier>

<Code>B0</Code>

<Name language="EN">DEAL</Name>

<Tier>3</Tier>

<MarketingText language="EN">

<Text>

//0B5/C/SEAT ASSIGNMENT

//0LN/F/CARRYON HAND BAGGAGE

ALLOWANCE

//0C3/F/UPTO50LB 23KG BAGGAGE

//0C6/N/UPTO70LB 32KG BAGGAGE

//0IB/C/PREPAID 2ND TO 5TH ADD PC

23

//0IF/C/PREPAID 2ND TO 5TH ADD PC

32

//0BT/C/PET IN CABIN

//0BS/C/PET IN HOLD

//PEN/N/CHANGEABLE

//RFD/N/REFUNDABLE

//SET/C/SPARKLING WINE

//0AV/C/ALCOHOLIC DRINK CHAMPAIGN

//MAA/C/SCRAMBLED EGGS WITH BACON

//MAB/C/SPANISH OMELETTE

</Text>

</MarketingText>

</Brand>

</Brand>

</BrandsData>

</BrandProgram>

</CarrierBrandsData>

</BrandsMarketingTextResponse>

</GetMarketingTextRS>

Page 24: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

3-6 GetMarketingTextRQ With No Language and Program ID User Guide May 2018

3.4 G e t M a r k e t i n g T e x t R Q W i t h N o L a n g u a g e a n d

P r o g r a m I D

This section contains request and response examples of GetMarketingText with no specified language

and a program ID as follows:

• GetMarketingTextRQ (see this page).

• GetMarketingTextRS (see this page).

3.4.1 G e t M a r k e t i n g T e x t R Q

<GetMarketingTextRQ version="1.0.0"

xmlns="http://stl.sabre.com/Merchandising/v1">

<BrandsMarketingTextRequest>

<RequestSource clientID="SHP" requestingCarrierGDS="K0" geoLocation="DFW"/>

<MarketingTextCriteria programID="51"/>

</BrandsMarketingTextRequest>

</GetMarketingTextRQ>

3.4.2 G e t M a r k e t i n g T e x t R S

This response includes all languages for the program. If you do not specify a language in the request,

all languages will appear in the response.

<GetMarketingTextRS xmlns="http://stl.sabre.com/Merchandising/v1">

<BrandsMarketingTextResponse>

<ResponseSource clientID="SHP" requestingCarrierGDS="K0" geoLocation="DFW"/>

<CarrierBrandsData>

<BrandProgram programID="51">

<Vendor>MMGR</Vendor>

<ProgramCode>SCANDINAVIA</ProgramCode>

<ProgramName>BETWEEN US AND US</ProgramName>

<SystemCode>A</SystemCode>

<EffectiveDate>2001-08-08</EffectiveDate>

<DiscontinueDate>2017-08-08</DiscontinueDate>

<BrandsData>

<Brand>

<Identifier>50</Identifier>

<Code>TEST</Code>

<Name language="EN">TEST PURPOSE</Name>

<Name language="JP">ブランド名</Name>

<Name language="TW">商標名稱</Name>

<Tier>10</Tier>

<BrandLabel brandLabelURL="www.example.com" language="EN"/>

<BrandLabel brandLabelURL="www.example.jp" language="JP"/>

<BrandLabel brandLabelURL="www.example.tw" language="TW"/>

<MarketingText language="EN">

<Text><![CDATA[<font><p>Default english marketing

text</p></font>]]></Text>

</MarketingText>

<MarketingText language="JP">

<Text><![CDATA[<font><p>たとえば、マーケティングのテキスト</p></font>]]></Text>

</MarketingText>

Page 25: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

User Guide May 2018 GetMarketingTextRQ With No Language and Program ID 3-7

<MarketingText language="TW">

<Text><![CDATA[<font><p>例如文本營銷</p></font>]]></Text>

</MarketingText>

</Brand>

</BrandsData>

</BrandProgram>

</CarrierBrandsData>

</BrandsMarketingTextResponse>

</GetMarketingTextRS>

Page 26: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

3-8 GetMarketingTextRQ With No Language and Program ID User Guide May 2018

• • •

Page 27: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

User Guide May 2018 Introduction 4-1

4.1 I n t r o d u c t i o n

This chapter contains the error codes and descriptions.

4.2 C o d e s a n d D e s c r i p t i o n s

Name OTA Code Description

INTERNAL_SERVICE_ERROR 1001 Internal service error

XML_PARSING_ERROR 1002 XML parsing error

INCOMPLETE_REQUEST 2001 Incomplete request

INVALID_CARRIER_CODE 2002 Invalid carrier code

MARKET_ID_NOT_UNIQUE 2004 MarketId is not unique

INVALID_DATE 2005 Invalid date

INVALID_ACCOUNT_CODE 2006 Invalid account code

INVALID_CARRIER_GDS_CODE 2008 Invalid requesting carrier GDS code

INVALID_DUTY_CODE 2009 Invalid duty code

INVALID_GEO_LOCATION 2011 Invalid geo location

INVALID_PSEUDO_CITY_CODE 2013 Invalid pseudo city code

INVALID_DEPARTMENT_CODE 2014 Invalid department code

INVALID_OFFICE_DESIGNATOR 2015 Invalid office designator

INVALID_AIRPORT_CODE 2016 Invalid airport code

INVALID_GLOBAL_INDICATOR 2017 Invalid global indicator

INVALID_IATA_NUMBER 2019 Invalid IATA number

MISSING_CLIENT_ID 2020 Missing clientId

UNSUPPORTED_USAGE 2021 Unsupported usage

INVALID_FUNCTION_CODE 2022 Invalid function code

INVALID_REQUEST_TYPE 2023 Invalid request type

INVALID_PROGRAM_ID 2101 Invalid program id

INVALID_LANGUAGE_CODE 2103 Invalid language code

PROGRAM_ID_OR_CARRIER_CODE 2104 Program id or carrier code expected

NO_PROGRAMS_FOUND 3001 No programs found

4 Error Codes 4

Page 28: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

4-2 Codes and Descriptions User Guide May 2018

Name OTA Code Description

NO_INTERLINE_PROGRAMS_FOUND 3002 No interline programs found

CANNOT_CONNECT_TO_CBS 3003 Cannot connect to Consolidated Branding Service (CBS)

Page 29: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

User Guide May 2018 Glossary 1

Following is a glossary of terms (listed in alphabetical order by term):

Term Description

AS Airline Solutions

ATPCO Airline Tariff Publishing Corporation

Branded Fares Airline fares organized into commercially recognizable products with distinct service offerings associated to the brand. Normally, multiple products are available and are

related to price and service tiers or levels

Brand ID Code representing each brand (two to ten characters).

Brand Name Marketing name for a specified group of fares within a Brand Program

Brand Program Set of fare brands (bundles of fare basis codes and/or booking codes marketed in a memorable way to help sell features to customers) with a point of sale and origin and destination that is designed to be marketed with services desirable to

customers

CBS Consolidated Branding Service - a standalone ATSE system that exposes the branding data configured via the Merchandising Manager application.

GDS Code for the Global Distribution System. For example:

1S – Sabre

1B – Abacus

1J – Axess

1F – Infini

GUI Graphical User Interface

IBF Interline Branded Fares

IS Itinerary Selector

MM Merchandising Manager

OAC Office Accounting Code

Record S8 Branded Fares ATPCO Record S8

SRW Sabre Red Workspace

SSW SabreSonic Web

TN Travel Network

5 Glossary

Page 30: User Guide - Sabrefiles.developer.sabre.com/doc/providerdoc/Merchandising/GetMarketingText_UserGuide.pdfInformation about existing Branded Fares programs is available in the merchandising

2 Glossary User Guide May 2018

• • •