Update Order API
The Update order API will allow us in updating the already added order against the customer in the system.
Update Order.
POST
https://<sub domain>.kapturecrm.com/ms/customer/order/api/v1/add-update
Authentication:
To access this API endpoint, you need to include your user name and password in the Authorization header. For authentication, use the following header, which will help you generate your Basic Auth token:
Request Body
The request body should be a JSON object containing the details of the customer against which the order needs to be updated along with the order details. Here are the list of parameters.
Name | Mandatory | Type | Description |
---|---|---|---|
customer_name | Yes | Date | Indicates the name of the customer exisiting in the System. |
order_id | Yes | Number | Kapture generated unique order id against which the update of information is needed. |
Please map in the request body if there's any extra associate body according to your use case.
Response Body
The API responds with a JSON object containing the details of the added order against the customer. If successful, the response will include the customer ID, order ID and the other relevant information.
Response | Response Messages |
---|---|
{ ..., "status": "success"} | List of customers fetched successfully. |
{"message": "Invalid Auth Key","status": "failed"} | Authorization key is either not passed in header, or incorrect, or expired/disabled |
Error Codes
Error Codes | Description |
---|---|
400 | Bad Request - Invalid parameters or missing data |
401 | Unauthorized - Invalid or missing API key |
403 | Forbidden - Insufficient permissions |
404 | Not Found - Resource or endpoint not found |
500 | Internal Server Error - Server-side issue |
Example of a working curl
Last updated