item resource type

Represents an item in Business Central.

Note

For information about enabling APIs for Business Central see Enabling the APIs for Dynamics 365 Business Central.

Methods

MethodReturn TypeDescription
GET itemitemGets an item object.
DELETE itemnoneDeletes an item object.
POST itemitemCreates an item object.
PATCH itemitemUpdates an item object.
NavigationReturn TypeDescription
itemCategoryitemCategoryGets the itemcategory of the item.
inventoryPostingGroupinventoryPostingGroupGets the inventorypostinggroup of the item.
generalProductPostingGroupgeneralProductPostingGroupGets the generalproductpostinggroup of the item.
unitOfMeasureunitOfMeasureGets the unitofmeasure of the item.
picturepictureGets the picture of the item.
defaultDimensionsdefaultDimensionsGets the defaultdimensions of the item.
itemVariantsitemVariantsGets the itemvariants of the item.
documentAttachmentsdocumentAttachmentsGets the documentattachments of the item.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the item. Non-editable.
numberstringSpecifies the number of the item.
displayNamestringSpecifies the item's name. This name will appear on all sales documents for the item.
displayName2string
typeNAV.itemTypeSpecifies the type of the item. It can be "Inventory", "Service" or "Non-Inventory".
itemCategoryIdGUIDThe ID of the item category in the item.
itemCategoryCodestringThe code of the item category in the item.
blockedbooleanSpecifies that entries can't be posted to the item. True indicates account is blocked and posting is not allowed.
gtinstringThis is the Global Trade Item Number.
inventorydecimalSpecifies how many units, such as pieces, boxes, or cans, of the item are in inventory. Read-Only.
unitPricedecimalSpecifies the price for one unit of the item in the specified item.
priceIncludesTaxbooleanSpecifies that the unitPrice includes tax. Set to true, if unitPrice includes tax.
unitCostdecimalThe unit cost of each individual item in the item.
taxGroupIdGUIDSpecifies the ID of the Tax Group for the item.
taxGroupCodestringA Tax Group represents a group of inventory items or resources that are subject to identical tax terms.
baseUnitOfMeasureIdGUIDSpecifies the ID of the unit of measure.
baseUnitOfMeasureCodestringThe item's base unit of measure code.
generalProductPostingGroupIdGUID
generalProductPostingGroupCodestring
inventoryPostingGroupIdGUID
inventoryPostingGroupCodestring
lastModifiedDateTimedatetimeThe last datetime the item was modified. Read-Only.

JSON representation

Here's a JSON representation of the item resource.

{
    "id": "GUID",
    "number": "string",
    "displayName": "string",
    "displayName2": "string",
    "type": "NAV.itemType",
    "itemCategoryId": "GUID",
    "itemCategoryCode": "string",
    "blocked": "boolean",
    "gtin": "string",
    "inventory": "decimal",
    "unitPrice": "decimal",
    "priceIncludesTax": "boolean",
    "unitCost": "decimal",
    "taxGroupId": "GUID",
    "taxGroupCode": "string",
    "baseUnitOfMeasureId": "GUID",
    "baseUnitOfMeasureCode": "string",
    "generalProductPostingGroupId": "GUID",
    "generalProductPostingGroupCode": "string",
    "inventoryPostingGroupId": "GUID",
    "inventoryPostingGroupCode": "string",
    "lastModifiedDateTime": "datetime"
}

GET item
DELETE item
POST item
PATCH item