Florida Traceability REST API

https://sandbox.api.licensee.fl.biotr.ac/documentation/index.html#/
Admin
REST API for BioTrackTHC's cannabis traceability platform in Florida, providing endpoints for...
Tokens:25,415
Snippets:86
Trust Score:5.1
Update:7 months ago
Show doc for...
Tokens:
Raw
### Licensee Lab Testing API

Source: https://sandbox.api.licensee.fl.biotr.ac/documentation/index.html#

Endpoints for creating samples and getting lab information.

```APIDOC
## GET /v1/inventory/lab/sample

### Description
Get list of lab samples

### Method
GET

### Endpoint
/v1/inventory/lab/sample

## PUT /v1/inventory/lab/sample/void

### Description
Void inventory lab samples.

### Method
PUT

### Endpoint
/v1/inventory/lab/sample/void

## GET /v1/inventory/lab/sample/{inventoryid}

### Description
Get a lab sample

### Method
GET

### Endpoint
/v1/inventory/lab/sample/{inventoryid}

## GET /v1/inventory/lab/test

### Description
Get Lab Tests

### Method
GET

### Endpoint
/v1/inventory/lab/test

## GET /v1/inventory/lab/test/result

### Description
Get inventory lab test results

### Method
GET

### Endpoint
/v1/inventory/lab/test/result

## POST /v1/inventory/{id}/lab/sample

### Description
Post a new lab sample

### Method
POST

### Endpoint
/v1/inventory/{id}/lab/sample

## GET /v1/lab

### Description
Get list of labs

### Method
GET

### Endpoint
/v1/lab

## GET /v1/lab/{id}

### Description
Get a lab

### Method
GET

### Endpoint
/v1/lab/{id}
```

--------------------------------

### Processor Workflow - Create QA Sample

Source: https://sandbox.api.licensee.fl.biotr.ac/documentation/index.html#

Generate a QA sample from an inventory item for lab testing using the POST /v1/inventory/{id}/lab/sample endpoint. This initiates the quality assurance process.

```HTTP
POST /v1/inventory/{id}/lab/sample
Host: api.biotrack.com
Authorization: Bearer <session_token>
Content-Type: application/json

{
  "sample_type": "potency",
  "quantity": 1,
  "unit": "gram"
}
```

--------------------------------

### Inbound Inventory Transfer - Check for Transfers

Source: https://sandbox.api.licensee.fl.biotr.ac/documentation/index.html#

Query for all inbound inventory transfers assigned to your facility using the GET /v1/inventory/transfer endpoint. This allows you to see pending deliveries.

```HTTP
GET /v1/inventory/transfer
Host: api.biotrack.com
Authorization: Bearer <session_token>
```

--------------------------------

### Cultivation Workflow - Create Inventory Source

Source: https://sandbox.api.licensee.fl.biotr.ac/documentation/index.html#

Create an initial inventory source, such as seeds or clones, using the POST /v1/inventory endpoint. This serves as the origin for new plant material.

```HTTP
POST /v1/inventory
Host: api.biotrack.com
Authorization: Bearer <session_token>
Content-Type: application/json

{
  "name": "Seed Lot A",
  "type": "seed",
  "quantity": 1000,
  "unit": "seeds"
}
```

--------------------------------

### Cultivation Workflow - Create Plant from Inventory Source

Source: https://sandbox.api.licensee.fl.biotr.ac/documentation/index.html#

Generate new plants by linking them to an existing inventory source using the POST /v1/plant endpoint. This action tracks the propagation of plant material.

```HTTP
POST /v1/plant
Host: api.biotrack.com
Authorization: Bearer <session_token>
Content-Type: application/json

{
  "inventory_id": "inventory_source_id",
  "plant_room_id": "plant_room_id",
  "quantity": 50
}
```

--------------------------------

### Cultivation Workflow - Create Plant Room

Source: https://sandbox.api.licensee.fl.biotr.ac/documentation/index.html#

Initiate the cultivation process by creating a plant room using the POST /v1/plant/room endpoint. This step is fundamental for organizing and tracking plants within the system.

```HTTP
POST /v1/plant/room
Host: api.biotrack.com
Authorization: Bearer <session_token>
Content-Type: application/json

{
  "name": "Vegetative Room 1",
  "facility_id": "your_facility_id"
}
```

--------------------------------

### Processor Workflow - Apply Ingredients

Source: https://sandbox.api.licensee.fl.biotr.ac/documentation/index.html#

Record the application of ingredients to an inventory item using the POST /v1/inventory/ingredient endpoint. This is relevant for recipes and formulations.

```HTTP
POST /v1/inventory/ingredient
Host: api.biotrack.com
Authorization: Bearer <session_token>
Content-Type: application/json

{
  "inventory_id": "inventory_id",
  "ingredient_name": "Terpene Blend X",
  "quantity": 5,
  "unit": "ml"
}
```

--------------------------------

### Fulfillment and Storage Workflow - Create Inventory Room

Source: https://sandbox.api.licensee.fl.biotr.ac/documentation/index.html#

Establish an inventory room for storing finished products using the POST /v1/inventory/room endpoint. This is essential for managing storage and fulfillment.

```HTTP
POST /v1/inventory/room
Host: api.biotrack.com
Authorization: Bearer <session_token>
Content-Type: application/json

{
  "name": "Retail Storage",
  "facility_id": "your_facility_id"
}
```

--------------------------------

### API Authentication - Licensee Login

Source: https://sandbox.api.licensee.fl.biotr.ac/documentation/index.html#

Obtain an authentication token for licensee API access by sending a POST request to the /v1/user/login endpoint. The response contains a session token valid for 7 days.

```HTTP
POST /v1/user/login
Host: api.biotrack.com
Content-Type: application/json

{
  "username": "your_username",
  "password": "your_password"
}
```

--------------------------------

### Manifest API

Source: https://sandbox.api.licensee.fl.biotr.ac/documentation/index.html#

Endpoints for creating and managing manifests.

```APIDOC
## GET /v1/manifest

### Description
Get list manifests

### Method
GET

### Endpoint
/v1/manifest

## POST /v1/manifest

### Description
Create a new manifest.

### Method
POST

### Endpoint
/v1/manifest

## GET /v1/manifest/pickup

### Description
Get list manifest pickups

### Method
GET

### Endpoint
/v1/manifest/pickup

## POST /v1/manifest/pickup

### Description
Create a new pickup manifest.

### Method
POST

### Endpoint
/v1/manifest/pickup

## PUT /v1/manifest/pickup/{id}

### Description
Update manifest pickup

### Method
PUT

### Endpoint
/v1/manifest/pickup/{id}

## PUT /v1/manifest/pickup/{id}/modify

### Description
Sender update manifest pickup

### Method
PUT

### Endpoint
/v1/manifest/pickup/{id}/modify

## GET /v1/manifest/{id}

### Description
Get manifest.

### Method
GET

### Endpoint
/v1/manifest/{id}

## PUT /v1/manifest/{id}

### Description
Update manifest.

### Method
PUT

### Endpoint
/v1/manifest/{id}

## PUT /v1/manifest/{id}/stop/{stopnumber}/arrive

### Description
Arrive at a manifest stop.

### Method
PUT

### Endpoint
/v1/manifest/{id}/stop/{stopnumber}/arrive

## PUT /v1/manifest/{id}/stop/{stopnumber}/arrive/undo

### Description
Undo stop arrive action.

### Method
PUT

### Endpoint
/v1/manifest/{id}/stop/{stopnumber}/arrive/undo

## PUT /v1/manifest/{id}/void

### Description
Void manifest.

### Method
PUT

### Endpoint
/v1/manifest/{id}/void
```

--------------------------------

### Plant Room Management API

Source: https://sandbox.api.licensee.fl.biotr.ac/documentation/index.html#

Endpoints for creating and managing plant rooms.

```APIDOC
## GET /v1/plant/room

### Description
List all plant rooms.

### Method
GET

### Endpoint
/v1/plant/room

### Response
#### Success Response (200)
- **rooms** (array) - List of plant room objects
  - **id** (integer) - Plant room ID
  - **name** (string) - Name of the plant room

#### Response Example
{
  "rooms": [
    {
      "id": 101,
      "name": "Growth Chamber A"
    }
  ]
}
```

```APIDOC
## POST /v1/plant/room/

### Description
Add a new plant room.

### Method
POST

### Endpoint
/v1/plant/room/

### Parameters
#### Request Body
- **name** (string) - Required - The name of the new plant room

### Request Example
{
  "name": "Propagation Area"
}

### Response
#### Success Response (201)
- **id** (integer) - The ID of the newly created plant room
- **name** (string) - The name of the new plant room

#### Response Example
{
  "id": 102,
  "name": "Propagation Area"
}
```

```APIDOC
## DELETE /v1/plant/room/{id}

### Description
Delete a plant room.

### Method
DELETE

### Endpoint
/v1/plant/room/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the plant room to delete

### Response
#### Success Response (204)
- No content is returned upon successful deletion.

#### Response Example
(No content)
```

```APIDOC
## GET /v1/plant/room/{id}

### Description
View details of a specific plant room.

### Method
GET

### Endpoint
/v1/plant/room/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the plant room to view

### Response
#### Success Response (200)
- **id** (integer) - Plant room ID
- **name** (string) - Name of the plant room

#### Response Example
{
  "id": 101,
  "name": "Growth Chamber A"
}
```

```APIDOC
## PUT /v1/plant/room/{id}

### Description
Modify an existing plant room.

### Method
PUT

### Endpoint
/v1/plant/room/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the plant room to modify

#### Request Body
- **name** (string) - Required - The new name for the plant room

### Request Example
{
  "name": "Modified Growth Chamber A"
}

### Response
#### Success Response (200)
- **id** (integer) - The ID of the modified plant room
- **name** (string) - The new name of the plant room

#### Response Example
{
  "id": 101,
  "name": "Modified Growth Chamber A"
}
```

--------------------------------

### Inventory Room Management API

Source: https://sandbox.api.licensee.fl.biotr.ac/documentation/index.html#

Endpoints for creating and managing inventory rooms.

```APIDOC
## GET /v1/inventory/room

### Description
Get a list of all inventory rooms.

### Method
GET

### Endpoint
/v1/inventory/room

### Response
#### Success Response (200)
- **rooms** (array) - List of inventory room objects
  - **id** (integer) - Inventory room ID
  - **name** (string) - Name of the inventory room

#### Response Example
{
  "rooms": [
    {
      "id": 201,
      "name": "Main Warehouse"
    }
  ]
}
```

```APIDOC
## POST /v1/inventory/room

### Description
Add a new room to the inventory rooms.

### Method
POST

### Endpoint
/v1/inventory/room

### Parameters
#### Request Body
- **name** (string) - Required - The name of the new inventory room

### Request Example
{
  "name": "Cold Storage"
}

### Response
#### Success Response (201)
- **id** (integer) - The ID of the newly created inventory room
- **name** (string) - The name of the new inventory room

#### Response Example
{
  "id": 202,
  "name": "Cold Storage"
}
```

```APIDOC
## DELETE /v1/inventory/room/{id}

### Description
Delete a room from the inventory rooms.

### Method
DELETE

### Endpoint
/v1/inventory/room/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the inventory room to delete

### Response
#### Success Response (204)
- No content is returned upon successful deletion.

#### Response Example
(No content)
```

```APIDOC
## GET /v1/inventory/room/{id}

### Description
Get details of a specific inventory room.

### Method
GET

### Endpoint
/v1/inventory/room/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the inventory room to retrieve

### Response
#### Success Response (200)
- **id** (integer) - Inventory room ID
- **name** (string) - Name of the inventory room

#### Response Example
{
  "id": 201,
  "name": "Main Warehouse"
}
```

```APIDOC
## PUT /v1/inventory/room/{id}

### Description
Modify an existing inventory room.

### Method
PUT

### Endpoint
/v1/inventory/room/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the inventory room to modify

#### Request Body
- **name** (string) - Required - The new name for the inventory room

### Request Example
{
  "name": "Updated Main Warehouse"
}

### Response
#### Success Response (200)
- **id** (integer) - The ID of the modified inventory room
- **name** (string) - The new name of the inventory room

#### Response Example
{
  "id": 201,
  "name": "Updated Main Warehouse"
}
```

--------------------------------

### Manifest and Driver Management API

Source: https://sandbox.api.licensee.fl.biotr.ac/documentation/index.html#

Endpoints for managing manifests, including drivers, pickups, and stops.

```APIDOC
## POST /manifests

### Description
Creates a new manifest.

### Method
POST

### Endpoint
/manifests

### Parameters
#### Request Body
- **manifestData** (forms.ManifestPost) - Required - Data for the new manifest.

### Request Example
```json
{
  "manifestData": {
    "driverId": "driver-xyz",
    "vehicleId": "vehicle-abc",
    "pickupLocation": "Location A",
    "destinationLocation": "Location B"
  }
}
```

### Response
#### Success Response (200)
- **manifestId** (string) - The ID of the newly created manifest.
- **message** (string) - A success message.

#### Response Example
```json
{
  "manifestId": "manifest-12345",
  "message": "Manifest created successfully."
}
```

## PUT /manifests

### Description
Updates an existing manifest.

### Method
PUT

### Endpoint
/manifests

### Parameters
#### Request Body
- **manifestData** (forms.ManifestPut) - Required - Data for updating the manifest.

### Request Example
```json
{
  "manifestData": {
    "manifestId": "manifest-12345",
    "destinationLocation": "Updated Location B"
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - A success message.

#### Response Example
```json
{
  "message": "Manifest updated successfully."
}
```

## POST /manifests/driver

### Description
Assigns a driver to a manifest.

### Method
POST

### Endpoint
/manifests/driver

### Parameters
#### Request Body
- **driverData** (forms.ManifestPostDriver) - Required - Data for assigning a driver.

### Request Example
```json
{
  "driverData": {
    "manifestId": "manifest-12345",
    "driverId": "driver-xyz"
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - A success message.

#### Response Example
```json
{
  "message": "Driver assigned to manifest successfully."
}
```

## POST /manifests/pickup

### Description
Records a pickup for a manifest.

### Method
POST

### Endpoint
/manifests/pickup

### Parameters
#### Request Body
- **pickupData** (forms.ManifestPickupPost) - Required - Data for the pickup.

### Request Example
```json
{
  "pickupData": {
    "manifestId": "manifest-12345",
    "stopId": "stop-abc",
    "items": [
      {
        "itemId": "item-1",
        "quantity": 10
      }
    ]
  }
}
```

### Response
#### Success Response (200)
- **pickupId** (string) - The ID of the pickup.
- **message** (string) - A success message.

#### Response Example
```json
{
  "pickupId": "pickup-def456
```

--------------------------------

### Plant Management API

Source: https://sandbox.api.licensee.fl.biotr.ac/documentation/index.html#

Endpoints for creating and managing plants, including their lifecycle and inventory conversion.

```APIDOC
## GET /v1/plant

### Description
Get a list of all plants.

### Method
GET

### Endpoint
/v1/plant

### Parameters
#### Query Parameters
- **room_id** (integer) - Optional - Filter plants by inventory room ID

### Response
#### Success Response (200)
- **plants** (array) - List of plant objects
  - **id** (integer) - Plant ID
  - **name** (string) - Name of the plant
  - **room_id** (integer) - ID of the room the plant is in

#### Response Example
{
  "plants": [
    {
      "id": 301,
      "name": "Strain A - Clone 1",
      "room_id": 201
    }
  ]
}
```

```APIDOC
## POST /v1/plant

### Description
Add new plants.

### Method
POST

### Endpoint
/v1/plant

### Parameters
#### Request Body
- **plants** (array) - Required - An array of plant objects to add
  - **name** (string) - Required - Name of the plant
  - **room_id** (integer) - Required - ID of the room to place the plant in

### Request Example
{
  "plants": [
    {
      "name": "Strain B - Clone 1",
      "room_id": 201
    },
    {
      "name": "Strain B - Clone 2",
      "room_id": 201
    }
  ]
}

### Response
#### Success Response (201)
- **created_plants** (array) - List of newly created plant objects with their IDs

#### Response Example
{
  "created_plants": [
    {
      "id": 302,
      "name": "Strain B - Clone 1",
      "room_id": 201
    },
    {
      "id": 303,
      "name": "Strain B - Clone 2",
      "room_id": 201
    }
  ]
}
```

```APIDOC
## PUT /v1/plant/convert/inventory

### Description
Convert plants to inventory.

### Method
PUT

### Endpoint
/v1/plant/convert/inventory

### Parameters
#### Request Body
- **plant_ids** (array) - Required - Array of plant IDs to convert
- **inventory_room_id** (integer) - Required - The ID of the inventory room to move the converted inventory to

### Request Example
{
  "plant_ids": [301, 302],
  "inventory_room_id": 201
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message

#### Response Example
{
  "message": "Plants successfully converted to inventory."
}
```

```APIDOC
## PUT /v1/plant/destroy

### Description
Finalize the destruction of plants.

### Method
PUT

### Endpoint
/v1/plant/destroy

### Parameters
#### Request Body
- **plant_ids** (array) - Required - Array of plant IDs to be destroyed

### Request Example
{
  "plant_ids": [301]
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message

#### Response Example
{
  "message": "Plants marked for destruction."
}
```

```APIDOC
## PUT /v1/plant/destroy/schedule

### Description
Schedule the destruction of plants.

### Method
PUT

### Endpoint
/v1/plant/destroy/schedule

### Parameters
#### Request Body
- **plant_ids** (array) - Required - Array of plant IDs to schedule for destruction
- **destruction_date** (string) - Required - The date for destruction (YYYY-MM-DD)

### Request Example
{
  "plant_ids": [302],
  "destruction_date": "2024-12-31"
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message

#### Response Example
{
  "message": "Plants scheduled for destruction."
}
```

```APIDOC
## PUT /v1/plant/destroy/schedule/undo

### Description
Undo a scheduled destruction of plants.

### Method
PUT

### Endpoint
/v1/plant/destroy/schedule/undo

### Parameters
#### Request Body
- **plant_ids** (array) - Required - Array of plant IDs to unschedule from destruction

### Request Example
{
  "plant_ids": [302]
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message

#### Response Example
{
  "message": "Scheduled plant destruction undone."
}
```

```APIDOC
## POST /v1/plant/initial

### Description
Add initial plants to the system.

### Method
POST

### Endpoint
/v1/plant/initial

### Parameters
#### Request Body
- **plants** (array) - Required - An array of initial plant objects
  - **name** (string) - Required - Name of the plant
  - **room_id** (integer) - Required - ID of the room the plant is in

### Request Example
{
  "plants": [
    {
      "name": "Mother Plant 1",
      "room_id": 101
    }
  ]
}

### Response
#### Success Response (201)
- **created_plants** (array) - List of newly created initial plant objects with their IDs

#### Response Example
{
  "created_plants": [
    {
      "id": 304,
      "name": "Mother Plant 1",
      "room_id": 101
    }
  ]
}
```

```APIDOC
## PUT /v1/plant/move

### Description
Move plants between rooms.

### Method
PUT

### Endpoint
/v1/plant/move

### Parameters
#### Request Body
- **plant_ids** (array) - Required - Array of plant IDs to move
- **destination_room_id** (integer) - Required - The ID of the destination room

### Request Example
{
  "plant_ids": [303],
  "destination_room_id": 101
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message

#### Response Example
{
  "message": "Plants successfully moved."
}
```

```APIDOC
## POST /v1/plant/waste/

### Description
Create a waste record for a plant.

### Method
POST

### Endpoint
/v1/plant/waste/

### Parameters
#### Request Body
- **plant_id** (integer) - Required - The ID of the plant that was wasted
- **waste_reason** (string) - Optional - Reason for wasting the plant

### Request Example
{
  "plant_id": 301,
  "waste_reason": "Pest infestation"
}

### Response
#### Success Response (201)
- **message** (string) - Confirmation message
- **waste_record_id** (integer) - The ID of the created waste record

#### Response Example
{
  "message": "Waste record created successfully.",
  "waste_record_id": 501
}
```

```APIDOC
## GET /v1/plant/{id}

### Description
View details of a specific plant.

### Method
GET

### Endpoint
/v1/plant/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the plant to view

### Response
#### Success Response (200)
- **id** (integer) - Plant ID
- **name** (string) - Name of the plant
- **room_id** (integer) - ID of the room the plant is in
- **status** (string) - Current status of the plant (e.g., 'active', 'destroyed')

#### Response Example
{
  "id": 301,
  "name": "Strain A - Clone 1",
  "room_id": 201,
  "status": "active"
}
```

```APIDOC
## PUT /v1/plant/{id}

### Description
Modify an existing plant.

### Method
PUT

### Endpoint
/v1/plant/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the plant to modify

#### Request Body
- **name** (string) - Optional - The new name for the plant
- **room_id** (integer) - Optional - The new room ID for the plant

### Request Example
{
  "name": "Strain A - Clone 1 (Updated)"
}

### Response
#### Success Response (200)
- **id** (integer) - The ID of the modified plant
- **name** (string) - The new name of the plant
- **room_id** (integer) - The new room ID of the plant

#### Response Example
{
  "id": 301,
  "name": "Strain A - Clone 1 (Updated)",
  "room_id": 201
}
```

```APIDOC
## PUT /v1/plant/{id}/undo

### Description
Undo the creation of a new plant.

### Method
PUT

### Endpoint
/v1/plant/{id}/undo

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the plant to undo

### Response
#### Success Response (200)
- **message** (string) - Confirmation message

#### Response Example
{
  "message": "Plant creation undone."
}
```

--------------------------------

### Authentication API

Source: https://sandbox.api.licensee.fl.biotr.ac/documentation/index.html#

Endpoints for obtaining authentication tokens and understanding authorization schemes.

```APIDOC
## Authentication API

### Description
This section covers the authentication process for the Traceability API. It details how to obtain an authentication token and the required format for subsequent API calls.

### Endpoints

#### POST /v1/user/login
**Description**: Obtain an authentication token for licensee API access.
**Method**: POST

#### POST /v1/lab/login
**Description**: Obtain an authentication token for lab API access.
**Method**: POST

### Authentication Scheme

- **Type**: Bearer Token
- **Header**: `Authorization: Bearer <session_token>`
- **Session Token Validity**: 7 days

### Request Example (Login)
```json
{
  "username": "your_username",
  "password": "your_password"
}
```

### Response Example (Login Success)
```json
{
  "session_token": "your_generated_session_token"
}
```
```

--------------------------------

### Plant Additive Management API

Source: https://sandbox.api.licensee.fl.biotr.ac/documentation/index.html#

Endpoints for creating and managing plant additives.

```APIDOC
## GET /v1/plant/additive

### Description
List additives added to plants.

### Method
GET

### Endpoint
/v1/plant/additive

### Parameters
#### Query Parameters
- **plant_id** (integer) - Optional - Filter additives by plant ID

### Response
#### Success Response (200)
- **additives** (array) - List of additive records
  - **id** (integer) - Additive record ID
  - **plant_id** (integer) - ID of the plant the additive was applied to
  - **additive_type** (string) - Type of additive
  - **amount** (number) - Amount of additive used
  - **application_date** (string) - Date of application

#### Response Example
{
  "additives": [
    {
      "id": 401,
      "plant_id": 301,
      "additive_type": "Nutrient Solution X",
      "amount": 50.5,
      "application_date": "2023-10-26"
    }
  ]
}
```

```APIDOC
## POST /v1/plant/additive

### Description
Add an additive to plants.

### Method
POST

### Endpoint
/v1/plant/additive

### Parameters
#### Request Body
- **plant_id** (integer) - Required - The ID of the plant to add the additive to
- **additive_type** (string) - Required - The type of additive
- **amount** (number) - Required - The amount of additive used
- **application_date** (string) - Optional - The date of application (YYYY-MM-DD)

### Request Example
{
  "plant_id": 301,
  "additive_type": "Foliar Spray Y",
  "amount": 10.0,
  "application_date": "2023-10-27"
}

### Response
#### Success Response (201)
- **message** (string) - Confirmation message
- **additive_record_id** (integer) - The ID of the created additive record

#### Response Example
{
  "message": "Additive successfully added to plant.",
  "additive_record_id": 402
}
```

```APIDOC
## PUT /v1/plant/additive

### Description
Update an existing plant additive record.

### Method
PUT

### Endpoint
/v1/plant/additive

### Parameters
#### Request Body
- **additive_record_id** (integer) - Required - The ID of the additive record to update
- **amount** (number) - Optional - The updated amount of additive
- **additive_type** (string) - Optional - The updated type of additive

### Request Example
{
  "additive_record_id": 401,
  "amount": 55.0
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message

#### Response Example
{
  "message": "Plant additive record updated successfully."
}
```

--------------------------------

### Inventory API

Source: https://sandbox.api.licensee.fl.biotr.ac/documentation/index.html#

Endpoints for creating and managing inventory.

```APIDOC
## GET /v1/inventory

### Description
Get inventory

### Method
GET

### Endpoint
/v1/inventory

## POST /v1/inventory

### Description
Post a new inventory record

### Method
POST

### Endpoint
/v1/inventory

## PUT /v1/inventory

### Description
Update many inventory records

### Method
PUT

### Endpoint
/v1/inventory

## PUT /v1/inventory/adjust

### Description
Adjust inventory

### Method
PUT

### Endpoint
/v1/inventory/adjust

## GET /v1/inventory/adjustment

### Description
Get list of inventory adjustments

### Method
GET

### Endpoint
/v1/inventory/adjustment

## GET /v1/inventory/adjustment/type

### Description
Get inventory adjustment types

### Method
GET

### Endpoint
/v1/inventory/adjustment/type

## GET /v1/inventory/adjustment/{id}

### Description
Get the adjustment for an inventory

### Method
GET

### Endpoint
/v1/inventory/adjustment/{id}

## POST /v1/inventory/conversion

### Description
Convert Inventory

### Method
POST

### Endpoint
/v1/inventory/conversion

## DELETE /v1/inventory/conversion/{id}

### Description
Delete/Undo an inventory conversion.

### Method
DELETE

### Endpoint
/v1/inventory/conversion/{id}

## PUT /v1/inventory/destroy

### Description
Destroy inventory previously scheduled for destruction

### Method
PUT

### Endpoint
/v1/inventory/destroy

## GET /v1/inventory/destroy/reason

### Description
Get the list of inventory destruction reasons

### Method
GET

### Endpoint
/v1/inventory/destroy/reason

## PUT /v1/inventory/destroy/schedule

### Description
Schedule inventory for destruction

### Method
PUT

### Endpoint
/v1/inventory/destroy/schedule

## PUT /v1/inventory/destroy/schedule/undo

### Description
Undo inventory destruction schedule

### Method
PUT

### Endpoint
/v1/inventory/destroy/schedule/undo

## GET /v1/inventory/ingredient

### Description
Get ingredients in an inventory item

### Method
GET

### Endpoint
/v1/inventory/ingredient

## GET /v1/inventory/ingredient/uom

### Description
Ingredients unit of measure

### Method
GET

### Endpoint
/v1/inventory/ingredient/uom

## DELETE /v1/inventory/ingredient/{id}

### Description
Delete inventory ingredient

### Method
DELETE

### Endpoint
/v1/inventory/ingredient/{id}

## POST /v1/inventory/initial

### Description
Post initial inventory

### Method
POST

### Endpoint
/v1/inventory/initial

## POST /v1/inventory/lot

### Description
Create a new 'Lot' inventory record.

### Method
POST

### Endpoint
/v1/inventory/lot

## PUT /v1/inventory/move

### Description
Move inventory

### Method
PUT

### Endpoint
/v1/inventory/move

## GET /v1/inventory/status

### Description
Get inventory status

### Method
GET

### Endpoint
/v1/inventory/status

## GET /v1/inventory/type

### Description
Get inventory types

### Method
GET

### Endpoint
/v1/inventory/type

## GET /v1/inventory/type/{id}

### Description
Get an inventory type

### Method
GET

### Endpoint
/v1/inventory/type/{id}

## GET /v1/inventory/{id}

### Description
Get Inventory item details from ID

### Method
GET

### Endpoint
/v1/inventory/{id}

## PUT /v1/inventory/{id}/adjust

### Description
Adjust inventory

### Method
PUT

### Endpoint
/v1/inventory/{id}/adjust

## PUT /v1/inventory/{id}/adjust/usable

### Description
Adjust inventory usable

### Method
PUT

### Endpoint
/v1/inventory/{id}/adjust/usable

## GET /v1/inventory/{id}/ingredient

### Description
Get an inventory Ingredient

### Method
GET

### Endpoint
/v1/inventory/{id}/ingredient

## POST /v1/inventory/{id}/ingredient

### Description
Add an ingredient to an inventory item

### Method
POST

### Endpoint
/v1/inventory/{id}/ingredient

## POST /v1/inventory/{id}/sublot

### Description
Split inventory into smaller lots

### Method
POST

### Endpoint
/v1/inventory/{id}/sublot
```

--------------------------------

### Cultivation Workflow - Add Plant Additives

Source: https://sandbox.api.licensee.fl.biotr.ac/documentation/index.html#

Record the application of any additives or nutrients to plants using the POST /v1/plant/additive endpoint. This maintains a record of plant care.

```HTTP
POST /v1/plant/additive
Host: api.biotrack.com
Authorization: Bearer <session_token>
Content-Type: application/json

{
  "plant_id": "plant_id",
  "additive_name": "Liquid Nutrients",
  "quantity": 10,
  "unit": "ml"
}
```

--------------------------------

### User Management API

Source: https://sandbox.api.licensee.fl.biotr.ac/documentation/index.html#

Endpoints for creating and managing traceability users, including login and password reset functionality.

```APIDOC
## GET /v1/user

### Description
Get list of users

### Method
GET

### Endpoint
/v1/user

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Number of users to return
- **offset** (integer) - Optional - Number of users to skip

### Response
#### Success Response (200)
- **users** (array) - List of user objects
  - **id** (integer) - User ID
  - **username** (string) - User's username
  - **email** (string) - User's email

#### Response Example
{
  "users": [
    {
      "id": 1,
      "username": "testuser",
      "email": "test@example.com"
    }
  ]
}
```

```APIDOC
## POST /v1/user

### Description
Create a User

### Method
POST

### Endpoint
/v1/user

### Parameters
#### Request Body
- **username** (string) - Required - The username for the new user
- **email** (string) - Required - The email address for the new user
- **password** (string) - Required - The password for the new user

### Request Example
{
  "username": "newuser",
  "email": "newuser@example.com",
  "password": "securepassword123"
}

### Response
#### Success Response (201)
- **id** (integer) - The ID of the newly created user
- **username** (string) - The username of the new user
- **email** (string) - The email of the new user

#### Response Example
{
  "id": 2,
  "username": "newuser",
  "email": "newuser@example.com"
}
```

```APIDOC
## POST /v1/user/login

### Description
Login to the API and generate a session token.

### Method
POST

### Endpoint
/v1/user/login

### Parameters
#### Request Body
- **username** (string) - Required - The user's username
- **password** (string) - Required - The user's password

### Request Example
{
  "username": "testuser",
  "password": "securepassword123"
}

### Response
#### Success Response (200)
- **session_token** (string) - A token for authenticated sessions

#### Response Example
{
  "session_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
```

```APIDOC
## POST /v1/user/password-reset-request

### Description
Request a password reset for a user.

### Method
POST

### Endpoint
/v1/user/password-reset-request

### Parameters
#### Request Body
- **email** (string) - Required - The email address associated with the user account

### Request Example
{
  "email": "testuser@example.com"
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating reset email sent

#### Response Example
{
  "message": "Password reset email sent."
}
```

```APIDOC
## DELETE /v1/user/{id}

### Description
Delete a User

### Method
DELETE

### Endpoint
/v1/user/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the user to delete

### Response
#### Success Response (204)
- No content is returned upon successful deletion.

#### Response Example
(No content)
```

```APIDOC
## GET /v1/user/{id}

### Description
View a user's details.

### Method
GET

### Endpoint
/v1/user/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the user to view

### Response
#### Success Response (200)
- **id** (integer) - User ID
- **username** (string) - User's username
- **email** (string) - User's email

#### Response Example
{
  "id": 1,
  "username": "testuser",
  "email": "test@example.com"
}
```

```APIDOC
## PUT /v1/user/{id}

### Description
Update an existing User's information.

### Method
PUT

### Endpoint
/v1/user/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the user to update

#### Request Body
- **username** (string) - Optional - The new username
- **email** (string) - Optional - The new email address

### Request Example
{
  "email": "updated_email@example.com"
}

### Response
#### Success Response (200)
- **id** (integer) - The ID of the updated user
- **username** (string) - The updated username
- **email** (string) - The updated email address

#### Response Example
{
  "id": 1,
  "username": "testuser",
  "email": "updated_email@example.com"
}
```

--------------------------------

### User Management API

Source: https://sandbox.api.licensee.fl.biotr.ac/documentation/index.html#

Endpoints for managing user accounts, including registration, login, and profile updates.

```APIDOC
## POST /users

### Description
Registers a new user.

### Method
POST

### Endpoint
/users

### Parameters
#### Request Body
- **userData** (forms.UserPost) - Required - Data for the new user.

### Request Example
```json
{
  "userData": {
    "username": "newuser",
    "email": "newuser@example.com",
    "password": "securepassword123"
  }
}
```

### Response
#### Success Response (200)
- **userId** (string) - The ID of the newly created user.
- **message** (string) - A success message.

#### Response Example
```json
{
  "userId": "user-abcde",
  "message": "User registered successfully."
}
```

## PUT /users

### Description
Updates an existing user's information.

### Method
PUT

### Endpoint
/users

### Parameters
#### Request Body
- **userData** (forms.UserPut) - Required - Data for updating the user.

### Request Example
```json
{
  "userData": {
    "userId": "user-abcde",
    "email": "updatedemail@example.com"
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - A success message.

#### Response Example
```json
{
  "message": "User updated successfully."
}
```

## POST /users/login

### Description
Logs in a user.

### Method
POST

### Endpoint
/users/login

### Parameters
#### Request Body
- **loginData** (models.UserLogin) - Required - User credentials for login.

### Request Example
```json
{
  "loginData": {
    "username": "newuser",
    "password": "securepassword123"
  }
}
```

### Response
#### Success Response (200)
- **token** (string) - Authentication token for the logged-in user.
- **message** (string) - A success message.

#### Response Example
```json
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "message": "Login successful."
}
```

## POST /users/password/reset

### Description
Initiates the password reset process for a user.

### Method
POST

### Endpoint
/users/password/reset

### Parameters
#### Request Body
- **resetRequest** (forms.PasswordResetRequestPost) - Required - Data for password reset request.

### Request Example
```json
{
  "resetRequest": {
    "email": "user@example.com"
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - A success message indicating the password reset process has started.

#### Response Example
```json
{
  "message": "Password reset email sent."
}
```
```

--------------------------------

### Cultivation Workflow - Create Inventory Room

Source: https://sandbox.api.licensee.fl.biotr.ac/documentation/index.html#

Establish an inventory room for managing harvested or processed products using the POST /v1/inventory/room endpoint. This is crucial for tracking inventory items.

```HTTP
POST /v1/inventory/room
Host: api.biotrack.com
Authorization: Bearer <session_token>
Content-Type: application/json

{
  "name": "Finished Goods Storage",
  "facility_id": "your_facility_id"
}
```

--------------------------------

### Outbound Inventory Transfer - Create Manifest

Source: https://sandbox.api.licensee.fl.biotr.ac/documentation/index.html#

Create a manifest to accompany the inventory transfer, detailing the contents and destination, using the POST /v1/manifest endpoint. This is a critical document for compliance.

```HTTP
POST /v1/manifest
Host: api.biotrack.com
Authorization: Bearer <session_token>
Content-Type: application/json

{
  "transfer_type": "outbound",
  "destination_facility_id": "destination_facility_id",
  "driver_id": "driver_id",
  "vehicle_id": "vehicle_id",
  "invoice_id": "invoice_id"
}
```
Tokens:
Raw