$ 1402.90
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
•
Website (website)
• Discuss (mail) • Contacts (contacts) • Sales (sale_management) • Invoicing (account) |
| Community Apps Dependencies |
Show
•
Alerting System - Grevlin Price Intelligence Suite
• Analytics Engine - Grevlin Price Intelligence Suite • Monetization & Subscriptions - Grevlin Price Intelligence Suite • Price Collection - Grevlin Price Intelligence Suite • Report Generation - Grevlin Price Intelligence Suite • Commodity Catalog - Grevlin Price Intelligence Suite • Geographic Hierarchy - Grevlin Price Intelligence Suite |
| Lines of code | 18263 |
| Technical Name |
grev_od_market_portal |
| License | OPL-1 |
| Website | https://grevlin.com |
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
•
Website (website)
• Discuss (mail) • Contacts (contacts) • Sales (sale_management) • Invoicing (account) |
| Community Apps Dependencies |
Show
•
Alerting System - Grevlin Price Intelligence Suite
• Analytics Engine - Grevlin Price Intelligence Suite • Monetization & Subscriptions - Grevlin Price Intelligence Suite • Price Collection - Grevlin Price Intelligence Suite • Report Generation - Grevlin Price Intelligence Suite • Commodity Catalog - Grevlin Price Intelligence Suite • Geographic Hierarchy - Grevlin Price Intelligence Suite |
| Lines of code | 18263 |
| Technical Name |
grev_od_market_portal |
| License | OPL-1 |
| Website | https://grevlin.com |
Portal & APIA powerful customer portal and RESTful API that puts market price intelligence directly in your customers’ hands.
|
|
|
|
Need Help?For support, contact us at odoo@grevlin.com Follow us on X: @GrevlinGlobal ✅ 30 days free support |
Grevlin Price Intelligence Suite - Portal & API
This module provides the customer-facing portal interface and RESTful API for the Grevlin Price Intelligence Suite, enabling external access to market price data, analytics, and reports.
Overview
The Portal & API module is the access layer for customers and integrators. It extends Odoo's portal with market price browsing, comparison tools, and alert management. It also exposes a versioned REST API with Bearer token authentication for programmatic data access.
Key Features
- Customer portal with price search and browsing
- Market comparison tool for side-by-side analysis
- Interactive charts powered by Chart.js (OWL components)
- Report browsing and purchasing
- Alert subscription management from portal
- Usage dashboard showing consumption and limits
- REST API v1 with 6 endpoints
- Bearer token authentication with API key verification
- Rate limiting and credit consumption
- Saved searches and data downloads (CSV, Excel, JSON, PDF)
Installation
- Place the grev_od_market_portal folder in your Odoo addons path
- Ensure all dependency modules are installed:
- grev_od_market_analytics
- grev_od_market_subscription
- grev_od_market_report
- grev_od_market_alert
- Install from :menuselection:`Settings --> Technical --> Database Structure --> Update Apps List`
Note
This module depends on the portal and website modules. Both are standard Odoo modules.
Portal Usage
Price Search
Customers access price data through the portal:
- Log in to the customer portal
- Navigate to :guilabel:`Market Prices` in the portal menu
- Use filters for product, market, date range, and price type
- View results with pagination
Market Comparison
- Navigate to :guilabel:`Market Comparison` in the portal
- Select a product and two or more markets to compare
- View side-by-side price data with difference calculations
Reports
- Navigate to :guilabel:`Market Reports` in the portal
- Browse available published reports
- Purchase reports (if applicable) and download PDFs
Alert Management
- Navigate to :guilabel:`My Alerts` in the portal
- Subscribe to available alert rules
- Choose notification channel and frequency
- View alert history
Usage Dashboard
- Navigate to :guilabel:`My Usage` in the portal
- View current plan details and usage statistics
- Monitor API call and query consumption
- Track remaining credits
REST API Reference
Authentication
All API endpoints require Bearer token authentication:
curl -H "Authorization: Bearer YOUR_API_KEY" \ https://your-odoo.com/api/v1/prices
The API key must be generated via the Subscriptions module.
Endpoints
| Endpoint | Method | Description |
|---|---|---|
| /api/v1/prices | GET | Query current prices with filters |
| /api/v1/prices/historical | GET | Historical price data with date range |
| /api/v1/analytics | GET | Computed analytics results |
| /api/v1/forecasts | GET | Price forecast data |
| /api/v1/markets | GET | List available markets |
| /api/v1/products | GET | List tracked commodities |
Common Query Parameters
| Parameter | Type | Description |
|---|---|---|
| product_id | Integer | Filter by product ID |
| market_id | Integer | Filter by market ID |
| country_id | Integer | Filter by country ID |
| date_from | Date | Start date (YYYY-MM-DD) |
| date_to | Date | End date (YYYY-MM-DD) |
| limit | Integer | Results per page (default: 50) |
| offset | Integer | Pagination offset |
Response Format
All responses are JSON:
{ "success": true, "data": [...], "count": 42, "limit": 50, "offset": 0 }
Error responses:
{ "success": false, "error": "Rate limit exceeded", "code": 429 }
Rate Limiting
API calls are rate-limited based on the customer's data plan:
- Per-minute limits prevent burst abuse
- Per-day limits cap total daily usage
- Exceeding limits returns HTTP 429
Technical Reference
Models
| Model | Technical Name | Description |
|---|---|---|
| Saved Search | grev.saved.search | Customer's saved search parameters |
| Data Download | grev.data.download | Download history with credit tracking |
Controllers
- controllers/portal_main.py: Portal routes extending CustomerPortal
- controllers/api_v1.py: REST API v1 endpoints
- controllers/api_auth.py: Bearer token authentication decorator
Frontend Assets
- static/src/js/chart_widget.js: OWL component wrapping Chart.js for price visualization
- static/src/xml/chart_templates.xml: OWL component templates
See also
- Subscription module for API key and plan management
- Analytics Engine module for data powering the API
- Alerting System module for alert subscriptions
- Report Generation module for purchasable reports
Odoo Proprietary License v1.0 This software and associated files (the "Software") may only be used (executed, modified, executed after modifications) if you have purchased a valid license from the authors, typically via Odoo Apps, or if you have received a written agreement from the authors of the Software (see the COPYRIGHT file). You may develop Odoo modules that use the Software as a library (typically by depending on it, importing it and using its resources), but without copying any source code or material from the Software. You may distribute those modules under the license of your choice, provided that this license is compatible with the terms of the Odoo Proprietary License (For example: LGPL, MIT, or proprietary licenses similar to this one). It is forbidden to publish, distribute, sublicense, or sell copies of the Software or modified copies of the Software. The above copyright notice and this permission notice must be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Please log in to comment on this module