API Documentation
Integrate GikFoods with your ghost kitchen or delivery platform
Quick Start
Authentication
Secure API key-based authentication for all requests
REST & Webhooks
RESTful API endpoints and real-time webhook events
Rate Limiting
1000 requests/hour per API key with usage monitoring
SDKs Available
Official SDKs for Node.js, Python, PHP, and Go
Get Your API Keys
Sign up for a developer account to receive your API keys and start building integrations.
Main Endpoints
/api/v1/brands
Create a new food brand
/api/v1/brands/:id
Get brand details and performance
/api/v1/menus
Create and update menu items
/api/v1/orders
Submit and track orders
/api/v1/delivery/routes
Generate optimized delivery routes
/api/v1/kitchens/booking
Book ghost kitchen time slots
Code Example
// Initialize GikFoods API client
const gikfoods = require('gikfoods');
const client = new gikfoods.Client({
apiKey: 'your-api-key-here'
});
// Create a new brand
const brand = await client.brands.create({
name: 'Spice House Kitchen',
cuisine: 'Indian',
description: 'Authentic Indian cuisine from a home chef'
});
// Submit an order
const order = await client.orders.create({
brandId: brand.id,
items: [
{ dishId: 'biryani-001', quantity: 2, price: 14.99 }
],
deliveryAddress: '123 Main St, New York, NY 10001'
});
// Get optimized delivery route
const route = await client.delivery.optimize({
orderId: order.id,
currentLocation: '456 Kitchen Ave, Brooklyn, NY'
});Webhook Events
Order Events
- ✓ order.created
- ✓ order.confirmed
- ✓ order.ready
- ✓ order.dispatched
- ✓ order.delivered
- ✓ order.cancelled
Kitchen Events
- ✓ kitchen.booking.confirmed
- ✓ kitchen.booking.cancelled
- ✓ kitchen.time_available
- ✓ kitchen.issue.reported
- ✓ kitchen.inspection.scheduled
- ✓ kitchen.maintenance.alert
Rate Limits & Best Practices
Rate Limits
Standard Plan
1,000 requests/hour
Pro Plan
10,000 requests/hour
Enterprise
Custom limits, contact sales
Best Practices
- • Always handle errors gracefully
- • Implement exponential backoff for retries
- • Cache responses when possible
- • Monitor webhook delivery success
- • Use pagination for list endpoints
- • Encrypt sensitive data in transit
Need Help?
Our technical team is here to help with your integration