ConsignmentDetailModel.ProductModel

attributes
Type: array object[] | null · ConsignmentDetailModel.ProductModel.AttributeModel[]

A collection of the attributes of the product.
- description
  Type: string | null
  
  The consignment product attribute's description.
- id
  Type: stringFormat: uuid
  
  The consignment product attribute's ID.
- productAttributeId
  Type: stringFormat: uuid
  
  The product attribute's ID.
- productAttributeName
  Type: string | null
  
  The product attribute's name.
batch
Type: string | null

The product batch.
bestBeforeDate
Type: string | nullFormat: date-time

This product's best before date.
consignmentLogisticUnitId
Type: string | nullFormat: uuid

The logistic unit id of the product
description
Type: string | null

A short description of the product.
dispatchedPercent
Type: numberFormat: double

The percentage of dispatched units of the product.
dispatchedQuantity
Type: numberFormat: double

The total number of dispatched units of the product.
dispatchedVolumeM3
Type: numberFormat: double

The total volume of dispatched units of the product, in M3.
dispatchedWeightKG
Type: numberFormat: double

The total weight of dispatched units of the product, in kilograms.
expiryDate
Type: string | nullFormat: date-time

This product's expiry date.
externalId
Type: string | null

The external id of the product
heldPercent
Type: numberFormat: double

The percentage of held units of the product.
heldQuantity
Type: numberFormat: double

The total number of held units of the product.
heldVolumeM3
Type: numberFormat: double

The total volume of held units of the product, in M3.
heldWeightKG
Type: numberFormat: double

The total weight of held units of the product, in kilograms.
id
Type: stringFormat: uuid

The product ID.
items
Type: array object[] | null · ConsignmentDetailModel.ProductModel.ItemModel[]

A collection of the items which make up this consignment product.
- dispatchedPercent
  Type: numberFormat: double
  
  The percentage of dispatched units of the product item.
- dispatchedQuantity
  Type: numberFormat: double
  
  The total number of dispatched units of the product item.
- dispatchedVolumeM3
  Type: numberFormat: double
  
  The total volume of dispatched units of the product item, in M3.
- dispatchedWeightKG
  Type: numberFormat: double
  
  The total weight of dispatched units of the product item, in kilograms.
- heldPercent
  Type: numberFormat: double
  
  The percentage of held units of the product item.
- heldQuantity
  Type: numberFormat: double
  
  The total number of held units of the product item.
- heldVolumeM3
  Type: numberFormat: double
  
  The total volume of held units of the product item, in M3.
- heldWeightKG
  Type: numberFormat: double
  
  The total weight of held units of the product item, in kilograms.
- id
  Type: stringFormat: uuid
  
  The product item ID.
- pickedPercent
  Type: numberFormat: double
  
  The percentage of picked units of the product item.
- pickedQuantity
  Type: numberFormat: double
  
  The total number of picked units of the product item.
- pickedVolumeM3
  Type: numberFormat: double
  
  The total volume of picked units of the product item, in M3.
- pickedWeightKG
  Type: numberFormat: double
  
  The total weight of picked units of the product item, in kilograms.
- quantity
  Type: numberFormat: double
  
  The number of physical units of the item included in the consignment product. When using item serial numbers, Quantity will always be 1.
- receivedPercent
  Type: numberFormat: double
  
  The percentage of received units of the product item.
- receivedQuantity
  Type: numberFormat: double
  
  The total number of received units of the product item.
- receivedVolumeM3
  Type: numberFormat: double
  
  The total volume of received units of the product item, in M3.
- receivedWeightKG
  Type: numberFormat: double
  
  The total weight of received units of the product item, in kilograms.
- serial
  Type: string | null
  
  The serial number of the product item. Using item serial numbers requires the partner product IsSerialRequired to be true, and Quantity will always be 1.
- volumeM3
  Type: numberFormat: double
  
  The volume of the product item, in M3.
- weightKG
  Type: numberFormat: double
  
  The weight of the product item, in kilograms.
packagingDate
Type: string | nullFormat: date-time

This product's packaging date.
partnerProduct
Type: object
- barcode
  Type: string | null
  
  The Barcode of a product
- code
  Type: string | null
  
  The product code.
- dgFlashpointDegC
  Type: string | null
  
  The flash point of the dangerous good product in °C
- dgHazchemEac
  Type: string | null
  
  The Hazchem Emergency Action Code of the dangerous good product
- dgMarinePollutant
  Type: boolean | null
  
  Whether this dangerous good product is a marine pollutant
- dgPackagingGroup
  Type: integerenum
  
  Integer numbers.
  
  values
  I = 1
  II = 2
  III = 3
- dgPhLevel
  Type: number | nullFormat: double
  
  The PH level of the dangerous good product
- dgProperShippingName
  Type: string | null
  
  The proper shipping name of the dangerous good product
- dgTechnicalName
  Type: string | null
  
  The technical name of the dangerous good product
- dgUnNumber
  Type: string | null
  
  The UN number of the dangerous good product
- gtin
  Type: string | null
  
  The GTIN of a product
- heightMM
  Type: integer | nullFormat: int32
  
  The height of the product, in MM.
- id
  Type: stringFormat: uuid
  
  The ID of the partner product.
- isDangerousGood
  Type: boolean
  
  Whether this partner product is a dangerous good
- isSerialRequired
  Type: boolean
  read-only
  
  Whether serial numbers are mandatory for this product.
- isVolumeAutoCalculated
  Type: boolean
  
  Whether the volume of the product was calculated automatically using length, height and width dimensions.
- lengthMM
  Type: integer | nullFormat: int32
  
  The length of the product, in MM.
- name
  Type: string | null
  
  The product name.
- productGroupId
  Type: stringFormat: uuid
  
  The product group's ID.
- productGroupName
  Type: string | null
  
  The product group's name.
- productUnitTypeId
  Type: string | nullFormat: uuid
  
  The product unit type's ID.
- productUnitTypeName
  Type: string | null
  
  The product unit type's name.
- serialTrackingMode
  Type: integerenum
  
  Integer numbers.
  
  values
  None = 1
  FullCapture = 2
  ReleaseCapture = 3
- volumeM3
  Type: numberFormat: double
  
  The volume of the product, in M3.
- weightKG
  Type: numberFormat: double
  
  The weight of the product, in kilograms.
- widthMM
  Type: integer | nullFormat: int32
  
  The width of the product, in MM.
pickedPercent
Type: numberFormat: double

The percentage of picked units of the product.
pickedQuantity
Type: numberFormat: double

The total number of picked units of the product.
pickedVolumeM3
Type: numberFormat: double

The total volume of picked units of the product, in M3.
pickedWeightKG
Type: numberFormat: double

The total weight of picked units of the product, in kilograms.
productionDate
Type: string | nullFormat: date-time

This product's production date.
quantity
Type: numberFormat: double

The total number of units of the product.
receivedPercent
Type: numberFormat: double

The percentage of received units of the product.
receivedQuantity
Type: numberFormat: double

The total number of received units of the product.
receivedVolumeM3
Type: numberFormat: double

The total volume of received units of the product, in M3.
receivedWeightKG
Type: numberFormat: double

The total weight of received units of the product, in kilograms.
sellByDate
Type: string | nullFormat: date-time

This product's sell by date.
volumeM3
Type: numberFormat: double

The total volume of the product, in M3.
weightKG
Type: numberFormat: double

The total weight of the product, in kilograms.