Show TOC

Background documentationRead Catalog Hierarchy Web Service

 

Your partner uses the read catalog hierarchy Web Service (GetCatalogAreaHierarchy) to read the complete product catalog hierarchy of your published product catalog.

Prerequisites

The following are mandatory parameters:

  • scenarioXCM

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

  • shopId

    Your partner has entered the Web shop ID.

The following parameters are used only in the business-to-business (B2B) scenario:

  • soldToId

    If your partner’s user is assigned to more than one ID, then your partner has entered an ID to retrieve the specific catalog information. Note that the selection of ID is relevant to pricing.

  • user

    Your partner uses this B2B user to access your Web catalog.

  • password

    Your partner uses this password for the B2B user above.

Features

  • Your partner can retrieve all product catalog areas, their descriptions, and the hierarchical dependencies between the product catalog areas.

  • Your partner can use this Web service to initially create the navigation structure in the external application that uses the Web catalog. The Web service returns a list of catalog areas with globally unique identifiers (GUID) and descriptions. Each areaKey field has a reference to a parentAreaKey field. If this field is empty, the area can be considered one of the root areas.

  • When your partner calls the GetCatalogAreaHierarchy Web service, it returns the published product catalog hierarchy as an XML file. This XML file includes information about area descriptions and superordinate areas and represents the same product catalog hierarchy as displayed by the Web application in a Web browser. The following figure depicts the concepts described above:

Result

This Web service retrieves the complete product catalog hierarchy of a specific Web shop. The Web service call can be easily mapped to the product catalog shown in the Web shop of the catalog Web application.