Login Contact Us Support Partner With Us
INTRODUCTION API AUTHENTICATION CUSTOMER LEADS TICKETS ORDER API PRODUCT API WEBHOOKS API FAQ CATEGORY API
Product Push API Product PULL API Update Product API

Product Push API

PURPOSE

Product push API will push the product details into the database. Product name should be mandatory field.

Note: Please use the POST Method to use these parameters

API CONFIGURATION

  • Click on configuration > Partner configuration > API’s configurations > Select Product API > Click on Product Push API > enter the API name to create API request and Key expiry date.
  • Select Mandatory required fields along with additional required parameters to generate the URL.
  • Each API request will be created along with “Auth Key” to pass the URL
Ticket API 1 Ticket API 2 Ticket API 2 Ticket API 2 Ticket API 2

SAMPLE REQUEST URL

https://kapdemo.kapturecrm.com/add-update-product-from-other-source.html

DATA FORMAT

[
   {
      "name":"Glasses",
      "parent_product_name":"Material",
      "rate":"2000",
      "mrp":"",
      "product_type":"product",
      "stock":"",
      "description":"",
      "short_description":"",
      "pack_type":"",
      "tax_enabled":"",
      "weight":"",
      "interest":"",
      "category":"",
      "industry":""
   }
];

SUCCESS RESPONSE

{
   "product_id":"526878",
   "message":"Lead Product details added successfully",
   "status":"success"
};

FAILURE RESPONSE

{
   "Message": "Product Name is empty.",
   "Status": "failed"
}

ERROR MESSAGES

Error Messages Description
AuthKeyInvalid Please use correct Authkey
ServerFailure Server error while processing this request
ReqFieldMissing Mandatory field missing
APIExpired API Request is Expired

ADDITIONAL NOTES

  • While pushing the data to Kapture required field to be given properly, field mapping to be proper when integrating with 3rd party apps
  • You must have permission to access API service
  • You must have a valid Auth Key to send the Request, Auth key should not be expired

Product PULL API

PURPOSE

Product pull API used to push the data from Kapture to customer database. Kapture product id and product name to be mandatory to fetch the product details.

Note: Please use the POST Method to use these parameters

API CONFIGURATION

  • Click on configuration > Partner configuration > API’s configurations > Select Product API > Click on Product Pull API > enter the API name to create API request and Key expiry date.
  • Select Mandatory required fields along with additional required parameters to generate the URL.
  • Each API request will be created along with “Auth Key” to pass the URL
Ticket API 1 Ticket API 2 Ticket API 3 Ticket API 3

SAMPLE REQUEST URL

https://http://kapdemo.kapturecrm.com/search-product-from-other-source.html

DATA FORMAT

[
   {
      "kapture_product_id":"526878",
      "sku_id":"",
      "name":"Glasses",
      "parent_product_id":""
   }
];

SUCCESS RESPONSE

{
   "message":{
            "contents":[
                     {
                        "id":"1781",
                        "title":"READY TO EAT",
                        "detail":"<p>Chicken Seekh Kabab, Chicken Spicy Seekh Kabab,&nbsp;Chicken Malai Seekh   Kabab</p>\r\n<p>Mutton&nbsp;Seekh Kabab,&nbsp;Mutton spicy Seekh Kabab,&nbsp;Mutton Malai Seekh Kabab</p>\r\n<p>\r\n  <br />\r\n</p>",
                        "type":"FAQ",
                        "categoryId":"598",
                        "categoryName":"sales faq",
                        "categoryPath":"497/596/597/598/",
                        "enabled":"Yes",
                        "queueKey":"",
                        "createDate":"04 Jul, 2019 11:47",
                        "attachmentDetail":"",
                        "displayIndex":"0"
                  }
            ]
   },
   "status":"success"
};

FAILURE RESPONSE

{
   "Product_Details": "Information given by you does not exist in our sytsem.",
   "Status": "failed"
}

ERROR MESSAGES

Error Messages Description
AuthKeyInvalid Please use correct Authkey
ServerFailure Server error while processing this request
ReqFieldMissing Mandatory field missing
APIExpired API Request is Expired

ADDITIONAL NOTES

  • While pushing the data to Kapture required field to be given properly, field mapping to be proper when integrating with 3rd party apps
  • You must have permission to access API service
  • You must have a valid Auth Key to send the Request, Auth key should not be expired

Update Product API

PURPOSE

Update Product API used to pass any additional information to update the existing product details. Product id to be mandatory to update it.

Note: Please use the POST Method to use these parameters

API CONFIGURATION

  • Click on configuration > Partner configuration > API’s configurations > Select Product API > Click on Update Product > enter the API name to create API request and Key expiry date.
  • Select Mandatory required fields along with additional required parameters to generate the URL.
  • Each API request will be created along with “Auth Key” to pass the URL
Ticket API 1 Ticket API 2 Ticket API 3 Ticket API 3

SAMPLE REQUEST URL

https://kapdemo.kapturecrm.com/add-update-product-from-other-source.html

DATA FORMAT

[
   {
      "name":"Glasses",
      "product_id":"526878",
      "parent_product_name":"def",
      "sku_code1":"",
      "rate":" 2000",
      "product_type":"",
      "stock":"",
      "description":"mirror glasses",
      "short_description":""
   }
];

SUCCESS RESPONSE

{
   "Product_Details":{
      "id":"526878",
      "cmId":"2469",
      "name":"Glasses",
      "generationDate":{
            "year":"2020",
            "month":"4",
            "parentProductId":"-1",
            "stock":"0",
            "description":"",
            "rate":"2000",
            "taxEnabled":"false",
            "otherChargeId":"0",
            "productType":"product"
      },
   "status":"success"
};

FAILURE RESPONSE

{
   "Message": "invalid Json Data",
   "Status": "failed"
}

ERROR MESSAGES

Error Messages Description
AuthKeyInvalid Please use correct Authkey
ServerFailure Server error while processing this request
ReqFieldMissing Mandatory field missing
APIExpired API Request is Expired

ADDITIONAL NOTES

  • While pushing the data to Kapture required field to be given properly, field mapping to be proper when integrating with 3rd party apps
  • You must have permission to access API service
  • You must have a valid Auth Key to send the Request, Auth key should not be expired
  • Andriod Application
  • I-Phone Application
  • Review Kapture CRM on G2
  • GDPR
  • HIPAA
  • ISO
Google Launch Pad
© 2023 KAPTURE - ALL RIGHTS RESERVED Privacy Policy
SCHEDULE A DEMO