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

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