Skip to main content
Version: v3 (preview)

Get Many Inventory​

Returns your organization's inventory, one record per item batch, newest first.

Query Parameters
  • page integer required

    Page to return. Pages start at 0

  • limit integer required

    Possible values: >= 1 and <= 500

    Number of records per page, up to 500

  • itemCode string

    Only return inventory for items with this code. An item can have several batches, so this can return several records

  • isArchived boolean

    Only return archived (true) or active (false) inventory

Responses

Successful Operation

Schema
  • data object[]
  • id uuid

    Nabis ID of the item batch

  • daysAtNabis integer

    Days since the item batch was first received at a Nabis warehouse. null if it hasn't been received yet

  • isArchived boolean

    Whether the item batch has been archived

  • updatedAt date-time

    When the item batch was last updated

  • item object

    The item (product) in the item batch

  • id uuid

    Nabis ID of the item

  • code string

    Your code for the item, typically used to map it to your own systems

  • name string

    Name of the item as it appears on order documents

  • unit string

    Description of a single unit of the item (e.g. 6-pack)

  • pricePerUnit number

    Price of a single unit

  • quantityPerUnitOfMeasure integer

    Case pack size, the number of units in a case

  • inventoryType string

    Whether the item is cannabis or non-cannabis. See Inventory Classifications for every value

  • inventoryClass string

    General classification of the item (e.g. EDIBLES). See Inventory Classifications for every value

  • inventoryCategory string

    Specific classification of the item within its class (e.g. GUMMY). See Inventory Classifications for every value

  • strainType string

    Strain type of the item. See Inventory Classifications for every value

  • subBrand string

    Brand name of the item, when it differs from your organization's name

  • productLine string

    Product line used to group similar items

  • containerType string

    Packaging the item comes in

  • isSample boolean

    Whether the item is a sample version of another item

  • isMedical boolean

    Whether the item is a medical product

  • isColdStorage boolean

    Whether the item requires cold storage

  • availableOnMarketplace boolean

    Whether the item can be purchased on the Nabis marketplace

  • cannabinoidTypeA string

    Possible values: [THC, CBD, CBG, CBN, THCV, CBC, Delta8THC, CBDV, THCA, CBDA, CBGA, CBNA, CBCA, THCVA, CBDVA, Delta10THC, Delta9THC]

    First cannabinoid listed for the item

  • cannabinoidDosageA number

    Dosage of cannabinoidTypeA, in cannabinoidDosageUnitA

  • cannabinoidDosageUnitA string

    Possible values: [mg]

    Unit of cannabinoidDosageA. Currently always mg; more units may be added in the future

  • cannabinoidTypeB string

    Possible values: [THC, CBD, CBG, CBN, THCV, CBC, Delta8THC, CBDV, THCA, CBDA, CBGA, CBNA, CBCA, THCVA, CBDVA, Delta10THC, Delta9THC]

    Second cannabinoid listed for the item

  • cannabinoidDosageB number

    Dosage of cannabinoidTypeB, in cannabinoidDosageUnitB

  • cannabinoidDosageUnitB string

    Possible values: [mg]

    Unit of cannabinoidDosageB. Currently always mg; more units may be added in the future

  • batch object

    The batch in the item batch

  • id uuid

    Nabis ID of the batch

  • code string

    Your code for the batch

  • manufacturingDate date

    Date the batch was manufactured, in yyyy-mm-dd format

  • expirationDate date

    Date the batch's certificate of analysis expires, in yyyy-mm-dd format. The batch must be re-tested or destroyed after this date

  • licenseNumber string

    Number of the license the batch was produced under

  • licenseNickname string

    Nickname of the license the batch was produced under

  • thcPercentage number

    THC of the batch, as a percentage

  • thcAPercentage number

    THC-A of the batch, as a percentage

  • cbdPercentage number

    CBD of the batch, as a percentage

  • otherCannabinoidPercentage number

    Other cannabinoids of the batch, as a percentage

  • calculatedThcPercentage number

    THC of the batch as a percentage. Uses thcPercentage when it's recorded, otherwise it's calculated from thcWeight. 0 when neither can be used

  • thcWeight number

    THC of the batch, in mg

  • thcAWeight number

    THC-A of the batch, in mg

  • cbdWeight number

    CBD of the batch, in mg

  • otherCannabinoidWeight number

    Other cannabinoids of the batch, in mg

  • calculatedThcWeight number

    THC weight of the batch, in mg. Uses thcWeight when it's recorded, otherwise it's calculated from thcPercentage. 0 when neither can be used

  • aromas string[]

    Aroma characteristics of the batch

  • warehouseCounts object[]

    Quantities of the item batch at each Nabis warehouse. These counts are not real-time and can lag behind our warehouse inventory system

  • warehouseId uuid

    Nabis ID of the warehouse

  • incoming integer

    Units inbound to the warehouse on open purchase orders

  • outgoing integer

    Units on open orders or in the fulfillment process

  • available integer

    Units available to sell

  • counted integer

    Units physically counted at the warehouse (outgoing + available)

  • quarantined integer

    Units that are quarantined and can't be sold

  • packed integer

    Units packed for outgoing orders

  • updatedAt date-time

    When a difference between our cached counts and our warehouse inventory system was last detected

  • page integer

    The page returned

  • totalCount integer

    Total number of records across all pages

  • totalNumPages integer

    Total number of pages

  • nextPage integer

    The next page, or null on the last page

  • prevPage integer

    The previous page, or null on the first page