Lot

Create a lot

Create a lot for use by 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.

required

object

specific action for this lot operation.

required

string

reference (entity_id) for the lot action.

name

required

string

name of the lot.

required

object

product contained in the lot.

required

string

reference (entity_id) for the product

barcode

string

a unique identifier required for specific states.

quantity

required

number <float>

quantity of the lot.

unit_of_measure

required

string

unit of measure of the lot.

date

required

string

timestamp when the lot was created in ISO 8601 UTC format.

required

object

type of the lot as required by specific states.

required

string

reference (entity_ID) for the lot type.

required

object

location of the lot.

required

string

reference (entity_ID) for the location.

required

object

origin of the lot.

Array of objects

Array

id required	string reference (entity_ID) for the plant.
quantity required	number <float> quantity of the plant.
unit_of_measure required	string unit of measure for the quantity.

Array of objects

Array

id required	string Reference (entity_ID) for the plant_batch.
quantity required	number <float> The quantity of the plant_batch.
unit_of_measure required	string The unit of measure for the quantity.

Array of objects

Array

id required	string reference (entity_ID) for the harvest.
quantity required	number <float> quantity of the harvest.
unit_of_measure required	string unit of measure for the quantity.

Array of objects

Array

id required	string reference (entity_ID) for the lot.
quantity required	number <float> quantity of the lot.
unit_of_measure required	string unit of measure for the quantity.

object

additional information about the lot.

patient_license	string the license number of the patient.
is_for_medical_use	boolean true if the lot is for medical use.
medical_compliance_info	string information required by specific states for medical compliance
note	string an optional note about the lot.
is_production_batch	boolean true if the lot is a production batch.
production_batch_id	string id of the production batch.
is_trade_sample	boolean true if lot contains a trade sample.
is_donation	boolean true if the lot is a donation.
is_test_sample	boolean true if the lot is a test sample.
is_retest	boolean true is the lot is a retest sample.
is_process_validation_sample	boolean true if lot is a process validation sample.
is_requires_remediation	boolean true if the lot requires remediation.
is_remediated	boolean true if the lot has been remediated.
is_same_product	boolean true if the lot is a transfer into inventory and copying product information.
shipper_license_number	string Shipper license number that the lot was received from.
is_quarantine	boolean true if lot is quarantined.
is_initial_inventory	boolean true if the lot is initial inventory.
is_lab_or_qa_not_required	boolean true if the lot does NOT require lab work or QA.
lab_or_qa_result_url	string URL of the location of the lab or QA result.
authentication_id	string id required for authentication by specific states.
sample_data	string sample data as required by specific states.
transfer_id	string Id of the transfer manifest that the lot was received on.
date_received	string ISO 8601 UTC format date that the lot was received.

Array of objects

A list of state changes made to the entity. Entity states for lot [active, inactive, finished, unfinished, used].

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

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

specific action for this lot operation.

id	string reference (entity_id) for the lot action.
name	string name of the lot action.

string

reference (entity_ID) for the lot.

name

string

the display name of the lot.

barcode

string

barcode of the lot

quantity

number <float>

quantity of the units measured in unit_of_measure.

unit_of_measure

string

the unit of measure for the product in the lot.

date

string

timestamp date of lot creation in ISO 8601 UTC format

object

type of the lot as required by specific states

id	string reference (entity_id) for the lot type
name	string name of the lot type

object

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

origin of the lot.

Array of objects

Array

id	string ID of the plant.
barcode	string barcode of the plant.
name	string name of the plant.
type	string product category type as defined by the state.
quantity	number <float> The quantity of the plant.
unit_of_measure	string The unit of measure of the quantity.

Array of objects

Array

id	string reference (entity_ID) for the plant_batch.
barcode	string barcode of the plant_batch
name	string name of the plant_batch.
type	string The product category type as defined by the state.
quantity	number <float> The quantity of the plant_batch.
unit_of_measure	string The unit of measure of the quantity.

Array of objects

Array

id	string ID of the harvest.
barcode	string barcode of the harvest.
name	string name of the harvest.
type	string product category type as defined by the state.
quantity	number <float> quantity of the harvest.
unit_of_measure	string unit of measure of the quantity.

Array of objects

Array

id	string reference (entity_ID) of the lot.
barcode	string barcode of the lot.
name	string name of the lot.
type	string The type of the lot as defined by the state.
quantity	number <float> quantity of the lot.
unit_of_measure	string unit of measure of the quantity.

object

strain of the plant.

id	string reference (entity_ID) for the strain.
name	string name of the strain.

object

product contained in the lot.

id	string reference (entity_ID) for the product.
name	string name of the product.
	object category of the product.
	object product category’s characteristics.

object

additional information about the lot.

patient_license	string license number of the patient.
is_for_medical_use	boolean true if the lot is for medical use.
medical_compliance_info	string information required by specific states for medical compliance.
note	string optional note about the lot.
is_production_batch	boolean true if the lot is a production batch.
production_batch_id	string id of the production batch.
is_trade_sample	boolean true if lot is a trade sample.
is_donation	boolean true if lot is a donation.
is_test_sample	boolean true if the lot is a test sample.
is_retest	boolean true is the lot is a retest sample.
is_process_validation_sample	boolean true if lot is a process validation sample.
is_requires_remediation	boolean true if the lot requires remediation.
is_remediated	boolean true if the lot has been remediated.
is_same_product	boolean true if a product is same product as source lot.
shipper_license_number	string Shipper license number that the lot was received from.
is_quarantine	boolean true if lot is quarantined.
is_initial_inventory	boolean true if this is manually created initial inventory
is_lab_or_qa_not_required	boolean true if Lab tests or QA is not required for this lot
lab_or_qa_result_url	string URL indicating the path to the lab or qa results file
authentication_id	string id or value used by some states such as employee id associated with a lot or sample
sample_data	string values used by some states to specify intent of sample usage
transfer_id	string Id of the transfer manifest that the lot was received on.
date_received	string ISO 8601 UTC format date that the lot was received.

Array of objects

adjustments to lot.

Array

quantity	number <float> quantity of the adjustment.
unit_of_measure	string unit of measure for the adjustment.
	object The reason for the adjustment from a list specified by the state.
date	string date the adjustment was made in ISO 8601 UTC format.
note	string note regarding this adjustment [ The note is optional unless required by the state based on the adjustment reason ].
actioned_by	string person who made the adjustment.
received_by	string person who received dispersed samples as required by specific states.

Array of objects

The remediation action made to the package.

Array

	object The method used for remediation.
date	string date the remediation was made in ISO 8601 UTC format.
steps	string The steps taken to remediate the package.
actioned_by	string person who actioned the remediation.

Array of objects

list of state changes made to the entity. Entity states for lot [active, inactive, finished, unfinished, onhold, discontinued, 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, in_transit, scheduled_for_transfer, accepted, rejected, returned, received, partial_rejected, partial_returned, scheduled_for_destruction, lot_not_in_inventory].

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

Request samples

Payload

application/json

{"license": {"license_number": "KMP-20201027-TST"
},
"action": {"id": "KOMLA0004"
},
"name": "Kodai 01 extract intermediate Lot 1",
"product": {"id": "fg67e96ac61b4ca9bb9c2607f98f4"
},
"barcode": "1KMBV1200000000046",
"quantity": 100,
"unit_of_measure": "Grams",
"date": "2021-05-03T18:27:39Z",
"type": {"id": "KOMLT0001"
},
"location": {"id": "fg67123c61b4ca9bb9c2607fghg6"
},
"origin": {"lots": [{"id": "fg67e96ac61b4ca9bb9c2607fghg6",
"quantity": 50,
"unit_of_measure": "Grams"
},
{"id": "fg67e96ac61b4ca9bb9c26abcdf5",
"quantity": 50,
"unit_of_measure": "Grams"
}
]
},
"additional": {"patient_license": "",
"is_for_medical_use": false,
"medical_compliance_info": "no",
"note": "",
"is_production_batch": false,
"production_batch_id": "",
"is_trade_sample": false,
"is_donation": false,
"is_test_sample": false,
"is_retest": false,
"is_process_validation_sample": false,
"is_requires_remediation": false,
"is_remediated": false,
"is_same_product": false,
"shipper_license_number": "",
"is_quarantine": false,
"is_initial_inventory": false,
"is_lab_or_QA_not_required": false,
"lab_or_qa_result_url": "",
"authentication_id": "",
"sample_data": [ ],
"transfer_id": "",
"date_received": ""
}
}

Response samples

application/json

{"results": {"type": "object",
"data": {"license": {"license_number": "KMPL20200818",
"type": {"name": "Type 12"
}
},
"action": {"id": "KOMLA0004",
"name": "combine"
},
"id": "fg67e96ac61b4ca9bb9c2607f98f4",
"name": "Kodai 01 extract intermediate Lot 1",
"barcode": "1KMBV1200000000046",
"quantity": 100,
"unit_of_measure": "Grams",
"date": "2021-05-03T18:27:39Z",
"type": {"id": "KOMLT0001",
"name": "Product"
},
"location": {"id": "fg67123c61b4ca9bb9c2607fghg6",
"name": "KMP Persona Location 1",
"type": {"id": "3",
"name": "Processing KMP 1"
}
},
"origin": {"plant": [ ],
"plant_batch": [ ],
"harvest": [ ],
"lots": [{"id": "fg67e96ac61b4ca9bb9c2607fghg6",
"barcode": "1KMBV1200000000045",
"name": "Kodai 01 extract intermediate sub lot A01",
"type": "Concentrate",
"quantity": 50,
"unit_of_measure": "Grams"
},
{"id": "fg67e96ac61b4ca9bb9c26abcdf5",
"barcode": "1KMBV1200000000046",
"name": "Kodai 01 extract intermediate sub lot A02",
"type": "Concentrate",
"quantity": 50,
"unit_of_measure": "Grams"
}
]
},
"contents": {"strain": {"id": "e239e96ac61b4ca9bb9c2607f2egghc86f4",
"name": "Queen Emeraldus Bounty"
},
"product": {"id": "fg67e96ac61b4ca9bb9c2607f98f4",
"name": "Kodai 01 extract intermediate",
"category": {"id": "e239e96ac61b4ca9bb9c2607f2cc86f4",
"type": "Concentrate",
"main_category": "Extract (weight)",
"sub_category": ""
},
"characteristics": {"quantity_type": "WeightBased",
"unit_of_measure": "Grams",
"ingredients": ["CO2 Kodai 01 extract intermediate"
],
"strain": {"id": "e239e96ac61b4ca9bb9c2607f2egghc86f4",
"name": "Queen Emeraldus Bounty"
},
"unit": {"cannabinoids": {"cbd_percent": 10,
"thc_percent": 10
},
"cbd_content": null,
"cbd_content_uom": null,
"cbd_content_dose": null,
"cbd_content_dose_uom": null,
"thc_content": null,
"thc_content_uom": null,
"thc_content_dose": null,
"thc_content_dose_uom": null,
"volume": null,
"volume_uom": null,
"weight": 100,
"weight_uom": "Grams",
"quantity": null,
"quantity_uom": null
},
"serving_size": null,
"serving_num": null,
"supply_duration_days": null,
"doses_number": null,
"lab_test_ref": "NotSubmitted",
"administration_method": "",
"brand": "KMP",
"description": "",
"image": {"product": "http://www.kmp.com/my_product_image.png",
"label": "http://www.kmp.com/my_product_image.png",
"tracking_barcode": "http://www.kmp.com/my_tracking_barcode_image.png",
"upc_barcode": "http://www.kmp.com/my_upc_barcode_image.png",
"package": "http://www.kmp.com/my_package_image.png"
},
"contains_seeds": false
}
}
},
"additional": {"patient_license": "",
"is_for_medical_use": false,
"medical_compliance_info": "no",
"note": "",
"is_production_batch": false,
"production_batch_id": "",
"is_trade_sample": false,
"is_donation": false,
"is_test_sample": false,
"is_retest": false,
"is_process_validation_sample": false,
"is_requires_remediation": false,
"is_remediated": false,
"is_same_product": false,
"shipper_license_number": "",
"is_quarantine": false,
"is_initial_inventory": false,
"is_lab_or_QA_not_required": false,
"lab_or_qa_result_url": "",
"authentication_id": "",
"sample_data": "",
"transfer_id": "",
"date_received": ""
},
"adjustment": [ ],
"remediation": [ ],
"entity_state": [{"state": "active",
"date": "2021-05-21T20:29:19Z",
"reason": "lot created",
"actioned_by": "kodai@kmp.com"
}
]
}
},
"warnings": [ ]
}

Retrieve lot(s) details

Retrieve the lot details. If the id: is not provided, the details of all active lots 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 Lot 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
entity_state	string Queryable entity states for lots. Enum: "active" "inactive" "finished" "unfinished" "onhold" "discontinued" "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" "in_transit" "scheduled_for_transfer" "accepted" "rejected" "returned" "received" "partial_rejected" "partial_returned" "scheduled_for_destruction" "lot_not_in_inventory"
start_date	string start date value for query operations Example: start_date=2021-08-12T00:00:00z
end_date	string end date value for query operations Example: end_date=2021-08-13T00:00:00z
barcode	string Lot's tag that uniquely identifies it for tracking purposes. Example: barcode=1KMP00000000099000015442

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

specific action for this lot operation.

id	string reference (entity_id) for the lot action.
name	string name of the lot action.

string

reference (entity_ID) for the lot.

name

string

the display name of the lot.

barcode

string

barcode of the lot

quantity

number <float>

quantity of the units measured in unit_of_measure.

unit_of_measure

string

the unit of measure for the product in the lot.

date

string

timestamp date of lot creation in ISO 8601 UTC format

object

type of the lot as required by specific states

id	string reference (entity_id) for the lot type
name	string name of the lot type

object

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

origin of the lot.

Array of objects

Array

id	string ID of the plant.
barcode	string barcode of the plant.
name	string name of the plant.
type	string product category type as defined by the state.
quantity	number <float> The quantity of the plant.
unit_of_measure	string The unit of measure of the quantity.

Array of objects

Array

id	string reference (entity_ID) for the plant_batch.
barcode	string barcode of the plant_batch
name	string name of the plant_batch.
type	string The product category type as defined by the state.
quantity	number <float> The quantity of the plant_batch.
unit_of_measure	string The unit of measure of the quantity.

Array of objects

Array

id	string ID of the harvest.
barcode	string barcode of the harvest.
name	string name of the harvest.
type	string product category type as defined by the state.
quantity	number <float> quantity of the harvest.
unit_of_measure	string unit of measure of the quantity.

Array of objects

Array

id	string reference (entity_ID) of the lot.
barcode	string barcode of the lot.
name	string name of the lot.
type	string The type of the lot as defined by the state.
quantity	number <float> quantity of the lot.
unit_of_measure	string unit of measure of the quantity.

object

strain of the plant.

id	string reference (entity_ID) for the strain.
name	string name of the strain.

object

product contained in the lot.

id	string reference (entity_ID) for the product.
name	string name of the product.
	object category of the product.
	object product category’s characteristics.

object

additional information about the lot.

patient_license	string license number of the patient.
is_for_medical_use	boolean true if the lot is for medical use.
medical_compliance_info	string information required by specific states for medical compliance.
note	string optional note about the lot.
is_production_batch	boolean true if the lot is a production batch.
production_batch_id	string id of the production batch.
is_trade_sample	boolean true if lot is a trade sample.
is_donation	boolean true if lot is a donation.
is_test_sample	boolean true if the lot is a test sample.
is_retest	boolean true is the lot is a retest sample.
is_process_validation_sample	boolean true if lot is a process validation sample.
is_requires_remediation	boolean true if the lot requires remediation.
is_remediated	boolean true if the lot has been remediated.
is_same_product	boolean true if a product is same product as source lot.
shipper_license_number	string Shipper license number that the lot was received from.
is_quarantine	boolean true if lot is quarantined.
is_initial_inventory	boolean true if this is manually created initial inventory
is_lab_or_qa_not_required	boolean true if Lab tests or QA is not required for this lot
lab_or_qa_result_url	string URL indicating the path to the lab or qa results file
authentication_id	string id or value used by some states such as employee id associated with a lot or sample
sample_data	string values used by some states to specify intent of sample usage
transfer_id	string Id of the transfer manifest that the lot was received on.
date_received	string ISO 8601 UTC format date that the lot was received.

Array of objects

adjustments to lot.

Array

quantity	number <float> quantity of the adjustment.
unit_of_measure	string unit of measure for the adjustment.
	object The reason for the adjustment from a list specified by the state.
date	string date the adjustment was made in ISO 8601 UTC format.
note	string note regarding this adjustment [ The note is optional unless required by the state based on the adjustment reason ].
actioned_by	string person who made the adjustment.
received_by	string person who received dispersed samples as required by specific states.

Array of objects

The remediation action made to the package.

Array

	object The method used for remediation.
date	string date the remediation was made in ISO 8601 UTC format.
steps	string The steps taken to remediate the package.
actioned_by	string person who actioned the remediation.

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

Response samples

application/json

{"results": {"type": "object",
"data": {"license": {"license_number": "KMPL20200818",
"type": {"name": "Type 12"
}
},
"action": {"id": "KOMLA0004",
"name": "adjustment"
},
"id": "fg67e96ac61b4ca9bb9c2607f98f4",
"name": "Kodai 01 extract intermediate Lot 1",
"barcode": "1KMBV1200000000046",
"quantity": 100,
"unit_of_measure": "Grams",
"date": "2021-05-03T18:27:39Z",
"type": {"id": "KOMLT0001",
"name": "Product"
},
"location": {"id": "fg67123c61b4ca9bb9c2607fghg6",
"name": "KMP Persona Location 1",
"type": {"id": "3",
"name": "Processing KMP 1"
}
},
"origin": {"plant": [ ],
"plant_batch": [ ],
"harvest": [ ],
"lots": [{"id": "fg67e96ac61b4ca9bb9c2607fghg6",
"barcode": "1KMBV1200000000045",
"name": "Kodai 01 extract intermediate sub lot A01",
"type": "Concentrate",
"quantity": 50,
"unit_of_measure": "Grams"
},
{"id": "fg67e96ac61b4ca9bb9c26abcdf5",
"barcode": "1KMBV1200000000046",
"name": "Kodai 01 extract intermediate sub lot A02",
"type": "Concentrate",
"quantity": 50,
"unit_of_measure": "Grams"
}
]
},
"contents": {"strain": {"id": "e239e96ac61b4ca9bb9c2607f2egghc86f4",
"name": "Queen Emeraldus Bounty"
},
"product": {"id": "fg67e96ac61b4ca9bb9c2607f98f4",
"name": "Kodai 01 extract intermediate",
"category": {"id": "e239e96ac61b4ca9bb9c2607f2cc86f4",
"type": "Concentrate",
"main_category": "Extract (weight)",
"sub_category": ""
},
"characteristics": {"quantity_type": "WeightBased",
"unit_of_measure": "Grams",
"ingredients": ["CO2 Kodai 01 extract intermediate"
],
"strain": {"id": "e239e96ac61b4ca9bb9c2607f2egghc86f4",
"name": "Queen Emeraldus Bounty"
},
"unit": {"cannabinoids": {"cbd_percent": 10,
"thc_percent": 10
},
"cbd_content": null,
"cbd_content_uom": null,
"cbd_content_dose": null,
"cbd_content_dose_uom": null,
"thc_content": null,
"thc_content_uom": null,
"thc_content_dose": null,
"thc_content_dose_uom": null,
"volume": null,
"volume_uom": null,
"weight": 100,
"weight_uom": "Grams",
"quantity": null,
"quantity_uom": null
},
"serving_size": null,
"serving_num": null,
"supply_duration_days": null,
"doses_number": null,
"lab_test_ref": "NotSubmitted",
"administration_method": "",
"brand": "KMP",
"description": "",
"image": {"product": "http://www.kmp-cat.com/product_image.png",
"label": "http://www.kmp.com/my_product_label.png",
"tracking_barcode": "http://www.kmp-cat.com/my_tracking_barcode_image.png",
"upc_barcode": "http://www.kmp-cat.com/my_upc_barcode_image.png",
"package": "http://www.kmp-cat.com/my_package_image.png"
},
"contains_seeds": false
}
}
},
"additional": {"patient_license": "",
"is_for_medical_use": false,
"medical_compliance_info": "no",
"note": "",
"is_production_batch": false,
"production_batch_id": "",
"is_trade_sample": false,
"is_donation": false,
"is_retest": false,
"is_test_sample": false,
"is_process_validation_sample": false,
"is_requires_remediation": false,
"is_remediated": true,
"is_same_product": false,
"shipper_license_number": "CA-100098-LIC",
"is_quarantine": false,
"is_initial_inventory": false,
"is_lab_or_QA_not_required": false,
"lab_or_qa_result_url": "https://www.kmp.com/l/r/06012021/result_kmpic013.pdf",
"authentication_id": "",
"sample_data": "",
"transfer_id": "fg67e2345fdgh4ca9bb9c2607fghg6",
"date_received": "2021-05-03T18:27:39Z"
},
"adjustment": [{"quantity": -1,
"unit_of_measure": "Grams",
"reason": {"id": "CAAR0004",
"name": "Correcting a mistake",
"is_note_required": false
},
"date": "2021-07-28T13:54:06Z",
"note": "scale was not properly calibrated",
"actioned_by": "Kodai Susumu",
"received_by": ""
}
],
"remediation": [{"method": {"id": "CAAR0002",
"name": "Dilution of Concentrate of Analyte"
},
"date": "2021-07-28T13:54:06Z",
"steps": "added 9 Grams of MCT oil",
"actioned_by": "Kodai Susumu"
}
],
"entity_state": [{"state": "active",
"date": "2021-05-21T20:29:19Z",
"reason": "lot created",
"actioned_by": "kodai@kmp.com"
},
{"state": "lab_testing_passed",
"date": "2021-07-26T20:29:19Z",
"reason": "lab xyz123 test 789 passed",
"actioned_by": "kodai@kmp.com"
}
]
}
},
"warnings": [ ]
}

Update lot

Update the details of a lot 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 Lot 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.

object

specific action for this lot operation.

required

string

reference (entity_id) for the lot action.

name

string

name of the lot.

object

product contained in the lot.

required

string

reference (entity_id) for the product

object

The location of the lot.

required

string

reference ID for the location.

object

additional information about the lot.

is_requires_remediation	boolean true if the lot requires remediation.
is_remediated	boolean true if the lot has been remediated.lot_response_model
shipper_license_number	string Shipper license number that the lot was received from.
is_quarantine	boolean true if lot is quarantined.
is_lab_or_qa_not_required	boolean true if the lot does NOT require lab work or QA
lab_or_qa_result_url	string URL of the location of the lab or QA result
authentication_id	string id required for authentication by specific states
sample_data	string sample data as required by specific states
transfer_id	string Id of the transfer manifest that the lot was received on.
date_received	string ISO 8601 UTC format date that the lot was received.

Array of objects

The adjustments made to the package.

Array

quantity

number <float>

Quantity of the units measured in unit_of_measure.

unit_of_measure

string

The unit of measure for the product in the lot.

object

The reason for the adjustment from a list specified by the state.

id	string Reference (entity_ID) for the adjustment reason.

date

string <date-time>

The date the adjustment was made

note

string

A note regarding this adjustment [ The note is optional unless required by the state based on the adjustment reason ].

actioned_by

string

The user who made the adjustment.

received_by

string

person who received dispersed samples as required by specific states.

Array of objects

The remediation action made to the package.

Array

method	string The method used for remediation.
date	string <date-time> The date the remediation was made.
remediation_steps	Array of strings The steps taken to remediate the package.
actioned_by	string The user who made the remediation.

Array of objects

A list of state changes made to the entity. Entity states for lot [active, inactive, finished, unfinished, discontinued, used].

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

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

specific action for this lot operation.

id	string reference (entity_id) for the lot action.
name	string name of the lot action.

string

reference (entity_ID) for the lot.

name

string

the display name of the lot.

barcode

string

barcode of the lot

quantity

number <float>

quantity of the units measured in unit_of_measure.

unit_of_measure

string

the unit of measure for the product in the lot.

date

string

timestamp date of lot creation in ISO 8601 UTC format

object

type of the lot as required by specific states

id	string reference (entity_id) for the lot type
name	string name of the lot type

object

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

origin of the lot.

Array of objects

Array

id	string ID of the plant.
barcode	string barcode of the plant.
name	string name of the plant.
type	string product category type as defined by the state.
quantity	number <float> The quantity of the plant.
unit_of_measure	string The unit of measure of the quantity.

Array of objects

Array

id	string reference (entity_ID) for the plant_batch.
barcode	string barcode of the plant_batch
name	string name of the plant_batch.
type	string The product category type as defined by the state.
quantity	number <float> The quantity of the plant_batch.
unit_of_measure	string The unit of measure of the quantity.

Array of objects

Array

id	string ID of the harvest.
barcode	string barcode of the harvest.
name	string name of the harvest.
type	string product category type as defined by the state.
quantity	number <float> quantity of the harvest.
unit_of_measure	string unit of measure of the quantity.

Array of objects

Array

id	string reference (entity_ID) of the lot.
barcode	string barcode of the lot.
name	string name of the lot.
type	string The type of the lot as defined by the state.
quantity	number <float> quantity of the lot.
unit_of_measure	string unit of measure of the quantity.

object

strain of the plant.

id	string reference (entity_ID) for the strain.
name	string name of the strain.

object

product contained in the lot.

id	string reference (entity_ID) for the product.
name	string name of the product.
	object category of the product.
	object product category’s characteristics.

object

additional information about the lot.

patient_license	string license number of the patient.
is_for_medical_use	boolean true if the lot is for medical use.
medical_compliance_info	string information required by specific states for medical compliance.
note	string optional note about the lot.
is_production_batch	boolean true if the lot is a production batch.
production_batch_id	string id of the production batch.
is_trade_sample	boolean true if lot is a trade sample.
is_donation	boolean true if lot is a donation.
is_test_sample	boolean true if the lot is a test sample.
is_retest	boolean true is the lot is a retest sample.
is_process_validation_sample	boolean true if lot is a process validation sample.
is_requires_remediation	boolean true if the lot requires remediation.
is_remediated	boolean true if the lot has been remediated.
is_same_product	boolean true if a product is same product as source lot.
shipper_license_number	string Shipper license number that the lot was received from.
is_quarantine	boolean true if lot is quarantined.
is_initial_inventory	boolean true if this is manually created initial inventory
is_lab_or_qa_not_required	boolean true if Lab tests or QA is not required for this lot
lab_or_qa_result_url	string URL indicating the path to the lab or qa results file
authentication_id	string id or value used by some states such as employee id associated with a lot or sample
sample_data	string values used by some states to specify intent of sample usage
transfer_id	string Id of the transfer manifest that the lot was received on.
date_received	string ISO 8601 UTC format date that the lot was received.

Array of objects

adjustments to lot.

Array

quantity	number <float> quantity of the adjustment.
unit_of_measure	string unit of measure for the adjustment.
	object The reason for the adjustment from a list specified by the state.
date	string date the adjustment was made in ISO 8601 UTC format.
note	string note regarding this adjustment [ The note is optional unless required by the state based on the adjustment reason ].
actioned_by	string person who made the adjustment.
received_by	string person who received dispersed samples as required by specific states.

Array of objects

The remediation action made to the package.

Array

	object The method used for remediation.
date	string date the remediation was made in ISO 8601 UTC format.
steps	string The steps taken to remediate the package.
actioned_by	string person who actioned the remediation.

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

Request samples

Payload

application/json

{"license": {"license_number": "KMP-20201027-TST"
},
"action": {"id": "KOMLA0008"
},
"adjustment": [{"quantity": -1,
"unit_of_measure": "Grams",
"reason": {"id": "CAAR0004"
},
"date": "2021-07-28T13:54:06Z",
"note": "scale was not properly calibrated",
"actioned_by": "kodai susumu",
"received_by": ""
}
]
}

Response samples

application/json

{"results": {"type": "object",
"data": {"license": {"license_number": "KMPL20200818",
"type": {"name": "Type 12"
}
},
"action": {"id": "KOMLA0004",
"name": "adjustment"
},
"id": "fg67e96ac61b4ca9bb9c2607f98f4",
"name": "Kodai 01 extract intermediate Lot 1",
"barcode": "1KMBV1200000000046",
"quantity": 100,
"unit_of_measure": "Grams",
"date": "2021-05-03T18:27:39Z",
"type": {"id": "KOMLT0001",
"name": "Product"
},
"location": {"id": "fg67123c61b4ca9bb9c2607fghg6",
"name": "KMP Persona Location 1",
"type": {"id": "3",
"name": "Processing KMP 1"
}
},
"origin": {"plant": [ ],
"plant_batch": [ ],
"harvest": [ ],
"lots": [{"id": "fg67e96ac61b4ca9bb9c2607fghg6",
"barcode": "1KMBV1200000000045",
"name": "Kodai 01 extract intermediate sub lot A01",
"type": "Concentrate",
"quantity": 50,
"unit_of_measure": "Grams"
},
{"id": "fg67e96ac61b4ca9bb9c26abcdf5",
"barcode": "1KMBV1200000000046",
"name": "Kodai 01 extract intermediate sub lot A02",
"type": "Concentrate",
"quantity": 50,
"unit_of_measure": "Grams"
}
]
},
"contents": {"strain": {"id": "e239e96ac61b4ca9bb9c2607f2egghc86f4",
"name": "Queen Emeraldus Bounty"
},
"product": {"id": "fg67e96ac61b4ca9bb9c2607f98f4",
"name": "Kodai 01 extract intermediate",
"category": {"id": "e239e96ac61b4ca9bb9c2607f2cc86f4",
"type": "Concentrate",
"main_category": "Extract (weight)",
"sub_category": ""
},
"characteristics": {"quantity_type": "WeightBased",
"unit_of_measure": "Grams",
"ingredients": ["CO2 Kodai 01 extract intermediate"
],
"strain": {"id": "e239e96ac61b4ca9bb9c2607f2egghc86f4",
"name": "Queen Emeraldus Bounty"
},
"unit": {"cannabinoids": {"cbd_percent": 10,
"thc_percent": 10
},
"cbd_content": null,
"cbd_content_uom": null,
"cbd_content_dose": null,
"cbd_content_dose_uom": null,
"thc_content": null,
"thc_content_uom": null,
"thc_content_dose": null,
"thc_content_dose_uom": null,
"volume": null,
"volume_uom": null,
"weight": 100,
"weight_uom": "Grams",
"quantity": null,
"quantity_uom": null
},
"serving_size": null,
"serving_num": null,
"supply_duration_days": null,
"doses_number": null,
"lab_test_ref": "NotSubmitted",
"administration_method": "",
"brand": "KMP",
"description": "",
"image": {"product": "http://www.kmp-cat.com/product_image.png",
"label": "http://www.kmp.com/my_product_label.png",
"tracking_barcode": "http://www.kmp-cat.com/my_tracking_barcode_image.png",
"upc_barcode": "http://www.kmp-cat.com/my_upc_barcode_image.png",
"package": "http://www.kmp-cat.com/my_package_image.png"
},
"contains_seeds": false
}
}
},
"additional": {"patient_license": "",
"is_for_medical_use": false,
"medical_compliance_info": "no",
"note": "",
"is_production_batch": false,
"production_batch_id": "",
"is_trade_sample": false,
"is_donation": false,
"is_test_sample": false,
"is_retest": false,
"is_process_validation_sample": false,
"is_requires_remediation": false,
"is_remediated": true,
"is_same_product": false,
"shipper_license_number": "",
"is_quarantine": false,
"is_initial_inventory": false,
"is_lab_or_QA_not_required": false,
"lab_or_qa_result_url": "https://www.kmp.com/l/r/06012021/result_kmpic013.pdf",
"authentication_id": "",
"sample_data": "",
"transfer_id": "6",
"date_received": ""
},
"adjustment": [{"quantity": -1,
"unit_of_measure": "Grams",
"reason": {"id": "CAAR0004",
"name": "Correcting a mistake",
"is_note_required": false
},
"date": "2021-07-28T13:54:06Z",
"note": "scale was not properly calibrated",
"actioned_by": "Kodai Susumu",
"received_by": ""
}
],
"remediation": [{"method": {"id": "CAAR0002",
"name": "Dilution of Concentrate of Analyte"
},
"date": "2021-07-28T13:54:06Z",
"steps": "added 9 Grams of MCT oil",
"actioned_by": "Kodai Susumu"
}
],
"entity_state": [{"state": "active",
"date": "2021-05-21T20:29:19Z",
"reason": "lot created",
"actioned_by": "kodai@kmp.com"
},
{"state": "lab_testing_passed",
"date": "2021-07-26T20:29:19Z",
"reason": "lab xyz123 test 789 passed",
"actioned_by": "kodai@kmp.com"
}
]
}
},
"warnings": [ ]
}

Retrieve lot actions

Retrieve a list of lot actions for CREATE and 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

Response Schema: application/json

object

type

string

Value: "array"

Array of objects

Array

id	string reference id for the lot action.
name	string name of the lot action

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/lots/actions

Response samples

application/json

{"results": {"type": "array",
"data": [{"id": "KOMLA0001",
"name": "split"
},
{"id": "KOMLA0002",
"name": "change_product"
},
{"id": "KOMLA0003",
"name": "convert"
},
{"id": "KOMLA0004",
"name": "combine"
},
{"id": "KOMLA0005",
"name": "change_origin"
},
{"id": "KOMLA0006",
"name": "move"
},
{"id": "KOMLA0007",
"name": "entity_state"
},
{"id": "KOMLA0008",
"name": "adjustment"
},
{"id": "KOMLA0009",
"name": "remediate"
},
{"id": "KOMLA0010",
"name": "other"
}
]
},
"warnings": [ ]
}

Retrieve lot types

Retrieve a list of lot types

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 lot.
name	string name of the lot.

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/lots/types

Response samples

application/json

{"results": {"type": "array",
"data": [{"id": "KOMLT0001",
"name": "Product"
},
{"id": "KOMLT0002",
"name": "ImmaturePlant"
},
{"id": "KOMLT0003",
"name": "VegetativePlant"
},
{"id": "KOMLT0004",
"name": "PlantWaste"
},
{"id": "KOMLT0005",
"name": "HarvestWaste"
}
]
},
"warnings": [ ]
}

Retrieve adjustment reasons

Retrieve a list of adjustment reasons 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 adjustment reason.
name	string adjustment reason.
is_note_required	boolean true if not is required for adjustment reason.

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/lots/adjustment_reasons

Response samples

application/json

{"results": {"type": "array",
"data": [{"id": "CAAR0001",
"name": "Damage (BCC)",
"is_note_required": true
},
{"id": "CAAR0002",
"name": "Display Sample",
"is_note_required": false
},
{"id": "CAAR0003",
"name": "Failure to Thrive (BCC)",
"is_note_required": true
},
{"id": "CAAR0004",
"name": "Incorrect Quantity",
"is_note_required": false
}
]
},
"warnings": [ ]
}

Retrieve remediation methods

Retrieve a list of remediation methods 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 id for the remediation method.
name	string name of the remediation method

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/lots/remediation_methods

Response samples

application/json

{"results": {"type": "array",
"data": [{"id": "CAAR0001",
"name": "Additional Processing Method"
},
{"id": "CAAR0002",
"name": "Dilution of Concentrate of Analyte"
},
{"id": "CAAR0003",
"name": "Failure to Thrive (BCC)"
},
{"id": "CAAR0004",
"name": "Further Drying/Curing"
},
{"id": "CAAR0005",
"name": "Relabeled"
},
{"id": "CAAR0006",
"name": "Sterilization"
},
{"id": "CAAR0007",
"name": "Used for Concentrate or Extract"
}
]
},
"warnings": [ ]
}

Retrieve lots rejection_reasons

Retrieve the lots rejection reasons for transfers

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 or null

Array

id	string reference id for the rejection reason.
name	string name of the rejection reason.

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/lots/rejection_reasons

Response samples

application/json

{"results": {"type": "array",
"data": [{"id": "CATLRR0001",
"name": "damage"
},
{"id": "CATLRR0002",
"name": "damage_bcc"
},
{"id": "CATLRR0003",
"name": "data_entry_error"
},
{"id": "CATLRR0004",
"name": "incorrect_item_transfer"
},
{"id": "CATLRR0005",
"name": "incorrect_quantity"
},
{"id": "CATLRR0006",
"name": "non_compliant_label"
},
{"id": "CATLRR0007",
"name": "spoilage"
},
{"id": "CATLRR0008",
"name": "theft"
}
]
},
"warnings": [ ]
}

➔ Next to Lab