ConsignmentHeaderModel

  • carrierCode
    Type: string | null

    The code of the carrier of this consignment, if any.

  • carrierId
    Type: string | nullFormat: uuid

    The ID of the carrier of this consignment, if any.

  • carrierName
    Type: string | null

    The name of the carrier of this consignment, if any.

  • carrierReferenceNumber
    Type: string | null

    The carrier's reference number of this consignment, if any.

  • carrierRunNumber
    Type: string | null

    The carrier's run number of this consignment, if any.

  • carrierRunOrdinal
    Type: integer | nullFormat: int32

    The carrier's run order of this consignment, if any.

  • client
    Type: string | null
    deprecated
    read-only

    The name of the client this consignment belongs to.

  • clientCode
    Type: string | null

    The code of the client this consignment belongs to.

  • clientId
    Type: stringFormat: uuid

    The ID of the client this consignment belongs to.

  • clientName
    Type: string | null

    The name of the client this consignment belongs to.

  • consignmentNumber
    Type: string | null

    The consignment number.

  • dateEntered
    Type: stringFormat: date

    When the consignment was added to the system.

  • ediStatus
    Type: integer | nullFormat: int32

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

  • id
    Type: stringFormat: uuid

    The ID of the consignment.

  • referenceNumber
    Type: string | null

    The consignment reference number.

  • status
    Type: integerenum

    Integer numbers.

    values
    • Complete = 0
    • Pending = 1
    • ReadyToPick = 2
    • ReadyToDispatch = 3
    • ReadyToReceive = 4
  • type
    Type: integerenum

    Integer numbers.

    values
    • PointToPoint = 0
    • Inwards = 1
    • Outwards = 2
  • warehouseCode
    Type: string | null

    The code of the warehouse this consignment belongs to.

  • warehouseId
    Type: string | nullFormat: uuid

    The ID of the warehouse this consignment belongs to.

  • warehouseName
    Type: string | null

    The name of the warehouse this consignment belongs to.