Orders

Use the interactive API for endpoint exploration and request execution:

• API Reference (Interactive)

Create order

PUT /api/v2/Order/create

cURL

curl --request PUT \
  --url 'https://<your-cloudrx-host>/api/v2/Order/create' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "clinicInformation": { "allProducts": true, "prescriberFeeTypeId": 0, "prescriberFee": 5 },
    "deliveryAddress": { "countryCode": "GBR", "postCode": "SW1A1AA" },
    "prescription": { "courierCode": 1, "clinicOrderId": "ORD-10001", "paymentType": 1 },
    "prescribingDoctor": { "prescriberName": "Doctor Example", "registrationNumber": "GMC1234567" },
    "customer": { "dateOfBirth": "1990-01-01T00:00:00Z", "surname": "Doe", "title": 1, "email": "", "telephone": "07123456789" },
    "prescribedItems": [
      { "productId": 123, "dmdCode": 456, "pack": 1, "quantity": 1, "medication": "Drug Name", "dosageInstructions": "Take daily", "allowedRepeats": 0 }
    ]
  }'

Request body (example)

{
  "clinicInformation": {
    "allProducts": true,
    "prescriberFeeTypeId": 0,
    "prescriberFee": 5
  },
  "deliveryAddress": {
    "countryCode": "GBR",
    "postCode": "SW1A1AA"
  },
  "prescription": {
    "courierCode": 1,
    "clinicOrderId": "ORD-10001",
    "paymentType": 1
  },
  "prescribingDoctor": {
    "prescriberName": "Doctor Example",
    "registrationNumber": "GMC1234567"
  },
  "customer": {
    "dateOfBirth": "1990-01-01T00:00:00Z",
    "surname": "Doe",
    "title": 1,
    "email": "",
    "telephone": "07123456789"
  },
  "prescribedItems": [
    {
      "productId": 123,
      "dmdCode": 456,
      "pack": 1,
      "quantity": 1,
      "medication": "Drug Name",
      "dosageInstructions": "Take daily",
      "allowedRepeats": 0
    }
  ]
}

Success response

200 OK

{
  "orderId": 12345
}

Common failures

• 400: validation/business rule failure (invalid country, clinic, courier, prescriber, duplicate clinicOrderId, etc.)

• 403: patient locked out

• 500: server exception

---

Create order with clinic registration

PUT /api/v2/Order/create-with-clinic

Use this when clinic metadata/doctor linkage needs to be established during submission.

cURL

curl --request PUT \
  --url 'https://<your-cloudrx-host>/api/v2/Order/create-with-clinic' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "clinicInformation": {
      "name": "Clinic Name",
      "address1": "Address 1",
      "address2": "Address 2",
      "postcode": "AA11AA",
      "contactEmail": "[email protected]",
      "contactNumber": "0700000000",
      "clinicCode": "CLINIC-001"
    },
    "deliveryAddress": { "countryCode": "GBR", "postCode": "SW1A1AA" },
    "prescription": { "courierCode": 1, "clinicOrderId": "ORD-10002", "paymentType": 1 },
    "prescribingDoctor": { "prescriberName": "Doctor Example", "registrationNumber": "GMC1234567" },
    "customer": { "dateOfBirth": "1990-01-01T00:00:00Z", "surname": "Doe", "title": 1, "email": "", "telephone": "07123456789" },
    "prescribedItems": [
      { "productId": 123, "dmdCode": 456, "pack": 1, "quantity": 1, "medication": "Drug Name", "dosageInstructions": "Take daily", "allowedRepeats": 0 }
    ]
  }'

---

Create order from HL7

PUT /api/v2/Order/create-with-hl7message

Body is raw HL7 string.

cURL

curl --request PUT \
  --url 'https://<your-cloudrx-host>/api/v2/Order/create-with-hl7message' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '"MSH|^~\\&|HEYDOC|SRC|CloudRx|CLINIC001|20210602160300||OMP^O09|msg-1|P|2.5\\rPID|1||pat^^^^^^^|^^^^^^^|Doe^John^^^XYZ^^||19900101|M|||1 Main St^Flat 1^London^^SW1A1AA^GB^H^^^^^||^PRN^CP^[email protected]^^^07123456789^^|||||||||||||||||\\rORC|NW|CL-ORDER-1|||IP||||20210602160300|doc^Smith^Alice^^^^^||doc^Smith^Alice^^^^^|||||||||Clinic Name^^^^^^^^|10 High St^Suite 1^London^^SW1A1AA^GB^^^^^^||||||||\\rRXO|Drug One^123^^^^|40|||Take one daily^^^^^|^20260101^^^^|||||2||||||||||1||||3|MONTH"'

---

Order status by pharmacy order id

GET /api/v2/Order/status?orderId=<int>

cURL

curl --request GET \
  --url 'https://<your-cloudrx-host>/api/v2/Order/status?orderId=12345' \
  --header 'Authorization: Bearer <access_token>'

---

Order status with clinic code (supplier flow)

GET /api/v2/Order/status-with-clinic-code?orderId=<int>&clinicOrderId=<string>&clinicCode=<string>

Rules:

• clinicCode required.

• Either orderId or clinicOrderId must be provided.

cURL

curl --request GET \
  --url 'https://<your-cloudrx-host>/api/v2/Order/status-with-clinic-code?orderId=0&clinicOrderId=ORD-10001&clinicCode=CL-701' \
  --header 'Authorization: Bearer <access_token>'

---

Order status by clinic order id

GET /api/v2/Order/status-clinic-ordernumber?orderId=<string>

cURL

curl --request GET \
  --url 'https://<your-cloudrx-host>/api/v2/Order/status-clinic-ordernumber?orderId=ORD-10001' \
  --header 'Authorization: Bearer <access_token>'

---

Order status by date range

GET /api/v2/Order/status-date-range?startDate=<ISO8601>&endDate=<ISO8601>

Rules:

• Date range max is 3 days.

cURL

curl --request GET \
  --url 'https://<your-cloudrx-host>/api/v2/Order/status-date-range?startDate=2026-02-15T00:00:00Z&endDate=2026-02-17T00:00:00Z' \
  --header 'Authorization: Bearer <access_token>'

---

Cancel order (clinic-scoped)

POST /api/v2/Order/cancel?orderId=<string>&clinicCode=<string>&cancelReason=<string>

cURL

curl --request POST \
  --url 'https://<your-cloudrx-host>/api/v2/Order/cancel?orderId=12345&clinicCode=CL-701&cancelReason=Patient%20requested%20cancellation' \
  --header 'Authorization: Bearer <access_token>'

Required params

• orderId

• clinicCode

• cancelReason

Why clinicCode is mandatory

clinicCode scopes cancellation to the correct clinic context and prevents cross-clinic cancellation when one client is linked to multiple clinics.

Success response

200 OK

"Order <orderId> cancelled successfully."

Business rules (summary)

• If order cannot be found for (orderId + clinicCode scope): 404.

• Clinic-pay orders can be cancelled only before processed state.

• Patient-pay orders can be cancelled only while waiting for payment.

• Rule violation returns 400.