Get Product Information Service

This service gives the product ID, relationships, attributes, and so on when requesting product information. It also gets the information present in the product model for the product.

You can search for a product by the following information:

  • Product ID
  • Record Type
  • Record Subtype
  • Segment
  • Category

The engine then provides all the products that fit the search criteria.

Get Product Information Request

Get Product Information Request Details
Element Name Element Type Description
BusinessTransactionID String

(Optional)

Used for the upstream web services to correlate a response with the appropriate request.
Query String

(Optional)

You have a choice: products can either be retrieved by specifying a query or by explicitly the product IDs.
IDList

IDList

(Optional)

You have a choice: Products can either be retrieved by specifying a query or by explicitly the product IDs.

Get Product Information Request Query Details
Element Name Element Type Description
Class

String

(Optional)

If one or more class values are included in the request, products in the eligible product list are filtered after the expansion to include AutoProvision and Non Mandatory children. This means that all of the products in the eligible product list that meets the filtering criteria are returned. Class is compared to the configured record type of the product.
Note: Multiple subclasses result in a union of all products having one of the provided classes.
SubClass

String

(Optional)

If one or more subclasses are included in the request, the products in the eligible product list are filtered while expansion includes AutoProvision and Non Mandatory children. This means that all the products in the eligible product list that meet the filtering criteria, plus any children or children of children are returned. The subclass is compared to the configured RecordSubType of the Product.

Note: Multiple subclasses results in a union of all products having one of the provided subclasses.

Category

String

(Optional)

If one or more categories are included in the request, the products in the eligible product list are filtered for these categories. If you provide multiple categories, an intersection of the results for each category is presented.

If one auto-provisioned child is not compatible with a category, the parent is not either.

Segment Boolean

(Optional)

Information is used to derive the initial list of eligible products. Per segment type, a segment element and all related segments must be mapped as names.

If multiple segments are provided for a SegmentType, the union of all associated products is returned. Multiple SegmentTypes returns an intersection of all products compatible with all SegmentTypes.

Get Product Information Response

Get Product Information Response Details
Element Name Element Type Description
BusinessTransactionID String

(Optional)

If provided, it is passed through from the request and can be used to correlate service calls across disparate services to track actual business process flows in the system.

Get Product Information Result Status Details

This class is a result structure common for all operations. For any operation, the reply schema contains this mandatory object. It specifies if the service execution succeeded or failed. Any client of an operation must first check the value of the code field to identify if the execution was successful or not.

 
Element Name Element Type Description
Component String

(Optional)

The name of the service is Product Information.
Operation String

(Optional)

The name of the operation is Product Information.
Severity String

(Optional)

The possible values are as follows:
S = for success
ERROR = for error
Code String

(Optional)

The error code is the string that identifies the error and the TIBCO Fulfillment Orchestration Suite component that produced the error. An error code of 0 (zero) indicates a successful invocation of the service.
Message String

(Optional)

A descriptive text string associated with the code.

 

Get Product Information Element Details
Element Name Description
Product/ProductID The ID of the product that is configured in the catalog.

Product/ ProductType

The class or type of product that is configured in the catalog.

Product / ProductName

The product's name that is configured in the catalog.

Product / Description

The description of the product that is configured in the catalog.
Note: The long description is not returned by this service.
Product/Characteristic The characteristics of the product.
Characteristic Element Details
Element Name Description
Name The ProductID of the characteristic.

Values/Value/Value

The value of the characteristic. The optional DefaultValue is configured to show the DefaultValue of the Characteristic. If the RelationshipValue is configured in the Characteristic relationship, this value shows, and Value and the Characteristic's DefaultValue shows as DefaultValue. If no relationship value is configured, Value and DefaultValue are the same.

Values/Value/ValueType

The product's name that is configured in the catalog.

Product / Description

The valueType of the Characteristic.