Published Mar 28, 2024

Order Write

By Anand Mehta
1 min

Summary

image-20240328-022619.png

These set of APIs will let you:

  • Cancel an order

 

EndPoints:

  • Order/Cancel

Base URL

The base URL for all API endpoints is:

https://bridge.cdsreg.com/

GetDeletedOrders

 

  • URL: https://bridge.cdsreg.com/Order/Cancel

  • Method: Post

  • Parameters

    • Auth Key: Authorization Key needed to call API endpoint.

    • Order Number: A unique ID provided to an order

    • Remove Payments: True or False field. True = you would like to remove the payment. False = you would like not to remove payment.

Example Request:

curl -X 'PUT' \ 'https://bridge.cdsreg.com/Order/Cancel' \ -H 'accept: text/plain' \ -H 'Content-Type: application/json' \ -d '{ "AuthKey": "(Omitted)", "OrderNumber": 0, "RemovePayments": true }'

Example Response:

{ "RecordCount": 0, "StatusCode": 0, "ReturnMessages": [ "string" ], "Success": true, "OperationId": "string" }

Error Responses

  • 400 Bad Request:

    • Invalid Auth Key

Example Error Response:

{ "RecordCount": 0, "StatusCode": 400, "ReturnMessages": [ "INVALID AUTH KEY" ], "Success": false, "OperationId": "4739ef76fa187cac9de91dfd8fe829c7", "RegRecords": []

Related content