Welcome

Description

API Documentation
πŸ›’ Items & Shopping Cart API

Comprehensive API documentation for our Items catalog and Shopping Cart system:

  • Public Access: Item browsing, search, and catalog endpoints
  • Protected Access: Shopping cart management with JWT authentication
  • Real-time: Stock availability and pricing information
  • Interactive: Test endpoints directly in the browser
πŸ”“ Public Item APIs πŸ”’ Protected Cart APIs πŸ“Š Real-time Data πŸ§ͺ Interactive Testing
Explore API Documentation

Interactive Swagger UI with live testing

Controllers Found

28

EndpointsAvailable

161

MVC Actions

55

Discovery

Actions

DiscoveredControllers

ApiControllers
Cart
API
Actions:
POST AddItemToCart
api/cart/AddItem
ReturnType: Task<ActionResult<CartOperationResultDto>>
PUT UpdateItemQuantity
api/cart/UpdateQuantity
ReturnType: Task<ActionResult<CartOperationResultDto>>
DELETE RemoveItemFromCart
api/cart/RemoveItem/{cartItemId:int}
ReturnType: Task<ActionResult<CartOperationResultDto>>
GET GetCart
api/cart/{boxId:int}
ReturnType: Task<ActionResult<CartDto>>
DELETE ClearCart
api/cart/Clear/{boxId:int}
ReturnType: Task<ActionResult<CartOperationResultDto>>
GET GetCartSummary
api/cart/{boxId:int}/Summary
ReturnType: Task<ActionResult<CartSummaryDto>>
GET GetCartItemCount
api/cart/{boxId:int}/Count
ReturnType: Task<ActionResult<Object>>
GET GetCartTotal
api/cart/{boxId:int}/Total
ReturnType: Task<ActionResult<Object>>
POST AddMultipleItemsToCart
api/cart/AddMultiple
ReturnType: Task<ActionResult<CartOperationResultDto>>
PUT UpdateMultipleCartItems
api/cart/UpdateMultiple
ReturnType: Task<ActionResult<CartOperationResultDto>>
GET GetCartStatistics
api/cart/{boxId:int}/Statistics
ReturnType: Task<ActionResult<CartStatisticsDto>>
POST CreateOrUpdateCartSession
api/cart/{boxId:int}/Session
ReturnType: Task<ActionResult<CartSessionDto>>
GET GetCartHistory
api/cart/{boxId:int}/History
ReturnType: Task<ActionResult<IEnumerable<CartItemDto>>>
Diagnostics
API
Actions:
GET GetEnvironmentInfo
api/diagnostics/environment
ReturnType: IActionResult
GET TestStaticFiles
api/diagnostics/static-files
ReturnType: IActionResult
GET TestCacheHeaders
api/diagnostics/cache-test
ReturnType: IActionResult
GET GetRequestInfo
api/diagnostics/request-info
ReturnType: IActionResult
GET GetDiscoveredControllers
api/diagnostics/controllers
ReturnType: Task<IActionResult>
Attendance
API
Actions:
POST Register
attendance/api/attendance/register
ReturnType: Task<IActionResult>
Auth
API
Actions:
POST Login
attendance/api/auth/login
ReturnType: Task<IActionResult>
Device
API
Actions:
POST Register
attendance/api/device/register
ReturnType: Task<IActionResult>
Activity
API
Actions:
GET Test
api/activity/test
ReturnType: ActionResult<Object>
GET GetAllActive
api/activity/GetAllActive
ReturnType: Task<ActionResult<IEnumerable<ActivityDto>>>
GET GetById
api/activity/{activityId}
ReturnType: Task<ActionResult<ActivityDto>>
GET GetByFiscalYear
api/activity/fiscal-year/{fiscalYear}
ReturnType: Task<ActionResult<IEnumerable<ActivityDto>>>
GET GetAvailableActivitiesForShareholder
api/activity/available/{shareholderId}
ReturnType: Task<ActionResult<IEnumerable<ShareholderActivityDto>>>
POST CreateActivity
api/activity/CreateActivity
ReturnType: Task<ActionResult<ActivityDto>>
PUT UpdateActivity
api/activity/{activityId}
ReturnType: Task<ActionResult>
DELETE DeleteActivity
api/activity/{activityId}
ReturnType: Task<ActionResult>
POST SetShareholderActivityEligibility
api/activity/eligibility
ReturnType: Task<ActionResult>
POST MarkActivityAsReceived
api/activity/mark-received
ReturnType: Task<ActionResult>
GET GetActivityStatistics
api/activity/{activityId}/statistics
ReturnType: Task<ActionResult<ActivityStatisticsDto>>
GET GetAllActivityStatistics
api/activity/statistics
ReturnType: Task<ActionResult<IEnumerable<ActivityStatisticsDto>>>
GET GetShareholderActivityHistory
api/activity/history/{shareholderId}
ReturnType: Task<ActionResult<IEnumerable<ShareholderActivityDto>>>
GET CheckShareholderEligibility
api/activity/check-eligibility/{shareholderId}/{activityId}
ReturnType: Task<ActionResult<Boolean>>
GET CheckShareholderReceived
api/activity/check-received/{shareholderId}/{activityId}
ReturnType: Task<ActionResult<Boolean>>
Article
API
Actions:
GET GetAll
api/article/GetAll
ReturnType: Task<ActionResult<IEnumerable<ArticleDto>>>
GET GetById
api/article/{id}
ReturnType: Task<ActionResult<ArticleDto>>
GET GetByType
api/article/type/{articleTypeId}
ReturnType: Task<ActionResult<IEnumerable<ArticleDto>>>
GET GetValid
api/article/valid
ReturnType: Task<ActionResult<IEnumerable<ArticleDto>>>
GET GetWithImages
api/article/{id}/images
ReturnType: Task<ActionResult<ArticleWithImagesDto>>
GET GetAllWithImages
api/article/with-images
ReturnType: Task<ActionResult<IEnumerable<ArticleWithImagesDto>>>
POST Create
api/article/Create
ReturnType: Task<ActionResult<ArticleDto>>
PUT Update
api/article/{id}
ReturnType: Task<ActionResult>
DELETE Delete
api/article/{id}
ReturnType: Task<ActionResult>
GET GetArticleImages
api/article/{articleId}/gallery
ReturnType: Task<ActionResult<IEnumerable<ArticleImageDto>>>
GET GetArticleImageById
api/article/gallery/{id}
ReturnType: Task<ActionResult<ArticleImageDto>>
POST CreateArticleImage
api/article/{articleId}/gallery
ReturnType: Task<ActionResult<ArticleImageDto>>
PUT UpdateArticleImage
api/article/gallery/{id}
ReturnType: Task<ActionResult>
DELETE DeleteArticleImage
api/article/gallery/{id}
ReturnType: Task<ActionResult>
ArticleTypes
API
Actions:
GET GetAll
api/articletypes/GetAll
ReturnType: Task<ActionResult<IEnumerable<ArticleTypeDto>>>
GET GetById
api/articletypes/{id}
ReturnType: Task<ActionResult<ArticleTypeDto>>
GET GetActive
api/articletypes/active
ReturnType: Task<ActionResult<IEnumerable<ArticleTypeDto>>>
POST Create
api/articletypes/Create
ReturnType: Task<ActionResult<ArticleTypeDto>>
PUT Update
api/articletypes/{id}
ReturnType: Task<ActionResult>
DELETE Delete
api/articletypes/{id}
ReturnType: Task<ActionResult>
GET CheckNameExists
api/articletypes/check-name/{name}
ReturnType: Task<ActionResult<Boolean>>
GET GetStatistics
api/articletypes/statistics
ReturnType: Task<ActionResult>
Auth
API
Actions:
POST Login
api/auth/login
ReturnType: Task<ActionResult<LoginResponse>>
POST Register
api/auth/register
ReturnType: Task<ActionResult<User>>
GET GetUser
api/auth/{id}
ReturnType: Task<ActionResult<User>>
Complaints
API
Actions:
GET Test
api/complaints/test
ReturnType: ActionResult<Object>
GET GetAll
api/complaints/GetAll
ReturnType: Task<ActionResult<IEnumerable<ComplaintDto>>>
GET GetAllWithImages
api/complaints/with-images
ReturnType: Task<ActionResult<IEnumerable<ComplaintDto>>>
GET GetById
api/complaints/{id}
ReturnType: Task<ActionResult<ComplaintDto>>
GET GetByIdWithImages
api/complaints/{id}/with-images
ReturnType: Task<ActionResult<ComplaintDto>>
GET GetByBoxNumber
api/complaints/box/{boxNumber}
ReturnType: Task<ActionResult<IEnumerable<ComplaintDto>>>
GET GetByComplainTypeId
api/complaints/type/{complainTypeId}
ReturnType: Task<ActionResult<IEnumerable<ComplaintDto>>>
POST Create
api/complaints/Create
ReturnType: Task<ActionResult<ComplaintDto>>
POST CreateComplaintWithImages
api/complaints/with-images
ReturnType: Task<ActionResult<ComplaintDto>>
PUT Update
api/complaints/{id}
ReturnType: Task<ActionResult>
DELETE Delete
api/complaints/{id}
ReturnType: Task<ActionResult>
GET GetImages
api/complaints/{complaintId}/images
ReturnType: Task<ActionResult<IEnumerable<ComplaintImageDto>>>
GET GetImageById
api/complaints/images/{id}
ReturnType: Task<ActionResult<ComplaintImageDto>>
POST AddImage
api/complaints/{complaintId}/images
ReturnType: Task<ActionResult<ComplaintImageDto>>
PUT UpdateImage
api/complaints/images/{id}
ReturnType: Task<ActionResult>
DELETE DeleteImage
api/complaints/images/{id}
ReturnType: Task<ActionResult>
Discovery
API
Actions:
GET GetAllControllers
api/discovery/controllers
ReturnType: Task<ActionResult<IEnumerable<ControllerInfo>>>
GET GetController
api/discovery/controllers/{name}
ReturnType: Task<ActionResult<ControllerInfo>>
GET GetApiRoutes
api/discovery/routes/api
ReturnType: Task<ActionResult<IEnumerable<ActionInfo>>>
GET GetMvcRoutes
api/discovery/routes/mvc
ReturnType: Task<ActionResult<IEnumerable<ActionInfo>>>
EnhancedAuth
API
Actions:
POST Login
api/enhancedauth/login
ReturnType: Task<ActionResult<ShareholderAuthResponse>>
POST RefreshToken
api/enhancedauth/refresh
ReturnType: Task<ActionResult<ShareholderAuthResponse>>
POST RevokeToken
api/enhancedauth/revoke
ReturnType: Task<ActionResult>
GET GetProfile
api/enhancedauth/profile
ReturnType: Task<ActionResult<ShareholderProfileDto>>
GET ValidateToken
api/enhancedauth/validate
ReturnType: ActionResult
GET GetAuthStats
api/enhancedauth/stats
ReturnType: Task<ActionResult>
Invoice
API
Actions:
GET GetAll
api/invoice/GetAll
ReturnType: Task<ActionResult<IEnumerable<InvoiceMasterDto>>>
GET GetById
api/invoice/{id}
ReturnType: Task<ActionResult<InvoiceMasterDto>>
GET GetByBoxId
api/invoice/shareholder/{boxId}
ReturnType: Task<ActionResult<IEnumerable<InvoiceMasterDto>>>
GET GetWithDetails
api/invoice/{id}/details
ReturnType: Task<ActionResult<InvoiceMasterWithDetailsDto>>
GET GetAllWithDetails
api/invoice/with-details
ReturnType: Task<ActionResult<IEnumerable<InvoiceMasterWithDetailsDto>>>
POST Create
api/invoice/Create
ReturnType: Task<ActionResult<InvoiceMasterDto>>
PUT Update
api/invoice/{id}
ReturnType: Task<ActionResult>
DELETE Delete
api/invoice/{id}
ReturnType: Task<ActionResult>
GET GetInvoiceDetails
api/invoice/{invoiceMasterId}/items
ReturnType: Task<ActionResult<IEnumerable<InvoiceDetailsDto>>>
GET GetInvoiceDetailById
api/invoice/items/{id}
ReturnType: Task<ActionResult<InvoiceDetailsDto>>
POST CreateInvoiceDetail
api/invoice/{invoiceMasterId}/items
ReturnType: Task<ActionResult<InvoiceDetailsDto>>
PUT UpdateInvoiceDetail
api/invoice/items/{id}
ReturnType: Task<ActionResult>
DELETE DeleteInvoiceDetail
api/invoice/items/{id}
ReturnType: Task<ActionResult>
Items
API
Actions:
GET GetItemByBarcode
api/items/ByBarcode/{barcode}
ReturnType: Task<ActionResult<ItemDto>>
GET SearchItemsByDescription
api/items/ByDescription
ReturnType: Task<ActionResult<ItemSearchResultDto>>
GET GetItemById
api/items/{id:int}
ReturnType: Task<ActionResult<ItemDto>>
GET GetAllItems
api/items/GetAllItems
ReturnType: Task<ActionResult<ItemSearchResultDto>>
GET GetAllCategories
api/items/Categories
ReturnType: Task<ActionResult<IEnumerable<ItemCategoryDto>>>
GET GetFeaturedItems
api/items/Featured
ReturnType: Task<ActionResult<IEnumerable<ItemDto>>>
GET GetRecentItems
api/items/Recent
ReturnType: Task<ActionResult<IEnumerable<ItemDto>>>
GET GetOffers
api/items/Offers
ReturnType: Task<ActionResult<IEnumerable<ItemDto>>>
GET GetItemsByCategory
api/items/Category/{categoryId:int}
ReturnType: Task<ActionResult<IEnumerable<ItemDto>>>
GET CheckItemStock
api/items/{id:int}/Stock
ReturnType: Task<ActionResult<Object>>
Notification
API
Actions:
GET GetAll
api/notification/GetAll
ReturnType: Task<IActionResult>
GET GetById
api/notification/{id}
ReturnType: Task<IActionResult>
POST Create
api/notification/Create
ReturnType: Task<IActionResult>
PUT Update
api/notification/{id}
ReturnType: Task<IActionResult>
DELETE Delete
api/notification/{id}
ReturnType: Task<IActionResult>
GET GetUnseenByShareholder
api/notification/unseen/{shareholderId}
ReturnType: Task<IActionResult>
PUT MarkAsSeen
api/notification/mark-seen/{id}
ReturnType: Task<IActionResult>
GET GetDangerBroadcasts
api/notification/danger-broadcasts
ReturnType: Task<IActionResult>
RelationshipType
API
Actions:
GET GetAllActive
api/relationshiptype/GetAllActive
ReturnType: Task<ActionResult<IEnumerable<RelationshipTypeDto>>>
GET GetById
api/relationshiptype/{id}
ReturnType: Task<ActionResult<RelationshipTypeDto>>
GET GetByName
api/relationshiptype/name/{name}
ReturnType: Task<ActionResult<RelationshipTypeDto>>
POST Create
api/relationshiptype/Create
ReturnType: Task<ActionResult<RelationshipTypeDto>>
PUT Update
api/relationshiptype/{id}
ReturnType: Task<ActionResult>
DELETE Delete
api/relationshiptype/{id}
ReturnType: Task<ActionResult>
GET CheckNameExists
api/relationshiptype/check-name/{name}
ReturnType: Task<ActionResult<Boolean>>
RelativeApplication
API
Actions:
POST CreateApplicationAdvanced
api/relativeapplication/with-metadata
ReturnType: Task<ActionResult<EnhancedRelativeDto>>
GET GetById
api/relativeapplication/{id}
ReturnType: Task<ActionResult<EnhancedRelativeDto>>
POST UploadImage
api/relativeapplication/{id}/images/upload
ReturnType: Task<ActionResult>
GET GetRelativeImage
api/relativeapplication/images/{id}
ReturnType: Task<ActionResult>
Relative
API
Actions:
GET Test
api/relative/test
ReturnType: ActionResult<Object>
GET GetAll
api/relative/GetAll
ReturnType: Task<ActionResult<IEnumerable<EnhancedRelativeDto>>>
GET GetById
api/relative/{id}
ReturnType: Task<ActionResult<EnhancedRelativeDto>>
GET GetByParentSHID
api/relative/parent/{parentSHID}
ReturnType: Task<ActionResult<IEnumerable<EnhancedRelativeDto>>>
GET GetPendingApplications
api/relative/pending
ReturnType: Task<ActionResult<IEnumerable<EnhancedRelativeDto>>>
POST CreateApplication
api/relative/CreateApplication
ReturnType: Task<ActionResult<EnhancedRelativeDto>>
PUT UpdateApplication
api/relative/{id}
ReturnType: Task<ActionResult>
POST ProcessApproval
api/relative/{id}/approval
ReturnType: Task<ActionResult>
DELETE Delete
api/relative/{id}
ReturnType: Task<ActionResult>
GET CheckCivilIdExists
api/relative/check-civil-id/{civilId}
ReturnType: Task<ActionResult<Boolean>>
GET GetByCivilId
api/relative/civil-id/{civilId}
ReturnType: Task<ActionResult<EnhancedRelativeDto>>
GET GetRelationshipTypes
api/relative/relationship-types
ReturnType: Task<ActionResult<IEnumerable<RelationshipTypeDto>>>
GET GetRelativeImages
api/relative/{id}/images
ReturnType: Task<ActionResult<IEnumerable<RelativeImageDto>>>
POST AddRelativeImage
api/relative/{id}/images
ReturnType: Task<ActionResult<RelativeImageDto>>
RelativeImage
API
Actions:
GET GetRelativeImage
api/relativeimage/{id}
ReturnType: Task<ActionResult<RelativeImageDto>>
GET GetImagesByRelativeId
api/relativeimage/relative/{relativeId}
ReturnType: Task<ActionResult<IEnumerable<RelativeImageDto>>>
GET GetImagesByRelativeIdAndType
api/relativeimage/relative/{relativeId}/type/{imageType}
ReturnType: Task<ActionResult<IEnumerable<RelativeImageDto>>>
POST AddImageToRelative
api/relativeimage/relative/{relativeId}
ReturnType: Task<ActionResult<RelativeImageDto>>
POST AddMultipleImagesToRelative
api/relativeimage/relative/{relativeId}/multiple
ReturnType: Task<ActionResult<IEnumerable<RelativeImageDto>>>
PUT UpdateImage
api/relativeimage/{id}
ReturnType: Task<ActionResult>
DELETE DeleteImage
api/relativeimage/{id}
ReturnType: Task<ActionResult>
GET GetTotalFileSizeForRelative
api/relativeimage/relative/{relativeId}/total-size
ReturnType: Task<ActionResult<Int64>>
Shareholder
API
Actions:
GET GetAll
api/shareholder/GetAll
ReturnType: Task<ActionResult<IEnumerable<ShareholderDto>>>
GET GetById
api/shareholder/{boxId}
ReturnType: Task<ActionResult<ShareholderDto>>
GET GetByCivilId
api/shareholder/civil/{civilId}
ReturnType: Task<ActionResult<ShareholderDto>>
GET GetByName
api/shareholder/search/{name}
ReturnType: Task<ActionResult<IEnumerable<ShareholderDto>>>
GET GetWithRelatives
api/shareholder/{boxId}/relatives
ReturnType: Task<ActionResult<ShareholderWithRelativesDto>>
GET GetAllWithRelatives
api/shareholder/with-relatives
ReturnType: Task<ActionResult<IEnumerable<ShareholderWithRelativesDto>>>
POST Login
api/shareholder/login
ReturnType: Task<ActionResult>
POST Create
api/shareholder/Create
ReturnType: Task<ActionResult<ShareholderDto>>
PUT Update
api/shareholder/{boxId}
ReturnType: Task<ActionResult>
DELETE Delete
api/shareholder/{boxId}
ReturnType: Task<ActionResult>
MvcControllers
ApiDiscovery
MVC
Actions:
GET Index
/ApiDiscovery/Index
ReturnType: Task<IActionResult>
GET ApiRoutes
/ApiDiscovery/ApiRoutes
ReturnType: Task<IActionResult>
GET MvcRoutes
/ApiDiscovery/MvcRoutes
ReturnType: Task<IActionResult>
GET Controller
/ApiDiscovery/Controller
ReturnType: Task<IActionResult>
Home
MVC
Actions:
GET Index
/Home/Index
ReturnType: Task<IActionResult>
GET DarkModeTest
/Home/DarkModeTest
ReturnType: IActionResult
GET Login
/Home/Login
ReturnType: IActionResult
POST Login
/Home/Login
ReturnType: IActionResult
GET Privacy
/Home/Privacy
ReturnType: IActionResult
POST SetLanguage
/Home/SetLanguage
ReturnType: IActionResult
Language
MVC
Actions:
GET Test
/Language/Test
ReturnType: IActionResult
POST SetLanguage
/Language/SetLanguage
ReturnType: IActionResult
GET Audit
/Language/Audit
ReturnType: IActionResult
GET TestLocalization
/Language/TestLocalization
ReturnType: IActionResult
News
MVC
Actions:
GET Index
/News/Index
ReturnType: Task<IActionResult>
GET Details
/News/Details
ReturnType: Task<IActionResult>
POST Create
/News/Create
ReturnType: IActionResult
POST Create
/News/Create
ReturnType: Task<IActionResult>
GET Edit
/News/Edit
ReturnType: Task<IActionResult>
POST Edit
/News/Edit
ReturnType: Task<IActionResult>
DELETE Delete
/News/Delete
ReturnType: Task<IActionResult>
POST DeleteConfirmed
/News/DeleteConfirmed
ReturnType: Task<IActionResult>
GET ManageImages
/News/ManageImages
ReturnType: Task<IActionResult>
POST AddImage
/News/AddImage
ReturnType: Task<IActionResult>
POST DeleteImage
/News/DeleteImage
ReturnType: Task<IActionResult>
AdminAuth
MVC
Actions:
GET Login
Admin/Auth/Login
ReturnType: Task<IActionResult>
GET LoginNew
Admin/Auth/Admin/Auth/LoginNew
ReturnType: Task<IActionResult>
POST Login
Admin/Auth/Login
ReturnType: Task<IActionResult>
POST Logout
Admin/Auth/Logout
ReturnType: Task<IActionResult>
GET AccessDenied
Admin/Auth/AccessDenied
ReturnType: IActionResult
GET Status
Admin/Auth/Status
ReturnType: Task<IActionResult>
AdminDashboard
MVC
Actions:
GET Index
Admin/Dashboard
ReturnType: Task<IActionResult>
GET GetStats
Admin/Stats
ReturnType: Task<IActionResult>
GET Profile
Admin/Profile
ReturnType: Task<IActionResult>
AdminUsers
MVC
Actions:
GET Index
Admin/Users/Index
ReturnType: Task<IActionResult>
GET Details
Admin/Users/{id}
ReturnType: Task<IActionResult>
GET Create
Admin/Users/Create
ReturnType: Task<IActionResult>
POST Create
Admin/Users/Create
ReturnType: Task<IActionResult>
GET Edit
Admin/Users/{id}/Edit
ReturnType: Task<IActionResult>
POST Edit
Admin/Users/{id}/Edit
ReturnType: Task<IActionResult>
GET ChangePassword
Admin/Users/{id}/ChangePassword
ReturnType: Task<IActionResult>
POST ChangePassword
Admin/Users/{id}/ChangePassword
ReturnType: Task<IActionResult>
GET Delete
Admin/Users/{id}/Delete
ReturnType: Task<IActionResult>
POST DeleteConfirmed
Admin/Users/{id}/Delete
ReturnType: Task<IActionResult>
GET CheckUsername
Admin/Users/CheckUsername
ReturnType: Task<IActionResult>
GET CheckEmail
Admin/Users/CheckEmail
ReturnType: Task<IActionResult>
ArticleTypes
MVC
Actions:
GET Index
Admin/ArticleTypes/Index
ReturnType: Task<IActionResult>
GET Details
Admin/ArticleTypes/{id}
ReturnType: Task<IActionResult>
GET Create
Admin/ArticleTypes/Create
ReturnType: IActionResult
POST Create
Admin/ArticleTypes/Create
ReturnType: Task<IActionResult>
GET Edit
Admin/ArticleTypes/{id}/Edit
ReturnType: Task<IActionResult>
POST Edit
Admin/ArticleTypes/{id}/Edit
ReturnType: Task<IActionResult>
GET Delete
Admin/ArticleTypes/{id}/Delete
ReturnType: Task<IActionResult>
POST DeleteConfirmed
Admin/ArticleTypes/{id}/Delete
ReturnType: Task<IActionResult>
GET CheckName
Admin/ArticleTypes/CheckName
ReturnType: Task<IActionResult>
Loading...
Loading...

JS_Loading

Loading...
Loading...
MobileHome
MobileDiscovery
MobileDashboard
MobileSettings
MobileMore
MobileMenu
LanguageSettings
🇺🇸 EN English


AppName
Version 1.0.0