Retrieve an item site

Retrieves an item site by ID.

IMPORTANT: If you need to fetch multiple specific item sites by ID, use the list endpoint instead with the ids parameter. It accepts an array of IDs so you can batch the request into a single call, which is significantly faster.

get/quickbooks-desktop/item-sites/{id}

Path parameters

idstring required

The QuickBooks-assigned unique identifier of the item site to retrieve.

Example:80000001-1234567890

The QuickBooks-assigned unique identifier of the item site to retrieve.

Headers

Conductor-End-User-Idstring required

The ID of the End-User to receive this request.

Example:end_usr_1234567abcdefg

The ID of the End-User to receive this request.

Response

Returns the specified item site.

idstring required

The unique identifier assigned by QuickBooks to this item site. This ID is unique across all item sites but not across different QuickBooks object types.

objectType'qbd_item_site' required

The type of object. This value is always "qbd_item_site".

createdAtstring required

The date and time when this item site was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

updatedAtstring required

The date and time when this item site was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

revisionNumberstring required

The current QuickBooks-assigned revision number of this item site object, 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.

reorderLevelnumber nullable required

The inventory level at which QuickBooks prompts you to reorder this item site.

quantityOnHandnumber nullable required

The number of units of this item site currently in inventory.

quantityOnPurchaseOrdersnumber nullable required

The number of units of this item site that are currently listed on outstanding purchase orders and have not yet been received.

quantityOnSalesOrdersnumber nullable required

The number of units of this item site that are currently listed on outstanding sales orders and have not yet been fulfilled or delivered to customers.

quantityToBeBuiltByPendingBuildTransactionsnumber nullable required

The number of units of this item site that are scheduled to be built on pending build transactions.

quantityRequiredByPendingBuildTransactionsnumber nullable required

The number of units of this item site required by pending build transactions.

quantityOnPendingTransfersnumber nullable required

The number of units of this item site that are currently on pending inventory transfer transactions.

assemblyBuildPointnumber nullable required

The inventory level of this item site at which a new build assembly should begin. When the combined quantityOnHand and quantityOnPurchaseOrders drops below this point, QuickBooks flags the need to build additional units.

Example response

{
  "id": "80000001-1234567890",
  "objectType": "qbd_item_site",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "inventoryAssemblyItem": {
    "id": "80000001-1234567890",
    "fullName": "Inventory Assembly Item"
  },
  "inventoryItem": {
    "id": "80000001-1234567890",
    "fullName": "Inventory Item"
  },
  "inventorySite": {
    "id": "80000001-1234567890",
    "fullName": "Main Warehouse"
  },
  "inventorySiteLocation": {
    "id": "80000001-1234567890",
    "fullName": "Aisle 3, Shelf B"
  },
  "reorderLevel": 25,
  "quantityOnHand": 150,
  "quantityOnPurchaseOrders": 40,
  "quantityOnSalesOrders": 30,
  "quantityToBeBuiltByPendingBuildTransactions": 15,
  "quantityRequiredByPendingBuildTransactions": 12,
  "quantityOnPendingTransfers": 8,
  "assemblyBuildPoint": 20
}

Changes

Changed in 4 of the 46 revisions of this API.56128

May 2, 20261de07095c4b71See the full diff
- ●
  for the path request parameter id, the maxLength was set to 36
  request-parameter-max-length-set
Apr 20, 202610d4e9ebd1df204See the full diff
- ▲
  response property assemblyBuildPoint list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property quantityOnHand list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property quantityOnPendingTransfers list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property quantityOnPurchaseOrders list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property quantityOnSalesOrders list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property quantityRequiredByPendingBuildTransactions list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property quantityToBeBuiltByPendingBuildTransactions list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property reorderLevel list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  the inventoryAssemblyItem response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  the inventoryItem response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  the inventorySite response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  the inventorySiteLocation response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  removed the required property inventoryAssemblyItem/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property inventoryAssemblyItem/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property inventoryItem/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property inventoryItem/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property inventorySite/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property inventorySite/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property inventorySiteLocation/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property inventorySiteLocation/id from the response with the 200 status
  response-required-property-removed
- ○
  added subschema #1 subschema #2 to the inventoryAssemblyItem response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the inventoryItem response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the inventorySite response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the inventorySiteLocation response property anyOf list for the response status 200
  response-property-any-of-added
Apr 20, 20268e0b7df2044d1620See the full diff
- ▲
  the response property assemblyBuildPoint became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property inventoryAssemblyItem became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property inventoryItem became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property inventorySite became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property inventorySiteLocation became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property quantityOnHand became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property quantityOnPendingTransfers became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property quantityOnPurchaseOrders became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property quantityOnSalesOrders became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property quantityRequiredByPendingBuildTransactions became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property quantityToBeBuiltByPendingBuildTransactions became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property reorderLevel became nullable for the status 200
  response-property-became-nullable
- ▲
  the inventoryAssemblyItem response's property type/format changed from / to object null/ for status 200
  response-property-type-changed
- ▲
  the inventoryItem response's property type/format changed from / to object null/ for status 200
  response-property-type-changed
- ▲
  the inventorySite response's property type/format changed from / to object null/ for status 200
  response-property-type-changed
- ▲
  the inventorySiteLocation response's property type/format changed from / to object null/ for status 200
  response-property-type-changed
- ○
  removed subschema #1 subschema #2 from the inventoryAssemblyItem response property anyOf list for the response status 200
  response-property-any-of-removed
- ○
  removed subschema #1 subschema #2 from the inventoryItem response property anyOf list for the response status 200
  response-property-any-of-removed
- ○
  removed subschema #1 subschema #2 from the inventorySite response property anyOf list for the response status 200
  response-property-any-of-removed
- ○
  removed subschema #1 subschema #2 from the inventorySiteLocation response property anyOf list for the response status 200
  response-property-any-of-removed
- ○
  response property assemblyBuildPoint list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property quantityOnHand list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property quantityOnPendingTransfers list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property quantityOnPurchaseOrders list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property quantityOnSalesOrders list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property quantityRequiredByPendingBuildTransactions list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property quantityToBeBuiltByPendingBuildTransactions list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property reorderLevel list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  added the required property inventoryAssemblyItem/fullName to the response with the 200 status
  response-required-property-added
- ○
  added the required property inventoryAssemblyItem/id to the response with the 200 status
  response-required-property-added
- ○
  added the required property inventoryItem/fullName to the response with the 200 status
  response-required-property-added
- ○
  added the required property inventoryItem/id to the response with the 200 status
  response-required-property-added
- ○
  added the required property inventorySite/fullName to the response with the 200 status
  response-required-property-added
- ○
  added the required property inventorySite/id to the response with the 200 status
  response-required-property-added
- ○
  added the required property inventorySiteLocation/fullName to the response with the 200 status
  response-required-property-added
- ○
  added the required property inventorySiteLocation/id to the response with the 200 status
  response-required-property-added
Apr 20, 20265f832f695675204See the full diff
- ▲
  response property assemblyBuildPoint list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property quantityOnHand list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property quantityOnPendingTransfers list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property quantityOnPurchaseOrders list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property quantityOnSalesOrders list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property quantityRequiredByPendingBuildTransactions list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property quantityToBeBuiltByPendingBuildTransactions list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property reorderLevel list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  the inventoryAssemblyItem response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  the inventoryItem response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  the inventorySite response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  the inventorySiteLocation response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  removed the required property inventoryAssemblyItem/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property inventoryAssemblyItem/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property inventoryItem/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property inventoryItem/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property inventorySite/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property inventorySite/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property inventorySiteLocation/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property inventorySiteLocation/id from the response with the 200 status
  response-required-property-removed
- ○
  added subschema #1 subschema #2 to the inventoryAssemblyItem response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the inventoryItem response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the inventorySite response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the inventorySiteLocation response property anyOf list for the response status 200
  response-property-any-of-added

Full history