InventoryItemHeaderModel

  • attributes
    Type: array object[] | null · InventoryItemHeaderModel.AttributeModel[]
    • description
      Type: string | null

      The value of the product attribute.

    • name
      Type: string | null

      The name of the product attribute.

    • productAttributeId
      Type: string Format: uuid

      The ID of the product attribute.

  • availableQuantity
    Type: number Format: double

    The quantity available.

  • availableVolumeM3
    Type: number Format: double

    The volume available in metres cubed.

  • availableWeightKG
    Type: number Format: double

    The weight available in kilograms.

  • batch
    Type: string | null

    The batch value.

  • bestBeforeDate
    Type: string | null Format: date

    The best before date.

  • dangerousGood
    Type: object · InventoryItemHeaderModel.DangerousGoodModel
    • hazchemEvacuate
      Type: boolean | null

      Indicates whether evacuation is required in the event of an incident involving the hazardous material, as specified by the Hazchem code.

    • hazchemFireCode
      Type: integer · DgHazchemFireCodeenum

      Integer numbers.

      values
      • I = 1
      • II = 2
      • III = 3
      • IV = 4
      • II_ARF = 5
      • III_ARF = 6
    • hazchemSafetyCode
      Type: integer · DgHazchemSafetyCodeenum

      Integer numbers.

      values
      • P = 1
      • R = 2
      • S = 3
      • S_Black = 4
      • T = 5
    • unNumber
      Type: integer | null Format: int32

      The UN number associated with the dangerous good, if applicable.

  • expiryDate
    Type: string | null Format: date

    The expiry date.

  • isSerialRequired
    Type: boolean
    read-only
  • logisticUnitNumber
    Type: string | null

    The number of logistic unit of the inventory product item, if applicable.

  • logisticUnitReferenceNumber
    Type: string | null

    The reference number of logistic unit of the inventory product item, if applicable.

  • logisticUnitSsccNumber
    Type: string | null

    The SSCC number of logistic unit of the inventory product item, if applicable.

  • onHandQuantity
    Type: number Format: double

    The quantity on hand.

  • onHandVolumeM3
    Type: number Format: double

    The volume on hand in metres cubed.

  • onHandWeightKG
    Type: number Format: double

    The weight on hand in kilograms.

  • packagingDate
    Type: string | null Format: date

    The packaging date.

  • partnerId
    Type: string Format: uuid

    The ID of partner.

  • partnerProductCode
    Type: string | null

    The partner product code.

  • partnerProductId
    Type: string Format: uuid

    The ID of partner product .

  • partnerProductName
    Type: string | null

    The partner product name.

  • productionDate
    Type: string | null Format: date

    The production date.

  • receivedUtc
    Type: string Format: date

    Date time when the product was received in UTC.

  • sellByDate
    Type: string | null Format: date

    The sell by date.

  • serial
    Type: string | null

    The serial of the warehouse product item.

  • serialTrackingMode
    Type: integer · SerialTrackingModeenum

    Integer numbers.

    values
    • None = 1
    • FullCapture = 2
    • ReleaseCapture = 3
  • warehouseLocationId
    Type: string Format: uuid

    The ID of the warehouse location of the inventory product item.

  • warehouseLocationName
    Type: string | null

    The name of the warehouse location of the inventory product item.

  • warehouseLocationType
    Type: integer · WarehouseLocationTypeenum

    Integer numbers.

    values
    • Racking = 1
    • Bulk = 2
    • Quarantine = 3
    • Transitional = 4
  • warehouseProductId
    Type: string Format: uuid

    The ID of the warehouse product.

  • warehouseProductItemId
    Type: string Format: uuid

    The ID of the warehouse product item.