GET
/
quickbooks-desktop
/
item-sites
import Conductor from 'conductor-node';

const client = new Conductor({
  apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});

async function main() {
  // Automatically fetches more pages as needed.
  for await (const itemSite of client.qbd.itemSites.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {
    console.log(itemSite.id);
  }
}

main();
{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/item-sites",
  "data": [
    {
      "id": "80000001-1234567890",
      "objectType": "qbd_item_site",
      "createdAt": "2021-10-01T17:34:56.000Z",
      "updatedAt": "2021-10-01T20:45:30.000Z",
      "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,
  "hasMore": true
}

Authorizations

​
Authorization
string
header
required

Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").

Headers

​
Conductor-End-User-Id
string
required

The ID of the EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}").

Example:

"end_usr_1234567abcdefg"

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.

Example:
["80000001-1234567890"]
​
itemType
enum<string>

Filter for item sites that match this item type.

Available options:
all_except_fixed_asset,
assembly,
discount,
fixed_asset,
inventory,
inventory_and_assembly,
non_inventory,
other_charge,
payment,
sales,
sales_tax,
service
Example:

"inventory"

​
itemIds
string[]

Filter for item sites for these items.

Example:
["80000001-1234567890"]
​
siteIds
string[]

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

Example:
["80000001-1234567890"]
​
limit
integer
default: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.

Required range: 1 <= x <= 150
Example:

150

​
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.

Example:

"12345678-abcd-abcd-example-1234567890ab"

​
status
enum<string>
default:active

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

Available options:
active,
all,
inactive
Example:

"active"

Response

200 - application/json

Returns a list of item sites.

The response is of type object.