GET v1/items/{id}

Gets Item details by id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Provide Item id to get details for

integer

Required

Body Parameters

None.

Response Information

Resource Description

Item
NameDescriptionTypeAdditional information
Id

Read-only. Item unique id - auto generated by the system.

integer

None.

Name

Item Name. Must be unique.

string

Required

ItemNumber

Item Number.

string

None.

ItemType

Item Type. Read-only for existing items. Available types: Inventory, Non Inventory, Service, Item Group, Discount, Fixed Asset, and Manufactured.

IdNamePair

Required

Category

Item Category.

IdNamePair

None.

Division

Division.

IdNamePair

None.

PreferredVendor

Preferred Vendor. Available for Inventory and Non Inventory item types only.

VendorRef

None.

Manufacturer

Manufacturer. Available for Inventory, Non Inventory, and Manufactured item types only.

VendorRef

None.

ManufacturePartNumber

Manufacturer Part Number. Available for Inventory, Non Inventory, and Manufactured item types only.

string

None.

Description

Description. Used on transaction line items when item is selected.

string

None.

InternalNotes

Internal Notes.

Note

None.

Price

Item Price. Available for Inventory, Non Inventory, Service, and Manufactured item types only.

decimal number

None.

Cost

Item Cost. Available for Inventory, Non Inventory, Service, and Manufactured item types only.

decimal number

None.

Taxable

Taxable. Available for Inventory, Non Inventory, Service, Item Group, and Manufactured item types only.

boolean

None.

Weight

Weight. Available for Inventory, Non Inventory, Service, and Fixed Asset item types only.

decimal number

Range: inclusive between 0 and 1.79769313486232E+308

IsShippingRequired

Is Shipping Required. Available for Inventory, Non Inventory, Service, and Fixed Asset item types only.

boolean

None.

ShippingPrice

Shipping Price. Available for Inventory, Non Inventory, Service, and Fixed Asset item types only.

decimal number

None.

ShippingPerc

Shipping Perc. Available for Inventory, Non Inventory, Service, and Fixed Asset item types only.

decimal number

None.

IncomeGLAccount

Income GL Account. Available for Inventory, Non Inventory, Service, Discount, Fixed Asset and Manufactured item types only. The default GL Account will be used if not provided.

IdNamePair

None.

InventoryAssetGLAccount

Inventory Asset GL Account. Available for Inventory, and Manufactured item types only. The default Asset Account will be used if not provided.

IdNamePair

None.

COGSGLAccount

COGS GL Account. Available for Inventory, and Manufactured item types only. The default COGS Account will be used if not provided.

IdNamePair

None.

ExpenseGLAccount

Expense GL Account. Available for Non Inventory, Service item types only. The default Expense Account will be used if not provided.

IdNamePair

None.

DefaultGLCategory

Default GL Category. Available for Inventory, Non Inventory, Service, Discount, Fixed Asset and Manufactured item types only.

IdNamePair

None.

DefaultInventoryLocation

Default Inventory Location. Available for Inventory, and Manufactured item types only.

IdNamePair

None.

RelatedAsset

Related Asset. Available for Fixed Asset item type only.

IdNamePair

None.

AllowVendorToIncludeInBill

Allow Vendor To Include In Bill.

boolean

None.

ReorderPoint

Reorder Point. Available for Inventory item type only.

decimal number

None.

QtyOnHand

Read-only. Available for Inventory, and Manufactured item types only. The quantity is calculated as of today and is not location specific.

decimal number

None.

QtyAvailable

Read-only. Available for Inventory, and Manufactured item types only. The quantity is calculated as of today and is not location specific.

decimal number

None.

BaseUnitOfMeasure

Read-only. Base Unit of Measure. Available for Inventory, Non-Inventory, Service, Fixed Asset, and Manufactured item types and only applicable if Unit of Measure tracking is enabled Id: Base Unit of Measure Id of the Unit of Measure set configured at the item level Name: Base Unit of Measure Abbreviation ExtendedName: Base Unit of Measure full name

LongIdNameExtended

None.

BarcodeValue

Barcode value. Must be unique.

string

None.

MaxQuantity

Max Quantity to stock. Available for Inventory and Manufactured item types only.

decimal number

None.

GroupItems

Component items of the group. Available for Item Group and Manufactured item types only.

Collection of GroupItem

None.

CustomFields

Item Custom Fields.

Collection of CustomField

None.

Active

Read-only. Indicates whether the item is active or not.

boolean

None.

DateCreated

Read-only. The date and time (in company time zone) when the item was created.

date

None.

CreatedBy

The person who created the item.

IdNamePair

None.

LastUpdatedDate

Read-only. The date and time (in company time zone) when the bill was last updated.

date

None.

LastUpdatedBy

The person who last updated the item.

IdNamePair

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "name": "sample string 2",
  "itemNumber": "sample string 3",
  "itemType": {
    "id": 1,
    "name": "sample string 2"
  },
  "category": {
    "id": 1,
    "name": "sample string 2"
  },
  "division": {
    "id": 1,
    "name": "sample string 2"
  },
  "preferredVendor": {
    "id": 1,
    "number": "sample string 2",
    "name": "sample string 3"
  },
  "manufacturer": {
    "id": 1,
    "number": "sample string 2",
    "name": "sample string 3"
  },
  "manufacturePartNumber": "sample string 4",
  "description": "sample string 5",
  "internalNotes": {
    "id": 1,
    "notesHtml": "sample string 2",
    "notesText": "sample string 3"
  },
  "price": 6.0,
  "cost": 7.0,
  "taxable": true,
  "weight": 9.0,
  "isShippingRequired": true,
  "shippingPrice": 11.0,
  "shippingPerc": 12.1,
  "incomeGLAccount": {
    "id": 1,
    "name": "sample string 2"
  },
  "inventoryAssetGLAccount": {
    "id": 1,
    "name": "sample string 2"
  },
  "cogsglAccount": {
    "id": 1,
    "name": "sample string 2"
  },
  "expenseGLAccount": {
    "id": 1,
    "name": "sample string 2"
  },
  "defaultGLCategory": {
    "id": 1,
    "name": "sample string 2"
  },
  "defaultInventoryLocation": {
    "id": 1,
    "name": "sample string 2"
  },
  "relatedAsset": {
    "id": 1,
    "name": "sample string 2"
  },
  "allowVendorToIncludeInBill": true,
  "reorderPoint": 14.0,
  "qtyOnHand": 1.0,
  "qtyAvailable": 1.0,
  "baseUnitOfMeasure": {
    "extendedName": "sample string 1",
    "id": 2,
    "name": "sample string 3"
  },
  "barcodeValue": "sample string 15",
  "maxQuantity": 1.0,
  "groupItems": [
    {
      "id": 1,
      "item": {
        "id": 1,
        "name": "sample string 2"
      },
      "itemType": {
        "id": 1,
        "name": "sample string 2"
      },
      "qty": 2.0,
      "price": 3.0,
      "glCategory": {
        "id": 1,
        "name": "sample string 2"
      },
      "inventoryLocation": {
        "id": 1,
        "name": "sample string 2"
      },
      "unitOfMeasure": {
        "extendedName": "sample string 1",
        "id": 2,
        "name": "sample string 3"
      }
    },
    {
      "id": 1,
      "item": {
        "id": 1,
        "name": "sample string 2"
      },
      "itemType": {
        "id": 1,
        "name": "sample string 2"
      },
      "qty": 2.0,
      "price": 3.0,
      "glCategory": {
        "id": 1,
        "name": "sample string 2"
      },
      "inventoryLocation": {
        "id": 1,
        "name": "sample string 2"
      },
      "unitOfMeasure": {
        "extendedName": "sample string 1",
        "id": 2,
        "name": "sample string 3"
      }
    }
  ],
  "customFields": [
    {
      "id": 1,
      "name": "sample string 2",
      "fieldType": {
        "id": 1,
        "name": "sample string 2"
      },
      "sourceId": 3,
      "value": "sample string 4",
      "valueText": "sample string 5",
      "isRequired": true
    },
    {
      "id": 1,
      "name": "sample string 2",
      "fieldType": {
        "id": 1,
        "name": "sample string 2"
      },
      "sourceId": 3,
      "value": "sample string 4",
      "valueText": "sample string 5",
      "isRequired": true
    }
  ],
  "active": true,
  "dateCreated": "2022-07-01T16:09:58.8338929-04:00",
  "createdBy": {
    "id": 1,
    "name": "sample string 2"
  },
  "lastUpdatedDate": "2022-07-01T16:09:58.8338929-04:00",
  "lastUpdatedBy": {
    "id": 1,
    "name": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<Item xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models.Accounting">
  <Active>true</Active>
  <AllowVendorToIncludeInBill>true</AllowVendorToIncludeInBill>
  <BarcodeValue>sample string 15</BarcodeValue>
  <BaseUnitOfMeasure xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>2</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 3</d2p1:_x003C_Name_x003E_k__BackingField>
    <d2p1:ExtendedName>sample string 1</d2p1:ExtendedName>
  </BaseUnitOfMeasure>
  <COGSGLAccount xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </COGSGLAccount>
  <Category xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </Category>
  <Cost>7</Cost>
  <CreatedBy xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </CreatedBy>
  <CustomFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
    <d2p1:CustomField>
      <d2p1:FieldType xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:FieldType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsRequired>true</d2p1:IsRequired>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:SourceId>3</d2p1:SourceId>
      <d2p1:Value>sample string 4</d2p1:Value>
      <d2p1:ValueText>sample string 5</d2p1:ValueText>
    </d2p1:CustomField>
    <d2p1:CustomField>
      <d2p1:FieldType xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:FieldType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsRequired>true</d2p1:IsRequired>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:SourceId>3</d2p1:SourceId>
      <d2p1:Value>sample string 4</d2p1:Value>
      <d2p1:ValueText>sample string 5</d2p1:ValueText>
    </d2p1:CustomField>
  </CustomFields>
  <DateCreated>2022-07-01T16:09:58.8338929-04:00</DateCreated>
  <DefaultGLCategory xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </DefaultGLCategory>
  <DefaultInventoryLocation xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </DefaultInventoryLocation>
  <Description>sample string 5</Description>
  <Division xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </Division>
  <ExpenseGLAccount xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </ExpenseGLAccount>
  <GroupItems>
    <GroupItem>
      <GLCategory xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </GLCategory>
      <Id>1</Id>
      <InventoryLocation xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </InventoryLocation>
      <Item xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </Item>
      <ItemType xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </ItemType>
      <Price>3</Price>
      <Qty>2</Qty>
      <UnitOfMeasure xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>2</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 3</d4p1:_x003C_Name_x003E_k__BackingField>
        <d4p1:ExtendedName>sample string 1</d4p1:ExtendedName>
      </UnitOfMeasure>
    </GroupItem>
    <GroupItem>
      <GLCategory xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </GLCategory>
      <Id>1</Id>
      <InventoryLocation xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </InventoryLocation>
      <Item xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </Item>
      <ItemType xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </ItemType>
      <Price>3</Price>
      <Qty>2</Qty>
      <UnitOfMeasure xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>2</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 3</d4p1:_x003C_Name_x003E_k__BackingField>
        <d4p1:ExtendedName>sample string 1</d4p1:ExtendedName>
      </UnitOfMeasure>
    </GroupItem>
  </GroupItems>
  <Id>1</Id>
  <IncomeGLAccount xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </IncomeGLAccount>
  <InternalNotes xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
    <d2p1:Id>1</d2p1:Id>
    <d2p1:NotesHtml>sample string 2</d2p1:NotesHtml>
    <d2p1:NotesText>sample string 3</d2p1:NotesText>
  </InternalNotes>
  <InventoryAssetGLAccount xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </InventoryAssetGLAccount>
  <IsShippingRequired>true</IsShippingRequired>
  <ItemNumber>sample string 3</ItemNumber>
  <ItemType xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </ItemType>
  <LastUpdatedBy xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </LastUpdatedBy>
  <LastUpdatedDate>2022-07-01T16:09:58.8338929-04:00</LastUpdatedDate>
  <ManufacturePartNumber>sample string 4</ManufacturePartNumber>
  <Manufacturer xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:Id>1</d2p1:Id>
    <d2p1:Name>sample string 3</d2p1:Name>
    <d2p1:Number>sample string 2</d2p1:Number>
  </Manufacturer>
  <MaxQuantity>1</MaxQuantity>
  <Name>sample string 2</Name>
  <PreferredVendor xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:Id>1</d2p1:Id>
    <d2p1:Name>sample string 3</d2p1:Name>
    <d2p1:Number>sample string 2</d2p1:Number>
  </PreferredVendor>
  <Price>6</Price>
  <QtyAvailable>1</QtyAvailable>
  <QtyOnHand>1</QtyOnHand>
  <RelatedAsset xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </RelatedAsset>
  <ReorderPoint>14</ReorderPoint>
  <ShippingPerc>12.1</ShippingPerc>
  <ShippingPrice>11</ShippingPrice>
  <Taxable>true</Taxable>
  <Weight>9</Weight>
</Item>