InventoryHeaderModel

  • logisticUnit
    Type: object
    • availableQuantity
      Type: numberFormat: double

      The quantity available.

    • availableVolumeM3
      Type: numberFormat: double

      The volume available in metres cubed.

    • availableWeightKG
      Type: numberFormat: double

      The weight available in kilograms.

    • logisticUnitNumber
      Type: string | null

      The logistic unit number

    • onHandQuantity
      Type: numberFormat: double

      The quantity on hand.

    • onHandVolumeM3
      Type: numberFormat: double

      The volume on hand in metres cubed.

    • onHandWeightKG
      Type: numberFormat: double

      The weight on hand in kilograms.

    • partnerId
      Type: stringFormat: uuid

      The ID of the partner

    • partnerName
      Type: string | null

      The name of the partner

    • referenceNumber
      Type: string | null

      The logistic unit reference number

    • ssccNumber
      Type: string | null

      The logistic unit SSCC

    • warehouseId
      Type: stringFormat: uuid

      The ID of the warehouse

    • warehouseLocationId
      Type: stringFormat: uuid

      The ID of the warehouse location

    • warehouseLocationName
      Type: string | null

      The name of the warehouse location

    • warehouseLocationType
      Type: integerenum

      Integer numbers.

      values
      • Racking = 1
      • Bulk = 2
      • Quarantine = 3
      • Transitional = 4
    • warehouseLogisticUnitId
      Type: stringFormat: uuid

      The ID of the warehouse logistic unit.

    • warehouseName
      Type: string | null

      The name of the warehouse

  • products
    Type: array object[] | null · InventoryHeaderModel.ProductModel[]
    • attributes
      Type: array object[] | null · InventoryHeaderModel.ProductModel.AttributeModel[]

      The attributes of the inventory product.

    • availableQuantity
      Type: numberFormat: double

      The quantity available.

    • availableVolumeM3
      Type: numberFormat: double

      The volume available in metres cubed.

    • availableWeightKG
      Type: numberFormat: double

      The weight available in kilograms.

    • batch
      Type: string | null

      The batch of the inventory product.

    • bestBeforeDate
      Type: string | nullFormat: date

      The best before date of the inventory product.

    • dgHazchemEvacuate
      Type: boolean | null

      Whether to hazchem evacuate.

    • dgHazchemFireCode
      Type: integerenum

      Integer numbers.

      values
      • I = 1
      • II = 2
      • III = 3
      • IV = 4
      • II_ARF = 5
      • III_ARF = 6
    • dgHazchemSafetyCode
      Type: integerenum

      Integer numbers.

      values
      • P = 1
      • R = 2
      • S = 3
      • S_Black = 4
      • T = 5
    • dgUnNumber
      Type: integer | nullFormat: int32

      The UN number of the dangerous good product.

    • expiryDate
      Type: string | nullFormat: date

      The expiry date of the inventory product.

    • isDangerousGood
      Type: boolean

      Whether the partner product is a dangerous good.

    • isSerialRequired
      Type: boolean
      read-only

      Whether serial numbers are mandatory for this product.

    • onHandQuantity
      Type: numberFormat: double

      The quantity on hand.

    • onHandVolumeM3
      Type: numberFormat: double

      The volume on hand in metres cubed.

    • onHandWeightKG
      Type: numberFormat: double

      The weight on hand in kilograms.

    • packagingDate
      Type: string | nullFormat: date

      The packaging date of the inventory product.

    • partnerId
      Type: stringFormat: uuid

      The ID of the partner

    • partnerName
      Type: string | null

      The name of the partner

    • partnerProductCode
      Type: string | null

      The partner product code.

    • partnerProductId
      Type: stringFormat: uuid

      The ID of the partner product.

    • partnerProductName
      Type: string | null

      The partner product name.

    • productionDate
      Type: string | nullFormat: date

      The production date of the inventory product.

    • sellByDate
      Type: string | nullFormat: date

      The sell by date of the inventory product.

    • serialTrackingMode
      Type: integerenum

      Integer numbers.

      values
      • None = 1
      • FullCapture = 2
      • ReleaseCapture = 3
    • warehouseId
      Type: stringFormat: uuid

      The warehouse Id of the inventory product.

    • warehouseLocationId
      Type: stringFormat: uuid

      The warehouse location Id of the inventory product.

    • warehouseLocationName
      Type: string | null

      The warehouse location name of the inventory product.

    • warehouseLocationType
      Type: integerenum

      Integer numbers.

      values
      • Racking = 1
      • Bulk = 2
      • Quarantine = 3
      • Transitional = 4
    • warehouseName
      Type: string | null

      The warehouse name of the inventory product.

    • warehouseProductId
      Type: stringFormat: uuid

      The ID of the warehouse product.