item resource type
Represents an item in Business Central.
Availability Information
This endpoint is only available if KatarGo is installed. Click here for the documentation without KatarGo.
Note
For information about enabling APIs for Business Central see Enabling the APIs for Dynamics 365 Business Central.
Methods
| Method | Return Type | Description |
|---|---|---|
| GET item | item | Gets an item object. |
| POST item | item | Creates an item object. |
| PATCH item | item | Updates an item object. |
| DELETE item | item | Deletes an item object |
Navigation
| Navigation | Return Type | Description |
|---|---|---|
| itemCategory | itemCategory | Gets the itemcategory of the item. |
| inventoryPostingGroup | inventoryPostingGroup | Gets the inventorypostinggroup of the item. |
| generalProductPostingGroup | generalProductPostingGroup | Gets the generalproductpostinggroup of the item. |
| unitOfMeasureWebCon | unitOfMeasureWebCon | Gets the unitofmeasure of the item. |
| picture | picture | Gets the picture of the item. |
| defaultDimension | defaultDimensions | Gets the defaultdimensions of the item. |
| itemVariant | itemVariants | Gets the itemvariants of the item. |
| itemSalesPriceKTG | itemSalesPricesKTG | Gets the itemSalesPricesKTG of the item |
| itemCrossSellingWebCon | itemCrossSellingsWebCon | Gets the itemCrossSellingsWebCon of the item |
| itemVendorWebCon | itemVendorWebCon | Gets the itemVendorWebCon of the item |
| itemTranslationWebCon | itemTranslationWebCon | Gets the itemTranslationWebCon of the item |
| itemAttributeValueMappingWebCon | itemAttributeValueMappingWebCon | Gets the itemAttributeValueMappingWebCon of the item |
| itemReferenceWebCon | itemReferencesWebCon | Gets the itemReferencesWebCon of the item |
| itemProductTextsKTG | itemProductTextsKTG | Gets the itemProductTextsKTG of the item |
Properties
| Property | Type | Description | Max Length |
|---|---|---|---|
| 🔑 id | GUID | The unique ID of the item. Non-editable. | |
| itemTemplate | string | Specifies the item template code. | 20 |
| number | string | Specifies the number of the item. | 20 |
| number2 | string | Specifies the number 2 of the item. | 20 |
| displayName | string | Specifies the item's name. This name will appear on all sales documents for the item. | 100 |
| displayName2 | string | Specifies the item's name 2. | 50 |
| searchDescription | string | Search description. This value is generated in NAV for indexing purposes. | 100 |
| type | NAV.itemType | Specifies the type of the item. It can be "Inventory", "Service" or "Non-Inventory". | |
| itemCategoryId | GUID | The ID of the item category in the item. | |
| itemCategoryCode | string | The code of the item category in the item. | 20 |
| expirationCalculation | string | Indicates date formula when this item will expire. | |
| commonItemNo | string | Specifies another item no. that ist common between the systems. | 20 |
| blocked | boolean | Specifies that entries cannot be posted to the item. True indicates account is blocked and posting is not allowed. | |
| gtin | string | This is the Global Trade Item Number. | 14 |
| inventory | decimal | Specifies how many units, such as pieces, boxes, or cans, of the item are in inventory. Read-Only. | |
| unitPrice | decimal | Specifies the price for one unit of the item in the specified item. | |
| unitListPrice | decimal | ||
| vatProductPostingGroup | string | Specifies the VAT product posting group of the item. | 20 |
| priceIncludesTax | boolean | Specifies that the unitPrice includes tax. Set to true, if unitPrice includes tax. | |
| vatBusPostingGrPrice | string | Specifies a VAT business posting group for customers for whom you want the item price including VAT, as shown in the Unit Price field, to apply. | 20 |
| unitCost | decimal | The unit cost of each individual item in the item. | |
| taxGroupId | GUID | Specifies the ID of the Tax Group for the item. | |
| taxGroupCode | string | A Tax Group represents a group of inventory items or resources that are subject to identical tax terms. | 20 |
| baseUnitOfMeasureId | GUID | Specifies the ID of the unit of measure. | |
| baseUnitOfMeasureCode | string | The item's base unit of measure code. | 10 |
| generalProductPostingGroupId | GUID | Specifies the ID of the general product posting group of the item. | |
| generalProductPostingGroupCode | string | Specifies the general product posting group of the item. | 20 |
| inventoryPostingGroupId | GUID | Specifies the ID of the inventory posting group of the item. | |
| inventoryPostingGroupCode | string | Specifies the inventory posting group of the item. | 20 |
| grossWeight | decimal | The gross weight of each individual item in the item. | |
| netWeight | decimal | The net weight of each individual item in the item. | |
| unitVolume | decimal | The unit volume of each individual item in the item. | |
| salesUnitOfMeasure | string | The item's sales unit of measure code. | 10 |
| freightType | string | The item's freight type. | 10 |
| tariffNo | string | The item's tariff no. | 20 |
| countryPurchasedCode | string | Specifies the country of purchase of the item. | 10 |
| countryOriginCode | string | Specifies the country of origin of the item. | b |
| manufacturerCode | string | Specifies the manufacturer of the item. | 10 |
| webshopItem | boolean | Specifies if the item is a webshop item. | |
| itemDiscountGroup | string | Specifies the item discount group of the item. | 20 |
| responsibilityCenter | string | Specifies the responsibility center for this item. | 10 |
| vendorNo | string | Specifies the vendor code of who supplies this item by default. | 20 |
| vendorItemNo | string | Specifies the number that the vendor uses for this item. | 50 |
| statusCode | string | Indicates the status of the item. The status code is a flexible status indicator. It can be used, for example, to block items or publish them for marketplaces. You can also store texts that are displayed during document processing. | 10 |
| listCost | decimal | Specifies the list cost of the item. | |
| brandCode | string | Specifies the brand code of the item. | 10 |
| seasonCode | string | Specifies the season code for the item. This field can be used to select from the defined seasons. | 10 |
| isMasterItem | boolean | Specifies that this is a master item. | |
| masterItemNumber | string | Specifies the number of the master item. | 20 |
| lastModifiedDateTime | datetime | The last datetime the item was modified. Read-Only. |