Skip to main content

SUPPLIER

🏭 Technical Specification: Supplier Setup


📋 Feature Overview

Attribute Detail
Module 📂 Directory (SUPPLIER)
Feature Name Supplier Profile Management
Description Manages supplier profiles including general details, contact information, address logic (Country/State/District), and associated pickup addresses.
Page & Detail
1. Listing Page: /listing-supplier-profile
Displays grid of suppliers, filters, and delete actions.
2. Add/Edit Page: /add-supplier-profile-manage
Form for creating new suppliers or updating profile/address details.
User Guide 📄 [Ekajaya Admin User Guide - Directory Module, Section 6]

🛠️ Technical Implementation

A. Permissions & Access Control

Note: Access is controlled via PermissionGuard and template checks.
Scope Permission Code Description & Page Usage
Menu Visibility SUPPLIER.MENU

Sidebar menu visibility.

\listing-supplier-profile

\add-supplier-profile-manage
Page Routing SUPPLIER.LISTING Access to listing route.
\listing-supplier-profile
Page Routing SUPPLIER.VIEW

Access to add route.

\add-supplier-profile-manage
Create Action SUPPLIER.CREATE Visibility of the + Add button.
\listing-supplier-profile
View Access SUPPLIER.VIEW Controls visibility of action buttons (Edit).
\listing-supplier-profile
Delete Action SUPPLIER.DELETE Visibility of the Delete 🗑️ icon.
\listing-supplier-profile
Update Action SUPPLIER.UPDATE Ability to save changes on Edit screen.
\add-supplier-profile-manage

B. API Interaction

Base URL: ${environment.baseApiUrl}
1. RetrieveListing Supplier ListProfile \listing-supplier-profile
Endpoint
/suppliers/getQuery
Method
POST
Purpose
Fetches paginated data for the grid.
Params
filter: isDeleted||$eq||0 (plus dynamic search).
sort:Filter: supplierCode, supplierName, registrationNumber, isDeleted=0
/supplier/delete
POST
Purpose: Delete Supplier
2. DeleteAdd Supplier \listing-supplier-profile
Profile
Endpoint
/supplier/delete
Method
POST
{
  "id": Number
}
3. Get Single Supplier (Edit Mode)Manage \add-supplier-profile-manage
Endpoint
/countries/getQuery
POST
Purpose: Populate countryDataSource
/states/getQuery
POST
Filter: countryId
/districts/getQuery
POST
Filter: stateId
/suppliers/getQuery
Method
POST
Params
filter:Filter: id||$eq||{id}id
limit: 1
(Fetch
specific
Note: Uses getQuery with limit 1, not getOne.
record)
4. Create/Update
/suppliers/getQuery
SupplierPOST
Filter: \add-supplier-profile-managesupplierCode (Uniqueness Check)
Create EP
/suppliers/mdCreate
POST
UpdatePurpose: EPMaster-Detail Create
/suppliers/mdUpdate
POST
Purpose: Master-Detail Update
{
  "supplierCode": "String",
  "supplierName": "String",
  "pickupAddressList": [ ... ],
  "countryId": Number,
  "stateId": Number,
  "districtId": Number,
  "isCima": Boolean
}
5. Helper APIs (Dropdowns) \add-supplier-profile-manage
Countries
/countries/getQuery
POST
States
/states/getQuery (countryId filter)
POST
Districts
/districts/getQuery (stateId filter)
POST

C. Validation & Business Logic

1. Unique Code Validation \add-supplier-profile-manage

  • Trigger: On Save.
  • Logic: Calls /suppliers/getQuery with filter supplierCode||$eq||{inputCode}.
  • Error: Blocking error: "Supplier code already exists".

2. Pickup Address Validation \add-supplier-profile-manage

  • Trigger: On Save.
  • Logic: Checks this.dataSource.pickupAddressList.
  • Condition: If the list is null or length is 0.
  • Error: "Please add pickup address".
Back to top