{"openapi":"3.0.3","info":{"title":"ScanSewa Developer API","version":"1.0.0","description":"Read-only REST API for a ScanSewa vendor's data. Authenticate with an API key (Bearer or x-api-key). Each key is scoped and rate limited to 120 requests/minute."},"servers":[{"url":"https://api.scansewa.com/api/public/v1"}],"security":[{"ApiKeyAuth":[]}],"tags":[{"name":"Orders"},{"name":"Catalog"},{"name":"Tables"},{"name":"Inventory"},{"name":"Customers"},{"name":"Analytics"}],"paths":{"/orders":{"get":{"tags":["Orders"],"summary":"List orders","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"status","in":"query","schema":{"type":"string","enum":["Pending","Confirmed","Delivered","Completed","Cancelled"]}},{"name":"since","in":"query","schema":{"type":"string","format":"date-time"},"description":"ISO date — only orders created at/after this"},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"hasMore":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Order"}}}}}}}}}},"/orders/{id}":{"get":{"tags":["Orders"],"summary":"Get one order","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"$ref":"#/components/schemas/Order"}}}}}},"404":{"$ref":"#/components/responses/NotFound"}}}},"/menu":{"get":{"tags":["Catalog"],"summary":"List menu items","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"inStock","in":"query","schema":{"type":"boolean"}},{"name":"category","in":"query","schema":{"type":"string"},"description":"Category id filter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"total":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/MenuItem"}}}}}}}}}},"/menu/{id}":{"get":{"tags":["Catalog"],"summary":"Get one menu item","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"$ref":"#/components/schemas/MenuItem"}}}}}},"404":{"$ref":"#/components/responses/NotFound"}}}},"/categories":{"get":{"tags":["Catalog"],"summary":"List categories","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"active","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"total":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Category"}}}}}}}}}},"/offers":{"get":{"tags":["Catalog"],"summary":"List offers","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"active","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"total":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Offer"}}}}}}}}}},"/tables":{"get":{"tags":["Tables"],"summary":"List tables","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"occupied","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"total":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Table"}}}}}}}}}},"/inventory":{"get":{"tags":["Inventory"],"summary":"List inventory items","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"lowStock","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"total":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/InventoryItem"}}}}}}}}}},"/customers":{"get":{"tags":["Customers"],"summary":"List customers (PII)","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"q","in":"query","schema":{"type":"string"},"description":"Search by name or phone"},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"hasMore":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}}}}}}}}}},"/analytics/summary":{"get":{"tags":["Analytics"],"summary":"Sales summary","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"since","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"until","in":"query","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesSummary"}}}}}}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"http","scheme":"bearer","bearerFormat":"ssk_live_…","description":"Send your API key as a Bearer token, or use the x-api-key header."}},"responses":{"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unauthorized":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"success":{"type":"boolean","example":false},"message":{"type":"string"}}},"OrderItem":{"type":"object","properties":{"menuItemId":{"type":"string"},"name":{"type":"string"},"quantity":{"type":"integer"},"unitPrice":{"type":"number"},"itemTotal":{"type":"number"}}},"Order":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"paymentStatus":{"type":"string","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"}},"subtotal":{"type":"number"},"grandTotal":{"type":"number"},"table":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"customerName":{"type":"string","nullable":true},"customerPhone":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"MenuItem":{"type":"object","properties":{"id":{"type":"string"},"menuItemId":{"type":"string"},"name":{"type":"string"},"price":{"type":"number"},"categoryId":{"type":"string","nullable":true},"categoryName":{"type":"string","nullable":true},"categoryType":{"type":"string","nullable":true},"foodType":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"isInStock":{"type":"boolean"}}},"Category":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"imageUrl":{"type":"string","nullable":true}}},"Offer":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"offerType":{"type":"string","nullable":true},"mrp":{"type":"number"},"price":{"type":"number"},"description":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"startDate":{"type":"string","format":"date-time","nullable":true},"endDate":{"type":"string","format":"date-time","nullable":true}}},"Table":{"type":"object","properties":{"id":{"type":"string"},"nameOrNumber":{"type":"string"},"capacity":{"type":"integer","nullable":true},"tableType":{"type":"string","nullable":true},"tableArea":{"type":"string","nullable":true},"occupied":{"type":"boolean"}}},"InventoryItem":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"quantity":{"type":"number"},"unit":{"type":"string","nullable":true},"pricePerUnit":{"type":"number","nullable":true},"lowStockThreshold":{"type":"number"},"lowStock":{"type":"boolean"},"categoryId":{"type":"string","nullable":true}}},"Customer":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"address":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"}}},"SalesSummary":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"orders":{"type":"integer"},"revenue":{"type":"number"},"subtotal":{"type":"number"},"averageOrderValue":{"type":"number"},"byStatus":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"count":{"type":"integer"},"revenue":{"type":"number"}}}},"bySource":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"count":{"type":"integer"},"revenue":{"type":"number"}}}},"topItems":{"type":"array","items":{"type":"object","properties":{"menuItemId":{"type":"string"},"name":{"type":"string","nullable":true},"quantity":{"type":"integer"},"revenue":{"type":"number"}}}}}}}}}}}