List all inventory sites - Conductor Docs

QuickBooks Desktop API

Core Resources

Auth Sessions
End Users

Utilities

GET
Health check

Transactions

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

General

Accounts
Classes
Customers / Jobs
Date-Driven Terms
Employees
Inventory Sites
Payroll Wage Items
Sales Representatives
Sales-Tax Codes
Standard Terms
Vendors

Items

Discount Items
Inventory Assembly Items
Inventory Items
Non-Inventory Items
Sales-Tax Items
Service Items
Subtotal Items

GET

quickbooks-desktop

inventory-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() {
  const inventorySite = await client.qbd.inventorySites.list({
    conductorEndUserId: 'end_usr_1234567abcdefg',
  });

  console.log(inventorySite.data);
}

main();

{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/inventory-sites",
  "data": [
    {
      "id": "80000001-1234567890",
      "objectType": "qbd_inventory_site",
      "createdAt": "2021-10-01T17:34:56.000Z",
      "updatedAt": "2021-10-01T20:45:30.000Z",
      "revisionNumber": "1721172183",
      "name": "Stockroom",
      "isActive": true,
      "parent": {
        "id": "80000001-1234567890",
        "fullName": "Romulus Warehouse:Stockroom"
      },
      "isDefault": true,
      "description": "Main Stockroom for Electronics",
      "contact": "Jane Smith",
      "phone": "+1-555-123-4567",
      "fax": "+1-555-555-1212",
      "email": "inventory-site@example.com",
      "address": {
        "line1": "Conductor Labs Inc.",
        "line2": "540 Market St.",
        "line3": "Suite 100",
        "line4": "",
        "line5": "",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94110",
        "country": "United States"
      }
    }
  ]
}

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 inventory 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"]

names

string[]

Filter for specific inventory sites by their name(s), case-insensitive. Like id, name is a unique identifier for an inventory site.

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:

["Stockroom"]

status

enum<string>

default:active

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

Available options:

active,

all,

inactive

Example:

"active"

updatedAfter

string

Filter for inventory sites updated on or after this date and time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD), the time is assumed to be 00:00:00 of that day.

Example:

"2021-01-01T12:34:56.000Z"

updatedBefore

string

Filter for inventory sites updated on or before this date and time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD), the time is assumed to be 23:59:59 of that day.

Example:

"2021-02-01T12:34:56.000Z"

nameContains

string

Filter for inventory sites whose name contains this substring, case-insensitive. NOTE: If you use this parameter, you cannot also use nameStartsWith or nameEndsWith.

Example:

"ABC"

nameStartsWith

string

Filter for inventory sites whose name starts with this substring, case-insensitive. NOTE: If you use this parameter, you cannot also use nameContains or nameEndsWith.

Example:

"ABC"

nameEndsWith

string

Filter for inventory sites whose name ends with this substring, case-insensitive. NOTE: If you use this parameter, you cannot also use nameContains or nameStartsWith.

Example:

"ABC"

nameFrom

string

Filter for inventory sites whose name is alphabetically greater than or equal to this value.

Example:

"A"

nameTo

string

Filter for inventory sites whose name is alphabetically less than or equal to this value.

Example:

"Z"

Response

200 - application/json

Returns a list of inventory 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/inventory-sites"

data

object[]

required

The array of inventory sites.

data.id

string

required

The unique identifier assigned by QuickBooks to this inventory site. This ID is unique across all inventory sites but not across different QuickBooks object types.

Example:

"80000001-1234567890"

data.objectType

string

required

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

Allowed value: "qbd_inventory_site"

Example:

"qbd_inventory_site"

data.createdAt

string

required

The date and time when this inventory 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 inventory 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 inventory 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.name

string

required

The case-insensitive unique name of this inventory site, unique across all inventory sites.

NOTE: Inventory sites do not have a fullName field because they are not hierarchical objects, which is why name is unique for them but not for objects that have parents.

Example:

"Stockroom"

data.isActive

boolean

required

Indicates whether this inventory site is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to true.

Example:

true

data.parent

object | null

required

The parent inventory site one level above this one in the hierarchy.

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Romulus Warehouse:Stockroom"
}

data.isDefault

boolean | null

required

Indicates whether this inventory site is the default site used when no specific site is provided during the creation of other objects.

Example:

true

data.description

string | null

required

A description of this inventory site.

Example:

"Main Stockroom for Electronics"

data.contact

string | null

required

The name of the primary contact person for this inventory site.

Example:

"Jane Smith"

data.phone

string | null

required

The inventory site's primary telephone number.

Example:

"+1-555-123-4567"

data.fax

string | null

required

The inventory site's fax number.

Example:

"+1-555-555-1212"

data.email

string | null

required

The inventory site's email address.

Example:

"inventory-site@example.com"

data.address

object | null

required

The inventory site's address.

Retrieve an inventory site The Payroll Wage 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() {
  const inventorySite = await client.qbd.inventorySites.list({
    conductorEndUserId: 'end_usr_1234567abcdefg',
  });

  console.log(inventorySite.data);
}

main();

{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/inventory-sites",
  "data": [
    {
      "id": "80000001-1234567890",
      "objectType": "qbd_inventory_site",
      "createdAt": "2021-10-01T17:34:56.000Z",
      "updatedAt": "2021-10-01T20:45:30.000Z",
      "revisionNumber": "1721172183",
      "name": "Stockroom",
      "isActive": true,
      "parent": {
        "id": "80000001-1234567890",
        "fullName": "Romulus Warehouse:Stockroom"
      },
      "isDefault": true,
      "description": "Main Stockroom for Electronics",
      "contact": "Jane Smith",
      "phone": "+1-555-123-4567",
      "fax": "+1-555-555-1212",
      "email": "inventory-site@example.com",
      "address": {
        "line1": "Conductor Labs Inc.",
        "line2": "540 Market St.",
        "line3": "Suite 100",
        "line4": "",
        "line5": "",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94110",
        "country": "United States"
      }
    }
  ]
}