Error Codes Flutter Setup <% docs.sections.forEach(function(section) { %> <%= section.title %> <% }); %>

HTTP Error Codes

<% docs.errorCodes.forEach(function(err) { %> <% }); %>

Code	Meaning	When	Example
<%= err.code %>	<%= err.meaning %>	<%= err.when %>	<% if (err.example) { %> <%= JSON.stringify(err.example, null, 2) %> <% } else { %>—<% } %>

Flutter Implementation

Export JSON is restricted to super_admin only. Use the button above while logged in, or call /api/v1/docs.json with Authorization: Bearer <token> from POST /api/auth/login. All exports are audit-logged.

1. Add dependencies (pubspec.yaml)

<%= docs.flutterSetup.packages %>

2. API config

<%= docs.flutterSetup.baseConfig %>

3. Auth header (protected routes)

<%= docs.flutterSetup.authHeader %>

4. GET request example

<%= docs.flutterSetup.getExample %>

5. Multipart upload (deals/flyers)

<%= docs.flutterSetup.postMultipart %>

Image and file URLs in responses are relative (e.g. /uploads/deals/abc.jpg). Prepend serverUrl before passing to Image.network().

<% docs.sections.forEach(function(section) { %>

<%= section.title %>

<% section.endpoints.forEach(function(ep, idx) { %>

<%= ep.method %> <%= docs.baseUrl %><%= ep.path %> <% if (ep.auth) { %>JWT Required<% } else { %>Public<% } %>

<% if (ep.description) { %>

<%= ep.description %>

<% } %> <% if (ep.query) { %>

Query: <%= ep.query %>

<% } %> <% if (ep.request) { %>

Sample Request

<%= JSON.stringify(ep.request, null, 2) %>

<% } %> <% if (ep.response) { %>

Sample Response

<%= JSON.stringify(ep.response, null, 2) %>

<% } %> <% if (ep.flutter) { %>

Flutter Example

<%= ep.flutter %>

<% } %> <% if (ep.errors && ep.errors.length) { %>

Possible Errors: <% ep.errors.forEach(function(code) { %> <%= code %> <% }); %>

<% } %>

<% }); %>

<%= title %>

Contents