Product Offer Operations

For a list of operations associated with this Web service, see the following table.

Node	Description
GetProductOffer	Retrieves a flat, nonhierarchical list of product offers. This operation does not require any input data. Optional input is the offer ID, the offer name, or a search specification to retrieve a specific list of offers. Output of this operation returns product offer header information such as Offer Id, Offer Name and Offer Description. When an offer ID not provided in the input message, the output will list all the product offers defined in the application.
GetProductOfferStructure	Retrieves the detailed structure of a specific product offer. The input message requires the offer ID. The output message returns product offer definition data such as product offer responses, actions, workflow parameters, named parameters, recommendations, eligibility and compatibility rules, and messages.
GetRecommendedOffers	Retrieves the recommended product offers for a specific account. It also retrieves recommended offers for a specific asset, open quote, or open order. If the account ID is specified in the input message, then the output message will return all the recommended product offers for that account. If the Account ID, Document ID, and Mode are specified in the input message, then the output message will return the recommended offers for that specific asset or open order or open quote This operation only returns recommended product offers. It does not return recommend promotions as part of the response message. Also, this operation enforces response suppression, which means the same offer is not recommended for an account that has previously accepted the offer.
ApplyOfferToCreateOrder	Applies a product offer to an account whose type is set to Residential. The input message requires the account ID and offer ID. If the offer requires modification to the customer's asset, then the asset ID is also required. The output message returns the complete order structure. The user has the option to retrieve just the order ID, or the order number without returning the full order structure. For offers that require user interaction, in other words, offers with named parameters, the input message must be configured with run-time values. Values include attribute value, field value, base product, component product, or upgrade product.
ApplyOfferToCreateQuote	Applies a product offer to an account of a type other than residential. The input message requires the account ID, and offer ID. The output message returns the complete quote structure. The user can retrieve just the quote ID or quote number without returning the full quote structure For offers that require user interaction, in other words, offers with named parameters, the input message must be configured with run-time values. Values include attribute value, field value, base product, component product, or upgrade product.

Request Message Description: GetProductOffer

For a description of this request message, see the following table.

Node	Description	Type
RAFProductOfferListIO	Based on an integration object that is used for both the request and response messages. The user can pass the offer ID to query relevant offer details.	Integration object

Response Message Description: GetProductOffer

For a description of this response message, see the following table.

Node	Description	Type
RAFProductOfferListIO	Based on an integration object that is used for both the request and response message.	Integration object

Request Message Description: GetProductOfferStructure

For a description of this request message, see the following table.

Node	Description	Type
RAFProductOfferStructureIO	Identifies the objects that will be queried for the product offer ID or name. The input message required is offer ID or offer name	Integration object

Response Message Description: GetProductOfferStructure

For a description of this response message, see the following table.

Node	Description	Type
RAFProductOfferStructureIO	The output message has a hierarchy that contains details from the product offer header and all child details of the specified offer. Child objects include: Product Offer E and C Product Offer Recommendations Product Offer Responses Product Offer Actions Product Offer Parameters Product Offer Messages	Integration object

Request Message Description: GetRecommendedOffers

For a description of this request message, see the following table.

Node	Description	Type
Account Id	Required. The account ID of the offer that has been queried.	String
DocId	Optional. Values can be Asset ID, Open Order ID or Open Quote ID for the recommended offer that has been queried.	String
Mode	Value can be Asset, Order, or Quote. Mode is required when document ID is specified.	String

For a description of this response message, see the following table.

Node	Description	Type
RAFProductOfferRecommendationsIO	The output message contains a list of all the product offers recommended for the Account, or the document details that were part of the request message. The response message contains a hierarchy message which contains details of the product offer.	Integration object

For a description of this request message, see the following table.

Node	Description	Type
Offer Id	Required. The offer ID that has to be applied.	String
Response	Required. Values can include, Accept, Reject and so on. You must provide the language independent code	String
Account Id	Required. The account on which the offer will be applied.	String
Document Id	Asset ID or order ID on which the offer will be applied.	String
Mode	The asset, or order. This supports the apply offer operations on an open order.	String
SaveInstanceFlag	Possible values are Y or N. If set to Y, then the order is saved to the database. If set to N, then the order persists in memory. The default setting is Y.	String
ReturnFullInstanceFlag	Possible values are Y or N. If set to Y, then the detailed order structure is returned in the response message. If set to N, then only the order is returned. The default setting is Y.	String
RAFActionListIO	Action List is required when the product offer includes user input details. Run-time values that have user input information are provided in the request message. This includes the action details and parameters for that action.	Integration object

For a description of this response message, see the following table.

Node	Description	Type
PDSOrder	The order document structure that has been created. This field is populated when the ReturnFullInstanceFlag is set to Y.	Integration object
Order Id	The order ID after the offer has been applied. This field is populated when the SaveInstanceFlag is set to Y.	String
Order Number	The order number after the offer has been applied. This field is populated when the SaveInstanceFlag is set to Y.	String

For a description of this request message, see the following table.

Node	Description	Type
Offer Id	Required. The offer ID that has to be applied.	String
Response	Required. Values can include, Accept, Reject and so on. You must provide the language independent code.	String
Account Id	Required. The account on which the offer will be applied.	String
Document Id	Asset ID or order ID on which the offer will be applied.	String
Mode	The asset, or order. This supports the Apply Offer operations on an open order.	String
SaveInstanceFlag	Possible values are Y or N. If set to Y, then the order is saved to the database. If set to N, then the order persists in memory. The default setting is Y.	String
ReturnFullInstanceFlag	Possible values are Y or N. If set to Y, then the detailed order structure is returned in the response message. If set to N, then only the order is returned. The default setting is Y.	String
RAFActionListIO	Action list is required when the product offer includes user input details. Run-time values that have user input information are provided in the request message. This includes the action details and parameters for that action.	Integration object

For a description of this response message, see the following table.

Node	Description	Type
PDSQuote	The quote document structure that has been created. This field is populated when the ReturnFullInstanceFlag is set to Y.	Integration object
Quote Id	The quote ID after the offer has been applied. This field is populated when the SaveInstanceFlag is set to Y.	String
Quote Number	The quote number after the offer has been applied. This field is populated when the SaveInstanceFlag is set to Y.	String