Encompasses the details about an item that is used in Inventory Control, Order Entry, and/or Purchasing.


List Items

readByQuery

<readByQuery>
    <object>ITEM</object>
    <fields>*</fields>
    <query></query>
    <pagesize>100</pagesize>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use ITEM
fields Optional string Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.
query Required string SQL-like query based on fields on the object. Illegal XML characters must be properly encoded. The following SQL operators are supported: <, >, >=, <=, =, like, not like, in, not in. When doing NULL comparisons: IS NOT NULL, IS NULL. Multiple fields may be matched using the AND and OR operators. Joins are not supported. Single quotes in any operands must be escaped with a backslash - For example, the value Erik's Deli would become 'Erik\'s Deli'.
pagesize Optional integer Custom page size between 1 and 1000 items (Default: 100)

query

Name Required Type Description
ITEMTYPE Optional string Item type. Use I for Inventory, NI for Non-Inventory, NP for Non-Inventory (Purchase only), NS for Non-Inventory (Sales only), K for Kit, or SK for Stockable Kit.
COST_METHOD Optional string Cost method. Use S for Standard, A for Average, F for FIFO, or L for LIFO.
VSOECATEGORY Optional string VSOE category. Use PSD for Product - Specified, SFW for Software, PUS for Product - Unspecified, UUS for Upgrade - Unspecified, USD for Upgrade - Specified, SVR for Services, or PCS for Post Contract Support(PCS).
VSOEDLVRSTATUS Optional string VSOE default delivery status. Use D for Delivered or U for Undelivered.
VSOEREVDEFSTATUS Optional string VSOE default deferral status. Use I for Defer until item is delivered or B for Defer bundle until item is delivered.
REVPOSTING Optional string Kit revenue posting. Use I for Component Level or K for Kit Level.
REVPRINTING Optional string Kit print format. Use I for Individual Components or K for Kit.
TERMPERIOD Optional string Periods measured in. Use D for Days, W for Weeks, M for Months, or Y for Years.

Get Item

read

<read>
    <object>ITEM</object>
    <keys>1</keys>
    <fields>*</fields>
</read>

Parameters

Name Required Type Description
object Required string Use ITEM
keys Required string Item RECORDNO to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.

Get Item by Name

readByName

<readByName>
    <object>ITEM</object>
    <keys>I1234</keys>
    <fields>*</fields>
</readByName>

Parameters

Name Required Type Description
object Required string Use ITEM
keys Required string Item ITEMID to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.

Create Item

create

<create>
    <ITEM>
        <ITEMID>I1234</ITEMID>
        <NAME>hello world</NAME>
        <ITEMTYPE>Inventory</ITEMTYPE>
    </ITEM>
</create>

Parameters

Name Required Type Description
ITEM Optional object Object to create

ITEM

Name Required Type Description
ITEMID Required string Item ID to create
NAME Required string Item name
ITEMTYPE Required string Item type. Use Inventory, Non-Inventory, Non-Inventory (Purchase only), Non-Inventory (Sales only), Kit, or Stockable Kit.
STATUS Optional string Status. Use active for Active otherwise use inactive for Inactive. (Default: active)
PRODUCTLINEID Optional string Product line ID
COST_METHOD Optional string Cost method. Use Standard, Average, FIFO, or LIFO.
EXTENDED_DESCRIPTION Optional string Extended description
PODESCRIPTION Optional string Purchasing description
SODESCRIPTION Optional string Sales description
UOMGRP Optional string Unit of measure
NOTE Optional string Note
SHIP_WEIGHT Optional decimal Shipping weight
GLGROUP Optional string Item GL group name
STANDARD_COST Optional currency Standard cost
BASEPRICE Optional currency Base price
TAXABLE Optional boolean Taxable. Use false for No, true for Yes. (Default: true)
TAXGROUP Optional string Item tax group name
DEFAULTREVRECTEMPLKEY Optional string Default rev rec template ID
INCOMEACCTKEY Optional string Revenue GL account number
INVACCTKEY Optional string Inventory GL account number
EXPENSEACCTKEY Optional string Expense GL account number
COGSACCTKEY Optional string COGS GL account number
OFFSETOEGLACCOUNTKEY Optional string AR GL account number
OFFSETPOGLACCOUNTKEY Optional string AP GL account number
DEFERREDREVACCTKEY Optional string Deferred revenue GL account number
VSOECATEGORY Optional string VSOE category. Use Product - Specified, Software, Product - Unspecified, Upgrade - Unspecified, Upgrade - Specified, Services, or Post Contract Support(PCS).
VSOEDLVRSTATUS Optional string VSOE default delivery status. Use Delivered or Undelivered.
VSOEREVDEFSTATUS Optional string VSOE default deferral status. Use Defer until item is delivered or Defer bundle until item is delivered.
REVPOSTING Optional string Kit revenue posting. Use Component Level or Kit Level.
REVPRINTING Optional string Kit print format. Use Individual Components or Kit.
SUBSTITUTEID Optional string Substitute item ID
ENABLE_SERIALNO Optional boolean Serial tracking enabled. Use false for No, true for Yes. (Default: false)
SERIAL_MASKKEY Optional string Serial number mask
ENABLE_LOT_CATEGORY Optional boolean Lot tracking enabled. Use false for No, true for Yes. (Default: false)
LOT_CATEGORYKEY Optional string Lot category
ENABLE_BINS Optional boolean Bin tracking enabled. Use false for No, true for Yes. (Default: false)
ENABLE_EXPIRATION Optional boolean Expiration tracking enabled. Use false for No, true for Yes. (Default: false)
UPC Optional string UPC
INV_PRECISION Optional integer Inventory unit cost precision
SO_PRECISION Optional integer Sales unit cost precision
PO_PRECISION Optional integer Purchasing unit cost precision
HASSTARTENDDATES Optional boolean Item has start and end dates. Use false for No, true for Yes. (Default: false)
TERMPERIOD Optional string Periods measured in. Use Days, Weeks, Months, or Years.
TOTALPERIODS Optional integer Number of periods
COMPUTEFORSHORTTERM Optional boolean Prorate price allowed. Use false for No, true for Yes. (Default: false)
RENEWALMACROID Optional string Default renewal macro ID
Custom fields Optional varies Custom fields. For a multi-pick-list custom field, implode multiple field values with #~#.

Create Item (Legacy)

create_item

<create_item>
    <itemid>I1234</itemid>
    <name>hello world</name>
    <itemtype>Inventory</itemtype>
</create_item>

Parameters

Name Required Type Description
itemid Required string Item ID to create
name Required string Item name
status Optional string Status. Use active for Active otherwise use inactive for Inactive. (Default: active)
itemtype Required string Item type. Use Inventory, Non-Inventory, Non-Inventory (Purchase only), Non-Inventory (Sales only), Kit, or Stockable Kit.
enable_bins Optional boolean Bin tracking enabled. Use false for No, true for Yes. (Default: false)
extended_description Optional string Extended description
productlineid Optional string Product line ID
substituteid Optional string Substitute item ID
ship_weight Optional decimal Shipping weight
taxable Optional boolean Taxable. Use false for No, true for Yes. (Default: true)
cost_method Optional string Cost method. Use Standard, Average, FIFO, or LIFO.
standard_cost Optional currency Standard cost
base_price Optional currency Base price
glgroup Optional string Item GL group name
note Optional string Note
inventory_precision Optional integer Inventory unit cost precision
purchasing_precision Optional integer Purchasing unit cost precision
sales_precision Optional integer Sales unit cost precision
upc Optional string UPC
hasstartenddates Optional boolean Item has start and end dates. Use false for No, true for Yes. (Default: false)
term_period Optional string Periods measured in. Use Days, Weeks, Months, or Years.
defaultnoofperiods Optional integer Number of periods
computepriceforshortterm Optional boolean Prorate price allowed. Use false for No, true for Yes. (Default: false)
itaxgroup Optional string Item tax group name.
revenue_posting Optional string Kit revenue posting. Use Component Level or Kit Level.
vsoecategory Optional string VSOE category. Use Product - Specified, Software, Product - Unspecified, Upgrade - Unspecified, Upgrade - Specified, Services, or Post Contract Support(PCS).
vsoedlvrstatus Optional string VSOE default delivery status. Use Delivered or Undelivered.
vsoerevdefstatus Optional string VSOE default deferral status. Use Defer until item is delivered or Defer bundle until item is delivered.
incomeaccount Optional string Revenue GL account number
invaccount Optional string Inventory GL account number
expenseaccount Optional string Expense GL account number
cogsaccount Optional string COGS GL account number
offsetoeglaccount Optional string AR GL account number
offsetpoglaccount Optional string AP GL account number
defrevaccount Optional string Deferred revenue GL account number
uomgrp Optional string Unit of measure
customfields Optional customfield[0...n] Custom fields

customfield

Name Required Type Description
customfieldname Optional string Custom field ID
customfieldvalue Optional varies Custom field value. For a multi-pick-list custom field, implode multiple field values with #~#.

Update Item

update

<update>
    <ITEM>
        <RECORDNO>12</RECORDNO>
        <NAME>hello world</NAME>
    </ITEM>
</update>

Parameters

Name Required Type Description
ITEM Optional object Object to update

ITEM

Name Required Type Description
RECORDNO Required integer Item RECORDNO to update
NAME Optional string Item name
STATUS Optional string Status. Use active for Active otherwise use inactive for Inactive.
PRODUCTLINEID Optional string Product line ID
COST_METHOD Optional string Cost method. Use Standard, Average, FIFO, or LIFO.
EXTENDED_DESCRIPTION Optional string Extended description
PODESCRIPTION Optional string Purchasing description
SODESCRIPTION Optional string Sales description
UOMGRP Optional string Unit of measure
NOTE Optional string Note
SHIP_WEIGHT Optional decimal Shipping weight
GLGROUP Optional string Item GL group name
STANDARD_COST Optional currency Standard cost
BASEPRICE Optional currency Base price
TAXABLE Optional boolean Taxable. Use false for No, true for Yes.
TAXGROUP Optional string Item tax group name.
DEFAULTREVRECTEMPLKEY Optional string Default rev rec template ID
INCOMEACCTKEY Optional string Revenue GL account number
INVACCTKEY Optional string Inventory GL account number
EXPENSEACCTKEY Optional string Expense GL account number
COGSACCTKEY Optional string COGS GL account number
OFFSETOEGLACCOUNTKEY Optional string AR GL account number
OFFSETPOGLACCOUNTKEY Optional string AP GL account number
DEFERREDREVACCTKEY Optional string Deferred revenue GL account number
VSOECATEGORY Optional string VSOE category. Use Product - Specified, Software, Product - Unspecified, Upgrade - Unspecified, Upgrade - Specified, Services, or Post Contract Support(PCS).
VSOEDLVRSTATUS Optional string VSOE default delivery status. Use Delivered or Undelivered.
VSOEREVDEFSTATUS Optional string VSOE default deferral status. Use Defer until item is delivered or Defer bundle until item is delivered.
REVPOSTING Optional string Kit revenue posting. Use Component Level or Kit Level.
REVPRINTING Optional string Kit print format. Use Individual Components or Kit.
SUBSTITUTEID Optional string Substitute item ID
ENABLE_SERIALNO Optional boolean Serial tracking enabled. Use false for No, true for Yes.
SERIAL_MASKKEY Optional string Serial number mask
ENABLE_LOT_CATEGORY Optional boolean Lot tracking enabled. Use false for No, true for Yes.
LOT_CATEGORYKEY Optional string Lot category
ENABLE_BINS Optional boolean Bin tracking enabled. Use false for No, true for Yes.
ENABLE_EXPIRATION Optional boolean Expiration tracking enabled. Use false for No, true for Yes.
UPC Optional string UPC
INV_PRECISION Optional integer Inventory unit cost precision
SO_PRECISION Optional integer Sales unit cost precision
PO_PRECISION Optional integer Purchasing unit cost precision
HASSTARTENDDATES Optional boolean Item has start and end dates. Use false for No, true for Yes.
TERMPERIOD Optional string Periods measured in. Use Days, Weeks, Months, or Years.
TOTALPERIODS Optional integer Number of periods
COMPUTEFORSHORTTERM Optional boolean Prorate price allowed. Use false for No, true for Yes.
RENEWALMACROID Optional string Default renewal macro ID
Custom fields Optional varies Custom fields. For a multi-pick-list custom field, implode multiple field values with #~#.

Update Item (Legacy)

update_item

<update_item itemid="I1234">
    <name>hello world</name>
</update_item>

Parameters

Name Required Type Description
itemid Required string Item ID to update
name Optional string Item name
status Optional string Status. Use active for Active otherwise use inactive for Inactive.
enable_bins Optional boolean Bin tracking enabled. Use false for No, true for Yes.
extended_description Optional string Extended description
productlineid Optional string Product line ID
substituteid Optional string Substitute item ID
ship_weight Optional decimal Shipping weight
taxable Optional boolean Taxable. Use false for No, true for Yes.
standard_cost Optional currency Standard cost
base_price Optional currency Base price
glgroup Optional string Item GL group name
note Optional string Note
inventory_precision Optional integer Inventory unit cost precision
purchasing_precision Optional integer Purchasing unit cost precision
sales_precision Optional integer Sales unit cost precision
upc Optional string UPC
hasstartenddates Optional boolean Item has start and end dates. Use false for No, true for Yes.
term_period Optional string Periods measured in. Use Days, Weeks, Months, or Years.
defaultnoofperiods Optional integer Number of periods
computepriceforshortterm Optional boolean Prorate price allowed. Use false for No, true for Yes.
itaxgroup Optional string Item tax group name.
revenue_posting Optional string Kit revenue posting. Use Component Level or Kit Level.
vsoecategory Optional string VSOE category. Use Product - Specified, Software, Product - Unspecified, Upgrade - Unspecified, Upgrade - Specified, Services, or Post Contract Support(PCS).
vsoedlvrstatus Optional string VSOE default delivery status. Use Delivered or Undelivered.
vsoerevdefstatus Optional string VSOE default deferral status. Use Defer until item is delivered or Defer bundle until item is delivered.
incomeaccount Optional string Revenue GL account number
invaccount Optional string Inventory GL account number
expenseaccount Optional string Expense GL account number
cogsaccount Optional string COGS GL account number
offsetoeglaccount Optional string AR GL account number
offsetpoglaccount Optional string AP GL account number
defrevaccount Optional string Deferred revenue GL account number
uomgrp Optional string Unit of measure
customfields Optional customfield[0...n] Custom fields

customfield

Name Required Type Description
customfieldname Optional string Custom field ID
customfieldvalue Optional varies Custom field value. For a multi-pick-list custom field, implode multiple field values with #~#.

Delete Item

delete

<delete>
    <object>ITEM</object>
    <keys>112</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use ITEM
keys Required string Item RECORDNO to delete

Delete Item (Legacy)

delete_item

<delete_item itemid="I1234"></delete_item>

Parameters

Name Required Type Description
itemid Required string Item ID to delete

Provide feedback