Menu Items

get

http://{{apiurl}}/api/v1/configuration/menuitems

Purpose
Retrieve a paginated list of menu items configured for a specific venue.

HTTP
GET {{apiUrl}}/api/v1/configuration/menuitems

Path params

None

Query params

venueId (required, UUID): The venue to fetch menu items for.
limit (optional, integer): Number of records to return per page. Default/typical: 20.
cursor (optional, string): Opaque pagination cursor returned by a previous response. Use it to fetch the next page.

Variables required

base_url: Base URL for the NXR API environment.
nx_integrator_api_key: API key credential (stored as a variable).
nx_integrator_api_secret: API secret credential (stored as a variable).

Authentication

Inherit from parent collection/folder, or configure per your environment using the provided variables.

Sample Response

{
    "records":
    [
        {
            "id": "0001b319-3922-4114-9b8d-4bcd9d2b3428",
            "updatedAt": "2025-05-22T20:53:38.492Z",
            "name": "Shr Sca",
            "displayName": "Shrimp Scampi",
            "parentId": "48d62656-03a9-4d2f-850a-1ffb1f424352",
            "externalId": "SHRIMP_12345"
        }
    ],
    "cursor": "",
    "length": 20,
    "status": "SUCCESS",
    "count": 20
}

Notes

Use GET to list menu items for a venue. Include the venueId query param. Optional pagination via limit and cursor.

Model:

id: The ID of the Menu Item
updatedAt: The datetime that the record was last modified
name: The POS name of the Menu Item. This may differ from what is displayed on guest facing.
displayName: The name that may be displayed to the guest (optional)
parentId: The Sales Category that the Menu Item belongs to
externalId: A third-party or external ID of the item (optional)