Search
This section covers Search API endpoints allowing you to browse / search through products based on different criteria.
The following UI in the PIM is developed using this search API itself.
GET /api/v1/search/all
This endpoint is used to get all the products available for the organization.
Request Parameters
Name Type Description page int Number of the page from the paginated result set, by default it is 1 pagesize int How many records to be displayed in a page, by default it is 10
Sample Request
Request GET
/api/v1/search/all?page=1&pagesize=20 curl --location '<api_url>/api/v1/search/all?page=1&pagesize=20' \
--header 'Accept: text/plain' \
--header 'Authorization:{{api-key}}'
CopyCopied!
Response Model
Response {
"statusCode" : 100 ,
"status" : "string" ,
"error" : "string" ,
"errorId" : "string" ,
"message" : "string" ,
"messageCode" : "string" ,
"result" : [
{
"productId" : "3fa85f64-5717-4562-b3fc-2c963f66afa6" ,
"productIId" : 0 ,
"stockCode" : "string" ,
"name" : "string" ,
"categoryName" : "string" ,
"brandName" : "string" ,
"image" : "string" ,
"inventory" : 0 ,
"sellPrice" : 0 ,
"costPrice" : 0 ,
"currency" : "string" ,
"status" : 0 ,
"published" : "2023-08-14T11:09:12.974Z" ,
"lastUpdated" : "2023-08-14T11:09:12.974Z" ,
"currencySymbol" : "string" ,
"sku" : "string"
}
] ,
"totalRecords" : 0
}
CopyCopied!
Name Type Description status string Holds the status name related to the status code error string details of the error if any errorId string error code if any error in the process message string message to display on front end if any in case of errors/success messageCode string Response message code totalRecords int Total Number of products in result set result object contains the result object can be array of objects or specific object result.productId Guid Unique id of the product result.productIId int unique numeric id of the product result.stockCode string Unique stock code of the Product result.name string Product Name result.categoryName string Name of the Category this product belongs to result.brandName string name of the manufacturer this product belongs to result.image string Product Image URL result.inventory int Product Inventory result.sellPrice decimal Product Sell Price result.costPrice decimal Product Cost Price result.currency string Currency of the Price result.status int Status of the product result.published DateTime DateTime the product is published result.lastUpdated DateTime DateTime the product is last updated result.currencySymbol string Symbol of the currency
POST /api/v1/search/advanced
This endpoint is used to query the products based on any or a combination of multiple properties - like category, brand,
season, status, tag, Channel, StockCode, ItemType, StockAvailability, productName, freetext, etc.
Request Parameters
Name Type Description page int Number of the page from the paginated result set, by default it is 1 pagesize int How many records to be displayed in a page, by default it is 10 categoryId string Unique Guid of the Category brandId string Unique Guid of the brand collectionId string Unique Guid of the Collection vendorId string Unique Guid of the Vendor createdId string Unique Guid of the Created lastUpdatedId string Unique Guid of the LastUpdated seasonCode string Unique Guid of the Season status int Unique integer status id tag string Unique Guid of the tag channel string Unique Guid of the channel lifecycle string Unique Guid of the lifecycle stockCode string Unique identifier stock code of the product itemType integer itemType of the product stockAvailability integer Product stock as number manufacturer string Unique Guid of the brand productName string name of the product freeText string a string value to compare against product name, stockcode, category...etc
Sample Request
Request POST
/api/v1/search/advanced?page=1&pagesize=20 curl --location '<api_url>/api/v1/search/advanced?page=1&pagesize=20' \
--header 'Content-Type: application/json' \
--header 'Accept: text/plain' \
--header 'Authorization:{{api-key}}'
\
--data '{
"categoryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"brandId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"collectionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"vendorId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"lastUpdatedId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"seasonCode": "string",
"status": 0,
"tag": "string",
"channel": "string",
"lifecycle": "string",
"stockCode": "string",
"itemType": 0,
"stockAvailability": 0,
"manufacturer": "string",
"productName": "string",
"freeText": "string"
}'
CopyCopied!
Response Model
Response {
"statusCode" : 100 ,
"status" : "string" ,
"error" : "string" ,
"errorId" : "string" ,
"message" : "string" ,
"messageCode" : "string" ,
"result" : [
{
"productId" : "3fa85f64-5717-4562-b3fc-2c963f66afa6" ,
"productIId" : 0 ,
"stockCode" : "string" ,
"name" : "string" ,
"categoryName" : "string" ,
"brandName" : "string" ,
"image" : "string" ,
"inventory" : 0 ,
"sellPrice" : 0 ,
"costPrice" : 0 ,
"currency" : "string" ,
"status" : 0 ,
"published" : "2023-08-14T11:08:38.359Z" ,
"lastUpdated" : "2023-08-14T11:08:38.359Z" ,
"currencySymbol" : "string" ,
"sku" : "string"
}
] ,
"totalRecords" : 0
}
CopyCopied!
Name Type Description status string Holds the status name related to the status code error string details of the error if any errorId string error code if any error in the process message string message to display on front end if any in case of errors/success messageCode string Response message code totalRecords int Total Number of products in result set result object contains the result object can be array of objects or specific object result.productId Guid Unique id of the product result.productIId int unique numeric id of the product result.stockCode string Unique stock code of the Product result.name string Product Name result.categoryName string Name of the Category this product belongs to result.brandName string name of the manufacturer this product belongs to result.image string Product Image URL result.inventory int Product Inventory result.sellPrice decimal Product Sell Price result.costPrice decimal Product Cost Price result.currency string Currency of the Price result.status int Status of the product result.published DateTime DateTime the product is published result.lastUpdated DateTime DateTime the product is last updated result.currencySymbol string Symbol of the currency
GET /api/v1/search/by-category/{id}
This endpoint is used to query the products based on a specific Category or sub category, by providing the
unique Guid of the specific Category or sub category as an input.
Request Parameters
Name Type Description id string Unique Guid of the Category or sub category page int Number of the page from the paginated result set, by default it is 1 pagesize int How many records to be displayed in a page, by default it is 10
Sample Request
Request GET
/api/v1/search/by-category/:id?page=1&pagesize=20 curl --location '<api_url>/api/v1/search/by-category/{categoryId}?page=1&pagesize=20' \
--header 'Accept: text/plain' \
--header 'Authorization: bearer {{api-key}}'
CopyCopied!
Response Model
Response {
"statusCode" : 100 ,
"status" : "string" ,
"error" : "string" ,
"errorId" : "string" ,
"message" : "string" ,
"messageCode" : "string" ,
"result" : [
{
"productId" : "3fa85f64-5717-4562-b3fc-2c963f66afa6" ,
"productIId" : 0 ,
"stockCode" : "string" ,
"name" : "string" ,
"categoryName" : "string" ,
"brandName" : "string" ,
"image" : "string" ,
"inventory" : 0 ,
"sellPrice" : 0 ,
"costPrice" : 0 ,
"currency" : "string" ,
"status" : 0 ,
"published" : "2023-08-14T11:04:50.071Z" ,
"lastUpdated" : "2023-08-14T11:04:50.071Z" ,
"currencySymbol" : "string" ,
"sku" : "string"
}
] ,
"totalRecords" : 0
}
CopyCopied!
Name Type Description status string Holds the status name related to the status code error string details of the error if any errorId string error code if any error in the process message string message to display on front end if any in case of errors/success messageCode string Response message code totalRecords int Total Number of products in result set result object contains the result object can be array of objects or specific object result.productId Guid Unique id of the product result.productIId int unique numeric id of the product result.stockCode string Unique stock code of the Product result.name string Product Name result.categoryName string Name of the Category this product belongs to result.brandName string name of the manufacturer this product belongs to result.image string Product Image URL result.inventory int Product Inventory result.sellPrice decimal Product Sell Price result.costPrice decimal Product Cost Price result.currency string Currency of the Price result.status int Status of the product result.published DateTime DateTime the product is published result.lastUpdated DateTime DateTime the product is last updated result.currencySymbol string Symbol of the currency
GET /api/v1/search/by-brand/{id}
This endpoint is used to query the products based on a specific brand or sub brand, by providing the
unique Guid of the specific brand or sub brand as an input.
Request Parameters
Name Type Description id string Unique Guid of the brand or sub brand page int Number of the page from the paginated result set, by default it is 1 pagesize int How many records to be displayed in a page, by default it is 10
Sample Request
Request GET
/api/v1/search/by-brand/:id?page=1&pagesize=20 curl --location '<api_url>/api/v1/search/by-brand/{brandId}?page=1&pagesize=20' \
--header 'Accept: text/plain' \
--header 'Authorization: bearer {{api-key}}'
CopyCopied!
Response Model
Response {
"statusCode" : 100 ,
"status" : "string" ,
"error" : "string" ,
"errorId" : "string" ,
"message" : "string" ,
"messageCode" : "string" ,
"result" : [
{
"productId" : "3fa85f64-5717-4562-b3fc-2c963f66afa6" ,
"productIId" : 0 ,
"stockCode" : "string" ,
"name" : "string" ,
"categoryName" : "string" ,
"brandName" : "string" ,
"image" : "string" ,
"inventory" : 0 ,
"sellPrice" : 0 ,
"costPrice" : 0 ,
"currency" : "string" ,
"status" : 0 ,
"published" : "2023-08-14T11:05:24.786Z" ,
"lastUpdated" : "2023-08-14T11:05:24.786Z" ,
"currencySymbol" : "string" ,
"sku" : "string"
}
] ,
"totalRecords" : 0
}
CopyCopied!
Name Type Description status string Holds the status name related to the status code error string details of the error if any errorId string error code if any error in the process message string message to display on front end if any in case of errors/success messageCode string Response message code totalRecords int Total Number of products in result set result object contains the result object can be array of objects or specific object result.productId Guid Unique id of the product result.productIId int unique numeric id of the product result.stockCode string Unique stock code of the Product result.name string Product Name result.categoryName string Name of the Category this product belongs to result.brandName string name of the manufacturer this product belongs to result.image string Product Image URL result.inventory int Product Inventory result.sellPrice decimal Product Sell Price result.costPrice decimal Product Cost Price result.currency string Currency of the Price result.status int Status of the product result.published DateTime DateTime the product is published result.lastUpdated DateTime DateTime the product is last updated result.currencySymbol string Symbol of the currency
GET /api/v1/search/by-collection/{id}
This endpoint is used to query the products based on a specific product collection, by providing the
unique Guid of the collection as an input.
Request Parameters
Name Type Description id string Unique Guid of the collection page int Number of the page from the paginated result set, by default it is 1 pagesize int How many records to be displayed in a page, by default it is 10
Sample Request
Request GET
/api/v1/search/by-collection/:id?page=1&pagesize=20 curl --location '<api_url>/api/v1/search/by-collection/{collectionId}?page=1&pagesize=20' \
--header 'Accept: text/plain' \
--header 'Authorization:{{api-key}}'
CopyCopied!
Response Model
Response {
"statusCode" : 100 ,
"status" : "string" ,
"error" : "string" ,
"errorId" : "string" ,
"message" : "string" ,
"messageCode" : "string" ,
"result" : [
{
"productId" : "3fa85f64-5717-4562-b3fc-2c963f66afa6" ,
"productIId" : 0 ,
"stockCode" : "string" ,
"name" : "string" ,
"categoryName" : "string" ,
"brandName" : "string" ,
"image" : "string" ,
"inventory" : 0 ,
"sellPrice" : 0 ,
"costPrice" : 0 ,
"currency" : "string" ,
"status" : 0 ,
"published" : "2023-08-14T11:05:50.105Z" ,
"lastUpdated" : "2023-08-14T11:05:50.105Z" ,
"currencySymbol" : "string" ,
"sku" : "string"
}
] ,
"totalRecords" : 0
}
CopyCopied!
Name Type Description status string Holds the status name related to the status code error string details of the error if any errorId string error code if any error in the process message string message to display on front end if any in case of errors/success messageCode string Response message code totalRecords int Total Number of products in result set result object contains the result object can be array of objects or specific object result.productId Guid Unique id of the product result.productIId int unique numeric id of the product result.stockCode string Unique stock code of the Product result.name string Product Name result.categoryName string Name of the Category this product belongs to result.brandName string name of the manufacturer this product belongs to result.image string Product Image URL result.inventory int Product Inventory result.sellPrice decimal Product Sell Price result.costPrice decimal Product Cost Price result.currency string Currency of the Price result.status int Status of the product result.published DateTime DateTime the product is published result.lastUpdated DateTime DateTime the product is last updated result.currencySymbol string Symbol of the currency
GET /api/v1/search/by-season/{id}
This endpoint is used to query the products based on a specific season, by providing the
unique Guid of the season as an input.
Request Parameters
Name Type Description id string Unique Guid of the season page int Number of the page from the paginated result set, by default it is 1 pagesize int How many records to be displayed in a page, by default it is 10
Sample Request
Request GET
/api/v1/search/by-season/:id?page=1&pagesize=20 curl --location '<api_url>/api/v1/search/by-season/{seasonId}?page=1&pagesize=20' \
--header 'Accept: text/plain' \
--header 'Authorization:{{api-key}}'
CopyCopied!
Response Model
Response {
"statusCode" : 100 ,
"status" : "string" ,
"error" : "string" ,
"errorId" : "string" ,
"message" : "string" ,
"messageCode" : "string" ,
"result" : [
{
"productId" : "3fa85f64-5717-4562-b3fc-2c963f66afa6" ,
"productIId" : 0 ,
"stockCode" : "string" ,
"name" : "string" ,
"categoryName" : "string" ,
"brandName" : "string" ,
"image" : "string" ,
"inventory" : 0 ,
"sellPrice" : 0 ,
"costPrice" : 0 ,
"currency" : "string" ,
"status" : 0 ,
"published" : "2023-08-14T11:06:08.718Z" ,
"lastUpdated" : "2023-08-14T11:06:08.718Z" ,
"currencySymbol" : "string" ,
"sku" : "string"
}
] ,
"totalRecords" : 0
}
CopyCopied!
Name Type Description status string Holds the status name related to the status code error string details of the error if any errorId string error code if any error in the process message string message to display on front end if any in case of errors/success messageCode string Response message code totalRecords int Total Number of products in result set result object contains the result object can be array of objects or specific object result.productId Guid Unique id of the product result.productIId int unique numeric id of the product result.stockCode string Unique stock code of the Product result.name string Product Name result.categoryName string Name of the Category this product belongs to result.brandName string name of the manufacturer this product belongs to result.image string Product Image URL result.inventory int Product Inventory result.sellPrice decimal Product Sell Price result.costPrice decimal Product Cost Price result.currency string Currency of the Price result.status int Status of the product result.published DateTime DateTime the product is published result.lastUpdated DateTime DateTime the product is last updated result.currencySymbol string Symbol of the currency
GET /api/v1/search/by-status/{id}
This endpoint is used to query the products based on a specific status, by providing the
unique id of the status as an input.
Below is list of different status inputs with their specific ids and purpose
Name Id Description All -1 Used when we want products of all status codes None 0 No Status Draft 1 returns products in Draft status Active 2 returns products in Active status Archived 3 returns products that are Archived Discontinued 4 returns products that are discontinued
Request Parameters
Name Type Description id integer Unique integer id of the status page int Number of the page from the paginated result set, by default it is 1 pagesize int How many records to be displayed in a page, by default it is 10
Sample Request
Request GET
/api/v1/search/by-status/:id?page=1&pagesize=20 curl --location '<api_url>/api/v1/search/by-status/-1?page=1&pagesize=20' \
--header 'Accept: text/plain' \
--header 'Authorization:{{api-key}}'
CopyCopied!
Response Model
Response {
"statusCode" : 100 ,
"status" : "string" ,
"error" : "string" ,
"errorId" : "string" ,
"message" : "string" ,
"messageCode" : "string" ,
"result" : [
{
"productId" : "3fa85f64-5717-4562-b3fc-2c963f66afa6" ,
"productIId" : 0 ,
"stockCode" : "string" ,
"name" : "string" ,
"categoryName" : "string" ,
"brandName" : "string" ,
"image" : "string" ,
"inventory" : 0 ,
"sellPrice" : 0 ,
"costPrice" : 0 ,
"currency" : "string" ,
"status" : 0 ,
"published" : "2023-08-14T11:06:25.292Z" ,
"lastUpdated" : "2023-08-14T11:06:25.292Z" ,
"currencySymbol" : "string" ,
"sku" : "string"
}
] ,
"totalRecords" : 0
}
CopyCopied!
Name Type Description status string Holds the status name related to the status code error string details of the error if any errorId string error code if any error in the process message string message to display on front end if any in case of errors/success messageCode string Response message code totalRecords int Total Number of products in result set result object contains the result object can be array of objects or specific object result.productId Guid Unique id of the product result.productIId int unique numeric id of the product result.stockCode string Unique stock code of the Product result.name string Product Name result.categoryName string Name of the Category this product belongs to result.brandName string name of the manufacturer this product belongs to result.image string Product Image URL result.inventory int Product Inventory result.sellPrice decimal Product Sell Price result.costPrice decimal Product Cost Price result.currency string Currency of the Price result.status int Status of the product result.published DateTime DateTime the product is published result.lastUpdated DateTime DateTime the product is last updated result.currencySymbol string Symbol of the currency
GET /api/v1/search/by-tag/{id}
This endpoint is used to query the products based on a specific tag, by providing the
unique Guid of the tag as an input.
Request Parameters
Name Type Description id string Unique Guid of the tag page int Number of the page from the paginated result set, by default it is 1 pagesize int How many records to be displayed in a page, by default it is 10
Sample Request
Request GET
/api/v1/search/by-tag/:id?page=1&pagesize=20 curl --location '<api_url>/api/v1/search/by-tag/<uuid>?page=1&pagesize=20' \
--header 'Accept: text/plain' \
--header 'Authorization:{{api-key}}'
CopyCopied!
Response Model
Response {
"statusCode" : 100 ,
"status" : "string" ,
"error" : "string" ,
"errorId" : "string" ,
"message" : "string" ,
"messageCode" : "string" ,
"result" : [
{
"productId" : "3fa85f64-5717-4562-b3fc-2c963f66afa6" ,
"productIId" : 0 ,
"stockCode" : "string" ,
"name" : "string" ,
"categoryName" : "string" ,
"brandName" : "string" ,
"image" : "string" ,
"inventory" : 0 ,
"sellPrice" : 0 ,
"costPrice" : 0 ,
"currency" : "string" ,
"status" : 0 ,
"published" : "2023-08-14T11:06:40.981Z" ,
"lastUpdated" : "2023-08-14T11:06:40.981Z" ,
"currencySymbol" : "string" ,
"sku" : "string"
}
] ,
"totalRecords" : 0
}
CopyCopied!
Name Type Description status string Holds the status name related to the status code error string details of the error if any errorId string error code if any error in the process message string message to display on front end if any in case of errors/success messageCode string Response message code totalRecords int Total Number of products in result set result object contains the result object can be array of objects or specific object result.productId Guid Unique id of the product result.productIId int unique numeric id of the product result.stockCode string Unique stock code of the Product result.name string Product Name result.categoryName string Name of the Category this product belongs to result.brandName string name of the manufacturer this product belongs to result.image string Product Image URL result.inventory int Product Inventory result.sellPrice decimal Product Sell Price result.costPrice decimal Product Cost Price result.currency string Currency of the Price result.status int Status of the product result.published DateTime DateTime the product is published result.lastUpdated DateTime DateTime the product is last updated result.currencySymbol string Symbol of the currency
GET /api/v1/search/by-vendor/{id}
This endpoint is used to query the products based on a specific Vendor, by providing the
unique Guid of the Vendor as an input.
Request Parameters
Name Type Description id string Unique Guid of the Vendor page int Number of the page from the paginated result set, by default it is 1 pagesize int How many records to be displayed in a page, by default it is 10
Sample Request
Request GET
/api/v1/search/by-vendor/:id?page=1&pagesize=20 curl --location --request GET '<api_url>/api/v1/search/by-vendor/{vendorId}?page=1&pagesize=20' \
--header 'Accept: text/plain' \
--header 'Content-Type: text/plain' \
--header 'Authorization:{{api-key}}'
CopyCopied!
Response Model
Response {
"statusCode" : 100 ,
"status" : "string" ,
"error" : "string" ,
"errorId" : "string" ,
"message" : "string" ,
"messageCode" : "string" ,
"result" : [
{
"productId" : "3fa85f64-5717-4562-b3fc-2c963f66afa6" ,
"productIId" : 0 ,
"stockCode" : "string" ,
"name" : "string" ,
"categoryName" : "string" ,
"brandName" : "string" ,
"image" : "string" ,
"inventory" : 0 ,
"sellPrice" : 0 ,
"costPrice" : 0 ,
"currency" : "string" ,
"status" : 0 ,
"published" : "2023-08-14T11:06:56.395Z" ,
"lastUpdated" : "2023-08-14T11:06:56.395Z" ,
"currencySymbol" : "string" ,
"sku" : "string"
}
] ,
"totalRecords" : 0
}
CopyCopied!
Name Type Description status string Holds the status name related to the status code error string details of the error if any errorId string error code if any error in the process message string message to display on front end if any in case of errors/success messageCode string Response message code totalRecords int Total Number of products in result set result object contains the result object can be array of objects or specific object result.productId Guid Unique id of the product result.productIId int unique numeric id of the product result.stockCode string Unique stock code of the Product result.name string Product Name result.categoryName string Name of the Category this product belongs to result.brandName string name of the manufacturer this product belongs to result.image string Product Image URL result.inventory int Product Inventory result.sellPrice decimal Product Sell Price result.costPrice decimal Product Cost Price result.currency string Currency of the Price result.status int Status of the product result.published DateTime DateTime the product is published result.lastUpdated DateTime DateTime the product is last updated result.currencySymbol string Symbol of the currency
GET /api/v1/search/by-created/{id}
This endpoint is used to query the products based on products created date, by providing specific
time period to check as an input.
Different Time periods available and the details of the same can be retrieved from the taxonomy endpoint for Created time epriods.
Request Parameters
Name Type Description id string Unique Guid of the Created Time period page int Number of the page from the paginated result set, by default it is 1 pagesize int How many records to be displayed in a page, by default it is 10
Sample Request
Request GET
/api/v1/search/by-created/:id?page=1&pagesize=20 curl --location '<api_url>/api/v1/search/by-created/{createdId}?page=1&pagesize=20' \
--header 'Accept: text/plain' \
--header 'Authorization:{{api-key}}'
CopyCopied!
Response Model
Response {
"statusCode" : 100 ,
"status" : "string" ,
"error" : "string" ,
"errorId" : "string" ,
"message" : "string" ,
"messageCode" : "string" ,
"result" : [
{
"productId" : "3fa85f64-5717-4562-b3fc-2c963f66afa6" ,
"productIId" : 0 ,
"stockCode" : "string" ,
"name" : "string" ,
"categoryName" : "string" ,
"brandName" : "string" ,
"image" : "string" ,
"inventory" : 0 ,
"sellPrice" : 0 ,
"costPrice" : 0 ,
"currency" : "string" ,
"status" : 0 ,
"published" : "2023-08-14T11:07:18.365Z" ,
"lastUpdated" : "2023-08-14T11:07:18.365Z" ,
"currencySymbol" : "string" ,
"sku" : "string"
}
] ,
"totalRecords" : 0
}
CopyCopied!
Name Type Description status string Holds the status name related to the status code error string details of the error if any errorId string error code if any error in the process message string message to display on front end if any in case of errors/success messageCode string Response message code totalRecords int Total Number of products in result set result object contains the result object can be array of objects or specific object result.productId Guid Unique id of the product result.productIId int unique numeric id of the product result.stockCode string Unique stock code of the Product result.name string Product Name result.categoryName string Name of the Category this product belongs to result.brandName string name of the manufacturer this product belongs to result.image string Product Image URL result.inventory int Product Inventory result.sellPrice decimal Product Sell Price result.costPrice decimal Product Cost Price result.currency string Currency of the Price result.status int Status of the product result.published DateTime DateTime the product is published result.lastUpdated DateTime DateTime the product is last updated result.currencySymbol string Symbol of the currency
GET /api/v1/search/by-updated/{id}
This endpoint is used to query the products based on products updated date, by providing specific
time period to check as an input.
Different Time periods available and the details of the same can be retrieved from the taxonomy endpoint for Created time epriods.
Request Parameters
Name Type Description id string Unique Guid of the Created Time period page int Number of the page from the paginated result set, by default it is 1 pagesize int How many records to be displayed in a page, by default it is 10
Sample Request
Request GET
/api/v1/search/by-updated/:id?page=1&pagesize=20 curl --location '<api_url>/api/v1/search/by-updated/{lastUpdatedId}?page=1&pagesize=20' \
--header 'Accept: text/plain' \
--header 'Authorization:{{api-key}}'
CopyCopied!
Response Model
Response {
"statusCode" : 100 ,
"status" : "string" ,
"error" : "string" ,
"errorId" : "string" ,
"message" : "string" ,
"messageCode" : "string" ,
"result" : [
{
"productId" : "3fa85f64-5717-4562-b3fc-2c963f66afa6" ,
"productIId" : 0 ,
"stockCode" : "string" ,
"name" : "string" ,
"categoryName" : "string" ,
"brandName" : "string" ,
"image" : "string" ,
"inventory" : 0 ,
"sellPrice" : 0 ,
"costPrice" : 0 ,
"currency" : "string" ,
"status" : 0 ,
"published" : "2023-08-14T11:08:04.151Z" ,
"lastUpdated" : "2023-08-14T11:08:04.151Z" ,
"currencySymbol" : "string" ,
"sku" : "string"
}
] ,
"totalRecords" : 0
}
CopyCopied!
Name Type Description status string Holds the status name related to the status code error string details of the error if any errorId string error code if any error in the process message string message to display on front end if any in case of errors/success messageCode string Response message code totalRecords int Total Number of products in result set result object contains the result object can be array of objects or specific object result.productId Guid Unique id of the product result.productIId int unique numeric id of the product result.stockCode string Unique stock code of the Product result.name string Product Name result.categoryName string Name of the Category this product belongs to result.brandName string name of the manufacturer this product belongs to result.image string Product Image URL result.inventory int Product Inventory result.sellPrice decimal Product Sell Price result.costPrice decimal Product Cost Price result.currency string Currency of the Price result.status int Status of the product result.published DateTime DateTime the product is published result.lastUpdated DateTime DateTime the product is last updated result.currencySymbol string Symbol of the currency