The All Product Collection type provides a comprehensive search across all products in the catalog. It’s ideal for retrieving all products.
Unlike Category and Brand collections, the All Product collection does not require or use the cf parameter.
If the cf parameter is included in a request, the API will return a validation error, preventing the request from being processed.
If the cf parameter is included in a request, the API will return a validation error, preventing the request from being processed.
Merchandising rules cannot be applied to the All Product Collection.
Validation Exception
| Type | Definition | HTTP Code |
|---|---|---|
| InvalidCollectionFilter | cf parameter must not be provided in the request. | 400 |
Request Parameters
The type path variable value must exactly match the example values provided in the request parameter table.
| Parameter | Description | Data Type | Required | Example |
|---|---|---|---|---|
| type | Path variable that specifies the desired product listing type | String | Yes | "AllProducts" |
| p | Partner ID. Navigate to InOne > Inone Settings > Account Preferences to copy your Partner ID. | String | Yes | |
| l | Locale is required to get your products in the current language of the website. E.g. en_US, en_GB | String | Yes | l=en_US |
| c | Products will be displayed in the given currency (The current currency selected by the end-user on your website). E.g., USD | String | Yes | c=USD |
| a | Filter the products with the following pattern: a={field}~{value} | List of String | No | a=size~38~39 |
| pf | Index indicating from which order the products will start to be listed. It is used for pagination. The default value is pf=0. | Integer | No | |
| ps | Number of products that will be returned in the response. The default value is ps=6. | Integer | No | |
| st | Sorting type of the listed products. It only takes one of the predefined sorting types. The default value is st=Relevancy. | String | No | |
| oi | The listed products will only be displayed as item IDs. The default value is oi=False | Boolean | No | |
| oc | The listed products will be displayed without their variants. The default value is false. | Boolean | No | |
| u | User ID can be found in local storage by the key name spUID. spUID, which is a stringified object and contains data and expired properties. | String | No |