ConsignmentDetailModel

  • actualDispatchDateTime
    Type: string | nullFormat: date

    The date and time consignment was dispatched from its origin.

  • actualReceiveDateTime
    Type: string | nullFormat: date

    The date and time this consignment was received at the warehouse.

  • carrier
    Type: object
    • code
      Type: string | null

      The code of the partner.

    • email
      Type: string | null

      The email address of the partner.

    • externalId
      Type: string | null

      The external ID of the partner.

    • id
      Type: stringFormat: uuid

      The ID of the partner.

    • name
      Type: string | null

      The name of the partner.

    • relationship
      Type: integerenum

      Integer numbers.

      values
      • Client = 1
      • Carrier = 2
    • status
      Type: integerenum

      Integer numbers.

      values
      • Inactive = 1
      • Active = 2
  • carrierReferenceNumber
    Type: string | null

    The carrier reference number.

  • carrierRunNumber
    Type: string | null

    The carrier run number.

  • carrierRunOrdinal
    Type: integer | nullFormat: int32

    The carrier order of the consignment for the run number.

  • client
    Type: object
    • code
      Type: string | null

      The code of the partner.

    • email
      Type: string | null

      The email address of the partner.

    • externalId
      Type: string | null

      The external ID of the partner.

    • id
      Type: stringFormat: uuid

      The ID of the partner.

    • name
      Type: string | null

      The name of the partner.

    • relationship
      Type: integerenum

      Integer numbers.

      values
      • Client = 1
      • Carrier = 2
    • status
      Type: integerenum

      Integer numbers.

      values
      • Inactive = 1
      • Active = 2
  • consignmentNumber
    Type: string | null

    The consignment number.

  • consignmentTracking
    Type: array object[] | null · ConsignmentTrackingHeaderModel[]

    A collection of tracking for this consignment.

    • carrierName
      Type: string | null

      The name of the carrier

    • createdUtc
      Type: string | nullFormat: date

      The consignment tracking created utc

    • id
      Type: stringFormat: uuid

      The ID of the consignment tracking.

    • integrationName
      Type: string | null

      The name of the integration that created the tracking

    • lastUpdatedDate
      Type: string | nullFormat: date

      The consignment last updated date time

    • modifiedUtc
      Type: string | nullFormat: date

      The consignment tracking modified utc

    • status
      Type: integerenum

      Integer numbers.

      values
      • Unknown = 0
      • Printed = 1
      • Dispatched = 2
      • InTransit = 3
      • OutForDelivery = 4
    • trackingNumber
      Type: string | null

      The consignment tracking number

    • trackingUrl
      Type: string | null

      The consignment tracking url

  • consumables
    Type: array object[] | null · ConsignmentDetailModel.ConsumableModel[]

    A collection of consumables associated with the consignment.

    • consumableTypeId
      Type: stringFormat: uuid

      The consumable type ID

    • consumableTypeName
      Type: string | null

      The consumable type's name

    • id
      Type: stringFormat: uuid

      The ID of the consignment consumable.

    • value
      Type: numberFormat: double

      The value of this consumable

  • containerGrossWeightKG
    Type: number | nullFormat: double

    The container gross weight in kilograms.

  • containerNumber
    Type: string | null

    The container number.

  • containerReceivedDate
    Type: string | nullFormat: date

    When the container was received.

  • containerReturnedDate
    Type: string | nullFormat: date

    When the container was returned.

  • containerSealNumber
    Type: string | null

    The container seal number.

  • containerSize
    Type: integerenum

    Integer numbers.

    values
    • TenFoot = 1
    • TwentyFoot = 2
    • FortyFoot = 3
    • FortyFiveFoot = 4
  • containerStatus
    Type: integerenum

    Integer numbers.

    values
    • Pending = 1
    • Received = 2
    • Returned = 3
  • containerTareWeightKG
    Type: number | nullFormat: double

    The container tare weight in kilograms.

  • containerType
    Type: integerenum

    Integer numbers.

    values
    • GeneralPurpose = 1
    • GeneralPurposeHighCube = 2
    • Refrigerated = 3
    • RefrigeratedHighCube = 4
    • RefrigeratedNotOperating = 5
  • containerVesselName
    Type: string | null

    Container vessel name.

  • containerVoyage
    Type: string | null

    Container voyage name.

  • containerYard
    Type: object
    • city
      Type: string | null

      The city of the container yard's address.

    • code
      Type: string | null

      The code of the container yard.

    • country
      Type: string | null

      The country of the container yard's address.

    • id
      Type: stringFormat: uuid

      The ID of the container yard.

    • latitude
      Type: numberFormat: double

      The latitude of the container yard's address.

    • longitude
      Type: numberFormat: double

      The longitude of the container yard's address.

    • name
      Type: string | null

      The name of the container yard.

    • postCode
      Type: string | null

      The postal code of the container yard's address.

    • state
      Type: string | null

      The state of the container yard's address.

    • streetAddress
      Type: string | null

      The street address of the container yard's address.

    • suburb
      Type: string | null

      The suburb of the container yard's address. Optional.

  • containerYardReference
    Type: string | null

    Container yard reference.

  • dateEntered
    Type: stringFormat: date

    The date this consignment was entered into the system.

  • defaultDispatchWarehouseLocation
    Type: object
    • id
      Type: stringFormat: uuid

      The ID of warehouse location

    • name
      Type: string | null

      The name of warehouse location

  • defaultReceiveWarehouseLocation
    Type: object
    • id
      Type: stringFormat: uuid

      The ID of warehouse location

    • name
      Type: string | null

      The name of warehouse location

  • deliveryInstructions
    Type: string | null

    Delivery instructions.

  • destinationAddress
    Type: object
    • city
      Type: string | null

      The city of the address.

    • code
      Type: string | null

      The code of the address. Generally used for EDI mapping between systems.

    • country
      Type: string | null

      The country of the address.

    • email
      Type: string | null

      The email address of address.

    • id
      Type: stringFormat: uuid

      The address ID.

    • latitude
      Type: number | nullFormat: double

      The latitude of this address.

    • longitude
      Type: number | nullFormat: double

      The longitude of this address.

    • name
      Type: string | null

      The name of the address, e.g. a place name or title.

    • phone
      Type: string | null

      The phone number of address.

    • postCode
      Type: string | null

      The postal code of the address.

    • state
      Type: string | null

      The state of the address.

    • streetAddress
      Type: string | null

      The street address of the address.

    • suburb
      Type: string | null

      The suburb of the address. Optional.

    • type
      Type: integerenum

      Integer numbers.

      values
      • Adhoc = 0
      • Warehouse = 1
      • PartnerOrigin = 2
      • PartnerConsignee = 3
      • ContainerYard = 4
      • ExternalWarehouse = 5
  • destinationAddressAttention
    Type: string | null

    The attention for the destination address

  • destinationAuthorityToLeave
    Type: boolean

    Indicates whether authority has been granted to leave the item at the destination address.

  • dischargeShippingPort
    Type: object
    • code
      Type: string | null

      The shipping port code.

    • country
      Type: string | null

      The shipping port country.

    • id
      Type: stringFormat: uuid

      The ID of the shipping port.

    • name
      Type: string | null

      The shipping port name.

  • ediStatus
    Type: integer | nullFormat: int32

    The external EDI status of the consignment, for the current connection

  • expectedArrivalDateTime
    Type: string | nullFormat: date

    The date this consignment is expected to arrive at its destination.

  • expectedDeliveryDateTime
    Type: string | nullFormat: date

    The date and time consignment is expected to be delivered to its destination.

  • expectedDispatchDateTime
    Type: string | nullFormat: date

    The date and time consignment is expected to be dispatched from its origin.

  • externalId
    Type: string | null

    The consignment's external id.

  • id
    Type: stringFormat: uuid

    The ID of the consignment.

  • idempotencyKey
    Type: string | null

    The consignment's idempotency key.

  • isVoid
    Type: boolean

    The consignment's void status.

  • jobs
    Type: array object[] | null · ConsignmentDetailModel.JobModel[]

    A collection of jobs that this consignment is associated with.

    • description
      Type: string | null

      The description of the job

    • dueDateTime
      Type: string | nullFormat: date

      The due date time of the job

    • jobId
      Type: stringFormat: uuid

      The ID of the job

    • jobNumber
      Type: string | null

      The job number

    • position
      Type: integerFormat: int32

      The position of the consignment in the job

    • priority
      Type: integerenum

      Integer numbers.

      values
      • Normal = 2
      • High = 3
      • Urgent = 4
    • reference
      Type: string | null

      The reference of the job

    • status
      Type: integerenum

      Integer numbers.

      values
      • Draft = 1
      • ReadyToStart = 2
      • InProgress = 3
      • Complete = 4
      • Cancelled = 5
      • Incomplete = -2
      • Open = -1
    • type
      Type: integerenum

      Integer numbers.

      values
      • WavePick = 1
      • Replenishment = 2
    • wavePickStyle
      Type: integerenum

      Integer numbers.

      values
      • ParallelPicking = 1
      • BulkPicking = 2
  • loadShippingPort
    Type: object
    • code
      Type: string | null

      The shipping port code.

    • country
      Type: string | null

      The shipping port country.

    • id
      Type: stringFormat: uuid

      The ID of the shipping port.

    • name
      Type: string | null

      The shipping port name.

  • logisticUnits
    Type: array object[] | null · ConsignmentDetailModel.LogisticUnitModel[]

    A collection of the logistic units containing the consignment products

    • carrierReference
      Type: string | null

      The logistic unit carrier reference

    • dispatchedPercent
      Type: numberFormat: double
    • dispatchedQuantity
      Type: numberFormat: double
    • grossWeightKG
      Type: numberFormat: double

      The logistic unit gross weight in KG

    • heightMM
      Type: integer | nullFormat: int32

      The height of the logistic unit in millimetres

    • heldPercent
      Type: numberFormat: double
    • heldQuantity
      Type: numberFormat: double
    • id
      Type: stringFormat: uuid

      The logistic unit id

    • lengthMM
      Type: integer | nullFormat: int32

      The length of the logistic unit in millimetres

    • logisticUnitNumber
      Type: string | null

      The logistic unit number

    • packageType
      Type: object
    • pickedPercent
      Type: numberFormat: double
    • pickedQuantity
      Type: numberFormat: double
    • quantity
      Type: numberFormat: double

      The logistic unit quantity of items

    • receivedPercent
      Type: numberFormat: double
    • receivedQuantity
      Type: numberFormat: double
    • referenceNumber
      Type: string | null

      The logistic unit reference number

    • ssccNumber
      Type: string | null

      The logistic unit sscc number

    • tareWeightKG
      Type: numberFormat: double

      The logistic unit tare weight in KG

    • volumeM3
      Type: numberFormat: double

      The logistic unit volume in cubic meters

    • weightKG
      Type: numberFormat: double

      The logistic unit net weight in KG

    • widthMM
      Type: integer | nullFormat: int32

      The width of the logistic unit in millimetres

  • metrics
    Type: array object[] | null · ConsignmentDetailModel.MetricModel[]

    A collection of metrics associated with the consignment.

    • id
      Type: stringFormat: uuid

      The ID of the metric.

    • type
      Type: integerenum

      Integer numbers.

      values
      • WeightKG = 0
      • VolumeM3 = 1
      • Quantity = 2
      • UnitType = 3
      • VirtualPallets = 4
      • VirtualPalletPartThereof = 5
      • Items = 6
    • unitType
      Type: string | null

      The unit type of this metric.

    • value
      Type: numberFormat: double

      The value of this metric

  • notes
    Type: array object[] | null · ConsignmentDetailModel.NoteModel[]

    A collection of notes attached to the consignment.

    • attachmentCount
      Type: integerFormat: int32

      A count of the notes attachments

    • displayOnPrintOut
      Type: boolean

      Whether the note will be included when the associated consignment is exported or printed.

    • id
      Type: stringFormat: uuid

      The ID of the note.

    • note
      Type: string | null

      The body of the note.

  • originAddress
    Type: object
    • city
      Type: string | null

      The city of the address.

    • code
      Type: string | null

      The code of the address. Generally used for EDI mapping between systems.

    • country
      Type: string | null

      The country of the address.

    • email
      Type: string | null

      The email address of address.

    • id
      Type: stringFormat: uuid

      The address ID.

    • latitude
      Type: number | nullFormat: double

      The latitude of this address.

    • longitude
      Type: number | nullFormat: double

      The longitude of this address.

    • name
      Type: string | null

      The name of the address, e.g. a place name or title.

    • phone
      Type: string | null

      The phone number of address.

    • postCode
      Type: string | null

      The postal code of the address.

    • state
      Type: string | null

      The state of the address.

    • streetAddress
      Type: string | null

      The street address of the address.

    • suburb
      Type: string | null

      The suburb of the address. Optional.

    • type
      Type: integerenum

      Integer numbers.

      values
      • Adhoc = 0
      • Warehouse = 1
      • PartnerOrigin = 2
      • PartnerConsignee = 3
      • ContainerYard = 4
      • ExternalWarehouse = 5
  • originAddressAttention
    Type: string | null

    The attention for the origin address

  • pickingInstructions
    Type: string | null

    Picking instructions.

  • pods
    Type: array object[] | null · ConsignmentDetailModel.PodModel[]

    A collection of proof-of-deliveries attached to the consignment.

    • eventUtc
      Type: stringFormat: date

      When the delivery was completed.

    • externalUrl
      Type: string | null

      A link to an external webpage detailing the completion of the delivery.

    • id
      Type: stringFormat: uuid

      The ID of the proof-of-delivery.

    • signatoryName
      Type: string | null

      The name of the person who signed for the delivery.

  • poNumber
    Type: string | null

    Purchase order number.

  • products
    Type: array object[] | null · ConsignmentDetailModel.ProductModel[]

    A collection of the products which make up the consignment.

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

      A collection of the attributes of the product.

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

    • packagingDate
      Type: string | nullFormat: date-time

      This product's packaging date.

    • partnerProduct
      Type: object
    • 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.

  • receiversReference
    Type: string | null

    Receivers reference.

  • referenceNumber
    Type: string | null

    The reference number.

  • sendersReference
    Type: string | null

    Senders reference.

  • serviceTypes
    Type: array object[] | null · ServiceTypeHeaderModel[]

    The service types assigned to the consignment.

    • code
      Type: string | null

      The code of the service type.

    • id
      Type: stringFormat: uuid

      The ID of the service type.

    • name
      Type: string | null

      The name of the service type.

  • soNumber
    Type: string | null

    Sales order number.

  • sourceIntegrationType
    Type: integerenum

    Integer numbers.

    values
    • Custom = 1
    • Xero = 2
    • Icos = 3
    • Zapier = 4
    • Myob = 5
  • status
    Type: integerenum

    Integer numbers.

    values
    • Complete = 0
    • Pending = 1
    • ReadyToPick = 2
    • ReadyToDispatch = 3
    • ReadyToReceive = 4
  • tasks
    Type: array object[] | null · ConsignmentDetailModel.TaskModel[]

    A collection of tasks associated with the consignment.

    • id
      Type: stringFormat: uuid

      The ID of the consignment task.

    • taskTypeId
      Type: stringFormat: uuid

      The task type ID

    • taskTypeName
      Type: string | null

      The task type's name

    • value
      Type: numberFormat: double

      The value of this task

  • type
    Type: integerenum

    Integer numbers.

    values
    • PointToPoint = 0
    • Inwards = 1
    • Outwards = 2
  • warehouse
    Type: object
    • addressId
      Type: stringFormat: uuid

      The ID of the address associated with the warehouse.

    • code
      Type: string | null

      The code of the warehouse.

    • id
      Type: stringFormat: uuid

      The ID of the warehouse.

    • latitude
      Type: numberFormat: double

      The latitude of the warehouse address.

    • longitude
      Type: numberFormat: double

      The longitude of the warehouse address.

    • name
      Type: string | null

      The name of the warehouse.

    • status
      Type: integerenum

      Integer numbers.

      values
      • Active = 1
      • Inactive = 2
    • timezoneId
      Type: string | null

      Identifier for the warehouse time zone