vmi-api

name	Vmi API
description	Use when working with distributors, health check, inv profile hdr, inv profile line, inv warehouse, products, restock hdr, restock line, sections, seed, usage hdr, usage line, usage line warranty, warehouse, warehouse x users, or making API calls to https://vmi.augur-api.com.
version	1.0.5

Vmi

Service-specific knowledge for vmi microservice.

API Documentation

• OpenAPI Specification
• Postman Collection

Authentication

All endpoints except /health-check and /ping require bearer token authentication. See authentication.md for details.

API Endpoints

distributors

Method	Endpoint	Description	Details
GET	/distributors/{distributorsUid}	Get distributor Details	distributors.md
PUT	/distributors/{distributorsUid}	Update distributor	distributors.md
DELETE	/distributors/{distributorsUid}	DELETE distributor	distributors.md
PUT	/distributors/{distributorsUid}/enable	Enable/Disable/Delete distributor	distributors.md
GET	/distributors	List distributors	distributors.md
POST	/distributors	Create distributor	distributors.md

health_check

Method	Endpoint	Description	Details
GET	/health-check	Health Check	health_check.md
GET	/ping	Ping to get Pong	health_check.md

inv_profile_hdr

Method	Endpoint	Description	Details
GET	/inv-profile-hdr/{invProfileHdrUid}	Get Inventory Profile Header Details	inv_profile_hdr.md
PUT	/inv-profile-hdr/{invProfileHdrUid}	Update Inventory Profile Header	inv_profile_hdr.md
DELETE	/inv-profile-hdr/{invProfileHdrUid}	DELETE Inventory Profile Header	inv_profile_hdr.md
GET	/inv-profile-hdr	List Inventory Profile Headers	inv_profile_hdr.md
POST	/inv-profile-hdr	Create Inventory Profile Header	inv_profile_hdr.md
POST	/inv-profile-hdr/{customerId}/upload	Upload Excel file to create inventory profile headers	inv_profile_hdr.md

inv_profile_line

Method	Endpoint	Description	Details
GET	/inv-profile-hdr/{invProfileHdrUid}/inv-profile-line/{invProfileLineUid}	Get Inventory Profile line Details	inv_profile_line.md
PUT	/inv-profile-hdr/{invProfileHdrUid}/inv-profile-line/{invProfileLineUid}	Update Inventory Profile line	inv_profile_line.md
DELETE	/inv-profile-hdr/{invProfileHdrUid}/inv-profile-line/{invProfileLineUid}	DELETE Inventory Profile Line	inv_profile_line.md
GET	/inv-profile-hdr/{invProfileHdrUid}/inv-profile-line	List Inventory Profile Lines	inv_profile_line.md
POST	/inv-profile-hdr/{invProfileHdrUid}/inv-profile-line	Create Inventory Profile Lines	inv_profile_line.md

inv_warehouse

Method	Endpoint	Description	Details
POST	/warehouse/{warehouseUid}/adjust	Adjust Inventory	inv_warehouse.md
GET	/warehouse/{warehouseUid}/availability	List inventory availability	inv_warehouse.md
POST	/warehouse/{warehouseUid}/receive	Receive Inventory	inv_warehouse.md
GET	/warehouse/{warehouseUid}/replenish	Get Replenish Information	inv_warehouse.md
POST	/warehouse/{warehouseUid}/replenish	Replenish Inventory	inv_warehouse.md
POST	/warehouse/{warehouseUid}/transfer	Transfer Inventory	inv_warehouse.md

products

Method	Endpoint	Description	Details
POST	/distributors/{distributorsUid}/products	Create Product	products.md
GET	/products/{productsUid}	Get Product Details	products.md
PUT	/products/{productsUid}	Update Product	products.md
DELETE	/products/{productsUid}	DELETE Product	products.md
PUT	/products/{productsUid}/enable	Enable/Disable/Delete Product	products.md
GET	/products/find	Find products and items	products.md
GET	/products	List products	products.md

restock_hdr

Method	Endpoint	Description	Details
GET	/restock-hdr/{restockHdrUid}	Get Restock Header Details	restock_hdr.md
PUT	/restock-hdr/{restockHdrUid}	Update Restock Header	restock_hdr.md
DELETE	/restock-hdr/{restockHdrUid}	DELETE Restock Header	restock_hdr.md
GET	/restock-hdr	List Restock Headers	restock_hdr.md
POST	/restock-hdr	Create Restock Header	restock_hdr.md

sections

Method	Endpoint	Description	Details
GET	/sections/{sectionsUid}	Get section Details	sections.md
PUT	/sections/{sectionsUid}	Update section	sections.md
DELETE	/sections/{sectionsUid}	DELETE section	sections.md
PUT	/sections/{sectionsUid}/enable	Enable/Disable/Delete section	sections.md
GET	/sections	List sections	sections.md
POST	/sections	Create section	sections.md

usage_hdr

Method	Endpoint	Description	Details
POST	/warehouse/{warehouseUid}/usage	Use Inventory	usage_hdr.md

warehouse

Method	Endpoint	Description	Details
GET	/warehouse/{warehouseUid}	Get Warehouse Details	warehouse.md
PUT	/warehouse/{warehouseUid}	Update Warehouse	warehouse.md
DELETE	/warehouse/{warehouseUid}	DELETE Warehouse	warehouse.md
PUT	/warehouse/{warehouseUid}/enable	Enable/Disable/Delete Warehouse	warehouse.md
GET	/warehouse	List Warehouses	warehouse.md
POST	/warehouse	Create Warehouse	warehouse.md

warehouse_x_users

Method	Endpoint	Description	Details
GET	/warehouse/{warehouseUid}/users/{usersId}	Get Warehouse User Assignment	warehouse_x_users.md
PUT	/warehouse/{warehouseUid}/users/{usersId}	Update Warehouse User Assignment	warehouse_x_users.md
DELETE	/warehouse/{warehouseUid}/users/{usersId}	Remove User from Warehouse (sets status_cd to 700)	warehouse_x_users.md
GET	/warehouse/{warehouseUid}/users	List Warehouses Users	warehouse_x_users.md
POST	/warehouse/{warehouseUid}/users	Create/Update Warehouse User	warehouse_x_users.md