Update an inventory item
Updates an existing inventory item.
Authorizations
Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}"
).
Headers
The ID of the EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}"
).
Path Parameters
The QuickBooks-assigned unique identifier of the inventory item to update.
Body
The current revision number of the inventory item you are updating, which you can get by fetching the object first. Provide the most recent revisionNumber
to ensure you're working with the latest data; otherwise, the update will return an error.
The case-insensitive name of this inventory item. Not guaranteed to be unique because it does not include the names of its parent objects like fullName
does. For example, two inventory items could both have the name
"Widget", but they could have unique fullName
values, such as "Products:Widget" and "Inventory:Widget". Maximum length: 31 characters.
The inventory item's barcode.
Indicates whether this inventory item is active. Inactive objects are typically hidden from views and reports in QuickBooks.
The inventory item's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default.
The parent inventory item one level above this one in the hierarchy. For example, if this inventory item has a fullName
of "Products:Electronics:Widgets", its parent has a fullName
of "Products:Electronics". If this inventory item is at the top level, this field will be null
.
The inventory item's stock keeping unit (SKU), which is sometimes the manufacturer's part number.
The unit-of-measure set associated with this inventory item, which consists of a base unit and related units.
Indicates whether to allow changing the inventory item's unit-of-measure set (using the unitOfMeasureSetId
field) when the base unit of the new unit-of-measure set does not match that of the currently assigned set. Without setting this field to true
in this scenario, the request will fail with an error; hence, this field is equivalent to accepting the warning prompt in the QuickBooks UI.
NOTE: Changing the base unit requires you to update the item's quantities-on-hand and cost to reflect the new unit; otherwise, these values will be inaccurate. Alternatively, consider creating a new item with the desired unit-of-measure set and deactivating the old item.
The sales-tax code associated with this inventory item, determining whether it is taxable or non-taxable. It's used to assign a default tax status to all transactions for this inventory item. Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks. If QuickBooks is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it will assign the default non-taxable code to all sales.
The description of this inventory item that appears on sales forms (e.g., invoices, sales receipts) when sold to customers.
The price at which this inventory item is sold to customers, represented as a decimal string.
The income account used to track revenue from sales of this inventory item.
When true
, applies the new income account (specified by the incomeAccountId
field) to all existing transactions that use this inventory item. If true
, the income account will be updated in all historical transactions where this inventory item appears. Be cautious with this setting as it modifies historical data. The update will fail if any affected transactions fall within a closed accounting period. If not specified, QuickBooks will prompt the user to make this choice.
The description of this inventory item that appears on purchase forms (e.g., checks, bills, item receipts) when it is ordered or bought from vendors.
The cost at which this inventory item is purchased from vendors, represented as a decimal string.
The tax code applied to purchases of this inventory item. Applicable in regions where purchase taxes are used, such as Canada or the UK.
The Cost of Goods Sold (COGS) account for this inventory item, tracking the original direct costs of producing goods sold.
When true
, applies the new COGS account (specified by the cogsAccountId
field) to all existing transactions that use this inventory item. If true
, the COGS account will be updated in all historical transactions where this inventory item appears. Be cautious with this setting as it modifies historical data. The update will fail if any affected transactions fall within a closed accounting period. If not specified, QuickBooks will prompt the user to make this choice.
The preferred vendor from whom this inventory item is typically purchased.
The asset account used to track the current value of this inventory item in inventory.
The minimum quantity of this inventory item at which QuickBooks prompts for reordering.
The maximum quantity of this inventory item desired in inventory.
Response
The unique identifier assigned by QuickBooks to this inventory item. This ID is unique across all inventory items but not across different QuickBooks object types.
The type of object. This value is always "qbd_inventory_item"
.
"qbd_inventory_item"
The date and time when this inventory item was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.
The date and time when this inventory item was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.
The current revision number of this inventory item, which changes each time the object is modified. When updating this object, you must provide the most recent revisionNumber
to ensure you're working with the latest data; otherwise, the update will return an error.
The case-insensitive name of this inventory item. Not guaranteed to be unique because it does not include the names of its parent objects like fullName
does. For example, two inventory items could both have the name
"Widget", but they could have unique fullName
values, such as "Products:Widget" and "Inventory:Widget". Maximum length: 31 characters.
The case-insensitive fully-qualified unique name of this inventory item, formed by combining the names of its parent objects with its own name
, separated by colons. For example, if an inventory item is under "Products:Electronics" and has the name
"Widgets", its fullName
would be "Products:Electronics:Widgets".
Unlike name
, fullName
is guaranteed to be unique across all inventory item objects. However, fullName
can still be arbitrarily changed by the QuickBooks user when they modify the underlying name
field.
The inventory item's barcode.
Indicates whether this inventory item is active. Inactive objects are typically hidden from views and reports in QuickBooks.
The inventory item's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default.
The parent inventory item one level above this one in the hierarchy. For example, if this inventory item has a fullName
of "Products:Electronics:Widgets", its parent has a fullName
of "Products:Electronics". If this inventory item is at the top level, this field will be null
.
The depth level of this inventory item in the hierarchy. A top-level inventory item has a sublevel
of 0; each subsequent sublevel increases this number by 1. For example, an inventory item with a fullName
of "Products:Electronics:Widgets" would have a sublevel
of 2.
The inventory item's stock keeping unit (SKU), which is sometimes the manufacturer's part number.
The unit-of-measure set associated with this inventory item, which consists of a base unit and related units.
The sales-tax code associated with this inventory item, determining whether it is taxable or non-taxable. It's used to assign a default tax status to all transactions for this inventory item. Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks. If QuickBooks is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it will assign the default non-taxable code to all sales.
The description of this inventory item that appears on sales forms (e.g., invoices, sales receipts) when sold to customers.
The price at which this inventory item is sold to customers, represented as a decimal string.
The income account used to track revenue from sales of this inventory item.
The description of this inventory item that appears on purchase forms (e.g., checks, bills, item receipts) when it is ordered or bought from vendors.
The cost at which this inventory item is purchased from vendors, represented as a decimal string.
The tax code applied to purchases of this inventory item. Applicable in regions where purchase taxes are used, such as Canada or the UK.
The Cost of Goods Sold (COGS) account for this inventory item, tracking the original direct costs of producing goods sold.
The preferred vendor from whom this inventory item is typically purchased.
The asset account used to track the current value of this inventory item in inventory.
The minimum quantity of this inventory item at which QuickBooks prompts for reordering.
The maximum quantity of this inventory item desired in inventory.
The current quantity of this inventory item available in inventory. To change the quantityOnHand
for an inventory item, you must create an inventory-adjustment instead of updating this inventory item directly.
The average cost per unit of this inventory item, represented as a decimal string.
The number of units of this inventory item that have been ordered from vendors (as recorded in purchase orders) but not yet received.
The number of units of this inventory item that have been sold (as recorded in sales orders) but not yet fulfilled or delivered to customers.
A globally unique identifier (GUID) you can provide for tracking this object in your external system.
IMPORTANT: Must be formatted as a valid GUID; otherwise, QuickBooks will return an error. This field is immutable and can only be set during object creation.
The custom fields for the inventory item object, added as user-defined data extensions, not included in the standard QuickBooks object.