Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/OluwagbeminiyiA/agro_pulse-API/llms.txt

Use this file to discover all available pages before exploring further.

AgroPulse is an AI-powered agricultural commerce platform that connects the three core participants of the food supply chain: farmers (sellers) who list and manage their produce, buyers who browse and order that produce, and transporters who handle last-mile delivery. Every interaction in the platform — from browsing a produce catalog to releasing payment from escrow after delivery — flows through this REST API. All endpoints return JSON, and all primary keys are UUIDs.

Start here

Quickstart

Authenticate, browse produce, place an order, and initialize payment in five steps.

Authentication

Obtain and refresh JWT tokens, pass them in requests, and handle auth errors.

User roles

Understand the BUYER, SELLER, and TRANSPORTER roles and how they govern access.

Order lifecycle

Trace an order from PENDING through payment, fulfilment, and delivery to COMPLETED.

Platform modules

Produce

Create and manage produce listings with pricing, stock, and harvest metadata.

Orders

Place orders, manage order items, and track order status changes.

Deliveries

Assign transporters and track delivery progress from dispatch to drop-off.

Payments

Initialize payments, verify transactions, manage escrow, and trigger payouts via Squad.

Subscriptions

Set up recurring produce orders with pause, resume, and cancel support.

Users

Register users and manage BUYER, SELLER, and TRANSPORTER profiles.

Tech stack

ComponentTechnology
LanguagePython 3.12+
FrameworkDjango 6
API layerDjango REST Framework
DatabasePostgreSQL
AuthenticationSimpleJWT
Payment gatewaySquad
Async workersCelery / Redis
The AgroPulse API returns JSON for every response. All resource IDs — users, produce listings, orders, deliveries, payments — are UUIDs.

Build docs developers (and LLMs) love