GetSearchResultsPaged (Method)

Request (GetSearchResultsPagedSoapIn)

The request body is of type GetSearchResultsPaged.

Request Body Parameters

Name	Description	Data Type
SearchString		xml:string
SearchCategoryID		xml:string
IncludeItemsFromAllChildCategories		xml:boolean
IncludeModels		xml:boolean
IncludeStockCodes		xml:boolean
IncludeSKUs		xml:boolean
RowsPerPage		xml:int
PageNumber		xml:int

Example

Javascript

// Example 1: Get serch results paged 
//      searching for 'bike'
//      requesting page 1
//      searching in all categories
MakeAJAXCall('Inventory.GetSearchResultsPaged', {
    SearchString: 'bike',
    SearchCategoryID: PAGE_CATEGORY,
    IncludeItemsFromAllChildCategories: true,
    IncludeModels: false,
    IncludeStockCodes: true,
    IncludeSKUs: false,
    RowsPerPage: -1,
    PageNumber: 1,
}, console.log)

200 Response (GetSearchResultsPagedSoapOut)

The response body is of type GetSearchResultsPagedResponse.

Response Body Parameters

Name	Description	Data Type
GetSearchResultsPagedResult	Example { "Data": [{ "RowNumber": 1, "Item_ID": 5733, "Rank": 96, "StockCode": "DD 1/8\" Aluminum Diamond", "Name": "Tread Plate Sides/Rear Standar", "Headline": "", "SubHeadline": "", "ShortDescription": "", "Link1": "", "Model_ID": 0, "SortOrder": 11096, "LongDescription2": "Product Configurator", "ITM_Item.SortOrder": 0, "CanAddToCart": true }, { "RowNumber": 2, "Item_ID": 5748, "Rank": 96, "StockCode": "CC100", "Name": "Chilli Choc Bars", "Headline": "", "SubHeadline": "", "ShortDescription": "", "Link1": "", "Model_ID": 0, "SortOrder": 11578, "LongDescription2": "By-product", "ITM_Item.SortOrder": 0, "CanAddToCart": true }, { "RowNumber": 3, "Item_ID": 579, "Rank": 64, "StockCode": "A100", "Name": "Boys 15 Speed Mountain Bike", "Headline": "Rulon LR Sleeve Bearing", "SubHeadline": "", "ShortDescription": "", "Link1": "", "Model_ID": 0, "SortOrder": 8, "LongDescription2": "Distribution", "ITM_Item.SortOrder": 2, "CanAddToCart": true }, { "RowNumber": 4, "Item_ID": 605, "Rank": 64, "StockCode": "A130", "Name": "18 Speed Racing Bike Boys", "Headline": "Racing Bike", "SubHeadline": "18 Speed - Boys", "ShortDescription": "Cruise the neighborhood on this stylish, 18-speed comfort bike.", "Link1": "", "Model_ID": 0, "SortOrder": 1250, "LongDescription2": "Distribution/Goods in Transit", "ITM_Item.SortOrder": 4, "CanAddToCart": true }], "Paging": { "CurrentPage": 1, "TotalPages": 21, "TotalResults": 84, "ResultsPerPage": 4 } }	xml:string

Name

Description

Data Type

GetSearchResultsPagedResult

Example

{
    "Data": [{
        "RowNumber": 1,
        "Item_ID": 5733,
        "Rank": 96,
        "StockCode": "DD 1/8\" Aluminum Diamond",
        "Name": "Tread Plate Sides/Rear Standar",
        "Headline": "",
        "SubHeadline": "",
        "ShortDescription": "",
        "Link1": "",
        "Model_ID": 0,
        "SortOrder": 11096,
        "LongDescription2": "Product Configurator",
        "ITM_Item.SortOrder": 0,
        "CanAddToCart": true
    }, {
        "RowNumber": 2,
        "Item_ID": 5748,
        "Rank": 96,
        "StockCode": "CC100",
        "Name": "Chilli Choc Bars",
        "Headline": "",
        "SubHeadline": "",
        "ShortDescription": "",
        "Link1": "",
        "Model_ID": 0,
        "SortOrder": 11578,
        "LongDescription2": "By-product",
        "ITM_Item.SortOrder": 0,
        "CanAddToCart": true
    }, {
        "RowNumber": 3,
        "Item_ID": 579,
        "Rank": 64,
        "StockCode": "A100",
        "Name": "Boys 15 Speed Mountain Bike",
        "Headline": "Rulon LR Sleeve Bearing",
        "SubHeadline": "",
        "ShortDescription": "",
        "Link1": "",
        "Model_ID": 0,
        "SortOrder": 8,
        "LongDescription2": "Distribution",
        "ITM_Item.SortOrder": 2,
        "CanAddToCart": true
    }, {
        "RowNumber": 4,
        "Item_ID": 605,
        "Rank": 64,
        "StockCode": "A130",
        "Name": "18 Speed Racing Bike Boys",
        "Headline": "Racing Bike",
        "SubHeadline": "18 Speed - Boys",
        "ShortDescription": "Cruise the neighborhood on this stylish, 18-speed comfort bike.",
        "Link1": "",
        "Model_ID": 0,
        "SortOrder": 1250,
        "LongDescription2": "Distribution/Goods in Transit",
        "ITM_Item.SortOrder": 4,
        "CanAddToCart": true
    }],
    "Paging": {
        "CurrentPage": 1,
        "TotalPages": 21,
        "TotalResults": 84,
        "ResultsPerPage": 4
    }
}

xml:string