Other Reference Codes¶
GET /reference/{code_type}
Returns other HQ standard code lists.
Authentication: API key (x-functions-key)
Request¶
Path parameters¶
| Parameter | Required | Allowed values |
|---|---|---|
| code_type | Yes | order-types, order-sources, payment-methods, payment-types, tax-categories |
Response¶
200 OK — same structure as Transaction Types.
| Field | Type | Description |
|---|---|---|
| version | string | Version (date) of the code list |
| data | array | Codes |
| data[].code | string | Standard code |
| data[].name | localized text | Display name |
{
"version": "2026-10-15",
"data": [
{ "code": "DINE_IN", "name": { "en-US": "Dine-in", "zh-TW": "內用" } },
{ "code": "TO_GO", "name": { "en-US": "To go", "zh-TW": "外帶" } }
]
}
Errors¶
| HTTP | code | When |
|---|---|---|
| 401 | UNAUTHORIZED | Missing or invalid API key |
| 404 | NOT_FOUND | code_type is not one of the allowed values |
Notes¶
order-sourcesandpayment-typesare suggested lists: you may also send your own free-string values. The other lists are strict. See Code Tables.