Additive

Create additive

Create an additive 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.

name

required

string

The name of the additive.

required

object

The type of the additive.

required

string

Reference (entity_ID) for the type of additive.

epa_number

string

The EPA registration number.

upc_code

integer

The UPC code of the additive.

lot_number

string

The lot number of the additive.

manufacturer

string

The manufacturer of the additive.

supplier

required

string

The supplier of the additive.

required

Array of objects

The active ingredients in the additive.

Array

chemical_component required	string The name of the active ingredient.
quantity required	number <float> The quantity of the ingredient in the additive added based on the unit of measure (e.g. uom == percentage and quantity == 30.0).
unit_of_measure required	string The unit of measure for the active ingredient.

unit_of_measure

required

string

The unit of measure used by the additive when adding to a plant.

is_used

boolean

True if the additive is in use by the licensee, otherwise false.

Responses

200

Response Schema: application/json

object

type	string Value: "object"
data	Array of arrays

Array of objects

Array

type	string
detail	string

400

Bad Request

post/{state}/v1/additives

Request samples

Payload

application/json

{"license": {"license_number": "KMP20200825"
},
"name": "Amuro additives fertilzers 05252023",
"type": {"id": "CAPAT0001"
},
"epa_number": "X12345E",
"upc_code": "UPC123456E",
"lot_number": "XCV1234567E",
"manufacturer": "Kodai Chemlife",
"supplier": "KMP Chem supplies inc",
"content": [{"chemical_component": "Phosphorous",
"quantity": 9.01,
"unit_of_measure": "percent"
},
{"chemical_component": "Nitrogen",
"quantity": 10.001,
"unit_of_measure": "percent"
},
{"chemical_component": "Potassium",
"quantity": 11.95,
"unit_of_measure": "percent"
}
],
"unit_of_measure": "Liters",
"is_used": false
}

Response samples

application/json

{"results": {"type": "object",
"data": {"license": {"license_number": "KMP20200825",
"type": {"name": "Type 12"
}
},
"id": "74fab062b1a248f7bfe08b103dd3960f",
"name": "Amuro additives fertilzers 05252023",
"type": {"id": "CAPAT0001",
"name": "fertilizer"
},
"epa_number": "X12345E",
"upc_code": "UPC123456E",
"lot_number": "XCV1234567E",
"manufacturer": "Kodai Chemlife",
"supplier": "KMP Chem supplies inc",
"content": [{"chemical_component": "Phosphorous",
"quantity": 9.01,
"unit_of_measure": "percent"
},
{"chemical_component": "Nitrogen",
"quantity": 10.001,
"unit_of_measure": "percent"
},
{"chemical_component": "Potassium",
"quantity": 11.95,
"unit_of_measure": "percent"
}
],
"unit_of_measure": "Liters",
"entity_state": [{"state": "active",
"date": "2022-07-07T23:50:22Z",
"reason": "additive created",
"actioned_by": "user credentials"
},
{"state": "updated",
"date": "2022-07-07T23:50:22Z",
"reason": "additive updated",
"actioned_by": "user credentials"
}
]
}
},
"warnings": [ ]
}

Retrieve additive(s) details

Retrieve the additive details. If the id is not provided, the details of all the additives 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 Additive 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 additive. Inactive will return inactive and/or deleted additives. Enum: "active" "inactive" "used" "deleted" "updated"

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"
data	Array of arrays

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/additives/{id}

Response samples

application/json

{"results": {"type": "object",
"data": {"license": {"license_number": "KMP20200825",
"type": {"name": "Type 12"
}
},
"id": "74fab062b1a248f7bfe08b103dd3960f",
"name": "Amuro additives fertilzers 05252023",
"type": {"id": "CAPAT0001",
"name": "fertilizer"
},
"epa_number": "X12345E",
"upc_code": "UPC123456E",
"lot_number": "XCV1234567E",
"manufacturer": "Kodai Chemlife",
"supplier": "KMP Chem supplies inc",
"content": [{"chemical_component": "Phosphorous",
"quantity": 9,
"unit_of_measure": "percent"
},
{"chemical_component": "Nitrogen",
"quantity": 10,
"unit_of_measure": "percent"
},
{"chemical_component": "Potassium",
"quantity": 11,
"unit_of_measure": "percent"
}
],
"unit_of_measure": "Liters",
"entity_state": [{"state": "active",
"date": "2022-07-07T23:50:22Z",
"reason": "additive created",
"actioned_by": "user credentials"
},
{"state": "updated",
"date": "2022-07-07T23:50:22Z",
"reason": "additive updated",
"actioned_by": "user credentials"
}
]
}
},
"warnings": [ ]
}

Update additive

Update the details of an additive 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 Additive 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

object

license_number

required

string

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

name

string

The name of the additive.

object

The type of the additive.

id	string Reference (entity_ID) for the type of additive.

epa_number

string

The EPA registration number.

upc_code

integer

The UPC code of the additive.

lot_number

string

The lot number of the additive.

manufacturer

string

The manufacturer of the additive.

supplier

string

The supplier of the additive.

Array of objects

The active ingredients in the additive.

Array

chemical_component	string The name of the active ingredient.
quantity	number <float> The quantity of the ingredient in the additive added based on the unit of measure (e.g. uom == percentage and quantity == 30.0).
unit_of_measure	string The unit of measure for the active ingredient.

unit_of_measure

string

The unit of measure used by the additive when adding to a plant.

is_used

boolean

True if the additive is in use by the licensee, otherwise false.

Responses

200

Response Schema: application/json

object

type	string Value: "object"
data	Array of arrays

Array of objects

Array

type	string
detail	string

400

Bad Request

put/{state}/v1/additives/{id}

Request samples

Payload

application/json

{"license_number": "KMP20200825",
"supplier": "MP Chemical supplies inc"
}

Response samples

application/json

{"results": {"type": "object",
"data": {"license": {"license_number": "KMP20200825",
"type": {"name": "Type 12"
}
},
"id": "74fab062b1a248f7bfe08b103dd3960f",
"name": "Amuro additives fertilzers 052520",
"type": {"id": "CAPAT0001",
"name": "fertilizer"
},
"epa_number": "X12345E",
"upc_code": "UPC123456E",
"lot_number": "XCV1234567E",
"manufacturer": "Kodai Chemlife",
"supplier": "KMP Chemical supplies inc",
"content": [{"chemical_component": "Phosphorous",
"quantity": 9,
"unit_of_measure": "percent"
},
{"chemical_component": "Nitrogen",
"quantity": 10,
"unit_of_measure": "percent"
},
{"chemical_component": "Potassium",
"quantity": 11,
"unit_of_measure": "percent"
}
],
"unit_of_measure": "Liters",
"entity_state": [{"state": "active",
"date": "2022-07-07T23:50:22Z",
"reason": "additive created",
"actioned_by": "user credentials"
},
{"state": "updated",
"date": "2022-07-07T23:50:22Z",
"reason": "additive updated",
"actioned_by": "user credentials"
}
]
}
},
"warnings": [ ]
}

Delete additive

Deactivate an additive 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 Additive 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

Response Schema: application/json

object

type

string

Value: "object"

object

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

Array of objects

Array

type	string
detail	string

400

Bad Request

delete/{state}/v1/additives/{id}

Request samples

Payload

application/json

{"license_number": "KMP20200825"
}

Response samples

application/json

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

Retrieve additives_types

retrieve the additives_types for a specific state

SecurityApiKeyAuth and CustomAuth

Request

path Parameters

state

required

string

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

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

header Parameters

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

Responses

200

Response Schema: application/json

object

type

string

Value: "array"

Array of objects

Array

Array of objects

Array

id	string Reference (entity_ID) for the plant additives_types
name	string name of the additives_types

Array of objects

Array

id	string Reference (entity_ID) for the plant additives_types unit of measure
name	string name of the additives_types unit of measure
volume	number <float> volume value for the additives_types unit or measure where applicable
weight	number or null <float> weight value for the additives_types unit or measure where applicable
uom	string unit of measure for the additives_types unit or measure volume or weight where applicable.

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/additives/types

Response samples

application/json

{"results": {"type": "array",
"data": [{"types": [{"id": "ILPAT0001",
"name": "nutrient"
},
{"id": "ILPAT0002",
"name": "pesticide"
},
{"id": "ILPAT0003",
"name": "custom_mix"
}
],
"units": [{"id": "1",
"name": "drops",
"volume": 0.05,
"weight": null,
"uom": "milliliters"
},
{"id": "2",
"name": "sprays",
"volume": 0.07,
"weight": null,
"uom": "milliliters"
}
]
}
]
},
"warnings": [ ]
}

➔ Next to Waste