> 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.

# Get Item Variants

GET https://api.npretail.app/{tenant}/{environment}/{company}/inventory/itemvariant

Get a list of item variants with pagination

Reference: https://docs.navipartner.com/apis/api-reference/inventory/itemvariant/get-item-variants

## 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)

### Query parameters

- `itemCode` (string, optional)
- `pageSize` (integer, optional)
- `pageKey` (string, optional)
- `lastRowVersion` (string, optional)
- `sync` (boolean, optional)

## Response

### 200

- `morePages` (boolean, required)
- `nextPageKey` (string, required)
- `nextPageURL` (string, required)
- `data` (list of ItemVariant, required)

## Types

### ItemVariant

Represents an item variant in the system. A variant has up to four variety positions. Each position holds the variety (for example `COLOR`), the variety table (the value set, for example `COLOR-STD`) and the value (for example `RED`). Unused positions are empty strings. To get display names and sort order, match `varietyN`, `varietyNTable` and `varietyNValue` to `type`, `table` and `value` in `GET /inventory/varietyvalue`.

- `id` (UUID, required)
- `itemCode` (string, required)
- `variantCode` (string, required)
- `description` (string, required)
- `description2` (string, required)
- `blocked` (boolean, required) — Whether the variant is blocked in Business Central. Blocked variants are still returned so a sync client sees the change; hide them in your shop.
- `variety1` (string, required) — Variety code of position 1. Matches `code` in `GET /inventory/variety`.
- `variety1Table` (string, required) — Variety table code of position 1. Matches `code` in `GET /inventory/varietytable`.
- `variety1Value` (string, required) — Variety value of position 1. Matches `value` in `GET /inventory/varietyvalue`.
- `variety2` (string, required)
- `variety2Table` (string, required)
- `variety2Value` (string, required)
- `variety3` (string, required)
- `variety3Table` (string, required)
- `variety3Value` (string, required)
- `variety4` (string, required)
- `variety4Table` (string, required)
- `variety4Value` (string, required)
- `rowVersion` (string, optional)

## Examples

**Response**

```json
{
  "morePages": true,
  "nextPageKey": "c29tZSBiYXNlNjQgc3RyaW5n",
  "nextPageURL": "https://api.npretail.app/tenant/env/company/inventory/itemvariant?pageKey=c29tZSBiYXNlNjQgc3RyaW5n&lastRowVersion=12345678901234567890",
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "itemCode": "A1000",
      "variantCode": "RED-42",
      "description": "Office Chair - Red 42",
      "description2": "Ergonomic Design - Red Color",
      "blocked": false,
      "variety1": "COLOR",
      "variety1Table": "COLOR-STD",
      "variety1Value": "RED",
      "variety2": "SIZE",
      "variety2Table": "SIZE-EU",
      "variety2Value": "42",
      "variety3": "",
      "variety3Table": "",
      "variety3Value": "",
      "variety4": "",
      "variety4Table": "",
      "variety4Value": "",
      "rowVersion": "12345678901234567890"
    },
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "itemCode": "A1000",
      "variantCode": "RED-42",
      "description": "Office Chair - Red 42",
      "description2": "Ergonomic Design - Red Color",
      "blocked": false,
      "variety1": "COLOR",
      "variety1Table": "COLOR-STD",
      "variety1Value": "RED",
      "variety2": "SIZE",
      "variety2Table": "SIZE-EU",
      "variety2Value": "42",
      "variety3": "",
      "variety3Table": "",
      "variety3Value": "",
      "variety4": "",
      "variety4Table": "",
      "variety4Value": "",
      "rowVersion": "12345678901234567890"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./inventory/itemvariant"

querystring = {"itemCode":"A1000","pageSize":"50"}

headers = {"x-np-api-key": "<NaviPartner API Key>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./inventory/itemvariant?itemCode=A1000&pageSize=50';
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
package main

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

func main() {

	url := "https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./inventory/itemvariant?itemCode=A1000&pageSize=50"

	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
require 'uri'
require 'net/http'

url = URI("https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./inventory/itemvariant?itemCode=A1000&pageSize=50")

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
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./inventory/itemvariant?itemCode=A1000&pageSize=50")
  .header("x-np-api-key", "<NaviPartner API Key>")
  .asString();
```

```php
<?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./inventory/itemvariant?itemCode=A1000&pageSize=50', [
  'headers' => [
    'x-np-api-key' => '<NaviPartner API Key>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./inventory/itemvariant?itemCode=A1000&pageSize=50");
var request = new RestRequest(Method.GET);
request.AddHeader("x-np-api-key", "<NaviPartner API Key>");
IRestResponse response = client.Execute(request);
```

```swift
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./inventory/itemvariant?itemCode=A1000&pageSize=50")! 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()
```