Skip to content

Place Order

Place Order

Order medications from any pharmacy in the Famasi network. Choose delivery or pickup, pay securely, and track your order in real-time.

Create Order

Place an order for medications at a specific pharmacy.

Terminal window
# Place an order for 2 packs of Amoxicillin
place_order({
pharmacyId: "PH-456",
medicationId: "MED-123",
quantity: 2,
deliveryType: "delivery",
address: {
street: "12 Admiralty Way",
city: "Lekki",
state: "Lagos"
},
notes: "Call when you arrive"
})

Parameters:

ParameterTypeRequiredDescription
pharmacyIdstringYesPharmacy ID from search
medicationIdstringYesMedication ID
quantitynumberYesNumber of units to order
deliveryTypestringYes"delivery" or "pickup"
addressobjectNoRequired for delivery
address.streetstringNoStreet address
address.citystringNoCity
address.statestringNoState
notesstringNoSpecial instructions

Response:

{
"success": true,
"orderId": "ORD-789",
"status": "pending_payment",
"total": 5000,
"currency": "NGN",
"items": [
{
"medicationId": "MED-123",
"name": "Amoxicillin 500mg",
"quantity": 2,
"price": 2500,
"total": 5000
}
],
"pharmacy": {
"id": "PH-456",
"name": "GreenCross Pharmacy",
"phone": "+2348012345678"
},
"delivery": {
"type": "delivery",
"fee": 500,
"eta": "30-45 minutes"
},
"checkoutUrl": "https://pay.famasi.ai/checkout/ORD-789"
}

Get a secure payment link to complete the order.

Terminal window
# Get payment checkout link
get_checkout_link({
orderId: "ORD-789"
})

Parameters:

ParameterTypeRequiredDescription
orderIdstringYesOrder ID from place_order response

Response:

{
"checkoutUrl": "https://pay.famasi.ai/checkout/ORD-789",
"expiresAt": "2026-04-19T12:00:00Z"
}

Payment Methods

The checkout supports multiple payment options:

  • Card — Visa, Mastercard, Verve
  • Bank Transfer — Direct bank transfer
  • USSD — Mobile banking codes
  • Wallet — Famasi wallet balance

Order States

StatusDescription
pending_paymentAwaiting payment
payment_receivedPayment confirmed
processingPharmacy preparing order
ready_for_pickupReady for collection
out_for_deliveryWith delivery partner
completedDelivered/picked up
cancelledOrder cancelled

Example: Complete Order Flow

Terminal window
# Step 1: Place the order
place_order({
pharmacyId: "PH-456",
medicationId: "MED-123",
quantity: 2,
deliveryType: "delivery",
address: {
street: "12 Admiralty Way",
city: "Lekki",
state: "Lagos"
}
})
# → Returns orderId: "ORD-789"
# Step 2: Get checkout link
get_checkout_link({ orderId: "ORD-789" })
# → Returns payment URL
# Step 3: Complete payment on checkout page
# (User pays via card, transfer, or USSD)
# Step 4: Track order
# Use check_order_status or get_order_history

Bulk Orders

Order multiple medications at once:

Terminal window
place_order({
pharmacyId: "PH-456",
items: [
{ medicationId: "MED-123", quantity: 2 },
{ medicationId: "MED-124", quantity: 1 }
],
deliveryType: "pickup"
})

Next steps