Show TOC

Background documentationSearch Catalog Web Service

 

Your partner uses the search catalog Web service (SearchCatalogItem) to extend their search feature to include your products in their search results. Your partner can then perform a product catalog search and retrieve a list of items.

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.

Features

  • searchTerm

    Your partner can enter a search term to search for items in your product catalog.

  • areaKey

    Your partner can perform a catalog search limited to a specific area if the areaSearch parameter is set to True.

  • locData

    Your partner can search for items in your product catalog by using an item characteristic value.

  • startIdx; endIdx

    Your partner can limit the number of items retrieved by the Web service by entering a range. The startIdx parameter represents the beginning of the range and the endIdx parameter represents the end of the range.

  • Your partner can make simple and complex search requests against your published product catalog. Note that your partner can submit a complex search request by combining lists of characteristic values (locData) in a comma delimited format.

  • Your partner can create fuzzy searches with the wildcard characters (?) and (*).

  • When your partner calls the SearchCatalogItem Web service, it returns the search result as an XML file. This XML file includes the most important information about the search result items, including the descriptions, prices, and links to the item thumbnails. The information in the XML file represents the same search result information as displayed by the Web application in a Web browser.

Result

The result of this Web service search is the same as an identical search using the Web shop running on top of the product catalog Web application.