List all inventory sites

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}}").

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.

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.

status

enum<string>

default:

active

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

Available options:

active,

all,

inactive

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.

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.

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.

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.

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.

nameFrom

string

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

nameTo

string

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

Response

200 - application/json

data

object[]

required

The array of inventory sites.

data.address

object | null

required

The inventory site's address.

data.contact

string | null

required

The name of the primary contact person for this 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.

data.description

string | null

required

A description of this inventory site.

data.email

string | null

required

The inventory site's email address.

data.fax

string | null

required

The inventory site's fax number.

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.

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.

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.

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.

data.objectType

string

required

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

Allowed value: "qbd_inventory_site"

data.parent

object | null

required

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

data.phone

string | null

required

The inventory site's primary telephone number.

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.

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.

objectType

string

required

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

Allowed value: "list"

url

string

required

The endpoint URL where this list can be accessed.

QuickBooks Desktop API

General

Transactions

Items

Authorizations

Headers

Query Parameters

Response