Transfer

Create transfer

Create a transfer 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 of the shipping facility. This is the business license number issued by the state.

name

string

master transfer name. describes the manifests contained within this transfer

object

totals of all shipments contained within this transfer

shipment_count	integer totals of all shipments contained within this transfer
gross_weight	number <float> total gross weight of shipments contained within this transfer.
gross_weight_uom	string unit of measure for the total gross weight

object

master manifest contains summary of all shipment manifests

number

string

unique master manifest number.

created_timestamp

string

created time stamp in ISO 8601 UTC format.

object

The name of the user who created the manifest.

required

object

details for the employee.

required

string

reference (entity_id) for the employee.

required

object

originator of the transfer.

required

object

required

string

reference (entity_id) for the facility associated with the license_number

required

object

employee contact for the facility.

required

object

details for the employee.

required

string

reference (entity_id) for the employee.

required

Array of objects

Array containing information pertaining to the individual shipments in the transfer.

Array

name

string

transfer name. describes the manifest contained within this shipment

required

object

characteristics of this transfer

id required	string Reference (entity_ID) for the transfer type.
type required	string indicates the specific type of transporter possible values are : "standard", "pick_up", "order", "third_party", "return"
license_type	string used to identify if the transfer is a licensed transfer.

required

Array of objects

describes the contents of the lots in the transfers

Array

id required	string reference (entity_id) of the contents description.
name	string description of the contents

required

object

manifest associated with the transfers

number

string

unique number for the manifest.

created_timestamp

required

string

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

required

object

identifies employee who created the transfer / manifest

required

object

details for the employee.

required

object

totals of shipment contained within this specific transfer

object

totals shipments and lots counts for this transfer

count required	integer total count of shipments contained within this transfer
lot_count required	integer total number of lots shipped within this transfer
received_lot_count	integer
gross_weight	number <float> gross weight of shipments contained within this transfer as required by specific states
gross_weight_uom	string unit of measure for the gross weight as required by specific states

stop_num

required

integer

stop number out of multiple stops if applicable

route_detail

required

string

description of route followed from origin to destination by transporter

estimated_departure_timestamp

required

string

estimated departure time stamp in ISO 8601 UTC format.

estimated_arrival_timestamp

required

string

estimated arrival time stamp in ISO 8601 UTC format.

required

object

receiver of the transfer

required

object

required

string

reference (entity_id) for the facility associated with the license_number

object

location where the transfer will be received

required

string

reference (entity_id) for the location

object

employee contact for the facility

required

object

details for the employee.

required

Array of objects

array of lots and characteristics contained in this transfer.

Array

price_per_lot	number <float> wholesale price of lot Note: required for outbound transfers
usage	string indicates if lots contents intended for adult or medical use
return_reason	string reason for lot rejection or return Note: required for return transfers
return_refund_amount	number <float> refund price for returned lot Note: required for return transfers
required	object lot contained within transfer

required

object

transfer transporter

object

required

string

reference (entity_id) for the facility associated with the license_number

object

employee contact for the facility.

required

object

details for the employee.

required

string

reference (entity_id) for the employee.

required

object

totals of shipment contained within this specific transfer

shipment_count required	integer shipment count total for this transfer for this transporter
lot_count required	integer total lot count for this transfer for this transporter
received_lot_count	integer
gross_weight	number <float> total gross weight for this transfer for this transporter
gross_weight_uom	string unit of measure for the gross weight

route_detail

required

string

description of complete route followed from origin to destination for each shipment by transporter

required

object

characteristics of layover if present for the transfer

is_layover required	boolean true if this transfer contains a layover
estimated_start_timestamp required	string estimated start time stamp in ISO 8601 UTC format
estimated_end_timestamp required	string estimated end time stamp in ISO 8601 UTC format

required

object

driver details for the transporter.

required

object

details for the employee (driver)

required

string

reference (entity_id) for the employee.

object

vehicle used for the transfers

required

string

reference (entity_id) for the employee.

Responses

200

Response Schema: application/json

object

type

string

Value: "object"

object

string

Reference (entity_ID) for the master id for all contained transfers

name

string

master transfer name. describes the manifests contained within this transfer

object

totals of all shipments contained within this transfer

shipment_count	integer total count of shipments contained within this transfer
gross_weight	number <float> total gross weight of shipments contained within this transfer
gross_weight_uom	string unit of measure for the total gross weight

object

master manifest contains summary of all transfer manifests

number

string

unique master manifest number.

created_timestamp

string

created time stamp in ISO 8601 UTC format.

object

user who created the master manifest.

object

updated_timestamp

string

updated time stamp in ISO 8601 UTC format

object

user who updated the master manifest.

object

details for the employee.

update_number

integer

total update counts to master manifest

is_void

boolean

true if the master manifest is void, otherwise false

Array of objects

applicable actions for transfer update operation

Array

id	string Reference (entity_ID) for the action
name	string name of transfer update action

object

originator of the transfer

object

id	string reference (entity_id) for the facility associated with the license_number
name	string name of the facility
phone_number	string phone number of the facility
	object
	object Address of the facility

object

employee contact for the facility.

object

details for the employee.

Array of objects

Array containing information pertaining to the individual shipments in the transfer.

Array

id	string reference (entity_id) for the transfer
name	string describes the transfer contained within this shipment
shipment_id	string shipment identifier as required by specific states
	object characteristics of this transfer
	Array of objects describes the contents of the lots in the transfers
	object manifest associated with the specific transfers
	object totals shipped and received for this transfer
stop_num	integer stop number out of multiple stops if applicable
route_detail	string description of route followed from origin to destination by transporter
estimated_departure_timestamp	string estimated departure time stamp in ISO 8601 UTC format.
departure_timestamp	string departure time stamp in ISO 8601 UTC format.
estimated_arrival_timestamp	string estimated arrival time stamp in ISO 8601 UTC format.
arrival_timestamp	string arrival time stamp in ISO 8601 UTC format.
received_timestamp	string time stamp shipment received in ISO 8601 UTC format
	object receiver of the transfer
	Array of objects array of lots and characteristics contained in this transfer

object

transfer transporter.

object

id	string reference (entity_id) for the facility associated with the license_number
name	string name of the facility
phone_number	string phone number of the facility
	object
	object Address of the facility

object

employee contact for the facility.

object

details for the employee.

object

totals of all shipments transported for this transfer

shipment_count	integer shipment count total for this transfer for this transporter
lot_count	integer total lot count for this transfer for this transporter
received_lot_count	integer
gross_weight	number <float> total gross weight for this transfer for this transporter
gross_weight_uom	string unit of measure for the gross weight

route_detail

string

description of complete route followed from origin to destination for each transfer by transporter

object

characteristics of layover if present for the transfer

is_layover	boolean true if this transfer contains a layover, otherwise false
estimated_start_timestamp	string estimated start time stamp in ISO 8601 UTC format
start_timestamp	string start time stamp in ISO 8601 UTC format
estimated_end_timestamp	string estimated end time stamp in ISO 8601 UTC format
end_timestamp	string end time stamp in ISO 8601 UTC format

object

driver details for the transporter

object

details for the employee.

object

vehicle used for the transfer

id	string reference (entity_id) for the vehicle.
reference_id	string unique reference (entity_id) provided by track and trace systems
color	string The color of the vehicle.
make	string The make of the vehicle.
model	string The model of the vehicle.
plate_number	string The plate_number of the vehicle.
license_plate_issuing_state	string The state that issued the license plate.
vin	string The vin number of the vehicle.
year	string The model year of the vehicle.

Array of objects

list of state changes made to the entity. Entity states applicable [active, updated, inactive, shipped, delivered, ready_for_pickup, picked_up, in_transit, received, rejected, partial_rejected, accepted, returned, partial_returned, deleted, void]

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

Request samples

Payload

application/json

{"license": {"license_number": "KMP20222825"
},
"name": "Trace transfers 2199",
"totals": {"shipment_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
},
"master_manifest": {"number": "da7f7fe3bcbc4aa09cb67140012f8bf9",
"created_timestamp": "2021-09-04T09:05:00Z",
"created_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529"
}
}
},
"shipper": {"facilities": {"id": "da7f7fe3bcbc4aa09cb67140012f8bf9"
},
"contacts": {"employees": {"id": "5c79343945ac422abff5dda971fdf529"
}
}
},
"transfers": [{"name": "Trace transfer shipment Z1 processor to processor",
"transfer_type": {"id": "CAKOMTT0004",
"type": "standard",
"license_type": "licensed"
},
"contents": [{"id": "KOMTC0003"
}
],
"manifest": {"created_timestamp": "2021-09-03T08:00:00Z",
"created_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529"
}
}
},
"totals": {"shipped": {"count": 1,
"lot_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
}
},
"stop_num": 1,
"route_detail": "Scott street to El Camino Real to Kiely to arrive at destination",
"estimated_departure_timestamp": "2021-09-04T09:00:00Z",
"estimated_arrival_timestamp": "2021-09-04T10:00:00Z",
"receiver": {"facilities": {"id": "da7f7fe3bcbc4aa09cb345678f8bf9"
},
"locations": {"id": "da7f7fe3bcbc4aa09cb345678f8bf9"
},
"contacts": {"employees": {"id": "5c79343945ac422abff5dda971fdf529"
}
}
},
"lots": [{"price_per_lot": 20,
"usage": "",
"return_reason": "",
"return_refund_amount": 0,
"lot": {"id": "fg67e96ac61b4ca9bb9c2607f98f4"
}
}
]
}
],
"transporter": {"facilities": {"id": "da7f7fe3bcbc4abnm4575678f8bf9"
},
"contacts": {"employees": {"id": "5c79343945ac422abff5dda971fdf529"
}
},
"totals": {"shipment_count": 1,
"lot_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
},
"route_detail": "Scott street to El Camino Real to Kiely to arrive at destination",
"layover": {"is_layover": false,
"estimated_start_timestamp": "",
"estimated_end_timestamp": ""
},
"driver": {"employees": {"id": "5c79343945ac422abff5dda971fdf529"
}
},
"vehicles": {"id": "2ab28247836d437888ea4e780e3379e4"
}
}
}

Response samples

application/json

{"results": {"type": "object",
"data": {"id": "da7f7fe3bcbc4aa09cb67140012f567",
"name": "Trace transfers 2199",
"totals": {"shipment_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
},
"master_manifest": {"number": "KOMMT123456789",
"created_timestamp": "2021-09-04T10:00:00Z",
"created_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567"
}
},
"updated_timestamp": "2021-09-04T10:00:00Z",
"updated_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567"
}
},
"update_number": 1,
"is_void": false
},
"action": [{"id": "ILTUOP0002",
"name": "receive inbound transfer"
}
],
"shipper": {"facilities": {"id": "da7f7fe3bcbc4aa09cb67140012f8bf9",
"name": "Tetsuro processing",
"phone_number": "408-123-4567",
"license": {"license_number": "KMP20222825",
"type": {"name": "Type 12"
}
},
"address": {"address_line_1": "977 The Alameda",
"address_line_2": "Suite 100",
"address_line_3": "",
"country": "USA",
"county": "Santa Clara",
"city": "San Jose",
"state": "CA",
"zip": "95126",
"gps": "37.33250383310398, -121.90493842065254"
}
},
"contacts": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567"
}
}
},
"transfers": [{"id": "KMPSTID10001",
"name": "Trace transfer shipment Z1 processor to processor",
"shipment_id": "KMPTS1001",
"transfer_type": {"id": "CAKOMTT0004",
"name": "transfer",
"type": "standard",
"license_type": "licensed"
},
"contents": [{"id": "KOMTC0003",
"name": "test_sample"
}
],
"manifest": {"number": "1000056892314",
"created_timestamp": "2021-09-03T08:00:00Z",
"created_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567"
}
},
"updated_timestamp": "2021-09-03T09:00:00Z",
"updated_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.comerified.com",
"phone_number": "408-123-4567"
}
},
"update_number": 1,
"is_void": false
},
"totals": {"shipped": {"count": 1,
"lot_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
},
"received": {"count": 1,
"lot_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
}
},
"stop_num": 1,
"route_detail": "Scott street to El Camino Real to Kiely to arrive at destination",
"estimated_departure_timestamp": "2021-09-04T09:00:00Z",
"departure_timestamp": "2021-09-04T09:05:00Z",
"estimated_arrival_timestamp": "2021-09-04T10:00:00Z",
"arrival_timestamp": "2021-09-04T10:10:00Z",
"received_timestamp": "2021-09-04T10:30:00Z",
"receiver": {"facilities": {"id": "da7f7fe3bcbc4aa09cb345678f8bf9",
"name": "Materu Solvent Extraction",
"phone_number": "408-123-4567",
"license": {"license_number": "CDPH-0000003",
"type": {"name": "Type 6"
}
},
"address": {"address_line_1": "977 The Alameda",
"address_line_2": "Suite 200",
"address_line_3": "",
"country": "USA",
"county": "Santa Clara",
"city": "San Jose",
"state": "CA",
"zip": "95126",
"gps": "37.33250383310398, -121.90493842065254"
}
},
"locations": {"id": "da7f7fe3bcbc4aa09cb345678f8bf9",
"name": "Harlock receiving"
},
"contacts": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Amuro",
"last_name": "Rey"
},
"email_address": "arey@greencheckverified.com",
"phone_number": "408-123-4567"
}
}
},
"lots": [{"price_per_lot": 20,
"usage": "for_extraction",
"return_reason": "",
"return_refund_amount": 0,
"lot": {"id": "fg67e96ac61b4ca9bb9c2607f98f4",
"name": "Kodai 01 extract intermediate Lot 1",
"barcode": "1KMBV1200000000046"
}
}
]
}
],
"transporter": {"facilities": {"id": "da7f7fe3bcbc4abnm4575678f8bf9",
"name": "Xabungle Transport Tomino 1",
"phone_number": "408-123-4567",
"license": {"license_number": "008-0000010-LIC",
"type": {"name": "Type 8"
}
},
"address": {"address_line_1": "977 The Alameda",
"address_line_2": "Suite 300",
"address_line_3": "",
"country": "USA",
"county": "Santa Clara",
"city": "San Jose",
"state": "CA",
"zip": "95126",
"gps": "37.33250383310398, -121.90493842065254"
}
},
"contacts": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Jiron",
"last_name": "Amos"
},
"email_address": "jamos@xabungle.com",
"phone_number": "408-123-4567"
}
},
"totals": {"shipment_count": 1,
"lot_count": 1,
"received_lot_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
},
"route_detail": "Scott street to El Camino Real to Kiely to arrive at destination",
"layover": {"is_layover": false,
"estimated_start_timestamp": "",
"start_timestamp": "",
"estimated_end_timestamp": "",
"end_timestamp": ""
},
"driver": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Jiron",
"last_name": "Amos"
},
"email_address": "jamos@xabungle.com",
"phone_number": "408-123-4567",
"occupational_licenses": [{"type": "drivers_license",
"number": "CADL12345678",
"issuing_state": "CA"
},
{"type": "occupational",
"number": "CADL12345678",
"issuing_state": "CA"
}
],
"birthday": "2000-01-03T00:00:00Z"
}
},
"vehicles": {"id": "2ab28247836d437888ea4e780e3379e4",
"reference_id": "DMD0001",
"color": "Stainless Steel",
"make": "DeLorean",
"model": "DMC1",
"plate_number": "JP123456ABC",
"license_plate_issuing_state": "CA",
"vin": "dmc1234RTGY67890",
"year": "1983"
}
},
"entity_state": [{"state": "active",
"date": "2021-09-21T20:29:19Z",
"reason": "transfer created",
"actioned_by": "kodai@kmp.com"
},
{"state": "updated",
"date": "2021-09-22T20:29:19Z",
"reason": "transfer updated",
"actioned_by": "kodai@kmp.com"
},
{"state": "shipped",
"date": "2021-09-22T20:29:19Z",
"reason": "transfer shipped",
"actioned_by": "kodai@kmp.com"
}
]
}
},
"warnings": [ ]
}

Retrieve transfer(s) details

Retrieve the transfer details for a specific direction. If the id is not provided, the details of all active transfers for the license_number are returned

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 Transfer 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
type	string The type of the transfer. Enum: "transfer" "return" "wholesale" "external"
direction required	string The direction of the transfer Enum: "inbound" "outbound"
expand	string The expand query parameter is used to include additional information for the lots response Value: "lots"
entity_state	string Queryable entity states for transfers Enum: "active" "updated" "inactive" "shipped" "delivered" "ready_for_pickup" "picked_up" "in_transit" "received" "rejected" "partial_rejected" "accepted" "returned" "partial_returned" "deleted" "void"
transfer_id	string Identifier provided by the track and trace system i.e manifest number that can be used to filter to a specific transfer. Example: transfer_id=123456ABC

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

string

Reference (entity_ID) for the master id for all contained transfers

name

string

master transfer name. describes the manifests contained within this transfer

object

totals of all shipments contained within this transfer

shipment_count	integer total count of shipments contained within this transfer
gross_weight	number <float> total gross weight of shipments contained within this transfer
gross_weight_uom	string unit of measure for the total gross weight

object

master manifest contains summary of all transfer manifests

number

string

unique master manifest number.

created_timestamp

string

created time stamp in ISO 8601 UTC format.

object

user who created the master manifest.

object

updated_timestamp

string

updated time stamp in ISO 8601 UTC format

object

user who updated the master manifest.

object

details for the employee.

update_number

integer

total update counts to master manifest

is_void

boolean

true if the master manifest is void, otherwise false

Array of objects

applicable actions for transfer update operation

Array

id	string Reference (entity_ID) for the action
name	string name of transfer update action

object

originator of the transfer

object

id	string reference (entity_id) for the facility associated with the license_number
name	string name of the facility
phone_number	string phone number of the facility
	object
	object Address of the facility

object

employee contact for the facility.

object

details for the employee.

Array of objects

Array containing information pertaining to the individual shipments in the transfer.

Array

id	string reference (entity_id) for the transfer
name	string describes the transfer contained within this shipment
shipment_id	string shipment identifier as required by specific states
	object characteristics of this transfer
	Array of objects describes the contents of the lots in the transfers
	object manifest associated with the specific transfers
	object totals shipped and received for this transfer
stop_num	integer stop number out of multiple stops if applicable
route_detail	string description of route followed from origin to destination by transporter
estimated_departure_timestamp	string estimated departure time stamp in ISO 8601 UTC format.
departure_timestamp	string departure time stamp in ISO 8601 UTC format.
estimated_arrival_timestamp	string estimated arrival time stamp in ISO 8601 UTC format.
arrival_timestamp	string arrival time stamp in ISO 8601 UTC format.
received_timestamp	string time stamp shipment received in ISO 8601 UTC format
	object receiver of the transfer
	Array of objects array of lots and characteristics contained in this transfer

object

transfer transporter.

object

id	string reference (entity_id) for the facility associated with the license_number
name	string name of the facility
phone_number	string phone number of the facility
	object
	object Address of the facility

object

employee contact for the facility.

object

details for the employee.

object

totals of all shipments transported for this transfer

shipment_count	integer shipment count total for this transfer for this transporter
lot_count	integer total lot count for this transfer for this transporter
received_lot_count	integer
gross_weight	number <float> total gross weight for this transfer for this transporter
gross_weight_uom	string unit of measure for the gross weight

route_detail

string

description of complete route followed from origin to destination for each transfer by transporter

object

characteristics of layover if present for the transfer

is_layover	boolean true if this transfer contains a layover, otherwise false
estimated_start_timestamp	string estimated start time stamp in ISO 8601 UTC format
start_timestamp	string start time stamp in ISO 8601 UTC format
estimated_end_timestamp	string estimated end time stamp in ISO 8601 UTC format
end_timestamp	string end time stamp in ISO 8601 UTC format

object

driver details for the transporter

object

details for the employee.

object

vehicle used for the transfer

id	string reference (entity_id) for the vehicle.
reference_id	string unique reference (entity_id) provided by track and trace systems
color	string The color of the vehicle.
make	string The make of the vehicle.
model	string The model of the vehicle.
plate_number	string The plate_number of the vehicle.
license_plate_issuing_state	string The state that issued the license plate.
vin	string The vin number of the vehicle.
year	string The model year of the vehicle.

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

Response samples

application/json

{"results": {"type": "object",
"data": {"id": "da7f7fe3bcbc4aa09cb67140012f567",
"name": "Trace transfers 2199",
"totals": {"shipment_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
},
"master_manifest": {"number": "KOMMT123456789",
"created_timestamp": "2021-09-04T10:00:00Z",
"created_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567"
}
},
"updated_timestamp": "2021-09-04T10:00:00Z",
"updated_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567"
}
},
"update_number": 1,
"is_void": false
},
"action": [{"id": "ILTUOP0002",
"name": "receive inbound transfer"
}
],
"shipper": {"facilities": {"id": "da7f7fe3bcbc4aa09cb67140012f8bf9",
"name": "Tetsuro processing",
"phone_number": "408-123-4567",
"license": {"license_number": "KMP20222825",
"type": {"name": "Type 12"
}
},
"address": {"address_line_1": "977 The Alameda",
"address_line_2": "Suite 100",
"address_line_3": "",
"country": "USA",
"county": "Santa Clara",
"city": "San Jose",
"state": "CA",
"zip": "95126",
"gps": "37.33250383310398, -121.90493842065254"
}
},
"contacts": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567"
}
}
},
"transfers": [{"id": "KMPSTID10001",
"name": "Trace transfer shipment Z1 processor to processor",
"shipment_id": "KMPTS1001",
"transfer_type": {"id": "CAKOMTT0004",
"name": "transfer",
"type": "standard",
"license_type": "licensed"
},
"contents": [{"id": "KOMTC0003",
"name": "test_sample"
}
],
"manifest": {"number": "1000056892314",
"created_timestamp": "2021-09-03T08:00:00Z",
"created_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.comerified.com",
"phone_number": "408-123-4567"
}
},
"updated_timestamp": "2021-09-03T09:00:00Z",
"updated_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567"
}
},
"update_number": 1,
"is_void": false
},
"totals": {"shipped": {"count": 1,
"lot_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
},
"received": {"count": 1,
"lot_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
}
},
"stop_num": 1,
"route_detail": "Scott street to El Camino Real to Kiely to arrive at destination",
"estimated_departure_timestamp": "2021-09-04T09:00:00Z",
"departure_timestamp": "2021-09-04T09:05:00Z",
"estimated_arrival_timestamp": "2021-09-04T10:00:00Z",
"arrival_timestamp": "2021-09-04T10:10:00Z",
"received_timestamp": "2021-09-04T10:30:00Z",
"receiver": {"facilities": {"id": "da7f7fe3bcbc4aa09cb345678f8bf9",
"name": "Materu Solvent Extraction",
"phone_number": "408-123-4567",
"license": {"license_number": "CDPH-0000003",
"type": {"name": "Type 6"
}
},
"address": {"address_line_1": "977 The Alameda",
"address_line_2": "Suite 200",
"address_line_3": "",
"country": "USA",
"county": "Santa Clara",
"city": "San Jose",
"state": "CA",
"zip": "95126",
"gps": "37.33250383310398, -121.90493842065254"
}
},
"locations": {"id": "da7f7fe3bcbc4aa09cb345678f8bf9",
"name": "Harlock receiving"
},
"contacts": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Amuro",
"last_name": "Rey"
},
"email_address": "arey@greencheckverified.com",
"phone_number": "408-123-4567"
}
}
},
"lots": [{"price_per_lot": 20,
"usage": "for_extraction",
"return_reason": "",
"return_refund_amount": 0,
"lot": {"id": "fg67e96ac61b4ca9bb9c2607f98f4",
"name": "Kodai 01 extract intermediate Lot 1",
"barcode": "1KMBV1200000000046",
"main_category": "Flower"
}
}
]
}
],
"transporter": {"facilities": {"id": "da7f7fe3bcbc4abnm4575678f8bf9",
"name": "Xabungle Transport Tomino 1",
"phone_number": "408-123-4567",
"license": {"license_number": "008-0000010-LIC",
"type": {"name": "Type 8"
}
},
"address": {"address_line_1": "977 The Alameda",
"address_line_2": "Suite 300",
"address_line_3": "",
"country": "USA",
"county": "Santa Clara",
"city": "San Jose",
"state": "CA",
"zip": "95126",
"gps": "37.33250383310398, -121.90493842065254"
}
},
"contacts": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Jiron",
"last_name": "Amos"
},
"email_address": "jamos@xabungle.com",
"phone_number": "408-123-4567"
}
},
"totals": {"shipment_count": 1,
"lot_count": 1,
"received_lot_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
},
"route_detail": "Scott street to El Camino Real to Kiely to arrive at destination",
"layover": {"is_layover": false,
"estimated_start_timestamp": "",
"start_timestamp": "",
"estimated_end_timestamp": "",
"end_timestamp": ""
},
"driver": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Jiron",
"last_name": "Amos"
},
"email_address": "jamos@xabungle.com",
"phone_number": "408-123-4567",
"occupational_licenses": [{"type": "drivers_license",
"number": "CADL12345678",
"issuing_state": "CA"
},
{"type": "occupational",
"number": "CADL12345678",
"issuing_state": "CA"
}
],
"birthday": "2000-01-03T00:00:00Z"
}
},
"vehicles": {"id": "2ab28247836d437888ea4e780e3379e4",
"reference_id": "DMD0001",
"color": "Stainless Steel",
"make": "DeLorean",
"model": "DMC1",
"plate_number": "JP123456ABC",
"license_plate_issuing_state": "CA",
"vin": "dmc1234RTGY67890",
"year": "1983"
}
},
"entity_state": [{"state": "active",
"date": "2021-09-21T20:29:19Z",
"reason": "transfer created",
"actioned_by": "kodai@kmp.com"
},
{"state": "updated",
"date": "2021-09-22T20:29:19Z",
"reason": "transfer updated",
"actioned_by": "kodai@kmp.com"
},
{"state": "shipped",
"date": "2021-09-22T20:29:19Z",
"reason": "transfer shipped",
"actioned_by": "kodai@kmp.com"
}
]
}
},
"warnings": [ ]
}

Update transfer

Update a transfer for the license_number and {id} 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 Transfer 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 of the shipping facility. This is the business license number issued by the state.

name

string

master transfer name. describes the manifests contained within this transfer

object

totals of all shipments contained within this transfer

shipment_count	integer totals of all shipments contained within this transfer
gross_weight	number <float> total gross weight of shipments contained within this transfer.
gross_weight_uom	string unit of measure for the total gross weight

object

master manifest contains summary of all shipment manifests

number

string

unique master manifest number.

created_timestamp

string

created time stamp in ISO 8601 UTC format.

object

The name of the user who created the manifest.

required

object

details for the employee.

required

string

reference (entity_id) for the employee.

updated_timestamp

string

updated time stamp in ISO 8601 UTC format

object

employee who updated the master manifest

object

details for the employee.

required

string

reference (entity_id) for the employee.

update_number

integer

total update counts to master manifest

is_void

boolean

true if the master manifest is void, otherwise false

Array of objects

applicable actions for transfer update operation

Array

id	string Reference (entity_ID) for the action

Array of objects

Array containing information pertaining to the individual shipments in the transfer.

Array

name	string transfer name. describes the manifests contained within this shipment
departure_timestamp	string departure time stamp in ISO 8601 UTC format.
arrival_timestamp	string arrival time stamp in ISO 8601 UTC format.
received_timestamp	string time stamp shipment received in ISO 8601 UTC format

object

transfer transporter.

object

totals of shipment contained within this specific transfer

shipment_count	integer shipment count total for this transfer for this transporter
lot_count	integer total lot count for this transfer for this transporter
received_lot_count	integer
gross_weight	number <float> total gross weight for this transfer for this transporter
gross_weight_uom	string unit of measure for the gross weight

route_detail

string

description of complete route followed from origin to destination for each shipment by transporter

object

characteristics of layover if present for the transfer

start_timestamp	string start time stamp in ISO 8601 UTC format
end_timestamp	string end time stamp in ISO 8601 UTC format

Array of objects

list of state changes made to the entity. Entity states applicable [active, inactive, updated]

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

string

Reference (entity_ID) for the master id for all contained transfers

name

string

master transfer name. describes the manifests contained within this transfer

object

totals of all shipments contained within this transfer

shipment_count	integer total count of shipments contained within this transfer
gross_weight	number <float> total gross weight of shipments contained within this transfer
gross_weight_uom	string unit of measure for the total gross weight

object

master manifest contains summary of all transfer manifests

number

string

unique master manifest number.

created_timestamp

string

created time stamp in ISO 8601 UTC format.

object

user who created the master manifest.

object

updated_timestamp

string

updated time stamp in ISO 8601 UTC format

object

user who updated the master manifest.

object

details for the employee.

update_number

integer

total update counts to master manifest

is_void

boolean

true if the master manifest is void, otherwise false

Array of objects

applicable actions for transfer update operation

Array

id	string Reference (entity_ID) for the action
name	string name of transfer update action

object

originator of the transfer

object

id	string reference (entity_id) for the facility associated with the license_number
name	string name of the facility
phone_number	string phone number of the facility
	object
	object Address of the facility

object

employee contact for the facility.

object

details for the employee.

Array of objects

Array containing information pertaining to the individual shipments in the transfer.

Array

id	string reference (entity_id) for the transfer
name	string describes the transfer contained within this shipment
shipment_id	string shipment identifier as required by specific states
	object characteristics of this transfer
	Array of objects describes the contents of the lots in the transfers
	object manifest associated with the specific transfers
	object totals shipped and received for this transfer
stop_num	integer stop number out of multiple stops if applicable
route_detail	string description of route followed from origin to destination by transporter
estimated_departure_timestamp	string estimated departure time stamp in ISO 8601 UTC format.
departure_timestamp	string departure time stamp in ISO 8601 UTC format.
estimated_arrival_timestamp	string estimated arrival time stamp in ISO 8601 UTC format.
arrival_timestamp	string arrival time stamp in ISO 8601 UTC format.
received_timestamp	string time stamp shipment received in ISO 8601 UTC format
	object receiver of the transfer
	Array of objects array of lots and characteristics contained in this transfer

object

transfer transporter.

object

id	string reference (entity_id) for the facility associated with the license_number
name	string name of the facility
phone_number	string phone number of the facility
	object
	object Address of the facility

object

employee contact for the facility.

object

details for the employee.

object

totals of all shipments transported for this transfer

shipment_count	integer shipment count total for this transfer for this transporter
lot_count	integer total lot count for this transfer for this transporter
received_lot_count	integer
gross_weight	number <float> total gross weight for this transfer for this transporter
gross_weight_uom	string unit of measure for the gross weight

route_detail

string

description of complete route followed from origin to destination for each transfer by transporter

object

characteristics of layover if present for the transfer

is_layover	boolean true if this transfer contains a layover, otherwise false
estimated_start_timestamp	string estimated start time stamp in ISO 8601 UTC format
start_timestamp	string start time stamp in ISO 8601 UTC format
estimated_end_timestamp	string estimated end time stamp in ISO 8601 UTC format
end_timestamp	string end time stamp in ISO 8601 UTC format

object

driver details for the transporter

object

details for the employee.

object

vehicle used for the transfer

id	string reference (entity_id) for the vehicle.
reference_id	string unique reference (entity_id) provided by track and trace systems
color	string The color of the vehicle.
make	string The make of the vehicle.
model	string The model of the vehicle.
plate_number	string The plate_number of the vehicle.
license_plate_issuing_state	string The state that issued the license plate.
vin	string The vin number of the vehicle.
year	string The model year of the vehicle.

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

Request samples

Payload

application/json

{"action": [{"id": "ILTUOP0008"
}
],
"transfers": [{"arrival_timestamp": "2021-09-04T10:00:00Z",
"received_timestamp": "2021-09-10T10:00:00Z"
}
]
}

Response samples

application/json

{"results": {"type": "object",
"data": {"id": "da7f7fe3bcbc4aa09cb67140012f567",
"name": "Trace transfers 2199",
"totals": {"shipment_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
},
"master_manifest": {"number": "KOMMT123456789",
"created_timestamp": "2021-09-04T10:00:00Z",
"created_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567"
}
},
"updated_timestamp": "2021-09-04T10:00:00Z",
"updated_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567"
}
}
},
"action": [{"id": "ILTUOP0002",
"name": "receive inbound transfer"
}
],
"shipper": {"facilities": {"id": "da7f7fe3bcbc4aa09cb67140012f8bf9",
"name": "Tetsuro processing",
"phone_number": "408-123-4567",
"license": {"license_number": "KMP20222825",
"type": {"name": "Type 12"
}
},
"address": {"address_line_1": "977 The Alameda",
"address_line_2": "Suite 100",
"address_line_3": "",
"country": "USA",
"county": "Santa Clara",
"city": "San Jose",
"state": "CA",
"zip": "95126",
"gps": "37.33250383310398, -121.90493842065254"
}
},
"contacts": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.comerified.comerified.comerified.comerified.com",
"phone_number": "408-123-4567"
}
}
},
"transfers": [{"id": "KMPSTID10001",
"name": "Trace transfer shipment Z1 processor to processor",
"shipment_id": "KMPTS1001",
"transfer_type": {"id": "CAKOMTT0004",
"name": "transfer",
"type": "standard",
"license_type": "licensed"
},
"contents": [{"id": "KOMTC0003",
"name": "test_sample"
}
],
"manifest": {"number": "1000056892314",
"created_timestamp": "2021-09-03T08:00:00Z",
"created_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567"
}
},
"updated_timestamp": "2021-09-03T09:00:00Z",
"updated_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.comerified.com",
"phone_number": "408-123-4567"
}
},
"update_number": 1,
"is_void": false
},
"totals": {"shipped": {"count": 1,
"lot_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
},
"received": {"count": 1,
"lot_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
}
},
"stop_num": 1,
"route_detail": "Scott street to El Camino Real to Kiely to arrive at destination",
"estimated_departure_timestamp": "2021-09-04T09:00:00Z",
"departure_timestamp": "2021-09-04T09:05:00Z",
"estimated_arrival_timestamp": "2021-09-04T10:00:00Z",
"arrival_timestamp": "2021-09-04T10:10:00Z",
"received_timestamp": "2021-09-04T10:30:00Z",
"receiver": {"facilities": {"id": "da7f7fe3bcbc4aa09cb345678f8bf9",
"name": "Materu Solvent Extraction",
"phone_number": "408-123-4567",
"license": {"license_number": "CDPH-0000003",
"type": {"name": "Type 6"
}
},
"address": {"address_line_1": "977 The Alameda",
"address_line_2": "Suite 200",
"address_line_3": "",
"country": "USA",
"county": "Santa Clara",
"city": "San Jose",
"state": "CA",
"zip": "95126",
"gps": "37.33250383310398, -121.90493842065254"
}
},
"locations": {"id": "da7f7fe3bcbc4aa09cb345678f8bf9",
"name": "Harlock receiving"
},
"contacts": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Amuro",
"last_name": "Rey"
},
"email_address": "arey@greencheckverified.com",
"phone_number": "408-123-4567"
}
}
},
"lots": [{"price_per_lot": 20,
"usage": "for_extraction",
"return_reason": "",
"return_refund_amount": 0,
"lot": {"id": "fg67e96ac61b4ca9bb9c2607f98f4"
}
}
]
}
],
"transporter": {"facilities": {"id": "da7f7fe3bcbc4abnm4575678f8bf9",
"name": "Xabungle Transport Tomino 1",
"phone_number": "408-123-4567",
"license": {"license_number": "KMP20222825",
"type": {"name": "Type 8"
}
},
"address": {"address_line_1": "977 The Alameda",
"address_line_2": "Suite 300",
"address_line_3": "",
"country": "USA",
"county": "Santa Clara",
"city": "San Jose",
"state": "CA",
"zip": "95126",
"gps": "37.33250383310398, -121.90493842065254"
}
},
"contacts": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Jiron",
"last_name": "Amos"
},
"email_address": "jamos@xabungle.com",
"phone_number": "408-123-4567"
}
},
"totals": {"shipment_count": 1,
"lot_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
},
"route_detail": "Scott street to El Camino Real to Kiely to arrive at destination",
"layover": {"is_layover": false,
"estimated_start_timestamp": "",
"start_timestamp": "",
"estimated_end_timestamp": "",
"end_timestamp": ""
},
"driver": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Jiron",
"last_name": "Amos"
},
"email_address": "jamos@xabungle.com",
"phone_number": "408-123-4567",
"occupational_licenses": [{"type": "drivers_license",
"number": "CADL12345678",
"issuing_state": "CA"
},
{"type": "occupational",
"number": "CADL12345678",
"issuing_state": "CA"
}
],
"birthday": "2000-01-03T00:00:00Z"
}
},
"vehicles": {"id": "2ab28247836d437888ea4e780e3379e4",
"reference_id": "DMD0001",
"color": "Stainless Steel",
"make": "DeLorean",
"model": "DMC1",
"plate_number": "JP123456ABC",
"license_plate_issuing_state": "CA",
"vin": "dmc1234RTGY67890",
"year": "1983"
}
},
"entity_state": [{"state": "active",
"date": "2021-09-21T20:29:19Z",
"reason": "transfer created",
"actioned_by": "kodai@kmp.com"
},
{"state": "updated",
"date": "2021-09-22T20:29:19Z",
"reason": "transfer updated",
"actioned_by": "kodai@kmp.com"
},
{"state": "shipped",
"date": "2021-09-22T20:29:19Z",
"reason": "transfer shipped",
"actioned_by": "kodai@kmp.com"
}
]
}
},
"warnings": [ ]
}

Retrieve transfer actions

Retrieve transfer actions by 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 transfer action
name	string name of the transfer action
description	string description of the transfer action

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/transfers/actions

Response samples

application/json

{"results": {"type": "array",
"data": [{"id": "ILTUOP0001",
"name": "void transfer",
"description": "void an active transfer if permitted"
},
{"id": "ILTUOP0002",
"name": "receive transfer",
"description": "receive inbound transfer"
},
{"id": "ILTUOP0003",
"name": "reject transfer",
"description": "reject specific lots or all lots from transfer"
},
{"id": "ILTUOP0008",
"name": "entity_state and allowed keys",
"description": "allow multiple updates for IL Biotrack transfers, no validation"
}
]
},
"warnings": [ ]
}

Create transfer template

Create a transfer template 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 of the shipping facility. This is the business license number issued by the state.

name

required

string

master transfer template name. describes the manifests contained within this transfer

object

totals of all shipments contained within this transfer template

shipment_count	integer totals of all shipments contained within this transfer template
gross_weight	number <float> total gross weight of shipments contained within this transfer template
gross_weight_uom	string unit of measure for the total gross weight

object

master manifest contains summary of all shipment manifests

number

string

unique master manifest template number.

created_timestamp

string

created time stamp in ISO 8601 UTC format.

object

user who created the master manifest.

object

details for the employee.

required

string

reference (entity_id) for the employee.

required

object

originator of the transfer.

required

object

required

string

reference (entity_id) for the facility associated with the license_number

required

object

employee contact for the facility.

required

object

details for the employee.

required

string

reference (entity_id) for the employee.

Array of objects

Array containing information pertaining to the individual shipments in the transfer.

Array

name

required

string

transfer name. describes the manifest contained within this shipment

required

object

characteristics of this transfer template

id required	string Reference (entity_ID) for the transfer template type.
type required	string indicates the specific type of transporter
license_type required	string used to identify if the transfer is a licensed transfer.

required

Array of objects

describes the contents of the lots in the shipment

Array

id	string reference (entity_id) of the contents description.
name	string description of the contents

required

object

manifest associated with the shipment

number

string

unique manifest number for this transfer

created_timestamp

required

string

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

required

object

identifies employee who created the transfer / manifest

required

object

details for the employee.

required

object

totals of shipment contained within this specific transfer

object

total shipped and received lots for this shipment

count required	integer total count of shipments contained within this transfer
lot_count required	integer total number of lots shipped within this transfer
gross_weight required	number <float> gross weight of shipments contained within this transfer as required by specific states
gross_weight_uom required	string unit of measure for the gross weight as required by specific states

stop_num

required

integer

stop number out of multiple stops if applicable

route_detail

required

string

description of route followed from origin to destination by transporter

estimated_departure_timestamp

required

string

estimated departure time stamp in ISO 8601 UTC format.

estimated_arrival_timestamp

required

string

estimated arrival time stamp in ISO 8601 UTC format.

required

object

Information pertaining to the receiver of the shipment.

required

object

license_number	string Reference (entity_ID) for the license of the shipping facility. This is the business license number issued by the state.
	object type of license as defined by the state

required

object

required

string

reference (entity_id) for the facility associated with the license_number

object

location where the transfer will be received

required

string

reference (entity_id) for the location

object

employee contact for the facility

required

object

details for the employee.

required

Array of objects

array of lots and characteristics contained in this transfer.

Array

price_per_lot required	number <float> wholesale price of lot
usage required	string indicates if lots contents intended for adult or medical use
return_reason required	string reason for lot rejection or return
return_refund_amount required	number <float> refund price for returned lot
required	object lot contained within transfer

required

object

transfer transporter

required

object

required

string

reference (entity_id) for the facility associated with the license_number

required

object

employee contact for the facility.

required

object

details for the employee.

required

string

reference (entity_id) for the employee.

required

object

totals of shipment contained within this specific transfer

shipment_count required	integer shipment count total for this transfer for this transporter
lot_count required	integer total lot count for this transfer for this transporter
gross_weight required	number <float> total gross weight for this transfer for this transporter
gross_weight_uom required	string unit of measure for the gross weight

route_detail

required

string

description of complete route followed from origin to destination for each shipment by transporter

required

object

characteristics of layover if present for the transfer

is_layover required	boolean true if this transfer contains a layover
estimated_start_timestamp required	string estimated start time stamp in ISO 8601 UTC format
estimated_end_timestamp required	string estimated end time stamp in ISO 8601 UTC format

required

object

driver details for the transporter.

required

object

details for the employee (driver)

required

string

reference (entity_id) for the employee.

object

vehicle used for the transfers

required

string

reference (entity_id) for the employee.

Responses

200

Response Schema: application/json

object

type

string

Value: "object"

object

string

Reference (entity_ID) for the master template id for all contained shipments

name

string

master transfer name. describes the manifests contained within this transfer

object

totals of all shipments contained within this transfer

shipment_count	integer total count of shipments contained within this transfer
gross_weight	number <float> total gross weight of shipments contained within this transfer
gross_weight_uom	string unit of measure for the total gross weight

object

master manifest contains summary of all shipment manifests

number

string

unique master manifest number.

created_timestamp

string

created time stamp in ISO 8601 UTC format.

object

user who created the master manifest.

object

details for the employee.

updated_timestamp

string

updated time stamp in ISO 8601 UTC format

object

user who updated the master manifest.

object

details for the employee.

update_number

integer

total update counts to master manifest

is_void

boolean

true if the master manifest is void, otherwise false

Array of objects

applicable actions for transfer update operation

Array

id	string Reference (entity_ID) for the action
name	string name of transfer update action

object

originator of the transfer

object

id	string reference (entity_id) for the facility associated with the license_number
name	string name of the facility
phone_number	string phone number of the facility
	object
	object Address of the facility

object

employee contact for the facility.

object

details for the employee.

Array of objects

Array containing information pertaining to the individual shipments in the transfer.

Array

id	string reference (entity_id) for the transfer template
name	string describes the transfer contained within this shipment
shipment_id	string shipment identifier as required by specific states
	object characteristics of this transfer
	Array of objects describes the contents of the lots in the transfers
	object manifest associated with the specific shipment
	object totals shipped and received for this transfer
stop_num	integer stop number out of multiple stops if applicable
route_detail	string description of route followed from origin to destination by transporter
estimated_departure_timestamp	string estimated departure time stamp in ISO 8601 UTC format.
departure_timestamp	string departure time stamp in ISO 8601 UTC format.
estimated_arrival_timestamp	string estimated arrival time stamp in ISO 8601 UTC format.
arrival_timestamp	string arrival time stamp in ISO 8601 UTC format.
received_timestamp	string arrival time stamp in ISO 8601 UTC format.
	object Information pertaining to the receiver of the shipment.
	Array of objects array of lots and characteristics contained in this transfer

object

transfer transporter.

object

id	string reference (entity_id) for the facility associated with the license_number
name	string name of the facility
phone_number	string phone number of the facility
	object
	object Address of the facility

object

employee contact for the facility.

object

details for the employee.

object

totals of all shipments transported for this transfer

shipment_count	integer The total number of shipments in the transfer.
lot_count	integer The total number of lots in the transfer.
received_lot_count	integer
gross_weight	integer the total weight of product in the transfer.
gross_weight_uom	string The unit of measure being used for the gross weight of the transfer.

route_detail

string

description of complete route followed from origin to destination for each shipment by transporter

object

characteristics of layover if present for the transfer

is_layover	boolean true if this transfer contains a layover, otherwise false
estimated_start_timestamp	string estimated start time stamp in ISO 8601 UTC format
start_timestamp	string start time stamp in ISO 8601 UTC format
estimated_end_timestamp	string estimated end time stamp in ISO 8601 UTC format
end_timestamp	string end time stamp in ISO 8601 UTC format

object

driver details for the transporter

object

details for the employee.

object

vehicle used for the transfers

id	string reference (entity_id) for the vehicle.
reference_id	string unique reference (entity_id) provided by track and trace systems
color	string The color of the vehicle.
make	string The make of the vehicle.
model	string The model of the vehicle.
plate_number	string The plate_number of the vehicle.
license_plate_issuing_state	string The state that issued the license plate.
vin	string The vin number of the vehicle.
year	string The model year of the vehicle.

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

post/{state}/v1/transfers/template

Request samples

Payload

application/json

{"license": {"license_number": "KMP20222825"
},
"name": "Trace transfers 2199",
"totals": {"shipment_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
},
"master_manifest": {"number": "da7f7fe3bcbc4aa09cb67140012f8bf9",
"created_timestamp": "2021-09-04T09:05:00Z",
"created_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529"
}
}
},
"shipper": {"facilities": {"id": "da7f7fe3bcbc4aa09cb67140012f8bf9"
},
"contacts": {"employees": {"id": "5c79343945ac422abff5dda971fdf529"
}
}
},
"transfers": [{"name": "Trace transfer shipment Z1 processor to processor",
"transfer_type": {"id": "CAKOMTT0004",
"type": "standard",
"license_type": "licensed"
},
"contents": [{"id": "KOMTC0003"
}
],
"manifest": {"created_timestamp": "2021-09-03T08:00:00Z",
"created_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529"
}
}
},
"totals": {"shipped": {"count": 1,
"lot_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
}
},
"stop_num": 1,
"route_detail": "Scott street to El Camino Real to Kiely to arrive at destination",
"estimated_departure_timestamp": "2021-09-04T09:00:00Z",
"estimated_arrival_timestamp": "2021-09-04T10:00:00Z",
"receiver": {"license": {"license_number": "KMP202228252"
},
"facilities": {"id": "da7f7fe3bcbc4aa09cb345678f8bf9"
},
"locations": {"id": "da7f7fe3bcbc4aa09cb345678f8bf9"
},
"contacts": {"employees": {"id": "5c79343945ac422abff5dda971fdf529"
}
}
},
"lots": [{"price_per_lot": 20,
"usage": "",
"return_reason": "",
"return_refund_amount": 0,
"lot": {"id": "fg67e96ac61b4ca9bb9c2607f98f4"
}
}
]
}
],
"transporter": {"facilities": {"id": "da7f7fe3bcbc4abnm4575678f8bf9"
},
"contacts": {"employees": {"id": "5c79343945ac422abff5dda971fdf529"
}
},
"totals": {"shipment_count": 1,
"lot_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
},
"route_detail": "Scott street to El Camino Real to Kiely to arrive at destination",
"layover": {"is_layover": false,
"estimated_start_timestamp": "",
"estimated_end_timestamp": ""
},
"driver": {"employees": {"id": "5c79343945ac422abff5dda971fdf529"
}
},
"vehicles": {"id": "2ab28247836d437888ea4e780e3379e4"
}
}
}

Response samples

application/json

{"results": {"type": "object",
"data": {"id": "da7f7fe3bcbc4aa09cb67140012f567",
"name": "Trace transfers 2199",
"totals": {"shipment_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
},
"master_manifest": {"number": "KOMMT123456789",
"created_timestamp": "2021-09-04T10:00:00Z",
"created_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567"
}
},
"updated_timestamp": "2021-09-04T10:00:00Z",
"updated_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567"
}
}
},
"action": [{"id": "ILTUOP0002",
"name": "receive inbound transfer"
}
],
"shipper": {"facilities": {"id": "da7f7fe3bcbc4aa09cb67140012f8bf9",
"name": "Tetsuro processing",
"phone_number": "408-123-4567",
"license": {"license_number": "KMP20222825",
"type": {"name": "Type 12"
}
},
"address": {"address_line_1": "977 The Alameda",
"address_line_2": "Suite 100",
"address_line_3": "",
"country": "USA",
"county": "Santa Clara",
"city": "San Jose",
"state": "CA",
"zip": "95126",
"gps": "37.33250383310398, -121.90493842065254"
}
},
"contacts": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567"
}
}
},
"transfers": [{"id": "KMPSTID10001",
"name": "Trace transfer shipment Z1 processor to processor",
"shipment_id": "KMPTS1001",
"transfer_type": {"id": "CAKOMTT0004",
"name": "transfer",
"type": "standard",
"license_type": "licensed"
},
"contents": [{"id": "KOMTC0003",
"name": "test_sample"
}
],
"manifest": {"number": "1000056892314",
"created_timestamp": "2021-09-03T08:00:00Z",
"created_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.comerified.comerified.comerified.com",
"phone_number": "408-123-4567"
}
},
"updated_timestamp": "2021-09-03T09:00:00Z",
"updated_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567"
}
},
"update_number": 1,
"is_void": false
},
"totals": {"shipped": {"count": 1,
"lot_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
},
"received": {"count": 1,
"lot_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
}
},
"stop_num": 1,
"route_detail": "Scott street to El Camino Real to Kiely to arrive at destination",
"estimated_departure_timestamp": "2021-09-04T09:00:00Z",
"departure_timestamp": "2021-09-04T09:05:00Z",
"estimated_arrival_timestamp": "2021-09-04T10:00:00Z",
"arrival_timestamp": "2021-09-04T10:10:00Z",
"received_timestamp": "2021-09-04T10:30:00Z",
"receiver": {"facilities": {"id": "da7f7fe3bcbc4aa09cb345678f8bf9",
"name": "Materu Solvent Extraction",
"phone_number": "408-123-4567",
"license": {"license_number": "CDPH-0000003",
"type": {"name": "Type 6"
}
},
"address": {"address_line_1": "977 The Alameda",
"address_line_2": "Suite 200",
"address_line_3": "",
"country": "USA",
"county": "Santa Clara",
"city": "San Jose",
"state": "CA",
"zip": "95126",
"gps": "37.33250383310398, -121.90493842065254"
}
},
"locations": {"id": "da7f7fe3bcbc4aa09cb345678f8bf9",
"name": "Harlock receiving"
},
"contacts": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Amuro",
"last_name": "Rey"
},
"email_address": "arey@greencheckverified.comerified.com",
"phone_number": "408-123-4567"
}
}
},
"lots": [{"price_per_lot": 20,
"usage": "for_extraction",
"return_reason": "",
"return_refund_amount": 0,
"lot": {"id": "fg67e96ac61b4ca9bb9c2607f98f4"
}
}
]
}
],
"transporter": {"facilities": {"id": "da7f7fe3bcbc4abnm4575678f8bf9",
"name": "Xabungle Transport Tomino 1",
"phone_number": "408-123-4567",
"license": {"license_number": "KMP20222825",
"type": {"name": "Type 8"
}
},
"address": {"address_line_1": "977 The Alameda",
"address_line_2": "Suite 300",
"address_line_3": "",
"country": "USA",
"county": "Santa Clara",
"city": "San Jose",
"state": "CA",
"zip": "95126",
"gps": "37.33250383310398, -121.90493842065254"
}
},
"contacts": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Jiron",
"last_name": "Amos"
},
"email_address": "jamos@xabungle.com",
"phone_number": "408-123-4567"
}
},
"totals": {"shipment_count": 1,
"lot_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
},
"route_detail": "Scott street to El Camino Real to Kiely to arrive at destination",
"layover": {"is_layover": false,
"estimated_start_timestamp": "",
"start_timestamp": "",
"estimated_end_timestamp": "",
"end_timestamp": ""
},
"driver": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Jiron",
"last_name": "Amos"
},
"email_address": "jamos@xabungle.com",
"phone_number": "408-123-4567",
"occupational_licenses": [{"type": "drivers_license",
"number": "CADL12345678",
"issuing_state": "CA"
},
{"type": "occupational",
"number": "CADL12345678",
"issuing_state": "CA"
}
],
"birthday": "2000-01-03T00:00:00Z"
}
},
"vehicles": {"id": "2ab28247836d437888ea4e780e3379e4",
"reference_id": "DMD0001",
"color": "Stainless Steel",
"make": "DeLorean",
"model": "DMC1",
"plate_number": "JP123456ABC",
"license_plate_issuing_state": "CA",
"vin": "dmc1234RTGY67890",
"year": "1983"
}
},
"entity_state": [{"state": "active",
"date": "2021-09-21T20:29:19Z",
"reason": "transfer created",
"actioned_by": "kodai@kmp.com"
},
{"state": "updated",
"date": "2021-09-22T20:29:19Z",
"reason": "transfer updated",
"actioned_by": "kodai@kmp.com"
},
{"state": "shipped",
"date": "2021-09-22T20:29:19Z",
"reason": "transfer shipped",
"actioned_by": "kodai@kmp.com"
}
]
}
},
"warnings": [ ]
}

Retrieve transfer template(s) details

Retrieve the transfer template. If the template id is not provided, all active transfer templates for the license_number are returned.

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 Template 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 lab test results. Not all entity states available for all states. Enum: "active" "updated" "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: "object"

object

string

Reference (entity_ID) for the master template id for all contained shipments

name

string

master transfer name. describes the manifests contained within this transfer

object

totals of all shipments contained within this transfer

shipment_count	integer total count of shipments contained within this transfer
gross_weight	number <float> total gross weight of shipments contained within this transfer
gross_weight_uom	string unit of measure for the total gross weight

object

master manifest contains summary of all shipment manifests

number

string

unique master manifest number.

created_timestamp

string

created time stamp in ISO 8601 UTC format.

object

user who created the master manifest.

object

details for the employee.

updated_timestamp

string

updated time stamp in ISO 8601 UTC format

object

user who updated the master manifest.

object

details for the employee.

update_number

integer

total update counts to master manifest

is_void

boolean

true if the master manifest is void, otherwise false

Array of objects

applicable actions for transfer update operation

Array

id	string Reference (entity_ID) for the action
name	string name of transfer update action

object

originator of the transfer

object

id	string reference (entity_id) for the facility associated with the license_number
name	string name of the facility
phone_number	string phone number of the facility
	object
	object Address of the facility

object

employee contact for the facility.

object

details for the employee.

Array of objects

Array containing information pertaining to the individual shipments in the transfer.

Array

id	string reference (entity_id) for the transfer template
name	string describes the transfer contained within this shipment
shipment_id	string shipment identifier as required by specific states
	object characteristics of this transfer
	Array of objects describes the contents of the lots in the transfers
	object manifest associated with the specific shipment
	object totals shipped and received for this transfer
stop_num	integer stop number out of multiple stops if applicable
route_detail	string description of route followed from origin to destination by transporter
estimated_departure_timestamp	string estimated departure time stamp in ISO 8601 UTC format.
departure_timestamp	string departure time stamp in ISO 8601 UTC format.
estimated_arrival_timestamp	string estimated arrival time stamp in ISO 8601 UTC format.
arrival_timestamp	string arrival time stamp in ISO 8601 UTC format.
received_timestamp	string arrival time stamp in ISO 8601 UTC format.
	object Information pertaining to the receiver of the shipment.
	Array of objects array of lots and characteristics contained in this transfer

object

transfer transporter.

object

id	string reference (entity_id) for the facility associated with the license_number
name	string name of the facility
phone_number	string phone number of the facility
	object
	object Address of the facility

object

employee contact for the facility.

object

details for the employee.

object

totals of all shipments transported for this transfer

shipment_count	integer The total number of shipments in the transfer.
lot_count	integer The total number of lots in the transfer.
received_lot_count	integer
gross_weight	integer the total weight of product in the transfer.
gross_weight_uom	string The unit of measure being used for the gross weight of the transfer.

route_detail

string

description of complete route followed from origin to destination for each shipment by transporter

object

characteristics of layover if present for the transfer

is_layover	boolean true if this transfer contains a layover, otherwise false
estimated_start_timestamp	string estimated start time stamp in ISO 8601 UTC format
start_timestamp	string start time stamp in ISO 8601 UTC format
estimated_end_timestamp	string estimated end time stamp in ISO 8601 UTC format
end_timestamp	string end time stamp in ISO 8601 UTC format

object

driver details for the transporter

object

details for the employee.

object

vehicle used for the transfers

id	string reference (entity_id) for the vehicle.
reference_id	string unique reference (entity_id) provided by track and trace systems
color	string The color of the vehicle.
make	string The make of the vehicle.
model	string The model of the vehicle.
plate_number	string The plate_number of the vehicle.
license_plate_issuing_state	string The state that issued the license plate.
vin	string The vin number of the vehicle.
year	string The model year of the vehicle.

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

Response samples

application/json

{"results": {"type": "object",
"data": {"id": "da7f7fe3bcbc4aa09cb67140012f567",
"name": "Trace transfers 2199",
"totals": {"shipment_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
},
"master_manifest": {"number": "KOMMT123456789",
"created_timestamp": "2021-09-04T10:00:00Z",
"created_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567"
}
},
"updated_timestamp": "2021-09-04T10:00:00Z",
"updated_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567"
}
},
"update_number": 1,
"is_void": false
},
"action": [{"id": "ILTUOP0002",
"name": "receive inbound transfer"
}
],
"shipper": {"facilities": {"id": "da7f7fe3bcbc4aa09cb67140012f8bf9",
"name": "Tetsuro processing",
"phone_number": "408-123-4567",
"license": {"license_number": "KMP20222825",
"type": {"name": "Type 12"
}
},
"address": {"address_line_1": "977 The Alameda",
"address_line_2": "Suite 100",
"address_line_3": "",
"country": "USA",
"county": "Santa Clara",
"city": "San Jose",
"state": "CA",
"zip": "95126",
"gps": "37.33250383310398, -121.90493842065254"
}
},
"contacts": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567"
}
}
},
"transfers": [{"id": "KMPSTID10001",
"name": "Trace transfer shipment Z1 processor to processor",
"shipment_id": "KMPTS1001",
"transfer_type": {"id": "CAKOMTT0004",
"name": "transfer",
"type": "standard",
"license_type": "licensed"
},
"contents": [{"id": "KOMTC0003",
"name": "test_sample"
}
],
"manifest": {"number": "1000056892314",
"created_timestamp": "2021-09-03T08:00:00Z",
"created_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567"
}
},
"updated_timestamp": "2021-09-03T09:00:00Z",
"updated_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567"
}
},
"update_number": 1,
"is_void": false
},
"totals": {"shipped": {"count": 1,
"lot_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
},
"received": {"count": 1,
"lot_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
}
},
"stop_num": 1,
"route_detail": "Scott street to El Camino Real to Kiely to arrive at destination",
"estimated_departure_timestamp": "2021-09-04T09:00:00Z",
"departure_timestamp": "2021-09-04T09:05:00Z",
"estimated_arrival_timestamp": "2021-09-04T10:00:00Z",
"arrival_timestamp": "2021-09-04T10:10:00Z",
"received_timestamp": "2021-09-04T10:30:00Z",
"receiver": {"facilities": {"id": "da7f7fe3bcbc4aa09cb345678f8bf9",
"name": "Materu Solvent Extraction",
"phone_number": "408-123-4567",
"license": {"license_number": "CDPH-0000003",
"type": {"name": "Type 6"
}
},
"address": {"address_line_1": "977 The Alameda",
"address_line_2": "Suite 200",
"address_line_3": "",
"country": "USA",
"county": "Santa Clara",
"city": "San Jose",
"state": "CA",
"zip": "95126",
"gps": "37.33250383310398, -121.90493842065254"
}
},
"locations": {"id": "da7f7fe3bcbc4aa09cb345678f8bf9",
"name": "Harlock receiving"
},
"contacts": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Amuro",
"last_name": "Rey"
},
"email_address": "arey@greencheckverified.com",
"phone_number": "408-123-4567"
}
}
},
"lots": [{"price_per_lot": 20,
"usage": "for_extraction",
"return_reason": "",
"return_refund_amount": 0,
"lot": {"license_number": "KMP20222825",
"action": {"id": "KOMLA0001",
"name": "split"
},
"id": "fg67e96ac61b4ca9bb9c2607f98f4",
"name": "Kodai 01 extract intermediate Lot 1",
"barcode": "1KMBV1200000000046",
"quantity": 100,
"unit_of_measure": "Grams",
"date": "2021-09-01T18: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": 1,
"thc_percent": 1
},
"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": 50,
"weight_uom": "Grams",
"quantity": null,
"quantity_uom": null
},
"serving_size": null,
"serving_num": null,
"supply_duration_days": null,
"doses_number": null,
"lab_test_ref": "passed",
"administration_method": "",
"brand": "",
"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": true,
"is_process_validation_sample": false,
"is_requires_remediation": false,
"is_remediated": false,
"is_same_product": false,
"transfer_state": {"id": "CATDLS0001",
"name": "shipped"
},
"is_quarantine": false,
"is_initial_inventory": false,
"is_lab_or_QA_not_required": false,
"lab_or_qa_result_url": "",
"authentication_id": "",
"sample_data": [ ]
},
"adjustment": [ ],
"remediation": [ ],
"entity_state": [{"state": "active",
"date": "2021-09-04T08:00:00Z",
"reason": "lot created",
"actioned_by": "kodai@kmp.com"
},
{"state": "updated",
"date": "2021-09-14T08:00:00Z",
"reason": "lot updated",
"actioned_by": "kodai@kmp.com"
},
{"state": "lab_testing_passed",
"date": "2021-09-14T08:30:00Z",
"reason": "lot lab testing passed",
"actioned_by": "kodai@kmp.com"
}
]
}
}
]
}
],
"transporter": {"facilities": {"id": "da7f7fe3bcbc4abnm4575678f8bf9",
"name": "Xabungle Transport Tomino 1",
"phone_number": "408-123-4567",
"license": {"license_number": "KMP20222825",
"type": {"name": "Type 8"
}
},
"address": {"address_line_1": "977 The Alameda",
"address_line_2": "Suite 300",
"address_line_3": "",
"country": "USA",
"county": "Santa Clara",
"city": "San Jose",
"state": "CA",
"zip": "95126",
"gps": "37.33250383310398, -121.90493842065254"
}
},
"contacts": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Jiron",
"last_name": "Amos"
},
"email_address": "jamos@xabungle.com",
"phone_number": "408-123-4567"
}
},
"totals": {"shipment_count": 1,
"lot_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
},
"route_detail": "Scott street to El Camino Real to Kiely to arrive at destination",
"layover": {"is_layover": false,
"estimated_start_timestamp": "",
"start_timestamp": "",
"estimated_end_timestamp": "",
"end_timestamp": ""
},
"driver": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Jiron",
"last_name": "Amos"
},
"email_address": "jamos@xabungle.com",
"phone_number": "408-123-4567",
"occupational_licenses": [{"type": "drivers_license",
"number": "CADL12345678",
"issuing_state": "CA"
},
{"type": "occupational",
"number": "CADL12345678",
"issuing_state": "CA"
}
],
"birthday": "2000-01-03T00:00:00Z"
}
},
"vehicles": {"id": "2ab28247836d437888ea4e780e3379e4",
"reference_id": "DMD0001",
"color": "Stainless Steel",
"make": "DeLorean",
"model": "DMC1",
"plate_number": "JP123456ABC",
"license_plate_issuing_state": "CA",
"vin": "dmc1234RTGY67890",
"year": "1983"
}
},
"entity_state": [{"state": "active",
"date": "2021-09-21T20:29:19Z",
"reason": "transfer created",
"actioned_by": "kodai@kmp.com"
},
{"state": "updated",
"date": "2021-09-22T20:29:19Z",
"reason": "transfer updated",
"actioned_by": "kodai@kmp.com"
},
{"state": "shipped",
"date": "2021-09-22T20:29:19Z",
"reason": "transfer shipped",
"actioned_by": "kodai@kmp.com"
}
]
}
},
"warnings": [ ]
}

Update transfer template

Update a transfer template for the license_number and {id} 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 Template 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 of the shipping facility. This is the business license number issued by the state.

name

string

master transfer template name. describes the manifests contained within this transfer

object

totals of all shipments contained within this transfer template

shipment_count	integer totals of all shipments contained within this transfer
gross_weight	number <float> total gross weight of shipments contained within this transfer template
gross_weight_uom	string unit of measure for the total gross weight

object

master manifest contains summary of all shipment manifests

number

string

unique master manifest number.

created_timestamp

string

created time stamp in ISO 8601 UTC format.

object

employee who created the master manifest

required

object

details for the employee.

required

string

reference (entity_id) for the employee.

updated_timestamp

string

updated time stamp in ISO 8601 UTC format

object

employee who updated the master manifest

object

details for the employee.

required

string

reference (entity_id) for the employee.

update_number

integer

total update counts to master manifest

is_void

boolean

true if the master manifest is void, otherwise false

Array of objects

applicable actions for transfer update operation

Array

id	string Reference (entity_ID) for the action

Array of objects

Array containing information pertaining to the individual shipments in the transfer.

Array

name

string

transfer name. describes the template manifest contained within this shipment

estimated_arrival_timestamp

string

arrival time stamp in ISO 8601 UTC format.

estimated_departure_timestamp

string

time stamp shipment received in ISO 8601 UTC format

Array of objects

array of lots and characteristics contained in this transfer template to be added or removed by action

Array

price_per_lot required	number <float> wholesale price of lot
return_refund_amount required	number <float> refund price for returned lot
	object lot contained within transfer

object

transfer transporter.

object

id	string reference (entity_id) for the facility associated with the license_number

object

employee contact for the facility.

required

object

details for the employee.

required

string

reference (entity_id) for the employee.

object

totals of all shipments transported for this transfer

shipment_count	integer shipment count total for this transfer for this transporter
lot_count	integer total lot count for this transfer for this transporter
gross_weight	number <float> total gross weight for this transfer for this transporter
gross_weight_uom	string unit of measure for the gross weight

route_detail

string

description of complete route followed from origin to destination for each shipment by transporter

object

characteristics of layover if present for the transfer

is_layover	boolean true if this transfer contains a layover
estimated_start_timestamp	string estimated start time stamp in ISO 8601 UTC format
start_timestamp	string start time stamp in ISO 8601 UTC format
estimated_end_timestamp	string estimated end time stamp in ISO 8601 UTC format
end_timestamp	string end time stamp in ISO 8601 UTC format

object

driver details for the transporter.

required

object

details for the employee (driver)

required

string

reference (entity_id) for the employee.

object

vehicle used for the transfers

required

string

reference (entity_id) for the employee.

Array of objects

list of state changes made to the entity. Entity states applicable [active, inactive, updated]

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

string

Reference (entity_ID) for the master template id for all contained shipments

name

string

master transfer name. describes the manifests contained within this transfer

object

totals of all shipments contained within this transfer

shipment_count	integer total count of shipments contained within this transfer
gross_weight	number <float> total gross weight of shipments contained within this transfer
gross_weight_uom	string unit of measure for the total gross weight

object

master manifest contains summary of all shipment manifests

number

string

unique master manifest number.

created_timestamp

string

created time stamp in ISO 8601 UTC format.

object

user who created the master manifest.

object

details for the employee.

updated_timestamp

string

updated time stamp in ISO 8601 UTC format

object

user who updated the master manifest.

object

details for the employee.

update_number

integer

total update counts to master manifest

is_void

boolean

true if the master manifest is void, otherwise false

Array of objects

applicable actions for transfer update operation

Array

id	string Reference (entity_ID) for the action
name	string name of transfer update action

object

originator of the transfer

object

id	string reference (entity_id) for the facility associated with the license_number
name	string name of the facility
phone_number	string phone number of the facility
	object
	object Address of the facility

object

employee contact for the facility.

object

details for the employee.

Array of objects

Array containing information pertaining to the individual shipments in the transfer.

Array

id	string reference (entity_id) for the transfer template
name	string describes the transfer contained within this shipment
shipment_id	string shipment identifier as required by specific states
	object characteristics of this transfer
	Array of objects describes the contents of the lots in the transfers
	object manifest associated with the specific shipment
	object totals shipped and received for this transfer
stop_num	integer stop number out of multiple stops if applicable
route_detail	string description of route followed from origin to destination by transporter
estimated_departure_timestamp	string estimated departure time stamp in ISO 8601 UTC format.
departure_timestamp	string departure time stamp in ISO 8601 UTC format.
estimated_arrival_timestamp	string estimated arrival time stamp in ISO 8601 UTC format.
arrival_timestamp	string arrival time stamp in ISO 8601 UTC format.
received_timestamp	string arrival time stamp in ISO 8601 UTC format.
	object Information pertaining to the receiver of the shipment.
	Array of objects array of lots and characteristics contained in this transfer

object

transfer transporter.

object

id	string reference (entity_id) for the facility associated with the license_number
name	string name of the facility
phone_number	string phone number of the facility
	object
	object Address of the facility

object

employee contact for the facility.

object

details for the employee.

object

totals of all shipments transported for this transfer

shipment_count	integer The total number of shipments in the transfer.
lot_count	integer The total number of lots in the transfer.
received_lot_count	integer
gross_weight	integer the total weight of product in the transfer.
gross_weight_uom	string The unit of measure being used for the gross weight of the transfer.

route_detail

string

description of complete route followed from origin to destination for each shipment by transporter

object

characteristics of layover if present for the transfer

is_layover	boolean true if this transfer contains a layover, otherwise false
estimated_start_timestamp	string estimated start time stamp in ISO 8601 UTC format
start_timestamp	string start time stamp in ISO 8601 UTC format
estimated_end_timestamp	string estimated end time stamp in ISO 8601 UTC format
end_timestamp	string end time stamp in ISO 8601 UTC format

object

driver details for the transporter

object

details for the employee.

object

vehicle used for the transfers

id	string reference (entity_id) for the vehicle.
reference_id	string unique reference (entity_id) provided by track and trace systems
color	string The color of the vehicle.
make	string The make of the vehicle.
model	string The model of the vehicle.
plate_number	string The plate_number of the vehicle.
license_plate_issuing_state	string The state that issued the license plate.
vin	string The vin number of the vehicle.
year	string The model year of the vehicle.

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

Request samples

Payload

application/json

{"action": [{"id": "ILTUOP0003"
}
],
"transfers": [{"estimated_arrival_timestamp": "2021-09-04T10:00:00Z",
"estimated_departure_timestamp": "2021-09-10T10:00:00Z"
}
]
}

Response samples

application/json

{"results": {"type": "object",
"data": {"id": "da7f7fe3bcbc4aa09cb67140012f567",
"name": "Trace transfers 2199",
"totals": {"shipment_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
},
"master_manifest": {"number": "da7f7fe3bcbc4aa09cb67140012f8bf9",
"created_timestamp": "2021-09-04T09:05:00Z",
"created_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567"
}
},
"updated_timestamp": "",
"updated_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567"
}
},
"update_number": 1,
"is_void": false
},
"action": [{"id": "ILTUOP0003",
"name": "removes lots from a transfer before receiving"
}
],
"shipper": {"facilities": {"id": "da7f7fe3bcbc4aa09cb67140012f8bf9",
"name": "Tetsuro processing",
"phone_number": "408-123-4567",
"license": {"license_number": "KMP20222825",
"type": {"name": "Type 12"
}
},
"address": {"address_line_1": "977 The Alameda",
"address_line_2": "Suite 100",
"address_line_3": "",
"country": "USA",
"county": "Santa Clara",
"city": "San Jose",
"state": "CA",
"zip": "95126",
"gps": "37.33250383310398, -121.90493842065254"
}
},
"contacts": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.com",
"phone_number": "408-123-4567"
}
}
},
"transfers": [{"id": "KMPSTID10001",
"name": "Trace transfer shipment Z1 processor to processor",
"shipment_id": "KMPTS1001",
"transfer_type": {"id": "CAKOMTT0004",
"name": "transfer",
"type": "standard",
"license_type": "licensed"
},
"contents": [{"id": "KOMTC0003",
"name": "test_sample"
}
],
"manifest": {"number": "1000056892314",
"created_timestamp": "2021-09-03T08:00:00Z",
"created_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.comerified.comerified.com",
"phone_number": "408-123-4567"
}
},
"updated_timestamp": "2021-09-03T09:00:00Z",
"updated_by": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Judau",
"last_name": "Ashita"
},
"email_address": "jashita@greencheckverified.comerified.com",
"phone_number": "408-123-4567"
}
},
"update_number": 1,
"is_void": false
},
"totals": {"shipped": {"count": 1,
"lot_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
},
"received": {"count": 1,
"lot_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
}
},
"stop_num": 1,
"route_detail": "Scott street to El Camino Real to Kiely to arrive at destination",
"estimated_departure_timestamp": "2021-09-04T09:00:00Z",
"departure_timestamp": "2021-09-04T09:05:00Z",
"estimated_arrival_timestamp": "2021-09-04T10:00:00Z",
"arrival_timestamp": "2021-09-04T10:10:00Z",
"received_timestamp": "2021-09-04T10:30:00Z",
"receiver": {"facilities": {"id": "da7f7fe3bcbc4aa09cb345678f8bf9",
"name": "Materu Solvent Extraction",
"phone_number": "408-123-4567",
"license": {"license_number": "CDPH-0000003",
"type": {"name": "Type 6"
}
},
"address": {"address_line_1": "977 The Alameda",
"address_line_2": "Suite 200",
"address_line_3": "",
"country": "USA",
"county": "Santa Clara",
"city": "San Jose",
"state": "CA",
"zip": "95126",
"gps": "37.33250383310398, -121.90493842065254"
}
},
"locations": {"id": "da7f7fe3bcbc4aa09cb345678f8bf9",
"name": "Harlock receiving"
},
"contacts": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Amuro",
"last_name": "Rey"
},
"email_address": "arey@greencheckverified.com",
"phone_number": "408-123-4567"
}
}
},
"lots": [{"price_per_lot": 20,
"usage": "for_extraction",
"return_reason": "",
"return_refund_amount": 0,
"lot": {"id": "fg67e96ac61b4ca9bb9c2607f98f4"
}
}
]
}
],
"transporter": {"facilities": {"id": "da7f7fe3bcbc4abnm4575678f8bf9",
"name": "Xabungle Transport Tomino 1",
"phone_number": "408-123-4567",
"license": {"license_number": "008-0000010-LIC",
"type": {"name": "Type 8"
}
},
"address": {"address_line_1": "977 The Alameda",
"address_line_2": "Suite 300",
"address_line_3": "",
"country": "USA",
"county": "Santa Clara",
"city": "San Jose",
"state": "CA",
"zip": "95126",
"gps": "37.33250383310398, -121.90493842065254"
}
},
"contacts": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Jiron",
"last_name": "Amos"
},
"email_address": "jamos@xabungle.com",
"phone_number": "408-123-4567"
}
},
"totals": {"shipment_count": 1,
"lot_count": 1,
"received_lot_count": 1,
"gross_weight": 100,
"gross_weight_uom": "Grams"
},
"route_detail": "Scott street to El Camino Real to Kiely to arrive at destination",
"layover": {"is_layover": false,
"estimated_start_timestamp": "",
"start_timestamp": "",
"estimated_end_timestamp": "",
"end_timestamp": ""
},
"driver": {"employees": {"id": "5c79343945ac422abff5dda971fdf529",
"name": {"first_name": "Jiron",
"last_name": "Amos"
},
"email_address": "jamos@xabungle.com",
"phone_number": "408-123-4567",
"occupational_licenses": [{"type": "drivers_license",
"number": "CADL12345678",
"issuing_state": "CA"
},
{"type": "occupational",
"number": "CADL12345678",
"issuing_state": "CA"
}
],
"birthday": "2000-01-03T00:00:00Z"
}
},
"vehicles": {"id": "2ab28247836d437888ea4e780e3379e4",
"reference_id": "DMD0001",
"color": "Stainless Steel",
"make": "DeLorean",
"model": "DMC1",
"plate_number": "JP123456ABC",
"license_plate_issuing_state": "CA",
"vin": "dmc1234RTGY67890",
"year": "1983"
}
},
"entity_state": [{"state": "active",
"date": "2021-09-21T20:29:19Z",
"reason": "transfer created",
"actioned_by": "kodai@kmp.com"
},
{"state": "updated",
"date": "2021-09-22T20:29:19Z",
"reason": "transfer updated",
"actioned_by": "kodai@kmp.com"
},
{"state": "shipped",
"date": "2021-09-22T20:29:19Z",
"reason": "transfer shipped",
"actioned_by": "kodai@kmp.com"
}
]
}
},
"warnings": [ ]
}

Delete transfer template

delete a transfer template for the license_number and template {id}

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

Responses

200

Response Schema: application/json

object

type

string

Value: "object"

object

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

Array of objects

Array

type	string
detail	string

400

Bad Request

delete/{state}/v1/transfers/template/{id}

Request samples

Payload

application/json

{"license_number": "KMP20200814"
}

Response samples

application/json

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

Retrieve transfer types

Retrieve transfer types by 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

Response Schema: application/json

object

type

string

Value: "array"

Array of objects

Array

string

reference id for the transfer type.

object

license_number	string license number issued by the state.
	object

name

string

name of the transfer type.

type

Array of strings

list of transfer type values for manifests as required by specific states

object

for_licensed_shipments	boolean or null true if transfer is for licensed shipments.
for_external_inbound_shipments	boolean or null true if transfer is for external inbound shipments.
for_external_outbound_shipments	boolean or null true if transfer is for external outbound shipments.
requires_destination_gross_weight	boolean or null true if transfer type requires shipment gross weight.
requires_lots_gross_weight	boolean or null true if transfer type requires lots gross weight.

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/transfers/types

Response samples

application/json

{"results": {"type": "array",
"data": [{"id": "CAKOMTT0001",
"license": {"license_number": "CML17-0000001",
"type": {"name": "Type 17"
}
},
"name": "qa_onsite_testing",
"type": ["standard",
"pick_up",
"order",
"third_party",
"return"
],
"characteristics": {"for_licensed_shipments": true,
"for_external_inbound_shipments": true,
"for_external_outbound_shipments": true,
"requires_destination_gross_weight": false,
"requires_lots_gross_weight": false
}
},
{"id": "CAKOMTT0003",
"license": {"license_number": "CML17-0000001",
"type": {"name": "Type 17"
}
},
"name": "state_authorized",
"type": ["standard",
"pick_up",
"order",
"third_party",
"return"
],
"characteristics": {"for_licensed_shipments": null,
"for_external_inbound_shipments": null,
"for_external_outbound_shipments": null,
"requires_destination_gross_weight": null,
"requires_lots_gross_weight": null
}
},
{"id": "CAKOMTT0004",
"license": {"license_number": "CML17-0000001",
"type": {"name": "Type 17"
}
},
"name": "transfer",
"type": ["standard",
"pick_up",
"order",
"third_party",
"return"
],
"characteristics": {"for_licensed_shipments": null,
"for_external_inbound_shipments": null,
"for_external_outbound_shipments": null,
"requires_destination_gross_weight": null,
"requires_lots_gross_weight": null
}
}
]
},
"warnings": [ ]
}

Retrieve transfer contents

Retrieve transfer contents by 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 transfer contents.
name	string name of the transfer contents.

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/transfer/contents

Response samples

application/json

{"results": {"type": "array",
"data": [{"id": "KOMTC0001",
"name": "trade_sample"
},
{"id": "KOMTC0002",
"name": "donation"
},
{"id": "KOMTC0003",
"name": "test_sample"
},
{"id": "KOMTC0004",
"name": "product_lot_requiring_remediation"
},
{"id": "KOMTC0005",
"name": "remediated_product_lot"
},
{"id": "KOMTC0006",
"name": "plant_lot"
},
{"id": "KOMTC0007",
"name": "product_lot"
},
{"id": "KOMTC0008",
"name": "rejected_lot(s)"
}
]
},
"warnings": [ ]
}

➔ Next to Sale