List Kitchen Orders | NaviPartner | NP Retail API Documentation

import requests
url = "https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./restaurant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/orders"
querystring = {"pageSize":"10"}
headers = {"x-np-api-key": "<NaviPartner API Key>"}
response = requests.get(url, headers=headers, params=querystring)
print(response.json())

{
  "morePages": true,
  "nextPageKey": "eyJSZXN0YXVyYW50IENvZGUiOiJCSVNUUk8wMSJ9",
  "nextPageURL": "/restaurant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/orders?pageSize=10&pageKey=eyJSZXN0YXVyYW50IENvZGUiOiJCSVNUUk8wMSJ9",
  "data": [
    {
      "orderId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "orderNo": 1001,
      "restaurantCode": "BISTRO01",
      "status": "Planned",
      "priority": 1,
      "onHold": false,
      "createdDateTime": "2024-01-15T14:30:00Z",
      "expectedDineDateTime": "2024-01-15T15:00:00Z",
      "finishedDateTime": ""
    }
  ]
}

Authentication

x-np-api-keystring

API Key authentication via header

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

restaurantIdUUIDRequired

The restaurant system ID

Query parameters

statusenumOptional

Filter by order status

pageSizeintegerOptional

Number of orders per page (max 100, default 50)

pageKeystringOptional

Page key for continuation (obtained from previous response nextPageKey)

Response

This endpoint returns an object.

morePagesboolean

Whether there are more pages available

nextPageKeystring

Page key for next page

nextPageURLstring

Full URL to fetch next page

datalist of objects

Kitchen orders for this page

Authentication

Path parameters

Headers

Query parameters

Response