Sale

Create Retail Sales

Create sales under the retail capable 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"

query Parameters

purchase_limit_override

boolean

Optional query string parameter to include if a posted sale is failing purchase limit validation due to clerical error. Example, 100 mg edible lot has 40 Grams set as unit_weight.

Example: purchase_limit_override=true

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

Array of objects

Array of individual sales objects.

Array

required

object

license_number

required

string

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

customer_types

required

object

customer_type GET sales/customer_types for details on types.

external_id

string

An identifier tied to invoice number on receipts in metrc or for Trace persistence in states that do not support the field.

terminal

required

string

an identifier for a specific register or point of sale system where sale is made.

required

object

date required	string created time stamp in ISO 8601 UTC format.
local_time required	string sale date time without timezone representing the local time the sale was made.

out_of_state_sale

required

boolean

true if the customer is from out of state.

required

Array of objects

Array

types required	object customer_types id from GET sales/customer_types
id required	string value of the particular identification passed in.
birthday	string customers birthday in ISO 8601 UTC format. Only needed with drivers license type identification.

required

object

required

string

Trace employee ID that registered the sale.

required

Array of objects

Array

lot required	object Trace lot id for the package / inventory to be sold.
discount	string A string format decimal value representing the dollar amount discount applied to the lot at the time of sale. Cannot exceed the price of the lot.
quantity required	string A string format of the quantity of items sold. For each should be integer, for weight based can be a float.
unit_price required	string A string format of price per unit. We will not convert this number and will be passed through to track and trace systems as sent.
	Array of objects
total required	string A string format of the total ((unit_price * quantity) - discount + taxes) for particular lot.

required

object

contains currency id used for the sale.

required

string

Trace currency id from GET sales/currency_types.

required

object

object containing information about total amount and quantity for the sale.

subtotal required	string the total amount for the sale after discount before taxes.
quantity required	string A string format of the value summing total quantities of all line items on the sale.
total required	string A string format of the total sale price including taxes and discounts. Must match the payment amount.

required

Array of objects

array of payment method(s) used in the sale

Array

id	string optional parameter that can be used to store a payment id likely from a payment processing system.
amount required	string the amount paid with the particular payment type.
required	object payment type from GET sales/payment_types
provider_name	string Commonly used with the ACH payment type (optional).

Responses

200

Response Schema: application/json

object

type

string

Value: "object"

object

Data regarding sale made in the post request.

object

license_number

string

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

object

License type of the company/facility.

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

string

The Trace id assigned to the processed sale.

receipt_number

string

ID/Receipt number provided by the track and trace system.

customer_types

object

customer_type GET sales/customer_types for details on types.

external_id

string

invoice number or transaction identified passed through in states that support invoice number in the track and trace system.

terminal

string

an identifier for a specific register or point of sale system where sale is made.

object

date	string created time stamp in ISO 8601 UTC format.
local_time	string sale date time without timezone representing the local time the sale was made.

out_of_state_sale

boolean

true if the customer is from out of state.

Array of objects

Array

types	object customer_types id from GET sales/customer_types
id	string value of the particular identification passed in.
birthday	string customers birthday in ISO 8601 UTC format. Only needed with drivers license type identification.

object

string

Trace employee ID that registered the sale.

object

Employee's name associated with the employee ID used to make the sale.

first_name	string Employee's first name.
last_name	string Employee's last name.

Array of objects

Array

	object Trace lot id for the package / inventory to be sold.
name	string Name provided for the lot being sold.
discount	string A string format decimal value representing the dollar amount discount applied to the lot at the time of sale. Cannot exceed the price of the lot.
quantity	string A string format of the quantity of items sold. For each should be integer, for weight based can be a float.
unit_of_measure	string the unit of measure associated to the lot.
unit_price	string A string format of price per unit. We will not convert this number and will be passed through to track and trace systems as sent.
	Array of objects
total	string string format of subtotal for particular lot.

object

contains currency id used for the sale.

id	string Trace currency id from GET sales/currency_types.
name	string Name of the currency used for the sale.

object

object containing information about total amount and quantity for the sale.

subtotal

string

the total amount for the sale after discount before taxes.

quantity

string

A string format of the value summing total quantities of all line items on the sale.

Array of objects

Array

	object
total	string string value in decimal format to represent the total for the tax type on the lot.

total

string

string value in decimal format to represent the sum of all line items, discounts and taxes.

Array of objects

array of payment method(s) used in the sale

Array

id	string optional parameter that can be used to store a payment id likely from a payment processing system.
amount	string the amount paid with the particular payment type.
	object payment type from GET sales/payment_types
provider_name	string Commonly used with the ACH payment type (optional).

Array of objects

list of state changes made to the entity. Entity states for sales [active,inactive,voided,refunded].

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

Request samples

Payload

application/json

{"sales": [{"license": {"license_number": "XXXRETAIL01"
},
"customer_types": {"id": "CAKOMCT0001"
},
"external_id": "0012345",
"terminal": "23678-AM",
"created_at": {"date": "2022-05-26T15:44:00Z",
"local_time": "2022-05-26T15:44:00"
},
"out_of_state_sale": true,
"identifications": [{"types": {"id": "CAKOMIT0001"
},
"id": "CADL123565",
"birthday": "1982-04-26T00:00:01Z"
},
{"types": {"id": "CAKOMIT0002"
},
"id": "PATIENTID001"
},
{"types": {"id": "CAKOMIT0003"
},
"id": "CAREGIVEID12345"
}
],
"employees": {"id": "0a50cbaf8c1b471aaa427de20facb641"
},
"line_items": [{"lot": {"id": "487fa179018e45d08b204ca4de67ca6d"
},
"discount": "1.00",
"quantity": "1",
"unit_price": "10.00",
"taxes": [{"type": {"id": "KOMTAX0001"
},
"name": "CA MJ Sales Tax",
"rate": "10.00",
"total": "1.00"
},
{"type": {"id": "KOMTAX0002"
},
"name": "Excise Tax",
"rate": "15.00",
"total": "1.50"
}
],
"total": "11.50"
},
{"lot": {"id": "9890c38942b948b291ff9ead560468b3"
},
"discount": "1.00",
"quantity": "1",
"unit_price": "10.00",
"taxes": [{"type": {"id": "KOMTAX0001"
},
"name": "CA MJ Sales Tax",
"rate": "10.00",
"total": "1.00"
},
{"type": {"id": "KOMTAX0002"
},
"name": "Excise Tax",
"rate": "15.00",
"total": "1.50"
}
],
"total": "11.50"
}
],
"currency": {"id": "KOMCURT0001"
},
"totals": {"subtotal": "18.00",
"quantity": "2",
"total": "23.00"
},
"payments": [{"id": "XXXXXDEB123",
"amount": "23.00",
"type": {"id": "CAKOMPT0002"
}
}
]
}
]
}

Response samples

application/json

{"results": {"type": "object",
"data": {"license": {"license_number": "XXXRETAIL01",
"type": {"name": "Type 12"
}
},
"id": "80d15c7713a74feeb4c1c5f533697644",
"receipt_number": "60071",
"customer_types": {"id": "CAKOMCT0001",
"name": "adult"
},
"external_id": "0012345",
"terminal": "23678-AM",
"created_at": {"date": "2022-05-26T15:44:00Z",
"local_time": "2022-05-26T15:44:00Z"
},
"out_of_state_sale": true,
"identifications": [{"types": {"id": "CAKOMIT0001",
"name": "drivers_license"
}
}
],
"employees": {"id": "0a50cbaf8c1b471aaa427de20facb641",
"name": {"first_name": "John",
"last_name": "Smith"
}
},
"line_items": [{"lot": {"id": "4ec56bd8397149f2a70e803dedd26334"
},
"name": "Larry OG Special Sauce",
"discount": "1.00",
"quantity": "1.0",
"unit_of_measure": "Each",
"unit_price": "10.00",
"taxes": [{"type": {"id": "KOMTAX0001",
"name": "Sales Tax"
},
"name": "Sales Tax - 01",
"rate": "10.00",
"total": "4.50"
},
{"type": {"id": "KOMTAX0001",
"name": "Sales Tax"
},
"name": "Sales Tax - 02",
"rate": "10.00",
"total": "1.00"
}
],
"total": "14.50"
},
{"lot": {"id": "f93fed1f329c46759a8d4a1e46e924f7"
},
"name": "Skunk OG Pre-Roll",
"discount": "1.00",
"quantity": "1.0",
"unit_of_measure": "Grams",
"unit_price": "10.00",
"taxes": [{"type": {"id": "KOMTAX0001",
"name": "Sales Tax"
},
"name": "Sales Tax",
"rate": "10.00",
"total": "4.50"
},
{"type": {"id": "KOMTAX0002",
"name": "Excise Tax"
},
"name": "Excise Tax",
"rate": "1.00",
"total": "0.10"
}
],
"total": "13.60"
}
],
"currency": {"id": "KOMCURT0001",
"name": "USD"
},
"totals": {"subtotal": "18.00",
"quantity": "2.0",
"taxes": [{"type": {"id": "KOMTAX0001",
"name": "Sales Tax"
},
"total": "10.00"
},
{"type": {"id": "KOMTAX0002",
"name": "Excise Tax"
},
"total": "0.10"
}
],
"total": "28.10"
},
"payments": [{"id": "XXXXDEB123",
"amount": "28.10",
"type": {"id": "CAKOMPT0002",
"name": "cash"
}
}
],
"entity_state": [{"state": "active",
"date": "2022-06-17T16:53:40Z",
"reason": "sale created",
"actioned_by": "system generated"
},
{"state": "updated",
"date": "2022-06-17T16:53:40Z",
"reason": "sale updated",
"actioned_by": "system generated"
}
]
}
},
"warnings": [{"detail": "sales.created_at entered is 529 hours before the current time stamp 2022-06-17T16:53:39Z",
"type": "created_at"
},
{"detail": "sales.local_time entered is 529 hours before the current time stamp 2022-06-17T16:53:39Z",
"type": "local_time"
}
]
}

Retrieve all active sales

Retrieve sales details for all active sales records.

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

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"

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.

data

Array of arrays

Data regarding sale made in the post request.

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/sales

Response samples

application/json

{"results": {"type": "array",
"records": {"count": "0 - 100",
"total": 437,
"previous": null,
"next": "https://integration-kmp.greencheckverified.com/ca/v1/sales?license_number=123-LIC&limit=100&offset=100"
},
"data": [{"license": {"license_number": "A12-0000015-LIC",
"type": {"name": "Type 12"
}
},
"id": "658cf07615194aa4a5267887a74f7b5b",
"receipt_number": "0000067180",
"customer_types": {"id": "CAKOMCT0001",
"name": "adult"
},
"external_id": "ABC1234",
"terminal": "01122023-BL",
"created_at": {"date": "2023-01-11T12:44:00Z",
"local_time": "2023-01-11T12:44:00"
},
"out_of_state_sale": true,
"identifications": [{"types": {"id": "CAKOMIT0001",
"name": "drivers_license"
}
}
],
"employees": {"id": "0a50cbaf8c1b471aaa427de20facb641",
"name": {"first_name": "Barney",
"last_name": "Sanf"
}
},
"line_items": [{"lot": {"id": "4ec56bd8397149f2a70e803dedd26334"
},
"name": "CA metrc inserted LOT__599402__1672779734612",
"discount": "1.00",
"quantity": "1.0",
"unit_of_measure": "Each",
"unit_price": "10.00",
"taxes": [{"type": {"id": "KOMTAX0001",
"name": "Sales Tax"
},
"name": "Sales Tax - 01",
"rate": "10.00",
"total": "1.00"
},
{"type": {"id": "KOMTAX0001",
"name": "Sales Tax"
},
"name": "Sales Tax - 02",
"rate": "5.00",
"total": ".50"
}
],
"total": "10.50"
},
{"lot": {"id": "f93fed1f329c46759a8d4a1e46e924f7"
},
"name": "CA metrc inserted LOT__107901__1673622697548",
"discount": "2.00",
"quantity": "1.0",
"unit_of_measure": "Grams",
"unit_price": "20.00",
"taxes": [{"type": {"id": "KOMTAX0001",
"name": "Sales Tax"
},
"name": "Sales Tax",
"rate": "10.00",
"total": "2"
},
{"type": {"id": "KOMTAX0002",
"name": "Excise Tax"
},
"name": "Excise Tax",
"rate": "1.00",
"total": ".20"
}
],
"total": "20.20"
}
],
"currency": {"id": "KOMCURT0001",
"name": "USD"
},
"totals": {"subtotal": "27.00",
"quantity": "2",
"taxes": [{"type": {"id": "KOMTAX0001",
"name": "Sales Tax"
},
"total": "3.50"
},
{"type": {"id": "KOMTAX0002",
"name": "Excise Tax"
},
"total": "0.20"
}
],
"total": "30.70"
},
"payments": [{"id": "XXXXXDEB1234__2023-01-30T19:38:52Z",
"amount": "30.70",
"type": {"id": "CAKOMPT0002",
"name": "cash"
}
}
],
"entity_state": [{"state": "active",
"date": "2023-01-30T19:38:52Z",
"reason": "sale created",
"actioned_by": "system generated"
},
{"state": "updated",
"date": "2023-01-30T19:38:52Z",
"reason": "sale updated",
"actioned_by": "system generated"
}
],
"warnings": [{"detail": "sales.created_at entered is 462 hours before the current time stamp 2023-01-30T19:38:51Z",
"type": "created_at"
},
{"detail": "sales.local_time entered is 462 hours before the current time stamp 2023-01-30T19:38:51",
"type": "local_time"
}
]
},
{"license": {"license_number": "A12-0000015-LIC",
"type": {"name": "Type 12"
}
},
"id": "658cf07615194aa4a5267887a74f7b5b",
"receipt_number": "0000067180",
"customer_types": {"id": "CAKOMCT0001",
"name": "adult"
},
"external_id": "ABC1234",
"terminal": "01122023-BL",
"created_at": {"date": "2023-01-11T12:44:00Z",
"local_time": "2023-01-11T12:44:00"
},
"out_of_state_sale": true,
"identifications": [{"types": {"id": "CAKOMIT0001",
"name": "drivers_license"
}
}
],
"employees": {"id": "0a50cbaf8c1b471aaa427de20facb641",
"name": {"first_name": "Barney",
"last_name": "Sanf"
}
},
"line_items": [{"lot": {"id": "4ec56bd8397149f2a70e803dedd26334"
},
"name": "CA metrc inserted LOT__599402__1672779734612",
"discount": "1.00",
"quantity": "1.0",
"unit_of_measure": "Each",
"unit_price": "10.00",
"taxes": [{"type": {"id": "KOMTAX0001",
"name": "Sales Tax"
},
"name": "Sales Tax - 01",
"rate": "10.00",
"total": "1.00"
},
{"type": {"id": "KOMTAX0001",
"name": "Sales Tax"
},
"name": "Sales Tax - 02",
"rate": "10.00",
"total": "1.00"
}
],
"total": "11.00"
},
{"lot": {"id": "f93fed1f329c46759a8d4a1e46e924f7"
},
"name": "CA metrc inserted LOT__107901__1673622697548",
"discount": "1.00",
"quantity": "1.0",
"unit_of_measure": "Grams",
"unit_price": "30.00",
"taxes": [{"type": {"id": "KOMTAX0001",
"name": "Sales Tax"
},
"name": "Sales Tax",
"rate": "10.00",
"total": "3.00"
},
{"type": {"id": "KOMTAX0002",
"name": "Excise Tax"
},
"name": "Excise Tax 101",
"rate": "1.00",
"total": "0.30"
}
],
"total": "32.30"
}
],
"currency": {"id": "KOMCURT0001",
"name": "USD"
},
"totals": {"subtotal": "38.00",
"quantity": "2.0",
"taxes": [{"type": {"id": "KOMTAX0001",
"name": "Sales Tax"
},
"total": "5.00"
},
{"type": {"id": "KOMTAX0002",
"name": "Excise Tax"
},
"total": "0.30"
}
],
"total": "43.30"
},
"payments": [{"id": "XXXXXDEB1234__2023-01-30T19:38:52Z",
"amount": "43.30",
"type": {"id": "CAKOMPT0002",
"name": "cash"
}
}
],
"entity_state": [{"state": "active",
"date": "2023-01-30T19:38:52Z",
"reason": "sale created",
"actioned_by": "system generated"
},
{"state": "updated",
"date": "2023-01-30T19:38:52Z",
"reason": "sale updated",
"actioned_by": "system generated"
}
],
"warnings": [{"detail": "sales.created_at entered is 462 hours before the current time stamp 2023-01-30T19:38:51Z",
"type": "created_at"
},
{"detail": "sales.local_time entered is 462 hours before the current time stamp 2023-01-30T19:38:51",
"type": "local_time"
}
]
}
]
},
"warnings": [ ]
}

Retrieve sale by id

Retrieve sales details for one or more sales records.

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 Trace sale id. Example: 11il9b62fe1c47e4970c55ec6c7ff8jj

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: "object"

object

Data regarding sale made in the post request.

object

license_number

string

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

object

License type of the company/facility.

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

string

The Trace id assigned to the processed sale.

receipt_number

string

ID/Receipt number provided by the track and trace system.

customer_types

object

customer_type GET sales/customer_types for details on types.

external_id

string

invoice number or transaction identified passed through in states that support invoice number in the track and trace system.

terminal

string

an identifier for a specific register or point of sale system where sale is made.

object

date	string created time stamp in ISO 8601 UTC format.
local_time	string sale date time without timezone representing the local time the sale was made.

out_of_state_sale

boolean

true if the customer is from out of state.

Array of objects

Array

types	object customer_types id from GET sales/customer_types
id	string value of the particular identification passed in.
birthday	string customers birthday in ISO 8601 UTC format. Only needed with drivers license type identification.

object

string

Trace employee ID that registered the sale.

object

Employee's name associated with the employee ID used to make the sale.

first_name	string Employee's first name.
last_name	string Employee's last name.

Array of objects

Array

	object Trace lot id for the package / inventory to be sold.
name	string Name provided for the lot being sold.
discount	string A string format decimal value representing the dollar amount discount applied to the lot at the time of sale. Cannot exceed the price of the lot.
quantity	string A string format of the quantity of items sold. For each should be integer, for weight based can be a float.
unit_of_measure	string the unit of measure associated to the lot.
unit_price	string A string format of price per unit. We will not convert this number and will be passed through to track and trace systems as sent.
	Array of objects
total	string string format of subtotal for particular lot.

object

contains currency id used for the sale.

id	string Trace currency id from GET sales/currency_types.
name	string Name of the currency used for the sale.

object

object containing information about total amount and quantity for the sale.

subtotal

string

the total amount for the sale after discount before taxes.

quantity

string

A string format of the value summing total quantities of all line items on the sale.

Array of objects

Array

	object
total	string string value in decimal format to represent the total for the tax type on the lot.

total

string

string value in decimal format to represent the sum of all line items, discounts and taxes.

Array of objects

array of payment method(s) used in the sale

Array

id	string optional parameter that can be used to store a payment id likely from a payment processing system.
amount	string the amount paid with the particular payment type.
	object payment type from GET sales/payment_types
provider_name	string Commonly used with the ACH payment type (optional).

Array of objects

list of state changes made to the entity. Entity states for sales [active,inactive,voided,refunded].

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

Response samples

application/json

{"results": {"type": "object",
"data": {"license": {"license_number": "XXXRETAIL01",
"type": {"name": "Type 12"
}
},
"id": "80d15c7713a74feeb4c1c5f533697644",
"receipt_number": "60071",
"customer_types": {"id": "CAKOMCT0001",
"name": "adult"
},
"external_id": "ABC1234",
"terminal": "23678-AM",
"created_at": {"date": "2022-05-26T15:44:00Z",
"local_time": "2022-05-26T15:44:00Z"
},
"out_of_state_sale": true,
"identifications": [{"types": {"id": "CAKOMIT0001",
"name": "drivers_license"
}
}
],
"employees": {"id": "0a50cbaf8c1b471aaa427de20facb641",
"name": {"first_name": "John",
"last_name": "Smith"
}
},
"line_items": [{"lot": {"id": "4ec56bd8397149f2a70e803dedd26334"
},
"name": "Larry OG Special Sauce",
"discount": "1.00",
"quantity": "1.0",
"unit_of_measure": "Each",
"unit_price": "20.00",
"taxes": [{"type": {"id": "KOMTAX0001",
"name": "Sales Tax"
},
"name": "Sales Tax - 01",
"rate": "10.00",
"total": "2.00"
},
{"type": {"id": "KOMTAX0001",
"name": "Sales Tax"
},
"name": "Sales Tax - 02",
"rate": "10.00",
"total": "2.00"
}
],
"total": "23"
},
{"lot": {"id": "f93fed1f329c46759a8d4a1e46e924f7"
},
"name": "Skunk OG Pre-Roll",
"discount": "0.00",
"quantity": "1.0",
"unit_of_measure": "Grams",
"unit_price": "10.00",
"taxes": [{"type": {"id": "KOMTAX0001",
"name": "Sales Tax"
},
"name": "Sales Tax",
"rate": "10.00",
"total": "1.00"
},
{"type": {"id": "KOMTAX0002",
"name": "Excise Tax"
},
"name": "Excise Tax",
"rate": "1.00",
"total": "1.00"
}
],
"total": "12.00"
}
],
"currency": {"id": "KOMCURT0001",
"name": "USD"
},
"totals": {"subtotal": "29.00",
"quantity": "2.0",
"taxes": [{"type": {"id": "KOMTAX0001",
"name": "Sales Tax"
},
"total": "5.00"
},
{"type": {"id": "KOMTAX0002",
"name": "Excise Tax"
},
"total": "1.00"
}
],
"total": "35.00"
},
"payments": [{"id": "XXXXDEB123",
"amount": "35.00",
"type": {"id": "CAKOMPT0002",
"name": "cash"
}
}
],
"entity_state": [{"state": "active",
"date": "2022-06-17T16:53:40Z",
"reason": "sale created",
"actioned_by": "system generated"
},
{"state": "updated",
"date": "2022-06-17T16:53:40Z",
"reason": "sale updated",
"actioned_by": "system generated"
}
]
}
},
"warnings": [{"detail": "sales.created_at entered is 529 hours before the current time stamp 2022-06-17T16:53:39Z",
"type": "created_at"
},
{"detail": "sales.local_time entered is 529 hours before the current time stamp 2022-06-17T16:53:39Z",
"type": "local_time"
}
]
}

Update Sale

Update the product registered under the license_number provided.

SecurityApiKeyAuth and CustomAuth

Request

path Parameters

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

header Parameters

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

Request Body schema: application/json

required

object

license_number

required

string

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

actions

required

object

Specific action id from sales/actions for the update request. Note: different put requests require different structures.

price_change_date

required

string

time stamp in ISO 8601 UTC format representing the time the price change was made.

required

object

Trace currency id retrieved from sales/currency_types. Must match original sale currency.

required

string

Trace currency id retrieved from sales/currency_types.

required

Array of objects

Array of one or more lots in which you are attempting to update the price on for a particular sale.

Array

required

object

required

string

Trace Lot ID for the item on the sale

amount

required

string

A string format of the price value for the lot on the sale.

Responses

200

Response Schema: application/json

object

type

string

Value: "object"

object

Data regarding sale made in the post request.

object

license_number

string

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

object

License type of the company/facility.

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

string

The Trace id assigned to the processed sale.

receipt_number

string

ID/Receipt number provided by the track and trace system.

customer_types

object

customer_type GET sales/customer_types for details on types.

terminal

string

an identifier for a specific register or point of sale system where sale is made.

object

date	string created time stamp in ISO 8601 UTC format.
local_time	string sale date time without timezone representing the local time the sale was made.

out_of_state_sale

boolean

true if the customer is from out of state.

Array of objects

Array

types	object customer_types id from GET sales/customer_types
id	string value of the particular identification passed in.
birthday	string customers birthday in ISO 8601 UTC format. Only needed with drivers license type identification.

object

string

Trace employee ID that registered the sale.

object

Employee's name associated with the employee ID used to make the sale.

first_name	string Employee's first name.
last_name	string Employee's last name.

Array of objects

Array

	object Trace lot id for the package / inventory to be sold.
name	string Name provided for the lot being sold.
barcode	string Tag used with/provided by the track and trace system for the lot being sold.
unit_of_measure	string the unit of measure associated to the lot.
quantity	string A string format of the quantity of items sold. For each should be integer, for weight based can be a float.
unit_price	string A string format of price per unit. We will not convert this number and will be passed through to track and trace systems as sent.
subtotal	string string format of subtotal for particular lot.

object

contains currency id used for the sale.

id	string Trace currency id from GET sales/currency_types.
name	string Name of the currency used for the sale.

Array of objects

Array

type	string customer supplied name for the tax type represented within the object.
rate	string customer supplied rate typically in decimal or percent format for the tax type represented within the object.
subtotal	string customer supplied subtotal for the tax type represented within the object.

object

object containing information about total amount and quantity for the sale.

amount	string the total amount for the sale summing up subtotals across lots and any applicable taxes.
quantity	string A string format of the value summing total quantities of all line items on the sale.

Array of objects

array of payment method(s) used in the sale

Array

id	string optional parameter that can be used to store a payment id likely from a payment processing system.
amount	string the amount paid with the particular payment type.
	object payment type from GET sales/payment_types
provider_name	string Commonly used with the ACH payment type (optional).

Array of objects

list of state changes made to the entity. Entity states for sales [active,inactive,voided,refunded].

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

Request samples

Payload

application/json

{"license": {"license_number": "XXXRETAIL01"
},
"actions": {"id": "KMSAN0002"
},
"price_change_date": "2021-05-21T20:29:19Z",
"currency": {"id": "KOMCURT0001"
},
"line_items": [{"lot": {"id": "b29cc14d394941d9a2cd48abf64c9d1c"
},
"amount": "10.00"
}
]
}

Response samples

application/json

{"results": {"type": "object",
"data": {"license": {"license_number": "XXXRETAIL01",
"type": {"name": "Dispensaries"
}
},
"id": "532ebe135f7a40db837b4445f55b213c",
"receipt_number": "0000012345",
"customer_types": {"id": "CAKOMCT0001",
"name": "adult"
},
"terminal": "xxxxxxx-1002",
"created_at": {"date": "2021-12-21T01:00:15Z",
"local_time": "2021-12-21T01:00:15"
},
"out_of_state_sale": true,
"identifications": [{"type": {"id": "CAKOMIT0001",
"name": "drivers_license"
}
},
{"type": {"id": "CAKOMIT0002",
"name": "patient_id"
}
},
{"type": {"id": "CAKOMIT0003",
"name": "caregiver_id"
}
}
],
"employees": {"id": "0a50cbaf8c1b471aaa427de20facb641",
"name": {"first_name": "John",
"last_name": "Smith"
}
},
"line_items": [{"lot": {"id": "487fa179018e45d08b204ca4de67ca6d"
},
"name": "lot name",
"quantity": "1",
"unit_of_measure": "Grams",
"unit_price": "10.00",
"subtotal": "10.00"
},
{"lot": {"id": "9890c38942b948b291ff9ead560468b3"
},
"name": "Lot name",
"quantity": "3",
"unit_of_measure": "Grams",
"unit_price": "10.00",
"subtotal": "30.00"
}
],
"currency": {"id": "KOMCURT0001",
"name": "USD"
},
"taxes": [{"type": "Local Sales Tax",
"rate": "10.00",
"subtotal": "4.50"
},
{"type": "City Cannabis Tax",
"rate": "5.00",
"subtotal": "2.25"
},
{"type": "State Cannabis Tax",
"rate": "10.00",
"subtotal": "4.50"
}
],
"totals": {"amount": "51.25",
"quantity": "4"
},
"payments": [{"id": "XXXTERM-0001",
"amount": "51.25",
"type": {"id": "CAKOMPT0002"
}
}
],
"entity_state": [{"state": "active",
"date": "2022-02-10T10:57:03Z",
"reason": "sale created",
"actioned_by": "system generated"
},
{"state": "updated",
"date": "2022-02-10T11:00:04Z",
"reason": "sale updated",
"actioned_by": "system generated"
},
{"state": "change_price",
"date": "2022-02-10T11:00:04Z",
"reason": "price updated on 33wa9b62fe1c47e4970c55ec6c7ff899 from 8 to 10",
"actioned_by": "system generated"
}
]
}
},
"warnings": [ ]
}

➔ Next to Sale Helpers