Product

Create product

Create a product

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

Product name.

Example: "KMP Purple Clones"

required

object

Categorization of the product.

id	string Reference (entity_ID) for the category of the product.

object

ingredients

Array of strings

Ingredients in the product.

object

The strain of the product

id	string Reference (entity_ID) for the strain.

object

Contains THC and CBD percentage values, the sum of both must be 100.

cbd_percent	number or null <float> the percent of cbd.
thc_percent	number or null <float> the percent of thc.

cbd_content

number or null <float>

Quantity of the CBD content

cbd_content_uom

string or null

Unit of measure for the CBD content

cbd_content_dose

number or null <float>

Quantity of the CBD content in one dose

cbd_content_dose_uom

string or null

Unit of measure for the CBD content in one dose

thc_content

number or null <float>

Quantity of the THC content

thc_content_uom

string or null

Unit of measure for the THC content

thc_content_dose

number or null <float>

Quantity of the THC content in one dose

thc_content_dose_uom

string or null

Unit of measure for the THC content in one dose

volume

number or null <float>

Standard volume of the product's content

volume_uom

string or null

Volume's unit of measure

weight

number or null <float>

Standard weight of the product's content

weight_uom

string or null

Weight's unit of measure

quantity

number or null <float>

number of units in the product

quantity_uom

string or null

Quantity's unit of measure

serving_size

number or null <float>

Product's quantity per one serving

serving_num

number or null <float>

Product's number of servings

supply_duration_days

number or null <float>

number of days the product should last

doses_number

number or null <float>

Standard number of doses that the product contains

lab_test_ref

string

Laboratory test approval reference

administration_method

string or null

Contains the information of how the product is administrated

brand

string

Product's brand

description

string

Longer description of the product

object

Object containing paths to product, package, and barcode images

product	string Url path to the product's image.
label	string Url path to the label's image.
tracking_barcode	string Url path to the image showing the barcode of the product's package.
upc_barcode	string Url path to the image showing the upc barcode of the product's package.
package	string Url path to the product's package image.

contains_seeds

boolean

true if product contains seeds.

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 .

string

Reference (entity_ID) for the product.

Example: 225903

name

string

Product name.

Example: "KMP Purple Clones"

object

id	string Reference (ID) for the product category.
type	string The type of the product category.
main_category	string The main category of the product.
sub_category	string or null The subcategory of the product.

object

quantity_type

string

Type of quantity.

Example: "CountBased"

unit_of_measure

string

Unit of measure.

Example: "Each"

ingredients

Array of strings

Ingredients in the product.

object

The strain of the product

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

object

	object Contains THC and CBD percentage values, the sum of both must be 100.
cbd_content	number or null <float> Quantity of the CBD content
cbd_content_uom	string or null Unit of measure for the CBD content
cbd_content_dose	number or null <float> Quantity of the CBD content in one dose
cbd_content_dose_uom	string or null Unit of measure for the CBD content in one dose
thc_content	number or null <float> Quantity of the THC content
thc_content_uom	string or null Unit of measure for the THC content
thc_content_dose	number or null <float> Quantity of the THC content in one dose
thc_content_dose_uom	string or null Unit of measure for the THC content in one dose
volume	number or null <float> Standard volume of the product's content
volume_uom	string or null Volume's unit of measure
weight	number or null <float> Standard weight of the product's content
weight_uom	string or null Weight's unit of measure
quantity	number or null <float> number of units in the product
quantity_uom	string or null Quantity's unit of measure

serving_size

number or null <float>

Product's quantity per one serving

serving_num

number or null <float>

Product's number of servings

supply_duration_days

number or null <float>

number of days the product should last

doses_number

number or null <float>

Standard number of doses that the product contains

lab_test_ref

string

Laboratory test approval reference

administration_method

string or null

Contains the information of how the product is administrated

brand

string

Product's brand

description

string

Longer description of the product

object

Object containing paths to product, package, and barcode images

product	string Url path to the product's image.
label	string Url path to the label's image.
tracking_barcode	string Url path to the image showing the barcode of the product's package.
upc_barcode	string Url path to the image showing the upc barcode of the product's package.
package	string Url path to the product's package image.

contains_seeds

boolean

true if product contains seeds.

Array of objects

A list of state changes made to the entity. Entity states for the product [active, inactive, approved, 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).

Array of objects

Array

type	string
detail	string

400

Bad Request

post/{state}/v1/config/products

Request samples

Payload

application/json

{"license": {"license_number": "KMP-20201027-TST"
},
"name": "KMP Hikari",
"category": {"id": "e239e96ac61b4ca9bb9c2607f2cc86f4"
},
"characteristics": {"ingredients": ["paradigm atom concentrate"
],
"strain": {"id": "e239e96ac61b4ca9bb9c2607f2egghc86f4"
},
"unit": {"cannabinoids": {"cbd_percent": 50,
"thc_percent": 50
},
"cbd_content": 0.2,
"cbd_content_uom": "Milligrams",
"cbd_content_dose": null,
"cbd_content_dose_uom": null,
"thc_content": 0.2,
"thc_content_uom": "Milligrams",
"thc_content_dose": null,
"thc_content_dose_uom": null,
"volume": null,
"volume_uom": null,
"weight": 50,
"weight_uom": "Grams",
"quantity": 25,
"quantity_uom": "Each"
},
"serving_size": null,
"serving_num": null,
"supply_duration_days": 14,
"doses_number": null,
"lab_test_ref": "NotSubmitted",
"administration_method": "",
"brand": "KMP",
"description": "Class A paradigm atom purple concentrate",
"image": {"product": "https://www.greencheckverified.com/my_product_image.png",
"label": "https://www.greencheckverified.com/my_product_image.png",
"tracking_barcode": "https://www.greencheckverified.com/my_tracking_barcode_image.png",
"upc_barcode": "https://www.greencheckverified.com/my_upc_barcode_image.png",
"package": "https://www.greencheckverified.com/my_package_image.png"
},
"contains_seeds": false
}
}

Response samples

application/json

{"results": {"type": "object",
"data": {"license": {"license_number": "KMPL20200818",
"type": {"name": "Type 12"
}
},
"id": "f348f96bdc61b4db9cc9d2607f2cc86f4",
"name": "KMP Hikari",
"category": {"id": "e239e96ac61b4ca9bb9c2607f2cc86f4",
"type": "Concentrate",
"main_category": "Capsule (weight - each)",
"sub_category": ""
},
"characteristics": {"quantity_type": "Count Based",
"unit_of_measure": "Each",
"ingredients": ["paradigm atom concentrate"
],
"strain": {"id": "e239e96ac61b4ca9bb9c2607f2egghc86f4",
"name": "Purple atom Clouds"
},
"unit": {"cannabinoids": {"cbd_percent": 50,
"thc_percent": 50
},
"cbd_content": 0.2,
"cbd_content_uom": "Milligrams",
"cbd_content_dose": null,
"cbd_content_dose_uom": null,
"thc_content": 0.2,
"thc_content_uom": "Milligrams",
"thc_content_dose": null,
"thc_content_dose_uom": null,
"volume": null,
"volume_uom": null,
"weight": 50,
"weight_uom": "Grams",
"quantity": 25,
"quantity_uom": "Each"
},
"serving_size": null,
"serving_num": null,
"supply_duration_days": 14,
"doses_number": null,
"lab_test_ref": "NotSubmitted",
"administration_method": "",
"brand": "KMP",
"description": "Class A paradigm atom purple concentrate",
"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
},
"entity_state": [{"state": "active",
"date": "2021-04-24T20:29:19Z",
"reason": "product created",
"actioned_by": "admin@kmp.com"
},
{"state": "approved",
"date": "2021-04-24T20:29:19Z",
"reason": "product approved by metrc ca",
"actioned_by": "admin@kmp.com"
}
]
}
},
"warnings": [ ]
}

Retrieve product(s)

If the id path parameter is not provided in the request, the response will contain all the active products for the license_number provided.

SecurityApiKeyAuth and CustomAuth

Request

path Parameters

id required	string Reference (entity_ID) for the product. Example: a521f55de4394f4f99c282be687e63aa
state required	string Lower case ANSI standard 38:2009 USPS codes of the US state where licensee is operating. Enum: "ca" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"

query Parameters

license_number required	string Reference (entity_ID) for the license. This is the business license number issued by the state. Example: license_number=ABC-1234
limit	number Optional parameter that allows you to specify a number to limit the results in the response. Default limit is 100. Example: limit=100
offset	number Optional parameter that allows you to offset records if the max number for the filter exceeds the limit. Example: offset=0
entity_state	string Queryable entity states for strain. Enum: "active" "inactive" "approved" "used" "deleted"

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 .

string

Reference (entity_ID) for the product.

Example: 225903

name

string

Product name.

Example: "KMP Purple Clones"

object

id	string Reference (ID) for the product category.
type	string The type of the product category.
main_category	string The main category of the product.
sub_category	string or null The subcategory of the product.

object

quantity_type

string

Type of quantity.

Example: "CountBased"

unit_of_measure

string

Unit of measure.

Example: "Each"

ingredients

Array of strings

Ingredients in the product.

object

The strain of the product

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

object

	object Contains THC and CBD percentage values, the sum of both must be 100.
cbd_content	number or null <float> Quantity of the CBD content
cbd_content_uom	string or null Unit of measure for the CBD content
cbd_content_dose	number or null <float> Quantity of the CBD content in one dose
cbd_content_dose_uom	string or null Unit of measure for the CBD content in one dose
thc_content	number or null <float> Quantity of the THC content
thc_content_uom	string or null Unit of measure for the THC content
thc_content_dose	number or null <float> Quantity of the THC content in one dose
thc_content_dose_uom	string or null Unit of measure for the THC content in one dose
volume	number or null <float> Standard volume of the product's content
volume_uom	string or null Volume's unit of measure
weight	number or null <float> Standard weight of the product's content
weight_uom	string or null Weight's unit of measure
quantity	number or null <float> number of units in the product
quantity_uom	string or null Quantity's unit of measure

serving_size

number or null <float>

Product's quantity per one serving

serving_num

number or null <float>

Product's number of servings

supply_duration_days

number or null <float>

number of days the product should last

doses_number

number or null <float>

Standard number of doses that the product contains

lab_test_ref

string

Laboratory test approval reference

administration_method

string or null

Contains the information of how the product is administrated

brand

string

Product's brand

description

string

Longer description of the product

object

Object containing paths to product, package, and barcode images

product	string Url path to the product's image.
label	string Url path to the label's image.
tracking_barcode	string Url path to the image showing the barcode of the product's package.
upc_barcode	string Url path to the image showing the upc barcode of the product's package.
package	string Url path to the product's package image.

contains_seeds

boolean

true if product contains seeds.

Array of objects

A list of state changes made to the entity. Entity states for the product [active, inactive, approved, used, deleted].

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

Response samples

application/json

{"results": {"type": "object",
"records": {"count": "0 - 100",
"total": 437,
"previous": null,
"next": "https://integration-kmp.greencheckverified.com/co/v1/config/products?license_number=123-LIC&limit=100&offset=100"
},
"data": {"license": {"license_number": "KMPL20200818",
"type": {"name": "Type 12"
}
},
"id": "fg67e96ac61b4ca9bb9c2607f98f4",
"name": "KMP Hikari",
"category": {"id": "e239e96ac61b4ca9bb9c2607f2cc86f4",
"type": "Concentrate",
"main_category": "Capsule (weight - each)",
"sub_category": ""
},
"characteristics": {"quantity_type": "CountBased",
"unit_of_measure": "Each",
"ingredients": ["paradigm atom concentrate"
],
"strain": {"id": "e239e96ac61b4ca9bb9c2607f2egghc86f4",
"name": "Purple atom Clouds"
},
"unit": {"cannabinoids": {"cbd_percent": 50,
"thc_percent": 50
},
"cbd_content": 0.2,
"cbd_content_uom": "Milligrams",
"cbd_content_dose": null,
"cbd_content_dose_uom": null,
"thc_content": 0.2,
"thc_content_uom": "Milligrams",
"thc_content_dose": null,
"thc_content_dose_uom": null,
"volume": null,
"volume_uom": null,
"weight": 50,
"weight_uom": "Grams",
"quantity": 25,
"quantity_uom": "Each"
},
"serving_size": null,
"serving_num": null,
"supply_duration_days": 14,
"doses_number": null,
"lab_test_ref": "NotSubmitted",
"administration_method": "",
"brand": "KMP",
"description": "Class A paradigm atom purple concentrate",
"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
},
"entity_state": [{"state": "active",
"date": "2021-04-24T20:29:19Z",
"reason": "product created",
"actioned_by": "admin@kmp.com"
},
{"state": "approved",
"date": "2021-04-24T20:29:19Z",
"reason": "product approved by metrc ca",
"actioned_by": "admin@kmp.com"
}
]
}
},
"warnings": [ ]
}

Update product

Update the product registered under the license_number provided.

SecurityApiKeyAuth and CustomAuth

Request

path Parameters

id required	string Reference (entity_ID) for the product you are updating. Example: a521f55de4394f4f99c282be687e63aa
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

string

Product name.

Example: "KMP Purple Clones"

object

ingredients

Array of strings

Ingredients in the product.

object

The strain of the product

id	string Reference (entity_ID) for the strain.

object

Contains THC and CBD percentage values, the sum of both must be 100.

cbd_percent	number or null <float> the percent of cbd.
thc_percent	number or null <float> the percent of thc.

cbd_content

number or null <float>

Quantity of the CBD content

cbd_content_uom

string or null

Unit of measure for the CBD content

cbd_content_dose

number or null <float>

Quantity of the CBD content in one dose

cbd_content_dose_uom

string or null

Unit of measure for the CBD content in one dose

thc_content

number or null <float>

Quantity of the THC content

thc_content_uom

string or null

Unit of measure for the THC content

thc_content_dose

number or null <float>

Quantity of the THC content in one dose

thc_content_dose_uom

string or null

Unit of measure for the THC content in one dose

volume

number or null <float>

Standard volume of the product's content

volume_uom

string or null

Volume's unit of measure

weight

number or null <float>

Standard weight of the product's content

weight_uom

string or null

Weight's unit of measure

quantity

number or null <float>

number of units in the product

quantity_uom

string or null

Quantity's unit of measure

serving_size

number or null <float>

Product's quantity per one serving

serving_num

number or null <float>

Product's number of servings

supply_duration_days

number or null <float>

number of days the product should last

doses_number

number or null <float>

Standard number of doses that the product contains

lab_test_ref

string

Laboratory test approval reference

administration_method

string or null

Contains the information of how the product is administrated

brand

string

Product's brand

description

string

Longer description of the product

object

Object containing paths to product, package, and barcode images

product	string Url path to the product's image.
label	string Url path to the label's image.
tracking_barcode	string Url path to the image showing the barcode of the product's package.
upc_barcode	string Url path to the image showing the upc barcode of the product's package.
package	string Url path to the product's package image.

contains_seeds

boolean

true if product contains seeds.

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 .

string

Reference (entity_ID) for the product.

Example: 225903

name

string

Product name.

Example: "KMP Purple Clones"

object

id	string Reference (ID) for the product category.
type	string The type of the product category.
main_category	string The main category of the product.
sub_category	string or null The subcategory of the product.

object

quantity_type

string

Type of quantity.

Example: "CountBased"

unit_of_measure

string

Unit of measure.

Example: "Each"

ingredients

Array of strings

Ingredients in the product.

object

The strain of the product

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

object

	object Contains THC and CBD percentage values, the sum of both must be 100.
cbd_content	number or null <float> Quantity of the CBD content
cbd_content_uom	string or null Unit of measure for the CBD content
cbd_content_dose	number or null <float> Quantity of the CBD content in one dose
cbd_content_dose_uom	string or null Unit of measure for the CBD content in one dose
thc_content	number or null <float> Quantity of the THC content
thc_content_uom	string or null Unit of measure for the THC content
thc_content_dose	number or null <float> Quantity of the THC content in one dose
thc_content_dose_uom	string or null Unit of measure for the THC content in one dose
volume	number or null <float> Standard volume of the product's content
volume_uom	string or null Volume's unit of measure
weight	number or null <float> Standard weight of the product's content
weight_uom	string or null Weight's unit of measure
quantity	number or null <float> number of units in the product
quantity_uom	string or null Quantity's unit of measure

serving_size

number or null <float>

Product's quantity per one serving

serving_num

number or null <float>

Product's number of servings

supply_duration_days

number or null <float>

number of days the product should last

doses_number

number or null <float>

Standard number of doses that the product contains

lab_test_ref

string

Laboratory test approval reference

administration_method

string or null

Contains the information of how the product is administrated

brand

string

Product's brand

description

string

Longer description of the product

object

Object containing paths to product, package, and barcode images

product	string Url path to the product's image.
label	string Url path to the label's image.
tracking_barcode	string Url path to the image showing the barcode of the product's package.
upc_barcode	string Url path to the image showing the upc barcode of the product's package.
package	string Url path to the product's package image.

contains_seeds

boolean

true if product contains seeds.

Array of objects

A list of state changes made to the entity. Entity states for the product [active, inactive, approved, used, deleted].

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

Request samples

Payload

application/json

{"license": {"license_number": "KMP-20201027-TST"
},
"characteristics": {"unit": {"cannabinoids": {"cbd_percent": 25,
"thc_percent": 75
},
"cbd_content": 0.1,
"thc_content": 0.3
}
}
}

Response samples

application/json

{"results": {"type": "object",
"data": {"license": {"license_number": "KMPL20200818",
"type": {"name": "Type 12"
}
},
"id": "fg67e96ac61b4ca9bb9c2607f98f4",
"name": "KMP Hikari",
"category": {"id": "e239e96ac61b4ca9bb9c2607f2cc86f4",
"type": "Concentrate",
"main_category": "Capsule (weight - each)",
"sub_category": ""
},
"characteristics": {"quantity_type": "CountBased",
"unit_of_measure": "Each",
"ingredients": ["paradigm atom concentrate"
],
"strain": {"id": "e239e96ac61b4ca9bb9c2607f2egghc86f4",
"name": "Purple atom Clouds"
},
"unit": {"cannabinoids": {"cbd_percent": 25,
"thc_percent": 75
},
"cbd_content": 0.1,
"cbd_content_uom": "Milligrams",
"cbd_content_dose": null,
"cbd_content_dose_uom": null,
"thc_content": 0.3,
"thc_content_uom": "Milligrams",
"thc_content_dose": null,
"thc_content_dose_uom": null,
"volume": null,
"volume_uom": null,
"weight": 50,
"weight_uom": "Grams",
"quantity": 25,
"quantity_uom": "Each"
},
"serving_size": null,
"supply_duration_days": 14,
"doses_number": null,
"lab_test_ref": "NotSubmitted",
"administration_method": "",
"brand": "KMP",
"description": "Class A paradigm atom purple concentrate",
"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
},
"entity_state": [{"state": "active",
"date": "2021-04-24T20:29:19Z",
"reason": "product created",
"actioned_by": "admin@kmp.com"
},
{"state": "approved",
"date": "2021-04-24T20:29:19Z",
"reason": "product approved by metrc ca",
"actioned_by": "admin@kmp.com"
}
]
}
},
"warnings": [ ]
}

Delete product

Deactivate a product registered under the license_number provided.

SecurityApiKeyAuth and CustomAuth

Request

path Parameters

id required	string Reference (entity_ID) for the product you are deleting. Example: a521f55de4394f4f99c282be687e63aa
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.

Responses

200

Response Schema: application/json

object

type

string

Value: "object"

object

id	string Reference (entity_ID) for the product. Example: 225903
deleted	boolean True if the product was deleted successfully, otherwise false.

Array of objects

Array

type	string
detail	string

400

Bad Request

delete/{state}/v1/config/products/{id}

Request samples

Payload

application/json

{"license": {"license_number": "KMP-20201027-TST"
}
}

Response samples

application/json

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

Retrieve product categories

Retrieve a list of product categories

SecurityApiKeyAuth and CustomAuth

Request

path Parameters

state

required

string

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

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

query Parameters

license_number

required

string

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

Example: license_number=ABC-1234

header Parameters

x-api-key required	string Trace API key header Example: b123x21wbHlkYXBpa2V5
Authorization required	string Company and user credentials authentication Example: KMP-JSON token=dmVuZG9yLWFwaS1rZXk6dX12312sdfs2V5

Responses

200

Response Schema: application/json

object

type

string

Value: "array"

Array of objects

Array

string

Reference (ID) for the product category.

type

string

The type of the product category.

main_category

string

The main category of the product.

sub_category

string or null

The subcategory of the product.

object

quantity_type	string The 'quantity type' of the product category.
required_uom	boolean True if the 'unit of measure' is required for the product category specified, otherwise false.
required_ingredients	boolean True if the 'ingredients' are required for the product category specified, otherwise false.
required_strain_id	boolean True if the 'strain id' is required for the product category specified, otherwise false.
required_unit_cannabinoids	boolean True if the 'CBD and THC percentages' are required for the product category specified, otherwise false.
required_unit_cbd_content	boolean True if the 'CBD content level' is required for the product category specified, otherwise false.
required_unit_cbd_content_uom	boolean True if the 'CBD content unit of measure' is required for the product category specified, otherwise false.
required_unit_cbd_content_dose	boolean True if the 'CBD content dose' is required for the product category specified, otherwise false.
required_unit_cbd_content_dose_uom	boolean True if the 'CBD content dose unit of measure' is required for the product category specified, otherwise false.
required_unit_thc_content	boolean True if the 'THC content level' is required for the product category specified, otherwise false.
required_unit_thc_content_uom	boolean True if the 'THC content unit of measure' is required for the product category specified, otherwise false.
required_unit_thc_content_dose	boolean True if the 'THC content dose' is required for the product category specified, otherwise false.
required_unit_thc_content_dose_uom	boolean True if the 'THC content dose unit of measure' is required for the product category specified, otherwise false.
required_unit_volume	boolean True if the 'volume' is required for the product category specified, otherwise false.
required_unit_volume_uom	boolean True if the 'volume unit of measure' is required for the product category specified, otherwise false.
required_unit_weight	boolean True if the 'weight' is required for the product category specified, otherwise false.
required_unit_weight_uom	boolean True if the 'weight unit of measure' is required for the product category specified, otherwise false.
required_unit_quantity	boolean True if the 'unit quantity' is required for the product category specified, otherwise false.
required_unit_quantity_uom	boolean True if the measure of 'unit quantity' is required for the product category specified, otherwise false.
required_serving_size	boolean True if the 'serving size' is required for the product category specified, otherwise false.
required_serving_num	boolean True if the 'serving number' is required for the product category specified, otherwise false.
required_supply_duration_days	boolean True is the “supply duration days” is required for the product category specified, otherwise false.
required_doses_number	boolean True if the 'doses number' is required for the product category specified, otherwise false.
required_lab_test_ref	boolean True if the 'lab test reference' is required for the product category specified, otherwise false.
required_administration_method	boolean True if the 'volume' is required for the product category specified, otherwise false.
required_brand	boolean True if the 'product brand' is required for the product category specified, otherwise false.
required_description	boolean True if the 'product description' is required for the product category specified, otherwise false.
required_product_image	boolean True if a 'product image' is required for the product category specified, otherwise false.
required_package_image	boolean True if a 'package image' is required for hte product category specified, otherwise false.
required_label_image	boolean True if the 'label image' is required for the product category specified, otherwise false.
can_contain_seeds	boolean True if the product 'can contain seeds', otherwise false.
can_be_remediated	boolean True if the the product 'can be remediated' is required for the product category specified, otherwise false.

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/config/products/categories

Response samples

application/json

{"results": {"type": "array",
"data": [{"id": "123456",
"type": "Buds",
"main_category": "Flower",
"sub_category": null,
"characteristics": {"quantity_type": "WeightBased",
"required_uom": true,
"required_ingredients": false,
"required_strain_id": true,
"required_unit_cannabinoids": false,
"required_unit_cbd_content": false,
"required_unit_cbd_content_uom": false,
"required_unit_cbd_content_dose": false,
"required_unit_cbd_content_dose_uom": false,
"required_unit_thc_content": false,
"required_unit_thc_content_uom": false,
"required_unit_thc_content_dose": false,
"required_unit_thc_content_dose_uom": false,
"required_unit_volume": false,
"required_unit_volume_uom": false,
"required_unit_weight": false,
"required_unit_weight_uom": false,
"required_unit_quantity": true,
"required_unit_quantity_uom": true,
"required_serving_size": false,
"required_serving_num": false,
"required_supply_duration_days": false,
"required_doses_number": false,
"required_lab_test_ref": false,
"required_administration_method": false,
"required_brand": false,
"required_description": false,
"required_product_image": false,
"required_package_image": false,
"required_label_image": false,
"can_contain_seeds": false,
"can_be_remediated": true
}
},
{"id": "123457",
"type": "InfusedEdible",
"main_category": "Edible (volume - each)",
"sub_category": "",
"characteristics": {"quantity_type": "CountBased",
"required_uom": true,
"required_ingredients": false,
"required_strain_id": false,
"required_unit_cannabinoids": false,
"required_unit_cbd_content": false,
"required_unit_cbd_content_uom": false,
"required_unit_cbd_content_dose": false,
"required_unit_cbd_content_dose_uom": false,
"required_unit_thc_content": false,
"required_unit_thc_content_uom": false,
"required_unit_thc_content_dose": false,
"required_unit_thc_content_dose_uom": false,
"required_unit_volume": true,
"required_unit_volume_uom": true,
"required_unit_weight": false,
"required_unit_weight_uom": false,
"required_unit_quantity": false,
"required_unit_quantity_uom": false,
"required_serving_size": false,
"required_serving_num": false,
"required_supply_duration_days": false,
"required_doses_number": false,
"required_lab_test_ref": false,
"required_administration_method": false,
"required_brand": false,
"required_description": false,
"required_product_image": false,
"required_package_image": false,
"required_label_image": false,
"can_contain_seeds": false,
"can_be_remediated": false
}
}
]
},
"warnings": [ ]
}

➔ Next to Location