Harvest

Create harvest

Create a harvest 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

User friendly reference for the harvest.

required

object

Start and end dates of the harvest.

start required	string Timestamp date of the start of this harvest in ISO 8601 UTC format
end required	string Timestamp date of the end of this harvest in ISO 8601 UTC format

required

object

id	string Reference (entity_ID) for the harvests type

required

object

The strains in the Harvest

number

required

integer

The number of strains

Array of objects

Harvest strain (s). Note: Some state's require harvests to be made up of only one strain. Please review your state's guidelines.

Array

required

string

Reference (entity_ID) for the strain.

Array of objects

List of weights for the harvest.

Array

object

quantity	number Current quantity
unit_of_measure	string Unit of measure for the weight.

object

quantity	number Current quantity
unit_of_measure	string Unit of measure for the weight.

object

quantity	number Current quantity
unit_of_measure	string Unit of measure for the weight.

object

quantity	number Current quantity
unit_of_measure	string Unit of measure for the weight.

Array of objects

Plants that are in the harvest with weights.

Array

string

Unique identifier of the plant.

date

string

Timestamp date of harvest event.

Array of objects

Weights from the plant used in the harvest

Array

	object
	object

required

object

required

object

Location of the harvest during curing

id	string Trace Location ID where the harvest will be stored for curing.

object

Location of the harvest lots made during the harvest process. Only applicable in Biotrack states.

id	string Trace Location ID where the plant material lot will go during harvest.

object

Additional information

patient_license	string License number of the patient.
is_for_medical_user	boolean True if for a medical user, false otherwise.

Responses

200

Response Schema: application/json

object

type

string

Value: "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 this harvest.

id	string Reference (entity_ID) for the harvest action.
name	string Display name of the harvest action.

string

Reference (entity_ID) for the harvest.

name

string

User friendly reference for the harvest.

object

Start and end dates of the harvest.

start	string Timestamp date of the start of this harvest in ISO 8601 UTC format
end	string Timestamp date of the end of this harvest in ISO 8601 UTC format

object

id	string Reference (entity_ID) for the harvests type

object

The strains in the harvest.

number

integer

The number of strains.

unit_of_measure

string

Unit of measure for the strains.

Array of objects

List of strains in the harvest. Note: Some state's require harvests to be made up of only one strain. Please review your state's guidelines.

Array

number	integer The number of strains.
unit_of_measure	string Unit of measure for the strains.
	Array of objects List of strains in the harvest.

object

Total aggregates for Harvest components, such as the number of plants in the harvest and the total weight of harvested material.

object

number	integer Number of plants in the harvest
unit_of_measure	string The unit of measure of the number of plants.

object

number

integer

Total number of harvests.

object

	object
	object
	object

object

Harvest's cure information.

number

integer

Number of cures in the harvest.

Array of objects

Cure event data of the harvest

Array

id	string Unique identifier for the cure event
name	string Display name for the cure event
	object The cure drying time
	object The temperature
	object The humidity info of the cure
date	string Timestamp date of the cure event
	object

Array of objects

Plants that are in the harvest

Array

id	string Unique identifier of the plant
name	string Name of the plant.
barcode	string Unique identifier for tracking purposes.
date	string Growth date of the plant in ISO 8601 UTC format.
	object Distribution of weights for the individual plant.

object

Waste removal event.

quantity	integer Amount of waste removed.
unit_of_measure	number Unit of measure used for quantity

object

The lot information for the harvest

number

integer

Number of lots ....

quantity

integer

Amount ....

unit_of_measure

number

Unit of measure used for quantity

Array of objects

Lots in the harvest

Array

id	string Unique identifier for the lot
name	string Display name for the lot
barcode	string Barcode of the lot
quantity	number Quantity of the lot.
unit_of_measure	string Unit of measure of the quantity
date	string Timestamp date of the lot
	object
	object

object

id	string Reference (entity_ID) for the location.
name	string name of the location.
	object Type of the location.

object

id	string Reference (entity_ID) for the location.
name	string name of the location.
	object Type of the location.

object

Products that are created

object

Additional information

patient_license	string License number of the patient.
is_for_medical_user	boolean True if for a medical user, false otherwise.

Array of objects

A list of state changes made to the entity. Entity states for harvest [ active, inactive, curing, cured, updated, finished, unfinished, onhold, lab_testing_not_submitted, lab_testing_submitted, lab_testing_in_progress, lab_testing_awaiting_confirmation, lab_testing_passed, lab_testing_failed, lab_retesting_in_progress, lab_retest_passed, lab_retest_failed, used, waste_removed].

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/harvests

Request samples

Payload

application/json

{"license": {"license_number": "1231235123"
},
"name": "Tomino amuro kamui 06122022 manicure A02",
"harvest_date": {"start": "2022-07-06T18:27:39Z",
"end": "2022-07-06T19:27:39Z"
},
"type": {"id": "CAHHT0002"
},
"strain": {"strains": [{"id": "ef2db9096a8b48b5b261e0247098721a"
}
]
},
"weights": null,
"plants": [{"id": "1f46b71cbfa54535b26524ab54bb790c",
"date": "2022-05-24T20:29:19Z",
"weights": {"flower": {"wet": {"quantity": 100.1,
"unit_of_measure": "Grams"
}
},
"plant_material": {"wet": {"quantity": 100.1,
"unit_of_measure": "Grams"
}
}
}
},
{"id": "618ed4dfa1f1407195c125f7a78b4525",
"date": "2022-05-24T20:29:19Z",
"weights": {"flower": {"wet": {"quantity": 200.2,
"unit_of_measure": "Grams"
}
},
"plant_material": {"wet": {"quantity": 200.2,
"unit_of_measure": "Grams"
}
}
}
},
{"id": "949201a758794e9a96617191cc7a383c",
"date": "2022-05-24T20:29:19Z",
"weights": {"flower": {"wet": {"quantity": 300.3,
"unit_of_measure": "Grams"
}
},
"plant_material": {"wet": {"quantity": 300.3,
"unit_of_measure": "Grams"
}
}
}
}
],
"locations": {"harvest_locations": {"id": "39d820bae059468facede4bff0efc4ec"
},
"lots_locations": null
},
"products": null,
"additional": {"patient_license": null,
"is_for_medical_use": false
}
}

Response samples

application/json

{"results": {"type": "array",
"data": {"license": {"license_number": "KMP20222825",
"type": {"name": "Type 12"
}
},
"actions": null,
"id": "e80553d1d2d04c2fbe72054e5b4a4c83",
"name": "Tomino amuro kamui 06122022 manicure A02",
"harvest_date": {"start": "2022-06-12T18:27:39Z",
"end": "2022-06-12T19:27:39Z"
},
"type": {"id": "CAHHT0002",
"name": "manicure_harvest"
},
"strain": {"number": 1,
"unit_of_measure": "Each",
"strains": [{"id": "ef2db9096a8b48b5b261e0247098721a",
"name": "Tomino amuro kamui 05202022"
}
]
},
"totals": {"plants": {"number": 3,
"unit_of_measure": "Each"
},
"weights": {"total_weight": {"wet": {"quantity": 1201.2,
"initial_quantity": [{"qty": 1201.2
}
],
"unit_of_measure": "Grams"
},
"dry": null,
"moisture_loss": null
},
"flower": {"wet": {"quantity": 600.6,
"initial_quantity": [{"qty": 600.6
}
],
"unit_of_measure": "Grams"
},
"dry": null,
"moisture_loss": null
},
"plant_material": {"wet": {"quantity": 600.6,
"initial_quantity": [{"qty": 600.6
}
],
"unit_of_measure": "Grams"
},
"dry": null,
"moisture_loss": null
}
}
},
"cure": null,
"plants": [{"id": "1f46b71cbfa54535b26524ab54bb790c",
"barcode": "1A4FF0200000029000014271"
},
{"id": "618ed4dfa1f1407195c125f7a78b4525",
"barcode": "1A4FF0200000029000014275"
},
{"id": "949201a758794e9a96617191cc7a383c",
"barcode": "1A4FF0200000029000014273"
}
],
"waste": null,
"lots": null,
"locations": {"harvest_locations": {"id": "39d820bae059468facede4bff0efc4ec",
"name": "Hathaway cultivation 1",
"type": {"id": "CALOC0001",
"name": "Cultivation"
}
},
"lots_locations": null
},
"products": null,
"additional": {"patient_license": null,
"is_for_medical_use": false
},
"entity_state": [{"state": "active",
"date": "2022-07-06T23:56:18Z",
"reason": "manicure_harvest",
"actioned_by": "system generated"
},
{"state": "updated",
"date": "2022-07-06T23:56:17Z",
"reason": "harvest updated",
"actioned_by": "system generated"
},
{"state": "lab_testing_not_submitted",
"date": "2022-07-06T23:56:17Z",
"reason": "harvest lab testing not submitted",
"actioned_by": "system generated by metrc"
}
]
}
},
"warnings": [{"detail": "plant_id 949201a758794e9a96617191cc7a383c plants.date entered is 1035 hours before the current time stamp 2022-07-06T23:56:14Z",
"type": "plants.date"
},
{"detail": "plant_id 618ed4dfa1f1407195c125f7a78b4525 plants.date entered is 1035 hours before the current time stamp 2022-07-06T23:56:14Z",
"type": "plants.date"
},
{"detail": "plant_id 1f46b71cbfa54535b26524ab54bb790c plants.date entered is 1035 hours before the current time stamp 2022-07-06T23:56:14Z",
"type": "plants.date"
}
]
}

Retrieve harvest(s) details

Retrieve the harvest details. If the id is not provided, the details of all the active harvests 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 Harvest 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
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
name	string Display name of the harvest. Example: name=Harvest strain 06122022 manicure A02
expand	string The expand query parameter is used to include additional information for the child objects in the harvests response. Enum: "cure" "waste" "lots" "all"
entity_state	string Queryable entity states for plant. Inactive will return harvested, destroyed, and/or deleted harvests. Enum: "active" "inactive" "curing" "cured" "updated" "finished" "unfinished" "onhold" "lab_testing_not_submitted" "lab_testing_submitted" "lab_testing_in_progress" "lab_testing_awaiting_confirmation" "lab_testing_passed" "lab_testing_failed" "lab_retesting_in_progress" "lab_retest_passed" "lab_retest_failed"
start_date	string Starting date for the time range of harvest's modifications. Example: start_date=2020-09-04
end_date	string End date for the time range of harvest's modifications. 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

Response Schema: application/json

object

type

string

Value: "object"

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.

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 this harvest.

id	string Reference (entity_ID) for the harvest action.
name	string Display name of the harvest action.

string

Reference (entity_ID) for the harvest.

name

string

User friendly reference for the harvest.

object

Start and end dates of the harvest.

start	string Timestamp date of the start of this harvest in ISO 8601 UTC format
end	string Timestamp date of the end of this harvest in ISO 8601 UTC format

object

id	string Reference (entity_ID) for the harvests type

object

The strains in the harvest.

number

integer

The number of strains.

unit_of_measure

string

Unit of measure for the strains.

Array of objects

List of strains in the harvest. Note: Some state's require harvests to be made up of only one strain. Please review your state's guidelines.

Array

number	integer The number of strains.
unit_of_measure	string Unit of measure for the strains.
	Array of objects List of strains in the harvest.

object

Total aggregates for Harvest components, such as the number of plants in the harvest and the total weight of harvested material.

object

number	integer Number of plants in the harvest
unit_of_measure	string The unit of measure of the number of plants.

object

number

integer

Total number of harvests.

object

	object
	object
	object

object

Harvest's cure information.

number

integer

Number of cures in the harvest.

Array of objects

Cure event data of the harvest

Array

id	string Unique identifier for the cure event
name	string Display name for the cure event
	object The cure drying time
	object The temperature
	object The humidity info of the cure
date	string Timestamp date of the cure event
	object

Array of objects

Plants that are in the harvest

Array

id	string Unique identifier of the plant
name	string Name of the plant.
barcode	string Unique identifier for tracking purposes.
date	string Growth date of the plant in ISO 8601 UTC format.
	object Distribution of weights for the individual plant.

object

Waste removal event.

quantity	integer Amount of waste removed.
unit_of_measure	number Unit of measure used for quantity

object

The lot information for the harvest

number

integer

Number of lots ....

quantity

integer

Amount ....

unit_of_measure

number

Unit of measure used for quantity

Array of objects

Lots in the harvest

Array

id	string Unique identifier for the lot
name	string Display name for the lot
barcode	string Barcode of the lot
quantity	number Quantity of the lot.
unit_of_measure	string Unit of measure of the quantity
date	string Timestamp date of the lot
	object
	object

object

id	string Reference (entity_ID) for the location.
name	string name of the location.
	object Type of the location.

object

id	string Reference (entity_ID) for the location.
name	string name of the location.
	object Type of the location.

object

Products that are created

object

Additional information

patient_license	string License number of the patient.
is_for_medical_user	boolean True if for a medical user, false otherwise.

Array of objects

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/harvests/{id}

Response samples

application/json

{"results": {"type": "array",
"records": {"count": "0 - 100",
"total": 437,
"previous": null,
"next": "https://integration-kmp.greencheckverified.com/ca/v1/harvests?license_number=123-LIC&limit=100&offset=100"
},
"data": {"license": {"license_number": "KMP20222825",
"type": {"name": "Type 12"
}
},
"actions": {"id": "KMHAN0002",
"name": "cure"
},
"id": "a66594cfea964c959292fcc5e188f662",
"name": "Tomino amuro kamui 05242022 manicure 1",
"harvest_date": {"start": "2022-05-24T18:27:39Z",
"end": "2022-05-24T00:00:00Z"
},
"type": {"id": "CAHHT0002",
"name": "manicure_harvest"
},
"strain": {"number": 1,
"unit_of_measure": "Each",
"strains": [{"id": "ef2db9096a8b48b5b261e0247098721a",
"name": "Tomino amuro kamui 05202022"
}
]
},
"totals": {"plants": {"number": 3,
"unit_of_measure": "Each"
},
"weights": {"total_weight": {"wet": {"quantity": 0,
"initial_quantity": [{"qty": 1201.2
}
],
"unit_of_measure": "Grams"
},
"dry": {"quantity": 301.6,
"initial_quantity": [{"qty": 361.6
},
{"qty": 301.6
}
],
"unit_of_measure": "Grams"
},
"moisture_loss": {"quantity": [{"qty": 839.6
},
{"qty": 899.6
}
],
"unit_of_measure": "Grams"
}
},
"flower": {"wet": {"quantity": 0,
"initial_quantity": [{"qty": 600.6
}
],
"unit_of_measure": "Grams"
},
"dry": {"quantity": 150.8,
"initial_quantity": [{"qty": 180.8
},
{"qty": 150.8
}
],
"unit_of_measure": "Grams"
},
"moisture_loss": {"quantity": [{"qty": 419.8
},
{"qty": 449.8
}
],
"unit_of_measure": "Grams"
}
},
"plant_material": {"wet": {"quantity": 0,
"initial_quantity": [{"qty": 600.6
}
],
"unit_of_measure": "Grams"
},
"dry": {"quantity": 150.8,
"initial_quantity": [{"qty": 180.8
},
{"qty": 150.8
}
],
"unit_of_measure": "Grams"
},
"moisture_loss": {"quantity": [{"qty": 419.8
},
{"qty": 449.8
}
],
"unit_of_measure": "Grams"
}
}
}
},
"cure": {"number": 2,
"cures": [{"id": "133c21a843b745b49144e6184550f4b0",
"name": "Tomino amuro kamui 05242022 cure 2",
"drying": {"duration": 720,
"unit_of_measure": "hours"
},
"temperature": {"value": 25,
"unit_of_measure": "Celsius"
},
"humidity": {"level": 60,
"unit_of_measure": "RH percent"
},
"date": "2022-05-24T20:29:19Z",
"locations": {"harvest_locations": {"id": "39d820bae059468facede4bff0efc4ec",
"name": "Hathaway cultivation 1"
},
"lots_locations": {"id": null,
"name": null
}
}
},
{"id": "165d455b919d4023ba007317b7882c80",
"name": "Tomino amuro kamui 05242022 cure 3",
"drying": {"duration": 720,
"unit_of_measure": "hours"
},
"temperature": {"value": 25,
"unit_of_measure": "Celsius"
},
"humidity": {"level": 60,
"unit_of_measure": "RH percent"
},
"date": "2022-05-24T20:29:19Z",
"locations": {"harvest_locations": {"id": "39d820bae059468facede4bff0efc4ec",
"name": "Hathaway cultivation 1"
},
"lots_locations": {"id": null,
"name": null
}
}
}
]
},
"plants": [{"id": "1f46b71cbfa54535b26524ab54bb790c",
"barcode": "1A4FF0200000029000014271"
},
{"id": "618ed4dfa1f1407195c125f7a78b4525",
"barcode": "1A4FF0200000029000014275"
},
{"id": "949201a758794e9a96617191cc7a383c",
"barcode": "1A4FF0200000029000014273"
}
],
"waste": {"quantity": 100,
"unit_of_measure": "Grams"
},
"lots": null,
"locations": {"harvest_locations": {"id": "39d820bae059468facede4bff0efc4ec",
"name": "Hathaway cultivation 1",
"type": {"id": "CALOC0001",
"name": "Cultivation"
}
},
"lots_locations": null
},
"products": null,
"additional": {"patient_license": null,
"is_for_medical_use": false
},
"entity_state": [{"state": "active",
"date": "2022-05-25T21:10:32Z",
"reason": "manicure_harvest",
"actioned_by": "system generated"
},
{"state": "updated",
"date": "2022-05-25T21:11:55Z",
"reason": "harvest updated",
"actioned_by": "system generated"
},
{"state": "lab_testing_not_submitted",
"date": "2022-05-25T21:11:55Z",
"reason": "harvest lab testing not submitted",
"actioned_by": "system generated by metrc"
},
{"state": "waste_removed",
"date": "2022-05-24T18:27:39Z",
"reason": "100.0 Grams of waste removed ID 5feaaddab18d44f7b7e0d5973c4de553",
"actioned_by": "user credentials"
},
{"state": "cured",
"date": "2022-06-14T19:45:49Z",
"reason": "harvest cured",
"actioned_by": "system generated"
}
]
}
},
"warnings": [ ]
}

Update harvest

Update the details of a harvest 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 Harvest 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 harvest operation.

required

string

Reference (entity_id) for the harvest action.

Array of objects

List of weights for the harvest update.

Array

object

quantity	number Current quantity
unit_of_measure	string Unit of measure for the weight.

object

quantity	number Current quantity
unit_of_measure	string Unit of measure for the weight.

object

quantity	number Current quantity
unit_of_measure	string Unit of measure for the weight.

object

quantity	number Current quantity
unit_of_measure	string Unit of measure for the weight.

Array of objects

List of plants involved in the harvest update.

Array

string

Trace ID assigned to the plant.

object

Distribution of weights for the individual plant.

object

	object
	object

object

	object
	object

object

Details for the cure, if harvest action is a cure.

name

string

object

Details of the cure duration.

duration	number
unit_of_measure	string Unit of time measurement for the cure duration.

object

Details of the cure temperature

value	number
unit_of_measure	string Unit of temperature measurement for the cure duration.

object

Details of the cure humidity level

value	number
unit_of_measure	string Unit of humidity measurement for the cure duration.

date

string

Timestamps of the cure.

object

Products involved in the harvest update.

object

id	string
category	string

object

id	string
category	string

object

Harvest's location information.

object

Location of the harvest during curing

id	string Trace Location ID where the harvest will be stored for curing.

object

Location of the harvest lots made during the harvest process. Only applicable in Biotrack states.

id	string Trace Location ID where the plant material lot will go during harvest.

object

Additional information related to the harvest.

patient_license	string License number of the patient.
is_for_medical_user	boolean True if for a medical user, false otherwise.

Responses

200

Response Schema: application/json

object

type

string

Value: "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 this harvest.

id	string Reference (entity_ID) for the harvest action.
name	string Display name of the harvest action.

string

Reference (entity_ID) for the harvest.

name

string

User friendly reference for the harvest.

object

Start and end dates of the harvest.

start	string Timestamp date of the start of this harvest in ISO 8601 UTC format
end	string Timestamp date of the end of this harvest in ISO 8601 UTC format

object

id	string Reference (entity_ID) for the harvests type

object

The strains in the harvest.

number

integer

The number of strains.

unit_of_measure

string

Unit of measure for the strains.

Array of objects

List of strains in the harvest. Note: Some state's require harvests to be made up of only one strain. Please review your state's guidelines.

Array

number	integer The number of strains.
unit_of_measure	string Unit of measure for the strains.
	Array of objects List of strains in the harvest.

object

Total aggregates for Harvest components, such as the number of plants in the harvest and the total weight of harvested material.

object

number	integer Number of plants in the harvest
unit_of_measure	string The unit of measure of the number of plants.

object

number

integer

Total number of harvests.

object

	object
	object
	object

object

Harvest's cure information.

number

integer

Number of cures in the harvest.

Array of objects

Cure event data of the harvest

Array

id	string Unique identifier for the cure event
name	string Display name for the cure event
	object The cure drying time
	object The temperature
	object The humidity info of the cure
date	string Timestamp date of the cure event
	object

Array of objects

Plants that are in the harvest

Array

id	string Unique identifier of the plant
name	string Name of the plant.
barcode	string Unique identifier for tracking purposes.
date	string Growth date of the plant in ISO 8601 UTC format.
	object Distribution of weights for the individual plant.

object

Waste removal event.

quantity	integer Amount of waste removed.
unit_of_measure	number Unit of measure used for quantity

object

The lot information for the harvest

number

integer

Number of lots ....

quantity

integer

Amount ....

unit_of_measure

number

Unit of measure used for quantity

Array of objects

Lots in the harvest

Array

id	string Unique identifier for the lot
name	string Display name for the lot
barcode	string Barcode of the lot
quantity	number Quantity of the lot.
unit_of_measure	string Unit of measure of the quantity
date	string Timestamp date of the lot
	object
	object

object

id	string Reference (entity_ID) for the location.
name	string name of the location.
	object Type of the location.

object

id	string Reference (entity_ID) for the location.
name	string name of the location.
	object Type of the location.

object

Products that are created

object

Additional information

patient_license	string License number of the patient.
is_for_medical_user	boolean True if for a medical user, false otherwise.

Array of objects

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/harvests/{id}

Request samples

Payload

application/json

{"license": {"license_number": "KMP20222825"
},
"action": {"id": "KMHAN0006"
},
"move_date": "2022-05-24T20:29:19Z",
"locations": {"id": "f6c3a86531294b0c83eacc1104a6a680"
}
}

Response samples

application/json

{"results": {"type": "array",
"data": {"license": {"license_number": "KMP20222825",
"type": {"name": "Type 12"
}
},
"actions": {"id": "KMHAN0006",
"name": "move"
},
"id": "31f31970bcdf423796e2bb7f6f227017",
"name": "Hathaway rejit 052472022 Update",
"harvest_date": {"start": "2022-07-06T18:27:39Z",
"end": "2022-07-06T00:00:00Z"
},
"type": {"id": "CAHHT0002",
"name": "manicure_harvest"
},
"strain": {"number": 1,
"unit_of_measure": "Each",
"strains": [{"id": "ef2db9096a8b48b5b261e0247098721a",
"name": "Tomino amuro kamui 05202022"
}
]
},
"totals": {"plants": {"number": 3,
"unit_of_measure": "Each"
},
"weights": {"total_weight": {"wet": {"quantity": 0,
"initial_quantity": [{"qty": 1201.2
}
],
"unit_of_measure": "Grams"
},
"dry": {"quantity": 83.8208,
"initial_quantity": [{"qty": 100.24
}
],
"unit_of_measure": "Grams"
},
"moisture_loss": {"quantity": [{"qty": 1100.96
}
],
"unit_of_measure": "Grams"
}
},
"flower": {"wet": {"quantity": 0,
"initial_quantity": [{"qty": 600.6
}
],
"unit_of_measure": "Grams"
},
"dry": {"quantity": 33.7008,
"initial_quantity": [{"qty": 50.12
}
],
"unit_of_measure": "Grams"
},
"moisture_loss": {"quantity": [{"qty": 550.48
}
],
"unit_of_measure": "Grams"
}
},
"plant_material": {"wet": {"quantity": 0,
"initial_quantity": [{"qty": 600.6
}
],
"unit_of_measure": "Grams"
},
"dry": {"quantity": 50.12,
"initial_quantity": [{"qty": 50.12
}
],
"unit_of_measure": "Grams"
},
"moisture_loss": {"quantity": [{"qty": 550.48
}
],
"unit_of_measure": "Grams"
}
}
}
},
"cure": {"number": 1,
"cures": [{"id": "0a82fae21905473eaa0445fdf0bdb77b",
"name": "Tomino amuro kamui 05242022 cure 1",
"drying": {"duration": 720,
"unit_of_measure": "hours"
},
"temperature": {"value": 25,
"unit_of_measure": "Celsius"
},
"humidity": {"level": 60,
"unit_of_measure": "RH percent"
},
"date": "2022-05-24T20:29:19Z",
"locations": {"harvest_locations": {"id": "39d820bae059468facede4bff0efc4ec",
"name": "Hathaway cultivation 1"
},
"lots_locations": {"id": null,
"name": null
}
}
}
]
},
"plants": [{"id": "1f46b71cbfa54535b26524ab54bb790c",
"barcode": "1A4FF0200000029000014271"
},
{"id": "618ed4dfa1f1407195c125f7a78b4525",
"barcode": "1A4FF0200000029000014275"
},
{"id": "949201a758794e9a96617191cc7a383c",
"barcode": "1A4FF0200000029000014273"
}
],
"waste": null,
"lots": {"number": 7,
"quantity": 16.4192,
"unit_of_measure": "Grams",
"lot": [{"id": "afbf6642151f456e8941722b3c00340d",
"name": "Tomino amuro kamui buds weight lot 01",
"barcode": "1A4FF0300000029000016680",
"quantity": 2.3456,
"unit_of_measure": "Grams",
"date": "2022-06-12T20:04:50Z",
"contents": {"products": {"id": "3aef481fd5d2423382188f482f7a8383",
"name": "Tomino amuro kamui 05202022 Flower Buds weight product 01",
"category": {"id": "CAKOMPC0014",
"type": "Buds",
"main_category": "Flower",
"sub_category": null
}
}
},
"locations": {"id": "39d820bae059468facede4bff0efc4ec",
"name": "Hathaway cultivation 1",
"type": {"id": "CALOC0001",
"name": "Cultivation"
}
}
},
{"id": "03795e508adb4d85b0a67d779d64951b",
"name": "Tomino amuro kamui buds weight lot 02",
"barcode": "ABCDEF012345670000010042",
"quantity": 1,
"unit_of_measure": "Ounces",
"date": "2014-11-29T00:00:00Z",
"contents": {"products": {"id": "3aef481fd5d2423382188f482f7a8383",
"name": "Tomino amuro kamui 05202022 Flower Buds weight product 01",
"category": {"id": "CAKOMPC0014",
"type": "Buds",
"main_category": "Flower",
"sub_category": null
}
}
},
"locations": {"id": "39d820bae059468facede4bff0efc4ec",
"name": "Hathaway cultivation 1",
"type": {"id": "CALOC0001",
"name": "Cultivation"
}
}
},
{"id": "3e09000a85c748819f8c4ab789e58623",
"name": "Tomino amuro kamui buds weight lot A01",
"barcode": "ABCDEF012345670000010042",
"quantity": 1,
"unit_of_measure": "Ounces",
"date": "2014-11-29T00:00:00Z",
"contents": {"products": {"id": "3aef481fd5d2423382188f482f7a8383",
"name": "Tomino amuro kamui 05202022 Flower Buds weight product 01",
"category": {"id": "CAKOMPC0014",
"type": "Buds",
"main_category": "Flower",
"sub_category": null
}
}
},
"locations": {"id": "39d820bae059468facede4bff0efc4ec",
"name": "Hathaway cultivation 1",
"type": {"id": "CALOC0001",
"name": "Cultivation"
}
}
},
{"id": "5ad8e730dd904ec7ad1e2f69cec7b8fa",
"name": "Tomino amuro kamui buds weight lot A02",
"barcode": "ABCDEF012345670000010042",
"quantity": 1,
"unit_of_measure": "Ounces",
"date": "2014-11-29T00:00:00Z",
"contents": {"products": {"id": "dd92f06c2f104fe5abfbdcddf8baf233",
"name": "Tomino amuro kamui 05202022 Flower Buds weight product 05",
"category": {"id": "CAKOMPC0014",
"type": "Buds",
"main_category": "Flower",
"sub_category": null
}
}
},
"locations": {"id": "39d820bae059468facede4bff0efc4ec",
"name": "Hathaway cultivation 1",
"type": {"id": "CALOC0001",
"name": "Cultivation"
}
}
},
{"id": "64cd9fece1e94907b3f072426b99f65a",
"name": "Tomino amuro kamui buds weight lot A03",
"barcode": "ABCDEF012345670000010042",
"quantity": 1,
"unit_of_measure": "Ounces",
"date": "2014-11-29T00:00:00Z",
"contents": {"products": {"id": "3aef481fd5d2423382188f482f7a8383",
"name": "Tomino amuro kamui 05202022 Flower Buds weight product 01",
"category": {"id": "CAKOMPC0014",
"type": "Buds",
"main_category": "Flower",
"sub_category": null
}
}
},
"locations": {"id": "39d820bae059468facede4bff0efc4ec",
"name": "Hathaway cultivation 1",
"type": {"id": "CALOC0001",
"name": "Cultivation"
}
}
},
{"id": "91d638770b5e44c5856045fcced35f56",
"name": "Tomino amuro kamui buds weight lot A04",
"barcode": "ABCDEF012345670000010042",
"quantity": 1,
"unit_of_measure": "Ounces",
"date": "2014-11-29T00:00:00Z",
"contents": {"products": {"id": "3aef481fd5d2423382188f482f7a8383",
"name": "Tomino amuro kamui 05202022 Flower Buds weight product 01",
"category": {"id": "CAKOMPC0014",
"type": "Buds",
"main_category": "Flower",
"sub_category": null
}
}
},
"locations": {"id": "39d820bae059468facede4bff0efc4ec",
"name": "Hathaway cultivation 1",
"type": {"id": "CALOC0001",
"name": "Cultivation"
}
}
},
{"id": "7e76cef9f31246ecb0762845f15068a8",
"name": "Tomino amuro kamui buds weight lot A05",
"barcode": "1A4FF0300000029000017209",
"quantity": 2.3456,
"unit_of_measure": "Grams",
"date": "2022-06-30T20:04:50Z",
"contents": {"products": {"id": "3aef481fd5d2423382188f482f7a8383",
"name": "Tomino amuro kamui 05202022 Flower Buds weight product 01",
"category": {"id": "CAKOMPC0014",
"type": "Buds",
"main_category": "Flower",
"sub_category": null
}
}
},
"locations": {"id": "39d820bae059468facede4bff0efc4ec",
"name": "Hathaway cultivation 1",
"type": {"id": "CALOC0001",
"name": "Cultivation"
}
}
}
]
},
"locations": {"harvest_locations": {"id": "f6c3a86531294b0c83eacc1104a6a680",
"name": "Harvest Room #697706",
"type": {"id": "CALOC0001",
"name": "Cultivation"
}
},
"lots_locations": null
},
"products": null,
"additional": {"patient_license": null,
"is_for_medical_use": false
},
"entity_state": [{"state": "active",
"date": "2022-05-25T22:30:21Z",
"reason": "manicure_harvest",
"actioned_by": "system generated"
},
{"state": "updated",
"date": "2022-07-07T00:14:40Z",
"reason": "harvest updated",
"actioned_by": "system generated"
},
{"state": "lab_testing_not_submitted",
"date": "2022-05-25T22:30:21Z",
"reason": "harvest lab testing not submitted",
"actioned_by": "system generated by metrc"
},
{"state": "harvest_moved",
"date": "2022-05-24T20:29:19Z",
"reason": "original location 39d820bae059468facede4bff0efc4ec Hathaway cultivation 1 to new location ae7313d71a4c4675b94f521e3b4f4f81 Harvest Room #940657",
"actioned_by": "user credentials"
},
{"state": "name_changed",
"date": "2022-04-24T00:00:00Z",
"reason": "harvest name changed from Tomino amuro kamui 05242022 manicure 3 to Hathaway rejit 052472022 Update",
"actioned_by": "user credentials"
},
{"state": "cured",
"date": "2022-06-06T20:10:38Z",
"reason": "harvest cured",
"actioned_by": "system generated"
},
{"state": "used",
"date": "2022-06-12T19:17:50Z",
"reason": "harvest is used",
"actioned_by": "system generated"
},
{"state": "harvest_moved",
"date": "2022-05-24T20:29:19Z",
"reason": "original location ae7313d71a4c4675b94f521e3b4f4f81 Harvest Room #940657 to new location f6c3a86531294b0c83eacc1104a6a680 Harvest Room #697706",
"actioned_by": "user credentials"
}
]
}
},
"warnings": [ ]
}

Delete harvest

Deactivate a harvest for the license_number provided. This allows a licensee to correct plants that were accidentally scheduled for harvest. Once actually harvested, the licensee cannot deactivate without 'finishing' the harvest.

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 Harvest 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.

Responses

200

Response Schema: application/json

object

type

string

Value: "object"

object

string

Reference (entity_ID) for the harvest.

deleted

boolean

True if the harvest was deleted successfully, otherwise false.

object

	object
	object

object

	object
	object

Array of objects

Array

type	string
detail	string

400

Bad Request

delete/{state}/v1/harvests/{id}

Request samples

Payload

application/json

{"license": {"license_number": "KMP20200814"
}
}

Response samples

application/json

{"results": {"type": "object",
"data": {"id": "10",
"deleted": true
}
},
"warnings": [ ]
}

Retrieve harvests types

Retrieve the harvests types for a specific state

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

Response Schema: application/json

object

type

string

Value: "array"

Array of objects

Array

id	string Reference (entity_ID) for the harvests type
name	string name of the type.
note	string additional information on this type.

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/harvests/types

Response samples

application/json

{"results": {"type": "array",
"data": [{"id": "CAHHT0001",
"name": "whole_plant_harvest",
"note": "full plant harvest"
},
{"id": "CAHHT0002",
"name": "manicure_harvest",
"note": "product or partial harvest"
}
]
},
"warnings": [ ]
}

Retrieve harvests actions

Retrieve the harvests actions for a specific state

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

Response Schema: application/json

object

type

string

Value: "array"

Array of objects

Array

id	string Reference (entity_ID) for the harvest action
name	string name of the action.
note	string additional information on this action.

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/harvests/actions

Response samples

application/json

{"results": {"type": "array",
"data": [{"id": "KMHAN0001",
"name": "add to harvest or manicure",
"note": "add plant material or flowers to batch"
},
{"id": "KMHAN0002",
"name": "cure",
"note": "cure operation for harvest"
},
{"id": "KMHAN0003",
"name": "rename",
"note": "rename manicure or harvest batch"
},
{"id": "KMHAN0004",
"name": "finish",
"note": "finish batch"
},
{"id": "KMHAN0005",
"name": "unfinish",
"note": "unfinish batch"
},
{"id": "KMHAN0006",
"name": "move",
"note": "move harvest batch to different location"
},
{"id": "KMHAN0007",
"name": "entity_state_change",
"note": "add, remove or change entity_state value"
},
{"id": "KMHAN0008",
"name": "additional",
"note": "change values under additional"
}
]
},
"warnings": [ ]
}

➔ Next to Additive