Show TOC

Background documentationRead Catalog Item Details Web Service

 

Your partner uses the read catalog item details Web service (GetItemDetails) to retrieve all details of a particular product catalog item that are available in the published product catalog.

Prerequisites

  • scenarioXCM

    Your partner has entered the application configuration to be used for the Web catalog access.

  • shopId

    Your partner has entered the Web shop ID.

  • areaKey

    Your partner has entered a specific product catalog area. The Web service retrieves item details from this area.

  • itemKey

    Your partner has entered the item GUID. The Web service retrieves this item.

Features

  • returnCUA

    If your partner sets this parameter to True, the Web service returns cross-selling and up-selling items, and accessories for the requested item.

  • returnATP

    If your partner sets this parameter to True, the Web service returns the result of an availability check (ATP check) for the item. The Web service uses the quantity given in the parameter quantityForATPCheck and the unit of measure (UOM) given in the parameter uomForATPCheck.

  • When your partner calls the GetItemDetails Web service, it returns the published product catalog item details as an XML file. This XML file includes all information available for this item in your published product catalog, including the description, texts, price, links to documents, availability information, cross-selling and up-selling items, and accessories. The information in the XML file represents the same Web catalog item details as displayed by the Web application in a Web browser (on the item details page).

Result

The result of this Web service is similar to what is displayed on the product details page using the Web shop running on top of the product catalog Web application.