Getting Started

Base URL

Use the environment-specific API host:

  • Sandbox: https://sandbox-orderservice.cloudrx.co.uk/

  • Production: https://orderservice.cloudrx.co.uk/

Identity URL

Use the environment-specific Identity Server host:

  • Sandbox: https://sandbox-is4.cloudrx.co.uk

  • Production: https://is4.cloudrx.co.uk

Token endpoint path for both environments:

  • POST /connect/token

Required scopes

  • cloudrx_orderservice

  • cloudrx_productservice

  • cloudrx_smsservice

  • cloudrx_courierservice

Required headers for secured endpoints

After obtaining a token from Identity Server, include:

  • Authorization: Bearer <access_token>

  • Content-Type: application/json (for JSON body calls)

Common integration flow

  1. Request token from Identity Server (/connect/token) and store it.

  2. Optionally validate products/couriers.

  3. Submit order.

  4. Poll order status.

  5. Cancel only when business rules allow and with correct clinicCode.

Endpoint map (v2)

  • PUT /api/v2/Order/create

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

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

  • GET /api/v2/Order/status

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

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

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

  • POST /api/v2/Order/cancel

  • GET /api/v2/Product/stock-check

  • GET /api/v2/Product/price-check

  • GET /api/v2/Product/search (anonymous)

  • GET /api/v2/CourierService/price-check

Identity endpoint

  • POST <identity-server-base-url>/connect/token

Postman/cURL tip

Keep clinicCode explicit in workflows where the same client can operate multiple clinics.

Try It

Last updated

Was this helpful?