Vendor Portal API

Self-service portal for vendors to manage purchase orders, submit invoices, track payments, and respond to RFQs.

Authentication

Like the customer portal, the vendor portal uses token-based access. Tokens are generated by procurement teams and shared with vendors.

Generate a Token (Admin)


POST /api/v1/vendor-portal/tokens
Authorization: Bearer ADMIN_JWT_TOKEN
 
{
  "vendor_id": "uuid",
  "permissions": {
    "view_pos": true,
    "acknowledge_pos": true,
    "view_deliveries": true,
    "update_shipping": true,
    "submit_invoices": true,
    "view_payments": true,
    "view_rfqs": true,
    "submit_quotes": true
  }
}

Endpoints

Dashboard


GET /vendor-portal/view/{token}/dashboard

Returns PO summary (total, pending, received), recent payments, and open RFQs.

Purchase Orders


GET  /vendor-portal/view/{token}/purchase-orders
GET  /vendor-portal/view/{token}/purchase-orders/{id}
POST /vendor-portal/view/{token}/purchase-orders/{id}/acknowledge
POST /vendor-portal/view/{token}/purchase-orders/{id}/shipping

Acknowledge: Vendor confirms they received and accept the PO.

Shipping Update:


{
  "carrier": "Aramex",
  "tracking_number": "ARX-123456",
  "expected_delivery": "2026-04-20",
  "notes": "Shipped via express"
}

Invoice Submission


POST /vendor-portal/view/{token}/invoices
{
  "po_id": "uuid",
  "invoice_number": "VINV-2026-001",
  "amount": 15000.00,
  "date": "2026-04-14",
  "notes": "Payment due net 30"
}

Creates a draft vendor bill (in_invoice) in the accounting module for review.


GET /vendor-portal/view/{token}/invoices

View submitted invoices with payment status.

Payments


GET /vendor-portal/view/{token}/payments

View payment history with invoice allocation details.

RFQ Response


GET  /vendor-portal/view/{token}/rfqs
POST /vendor-portal/view/{token}/rfqs/{quoteId}/submit
{
  "lines": [
    { "rfq_line_id": "product-uuid", "unit_price": 45.00, "quantity": 100 }
  ],
  "lead_time_days": 14,
  "notes": "Valid for 30 days"
}

Permissions

Permission	Default	Controls
`view_pos`	true	See purchase order list and details
`acknowledge_pos`	true	Confirm receipt of POs
`view_deliveries`	true	See delivery schedule
`update_shipping`	true	Update tracking and shipping info
`submit_invoices`	true	Submit vendor invoices
`view_payments`	true	See payment history
`view_rfqs`	true	See RFQ requests
`submit_quotes`	true	Submit pricing quotes