Order

Gets the status of the order with TrackingId and Dispatch Date.

get

Get /status { "orderId": 1, }

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Query parameters

orderIdinteger · int32Optional

Use Pharmacy Order Number or your (Clinic) order reference

Responses

200

Returns the status of the order.

application/json

Order Status Model.

clinicOrderIdstring · nullableOptional

Gets or sets.

pharmacyOrderIdstring · nullableOptional

Gets or sets.

orderStatusstring · nullableOptional

Gets or sets.

dispatchDatestring · date-time · nullableOptional

Gets or sets.

trackingIdstring · nullableOptional

Gets or sets.

cancelReasonstring · nullableOptional

Gets or sets.

400

The OrderId is not valid or does not exist in CloudRx System.

application/json

401

Unauthorized

403

Forbidden

404

Not Found

application/json

500

CloudRx system is in fault state.

application/json

get

/api/v2/Order/status

GET /api/v2/Order/status HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "clinicOrderId": "text",
  "pharmacyOrderId": "text",
  "orderStatus": "text",
  "dispatchDate": "2026-02-20T00:00:27.668Z",
  "trackingId": "text",
  "cancelReason": "text"
}

Gets the status of the order by using Pharmacy Order Number or Clinic Order Number and will need to provide Clinic Code. Either Pharmacy OrderNumber or Clinic Number should be provided. This Api call should also be used by the Clinic System Supplier where they would be sending scripts on behalf of Clinics.

get

Get /status { "orderId": 1, "clinicOrderId": "abc1234", "clinicCode": "cl1234", }

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Query parameters

orderIdinteger · int32Optional

Use Pharmacy Order Number

clinicOrderIdstringOptional

Your (Clinic) order reference

clinicCodestringOptional

Clinic Code.

Responses

200

Returns the status of the order.

application/json

Order Status Model.

clinicOrderIdstring · nullableOptional

Gets or sets.

pharmacyOrderIdstring · nullableOptional

Gets or sets.

orderStatusstring · nullableOptional

Gets or sets.

dispatchDatestring · date-time · nullableOptional

Gets or sets.

trackingIdstring · nullableOptional

Gets or sets.

cancelReasonstring · nullableOptional

Gets or sets.

400

The OrderId is not valid or does not exist in CloudRx System.

application/json

401

Unauthorized

403

Forbidden

404

Not Found

application/json

500

CloudRx system is in fault state.

application/json

get

/api/v2/Order/status-with-clinic-code

GET /api/v2/Order/status-with-clinic-code HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "clinicOrderId": "text",
    "pharmacyOrderId": "text",
    "orderStatus": "text",
    "dispatchDate": "2026-02-20T00:00:27.668Z",
    "trackingId": "text",
    "cancelReason": "text"
  }
]

Gets the status of the order by using Clinic Order Number with TrackingId and Dispatch Date.

get

Get /status { "orderId": "abc1234", }

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Query parameters

orderIdstringOptional

Clinic Order Number

Responses

200

Returns the status of the order.

application/json

Order Status Model.

clinicOrderIdstring · nullableOptional

Gets or sets.

pharmacyOrderIdstring · nullableOptional

Gets or sets.

orderStatusstring · nullableOptional

Gets or sets.

dispatchDatestring · date-time · nullableOptional

Gets or sets.

trackingIdstring · nullableOptional

Gets or sets.

cancelReasonstring · nullableOptional

Gets or sets.

400

The OrderId is not valid or does not exist in CloudRx System.

application/json

401

Unauthorized

403

Forbidden

404

Not Found

application/json

500

CloudRx system is in fault state.

application/json

get

/api/v2/Order/status-clinic-ordernumber

GET /api/v2/Order/status-clinic-ordernumber HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "clinicOrderId": "text",
  "pharmacyOrderId": "text",
  "orderStatus": "text",
  "dispatchDate": "2026-02-20T00:00:27.668Z",
  "trackingId": "text",
  "cancelReason": "text"
}

Get Order Status for a given date range. Maximum number of days you can get order status is set to 3.

get

Get /status-date-range { "startDate": "2020-01-01", "endDate": "2020-01-03" }

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Query parameters

startDatestring · date-timeOptional

Date Dispatched as Start Date

endDatestring · date-timeOptional

Date Dispatched as End Date

Responses

200

application/json

Order Status Model.

clinicOrderIdstring · nullableOptional

Gets or sets.

pharmacyOrderIdstring · nullableOptional

Gets or sets.

orderStatusstring · nullableOptional

Gets or sets.

dispatchDatestring · date-time · nullableOptional

Gets or sets.

trackingIdstring · nullableOptional

Gets or sets.

cancelReasonstring · nullableOptional

Gets or sets.

400

Bad Request

application/json

401

Unauthorized

403

Forbidden

404

Not Found

application/json

500

Internal Server Error

application/json

get

/api/v2/Order/status-date-range

GET /api/v2/Order/status-date-range HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "clinicOrderId": "text",
  "pharmacyOrderId": "text",
  "orderStatus": "text",
  "dispatchDate": "2026-02-20T00:00:27.668Z",
  "trackingId": "text",
  "cancelReason": "text"
}

Create order for the customer and register the Clinic if it does not exist in the CloudRx System. This Api call should also be used by the Clinic System Supplier where they would be sending scripts on behalf of Clinics.

put

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Body

Order Model used for Creating new order.

affiliateIdstring · nullableOptional

Gets or sets.

Responses

200

Returns orderId on successfull creation of the order.

application/json

Order Confirm Model.

orderIdinteger · int32Optional

Gets or sets.

400

Model Validation Errors.

application/json

401

Unauthorized

403

Forbidden

500

CloudRx system is in fault state.

application/json

put

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

PUT /api/v2/Order/create-with-clinic HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1043

{
  "customer": {
    "clinicAccountNumber": 1,
    "title": "Mr",
    "firstName": "text",
    "surname": "text",
    "dateOfBirth": "2026-02-20",
    "gender": "Male",
    "telephone": "text",
    "email": "text",
    "nhsNumber": "text"
  },
  "homeAddress": {
    "address1": "text",
    "address2": "text",
    "city": "text",
    "county": "text",
    "postCode": "text",
    "countryCode": "text"
  },
  "deliveryAddress": {
    "address1": "text",
    "address2": "text",
    "city": "text",
    "county": "text",
    "postCode": "text",
    "countryCode": "text"
  },
  "prescription": {
    "clinicOrderId": "text",
    "clinicOrderValue": 1,
    "paymentType": "Account",
    "repeatsAllowed": 1,
    "courierCode": "RMT24",
    "currencyCode": "GBP"
  },
  "prescribedItems": [
    {
      "productId": 1,
      "dmdCode": 1,
      "pack": 1,
      "medication": "text",
      "dosageInstructions": "text",
      "quantity": 1
    }
  ],
  "prescribingDoctor": {
    "registrationNumber": "text",
    "prescriberName": "text"
  },
  "clinicInformation": {
    "clinicCode": "text",
    "name": "text",
    "address1": "text",
    "address2": "text",
    "address3": "text",
    "address4": "text",
    "postcode": "text",
    "countryCode": "text",
    "contactNumber": "text",
    "contactEmail": "text",
    "prescriberFeeTypeId": 0,
    "prescriberFee": 1
  },
  "affiliateId": "text"
}

{
  "orderId": 1
}

Create order in the CloudRx system from the HL7 message.

put

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Body

stringOptional

Responses

200

Returns orderId on successfull creation of the order.

application/json

Order Confirm Model.

orderIdinteger · int32Optional

Gets or sets.

400

Model Validation Errors.

application/json

401

Unauthorized

403

Forbidden

500

CloudRx system is in fault state.

application/json

put

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

PUT /api/v2/Order/create-with-hl7message HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

{
  "orderId": 1
}

Create order for the customer.

put

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Body

Order Model used for Creating new order.

affiliateIdstring · nullableOptional

Gets or sets.

Responses

200

Returns orderId on successfull creation of the order.

application/json

Order Confirm Model.

orderIdinteger · int32Optional

Gets or sets.

400

Model Validation Errors.

application/json

401

Unauthorized

403

Forbidden

500

CloudRx system is in fault state.

application/json

put

/api/v2/Order/create

PUT /api/v2/Order/create HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1043

{
  "customer": {
    "clinicAccountNumber": 1,
    "title": "Mr",
    "firstName": "text",
    "surname": "text",
    "dateOfBirth": "2026-02-20",
    "gender": "Male",
    "telephone": "text",
    "email": "text",
    "nhsNumber": "text"
  },
  "homeAddress": {
    "address1": "text",
    "address2": "text",
    "city": "text",
    "county": "text",
    "postCode": "text",
    "countryCode": "text"
  },
  "deliveryAddress": {
    "address1": "text",
    "address2": "text",
    "city": "text",
    "county": "text",
    "postCode": "text",
    "countryCode": "text"
  },
  "prescription": {
    "clinicOrderId": "text",
    "clinicOrderValue": 1,
    "paymentType": "Account",
    "repeatsAllowed": 1,
    "courierCode": "RMT24",
    "currencyCode": "GBP"
  },
  "prescribedItems": [
    {
      "productId": 1,
      "dmdCode": 1,
      "pack": 1,
      "medication": "text",
      "dosageInstructions": "text",
      "quantity": 1
    }
  ],
  "prescribingDoctor": {
    "registrationNumber": "text",
    "prescriberName": "text"
  },
  "clinicInformation": {
    "clinicCode": "text",
    "name": "text",
    "address1": "text",
    "address2": "text",
    "address3": "text",
    "address4": "text",
    "postcode": "text",
    "countryCode": "text",
    "contactNumber": "text",
    "contactEmail": "text",
    "prescriberFeeTypeId": 0,
    "prescriberFee": 1
  },
  "affiliateId": "text"
}

{
  "orderId": 1
}

Cancels an order with the specified order ID.

post

POST /cancel { "orderId": "123", "clinicCode": "ABC123", "cancelReason": "Patient requested cancellation" }

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Query parameters

orderIdstringOptional

The order ID to cancel.

clinicCodestringOptional

The clinic code used to scope cancellation.

cancelReasonstringOptional

The reason for cancellation.

Responses

200

Returns success message.

application/json

stringOptional

400

The OrderId is not valid or cancellation not allowed.

application/json

401

Unauthorized

403

Forbidden

404

The OrderId does not exist.

application/json

500

CloudRx system is in fault state.

application/json

post

/api/v2/Order/cancel

POST /api/v2/Order/cancel HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

text

PreviousCourierService NextProduct

Last updated 1 day ago

Was this helpful?

hashtagGets the status of the order with TrackingId and Dispatch Date.

hashtagGets the status of the order by using Clinic Order Number with TrackingId and Dispatch Date.

hashtagGet Order Status for a given date range. Maximum number of days you can get order status is set to 3.

hashtagCreate order for the customer and register the Clinic if it does not exist in the CloudRx System. This Api call should also be used by the Clinic System Supplier where they would be sending scripts on behalf of Clinics.

hashtagCreate order in the CloudRx system from the HL7 message.

hashtagCreate order for the customer.

hashtagCancels an order with the specified order ID.

Gets the status of the order with TrackingId and Dispatch Date.

Gets the status of the order by using Clinic Order Number with TrackingId and Dispatch Date.

Get Order Status for a given date range. Maximum number of days you can get order status is set to 3.

Create order for the customer and register the Clinic if it does not exist in the CloudRx System. This Api call should also be used by the Clinic System Supplier where they would be sending scripts on behalf of Clinics.

Create order in the CloudRx system from the HL7 message.

Create order for the customer.

Cancels an order with the specified order ID.