COconductor-is

Retrieve an item group

Changed on

Retrieves an item group by ID.

IMPORTANT: If you need to fetch multiple specific item groups by ID, use the list endpoint instead with the ids parameter. It accepts an array of IDs so you can batch the request into a single call, which is significantly faster.

get/quickbooks-desktop/item-groups/{id}

Request

Path parameters

idstring required

The QuickBooks-assigned unique identifier of the item group to retrieve.

Example:80000001-1234567890

Headers

Conductor-End-User-Idstring required

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

Example:end_usr_1234567abcdefg

Response

Returns the specified item group.

idstring required

The unique identifier assigned by QuickBooks to this item group. This ID is unique across all item groups but not across different QuickBooks object types.

objectType'qbd_item_group' required

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

createdAtstring required

The date and time when this item group was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

updatedAtstring required

The date and time when this item group was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

revisionNumberstring required

The current QuickBooks-assigned revision number of this item group 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.

namestring required

The case-insensitive unique name of this item group, unique across all item groups.

NOTE: Item groups 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.

barcodestring nullable required

The item group's barcode.

isActiveboolean required

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

descriptionstring nullable required

The item group's description that will appear on sales forms that include this item.

shouldPrintItemsInGroupboolean required

Indicates whether the individual items in this item group and their separate amounts appear on printed forms.

specialItemType'finance_charge' | 'reimbursable_expense_group' | 'reimbursable_expense_subtotal' nullable required

The type of special item for this item group.

externalIdstring nullable required

A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.

Example response

{
  "id": "80000001-1234567890",
  "objectType": "qbd_item_group",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "name": "Office Supplies Bundle",
  "barcode": "012345678905",
  "isActive": true,
  "description": "Complete office starter kit with essential supplies for new employees.",
  "unitOfMeasureSet": {
    "id": "80000001-1234567890",
    "fullName": "Weight Units"
  },
  "shouldPrintItemsInGroup": true,
  "specialItemType": "finance_charge",
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "lines": [
    {
      "item": {
        "id": "80000001-1234567890",
        "fullName": "Widget A"
      },
      "quantity": 5,
      "unitOfMeasure": "Each"
    }
  ],
  "customFields": [
    {
      "ownerId": "0",
      "name": "Customer Rating",
      "type": "string_1024_type",
      "value": "Premium"
    }
  ]
}

Changes

  • 1de07095c4b7Revision changes
    • warning

      for the path request parameter id, the maxLength was set to 36

  • 10d4e9ebd1dfRevision changes
    • breaking

      response property barcode list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property description list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property externalId list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property lines/items/quantity list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property lines/items/unitOfMeasure list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property specialItemType list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the // response's property type changed from object null to no type for status

    • breaking

      the response's property type changed from object null to no type for status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      added subschema #1 subschema #2 to the // response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      removed the finance_charge enum value from the response property for the response status

    • info

      removed the reimbursable_expense_group enum value from the response property for the response status

    • info

      removed the reimbursable_expense_subtotal enum value from the response property for the response status

    • info

      removed the undefined enum value from the response property for the response status