Sign in

List all inventory sites

Returns a list of inventory sites.

NOTE: QuickBooks Desktop does not support pagination for inventory sites; hence, there is no cursor parameter. Users typically have few inventory sites.

get/quickbooks-desktop/inventory-sites

Query parameters

idsstring[]

Filter for specific inventory sites 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 sites 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"
]
namesstring[]

Filter for specific inventory sites by their name(s), case-insensitive. Like id, name is a unique identifier for an inventory site.

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 sites by their name(s), case-insensitive. Like id, name is a unique identifier for an inventory site.

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.

[
  "Stockroom"
]
status'active' | 'all' | 'inactive'

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

Example:active

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

updatedAfterstring

Filter for inventory sites 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 sites 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 sites 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 sites 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 sites 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 sites whose name contains this substring, case-insensitive.

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

nameStartsWithstring

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

Example:A

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

nameTostring

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

Example:Z

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

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

objectType'list' required

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

urlstring required

The endpoint URL where this list can be accessed.

Example response

{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/inventory-sites",
  "data": [
    {
      "id": "80000001-1234567890",
      "objectType": "qbd_inventory_site",
      "createdAt": "2025-01-01T12:34:56+00:00",
      "updatedAt": "2025-02-01T12:34:56+00:00",
      "revisionNumber": "1721172183",
      "name": "Stockroom",
      "isActive": true,
      "parent": {
        "id": "80000001-1234567890",
        "fullName": "Romulus Warehouse:Stockroom"
      },
      "isDefault": true,
      "description": "Main Stockroom for Electronics",
      "contact": "Jane Smith",
      "phone": "+1-555-123-4567",
      "fax": "+1-555-555-1212",
      "email": "inventory-site@example.com",
      "address": {
        "line1": "Conductor Labs Inc.",
        "line2": "540 Market St.",
        "line3": "Suite 100",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94110",
        "country": "United States"
      }
    }
  ]
}

Changes

Changed in 5 of the 46 revisions of this API.2916

  • 268ef8ccba101See the full diff
    • ▲

      for the query request parameter status, default value active was added

      request-parameter-default-value-added

  • 77c40a8437591See the full diff
    • ▲

      for the query request parameter status, default value active was removed

      request-parameter-default-value-removed

  • 10d4e9ebd1df93See the full diff
    • ▲

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

      response-property-list-of-types-widened

    • ▲

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

      response-property-list-of-types-widened

    • ▲

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

      response-property-list-of-types-widened

    • ▲

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

      response-property-list-of-types-widened

    • ▲

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

      response-property-list-of-types-widened

    • ▲

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

      response-property-list-of-types-widened

    • ▲

      the data/items/parent response's property type/format changed from object null/ to / for status 200

      response-property-type-changed

    • ▲

      removed the required property data/items/parent/fullName from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property data/items/parent/id from the response with the 200 status

      response-required-property-removed

    • ○

      added qbd_site_address subschema #2 to the data/items/address response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      added subschema #1 subschema #2 to the data/items/parent response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      removed qbd_site_address subschema #2 from the data/items/address response property oneOf list for the response status 200

      response-property-one-of-removed

  • 8e0b7df2044d910See the full diff
    • ▲

      the response property data/items/contact became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/items/description became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/items/email became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/items/fax became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/items/isDefault became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/items/parent became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/items/phone became nullable for the status 200

      response-property-became-nullable

    • ▲

      added qbd_site_address subschema #2 to the data/items/address response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      the data/items/parent response's property type/format changed from / to object null/ for status 200

      response-property-type-changed

    • ○

      removed qbd_site_address subschema #2 from the data/items/address response property anyOf list for the response status 200

      response-property-any-of-removed

    • ○

      removed subschema #1 subschema #2 from the data/items/parent response property anyOf list for the response status 200

      response-property-any-of-removed

    • ○

      response property data/items/contact list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/items/description list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/items/email list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/items/fax list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/items/isDefault list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property data/items/phone list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      added the required property data/items/parent/fullName to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/items/parent/id to the response with the 200 status

      response-required-property-added

  • 5f832f69567593See the full diff
    • ▲

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

      response-property-list-of-types-widened

    • ▲

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

      response-property-list-of-types-widened

    • ▲

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

      response-property-list-of-types-widened

    • ▲

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

      response-property-list-of-types-widened

    • ▲

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

      response-property-list-of-types-widened

    • ▲

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

      response-property-list-of-types-widened

    • ▲

      the data/items/parent response's property type/format changed from object null/ to / for status 200

      response-property-type-changed

    • ▲

      removed the required property data/items/parent/fullName from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property data/items/parent/id from the response with the 200 status

      response-required-property-removed

    • ○

      added qbd_site_address subschema #2 to the data/items/address response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      added subschema #1 subschema #2 to the data/items/parent response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      removed qbd_site_address subschema #2 from the data/items/address response property oneOf list for the response status 200

      response-property-one-of-removed