v48

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-262621423.8 MB

List all inventory items

Returns a list of inventory items. Use the cursor parameter to paginate through the results.

get/quickbooks-desktop/inventory-items

Query parameters

idsstring[]

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 for this request.

NOTE: If any of the values you specify in this parameter are not found, the request will return an error.

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 for this request.

NOTE: If any of the values you specify in this parameter are not found, the request will return an error.

[
  "80000001-1234567890"
]

fullNamesstring[]

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 "Kitchen" and has the name "Cabinet", its fullName would be "Kitchen:Cabinet".

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.

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.

[
  "Kitchen:Cabinet"
]

limitinteger

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.

Example:150

cursorstring

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'active' | 'all' | 'inactive'

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

Example:active

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

updatedAfterstring

Filter for inventory items updated on or after this date/time. Accepts the following ISO 8601 formats:

date-only (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the start of the specified day in the local timezone of the end-user's computer (e.g., 2025-01-01 → 2025-01-01T00:00:00).
datetime without timezone (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.
datetime with timezone (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.

Example:2025-01-01T12:34:56+00:00

Filter for inventory items updated on or after this date/time. Accepts the following ISO 8601 formats:

date-only (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the start of the specified day in the local timezone of the end-user's computer (e.g., 2025-01-01 → 2025-01-01T00:00:00).
datetime without timezone (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.
datetime with timezone (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.

updatedBeforestring

Filter for inventory items updated on or before this date/time. Accepts the following ISO 8601 formats:

date-only (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the end of the specified day in the local timezone of the end-user's computer (e.g., 2025-01-01 → 2025-01-01T23:59:59).
datetime without timezone (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.
datetime with timezone (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.

Example:2025-02-01T12:34:56+00:00

Filter for inventory items updated on or before this date/time. Accepts the following ISO 8601 formats:

date-only (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the end of the specified day in the local timezone of the end-user's computer (e.g., 2025-01-01 → 2025-01-01T23:59:59).
datetime without timezone (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.
datetime with timezone (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.

nameContainsstring

Filter for inventory items whose name contains this substring, case-insensitive.

NOTE: If you use this parameter, you cannot also use nameStartsWith or nameEndsWith.

Example:ABC

Filter for inventory items whose name contains this substring, case-insensitive.

NOTE: If you use this parameter, you cannot also use nameStartsWith or nameEndsWith.

nameStartsWithstring

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.

Example:ABC

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.

nameEndsWithstring

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.

Example:ABC

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.

nameFromstring

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

Example:A

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

nameTostring

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

Example:Z

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

classIdsstring[]

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

[
  "80000001-1234567890"
]

Headers

Conductor-End-User-Idstring required

The ID of the End-User to receive this request.

Example:end_usr_1234567abcdefg

The ID of the End-User to receive this request.

Response

Returns a list of inventory items.

objectType'list' required

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

urlstring required

The endpoint URL where this list can be accessed.

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

remainingCountnumber nullable required

The number of objects remaining to be fetched.

hasMoreboolean required

Indicates whether there are more objects to be fetched.

Example response

{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/inventory-items",
  "data": [
    {
      "id": "80000001-1234567890",
      "objectType": "qbd_inventory_item",
      "createdAt": "2025-01-01T12:34:56+00:00",
      "updatedAt": "2025-02-01T12:34:56+00:00",
      "revisionNumber": "1721172183",
      "name": "Cabinet",
      "fullName": "Kitchen:Cabinet",
      "barcode": "012345678905",
      "isActive": true,
      "class": {
        "id": "80000001-1234567890",
        "fullName": "Furniture"
      },
      "parent": {
        "id": "80000001-1234567890",
        "fullName": "Kitchen"
      },
      "sublevel": 1,
      "sku": "MPN-123456",
      "unitOfMeasureSet": {
        "id": "80000001-1234567890",
        "fullName": "Weight Units"
      },
      "salesTaxCode": {
        "id": "80000001-1234567890",
        "fullName": "Non"
      },
      "salesDescription": "High-quality steel bolts suitable for construction",
      "salesPrice": "19.99",
      "incomeAccount": {
        "id": "80000001-1234567890",
        "fullName": "Income:Product Sales"
      },
      "purchaseDescription": "Bulk purchase of steel bolts for inventory",
      "purchaseCost": "15.75",
      "purchaseTaxCode": {
        "id": "80000001-1234567890",
        "fullName": "GST"
      },
      "cogsAccount": {
        "id": "80000001-1234567890",
        "fullName": "Expenses:COGS"
      },
      "preferredVendor": {
        "id": "80000001-1234567890",
        "fullName": "Acme Supplies Ltd."
      },
      "assetAccount": {
        "id": "80000001-1234567890",
        "fullName": "Assets:Inventory"
      },
      "reorderPoint": 50,
      "maximumQuantityOnHand": 200,
      "quantityOnHand": 150,
      "averageCost": "16.50",
      "quantityOnPurchaseOrder": 10,
      "quantityOnSalesOrder": 10,
      "externalId": "12345678-abcd-1234-abcd-1234567890ab",
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "type": "string_1024_type",
          "value": "Premium"
        }
      ]
    }
  ],
  "nextCursor": "12345678-abcd-abcd-example-1234567890ab",
  "remainingCount": 10
}