GET
/
quickbooks-desktop
/
inventory-sites
/
{id}
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.retrieve('80000001-1234567890', {
    conductorEndUserId: 'end_usr_1234567abcdefg',
  });

  console.log(inventorySite.id);
}

main();
{
  "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}}").

Path Parameters

​
id
string
required

The QuickBooks-assigned unique identifier of the inventory site to retrieve.

Response

200 - application/json
Returns the specified inventory site.
​
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.

​
objectType
string
required

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

Allowed value: "qbd_inventory_site"
​
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.

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

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

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

​
isActive
boolean
required

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

​
parent
object | null
required

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

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

​
description
string | null
required

A description of this inventory site.

​
contact
string | null
required

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

​
phone
string | null
required

The inventory site's primary telephone number.

​
fax
string | null
required

The inventory site's fax number.

​
email
string | null
required

The inventory site's email address.

​
address
object | null
required

The inventory site's address.

Update an inventory siteList all inventory sites