Retrieving Catalog Data Using the Public Catalogs API

Use this procedure to have your application retrieve data related to catalog items, filter facets, and matching search suggestions in public catalogs from suppliers on SAP Business Network.

Context

Procedure

  1. A user in the process of searching for some items to purchase, enters relevant text in the search box.
  2. The client application initiates the typeahead search feature and requests the list of matching search suggestions using the GET /Shops({shopID})/AutoComplete. 
    GET {{runtime-URL}}/Shops({ShopID})/AutoComplete?$search={searchterm}

    The response includes the list of matching search suggestions.

  3. A user selects one of the search suggestions or enters a different search term.
  4. The client application requests all the items that match the search term and the related facets using the GET /Shops({shopID}). 
    GET {{runtime-URL}}/Shops({shopID})?$expand=Items,Facets

    The response includes the list of items that match the search term and the related facets.

  5. The user clicks on one the items to view its details.
  6. The client application requests the details of the item using the GET /Shops({shopID})/Items. 
    GET {{runtime-URL}}/Shops({shopID})/Items?$search={searchterm}&$select={List}
    $select
    The information that needs to be returned. The following values are supported:

    • extProductId

    • leadTime

    • manufactCode

    • manufactName

    • price

    • vendor

    • vendorName

    • vendorPartId

    $search
    The search terms entered by the user to search for items.

    The response includes all the details of the item.