--- title: "List all item sites" method: GET path: "/quickbooks-desktop/item-sites" --- # List all item sites `GET /quickbooks-desktop/item-sites` Returns a list of item sites. Use the `cursor` parameter to paginate through the results. ## Query parameters - `ids` string[] — 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. - `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`. - `itemIds` string[] — 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`. - `siteIds` string[] — 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`. - `limit` integer — 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. - `cursor` string — 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. ## Headers - `Conductor-End-User-Id` string, required — The ID of the End-User to receive this request. ## Response `200` Returns a list of item sites. - object - `objectType` 'list', required — The type of object. This value is always `"list"`. - `url` string, required — The endpoint URL where this list can be accessed. - `data` QbdItemSite[], required — The array of item sites. - `id` string, 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"`. - `createdAt` string, 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. - `updatedAt` string, 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. - `revisionNumber` string, 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. - `inventoryAssemblyItem` object, nullable, required — The inventory assembly item associated with this item site. An inventory assembly item is assembled or manufactured from other inventory items, and the items and/or assemblies that make up the assembly are called components. - `id` string, nullable, required — The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. - `fullName` string, nullable, required — The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. - `inventoryItem` object, nullable, required — The inventory item associated with this item site. - `id` string, nullable, required — The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. - `fullName` string, nullable, required — The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. - `inventorySite` object, nullable, required — The site location where inventory for the item associated with this item site is stored. - `id` string, nullable, required — The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. - `fullName` string, nullable, required — The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. - `inventorySiteLocation` object, nullable, required — The specific location (e.g., bin or shelf) within the inventory site where the item associated with this item site is stored. - `id` string, nullable, required — The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. - `fullName` string, nullable, required — The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. - `reorderLevel` number, nullable, required — The inventory level at which QuickBooks prompts you to reorder this item site. - `quantityOnHand` number, nullable, required — The number of units of this item site currently in inventory. - `quantityOnPurchaseOrders` number, nullable, required — The number of units of this item site that are currently listed on outstanding purchase orders and have not yet been received. - `quantityOnSalesOrders` number, 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. - `quantityToBeBuiltByPendingBuildTransactions` number, nullable, required — The number of units of this item site that are scheduled to be built on pending build transactions. - `quantityRequiredByPendingBuildTransactions` number, nullable, required — The number of units of this item site required by pending build transactions. - `quantityOnPendingTransfers` number, nullable, required — The number of units of this item site that are currently on pending inventory transfer transactions. - `assemblyBuildPoint` number, 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. - `nextCursor` string, 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. - `remainingCount` number, nullable, required — The number of objects remaining to be fetched. - `hasMore` boolean, required — Indicates whether there are more objects to be fetched. --- [API](https://skmtc.net/conductor-is/apis/conductor-api.md) · [All operations](https://skmtc.net/conductor-is/apis/conductor-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/conductor-is/conductor-api/revisions/0b07b3ebe160/schema)