Facility

Create a Facility

Create a facility. Facilities are related to a company as a physical resource.

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

name

required

string

Unique Facility name.

reference_id

required

string

Unique Reference ID from track and trace system.

identifier_code

required

string

Unique identifier code used by some states.

phone_number

required

string

15 character string to store phone number for the facility.

company_id

required

string

Trace Company id to associate the facility to.

timezone

required

string

Timezone facility is located in.

required

Array of objects

licenses belonging to the company

Array

license_number

required

object

License provided by the state that is associated with the facility.

address

required

object

Address of the facility

Responses

200

Response Schema: application/json

object

type

string

Value: "object"

object

string

Trace reference (entity_id) for the facility.

name

string

Facility name.

reference_id

string

Reference ID used in some states and assigned by the state or tracking system.

identifier_code

string

Identifier code used in some states and assigned by the state.

phone_number

string

Phone number for the Facility.

company_id

string

Trace reference for the Company that the facility is associated to.

timezone

string

Timezone for the Facility.

Array of objects

Array

license_number

string

License number associated with the Facility.

object

Address information for the Facility.

address_line_1	string First address line. Typically contains street address.
address_line_2	string Second address line. Typically contains suite and/or building number.
address_line_3	string Third address line. Not commonly used.
country	string Country the Facility resides in.
county	string The county that the Facility resides in.
city	string The city the Facility resides in.
state	string The state that the Facility resides in.
zip	string The zip code of the Facility.
gps	string The GPS coordinates of the Facility.

Array of objects

Array

type	string
detail	string

400

Bad Request

post/{state}/v1/config/facilities

Request samples

Payload

application/json

{"name": "OH Cultivation Facility",
"display_name": "OH CF",
"reference_id": 1234,
"identifier_code": 1234,
"phone_number": "123-456-7890",
"company_id": "3bca4bdef72849839fdf56e787a2ca40",
"timezone": "America/New_York",
"licenses": [{"license_number": "040-X0002"
}
],
"address": {"address_line_1": "123 farmlab st.",
"address_line_2": "Suite 100",
"address_line_3": null,
"country": "USA",
"county": "Cleveland",
"city": "Cleveland",
"state": "OH",
"zip": 54321,
"gps": "41.430329189481924, -81.75101155046161"
}
}

Response samples

application/json

{"results": {"type": "array",
"data": [{"id": "d01ba1a3db3643b09f9c497bb30d2529",
"reference_id": "0000000001234",
"name": "OH Cultivation Factory",
"display_name": "OH CF #1",
"identifier_code": "00000000001234",
"phone_number": "123-432-1234",
"timezone": "America/New_York",
"licenses": [{"license_number": "040-X0002"
}
],
"address": {"address_line_1": "123 farmlab st.",
"address_line_2": "Suite 100",
"address_line_3": null,
"country": "USA",
"county": "Cleveland",
"city": "Cleveland",
"state": "OH",
"zip": "54321",
"gps": "41.430329189481924, -81.75101155046161"
},
"entity_state": [{"state": "active",
"date": "2024-01-08T17:59:45Z",
"reason": "facility created",
"actioned_by": "system_generated"
},
{"state": "updated",
"date": "2024-01-08T17:59:45Z",
"reason": "facility updated",
"actioned_by": "system_generated"
}
]
}
]
},
"warnings": [ ]
}

Retrieve Facility List

Gets a list of Facilities associated to your api key.

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

entity_state

string

Queryable entity states for Facility.

Enum: "active" "inactive" "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: "array"

Array of objects

Array

string

Trace reference (entity_id) for the facility.

name

string

Facility name.

reference_id

string

Reference ID used in some states and assigned by the state or tracking system.

identifier_code

string

Identifier code used in some states and assigned by the state.

phone_number

string

Phone number for the Facility.

company_id

string

Trace reference for the Company that the facility is associated to.

timezone

string

Timezone for the Facility.

Array of objects

Array

license_number

string

License number associated with the Facility.

object

Address information for the Facility.

address_line_1	string First address line. Typically contains street address.
address_line_2	string Second address line. Typically contains suite and/or building number.
address_line_3	string Third address line. Not commonly used.
country	string Country the Facility resides in.
county	string The county that the Facility resides in.
city	string The city the Facility resides in.
state	string The state that the Facility resides in.
zip	string The zip code of the Facility.
gps	string The GPS coordinates of the Facility.

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/config/facilities

Response samples

application/json

{"results": {"type": "array",
"data": [{"id": "e1967c3bf9c84d7f828815f4814f5116",
"reference_id": "000000000123",
"name": null,
"display_name": null,
"identifier_code": "0000000000123",
"phone_number": "123-432-1234",
"timezone": "America/New_York",
"licenses": [{"license_number": "040-X0002"
}
],
"address": {"address_line_1": "123 farmlab st.",
"address_line_2": "Suite 100",
"address_line_3": null,
"country": "USA",
"county": "Cleveland",
"city": "Cleveland",
"state": "OH",
"zip": "54321",
"gps": null
},
"entity_state": [{"state": "active",
"date": "2024-01-05T15:27:39Z",
"reason": "facility created",
"actioned_by": "system_generated"
},
{"state": "updated",
"date": "2024-01-05T15:27:39Z",
"reason": "facility updated",
"actioned_by": "system_generated"
}
]
}
]
},
"warnings": [ ]
}

Retrieve Facility by {id}

Get the Facility details for the Facility {id} path parameter.

SecurityApiKeyAuth and CustomAuth

Request

path Parameters

id required	string Reference (entity_ID) for the Facility you are retrieving. Example: f6c3a86531294b0c83eacc1104a6a680
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: "object"

object

string

Trace reference (entity_id) for the facility.

name

string

Facility name.

reference_id

string

Reference ID used in some states and assigned by the state or tracking system.

identifier_code

string

Identifier code used in some states and assigned by the state.

phone_number

string

Phone number for the Facility.

company_id

string

Trace reference for the Company that the facility is associated to.

timezone

string

Timezone for the Facility.

Array of objects

Array

license_number

string

License number associated with the Facility.

object

Address information for the Facility.

address_line_1	string First address line. Typically contains street address.
address_line_2	string Second address line. Typically contains suite and/or building number.
address_line_3	string Third address line. Not commonly used.
country	string Country the Facility resides in.
county	string The county that the Facility resides in.
city	string The city the Facility resides in.
state	string The state that the Facility resides in.
zip	string The zip code of the Facility.
gps	string The GPS coordinates of the Facility.

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/config/facilities/{id}

Response samples

application/json

{"results": {"type": "object",
"data": {"id": "12345",
"reference_id": "WASTATE1.MM24R",
"name": "KMPL Manufacturing",
"display_name": "KMPL Mfg",
"identifier_code": "JALLCT1",
"phone_number": "408-123-4567",
"deleted": false,
"licenses": [{"license_number": "KMPL20200815",
"type": {"name": "M-Type 1"
},
"start_date": "2021-01-12T00:00:00Z",
"end_date": "2022-01-12T00:00:00Z"
}
],
"address": {"address_line_1": "577 Stoneybrook Road",
"address_line_2": "Suite 100",
"address_line_3": null,
"country": "USA",
"county": "Los Angeles",
"city": "WEST HOLLYWOOD",
"state": "CA",
"zip": "92069",
"gps": "37.33250383310398, -121.90493842065254"
},
"entity_state": [{"state": "active",
"date": "2021-01-12T05:27:39Z",
"reason": "facility added",
"actioned_by": "admin@kmp.com"
}
]
}
},
"warnings": [ ]
}

Update Facility

Update a Facility.

SecurityApiKeyAuth and CustomAuth

Request

path Parameters

id required	string reference (entity_ID) for the Facility you are updating. Example: 6ba36fba946d4de583b2f994f6297fd8
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

update_date	string The UTC datetime in which the values sent in were physically changed and put into effect.
reference_id	string New reference_id for the existing Facility.
identifier_code	string New identifier_code for the existing Facility.
phone_number	string New phone number for the existing Facility.

Responses

200

Response Schema: application/json

object

type

string

Value: "object"

object

string

Trace reference (entity_id) for the facility.

name

string

Facility name.

reference_id

string

Reference ID used in some states and assigned by the state or tracking system.

identifier_code

string

Identifier code used in some states and assigned by the state.

phone_number

string

Phone number for the Facility.

company_id

string

Trace reference for the Company that the facility is associated to.

timezone

string

Timezone for the Facility.

Array of objects

Array

license_number

string

License number associated with the Facility.

object

Address information for the Facility.

address_line_1	string First address line. Typically contains street address.
address_line_2	string Second address line. Typically contains suite and/or building number.
address_line_3	string Third address line. Not commonly used.
country	string Country the Facility resides in.
county	string The county that the Facility resides in.
city	string The city the Facility resides in.
state	string The state that the Facility resides in.
zip	string The zip code of the Facility.
gps	string The GPS coordinates of the Facility.

Array of objects

Array

type	string
detail	string

400

Bad Request

put/{state}/v1/config/facilities/{id}

Request samples

Payload

application/json

{"update_date": "2024-01-08T11:15:01Z",
"phone_number": "098-765-4321"
}

Response samples

application/json

{"results": {"type": "object",
"data": {"id": "d01ba1a3db3643b09f9c497bb30d2529",
"reference_id": "0000000001234",
"name": "OH Cultivation Factory",
"display_name": "OH CF #1",
"identifier_code": "00000000001234",
"phone_number": "098-765-4321",
"timezone": "America/New_York",
"licenses": [{"license_number": "040-X0002"
}
],
"address": {"address_line_1": "123 farmlab st.",
"address_line_2": "Suite 100",
"address_line_3": null,
"country": "USA",
"county": "Cleveland",
"city": "Cleveland",
"state": "OH",
"zip": "54321",
"gps": null
},
"entity_state": [{"state": "active",
"date": "2024-01-08T17:59:45Z",
"reason": "facility created",
"actioned_by": "system_generated"
},
{"state": "updated",
"date": "2024-01-08T18:36:50Z",
"reason": "facility updated",
"actioned_by": "system_generated"
},
{"state": "field_updates",
"date": "2024-01-08T11:15:01Z",
"reason": "phone_number updated",
"actioned_by": "system_generated"
}
]
}
},
"warnings": [ ]
}

Delete facility

Delete a Facility.

SecurityApiKeyAuth and CustomAuth

Request

path Parameters

id required	string Reference (entity_ID) for the facility you are deleting. Example: 6ba36fba946d4de583b2f994f6297fd8
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: "object"

object

Trace

id	string Reference (entity_ID) for the Facility.
deleted	boolean True if the Facility was deleted successfully, otherwise false.

Array of objects

Array

type	string
detail	string

400

Bad Request

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

Response samples

application/json

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

➔ Next to Employee