Show TOC

Background documentationRead Catalog Area Item List Web Service

 

Your partner uses the read catalog area item list Web service (GetCatalogArea) to retrieve all important information available for a specific product catalog area.

Prerequisites

  • scenarioXCM

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

  • shopId

    Your partner has entered the Web shop ID.

  • areaId

    Your partner has entered an area ID. The Web service retrieves information from this area.

Features

  • returnAreaLocs

    Your partner can retrieve the list of item characteristics used in this product catalog area.

  • returnPrices

    Your partner can retrieve prices for items contained in this product catalog area.

  • Your partner can retrieve the area description, texts, images, and a list of the area items (including important information about each area item).

  • Your partner can use the Web service to request a list of area item characteristics. Your partner can use these characteristics to search for a particular item using the SearchCatalogItem Web service. For more information, see Search Catalog Web Service.

  • Your partner can request that the Web service retrieve prices for all items in the product catalog area. If list prices are enabled, the system uses the Internet Pricing and Configurator (IPC) only for configurable products. However, if the IPC is enabled, the additional load slows the Web service response.

  • When your partner calls the GetCatalogArea Web service, it returns the published product catalog area as an XML file. This XML file includes area item descriptions, prices, and links to thumbnails. The information in the XML file represents the same Web catalog area as displayed by the Web application in a Web browser. Whenever a list of catalog characteristics (LOCs) is returned, the list of fixed LOC values is also returned to fill potential dropdown boxes. The following figure depicts the concepts described above:

Result

This Web service returns all important information about a requested catalog area. Additional information about each item of the catalog area can be retrieved by calling the read catalog item details Web service. For more information, see Read Catalog Item Details Web Service.