Item Search API Input Parameters

The Item Search API Input Parameters are used to construct query strings that return item record attributes in a JSON response. To create a query string for the Item Search API, we should use the input parameters with the base.
URL: http://www.mywebstore.com/api/items?{parameters}.

We can also use multiple parameters with the base URL by separating them with an ampersand (&).

The base URL when used without any parameters retrieves the item IDs of all the items. To retrieve only the desired items and item details, we can specify the following input parameters:

Parameters Usage 
c n region Retrieve Items by NetSuite Account Number, Commerce Site ID, Subsidiary ID 
id Retrieve Items by Item ID 
url Retrieve Items by Item URL 
Retrieve Items by Keyword Search 
commercecategoryid 
commercecategoryurl 
commercecategoryname 
Retrieve Items by Commerce Categories 
use_pcv pcv_entity pcv_groups Retrieve Items from Personalized Catalog for a specific customer or one or more customer groups 
fields fieldset Retrieve Additional Item Details 
matrixchilditems_fieldset 
correlateditems_fieldset 
relateditems_fieldset 
Flexibility in Specifying the Field Sets of Related Items 
limit offset Pagination of Query Results 
<field_name> 
<numeric_facet_field_ID>.ranges 
<numeric_facet_field_ID>.from 
<numeric_facet_field_ID>.to 
Facet and Filter Items 
include facet.exclude Include or Exclude Item Attributes 
sort Sort Items 
pricelevel Specify Price Level 
currency Specify Currency 
language country Specify Language and Country 
callback Callback Function 
ssdebug Retrieve Debug Information 

Leave a comment

Your email address will not be published. Required fields are marked *