List all item sites - Conductor Docs

QuickBooks Desktop API

Core Resources

Auth Sessions
End Users

Utilities

Transactions

All Transactions
Bill Check Payments
Bill Credit Card Payments
Bills
Checks
Credit Card Charges
Credit Card Credits
Credit Memos
Estimates
Inventory Adjustments
Invoices
Item Receipts
Journal Entries
Purchase Orders
Receive-Payments
Sales Orders
Sales Receipts
Time Tracking Activities
Transfers
Vendor Credits

General

Account Tax Lines
Accounts
Classes
Company
Customers / Jobs
Date-Driven Terms
Employees
Inventory Sites
Payroll Wage Items
Preferences
Price Levels
Sales Representatives
Sales-Tax Codes
Standard Terms
Vendors

Items

Discount Items
Inventory Assembly Items
Inventory Items
Item Groups
Item Sites
Non-Inventory Items
Sales-Tax Items
Service Items
Subtotal Items

Missing QBD types

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.

objectType

string

required

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

Allowed value: "list"

Example:

"list"

url

string

required

The endpoint URL where this list can be accessed.

Example:

"/v1/quickbooks-desktop/item-sites"

data

object[]

required

The array of item sites.

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

Example:

"80000001-1234567890"

data.objectType

string

required

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

Allowed value: "qbd_item_site"

Example:

"qbd_item_site"

data.createdAt

string

required

The date and time when this item site was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.

Example:

"2021-10-01T17:34:56.000Z"

data.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). The time zone is the same as the user's time zone in QuickBooks.

Example:

"2021-10-01T20:45:30.000Z"

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

Example:

"1721172183"

data.inventoryAssemblyItem

object | null

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.

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Inventory Assembly Item"
}

data.inventoryItem

object | null

required

The inventory item associated with this item site.

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Inventory Item"
}

data.inventorySite

object | null

required

The site location where inventory for the item associated with this item site is stored.

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Main Warehouse"
}

data.inventorySiteLocation

object | null

required

The specific location (e.g., bin or shelf) within the inventory site where the item associated with this item site is stored.

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Aisle 3, Shelf B"
}

data.reorderLevel

number | null

required

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

Example:

25

data.quantityOnHand

number | null

required

The number of units of this item site currently in inventory. quantityOnHand multiplied by averageCost equals totalValue for inventory item lists. To change the quantityOnHand for an item site, you must use an inventory-adjustment instead of updating the item site directly.

Example:

150

data.quantityOnPurchaseOrders

number | null

required

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

Example:

40

data.quantityOnSalesOrders

number | null

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.

Example:

30

data.quantityToBeBuiltByPendingBuildTransactions

number | null

required

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

Example:

15

data.quantityRequiredByPendingBuildTransactions

number | null

required

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

Example:

12

data.quantityOnPendingTransfers

number | null

required

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

Example:

8

data.assemblyBuildPoint

number | null

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:

20

nextCursor

string | null

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.

Example:

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

remainingCount

number | null

required

The number of objects remaining to be fetched.

Example:

10

hasMore

boolean

required

Indicates whether there are more objects to be fetched.

Retrieve an item site The Non-Inventory Item object

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
}