Get Items

GET

https://api.npretail.app/:tenant/:environment/:company/inventory/item

GET

/:tenant/:environment/:company/inventory/item

curl -G https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./inventory/item \
     -H "x-np-api-key: <NaviPartner API Key>" \
     -d pageSize=50 \
     -d withAttributes=true \
     -d withVariants=true

{
  "morePages": true,
  "nextPageKey": "c29tZSBiYXNlNjQgc3RyaW5n",
  "nextPageURL": "https://api.npretail.app/tenant/env/company/inventory/item?pageSize=50&withAttributes=true&withVariants=true&pageKey=c29tZSBiYXNlNjQgc3RyaW5n",
  "data": [
    {
      "baseUnitOfMeasure": "PCS",
      "code": "A1000",
      "crossVarietyNo": "Variety1",
      "description": "Office Chair",
      "description2": "Ergonomic Design",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "itemCategoryCode": "CHAIR",
      "itemDiscGroup": "FURNITURE",
      "unitPrice": 4000,
      "variety1": "COLOR",
      "variety1Table": "COLOR-STD",
      "variety2": "SIZE",
      "variety2Table": "SIZE-EU",
      "variety3": "",
      "variety3Table": "",
      "variety4": "",
      "variety4Table": "",
      "varietyGroup": "CHAIRS",
      "vatProdPostingGroup": "STANDARD",
      "vendorItemNo": "ADG-4577",
      "vendorNo": "01587796",
      "attributes": {
        "Color": "Black",
        "Depth": 70,
        "Width": 75,
        "Height": 100,
        "Material Description": "Leather, Satin Polished Aluminum base"
      },
      "entriaProduct": true,
      "variants": [
        {
          "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
          "variantCode": "RED-42",
          "description": "Office Chair - Red 42",
          "description2": "",
          "blocked": false,
          "variety1": "COLOR",
          "variety1Table": "COLOR-STD",
          "variety1Value": "RED",
          "variety2": "SIZE",
          "variety2Table": "SIZE-EU",
          "variety2Value": "42",
          "variety3": "",
          "variety3Table": "",
          "variety3Value": "",
          "variety4": "",
          "variety4Table": "",
          "variety4Value": ""
        },
        {
          "id": "16fd2706-8baf-433b-82eb-8c7fada847da",
          "variantCode": "BLACK-44",
          "description": "Office Chair - Black 44",
          "description2": "",
          "blocked": true,
          "variety1": "COLOR",
          "variety1Table": "COLOR-STD",
          "variety1Value": "BLACK",
          "variety2": "SIZE",
          "variety2Table": "SIZE-EU",
          "variety2Value": "44",
          "variety3": "",
          "variety3Table": "",
          "variety3Value": "",
          "variety4": "",
          "variety4Table": "",
          "variety4Value": ""
        }
      ]
    },
    {
      "baseUnitOfMeasure": "PCS",
      "code": "A1000",
      "crossVarietyNo": "Variety1",
      "description": "Office Chair",
      "description2": "Ergonomic Design",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "itemCategoryCode": "CHAIR",
      "itemDiscGroup": "FURNITURE",
      "unitPrice": 4000,
      "variety1": "COLOR",
      "variety1Table": "COLOR-STD",
      "variety2": "SIZE",
      "variety2Table": "SIZE-EU",
      "variety3": "",
      "variety3Table": "",
      "variety4": "",
      "variety4Table": "",
      "varietyGroup": "CHAIRS",
      "vatProdPostingGroup": "STANDARD",
      "vendorItemNo": "ADG-4577",
      "vendorNo": "01587796",
      "attributes": {
        "Color": "Black",
        "Depth": 70,
        "Width": 75,
        "Height": 100,
        "Material Description": "Leather, Satin Polished Aluminum base"
      },
      "entriaProduct": true,
      "variants": [
        {
          "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
          "variantCode": "RED-42",
          "description": "Office Chair - Red 42",
          "description2": "",
          "blocked": false,
          "variety1": "COLOR",
          "variety1Table": "COLOR-STD",
          "variety1Value": "RED",
          "variety2": "SIZE",
          "variety2Table": "SIZE-EU",
          "variety2Value": "42",
          "variety3": "",
          "variety3Table": "",
          "variety3Value": "",
          "variety4": "",
          "variety4Table": "",
          "variety4Value": ""
        },
        {
          "id": "16fd2706-8baf-433b-82eb-8c7fada847da",
          "variantCode": "BLACK-44",
          "description": "Office Chair - Black 44",
          "description2": "",
          "blocked": true,
          "variety1": "COLOR",
          "variety1Table": "COLOR-STD",
          "variety1Value": "BLACK",
          "variety2": "SIZE",
          "variety2Table": "SIZE-EU",
          "variety2Value": "44",
          "variety3": "",
          "variety3Table": "",
          "variety3Value": "",
          "variety4": "",
          "variety4Table": "",
          "variety4Value": ""
        }
      ]
    }
  ]
}

Get a list of items with pagination

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.

Query parameters

itemCodestringOptional

pageSizeintegerOptional

pageKeystringOptional

lastRowVersionstringOptional

syncbooleanOptional

withAttributesbooleanOptional

Indicates whether the item attributes should be included in the response.

withVariantsbooleanOptional

Indicates whether the item variants, with their variety values, should be included in each item as variants. Off by default. It adds one variant read per item, so with withVariants=true a page holds at most 1000 items, and a larger or missing pageSize is set to 1000. Use nextPageKey to read the next page.

Cannot be combined with sync=true, which returns 400. A new or changed variant does not change the item’s rowVersion, so an item sync would miss it. To keep variants up to date, sync GET /inventory/itemvariant instead.

Response

This endpoint returns an object.

morePagesboolean

nextPageKeystring

nextPageURLstring

datalist of objects

Errors

400

Bad Request

Authentication

Path parameters

Headers

Query parameters

Response

Errors