List all inventory assembly items

JavaScript

import Conductor from 'conductor-node';

const conductor = new Conductor({
  apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const inventoryAssemblyItem of conductor.qbd.inventoryAssemblyItems.list({
  conductorEndUserId: 'end_usr_1234567abcdefg',
})) {
  console.log(inventoryAssemblyItem.id);
}

import os
from conductor import Conductor

conductor = Conductor(
    api_key=os.environ.get("CONDUCTOR_SECRET_KEY"),  # This is the default and can be omitted
)
page = conductor.qbd.inventory_assembly_items.list(
    conductor_end_user_id="end_usr_1234567abcdefg",
)
page = page.data[0]
print(page.id)

curl --request GET \
  --url https://api.conductor.is/v1/quickbooks-desktop/inventory-assembly-items \
  --header 'Authorization: Bearer <token>' \
  --header 'Conductor-End-User-Id: <conductor-end-user-id>'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.conductor.is/v1/quickbooks-desktop/inventory-assembly-items",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Conductor-End-User-Id: <conductor-end-user-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.conductor.is/v1/quickbooks-desktop/inventory-assembly-items"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Conductor-End-User-Id", "<conductor-end-user-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.conductor.is/v1/quickbooks-desktop/inventory-assembly-items")
  .header("Conductor-End-User-Id", "<conductor-end-user-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.conductor.is/v1/quickbooks-desktop/inventory-assembly-items")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Conductor-End-User-Id"] = '<conductor-end-user-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/inventory-assembly-items",
  "data": [
    {
      "id": "80000001-1234567890",
      "objectType": "qbd_inventory_assembly_item",
      "createdAt": "2025-01-01T12:34:56.000Z",
      "updatedAt": "2025-02-01T12:34:56.000Z",
      "revisionNumber": "1721172183",
      "name": "Deluxe Kit",
      "fullName": "Assemblies:Deluxe Kit",
      "barcode": "012345678905",
      "isActive": true,
      "class": {
        "id": "80000001-1234567890",
        "fullName": "Finished Goods"
      },
      "parent": {
        "id": "80000001-1234567890",
        "fullName": "Assemblies"
      },
      "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"
      },
      "buildNotificationThreshold": 10,
      "maximumQuantityOnHand": 200,
      "quantityOnHand": 150,
      "averageCost": "16.50",
      "quantityOnPurchaseOrder": 10,
      "quantityOnSalesOrder": 10,
      "externalId": "12345678-abcd-1234-abcd-1234567890ab",
      "lines": [
        {
          "inventoryItem": {
            "id": "80000001-1234567890",
            "fullName": "Inventory Item"
          },
          "quantity": 5
        }
      ],
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "type": "string_1024_type",
          "value": "Premium"
        }
      ]
    }
  ],
  "nextCursor": "12345678-abcd-abcd-example-1234567890ab",
  "remainingCount": 10,
  "hasMore": true
}

GET

quickbooks-desktop

inventory-assembly-items

JavaScript

import Conductor from 'conductor-node';

const conductor = new Conductor({
  apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const inventoryAssemblyItem of conductor.qbd.inventoryAssemblyItems.list({
  conductorEndUserId: 'end_usr_1234567abcdefg',
})) {
  console.log(inventoryAssemblyItem.id);
}

import os
from conductor import Conductor

conductor = Conductor(
    api_key=os.environ.get("CONDUCTOR_SECRET_KEY"),  # This is the default and can be omitted
)
page = conductor.qbd.inventory_assembly_items.list(
    conductor_end_user_id="end_usr_1234567abcdefg",
)
page = page.data[0]
print(page.id)

curl --request GET \
  --url https://api.conductor.is/v1/quickbooks-desktop/inventory-assembly-items \
  --header 'Authorization: Bearer <token>' \
  --header 'Conductor-End-User-Id: <conductor-end-user-id>'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.conductor.is/v1/quickbooks-desktop/inventory-assembly-items",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Conductor-End-User-Id: <conductor-end-user-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.conductor.is/v1/quickbooks-desktop/inventory-assembly-items"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Conductor-End-User-Id", "<conductor-end-user-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.conductor.is/v1/quickbooks-desktop/inventory-assembly-items")
  .header("Conductor-End-User-Id", "<conductor-end-user-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.conductor.is/v1/quickbooks-desktop/inventory-assembly-items")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Conductor-End-User-Id"] = '<conductor-end-user-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/inventory-assembly-items",
  "data": [
    {
      "id": "80000001-1234567890",
      "objectType": "qbd_inventory_assembly_item",
      "createdAt": "2025-01-01T12:34:56.000Z",
      "updatedAt": "2025-02-01T12:34:56.000Z",
      "revisionNumber": "1721172183",
      "name": "Deluxe Kit",
      "fullName": "Assemblies:Deluxe Kit",
      "barcode": "012345678905",
      "isActive": true,
      "class": {
        "id": "80000001-1234567890",
        "fullName": "Finished Goods"
      },
      "parent": {
        "id": "80000001-1234567890",
        "fullName": "Assemblies"
      },
      "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"
      },
      "buildNotificationThreshold": 10,
      "maximumQuantityOnHand": 200,
      "quantityOnHand": 150,
      "averageCost": "16.50",
      "quantityOnPurchaseOrder": 10,
      "quantityOnSalesOrder": 10,
      "externalId": "12345678-abcd-1234-abcd-1234567890ab",
      "lines": [
        {
          "inventoryItem": {
            "id": "80000001-1234567890",
            "fullName": "Inventory Item"
          },
          "quantity": 5
        }
      ],
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "type": "string_1024_type",
          "value": "Premium"
        }
      ]
    }
  ],
  "nextCursor": "12345678-abcd-abcd-example-1234567890ab",
  "remainingCount": 10,
  "hasMore": true
}

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 End-User to receive this request.

Example:

"end_usr_1234567abcdefg"

Query Parameters

ids

string[]

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

Example:

["80000001-1234567890"]

fullNames

string[]

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

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:

["Assemblies:Deluxe Kit"]

limit

integer

default:150

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.

Required range: 1 <= x <= 150

Example:

150

cursor

string

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.

IMPORTANT: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor. To make a run resumable, see Paging by name.

Example:

"12345678-abcd-abcd-example-1234567890ab"

status

enum<string>

default:active

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

Available options:

active,

all,

inactive

Example:

"active"

updatedAfter

string

Filter for inventory assembly 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.000Z"

updatedBefore

string

Filter for inventory assembly 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.000Z"

nameContains

string

Filter for inventory assembly items 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 assembly items 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 assembly items 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 assembly items whose fullName sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.

When you set nameFrom or nameTo, QuickBooks returns inventory assembly items sorted by fullName in that order; without either, the order is not guaranteed. To page through inventory assembly items by name, see Paging by name.

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

Example:

"A"

nameTo

string

Filter for inventory assembly items whose fullName sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set nameFrom, it must not sort after this value, or QuickBooks returns an error.

When you set nameFrom or nameTo, QuickBooks returns inventory assembly items sorted by fullName in that order; without either, the order is not guaranteed.

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

Example:

"Z"

classIds

string[]

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

Example:

["80000001-1234567890"]

Response

200 - application/json

Returns a list of inventory assembly items.

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-assembly-items"

data

The Inventory Assembly Item object · object[]

required

The array of inventory assembly items.

Show child attributes

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.

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.

Example:

"12345678-abcd-abcd-example-1234567890ab"

remainingCount

number | null

required

The number of objects remaining to be fetched.

Example:

10

hasMore

boolean

required

Indicates whether there are more objects to be fetched.

QuickBooks Desktop API

Core Resources

Utilities

Transactions

General

Items

More

List all inventory assembly items

Authorizations

Headers

Query Parameters

Response