List all item sites

Returns a list of item sites. Use the cursor parameter to paginate through the results.

get/quickbooks-desktop/item-sites

Query parameters

idsstring[]

Filter for specific item sites by their QuickBooks-assigned unique identifier(s).

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.

NOTE: If any of the values you specify in this parameter are not found, the request will return an error.

Filter for specific item sites by their QuickBooks-assigned unique identifier(s).

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.

NOTE: If any of the values you specify in this parameter are not found, the request will return an error.

[
  "80000001-1234567890"
]

itemType'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service'

Filter for item sites that match this item type.

NOTE: QuickBooks Desktop only supports itemType or item/site filters for item-sites requests, not both. Do not use itemType together with itemIds or siteIds.

Example:inventory

Filter for item sites that match this item type.

NOTE: QuickBooks Desktop only supports itemType or item/site filters for item-sites requests, not both. Do not use itemType together with itemIds or siteIds.

itemIdsstring[]

Filter for item sites for these items.

NOTE: QuickBooks Desktop only supports itemType or item/site filters for item-sites requests, not both. Do not use itemType together with itemIds or siteIds.

Filter for item sites for these items.

NOTE: QuickBooks Desktop only supports itemType or item/site filters for item-sites requests, not both. Do not use itemType together with itemIds or siteIds.

[
  "80000001-1234567890"
]

siteIdsstring[]

Filter for item sites at these sites. A site represents a physical location, such as a warehouse or store.

NOTE: QuickBooks Desktop only supports itemType or item/site filters for item-sites requests, not both. Do not use itemType together with itemIds or siteIds.

Filter for item sites at these sites. A site represents a physical location, such as a warehouse or store.

NOTE: QuickBooks Desktop only supports itemType or item/site filters for item-sites requests, not both. Do not use itemType together with itemIds or siteIds.

[
  "80000001-1234567890"
]

limitinteger

The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the cursor parameter. Each response will include a nextCursor value that can be passed to subsequent requests to retrieve the next page of results.

Example:150

The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the cursor parameter. Each response will include a nextCursor value that can be passed to subsequent requests to retrieve the next page of results.

cursorstring

The pagination token to fetch the next set of results when paginating with the limit parameter. Do not include this parameter on the first call. Use the nextCursor value returned in the previous response to request subsequent results.

Example:12345678-abcd-abcd-example-1234567890ab

The pagination token to fetch the next set of results when paginating with the limit parameter. Do not include this parameter on the first call. Use the nextCursor value returned in the previous response to request subsequent results.

status'active' | 'all' | 'inactive'

Filter for item sites that are active, inactive, or both.

Example:active

Filter for item sites that are active, inactive, or both.

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 a list of item sites.

objectType'list' required

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

urlstring required

The endpoint URL where this list can be accessed.

nextCursorstring nullable required

The nextCursor is a pagination token returned in the response when you use the limit parameter in your request. To retrieve subsequent pages of results, include this token as the value of the cursor request parameter in your following API calls.

NOTE: The nextCursor value remains constant throughout the pagination process for a specific list instance; continue to use the same nextCursor token in each request to fetch additional pages.

remainingCountnumber nullable required

The number of objects remaining to be fetched.

hasMoreboolean required

Indicates whether there are more objects to be fetched.

Example response

{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/item-sites",
  "data": [
    {
      "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
    }
  ],
  "nextCursor": "12345678-abcd-abcd-example-1234567890ab",
  "remainingCount": 10
}

Changes

Changed in 5 of the 46 revisions of this API.6430

Apr 21, 2026268ef8ccba101See the full diff
- ▲
  for the query request parameter status, default value active was added
  request-parameter-default-value-added
Apr 21, 202677c40a8437591See the full diff
- ▲
  for the query request parameter status, default value active was removed
  request-parameter-default-value-removed
Apr 20, 202610d4e9ebd1df224See the full diff
- ▲
  response property data/items/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 data/items/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 data/items/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 data/items/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 data/items/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 data/items/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 data/items/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 data/items/reorderLevel 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 nextCursor 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 remainingCount list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  the data/items/inventoryAssemblyItem response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  the data/items/inventoryItem response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  the data/items/inventorySite response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  the data/items/inventorySiteLocation response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  removed the required property data/items/inventoryAssemblyItem/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/inventoryAssemblyItem/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/inventoryItem/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/inventoryItem/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/inventorySite/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/inventorySite/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/inventorySiteLocation/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/inventorySiteLocation/id from the response with the 200 status
  response-required-property-removed
- ○
  added subschema #1 subschema #2 to the data/items/inventoryAssemblyItem response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the data/items/inventoryItem response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the data/items/inventorySite response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the data/items/inventorySiteLocation response property anyOf list for the response status 200
  response-property-any-of-added
Apr 20, 20268e0b7df2044d1822See the full diff
- ▲
  the response property data/items/assemblyBuildPoint became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property data/items/inventoryAssemblyItem became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property data/items/inventoryItem became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property data/items/inventorySite became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property data/items/inventorySiteLocation became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property data/items/quantityOnHand became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property data/items/quantityOnPendingTransfers became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property data/items/quantityOnPurchaseOrders became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property data/items/quantityOnSalesOrders became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property data/items/quantityRequiredByPendingBuildTransactions became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property data/items/quantityToBeBuiltByPendingBuildTransactions became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property data/items/reorderLevel became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property nextCursor became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property remainingCount became nullable for the status 200
  response-property-became-nullable
- ▲
  the data/items/inventoryAssemblyItem response's property type/format changed from / to object null/ for status 200
  response-property-type-changed
- ▲
  the data/items/inventoryItem response's property type/format changed from / to object null/ for status 200
  response-property-type-changed
- ▲
  the data/items/inventorySite response's property type/format changed from / to object null/ for status 200
  response-property-type-changed
- ▲
  the data/items/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 data/items/inventoryAssemblyItem response property anyOf list for the response status 200
  response-property-any-of-removed
- ○
  removed subschema #1 subschema #2 from the data/items/inventoryItem response property anyOf list for the response status 200
  response-property-any-of-removed
- ○
  removed subschema #1 subschema #2 from the data/items/inventorySite response property anyOf list for the response status 200
  response-property-any-of-removed
- ○
  removed subschema #1 subschema #2 from the data/items/inventorySiteLocation response property anyOf list for the response status 200
  response-property-any-of-removed
- ○
  response property data/items/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 data/items/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 data/items/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 data/items/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 data/items/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 data/items/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 data/items/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 data/items/reorderLevel 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 nextCursor 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 remainingCount 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 data/items/inventoryAssemblyItem/fullName to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/inventoryAssemblyItem/id to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/inventoryItem/fullName to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/inventoryItem/id to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/inventorySite/fullName to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/inventorySite/id to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/inventorySiteLocation/fullName to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/inventorySiteLocation/id to the response with the 200 status
  response-required-property-added
Apr 20, 20265f832f695675224See the full diff
- ▲
  response property data/items/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 data/items/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 data/items/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 data/items/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 data/items/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 data/items/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 data/items/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 data/items/reorderLevel 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 nextCursor 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 remainingCount list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  the data/items/inventoryAssemblyItem response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  the data/items/inventoryItem response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  the data/items/inventorySite response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  the data/items/inventorySiteLocation response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  removed the required property data/items/inventoryAssemblyItem/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/inventoryAssemblyItem/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/inventoryItem/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/inventoryItem/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/inventorySite/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/inventorySite/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/inventorySiteLocation/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/inventorySiteLocation/id from the response with the 200 status
  response-required-property-removed
- ○
  added subschema #1 subschema #2 to the data/items/inventoryAssemblyItem response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the data/items/inventoryItem response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the data/items/inventorySite response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the data/items/inventorySiteLocation response property anyOf list for the response status 200
  response-property-any-of-added