COconductor-is

List all item sites

Changed on

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

get/quickbooks-desktop/item-sites

Request

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.

[
  "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
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.

[
  "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.

[
  "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
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.

IMPORTANT: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.

Example:12345678-abcd-abcd-example-1234567890ab
status'active' | 'all' | 'inactive'

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

Example:active

Headers

Conductor-End-User-Idstring required

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

Example:end_usr_1234567abcdefg

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