Place Order V3

To place order with items and its quantity.

Place Order API has two flow:

  1. Manual Flow : The available items are passed and order can be placed.

  2. Prescription Digitization Flow : In this flow only prescription will be provided which will be digitized at our end then, order will be placed.

In API request, You need to pass either provide patient_id or mobile & patient_name.

Place Order

POST {{apiUrl}}fulfillment/orders/place_order_v3

Request Body

Name
Type
Description

apikey*

String

Authentication token

location_token*

String

Get token from Check Serviceability V3 API

patient_id*

String

Id to uniquely identify the patient for whom the order is placed

if mobile and patient name is provided, then patient_id is optional.

items*

String

Stringified Array of items with quantity (in strip) and medicine_id.

i.e. [{"medicine_id":"Eli4pMFfzobV63G67jtjZw==","quantity": 2}]

Provide only available items which can be know from checkout V3.

Pass "discount_percentage" along with "medicine_id" and quantity to apply custom discount on the item.

delivery_type*

String

Order Delivery type can be pickup or delivery

address*

String

Address of Patient for delivery. required if delivery_type is delivery

address_line2

String

Address Line 2 for long address

city*

String

City of Patient for delivery

state*

String

State of Patient for delivery

zipcode*

String

Zip code of Patient for delivery

latitude

Number

Latitude of the patient to search in nearby pharmacies.

longitude

Number

Longitude of the patient to search in the nearby pharmacies.

mobile

String

Patient's mobile no is optional if patient_id is provided, required otherwise.

patient_name

String

Patient's name is optional if patient_id is provided, required otherwise.

prescription_urls

String

Stringified Array of prescription URLs.​

items param is optional, if prescription_urls param is passed.​

prescription_urls is mandatory for RX medicine.(Check is_rx_required from checkout)

For eg.

["https://www.klippa.com/wp-content/uploads/2020/12/medical-prescription-ocr.png","https://as2.ftcdn.net/v2/jpg/00/56/61/71/500_F_56617167_ZGbrr3mHPUmLoksQmpuY7SPA8ihTI5Dh.jpg"]

full_address

String

Required If lat-long is not provided. This address is used to get the lat-long to find the nearest pharmacy store.

Only zipcode can also by passed in this param

like { "full_address": "560008" }

requestId

String

Partner order id

{
    "status_code": "1",
    "status_message": "Order placed successfully",
    "datetime": "2025-03-13 17:52:30",
    "version": "1.1.51",
    "data": {
        "order_id": "F7VH/hoYLmOIBrCiHyccng==",
        "order_number": "OOM87BK5Y7",
        "total_amount": 119,
        "total": 149,
        "split_orders": [
            {
                "order_id": "7xS09/uGsj9fglWVxIw97Q==",
                "order_number": "O2M87BK68H",
                "chemist_details": {
                    "chemist_id": "GJmQXzl+VAVkke3efyTrcw==",
                    "pharmacy_name": "Demo Pharmacy",
                    "full_address": "Evital Rx 4d Square Mall, Ahmedabad, Gujarat, India, 380005",
                    "latitude": "23.1025849",
                    "longitude": "72.5953601",
                    "zipcode": "380005"
                }
            }
        ]
    }
}

Last updated

Was this helpful?