Facebook
Login Contact Us Support Partner With Us

Order Push API

PURPOSE

Order push API will push the data of order details into the database. Customer id or contact details to be mandatory fields, rest of the additional fields can be used based on required to push the data.

Note: Please use the POST Method to use these parameters

API CONFIGURATION

  • Click on configuration > Partner configuration > API’s configurations > Select Order API > Click on Order 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 3 Ticket API 4 Ticket API 4

SAMPLE REQUEST URL

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

DATA FORMAT

[
  {
    "customer_name":"Guru",
    "phone":"1234567890",
    "email_id":"xjbwih@jbk.ji",
    "order_status":"",
    "create_date":"yyyy-mm-dd HH:MM",
    "customer_id":"",
    "order_type":"",
    "date_of_birth":"yyyy-mm-dd",
    "address":"",
    "shipping_address":"",
    "total_paid":"",
    "expected_delivery_date":"",
    "transaction":"",
    "payment_mode":"cash",
    "order_id":"",
    "zip_code":"",
    "grand_total":"",
    "assign_email_id":"",
    "erp_order_id":"",
    "product_details":[
            {
                "sku_id":"",
                "product_name":"",
                "parent_product_name":"",
                "rate":"10000",
                "quantity":"1",
                "discount":"1"
            }
        ]
    }
];

SUCCESS RESPONSE

[
    {
        "Enquiry Id":"11756843",
        "Order Id":"4236966",
        "kapture_customer_id":"48046485",
        "message":"Order Added Successfully",
        "order_id":"4236966",
        "enquiry_id":"11756843",
        "Kapture Customer Id":"48046485",
        "status":"success"
    }
];

FAILURE RESPONSE

{
   "Message": "Order Creation Failed...",
   "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

Order PULL API

PURPOSE

Order pull API used to push the data from Kapture to customer database. Start date to be mandatory.

Note: Please use the POST Method to use these parameters

API CONFIGURATION

  • Click on configuration > Partner configuration > API’s configurations > Select Ticket API > Click on Ticket 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
Select API 1 Select API 2 Select API 3 Select API 4

DATA FORMAT

[
    {
        "enquiry_id":"293312",
        "start_date":"2016-03-31",
        "end_date":"2016-03-31",
        "sortOnModificationDate":"false",
        "numberOfRecords":"10",
        "startPosition":"10",
        "includeHistory":"false"
    }
];

SAMPLE REQUEST URL FORMAT

http://kapdemo.kapturecrm.com/select-order-between-start-and-end-dates.html

SUCCESS RESPONSE

{
    "orders":[
            {
                "id":"4070336",
                "leadId":"47772861",
                "enquiryId":"11490188",
                "name":"Rachel Smith",
                "phone":"987656889",
                "email":"Rachel@toothwoth.com",
                "creatorId":"43528",
                "productId":"",
                "productQuantity":"1",
                "productValue":"0",
                "paymentTerm":"",
                "paymentMode":"",
                "remarks":"",
                "companyName":"Tooth worth"
            }
   ],
   "status":"success"
};

FAILURE RESPONSE

{
   "Message": "No orders between dates",
   "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

Get Order API

PURPOSE

Get Order API used to get the information of the existing order details. Order id to be mandatory.

Note: Please use the POST Method to use these parameters

API CONFIGURATION

  • Click on configuration > Partner configuration > API’s configurations > Select Order API > Click on Get Order > 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
Search API 1 Search API 2 Search API 3 Search API 3

SAMPLE REQUEST URL

https://kapdemo.kapturecrm.com/search-order-by-order-id.html

DATA FORMAT

[
    {
        "order_id":"4075465"
    }
];

SUCCESS RESPONSE

{
    "message":{
            "id":"4075465",
            "cmId":"2469",
            "leadId":"47801920",
            "enquiryId":"11497473",
            "name":"Rouf Zargar",
            "phone":"9899788160",
            "email":"rouf.z@kapturecrm.com",
            "creatorId":"43528",
            "productId":"",
            "productQuantity":"1",
            "productValue":"1500"
        },
        "status":"success"
   };

FAILURE RESPONSE

{
   "Message": "could not find the order",
   "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 Order API

PURPOSE

Update Order API used to pass the information to update the existing order details. Customer id or customer name or customer code is mandatory with one of the email and phone

Note: Please use the POST Method to use these parameters

API CONFIGURATION

  • Click on configuration > Partner configuration > API’s configurations > Select Ticket API > Click on Update Ticket 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
Update API 1 update API 2 Update API 3

REQUEST URL

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

DATA FORMAT

[
    {
        "customer_name":"Guru",
        "phone":"1234567890",
        "email_id":"xjbwih@jbk.ji",
        "enquiry_id":"",
        "order_id":"4141343",
        "customer_id":"",
        "order_type":"",
        "product_details":[
            {
                    "product_details":"Subscription service",
                    "product_type":"",
                    "rate":"1000",
                    "quantity":"10",
                    "discount":"5"
            }
        ]
    }
]

SUCCESS RESPONSE

[
    {
        "Enquiry Id":"11759566",
        "Order Id":"4238584",
        "kapture_customer_id":"48046485",
        "message":"Order Added Successfully",
        "order_id":"4238584",
        "enquiry_id":"11759566",
        "Kapture Customer Id":"48046485",
        "status":"success"
    }
];

FAILURE RESPONSE

{
   "Message": "Order Id Or Enquiry Id Or Customer Id Or Customer Name Or Customer Code And Email Id or Phone required.",
   "Status": "Fail"
}

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 Payment against Order API

PURPOSE

Update payment against order API used to update the payment details for the existing orders. Order id and customer id is mandatory. Payment amount should be greater than zero.

Note: Please use the POST Method to use these parameters

API CONFIGURATION

  • Click on configuration > Partner configuration > API’s configurations > Select Ticket API > Click on Update Ticket 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
Update API 1 update API 2 Update API 3 Update API 3

REQUEST URL

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

DATA FORMAT

[
   {
      "kapture_order_id":"4238767",
      "erp_order_id":"",
      "kapture_customer_id":"48658789",
      "payment_mode":"cheque",
      "cheque_number":"",
      "cheque_date":"2020-05-22",
      "bank_name":"",
      "payment_id":"",
      "amount_paid":"1000",
      "remarks":""
   }
]

SUCCESS RESPONSE

{
    "message":"payment against order updated successfully.",
    "status":"success"
};

FAILURE RESPONSE

{
   "Message": "(customer Id and order Id) or (payment Id) required and Paid amount should be greater than zero",
   "Status": "Fail"
}

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
SCHEDULE A DEMO