Create a plant for the license_number provided.
OK
Bad Request
{- "license": {
- "license_number": "KMP20200825"
}, - "name": "KMP Paradigm atom plant 1",
- "barcode": "1A4FF0200000029000015577",
- "is_mother_plant": false,
- "quantity": 1,
- "growth_phase": {
- "id": "CAPPGP0003"
}, - "growth_date": "2021-05-03T18:27:39Z",
- "strain": {
- "id": "e239e96ac61b4ca9bb9c2607f2egghc86f4"
}, - "origin": {
- "plant_batches": {
- "id": "fg67e96ac61b4ca9bb9c2607fghg6"
}
}, - "locations": {
- "id": "fg67123c61b4ca9bb9c2607fghg6"
}, - "additional": {
- "patient_license": null,
- "is_for_medical_use": false
}
}{- "results": {
- "type": "object",
- "data": {
- "license": {
- "license_number": "KMP20200825",
- "type": {
- "name": "Type 12"
}
}, - "id": "fg67e96ac61b4ca9bb9c2607f98f4",
- "name": "KMP Paradigm atom plant 1",
- "barcode": "1A4FF0200000029000015577",
- "is_mother_plant": false,
- "growth_phase": {
- "id": "CAPPGP0003",
- "name": "flowering"
}, - "planted_date": "2021-05-03T18:27:39Z",
- "strain": {
- "id": "e239e96ac61b4ca9bb9c2607f2egghc86f4",
- "name": "Purple atom Clouds"
}, - "origin": {
- "plant_batches": {
- "id": "fg67e96ac61b4ca9bb9c2607fghg6",
- "barcode": "1A4FF0200000029000015576",
- "name": "KMP Paradigm atom plant batch x123",
- "type": {
- "id": "CAPBT0002",
- "name": "clone"
}
}
}, - "additives": [ ],
- "manicure": {
- "number": 1
}, - "harvest": {
- "total_quantity": 534.45,
- "total_quantity_tts": 534.45,
- "unit_of_measure": "Grams"
}, - "cure": {
- "number": 1
}, - "waste": {
- "count": 5,
- "total_quantity": 334.45,
- "unit_of_measure": "Grams"
}, - "locations": {
- "id": "fg67123c61b4ca9bb9c2607fghg6",
- "name": "KMP Persona Growing 1",
- "type": {
- "id": "1",
- "name": "Default Location Type"
}
}, - "additional": {
- "patient_license": null,
- "is_for_medical_use": false
}, - "destroyed": {
- "id": "74a7d17339e54c1faed64b1cd7cdb8e7"
}, - "entity_state": [
- {
- "state": "active",
- "date": "2021-05-21T20:29:19Z",
- "reason": "plant created",
- "actioned_by": "system generated"
}, - {
- "state": "updated",
- "date": "2021-06-21T20:29:19Z",
- "reason": "plant updated",
- "actioned_by": "system generated"
}, - {
- "state": "flowering",
- "date": "2021-06-21T20:29:19Z",
- "reason": "flowering phase",
- "actioned_by": "system generated"
}
]
}
}, - "warnings": [ ]
}Retrieves a list of plants All active plants for the license_number are obtained, filtered by the query parameter(s) criteria.
| 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. |
| entity_state | string Queryable entity states for plant. Inactive will return harvested, destroyed, and/or deleted plants. |
| 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 |
OK
object | |||||||||||||||||
| |||||||||||||||||
Array of objects | |||||||||||||||||
Bad Request
{- "results": {
- "type": "array",
- "records": {
- "count": "0 - 100",
- "total": 437,
- "previous": null,
}, - "data": [
- {
- "license": {
- "license_number": "MC000000",
- "type": {
- "name": "MA - Marijuana Cultivator"
}
}, - "actions": null,
- "id": "da0b9ea0590f40ddb1ac759090dc9a8d",
- "name": "ATL MGK 090122A",
- "barcode": "1KMPL02000001F8000000359",
- "is_mother_plant": false,
- "growth_phase": {
- "id": "MAPGP0005",
- "name": "flowering"
}, - "planted_date": null,
- "strain": {
- "id": "0a5ecacb32ec45ebbf85052ab8aadb86",
- "name": "ATL Mean Green Kush"
}, - "origin": {
- "plant_batches": {
- "id": "5e94ef20182d44e192dcbc8e9d1aa6d6",
- "barcode": "1KMPL020000025B000002995",
- "name": "MGK 080122 plants",
- "type": {
- "id": "CAPBT0002",
- "name": "clone"
}
}
}, - "additives": null,
- "manicure": {
- "number": 1
}, - "harvest": null,
- "cure": {
- "number": null
}, - "waste": null,
- "lots": null,
- "locations": {
- "id": "bf677f5f679544fb8eb93b3d30086f59",
- "name": "Flower 1A",
- "type": {
- "id": "MALOC0001",
- "name": "Default Location Type"
}
}, - "destroyed": null,
- "additional": {
- "patient_license": "",
- "is_for_medical_use": false
}, - "entity_state": [
- {
- "state": "active",
- "date": "2022-09-01T22:17:10Z",
- "reason": "plant created",
- "actioned_by": "system generated"
}, - {
- "state": "updated",
- "date": "2022-12-22T22:17:10Z",
- "reason": "plant updated",
- "actioned_by": "system generated"
}, - {
- "state": "flowering",
- "date": "2022-12-06T00:00:00Z",
- "reason": "flowering phase",
- "actioned_by": "system generated"
}
]
}, - {
- "license": {
- "license_number": "MC000000",
- "type": {
- "name": "MA - Marijuana Cultivator"
}
}, - "actions": null,
- "id": "2377d0b921164257b7878a35057cd1e8",
- "name": "Imported Plant 1KMPL02000001F8000000367",
- "barcode": "1KMPL02000001F8000000367",
- "is_mother_plant": null,
- "growth_phase": {
- "id": "MAPGP0003",
- "name": "vegetative"
}, - "planted_date": null,
- "strain": {
- "id": "0a5ecacb32ec45ebbf85052ab8aadb86",
- "name": "Amazing Strain Kush"
}, - "origin": {
- "plant_batches": {
- "id": "5e94ef20182d44e192dcbc8e9d1aa6d6",
- "barcode": "1KMPL020000025B000002995",
- "name": "ASK 314 Plants",
- "type": {
- "id": "CAPBT0002",
- "name": "clone"
}
}
}, - "additives": null,
- "manicure": {
- "number": 0
}, - "harvest": null,
- "cure": {
- "number": null
}, - "waste": null,
- "lots": null,
- "locations": {
- "id": "bf677f5f679544fb8eb93b3d30086f59",
- "name": "VEG 1B",
- "type": {
- "id": "MALOC0001",
- "name": "Default Location Type"
}
}, - "destroyed": null,
- "additional": {
- "patient_license": "",
- "is_for_medical_use": false
}, - "entity_state": [
- {
- "state": "active",
- "date": "2022-12-08T20:08:22Z",
- "reason": "plant created",
- "actioned_by": "system generated"
}, - {
- "state": "updated",
- "date": "2022-12-08T20:08:22Z",
- "reason": "plant updated",
- "actioned_by": "system generated"
}, - {
- "state": "vegetative",
- "date": "2022-12-08T00:00:00Z",
- "reason": "vegetative phase",
- "actioned_by": "system generated"
}
]
}
]
}
}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.
| 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. |
| entity_state | string Queryable entity states for plant. Inactive will return harvested, destroyed, and/or deleted plants. |
| 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 |
OK
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request
{- "results": {
- "type": "object",
- "data": {
- "license": {
- "license_number": "KMP20200825",
- "type": {
- "name": "Type 12"
}
}, - "id": "fg67e96ac61b4ca9bb9c2607f98f4",
- "name": "KMP Paradigm atom plant 1",
- "barcode": "1A4FF0200000029000015577",
- "is_mother_plant": false,
- "growth_phase": {
- "id": "CAPPGP0003",
- "name": "flowering"
}, - "planted_date": "2021-05-03T18:27:39Z",
- "strain": {
- "id": "e239e96ac61b4ca9bb9c2607f2egghc86f4",
- "name": "Purple atom Clouds"
}, - "origin": {
- "plant_batches": {
- "id": "fg67e96ac61b4ca9bb9c2607fghg6",
- "barcode": "1A4FF0200000029000015576",
- "name": "KMP Paradigm atom plant batch x123",
- "type": {
- "id": "CAPBT0002",
- "name": "clone"
}
}
}, - "additives": [ ],
- "manicure": {
- "number": 1
}, - "harvest": {
- "total_quantity": 534.45,
- "total_quantity_tts": 534.45,
- "unit_of_measure": "Grams"
}, - "cure": {
- "number": 1
}, - "waste": {
- "count": 5,
- "total_quantity": 334.45,
- "unit_of_measure": "Grams"
}, - "locations": {
- "id": "fg67123c61b4ca9bb9c2607fghg6",
- "name": "KMP Persona Growing 1",
- "type": {
- "id": "1",
- "name": "Default Location Type"
}
}, - "additional": {
- "patient_license": null,
- "is_for_medical_use": false
}, - "destroyed": {
- "id": "74a7d17339e54c1faed64b1cd7cdb8e7"
}, - "entity_state": [
- {
- "state": "active",
- "date": "2021-05-21T20:29:19Z",
- "reason": "plant created",
- "actioned_by": "system generated"
}, - {
- "state": "updated",
- "date": "2021-06-21T20:29:19Z",
- "reason": "plant updated",
- "actioned_by": "system generated"
}, - {
- "state": "flowering",
- "date": "2021-06-21T20:29:19Z",
- "reason": "flowering phase",
- "actioned_by": "system generated"
}, - {
- "state": "destroyed",
- "date": "2021-07-01T20:29:19Z",
- "reason": "plants destroyed waste id 74a7d17339e54c1faed64b1cd7cdb8e7",
- "actioned_by": "kmp vendor id"
}
]
}
}, - "warnings": [ ]
}Update the details of a plant. Update growth phases and take actions (move, destroy, etc..) upon the plants for the license_number provided.
required | object | ||||||||
required | object Specific action for this plant operation. | ||||||||
| 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. | |||||||||
| growth_date | string Timestamp when the growth_phase was changed. | ||||||||
object | |||||||||
object Plant's origin, either source plant, plants' batch or other type of lot. | |||||||||
object | |||||||||
| 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
| |||||||||
object Additional information related to the plant. | |||||||||
OK
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request
{- "license": {
- "license_number": "KMP20200825"
}, - "actions": {
- "id": "CAPSUD0003"
}, - "move_date": "2021-05-21T20:29:19Z",
- "locations": {
- "id": "4"
}
}{- "results": {
- "type": "object",
- "data": {
- "license": {
- "license_number": "KMP20200825",
- "type": {
- "name": "Type 12"
}
}, - "actions": {
- "id": "CAPSUD0003",
- "name": "move"
}, - "id": "fa273b8502974dc5a2382fef45e1f357",
- "name": "JION rejit 5 plants 06202022 A",
- "barcode": "1A4FF0200000029000014955",
- "is_mother_plant": false,
- "growth_phase": {
- "id": "CAPGP0005",
- "name": "flowering"
}, - "planted_date": "2022-01-25T00:00:00Z",
- "strain": {
- "id": "264185a57c304dce913294249093bfa1",
- "name": "matsumoto reijit 5"
}, - "origin": {
- "plant_batches": {
- "id": "073a1a986da943469f5c1202ba8029e0",
- "barcode": "1A4FF0200000029000014960",
- "name": "plant_batch_ca 1643150653261",
- "type": {
- "id": "CAPBT0002",
- "name": "clone"
}
}
}, - "additives": [
- {
- "id": "d692db2428c5424b924d919fbddc86af"
}, - {
- "id": "78aa6dd2b4634302bc6956fffcce5a97"
}, - {
- "id": "22afaa2d9e194f5a9d01caf5c805acac"
}, - {
- "id": "6f7651f72eee45e5ba8699d18d14f369"
}
], - "manicure": {
- "number": 0
}, - "harvest": null,
- "cure": {
- "number": null
}, - "waste": null,
- "lots": null,
- "locations": {
- "id": "f6f4c6a38310448d96894c693e2f57bd",
- "name": "Harvest Room #528008",
- "type": {
- "id": "CALOC0001",
- "name": "Cultivation"
}
}, - "destroyed": null,
- "additional": {
- "patient_license": null,
- "is_for_medical_use": false
}, - "entity_state": [
- {
- "state": "active",
- "date": "2021-05-21T20:29:19Z",
- "reason": "plant created",
- "actioned_by": "system generated"
}, - {
- "state": "updated",
- "date": "2021-06-21T20:29:19Z",
- "reason": "plant updated",
- "actioned_by": "system generated"
}, - {
- "state": "flowering",
- "date": "2021-06-21T20:29:19Z",
- "reason": "flowering phase",
- "actioned_by": "system generated"
}, - {
- "state": "plant_moved",
- "date": "2022-03-23T20:29:19Z",
- "reason": "original location 67b3e27b64d44e5f8d726a86af9c83a2 Jion cultivation 1",
- "actioned_by": "user credentials"
}
]
}
}, - "warnings": [ ]
}retrieve the plant growth_phases for a specific state and license number
{- "results": {
- "type": "array",
- "data": [
- {
- "id": "CAPGP0001",
- "name": "immature"
}, - {
- "id": "CAPPGP0002",
- "name": "vegetative"
}, - {
- "id": "CAPPGP0003",
- "name": "flowering"
}
]
}, - "warnings": [ ]
}retrieve the actions available for plants update
{- "results": {
- "type": "array",
- "data": [
- {
- "id": "ILPSUD0001",
- "name": "make mother plant",
- "note": "identify this as a mother plant"
}, - {
- "id": "ILPSUD0002",
- "name": "change growth phase",
- "note": "change growth phase of plant(s)"
}, - {
- "id": "ILPSUD0003",
- "name": "move",
- "note": "move plant(s) to different location"
}, - {
- "id": "ILPSUD0004",
- "name": "apply additives",
- "note": "apply additives to plant(s)"
}, - {
- "id": "ILPSUD0006",
- "name": "change name",
- "note": "change plant name"
}
]
}, - "warnings": [ ]
}