Cancelar una orden

Para cancelar una orden previamente registrada, es necesario contar con el identificador único de la orden generado por Eden

Para este servicio se utiliza el método HTTP DELETE, pero el registro no se borra, solo se cancela y queda en el histórico por si es necesario hacer alguna validación posterior.

Cancel an order.

delete

https://middleware-staging.dev-land.space/api/v1http://middleware-staging.dev-land.space/api/v1

/orders/{id}/

Cancel an order from the provided data.

Authorizations

Token

AuthorizationstringRequired

Path parameters

idstringRequired

Body

application/json

cancel_reasonstringRequired

Reason for which the order was cancelled. The options are "non-attendance", "room-not-available", "pregnant-risk", "physical-limitation" and "other".

cancel_descriptionstringOptional

Details of the reason why the order was cancelled. Max length is 255 characters.

Responses

200

A successful response that returns the order details.

application/json

400

A failed response because the required parameters were not received.

application/json

401

A failed response due to insufficient permissions to execute the operation.

application/json

403

A failed response due to not having the proper permissions.

application/json

404

A failed response because the required order was not found.

application/json

500

A failed response due to a server problem.

application/json

delete

/orders/{id}/

HTTPcURLJavaScriptPython

DELETE /api/v1/orders/{id}/ HTTP/1.1
Host: middleware-staging.dev-land.space
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "cancel_reason": "text",
  "cancel_description": "text"
}

{
  "data": {
    "id": "text",
    "status": "text",
    "folio": "text",
    "patient_id": "text",
    "patient_identifier": "text",
    "patient_name": "text"
  },
  "errors": {},
  "success": "true"
}