COconductor-is

Retrieve an item site

Changed on

Retrieves an item site by ID.

IMPORTANT: If you need to fetch multiple specific item sites 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-sites/{id}

Request

Path parameters

idstring required

The QuickBooks-assigned unique identifier of the item site 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 site.

idstring required

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

objectType'qbd_item_site' required

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

createdAtstring required

The date and time when this item site 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 site 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 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.

reorderLevelnumber nullable required

The inventory level at which QuickBooks prompts you to reorder this item site.

quantityOnHandnumber nullable required

The number of units of this item site currently in inventory.

quantityOnPurchaseOrdersnumber nullable required

The number of units of this item site that are currently listed on outstanding purchase orders and have not yet been received.

quantityOnSalesOrdersnumber nullable required

The number of units of this item site that are currently listed on outstanding sales orders and have not yet been fulfilled or delivered to customers.

quantityToBeBuiltByPendingBuildTransactionsnumber nullable required

The number of units of this item site that are scheduled to be built on pending build transactions.

quantityRequiredByPendingBuildTransactionsnumber nullable required

The number of units of this item site required by pending build transactions.

quantityOnPendingTransfersnumber nullable required

The number of units of this item site that are currently on pending inventory transfer transactions.

assemblyBuildPointnumber nullable required

The inventory level of this item site at which a new build assembly should begin. When the combined quantityOnHand and quantityOnPurchaseOrders drops below this point, QuickBooks flags the need to build additional units.

Example response

{
  "id": "80000001-1234567890",
  "objectType": "qbd_item_site",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "inventoryAssemblyItem": {
    "id": "80000001-1234567890",
    "fullName": "Inventory Assembly Item"
  },
  "inventoryItem": {
    "id": "80000001-1234567890",
    "fullName": "Inventory Item"
  },
  "inventorySite": {
    "id": "80000001-1234567890",
    "fullName": "Main Warehouse"
  },
  "inventorySiteLocation": {
    "id": "80000001-1234567890",
    "fullName": "Aisle 3, Shelf B"
  },
  "reorderLevel": 25,
  "quantityOnHand": 150,
  "quantityOnPurchaseOrders": 40,
  "quantityOnSalesOrders": 30,
  "quantityToBeBuiltByPendingBuildTransactions": 15,
  "quantityRequiredByPendingBuildTransactions": 12,
  "quantityOnPendingTransfers": 8,
  "assemblyBuildPoint": 20
}

Changes

  • 1de07095c4b7Revision changes
    • warning

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

  • 10d4e9ebd1dfRevision changes
    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

      response property reorderLevel 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

      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

    • 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

      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