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. Product Search


GET/api/v1/search/all

All

This endpoint is used to get all the products available for the organization.

Request Parameters

NameTypeDescription
pageintNumber of the page from the paginated result set, by default it is 1
pagesizeintHow 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}}' 

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
}
NameTypeDescription
statusstringHolds the status name related to the status code
errorstringdetails of the error if any
errorIdstringerror code if any error in the process
messagestringmessage to display on front end if any in case of errors/success
messageCodestringResponse message code
totalRecordsintTotal Number of products in result set
resultobjectcontains the result object can be array of objects or specific object
result.productIdGuidUnique id of the product
result.productIIdintunique numeric id of the product
result.stockCodestringUnique stock code of the Product
result.namestringProduct Name
result.categoryNamestringName of the Category this product belongs to
result.brandNamestringname of the manufacturer this product belongs to
result.imagestringProduct Image URL
result.inventoryintProduct Inventory
result.sellPricedecimalProduct Sell Price
result.costPricedecimalProduct Cost Price
result.currencystringCurrency of the Price
result.statusintStatus of the product
result.publishedDateTimeDateTime the product is published
result.lastUpdatedDateTimeDateTime the product is last updated
result.currencySymbolstringSymbol 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

NameTypeDescription
pageintNumber of the page from the paginated result set, by default it is 1
pagesizeintHow many records to be displayed in a page, by default it is 10
categoryIdstringUnique Guid of the Category
brandIdstringUnique Guid of the brand
collectionIdstringUnique Guid of the Collection
vendorIdstringUnique Guid of the Vendor
createdIdstringUnique Guid of the Created
lastUpdatedIdstringUnique Guid of the LastUpdated
seasonCodestringUnique Guid of the Season
statusintUnique integer status id
tagstringUnique Guid of the tag
channelstringUnique Guid of the channel
lifecyclestringUnique Guid of the lifecycle
stockCodestringUnique identifier stock code of the product
itemTypeintegeritemType of the product
stockAvailabilityintegerProduct stock as number
manufacturerstringUnique Guid of the brand
productNamestringname of the product
freeTextstringa 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"
}'

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
}
NameTypeDescription
statusstringHolds the status name related to the status code
errorstringdetails of the error if any
errorIdstringerror code if any error in the process
messagestringmessage to display on front end if any in case of errors/success
messageCodestringResponse message code
totalRecordsintTotal Number of products in result set
resultobjectcontains the result object can be array of objects or specific object
result.productIdGuidUnique id of the product
result.productIIdintunique numeric id of the product
result.stockCodestringUnique stock code of the Product
result.namestringProduct Name
result.categoryNamestringName of the Category this product belongs to
result.brandNamestringname of the manufacturer this product belongs to
result.imagestringProduct Image URL
result.inventoryintProduct Inventory
result.sellPricedecimalProduct Sell Price
result.costPricedecimalProduct Cost Price
result.currencystringCurrency of the Price
result.statusintStatus of the product
result.publishedDateTimeDateTime the product is published
result.lastUpdatedDateTimeDateTime the product is last updated
result.currencySymbolstringSymbol of the currency


GET/api/v1/search/by-category/{id}

By Category

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

NameTypeDescription
idstringUnique Guid of the Category or sub category
pageintNumber of the page from the paginated result set, by default it is 1
pagesizeintHow 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}}' 

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
}
NameTypeDescription
statusstringHolds the status name related to the status code
errorstringdetails of the error if any
errorIdstringerror code if any error in the process
messagestringmessage to display on front end if any in case of errors/success
messageCodestringResponse message code
totalRecordsintTotal Number of products in result set
resultobjectcontains the result object can be array of objects or specific object
result.productIdGuidUnique id of the product
result.productIIdintunique numeric id of the product
result.stockCodestringUnique stock code of the Product
result.namestringProduct Name
result.categoryNamestringName of the Category this product belongs to
result.brandNamestringname of the manufacturer this product belongs to
result.imagestringProduct Image URL
result.inventoryintProduct Inventory
result.sellPricedecimalProduct Sell Price
result.costPricedecimalProduct Cost Price
result.currencystringCurrency of the Price
result.statusintStatus of the product
result.publishedDateTimeDateTime the product is published
result.lastUpdatedDateTimeDateTime the product is last updated
result.currencySymbolstringSymbol of the currency


GET/api/v1/search/by-brand/{id}

By Brand

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

NameTypeDescription
idstringUnique Guid of the brand or sub brand
pageintNumber of the page from the paginated result set, by default it is 1
pagesizeintHow 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}}' 

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
}
NameTypeDescription
statusstringHolds the status name related to the status code
errorstringdetails of the error if any
errorIdstringerror code if any error in the process
messagestringmessage to display on front end if any in case of errors/success
messageCodestringResponse message code
totalRecordsintTotal Number of products in result set
resultobjectcontains the result object can be array of objects or specific object
result.productIdGuidUnique id of the product
result.productIIdintunique numeric id of the product
result.stockCodestringUnique stock code of the Product
result.namestringProduct Name
result.categoryNamestringName of the Category this product belongs to
result.brandNamestringname of the manufacturer this product belongs to
result.imagestringProduct Image URL
result.inventoryintProduct Inventory
result.sellPricedecimalProduct Sell Price
result.costPricedecimalProduct Cost Price
result.currencystringCurrency of the Price
result.statusintStatus of the product
result.publishedDateTimeDateTime the product is published
result.lastUpdatedDateTimeDateTime the product is last updated
result.currencySymbolstringSymbol of the currency


GET/api/v1/search/by-collection/{id}

By Collection

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

NameTypeDescription
idstringUnique Guid of the collection
pageintNumber of the page from the paginated result set, by default it is 1
pagesizeintHow 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}}' 

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
}
NameTypeDescription
statusstringHolds the status name related to the status code
errorstringdetails of the error if any
errorIdstringerror code if any error in the process
messagestringmessage to display on front end if any in case of errors/success
messageCodestringResponse message code
totalRecordsintTotal Number of products in result set
resultobjectcontains the result object can be array of objects or specific object
result.productIdGuidUnique id of the product
result.productIIdintunique numeric id of the product
result.stockCodestringUnique stock code of the Product
result.namestringProduct Name
result.categoryNamestringName of the Category this product belongs to
result.brandNamestringname of the manufacturer this product belongs to
result.imagestringProduct Image URL
result.inventoryintProduct Inventory
result.sellPricedecimalProduct Sell Price
result.costPricedecimalProduct Cost Price
result.currencystringCurrency of the Price
result.statusintStatus of the product
result.publishedDateTimeDateTime the product is published
result.lastUpdatedDateTimeDateTime the product is last updated
result.currencySymbolstringSymbol of the currency


GET/api/v1/search/by-season/{id}

By Season

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

NameTypeDescription
idstringUnique Guid of the season
pageintNumber of the page from the paginated result set, by default it is 1
pagesizeintHow 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}}' 

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
}
NameTypeDescription
statusstringHolds the status name related to the status code
errorstringdetails of the error if any
errorIdstringerror code if any error in the process
messagestringmessage to display on front end if any in case of errors/success
messageCodestringResponse message code
totalRecordsintTotal Number of products in result set
resultobjectcontains the result object can be array of objects or specific object
result.productIdGuidUnique id of the product
result.productIIdintunique numeric id of the product
result.stockCodestringUnique stock code of the Product
result.namestringProduct Name
result.categoryNamestringName of the Category this product belongs to
result.brandNamestringname of the manufacturer this product belongs to
result.imagestringProduct Image URL
result.inventoryintProduct Inventory
result.sellPricedecimalProduct Sell Price
result.costPricedecimalProduct Cost Price
result.currencystringCurrency of the Price
result.statusintStatus of the product
result.publishedDateTimeDateTime the product is published
result.lastUpdatedDateTimeDateTime the product is last updated
result.currencySymbolstringSymbol of the currency


GET/api/v1/search/by-status/{id}

By Status

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

NameIdDescription
All-1Used when we want products of all status codes
None0No Status
Draft1returns products in Draft status
Active2returns products in Active status
Archived3returns products that are Archived
Discontinued4returns products that are discontinued

Request Parameters

NameTypeDescription
idintegerUnique integer id of the status
pageintNumber of the page from the paginated result set, by default it is 1
pagesizeintHow 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}}'

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
}
NameTypeDescription
statusstringHolds the status name related to the status code
errorstringdetails of the error if any
errorIdstringerror code if any error in the process
messagestringmessage to display on front end if any in case of errors/success
messageCodestringResponse message code
totalRecordsintTotal Number of products in result set
resultobjectcontains the result object can be array of objects or specific object
result.productIdGuidUnique id of the product
result.productIIdintunique numeric id of the product
result.stockCodestringUnique stock code of the Product
result.namestringProduct Name
result.categoryNamestringName of the Category this product belongs to
result.brandNamestringname of the manufacturer this product belongs to
result.imagestringProduct Image URL
result.inventoryintProduct Inventory
result.sellPricedecimalProduct Sell Price
result.costPricedecimalProduct Cost Price
result.currencystringCurrency of the Price
result.statusintStatus of the product
result.publishedDateTimeDateTime the product is published
result.lastUpdatedDateTimeDateTime the product is last updated
result.currencySymbolstringSymbol of the currency


GET/api/v1/search/by-tag/{id}

By Tag

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

NameTypeDescription
idstringUnique Guid of the tag
pageintNumber of the page from the paginated result set, by default it is 1
pagesizeintHow 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}}'

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
}
NameTypeDescription
statusstringHolds the status name related to the status code
errorstringdetails of the error if any
errorIdstringerror code if any error in the process
messagestringmessage to display on front end if any in case of errors/success
messageCodestringResponse message code
totalRecordsintTotal Number of products in result set
resultobjectcontains the result object can be array of objects or specific object
result.productIdGuidUnique id of the product
result.productIIdintunique numeric id of the product
result.stockCodestringUnique stock code of the Product
result.namestringProduct Name
result.categoryNamestringName of the Category this product belongs to
result.brandNamestringname of the manufacturer this product belongs to
result.imagestringProduct Image URL
result.inventoryintProduct Inventory
result.sellPricedecimalProduct Sell Price
result.costPricedecimalProduct Cost Price
result.currencystringCurrency of the Price
result.statusintStatus of the product
result.publishedDateTimeDateTime the product is published
result.lastUpdatedDateTimeDateTime the product is last updated
result.currencySymbolstringSymbol of the currency
GET/api/v1/search/by-vendor/{id}

By Vendor

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

NameTypeDescription
idstringUnique Guid of the Vendor
pageintNumber of the page from the paginated result set, by default it is 1
pagesizeintHow 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}}' 

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
}
NameTypeDescription
statusstringHolds the status name related to the status code
errorstringdetails of the error if any
errorIdstringerror code if any error in the process
messagestringmessage to display on front end if any in case of errors/success
messageCodestringResponse message code
totalRecordsintTotal Number of products in result set
resultobjectcontains the result object can be array of objects or specific object
result.productIdGuidUnique id of the product
result.productIIdintunique numeric id of the product
result.stockCodestringUnique stock code of the Product
result.namestringProduct Name
result.categoryNamestringName of the Category this product belongs to
result.brandNamestringname of the manufacturer this product belongs to
result.imagestringProduct Image URL
result.inventoryintProduct Inventory
result.sellPricedecimalProduct Sell Price
result.costPricedecimalProduct Cost Price
result.currencystringCurrency of the Price
result.statusintStatus of the product
result.publishedDateTimeDateTime the product is published
result.lastUpdatedDateTimeDateTime the product is last updated
result.currencySymbolstringSymbol of the currency


GET/api/v1/search/by-created/{id}

By Created

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

NameTypeDescription
idstringUnique Guid of the Created Time period
pageintNumber of the page from the paginated result set, by default it is 1
pagesizeintHow 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}}' 

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
}
NameTypeDescription
statusstringHolds the status name related to the status code
errorstringdetails of the error if any
errorIdstringerror code if any error in the process
messagestringmessage to display on front end if any in case of errors/success
messageCodestringResponse message code
totalRecordsintTotal Number of products in result set
resultobjectcontains the result object can be array of objects or specific object
result.productIdGuidUnique id of the product
result.productIIdintunique numeric id of the product
result.stockCodestringUnique stock code of the Product
result.namestringProduct Name
result.categoryNamestringName of the Category this product belongs to
result.brandNamestringname of the manufacturer this product belongs to
result.imagestringProduct Image URL
result.inventoryintProduct Inventory
result.sellPricedecimalProduct Sell Price
result.costPricedecimalProduct Cost Price
result.currencystringCurrency of the Price
result.statusintStatus of the product
result.publishedDateTimeDateTime the product is published
result.lastUpdatedDateTimeDateTime the product is last updated
result.currencySymbolstringSymbol of the currency


GET/api/v1/search/by-updated/{id}

By Updated

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

NameTypeDescription
idstringUnique Guid of the Created Time period
pageintNumber of the page from the paginated result set, by default it is 1
pagesizeintHow 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}}'

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
}
NameTypeDescription
statusstringHolds the status name related to the status code
errorstringdetails of the error if any
errorIdstringerror code if any error in the process
messagestringmessage to display on front end if any in case of errors/success
messageCodestringResponse message code
totalRecordsintTotal Number of products in result set
resultobjectcontains the result object can be array of objects or specific object
result.productIdGuidUnique id of the product
result.productIIdintunique numeric id of the product
result.stockCodestringUnique stock code of the Product
result.namestringProduct Name
result.categoryNamestringName of the Category this product belongs to
result.brandNamestringname of the manufacturer this product belongs to
result.imagestringProduct Image URL
result.inventoryintProduct Inventory
result.sellPricedecimalProduct Sell Price
result.costPricedecimalProduct Cost Price
result.currencystringCurrency of the Price
result.statusintStatus of the product
result.publishedDateTimeDateTime the product is published
result.lastUpdatedDateTimeDateTime the product is last updated
result.currencySymbolstringSymbol of the currency