getServiceProduct

Description
This inquiry transaction returns the details of an existing service product.
Web Services
Operation name: getServiceProduct
Service name: ProductService
Example
Retrieve the details of the Deposit Box Rental service product.
Usage information
The input for this transaction is the ProductId of the product instance being queried and a ProductInquiryLevel.

The inquiry level controls the type and extent of information returned for the service product being queried.

A separate inquiry level, RelatedProductInquiryLevel, controls whether closely related products are returned for the product instance being queried. This related products inquiry level is only applicable if:
  • The requested product is a bundle that has bundle components.

    or

  • The requested product is a root product that has variants.

If RelatedProductInquiryLevel is not provided, then no closely related products are returned in the transaction response.

This transaction can also return localized content. The request header (DWLControl element) contains the localization parameter, InquiryLanguage. The values for InquiryLanguage must correspond to either LanguageType or Locale, as defined in the CDLANGTP code table. Each request can include one or more InquiryLanguage elements, enabling you to retrieve localized content for all desired locales.

Preconditions
Not applicable
Mandatory input
  • ProductId
  • ProductInquiryLevel
Inquiry levels
ProductInquiryLevel:
  • Level 0 - returns only product information.
  • Level 1 - returns level 0 data plus product spec value details, optionally filtered by SpecId.
  • Level 2 - returns level 1 data plus product identifiers.
  • Level 3 - returns level 2 data plus product relationship information and product category associations.
    Note: Category information is based on the CategoryInquiryLevel value.
  • Level 4 - returns level 3 data plus product term condition information.
CategoryInquiryLevel:
Important: CategoryInquiryLevel is only applicable when the ProductInquiryLevel >= 3.
  • Level 0 - returns category information plus category entity spec uses.
  • Level 1 - returns level 0 data plus category relationship information.
RelatedProductInquiryLevel:
  • Level 0 - returns Product data of the related products and, if applicable, product relationships between each related product and the requested product.
    • If the requested product is a bundle (a product with a product structure type of Bundle), then each of the bundle components and their product relationships with the bundle are returned.
    • If the requested product is a stand-alone root product (a product with the VariantAllowedIndicator not set to N), then the variant products are returned.
    • If the requested product is a root product and it is also a bundle, then the product's bundle components and variant products are returned along with the appropriate product relationships.
    • In addition, the system recursively retrieves closely related products for each related bundle or variant product that it returns. So if the product is a bundle, the system returns all of its bundle components, and if the related product is a variant, then the system returns its root product. However, if the related product is a root product, its variants are not returned. Variants are returned only if the main requested product is a root product and the RelatedProductInquiryLevel is 0 or greater.
  • Level 1 - returns level 0 data plus all product spec value data for each related product. If spec IDs are provided in the request, they are only filtered for the main requested product. The spec IDs in the request are not filtered for the returned related products.
  • Level 2 - returns level 1 data plus product identifier data for each related product.
  • Level 3 - returns level 2 data plus product relationship data and product category association data for each related product. Additional category information is returned based on the CategoryInquiryLevel.
  • Level 4 - returns level 3 data plus product term condition data for each related product.
Attention: A customized inquiry level must be used to return product equivalency information.
Filter values
Not applicable
Transaction behavior
When the ProductInquiryLevel is >= 1, the product spec values data that is returned is based on the SpecId provided. If the SpecId is not specified, then all product spec value data are returned.

This transaction only returns product spec values whose spec can be accessed by the product, either through its product type or active product category associations, and where the spec usages are active.

When the requested product is a variant, then the root product is always returned, regardless of whether the RelatedProductInquiryLevel is provided in the request. The amount of data returned for the root product is governed by the main ProductInquiryLevel, and not by the RelatedProductInquiryLevel.

This transaction returns only active records for the following business objects:
This transaction returns active and inactive records for the following business objects:
Request message
<TCRMTxType> getServiceProduct

<TCRMTxObject> ProductRequestBObj

<TCRMObject> ProductRequestBObj

Response objects
Product data based on the inquiry levels.
ProductInquiryLevel:
CategoryInquiryLevel:

RelatedProductInquiryLevel:

If the optional InquiryLanguage element is provided in the request header, the business objects for localized content are also returned:
Special note
Not applicable