Audit API

The Audit API provides financial reporting and analytics for administrators to track commissions, taxes, expenses, and store performance.

Overview

The Audit API provides endpoints for:

• Settings: Configure global tax and expenses percentages
• Overview: High-level financial summary
• Payout Reports: Detailed commission and payout calculations
• Tax Reports: Tax calculations and reporting
• Store Analytics: Individual store performance metrics

Base Path

/v1/products/audit/

Authentication

Required - Admin role only

Authorization: Token <admin_token>

Endpoints

• Get Audit Settings - Get global tax and expenses percentages
• Update Audit Settings - Update global tax and expenses percentages
• Get Audit Overview - Get high-level financial summary
• Get Payout Report - Get detailed commission and payout calculations
• Get Tax Report - Get tax calculations and reporting
• Get Store Analytics - Get individual store performance metrics

Notes

• All audit endpoints require admin authentication (role "2")
• Audit calculations use the configured tax and expenses percentages from settings
• Reports can be filtered by date range, store, and other criteria
• All financial calculations are based on completed orders and payments