> This page is for API Reference.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.navipartner.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.navipartner.com/_mcp/server.

# List Kitchen Orders

GET https://api.npretail.app/{tenant}/{environment}/{company}/restaurant/{restaurantId}/orders

Reference: https://docs.navipartner.com/apis/api-reference/restaurant/orders/get-kitchen-orders

## Authentication

- `x-np-api-key` header (required) — API Key authentication via header

## Request

### Path parameters

- `tenant` (string, required) — Your Entra Tenant ID. [More details.](/paths#1-tenant)
- `environment` (string, required) — Your Business Central Environment. [More details.](/paths#2-environment)
- `company` (string, required) — Your Business Central Company. [More details.](/paths#3-company)
- `restaurantId` (UUID, required) — The restaurant system ID

### Query parameters

- `status` (enum, optional) — Filter by order status
  - Allowed values: `Ready for Serving`, `In-Production`, `Released`, `Planned`, `Finished`, `Cancelled`
- `pageSize` (integer, optional) — Number of orders per page (max 100, default 50)
- `pageKey` (string, optional) — Page key for continuation (obtained from previous response nextPageKey)

## Response

### 200

- `morePages` (boolean, required) — Whether there are more pages available
- `nextPageKey` (string, required) — Page key for next page
- `nextPageURL` (string, required) — Full URL to fetch next page
- `data` (list of KitchenOrder, required) — Kitchen orders for this page

## Types

### KitchenOrder

Kitchen order with status and timing

- `orderId` (UUID, required) — Unique identifier (SystemId) of the kitchen order
- `orderNo` (long, required) — Kitchen order number
- `restaurantCode` (string, required) — Restaurant code
- `status` (enum, required) — Order status
  - Allowed values: `Ready for Serving`, `In-Production`, `Released`, `Planned`, `Finished`, `Cancelled`
- `priority` (integer, required) — Order priority
- `onHold` (boolean, required) — Whether order is on hold
- `createdDateTime` (string, optional) — When order was created (ISO 8601)
- `expectedDineDateTime` (string, optional) — When guest expects to dine (ISO 8601)
- `finishedDateTime` (string, optional) — When order was finished (ISO 8601)

## Examples

**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": ""
    }
  ]
}
```

**SDK Code**

```python ExampleGetKitchenOrders
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())
```

```javascript ExampleGetKitchenOrders
const url = 'https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./restaurant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/orders?pageSize=10';
const options = {method: 'GET', headers: {'x-np-api-key': '<NaviPartner API Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go ExampleGetKitchenOrders
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./restaurant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/orders?pageSize=10"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-np-api-key", "<NaviPartner API Key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby ExampleGetKitchenOrders
require 'uri'
require 'net/http'

url = URI("https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./restaurant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/orders?pageSize=10")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-np-api-key"] = '<NaviPartner API Key>'

response = http.request(request)
puts response.read_body
```

```java ExampleGetKitchenOrders
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./restaurant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/orders?pageSize=10")
  .header("x-np-api-key", "<NaviPartner API Key>")
  .asString();
```

```php ExampleGetKitchenOrders
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./restaurant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/orders?pageSize=10', [
  'headers' => [
    'x-np-api-key' => '<NaviPartner API Key>',
  ],
]);

echo $response->getBody();
```

```csharp ExampleGetKitchenOrders
using RestSharp;

var client = new RestClient("https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./restaurant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/orders?pageSize=10");
var request = new RestRequest(Method.GET);
request.AddHeader("x-np-api-key", "<NaviPartner API Key>");
IRestResponse response = client.Execute(request);
```

```swift ExampleGetKitchenOrders
import Foundation

let headers = ["x-np-api-key": "<NaviPartner API Key>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./restaurant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/orders?pageSize=10")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```