Get Item

GET

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

GET

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

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

200Retrieved

{
  "baseUnitOfMeasure": "PCS",
  "code": "A1000",
  "crossVarietyNo": "Variety1",
  "description": "Office Chair",
  "description2": "Ergonomic Design",
  "hasVariants": true,
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "inventory": 42,
  "itemCategoryCode": "CHAIR",
  "itemDiscGroup": "FURNITURE",
  "rowVersion": "12345678901234567890",
  "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"
  },
  "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 an item by its code

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.

idstringRequired

The unique identifier for an item.

Query parameters

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 the response as variants. Off by default.

Response

This endpoint returns an object.

baseUnitOfMeasurestring

codestring

crossVarietyNoenum

The variety position used as the cross variety. The value is the same in every language.

Allowed values:

descriptionstring

description2string

hasVariantsboolean

idUUID

inventorydouble

itemCategoryCodestring

itemDiscGroupstring

rowVersionstring

unitPricedouble

variety1string

Variety code of position 1. Matches code in GET /inventory/variety.

variety1Tablestring

Variety table code of position 1. Matches code in GET /inventory/varietytable.

variety2string

variety2Tablestring

variety3string

variety3Tablestring

variety4string

variety4Tablestring

varietyGroupstring

vatProdPostingGroupstring

vendorItemNostring

vendorNostring

attributesmap from strings to anyOptional

variantslist of objectsOptional

Returned only when withVariants=true.

Authentication

Path parameters

Headers

Query parameters

Response