v1 Beta

API Documentation

Integrate PrimeTijara directly into your ERP, project management tools, or custom applications. Our REST API gives you programmatic access to the full procurement workflow.

Overview

Catalog API

Browse and search 2,500+ building materials with real-time pricing.

Proforma API

Create, retrieve, and manage proforma invoices programmatically.

Orders API

Place orders, process payments, and track fulfillment status.

Webhooks

Receive real-time notifications for order and payment events.

Authentication

All authenticated endpoints require a Bearer token in the Authorization header. API keys are available on Enterprise plans.

# Example request
curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.primebuild.com.gh/v1/catalog

Endpoints Reference

GET
/api/v1/catalog

List all available materials with pricing and stock levels.

GET
/api/v1/catalog/:slug

Get detailed information for a specific product.

GET
/api/v1/categories

List all product categories.

POST
/api/v1/proformas

Create a new proforma invoice with line items and project details.

GET
/api/v1/proformas/:id

Retrieve proforma details, status, and items.

POST
/api/v1/proformas/:id/approve

Approve a proforma via stakeholder token.

GET
/api/v1/orders

List all orders for the authenticated user.

GET
/api/v1/orders/:id

Get order details including delivery status.

POST
/api/v1/orders/:id/fulfill

Update order fulfillment stage (Supplier endpoint).

POST
/api/v1/webhooks/paystack

Paystack payment webhook receiver.

indicates authentication required.

Rate Limits

Starter (free)60 requests/min
Professional300 requests/min
EnterpriseCustom

Response Format

{
  "ok": true,
  "data": { ... },
  "meta": {
    "page": 1,
    "total": 128,
    "per_page": 20
  }
}

Ready to integrate?

API access is available on Enterprise plans. Get in touch and we'll set you up with credentials.

Contact Sales