getLinkedProducts
- Description
- This inquiry transaction returns all the recorded linked products associated with a given product.
- Web Services
- Operation name: getLinkedProducts
- Example
- Retrieve all links for the Extreme Home Theatre System product.
- Usage information
- The input for this transaction is the product ID of the product
whose links are to be returned.
Links between products are created through the transactions collapseMultipleProducts, splitProduct, and undoCollapseMultipleProducts.
- Using the collapseMultipleProducts transaction, a product link is created between each collapsing product (source products) and the new product created (the target product).
- Using the splitProduct transaction, a product link is created between the product being split (source product) and each of the new products created (target products).
- Using the undoCollapseMultipleProducts transaction, for each of the original source products, a product link is created between the original source product and the newly created clone of the source product.
This transaction supports the Pagination feature.
- Preconditions
- The product record must exist.
- Mandatory input
- ProductId
- Inquiry levels
- Optionally, inquiry levels can be provided in the transaction
request. The inquiry levels control the type and extent of information
returned for the source and target products specified by the product
link record.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.
Note: If the ProductInquiryLevel is 1, 2, 3, or 4, then the product spec values data that is returned is filtered based on the SpecId provided in the request. If SpecId is not specified, then the transaction response returns all product spec value data.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
- The number of links returned is bounded by a configurable LinkDepthNumberLimit. This element limits the number of relationship links (the link depth) that the transaction follows when retrieving the linked products. For example, if Product A is split into two new products, Product B and Product C, then the two new products have a link depth of 1 from Product A. If Product C is then split into two further new products, Product D and Product E, then the two new products have a link depth of 2 from Product A. If Products D and E are consolidated to create a new product called Product F, then this new product has a link depth of 3 from Product A.
- Request message
- <TCRMTxType> getLinkedProducts
<TCRMTxObject> LinkedProductsRequestBObj
<TCRMObject> LinkedProductsRequestBObj
with:- ProductId
- ProductsRequestBObj (inquiry levels)
- Response objects
- MultipleProductLinksBObj with a list of ProductBObj objects based on inquiry levels
- Special note
- Not applicable