GET
/
quickbooks-desktop
/
inventory-items

Authorizations

Authorization
string
headerrequired

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 items by their QuickBooks-assigned unique identifier(s).

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters.

fullNames
string[]

Filter for specific inventory items by their full-name(s), case-insensitive. Like id, fullName is a unique identifier for an inventory item, formed by by combining the names of its parent objects with its own name, separated by colons. For example, if an inventory item is under "Furniture:Kitchen" and has the name "Cabinet", its fullName would be "Furniture:Kitchen:Cabinet".

Unlike name, fullName is guaranteed to be unique across all inventory item objects. Also, unlike id, fullName can be arbitrarily changed by the QuickBooks user when modifying its underlying name field.

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters.

limit
integer
default: 150

The maximum number of objects to return. Ranging from 1 to 150, defaults to 150. Use this parameter in conjunction with the cursor parameter to paginate through results. The response will include a nextCursor field, which can be used as the cursor parameter value in subsequent requests to fetch the next set of results.

cursor
string

The pagination token to fetch the next set of results when paginating with the limit parameter. Retrieve this value from the nextCursor field in the previous response. If omitted, the API returns the first page of results.

status
enum<string>
default: active

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

Available options:
active,
all,
inactive
updatedAfter
string

Filter for inventory items 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.

WARNING: Due to a known issue in QuickBooks Desktop, the updatedAfter parameter may not correctly filter inventory items by their updated dates. To accurately retrieve the desired inventory items, we recommend avoiding this parameter and instead fetching a broader dataset, then filtering the results locally using the updatedAt property.

updatedBefore
string

Filter for inventory items 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.

WARNING: Due to a known issue in QuickBooks Desktop, the updatedBefore parameter may not correctly filter inventory items by their updated dates. To accurately retrieve the desired inventory items, we recommend avoiding this parameter and instead fetching a broader dataset, then filtering the results locally using the updatedAt property.

nameContains
string

Filter for inventory items 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 items 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 items 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 items whose name is alphabetically greater than or equal to this value.

nameTo
string

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

classIds
string[]

Filter for inventory items of this class or classes. A class is a way end-users can categorize inventory items in QuickBooks.

Response

200 - application/json
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.

data
object[]
required

The array of inventory items.

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

remainingCount
number | null
required

The number of objects remaining to be fetched.

hasMore
boolean
required

Indicates whether there are more objects to be fetched.