Configuration represents the configuration settings available for a Venue.
Integrators may use the endpoints within Configuration to obtain menu item configurations, sales categories and other useful data about a Venue.
All configuration endpoints return data following the NX Integration Response:
Example JSON — NxIntegratorResponse
NxIntegratorResponse{
"id": "cfg_8743be2d",
"name": "Happy Hour Pricing",
"updatedAt": "2025-11-01T16:42:10Z",
"externalId": "ext_5578",
"rate": 0.85,
"amount": 12.50,
"parentId": "cfg_parent_001",
"type": "price_rule",
"prices": [
{
"id": "price_001",
"name": "Draft Beer",
"updatedAt": "2025-11-01T12:00:00Z",
"externalId": "menu_1001"
},
{
"id": "price_002",
"name": "House Wine",
"updatedAt": "2025-11-01T12:05:00Z",
"externalId": "menu_1002"
}
],
"firstName": "Alex",
"lastName": "Rivera",
"isActive": true,
"businessDate": "2025-11-01",
"displayName": "Happy Hour - Bar Menu"
}
Example JSON — Minimal NxIntegratorResponse
NxIntegratorResponse{
"id": "cfg_00291f7a",
"name": "Base Configuration",
"updatedAt": "2025-11-01T10:15:30Z"
}
📘 Field Reference
| Field | Type | Description |
|---|---|---|
id | string | Unique NX-generated identifier for the configuration entity. |
name | string | Internal or user-defined name for the entity. |
updatedAt | string (ISO 8601) | Timestamp of the most recent update. |
externalId | string, optional | External system identifier, if applicable. |
rate | number, optional | Percentage or multiplier rate (e.g., 0.85 for 15% discount). |
amount | number, optional | Absolute monetary amount associated with the configuration. |
parentId | string, optional | Reference to a parent configuration entity. |
type | string, optional | Entity type descriptor (e.g., MENU_ITEM, TAX, SALES_CATEGORY). |
prices | array, optional | List of related price records. Each item follows NxIntegratorApiBaseResponse. |
firstName | string, optional | Associated person’s first name, if relevant to the entity. |
lastName | string, optional | Associated person’s last name. |
isActive | boolean, optional | Indicates whether the configuration is currently active. |
businessDate | string (YYYY-MM-DD), optional | Effective business date for this configuration. |
displayName | string, optional | Human-readable display name for UI or reports. |