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 built with Django REST Framework. It provides a complete backend API for connecting farmers who list produce, buyers who place orders, and transporters who handle delivery — with integrated payments via Squad gateway, escrow protection, and recurring subscription support.

Quickstart

Make your first API call and place an order in minutes

Authentication

Obtain JWT tokens and authenticate every request

API Reference

Browse every endpoint with parameters and response schemas

Core Concepts

Understand roles, order lifecycles, and payment flows

What AgroPulse provides

User Roles

Farmers, buyers, and transporters each have distinct profile types with role-based access

Produce Catalog

Farmers list produce by category, price, quantity, and harvest date

Order Management

Buyers place and track orders through a full lifecycle from pending to completed

Delivery Tracking

Riders are assigned and delivery status is tracked through pickup, transit, and delivery

Payments & Escrow

Squad gateway integration with escrow holds funds until delivery is confirmed

Subscriptions

Buyers set up recurring produce orders at daily, weekly, or monthly frequency

Get started in four steps

1

Set up the server

Install dependencies and configure your environment. See the setup guide for database, environment variables, and running the dev server.
2

Register and authenticate

Create a user account, then obtain a JWT access token from POST /api/token/. Include the token as a Bearer header on all subsequent requests. See authentication.
3

Browse produce and place an order

Call GET /api/produces/ to browse available produce, then POST /api/orders/ to place an order. See the quickstart for a full example.
4

Initiate payment

After the order is created, call POST /api/payments/initialize_payment/ to start the Squad checkout flow. Funds are held in escrow until delivery is confirmed.
AgroPulse uses PostgreSQL and requires a Squad payment gateway account for payment features. See environment variables for all required configuration.

Build docs developers (and LLMs) love