Cancel an existing Order

View as Markdown
The **Cancel Order API** endpoint allows clients to **initiate a cancellation request** for an existing order that has been placed but not yet shipped, or completed. By providing a valid `order ID`, this API updates the status of the cancellation request to **New** and ensures that no further processing or fulfillment occurs. **Key Points:** - Only eligible orders (e.g., pending or processing) can be canceled. - Once an order is canceled, it cannot be reinstated and must be re-created if needed. - Any associated payments, credits, or refunds will be handled according to the organization’s billing and refund policy. **Use Cases:** - Allowing customers or staff to withdraw an accidental order. - Integrating order cancellation workflows into customer support systems.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

oidstringRequired

(Required)

Request

This endpoint expects an object.
patient_detailsobjectRequired
shipping_detailsobjectRequired
primary_contact_detailsobjectRequired

Response

Accepted
codeinteger
dataobject
messagestring