CatalogWebService Operations

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

Name Description

GetRelatedPromotions

Retrieves a list of related promotions.

GetRelatedProducts

Retrieves a list of related products.

GetCategory

Retrieves a flat, non-hierarchical list of categories.

UDSPublishCatalog

Publish a category and product catalog with support of pagination and visibility.

Request Message Description: GetRelatedPromotions

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

Name Description Type

PDS Related Promotions Interface

An instance of the integration object PDS Related Promotions Interface.

Integration Object

PricingMode

Y or N (calculates price or not). Optional. The default value is Y.

String

EligibilityMode

0, 1, 2 (eligibility display mode: 0 do not run; 1 run; 2 run but only return eligible products). Optional. The default value is 1.

String

ContextMode

SiebelContext or ExternalContext. Optional. However, you must provide ContextMode to run pricing and eligibility.

String

Context

An instance of the integration object PDS Catalog Context. It either contains SiebelContext or ExternalContext. Optional only if ContextMode is not provided. If ContextMode is provided, then it is required.

Integration Object

Response Message Description: GetRelatedPromotions

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

Name Description Type

PDS Related Promotions Interface

PDS Related Promotions Interface. After running Eligibility and Pricing, the List Price, Net Price, Eligibility status and Eligibility Reason fields will be updated.

Integration Object

Request Message Description: GetRelatedProducts

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

Name Description Type

PDS Related Products Interface

An instance of the integration object PDS Related Products Interface.

Integration Object

PricingMode

Y or N (calculates price or not). Optional. The default value is Y.

String

EligibilityMode

0, 1, 2 (eligibility display mode: 0 do not run; 1 run; 2 run but only return eligible products). Optional. The default value is 1.

String

ContextMode

SiebelContext or ExternalContext. Optional. However, provide ContextMode to run pricing and eligibility.

String

Context

An instance of the integration object PDS Catalog Context. The instance either contains SiebelContext or ExternalContext. Optional only if ContextMode is not provided. If ContextMode is provided, then it is required.

Integration Object

Response Message Description: GetRelatedProducts

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

Name Description Type

PDS Related Products Interface

An instance of the integration object PDS Related Products Interface. After running Eligibility and Pricing, the List Price, Net Price, Eligibility status and Eligibility Reason fields will be updated.

Integration Object

Request Message Description: GetCategory

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

Name Description Type

PDS Category Interface Integration Object

An instance of the integration object PDS Category Interface.

Integration Object

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

Name Description Type

PDS Category Interface Integration Object

An instance of the integration object PDS Category Interface.

Integration Object

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

Name Description Type

SiebelMessageIn

An instance of the integration object PDS UDS Publish Catalog Interface. This is a required input.

Integration Object

PricingMode

Y or N (calculates price or not). Optional. The default value is Y.

String

EligibilityMode

0, 1, 2 (eligibility display mode: 0 do not run; 1 run; 2 run but only return eligible products). Optional. The default value is 1.

String

ContextMode

SiebelContext or ExternalContext. Optional. However, provide ContextMode to run pricing and eligibility.

String

Context

An instance of the integration object PDS Catalog Context. It either contains SiebelContext or ExternalContext. Optional only if ContextMode is not provided. If ContextMode is provided, then it is required.

Integration Object

LOVLanguageMode

LIC, or LDC.

String

ViewMode

Visibility algorithm used in addition to a search specification to determine which records will be retrieved. Catalog or Organization.

String

NamedSearchSpec

Name of a predefined query.

String

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

Name Description Type

SiebelMessageOut

An instance of the integration object PDS UDS Publish Catalog Interface.

Integration Object