Items Available to the Item Search API

This topic applies to

Applies to

Commerce Web Stores | SuiteCommerce InStore

 

The Item Search API returns data from all item records that have been indexed. For more information about the search index, see Search Index Overview.

The Item Search API returns the items depending on the item availability in a given subsidiary at the time of indexing. Therefore, items are retuned only if the following conditions are met:

  • If the Subsidiaries feature is enabled for your account, the item should be associated with a subsidiary that is online in the website.

  • The item should be associated with an income account. For more information, see the help topic Entering Accounting Information on Items.

  • The Display in Web Site box should be selected on the item record.

  • The Inactive box should not be selected on the item record.

  • The item should be assigned to a Site Builder Category or a Commerce Category, or the Show Uncategorized Items box should be selected on the Web Site Setup page. For more information, see Search Index Settings.

  • The item should be in stock, or the selected Out of Stock Behavior option should display the item even when out of stock.

  • The item type should not be Other Charge Item or Discount Item. For more information, see the help topic Item Types.

  • The item price should be a numeric value. For example, some item types such as Discounts can have prices in percentage (10% off instead of $10 off).

Note

All item records flagged to display in the web site are accessible to the Item Search API. Since the Item Search API does not provide any authentication, the data retrieved by this service is exposed to public traffic on the internet.


Important

If you are using an earlier release of SuiteCommerce Advanced, you require a patch to ensure that the Item Search API response is cached in the CDN. For more information, see Item Search API Response Data not Cached.