Sale Helpers

Retrieve sales actions

Retrieve a list of sales actions for updating a sale

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 sale action.
name	string name of the sale action
description	string Information indicating in more detail what the action id can be used for

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/sales/actions

Response samples

application/json

{"results": {"type": "array",
"data": [{"id": "KMSAN0001",
"name": "change_quantity",
"description": "change quantity on item(s) sold"
},
{"id": "KMSAN0002",
"name": "change_price",
"description": "change price on item(s) sold"
},
{"id": "KMSAN0003",
"name": "void_sale",
"description": "remove sale and return items to inventory"
},
{"id": "KMSAN0004",
"name": "refund_sale",
"description": "refund item(s) from sale"
}
]
},
"warnings": [ ]
}

Retrieve customer types

Retrieve a list of customer types needed to make a sale.

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 customer type
name	string name of the customer type

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/sales/customer_types

Response samples

application/json

{"results": {"type": "array",
"data": [{"id": "CAKOMCT0001",
"name": "adult"
},
{"id": "CAKOMCT0002",
"name": "patient"
},
{"id": "CAKOMCT0003",
"name": "caregiver"
},
{"id": "CAKOMCT0004",
"name": "external_patient"
}
]
},
"warnings": [ ]
}

Retrieve identification types

Retrieve a list of identification types that can be passed with a sale.

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 type of identification
name	string name of the identification type

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/sales/identification_types

Response samples

application/json

{"results": {"type": "array",
"data": [{"id": "CAKOMIT0001",
"name": "drivers_license"
},
{"id": "CAKOMIT0002",
"name": "patient_id"
},
{"id": "CAKOMIT0003",
"name": "caregiver_id"
},
{"id": "CAKOMIT0004",
"name": "externalpatient_id"
}
]
},
"warnings": [ ]
}

Retrieve currency types

Retrieve a list of currency types needed to make a sale.

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 currency type
name	string name of the currency

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/sales/currency_types

Response samples

application/json

{"results": {"type": "array",
"data": [{"id": "KOMCURT0001",
"name": "USD"
}
]
},
"warnings": [ ]
}

Retrieve payment types

Retrieve a list of payment types needed to make a sale.

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 payment type
name	string name of the payment type

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/sales/payment_types

Response samples

application/json

{"results": {"type": "array",
"data": [{"id": "CAKOMPT0001",
"name": "debit"
},
{"id": "CAKOMPT0002",
"name": "cash"
},
{"id": "CAKOMPT0003",
"name": "ach"
}
]
},
"warnings": [ ]
}

Retrieve tax types

Retrieve a list of tax types needed to report taxes on a sale.

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 tax type
name	string name of the tax type

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/sales/tax_types

Response samples

application/json

{"results": {"type": "array",
"data": [{"id": "KOMTAX0001",
"name": "Sales Tax"
},
{"id": "KOMTAX0002",
"name": "Excise Tax"
},
{"id": "KOMTAX0003",
"name": "Other Tax"
},
{"id": "KOMTAX0004",
"name": "City Tax"
},
{"id": "KOMTAX0005",
"name": "County Tax"
},
{"id": "KOMTAX0006",
"name": "Municipal Tax"
}
]
},
"warnings": [ ]
}

Patient Lookup

Retrieve information about a consumer by its id. Currently supports medical patient lookup in states that support dynamic purchase limits.

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
consumer_id required	string Customers Patient ID. Example: consumer_id=ABCD-PAT-019876

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

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.

consumer_id

string

Consumer(Patient ID) provided as parameter in lookup.

status

string

Status as returned from state track and trace system. Values will either be active or inactive.

expiration_date

string or null

Expiration date as provided by the state track and trace system.

limits

object

Object containing state specific purchase limit values for the consumer (patient).

key

string or null

In certain states, this key is a session based token that guarantees the purchase limits for a period of time. Is used in conjunction with processing a sale.

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/sales/consumer/lookup

Response samples

application/json

{"results": {"type": "array",
"data": [{"license": {"license_number": "MED-X0001",
"type": {"name": "Medical Dispensary"
}
},
"consumer_id": "1234-5678-910",
"status": "active",
"expiration_date": null,
"limits": {"flower_ounces_available": 120,
"thc_ounces_available": 36,
"ConcentrateOuncesAvailable": 0,
"infused_ounces_available": 0,
"purchase_amounts_days": 30
},
"key": null
}
]
},
"warnings": [ ]
}

➔ Next to Delivery