Catalog
Search
This endpoint allows the user to search our item catalog.
URLhttps://api.getquipt.com/v2/catalog/{pageSize}/{pageNumber}
Methodget
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
| {pageSize} | The maximum number of records to return. The maximum value is 200. | Int | Yes |
| {pageNumber} | The page to retrieve. | String | No |
| &include | A comma separated list of properties to include with result. Valid options are Conditions and Facets. | String | No |
| &keywords | Search terms to locate a matching item. | String | No |
| &categories | Comma separated list of categories. | String | No |
| &manufacturers | Comma separated list of manufacturers. | String | No |
| &brands | Comma separated list of brands. | String | No |
| &attribute |
Comma separated list of valuess. | String | No |
Sample Requests:
|
1 |
GET https://api.getquipt.com/v2/catalog/100/1?include=conditions&keywords=iphone+11+pro |
|
1 |
GET https://api.getquipt.com/v2/catalog/100/1?include=conditions&manufacturers=apple,dell&keywords=laptop |
|
1 |
GET https://api.getquipt.com/v2/catalog/100/1?include=conditions&keywords=iphone&attributeSCRNSIZE=6.1&attributeSTORSIZE=256 |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| Result | The collection of items. | CatalogResult[] |
| TransactionId | The transaction id for the request. | String |
| TransactionTime | The time the transaction took place. | DateTime |
| Success | Whether or not the transaction was successful | Boolean |
| Messages | One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. | Message[] |