Waste

Create waste event

Create a waste event 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
license_number
string

Reference (entity_ID) for the license. This is the business license number issued by the state. The presence of the license number in the body is of informational nature, while it must be provided in the query parameters.

required
object

The create action being taken on the waste

id
required
string

Reference (entity_ID) for the waste action.

name
required
string

The display name of the waste.

required
object

The dates event dates of the creation of the waste. Hold dates are required in some states.

hold_start
string

Timestamp date of the hold start event. Required in some states.

hold_end
string

Timestamp date of the hold end event. Required in some states.

waste_start
required
string

Timestamp date of the waste start event.

waste_end
required
string

Timestamp date of the waste end event

Array of objects

The employee who created the waste.

Array
id
string

Reference (entity_id) for the employee that removed the waste.

required
Array of objects

The type of waste that was removed (e.g. Plant Material, Fibrous, Root Ball).

Array
id
string

The id of the waste type.

required
object

The reason for the waste as specified by the state.

id
required
string

Reference (entity_ID) for the waste reason.

note
string

Additional information related to the waste. May be optional or required based on the reason provided.

required
object

The waste method as specified by the state (e.g. Compost, Self-Hauler, or Waste-Hauler).

id
required
string

Reference (entity_ID) for the waste method.

weight
required
number <float>

The weight of the waste being removed.

unit_of_measure
required
string

The unit of measure for the weight of the waste.

required
object

List of plants, plant_batches, or harvests the waste was removed from (e.g. immature plant batch, flowering plant, harvest batch, etc.). One waste event must be from one origin type.

Array of objects
Array
id
string

ID of the source plant

barcode
string

Plant tag of the source plant.

Array of objects
Array
id
required
string

Reference (entity_ID) for the plant_batch.

barcode
required
string

barcode of the plant_batch.

Array of objects
Array
id
string

Reference (entity_ID) for the source harvest.

Array of objects

Other material the waste was mixed with.

Array
material
string

The material the waste was mixed with.

material_weight
number <float>

The weight of the material.

unit_of_measure
string

The unit of measure for the weight of the material.

date
string

The date the waste was removed.

Responses
200

OK

Response Schema: application/json
object
type
string
Value: "object"
object
object
license_number
string

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

object

License type of the company/facility.

name
string

The display name of the license type.

characteristics
object

Specific information related to the license type. The presence of the characteristics' object depends on the use of the expand query parameter .

object

Last action taken on the waste.

id
string

Reference (entity_id) for the waste action.

name
string

Display name of the wast action.

id
string

Reference (entity_ID) for the waste.

name
string

The display name of the waste.

barcode
string

A unique identifier required for specific states.

object

The dates event dates of the creation of the waste. Hold dates are required in some states.

hold_start
string

Timestamp date of the hold start event.

hold_end
string

Timestamp date of the hold end event

waste_start
string

Timestamp date of the waste start event.

waste_end
string

Timestamp date of the waste end event

object
id
string

reference (entity_id) for the employee.

object
first_name
string

employee first name

last_name
string

employee last name

email_address
string

employee email address

phone_number
string

employee phone number

Array of objects
Array
id
string

Reference (entity_ID) for the waste type

name
string

The display name of the type

object
id
string

Reference (entity_ID)for the waste reason.

name
string

The display name for the waste reason.

is_note_required
boolean

True if note is required when using this reason.

info
string

Additional information.

note
string

Additional information related to the waste. May be optional or required based on the reason provided.

object
id
string

Reference (entity_ID) for the waste method.

name
string

The display name of the method.

object
id
string

Reference (entity_ID) for the waste mixed_material.

name
string

name of the mixed_material.ß

quantity
number <float>

The quantity of mixed_material in the waste.

unit_of_measure
string

The unit_of_measure of the quantity.

object

The quantity & unit of measure of the waste.

quantity
number <integer>

The number of origin sources in the waste.

unit_of_measure
string

The unit of measure for the quantity of the counts.

object
object

Total weight of the waste.

quantity
number <float>

The weight of the waste.

unit_of_measure
string

Unit of measure for the quantity.

object

The waste's origin, either plant (mother plant), plant_batch, harvest, location, or lot.

Array of objects or null
Array
id
string

Reference (entity_ID) for the plant.

barcode
string

A unique identifier required for specific states.

name
string

The display name of the plant.

object
Array of objects or null
Array
id
string

Reference (entity_ID) for the plant_batch.

barcode
string

Barcode of the plant_batch.

name
string

Display name of the plant_batch.

quantity
integer

The quantity of immature plant_batches in the origin plant_batch.

unit_of_measure
string

The unit of measure used in the quantity.

Array of objects
Array
id
string

Reference (entity_ID) for the harvest

object

The quantities of the harvest used in the waste.

Array of objects or null
Array
id
string

Reference (entity_ID) for the location.

name
string

The name of the location.

quantity
number <float>

The quantity of material from the location in the waste.

unit_of_measure
string

Unit of measure for the quantity.

Array of objects or null
Array
id
string

Reference (entity_ID) of the source lot.

barcode
string

Barcode/tag of the source lot.

name
string

User friendly reference for the lot.

object

The type of the lot that is origin to the plant_batch.

object

The location of the waste.

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

Array of objects

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

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/waste
Request samples
application/json
{
  • "license": {
    },
  • "actions": {
    },
  • "name": "Tomino amuro kamui 05242022 waste 1",
  • "dates": {
    },
  • "employees": {
    },
  • "type": [
    ],
  • "reason": {
    },
  • "note": "too much pesticide was sprayed",
  • "method": {
    },
  • "mixed_material": [
    ],
  • "weights": null,
  • "origin": {
    },
  • "locations": {
    }
}
Response samples
application/json
{
  • "results": {
    },
  • "warnings": [ ]
}

Retrieve waste event(s) details

Retrieve the waste event details. If the id is not provided, the details of all the waste events for the license_number are obtained.

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

Waste 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
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
entity_state
string

Queryable entity states for additive. Inactive will return inactive and/or deleted additives.

Enum: "active" "inactive" "updated" "finished" "unfinished"
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

OK

Response Schema: application/json
object
type
string
Value: "object"
object
object
license_number
string

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

object

License type of the company/facility.

name
string

The display name of the license type.

characteristics
object

Specific information related to the license type. The presence of the characteristics' object depends on the use of the expand query parameter .

object

Last action taken on the waste.

id
string

Reference (entity_id) for the waste action.

name
string

Display name of the wast action.

id
string

Reference (entity_ID) for the waste.

name
string

The display name of the waste.

barcode
string

A unique identifier required for specific states.

object

The dates event dates of the creation of the waste. Hold dates are required in some states.

hold_start
string

Timestamp date of the hold start event.

hold_end
string

Timestamp date of the hold end event

waste_start
string

Timestamp date of the waste start event.

waste_end
string

Timestamp date of the waste end event

object
id
string

reference (entity_id) for the employee.

object
first_name
string

employee first name

last_name
string

employee last name

email_address
string

employee email address

phone_number
string

employee phone number

Array of objects
Array
id
string

Reference (entity_ID) for the waste type

name
string

The display name of the type

object
id
string

Reference (entity_ID)for the waste reason.

name
string

The display name for the waste reason.

is_note_required
boolean

True if note is required when using this reason.

info
string

Additional information.

note
string

Additional information related to the waste. May be optional or required based on the reason provided.

object
id
string

Reference (entity_ID) for the waste method.

name
string

The display name of the method.

object
id
string

Reference (entity_ID) for the waste mixed_material.

name
string

name of the mixed_material.ß

quantity
number <float>

The quantity of mixed_material in the waste.

unit_of_measure
string

The unit_of_measure of the quantity.

object

The quantity & unit of measure of the waste.

quantity
number <integer>

The number of origin sources in the waste.

unit_of_measure
string

The unit of measure for the quantity of the counts.

object
object

Total weight of the waste.

quantity
number <float>

The weight of the waste.

unit_of_measure
string

Unit of measure for the quantity.

object

The waste's origin, either plant (mother plant), plant_batch, harvest, location, or lot.

Array of objects or null
Array
id
string

Reference (entity_ID) for the plant.

barcode
string

A unique identifier required for specific states.

name
string

The display name of the plant.

object
Array of objects or null
Array
id
string

Reference (entity_ID) for the plant_batch.

barcode
string

Barcode of the plant_batch.

name
string

Display name of the plant_batch.

quantity
integer

The quantity of immature plant_batches in the origin plant_batch.

unit_of_measure
string

The unit of measure used in the quantity.

Array of objects
Array
id
string

Reference (entity_ID) for the harvest

object

The quantities of the harvest used in the waste.

Array of objects or null
Array
id
string

Reference (entity_ID) for the location.

name
string

The name of the location.

quantity
number <float>

The quantity of material from the location in the waste.

unit_of_measure
string

Unit of measure for the quantity.

Array of objects or null
Array
id
string

Reference (entity_ID) of the source lot.

barcode
string

Barcode/tag of the source lot.

name
string

User friendly reference for the lot.

object

The type of the lot that is origin to the plant_batch.

object

The location of the waste.

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

Array of objects

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

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/waste/{id}
Response samples
application/json
{
  • "results": {
    },
  • "warnings": [ ]
}

Update waste event

Update the details of a waste event 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

Waste 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
string

Reference (entity_ID) for the license. This is the business license number issued by the state. The presence of the license number in the body is of informational nature, while it must be provided in the query parameters.

required
object

Trace ID related to the move waste action.

id
string
move_date
required
string

Timestamp in ISO8601 UTC format representing the time the waste was physically moved.

required
object

Trace Location id for where the waste was placed.

id
string
Responses
200

OK

Response Schema: application/json
object
type
string
Value: "object"
object
object
license_number
string

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

object

License type of the company/facility.

name
string

The display name of the license type.

characteristics
object

Specific information related to the license type. The presence of the characteristics' object depends on the use of the expand query parameter .

object

Last action taken on the waste.

id
string

Reference (entity_id) for the waste action.

name
string

Display name of the wast action.

id
string

Reference (entity_ID) for the waste.

name
string

The display name of the waste.

barcode
string

A unique identifier required for specific states.

object

The dates event dates of the creation of the waste. Hold dates are required in some states.

hold_start
string

Timestamp date of the hold start event.

hold_end
string

Timestamp date of the hold end event

waste_start
string

Timestamp date of the waste start event.

waste_end
string

Timestamp date of the waste end event

object
id
string

reference (entity_id) for the employee.

object
first_name
string

employee first name

last_name
string

employee last name

email_address
string

employee email address

phone_number
string

employee phone number

Array of objects
Array
id
string

Reference (entity_ID) for the waste type

name
string

The display name of the type

object
id
string

Reference (entity_ID)for the waste reason.

name
string

The display name for the waste reason.

is_note_required
boolean

True if note is required when using this reason.

info
string

Additional information.

note
string

Additional information related to the waste. May be optional or required based on the reason provided.

object
id
string

Reference (entity_ID) for the waste method.

name
string

The display name of the method.

object
id
string

Reference (entity_ID) for the waste mixed_material.

name
string

name of the mixed_material.ß

quantity
number <float>

The quantity of mixed_material in the waste.

unit_of_measure
string

The unit_of_measure of the quantity.

object

The quantity & unit of measure of the waste.

quantity
number <integer>

The number of origin sources in the waste.

unit_of_measure
string

The unit of measure for the quantity of the counts.

object
object

Total weight of the waste.

quantity
number <float>

The weight of the waste.

unit_of_measure
string

Unit of measure for the quantity.

object

The waste's origin, either plant (mother plant), plant_batch, harvest, location, or lot.

Array of objects or null
Array
id
string

Reference (entity_ID) for the plant.

barcode
string

A unique identifier required for specific states.

name
string

The display name of the plant.

object
Array of objects or null
Array
id
string

Reference (entity_ID) for the plant_batch.

barcode
string

Barcode of the plant_batch.

name
string

Display name of the plant_batch.

quantity
integer

The quantity of immature plant_batches in the origin plant_batch.

unit_of_measure
string

The unit of measure used in the quantity.

Array of objects
Array
id
string

Reference (entity_ID) for the harvest

object

The quantities of the harvest used in the waste.

Array of objects or null
Array
id
string

Reference (entity_ID) for the location.

name
string

The name of the location.

quantity
number <float>

The quantity of material from the location in the waste.

unit_of_measure
string

Unit of measure for the quantity.

Array of objects or null
Array
id
string

Reference (entity_ID) of the source lot.

barcode
string

Barcode/tag of the source lot.

name
string

User friendly reference for the lot.

object

The type of the lot that is origin to the plant_batch.

object

The location of the waste.

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

Array of objects

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

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/waste/{id}
Request samples
application/json
{
  • "license": {
    },
  • "actions": {
    },
  • "move_date": "2022-07-16T20:29:19Z",
  • "locations": {
    }
}
Response samples
application/json
{
  • "results": {
    },
  • "warnings": [
    ]
}

Delete waste event

Deactivate a waste event 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

Waste 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
license_number
required
string

Reference (entity_ID) for the license. This is the business license number issued by the state. The presence of the license number in the body is of informational nature, while it must be provided in the query parameters.

Responses
200

OK

Response Schema: application/json
object
type
string
Value: "object"
object
id
string

Reference (entity_ID) for the waste event.

deleted
boolean

True if the waste event was deleted successfully, otherwise false.

Array of objects
Array
type
string
detail
string
400

Bad Request

delete/{state}/v1/waste/{id}
Request samples
application/json
{
  • "license_number": "KMIL1012345"
}
Response samples
application/json
{
  • "results": {
    },
  • "warnings": [ ]
}

Retrieve waste types

retrieve the waste types for a specific state

SecurityApiKeyAuth and CustomAuth
Request
path Parameters
state
required
string

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

Enum: "ca" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"
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

OK

Response Schema: application/json
object
type
string
Value: "array"
Array of objects
Array
id
string

Reference (entity_ID) for the waste type

name
string

The display name of the type

note
string

Additional information

Array of objects
Array
type
string
detail
string
400

Bad Request

get/{state}/v1/waste/types
Response samples
application/json
{
  • "results": {
    },
  • "warnings": [ ]
}

Retrieve waste reasons

retrieve the waste types for a specific state and license number

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

OK

Response Schema: application/json
object
type
string
Value: "array"
Array of objects
Array
id
string

Reference (entity_ID)for the waste reason.

name
string

The display name for the waste reason.

is_note_required
boolean

True if note is required when using this reason.

info
string

Additional information.

Array of objects
Array
type
string
detail
string
400

Bad Request

get/{state}/v1/waste/reasons
Response samples
application/json
{
  • "results": {
    },
  • "warnings": [ ]
}

Retrieve waste methods

retrieve the waste 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

OK

Response Schema: application/json
object
type
string
Value: "array"
Array of objects
Array
id
string

Reference (entity_ID) for the waste method.

name
string

The display name of the method.

Array of objects
Array
type
string
detail
string
400

Bad Request

get/{state}/v1/waste/methods
Response samples
application/json
{
  • "results": {
    },
  • "warnings": [ ]
}

Retrieve waste actions

Retrieve the waste actions for a specific state

SecurityApiKeyAuth and CustomAuth
Request
path Parameters
state
required
string

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

Enum: "ca" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"
header Parameters
x-api-key
required
string

Trace API key header

Example: b123x21wbHlkYXBpa2V5
Authorization
required
string

Company and user credentials authentication

Example: KMP-JSON token=dmVuZG9yLWFwaS1rZXk6dX12312sdfs2V5
Responses
200

OK

Response Schema: application/json
object
type
string
Value: "array"
Array of objects
Array
id
string

Reference (entity_ID) for the waste action.

name
string

The display name of the action.

note
string

Details of this action.

info
string

Additional information on this action.

Array of objects
Array
type
string
detail
string
400

Bad Request

get/{state}/v1/waste/actions
Response samples
application/json
{
  • "results": {
    },
  • "warnings": [ ]
}

Retrieve waste mixed_materials

retrieve the materials mixed with waste per 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

OK

Response Schema: application/json
object
type
string
Value: "array"
Array of objects
Array
id
string

Reference (entity_ID) for the waste mixed_material.

name
string

The display name of the mixed_material.

note
string

Additional information.

Array of objects
Array
type
string
detail
string
400

Bad Request

get/{state}/v1//waste/mixed_materials
Response samples
application/json
{
  • "results": {
    },
  • "warnings": [ ]
}