Product Manegement REST API
The product mangement system is made for a startup named Brainwave Assistive Technologies. The startup builds neurotechnology devices with the help of Brain Computer Interfaces. The product mangement system is meant for the employees of the company to help with supply chain management and logistics.
Swagger API Code Link
Swagger API Documentation Link
Github Documentation
Paypal VAP Class Repo
The following class diagram describes the relations between the entities used in the API.
- Product
Attributes | Description |
---|---|
ID | ID of the product |
Name | Name of the product |
Version | Version of the product |
DateCreated | Date on which the product was created |
wip | Work in progress |
- Supplier
Attributes | Description |
---|---|
ID | ID of the supplier |
name | Name of the supplier |
- Material
Attributes | Description |
---|---|
ID | ID of the material |
Name | Name of the material |
type | Type of the material: (raw, component) |
- Team
Attributes | Description |
---|---|
ID | Id of team |
- Members
Attributes | Description |
---|---|
empID | ID of the member |
Name | Name of the member |
Age | Age of the member |
- Warehouse
Attributes | Description |
---|---|
ID | ID of the warehouse |
Location | Location of the warehouse |
Capacity | Capacity of the warehouse |
- Factory
Attributes | Description |
---|---|
ID | ID of the factory |
Location | Location of the factory |
- Inventory
Attributes | Description |
---|---|
ID | ID of the inventory item |
storageType | Type of storage the item is stored in: (warehouse, store) |
StorageID | ID of the storage |
Quantity | Amount of items stored |
InventoryType | Type of item: (raw, component, product) |
ItemID | ID of the item stored |
- Store
Attributes | Description |
---|---|
ID | ID of the store |
location | Location of the store |
Ownership | Type of ownership: (1st Party, 3rd Party) |
Name | Name of store if third party |
- Schemas
- Parameters
- Error
- Security Schemas
- 200
- 400
- 401
- 404
Authentication
Tags
Request Body
Sucessful Response
Error Responses
GET Parameters
Multiple Examples
Query String
Security Scheme with scopes
Reusable Parameters
Reusable Responses
Reusable Schemas