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" "il" "wa" "ma" "md" "mi" "wv" "co" "ok" "oh"

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

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": [ ]
}