Skip to content

Provider Settings

Provider Settings

Configure your pharmacy profile, payment settings, notifications, and operational preferences.

Get Provider Info

View your current pharmacy settings.

Terminal window
# Get provider details
getProviderInfo()

Response:

{
"id": "PROV-123",
"name": "GreenCross Pharmacy",
"legalName": "GreenCross Pharmacy Ltd",
"registrationNumber": "RC123456",
"type": "retail",
"status": "active",
"contact": {
"phone": "+2348012345678",
"email": "info@greencrosspharmacy.com",
"website": "https://greencrosspharmacy.com"
},
"address": {
"street": "12 Admiralty Way",
"city": "Lekki",
"state": "Lagos",
"country": "Nigeria"
},
"hours": {
"monday": "08:00-22:00",
"tuesday": "08:00-22:00",
"wednesday": "08:00-22:00",
"thursday": "08:00-22:00",
"friday": "08:00-22:00",
"saturday": "09:00-20:00",
"sunday": "10:00-18:00"
},
"settings": {
"autoAcceptOrders": true,
"deliveryEnabled": true,
"pickupEnabled": true,
"defaultDeliveryFee": 500,
"currency": "NGN"
},
"branches": [
{
"id": "BR-123",
"name": "Lekki Branch",
"address": "12 Admiralty Way, Lekki",
"isMain": true
},
{
"id": "BR-124",
"name": "VI Branch",
"address": "45 Ozumba Mbadiwe, VI",
"isMain": false
}
],
"createdAt": "2024-06-15T10:00:00Z"
}

Edit Provider Info

Update your pharmacy profile information.

Terminal window
# Update pharmacy details
editProviderInfo({
name: "GreenCross Pharmacy",
legalName: "GreenCross Pharmacy Ltd",
phone: "+2348012345678",
email: "info@greencrosspharmacy.com",
website: "https://greencrosspharmacy.com",
address: {
street: "12 Admiralty Way",
city: "Lekki",
state: "Lagos"
}
})

Update Business Hours

Set your operating hours.

Terminal window
# Update opening hours
updateProviderHours({
monday: { open: "08:00", close: "22:00" },
tuesday: { open: "08:00", close: "22:00" },
wednesday: { open: "08:00", close: "22:00" },
thursday: { open: "08:00", close: "22:00" },
friday: { open: "08:00", close: "22:00" },
saturday: { open: "09:00", close: "20:00" },
sunday: { open: "10:00", close: "18:00" }
})

Update your pharmacy logo.

Terminal window
# Upload pharmacy logo
uploadProviderLogo({
file: "logo.png" // File path or base64 encoded
})

Requirements:

  • Format: PNG or JPG
  • Max size: 2MB
  • Recommended: 400x400px minimum
  • Transparent background preferred

Update Payment Type

Configure your payment preferences.

Terminal window
# Set preferred payment method
updatePaymentType({
type: "bank_transfer", // bank_transfer, wallet, auto
bankAccount: {
bankCode: "011",
accountNumber: "1234567890",
accountName: "GreenCross Pharmacy Ltd"
}
})

Payment Types:

TypeDescription
bank_transferPayouts to bank account
walletKeep funds in Famasi wallet
autoAuto-transfer when threshold reached

Notification Settings

Configure how you receive notifications.

Terminal window
# Update notification preferences
updateProviderNotifications({
channels: {
email: true,
sms: true,
push: true
},
events: {
newOrder: true,
orderCancelled: true,
lowStock: true,
paymentReceived: true,
customerMessage: true,
weeklyReport: true
}
})

Delivery Settings

Configure delivery options.

Terminal window
# Update delivery settings
updateDeliverySettings({
enabled: true,
radius: 10, // km
fee: 500,
freeDeliveryThreshold: 10000, // Free delivery over ₦10k
estimatedTime: "30-45 minutes",
serviceAreas: ["Lekki", "Victoria Island", "Ikoyi"]
})

Order Settings

Configure order handling preferences.

Terminal window
# Update order settings
updateOrderSettings({
autoAcceptOrders: false,
preparationTime: 15, // minutes
requirePrescriptionVerification: true,
allowScheduledOrders: true,
maxItemsPerOrder: 20,
minOrderAmount: 1000
})

Integration Settings

Manage third-party integrations.

Terminal window
# Get integration status
getProviderIntegrations()

Response:

{
"integrations": [
{
"name": "WhatsApp Business",
"status": "connected",
"phone": "+2348012345678"
},
{
"name": "Google Maps",
"status": "connected",
"placesId": "ChIJ..."
},
{
"name": "QuickBooks",
"status": "disconnected"
}
]
}

Connect Integration

Connect a third-party service.

Terminal window
# Connect WhatsApp Business
connectIntegration({
service: "whatsapp",
phone: "+2348012345678",
apiKey: "..."
})

Branch Management

Add or update pharmacy branches.

Terminal window
# Add new branch
addProviderBranch({
name: "Ikeja Branch",
address: {
street: "25 Allen Avenue",
city: "Ikeja",
state: "Lagos"
},
phone: "+2348088888888",
hours: {
monday: { open: "08:00", close: "21:00" }
// ... other days
},
managerId: "USER-124"
})

Example: Settings Workflow

Terminal window
# Step 1: View current settings
getProviderInfo()
# → Shows current configuration
# Step 2: Update contact info
editProviderInfo({
phone: "+2348099999999",
email: "newemail@greencrosspharmacy.com"
})
# Step 3: Set business hours
updateProviderHours({
monday: { open: "08:00", close: "22:00" },
sunday: { open: "12:00", close: "18:00" }
})
# Step 4: Configure notifications
updateProviderNotifications({
channels: { email: true, sms: true },
events: { newOrder: true, lowStock: true }
})

Pharmacy Types

TypeDescription
retailStandard retail pharmacy
hospitalHospital pharmacy
clinicClinic pharmacy
wholesaleWholesale distributor
onlineOnline-only pharmacy

Next steps

  • Users — Manage team members
  • Wallet — Configure payment settings
  • Analytics — View performance metrics