OHMS PRO-360 UAT

PRO-360Retail API

Live reference for the Web POS and mobile app APIs, served by this UAT server.

Two APIs, one server

	Web POS	Mobile app
Built for	Back office and POS tills	The mobile app
Endpoints	87	63
Sections	11	10
Base path	`/api/v1`	`/api/v2`
Reference	/retail/web-pos/api-docs	/retail/mobile/v2/docs
OpenAPI file	Download JSON	Download JSON

Find an endpoint

All 150 routes on this server. Search by path, method or what the route does.

Search endpoints

150 endpoints

GET/api/v1/Web POS: API root
GET/api/v1/versionWeb POS: API version
POST/api/v1/auth/loginWeb POS: Login
POST/api/v1/auth/refresh-tokenWeb POS: Refresh access token
POST/api/v1/auth/logoutWeb POS: Logout
GET/api/v1/auth/meWeb POS: Current user
GET/api/v1/auth/pos/validate-deviceWeb POS: Validate POS device
POST/api/v1/auth/pos/verify-pinWeb POS: Verify POS device security PIN
POST/api/v1/auth/pos/register-deviceWeb POS: Self-register a POS device
POST/api/v1/auth/pos-loginWeb POS: POS device login
GET/api/v1/appsWeb POS: List apps
GET/api/v1/app-settingsWeb POS: Get global app settings
GET/api/v1/master/suppliersWeb POS: List suppliers (store-scoped)
GET/api/v1/master/categoriesWeb POS: List product categories (store-scoped)
GET/api/v1/master/brandsWeb POS: List brands (store-scoped)
GET/api/v1/permissions/menusWeb POS: List menus
GET/api/v1/permissions/meWeb POS: Current user permissions by role
GET/api/v1/usersWeb POS: List users
GET/api/v1/storesWeb POS: List stores
POST/api/v1/storesWeb POS: Create store
GET/api/v1/pos-devicesWeb POS: List POS devices
POST/api/v1/pos-devicesWeb POS: Add POS device
PUT/api/v1/pos-devices/{id}Web POS: Update POS device
DELETE/api/v1/pos-devices/{id}Web POS: Remove POS device
GET/api/v1/pos-cashiersWeb POS: List POS cashiers
POST/api/v1/pos-cashiersWeb POS: Add POS cashier
PUT/api/v1/pos-cashiers/{id}Web POS: Update POS cashier
DELETE/api/v1/pos-cashiers/{id}Web POS: Remove POS cashier
POST/api/v1/pos/cashier-loginWeb POS: Identify cashier by cashier_code + PIN
GET/api/v1/products/next-codeWeb POS: Get next product code
GET/api/v1/products/peek-next-codeWeb POS: Peek next product code
GET/api/v1/products/current-codeWeb POS: Get current product code
GET/api/v1/products/next-variant-codeWeb POS: Get next variant code
GET/api/v1/products/peek-next-variant-codeWeb POS: Peek next variant code
GET/api/v1/products/current-variant-codeWeb POS: Get current variant code
POST/api/v1/products/importWeb POS: Import products
GET/api/v1/products/exportWeb POS: Export products
GET/api/v1/productsWeb POS: List products
POST/api/v1/productsWeb POS: Create product
GET/api/v1/products/{id}Web POS: Get product by ID
PUT/api/v1/products/{id}Web POS: Update product
DELETE/api/v1/products/{id}Web POS: Delete product
POST/api/v1/products/{id}/imagesWeb POS: Upload product image
DELETE/api/v1/products/{id}/images/{imageId}Web POS: Delete product image
GET/api/v1/pos/productsWeb POS: List POS products
GET/api/v1/pos/products/{id}Web POS: Get POS product by ID
GET/api/v1/pos/products/by-barcode/{barcode}Web POS: Get product by barcode
POST/api/v1/pos/products/{id}/generate-barcodeWeb POS: Generate barcode for product
POST/api/v1/pos/barcode/validateWeb POS: Validate barcode
POST/api/v1/pos/barcode/generateWeb POS: Generate barcode
GET/api/v1/pos/barcode/image/{barcode}Web POS: Get barcode image
GET/api/v1/pos/barcode/preview-for-productWeb POS: Preview barcode for product
GET/api/v1/pos/pos-settingsWeb POS: Get POS settings
POST/api/v1/pos/pos-settingsWeb POS: Update POS settings
GET/api/v1/pos/barcode-settingsWeb POS: Get barcode settings
POST/api/v1/pos/barcode-settingsWeb POS: Update barcode settings
GET/api/v1/products/setting/taxesWeb POS: List taxes (paginated)
POST/api/v1/products/setting/taxesWeb POS: Create tax
PUT/api/v1/products/setting/taxes/{id}Web POS: Update tax
DELETE/api/v1/products/setting/taxes/{id}Web POS: Delete tax
GET/api/v1/products/setting/brandsWeb POS: List brands (paginated)
POST/api/v1/products/setting/brandsWeb POS: Create brand
PUT/api/v1/products/setting/brands/{id}Web POS: Update brand
DELETE/api/v1/products/setting/brands/{id}Web POS: Delete brand
GET/api/v1/products/setting/unitsWeb POS: List units (paginated)
POST/api/v1/products/setting/unitsWeb POS: Create unit
PUT/api/v1/products/setting/units/{id}Web POS: Update unit
DELETE/api/v1/products/setting/units/{id}Web POS: Delete unit
GET/api/v1/products/setting/categoriesWeb POS: List product categories (paginated)
POST/api/v1/products/setting/categoriesWeb POS: Create category
PUT/api/v1/products/setting/categories/{id}Web POS: Update category
DELETE/api/v1/products/setting/categories/{id}Web POS: Delete category
GET/api/v1/products/setting/variant-attributesWeb POS: List variant attributes
POST/api/v1/products/setting/variant-attributesWeb POS: Create variant attribute
PUT/api/v1/products/setting/variant-attributes/{id}Web POS: Update variant attribute
DELETE/api/v1/products/setting/variant-attributes/{id}Web POS: Delete variant attribute
GET/api/v1/products/setting/variant-attributes/{attributeId}/valuesWeb POS: List attribute values
POST/api/v1/products/setting/variant-attributes/{attributeId}/valuesWeb POS: Create attribute value
PUT/api/v1/products/setting/variant-attributes/{attributeId}/values/{id}Web POS: Update attribute value
DELETE/api/v1/products/setting/variant-attributes/{attributeId}/values/{id}Web POS: Delete attribute value
GET/api/v1/products/setting/sequencesWeb POS: List sequences
POST/api/v1/products/setting/sequencesWeb POS: Create sequence
PUT/api/v1/products/setting/sequences/{module}Web POS: Update sequence
GET/api/v1/products/setting/payment-settingsWeb POS: List payment settings
POST/api/v1/products/setting/payment-settingsWeb POS: Create payment setting
PUT/api/v1/products/setting/payment-settings/{id}Web POS: Update payment setting
DELETE/api/v1/products/setting/payment-settings/{id}Web POS: Delete payment setting
GET/api/v2/Mobile: API root
GET/api/v2/versionMobile: API version
POST/api/v2/auth/loginMobile: Login
POST/api/v2/auth/refresh-tokenMobile: Refresh access token
POST/api/v2/auth/logoutMobile: Logout
GET/api/v2/auth/meMobile: Current user
GET/api/v2/master/suppliersMobile: List suppliers (store-scoped)
GET/api/v2/master/categoriesMobile: List product categories (store-scoped)
GET/api/v2/master/brandsMobile: List brands (store-scoped)
GET/api/v2/products/next-codeMobile: Get next product code
GET/api/v2/products/peek-next-codeMobile: Peek next product code
GET/api/v2/products/current-codeMobile: Get current product code
GET/api/v2/products/next-variant-codeMobile: Get next variant code
GET/api/v2/products/peek-next-variant-codeMobile: Peek next variant code
GET/api/v2/products/current-variant-codeMobile: Get current variant code
GET/api/v2/products/exportMobile: Export products
GET/api/v2/productsMobile: List products
GET/api/v2/products/{id}Mobile: Get product by ID
GET/api/v2/pos/productsMobile: List POS products
GET/api/v2/pos/products/{id}Mobile: Get POS product by ID
GET/api/v2/pos/products/by-barcode/{barcode}Mobile: Get product by barcode
GET/api/v2/products/setting/taxesMobile: List taxes (paginated)
GET/api/v2/products/setting/brandsMobile: List brands (paginated)
GET/api/v2/products/setting/unitsMobile: List units (paginated)
GET/api/v2/products/setting/categoriesMobile: List product categories (paginated)
GET/api/v2/products/setting/variant-attributesMobile: List variant attributes
GET/api/v2/products/setting/variant-attributes/{attributeId}/valuesMobile: List attribute values
GET/api/v2/products/setting/sequencesMobile: List sequences
GET/api/v2/products/setting/payment-settingsMobile: List payment settings
GET/api/v2/pos/dashboardMobile: Sales summary
GET/api/v2/pos/pos-settingsMobile: Till settings
GET/api/v2/storesMobile: List branches
POST/api/v2/pos/salesMobile: Complete a sale
GET/api/v2/pos/salesMobile: List bills
GET/api/v2/pos/sales/detailMobile: Bill detail
POST/api/v2/pos/send-receipt-emailMobile: Email a receipt
POST/api/v2/mobile/returnsMobile: Refund against a bill
GET/api/v2/mobile/returnsMobile: List refunds
GET/api/v2/mobile/stock-takesMobile: List counts
POST/api/v2/mobile/stock-takesMobile: Start a count
GET/api/v2/mobile/stock-takes/{id}Mobile: Count detail and review
PUT/api/v2/mobile/stock-takes/{id}/linesMobile: Record a shelf count
POST/api/v2/mobile/stock-takes/{id}/submitMobile: Submit for approval
GET/api/v2/purchase/ordersMobile: List purchase orders
POST/api/v2/purchase/ordersMobile: Create a purchase order
GET/api/v2/purchase/orders/{id}Mobile: Purchase order detail
POST/api/v2/purchase/orders/{id}/submitMobile: Submit to admin
GET/api/v2/purchase/suppliers/{supplierId}/products/{productId}/previous-priceMobile: Last price paid
GET/api/v2/mobile/transfersMobile: List transfers
POST/api/v2/mobile/transfersMobile: Send stock to a branch
POST/api/v2/mobile/transfers/requestsMobile: Request stock from a branch
GET/api/v2/mobile/transfers/{id}Mobile: Transfer detail
POST/api/v2/mobile/transfers/{id}/dispatchMobile: Approve and send a request
POST/api/v2/mobile/transfers/{id}/rejectMobile: Reject a request
POST/api/v2/mobile/transfers/{id}/receiveMobile: Receive a transfer
GET/api/v2/pos/sales-reportsMobile: Sales reports
GET/api/v2/mobile/shifts/currentMobile: Current shift
POST/api/v2/mobile/shifts/openMobile: Open a shift
POST/api/v2/mobile/shifts/closeMobile: Close the shift
GET/api/v2/mobile/admin/branchesMobile: All branches at a glance
GET/api/v2/mobile/admin/approvalsMobile: Approval queue
POST/api/v2/mobile/admin/stock-takes/{id}/approveMobile: Approve a count
POST/api/v2/mobile/admin/stock-takes/{id}/rejectMobile: Reject a count