Plant

Create plant

Create a plant for the license_number provided.

SecurityApiKeyAuth and CustomAuth
Request
path Parameters
state
required
string

Lower case ANSI standard 38:2009 USPS codes of the US state where licensee is operating.

Enum: "ca" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"
header Parameters
x-api-key
required
string

Trace API key header

Example: b123x21wbHlkYXBpa2V5
Authorization
required
string

Company and user credentials authentication

Example: KMP-JSON token=dmVuZG9yLWFwaS1rZXk6dX12312sdfs2V5
Request Body schema: application/json
required
object
license_number
required
string

Reference (entity_ID) for the license. This is the business license number issued by the state.

name
required
string

Display name of the plant

barcode
string

A unique identifier required for specific states.

is_mother_plant
required
boolean

True if plant is a mother plant, otherwise false.

quantity
required
integer

Quantity of plants being created.

required
object

The growth phase of the plant.

NOTE: For creating a plant, in most cases this would be vegetative. In CA it is Flowering.

id
string

The id of the growth_phase

growth_date
required
string

Timestamp when the growth_phase was changed.

required
object
id
required
string

Reference (entity_ID) for the strain.

required
object

The plant's origin plant batch.

object
id
required
string

Reference (entity_ID) for the plant_batch.

barcode
required
string

barcode of the plant_batch.

required
object
id
required
string

Reference (entity_ID) for the location.

object

Additional information related to the plant.

patient_license
string

License number of the patient.

is_for_medical_use
boolean

True if plant is for medical use, otherwise false.

Responses
200

OK

Response Schema: application/json
object
type
string
Value: "object"
object
object
license_number
string

Reference (entity_ID) for the license. This is the business license number issued by the state.

object

License type of the company/facility.

name
string

The display name of the license type.

characteristics
object

Specific information related to the license type. The presence of the characteristics' object depends on the use of the expand query parameter .

object

Last action taken on the plant.

id
string

Reference (entity_id) for the plant action.

name
string

Display name of the plant action

id
string

Reference (entity_ID) for the plant.

name
string

Display name of the plant.

Example: KMP Paradigm atom plant 1

barcode
string

A unique identifier required for specific states.

is_mother_plant
boolean

True if plant is a mother plant, false if not.

object

Growth phase of the plant.

id
string

Id of the growth phase of the plant.

Example: CAPPGP0003

name
string

The display name of the growth phase.

planted_date
string

Timestamp when the plant was created in ISO 8601 UTC format.

object

Plant's strain.

id
string

Id for the strain of the plant.

name
string

The strain name.

object

Plant's origin. Currently support plant_batch as an origin when creating a plant.

object
id
string

Reference (entity_ID) for the plant_batch.

barcode
string

Barcode of the plant_batch.

name
string

Display name of the plant_batch.

object

The type of the origin plant_batch (Seed or Clone)

quantity
integer

The quantity of immature plant_batches in the origin plant_batch.

unit_of_measure
string

The unit of measure used in the quantity.

Array of objects or null

List of additives that have been applied to the plant.

Array
id
string

Reference (entity_ID) for the additive that was applied.

object or null

Manicures that have been performed on the plant

number
integer

Number of manicures performed on the plant

Array of objects

Harvest information for the plant.

Array
id
string

Reference (entity_ID) for the source harvest.

object

Number of cures performed on plant

number
integer

Number of cures on the plant.

Array of objects

The waste removed from the Plant

Array
quantity
integer

Amount of waste removed.

unit_of_measure
number

Unit of measure used for quantity

object
id
string

Reference (entity_ID) for the location.

name
string

name of the location.

object

Type of the location.

id
string

Reference (entity_ID) for the location type.

name
string

name of the location type.

object

Additional information related to the plant.

patient_license
string

License number of the patient.

is_for_medical_user
boolean

True if plant is for a medical user, false otherwise.

object

Destroyed [waste] event that was used for destruction of the plant.

id
string

ID of the destroyed [ waste] event that was used for destruction of the plant.

Array of objects

A list of state changes made to the entity. Entity states for plant [active, inactive, immature, vegetative, flowering, harvest_scheduled, harvested, updated, onhold - for seized or similar, destroy _scheduled, destroyed, converted, cured].

Array
state
string

state of the entity.

date
string

timestamp when the state was recorded ISO 8601 UTC format.

reason
string

additional information for the 'state' change.

actioned_by
string

username of the person who updated the state of the entity (if applicable).

Array of objects
Array
type
string
detail
string
400

Bad Request

post/{state}/v1/plants
Request samples
application/json
{
  • "license": {
    },
  • "name": "KMP Paradigm atom plant 1",
  • "barcode": "1A4FF0200000029000015577",
  • "is_mother_plant": false,
  • "quantity": 1,
  • "growth_phase": {
    },
  • "growth_date": "2021-05-03T18:27:39Z",
  • "strain": {
    },
  • "origin": {
    },
  • "locations": {
    },
  • "additional": {
    }
}
Response samples
application/json
{
  • "results": {
    },
  • "warnings": [ ]
}

Retrieve Plants

Retrieves a list of plants All active plants for the license_number are obtained, filtered by the query parameter(s) criteria.

SecurityApiKeyAuth and CustomAuth
Request
path Parameters
state
required
string

Lower case ANSI standard 38:2009 USPS codes of the US state where licensee is operating.

Enum: "ca" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"
query Parameters
license_number
required
string

Reference (entity_ID) for the license. This is the business license number issued by the state.

Example: license_number=ABC-1234
limit
number

Optional parameter that allows you to specify a number to limit the results in the response. Default limit is 100.

Example: limit=100
offset
number

Optional parameter that allows you to offset records if the max number for the filter exceeds the limit.

Example: offset=0
barcode
string

Plant's tag that uniquely identifies it for tracking purposes.

Example: barcode=1KMP00000000099000015442
expand
string

The expand query parameter is used to include additional information for the child objects in the plants response.

Enum: "additives" "manicure" "harvest" "waste" "lots" "all"
entity_state
string

Queryable entity states for plant. Inactive will return harvested, destroyed, and/or deleted plants.

Enum: "active" "inactive" "immature" "vegetative" "flowering" "harvest_scheduled" "harvested" "updated" "onhold - for seized or similar" "destroy _scheduled" "destroyed" "converted" "cured"
start_date
string

Starting date for the time range of plant's modifications. Only applicable if entity_state query parameter is used.

Example: start_date=2020-09-04
end_date
string

End date for the time range of plant's modifications. Only applicable if entity_state query parameter is used.

Example: end_date=2020-09-05
header Parameters
x-api-key
required
string

Trace API key header

Example: b123x21wbHlkYXBpa2V5
Authorization
required
string

Company and user credentials authentication

Example: KMP-JSON token=dmVuZG9yLWFwaS1rZXk6dX12312sdfs2V5
Responses
200

OK

Response Schema: application/json
object
type
string
Value: "array"
object
count
string

A string representing what records you are receiving out of the total for the filter criteria.

total
number

The total number of records returned based upon filter criteria.

previous
string or null

URL that when executed will return you to the last page set.

next
string or null

URL that when executed will take you to the next set of paginated records.

data
Array of arrays
Array of objects
Array
type
string
detail
string
400

Bad Request

get/{state}/v1/plants
Response samples
application/json
{
  • "results": {
    }
}

Retrieve plant(s) details

Retrieve the plant details. If the id is not provided, the details of all the plants for the license_number are obtained, filtered by the query parameter(s) criteria.

SecurityApiKeyAuth and CustomAuth
Request
path Parameters
state
required
string

Lower case ANSI standard 38:2009 USPS codes of the US state where licensee is operating.

Enum: "ca" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"
id
required
string

Plant ID

Example: a521f55de4394f4f99c282be687e63aa
query Parameters
license_number
required
string

Reference (entity_ID) for the license. This is the business license number issued by the state.

Example: license_number=ABC-1234
barcode
string

Plant's tag that uniquely identifies it for the tracking purposes.

Example: barcode=1KMP00000000099000015442
expand
string

The expand query parameter is used to include additional information for the child objects in the plants response.

Enum: "additives" "manicure" "harvest" "waste" "lots" "all"
entity_state
string

Queryable entity states for plant. Inactive will return harvested, destroyed, and/or deleted plants.

Enum: "active" "inactive" "immature" "vegetative" "flowering" "harvest_scheduled" "harvested" "updated" "onhold - for seized or similar" "destroy _scheduled" "destroyed" "converted" "cured"
start_date
string

Starting date for the time range of plant's modifications. Only applicable if entity_state query parameter is used.

Example: start_date=2020-09-04
end_date
string

End date for the time range of plant's modifications. Only applicable if entity_state query parameter is used.

Example: end_date=2020-09-05
header Parameters
x-api-key
required
string

Trace API key header

Example: b123x21wbHlkYXBpa2V5
Authorization
required
string

Company and user credentials authentication

Example: KMP-JSON token=dmVuZG9yLWFwaS1rZXk6dX12312sdfs2V5
Responses
200

OK

Response Schema: application/json
object
type
string
Value: "object"
object
object
license_number
string

Reference (entity_ID) for the license. This is the business license number issued by the state.

object

License type of the company/facility.

name
string

The display name of the license type.

characteristics
object

Specific information related to the license type. The presence of the characteristics' object depends on the use of the expand query parameter .

object

Last action taken on the plant.

id
string

Reference (entity_id) for the plant action.

name
string

Display name of the plant action

id
string

Reference (entity_ID) for the plant.

name
string

Display name of the plant.

Example: KMP Paradigm atom plant 1

barcode
string

A unique identifier required for specific states.

is_mother_plant
boolean

True if plant is a mother plant, false if not.

object

Growth phase of the plant.

id
string

Id of the growth phase of the plant.

Example: CAPPGP0003

name
string

The display name of the growth phase.

planted_date
string

Timestamp when the plant was created in ISO 8601 UTC format.

object

Plant's strain.

id
string

Id for the strain of the plant.

name
string

The strain name.

object

Plant's origin. Currently support plant_batch as an origin when creating a plant.

object
id
string

Reference (entity_ID) for the plant_batch.

barcode
string

Barcode of the plant_batch.

name
string

Display name of the plant_batch.

object

The type of the origin plant_batch (Seed or Clone)

quantity
integer

The quantity of immature plant_batches in the origin plant_batch.

unit_of_measure
string

The unit of measure used in the quantity.

Array of objects or null

List of additives that have been applied to the plant.

Array
id
string

Reference (entity_ID) for the additive that was applied.

object or null

Manicures that have been performed on the plant

number
integer

Number of manicures performed on the plant

Array of objects

Harvest information for the plant.

Array
id
string

Reference (entity_ID) for the source harvest.

object

Number of cures performed on plant

number
integer

Number of cures on the plant.

Array of objects

The waste removed from the Plant

Array
quantity
integer

Amount of waste removed.

unit_of_measure
number

Unit of measure used for quantity

object
id
string

Reference (entity_ID) for the location.

name
string

name of the location.

object

Type of the location.

id
string

Reference (entity_ID) for the location type.

name
string

name of the location type.

object

Additional information related to the plant.

patient_license
string

License number of the patient.

is_for_medical_user
boolean

True if plant is for a medical user, false otherwise.

object

Destroyed [waste] event that was used for destruction of the plant.

id
string

ID of the destroyed [ waste] event that was used for destruction of the plant.

Array of objects

A list of state changes made to the entity. Entity states for plant [active, inactive, immature, vegetative, flowering, harvest_scheduled, harvested, updated, onhold - for seized or similar, destroy _scheduled, destroyed, converted, cured].

Array
state
string

state of the entity.

date
string

timestamp when the state was recorded ISO 8601 UTC format.

reason
string

additional information for the 'state' change.

actioned_by
string

username of the person who updated the state of the entity (if applicable).

Array of objects
Array
type
string
detail
string
400

Bad Request

get/{state}/v1/plants/{id}
Response samples
application/json
{
  • "results": {
    },
  • "warnings": [ ]
}

Update plant

Update the details of a plant. Update growth phases and take actions (move, destroy, etc..) upon the plants for the license_number provided.

SecurityApiKeyAuth and CustomAuth
Request
path Parameters
state
required
string

Lower case ANSI standard 38:2009 USPS codes of the US state where licensee is operating.

Enum: "ca" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"
id
required
string

Plant ID

Example: a521f55de4394f4f99c282be687e63aa
header Parameters
x-api-key
required
string

Trace API key header

Example: b123x21wbHlkYXBpa2V5
Authorization
required
string

Company and user credentials authentication

Example: KMP-JSON token=dmVuZG9yLWFwaS1rZXk6dX12312sdfs2V5
Request Body schema: application/json
required
object
license_number
required
string

Reference (entity_ID) for the license. This is the business license number issued by the state.

required
object

Specific action for this plant operation.

id
required
string

Reference (entity_id) for the plant action.

name
string

Display name of the plant

barcode
string

A unique identifier used for tracking purposes.

is_mother_plant
boolean

True if plant is a mother plant, otherwise false.

mother_plant_date
string <date-time>

The timestamp of when the plant was first used as a mother plant.

object

The growth phase of the plant.

NOTE: For creating a plant, in most cases this would be vegetative. In CA it is Flowering.

id
string

The id of the growth_phase

growth_date
string

Timestamp when the growth_phase was changed.

object
id
string

Reference (entity_ID) for the strain.

object

Plant's origin, either source plant, plants' batch or other type of lot.

object
id
string

Reference (entity_ID) for the plant_batch.

barcode
string

barcode of the plant_batch.

object
id
string

Reference (entity_ID) for the location.

move_date
string <date-time>

The timestamp of when the plant was moved.

additives_application_date
string

Timestamp when additives were applied to the plant.

Array of objects

Additives added to plant.

Array
id
string

Reference (entity_ID) for the additive.

application_device
string

The device used to apply the additive.

quantity
number <float>

The quantity of the additive added to the plant/location based on the unit of measure.

unit_of_measure
string

The unit of measure of the additive as added to the plant or location.

object

Additional information related to the plant.

patient_license
string

License number of the patient.

Responses
200

OK

Response Schema: application/json
object
type
string
Value: "object"
object
object
license_number
string

Reference (entity_ID) for the license. This is the business license number issued by the state.

object

License type of the company/facility.

name
string

The display name of the license type.

characteristics
object

Specific information related to the license type. The presence of the characteristics' object depends on the use of the expand query parameter .

object

Last action taken on the plant.

id
string

Reference (entity_id) for the plant action.

name
string

Display name of the plant action

id
string

Reference (entity_ID) for the plant.

name
string

Display name of the plant.

Example: KMP Paradigm atom plant 1

barcode
string

A unique identifier required for specific states.

is_mother_plant
boolean

True if plant is a mother plant, false if not.

object

Growth phase of the plant.

id
string

Id of the growth phase of the plant.

Example: CAPPGP0003

name
string

The display name of the growth phase.

planted_date
string

Timestamp when the plant was created in ISO 8601 UTC format.

object

Plant's strain.

id
string

Id for the strain of the plant.

name
string

The strain name.

object

Plant's origin. Currently support plant_batch as an origin when creating a plant.

object
id
string

Reference (entity_ID) for the plant_batch.

barcode
string

Barcode of the plant_batch.

name
string

Display name of the plant_batch.

object

The type of the origin plant_batch (Seed or Clone)

quantity
integer

The quantity of immature plant_batches in the origin plant_batch.

unit_of_measure
string

The unit of measure used in the quantity.

Array of objects or null

List of additives that have been applied to the plant.

Array
id
string

Reference (entity_ID) for the additive that was applied.

object or null

Manicures that have been performed on the plant

number
integer

Number of manicures performed on the plant

Array of objects

Harvest information for the plant.

Array
id
string

Reference (entity_ID) for the source harvest.

object

Number of cures performed on plant

number
integer

Number of cures on the plant.

Array of objects

The waste removed from the Plant

Array
quantity
integer

Amount of waste removed.

unit_of_measure
number

Unit of measure used for quantity

object
id
string

Reference (entity_ID) for the location.

name
string

name of the location.

object

Type of the location.

id
string

Reference (entity_ID) for the location type.

name
string

name of the location type.

object

Additional information related to the plant.

patient_license
string

License number of the patient.

is_for_medical_user
boolean

True if plant is for a medical user, false otherwise.

object

Destroyed [waste] event that was used for destruction of the plant.

id
string

ID of the destroyed [ waste] event that was used for destruction of the plant.

Array of objects

A list of state changes made to the entity. Entity states for plant [active, inactive, immature, vegetative, flowering, harvest_scheduled, harvested, updated, onhold - for seized or similar, destroy _scheduled, destroyed, converted, cured].

Array
state
string

state of the entity.

date
string

timestamp when the state was recorded ISO 8601 UTC format.

reason
string

additional information for the 'state' change.

actioned_by
string

username of the person who updated the state of the entity (if applicable).

Array of objects
Array
type
string
detail
string
400

Bad Request

put/{state}/v1/plants/{id}
Request samples
application/json
{
  • "license": {
    },
  • "actions": {
    },
  • "move_date": "2021-05-21T20:29:19Z",
  • "locations": {
    }
}
Response samples
application/json
{
  • "results": {
    },
  • "warnings": [ ]
}

Retrieve plant growth_phases

retrieve the plant growth_phases for a specific state and license number

SecurityApiKeyAuth and CustomAuth
Request
path Parameters
state
required
string

Lower case ANSI standard 38:2009 USPS codes of the US state where licensee is operating.

Enum: "ca" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"
query Parameters
license_number
required
string

Reference (entity_ID) for the license. This is the business license number issued by the state.

Example: license_number=ABC-1234
header Parameters
x-api-key
required
string

Trace API key header

Example: b123x21wbHlkYXBpa2V5
Authorization
required
string

Company and user credentials authentication

Example: KMP-JSON token=dmVuZG9yLWFwaS1rZXk6dX12312sdfs2V5
Responses
200

OK

Response Schema: application/json
object
type
string
Value: "array"
Array of objects
Array
id
string

Reference (entity_ID) for the plant growth phase.

name
string

name of the growth phase

Array of objects
Array
type
string
detail
string
400

Bad Request

get/{state}/v1/plants/growth_phases
Response samples
application/json
{
  • "results": {
    },
  • "warnings": [ ]
}

Retrieve plant actions

retrieve the actions available for plants update

SecurityApiKeyAuth and CustomAuth
Request
path Parameters
state
required
string

Lower case ANSI standard 38:2009 USPS codes of the US state where licensee is operating.

Enum: "ca" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"
header Parameters
x-api-key
required
string

Trace API key header

Example: b123x21wbHlkYXBpa2V5
Authorization
required
string

Company and user credentials authentication

Example: KMP-JSON token=dmVuZG9yLWFwaS1rZXk6dX12312sdfs2V5
Responses
200

OK

Response Schema: application/json
object
type
string
Value: "array"
Array of objects
Array
id
string

Reference (entity_ID) for actions.

name
string

name of the plant update action

note
string

additional information on this action

Array of objects
Array
type
string
detail
string
400

Bad Request

get/{state}/v1/plants/actions
Response samples
application/json
{
  • "results": {
    },
  • "warnings": [ ]
}