ConsignmentDetailModel
- actualType: string | nullFormat: date
Dispatch Date Time The date and time consignment was dispatched from its origin.
- actualType: string | nullFormat: date
Receive Date Time The date and time this consignment was received at the warehouse.
- Properties: 7carrierType:
- carrierType: string | null
Reference Number The carrier reference number.
- carrierType: string | null
Run Number The carrier run number.
- carrierType: integer | nullFormat: int32
Run Ordinal The carrier order of the consignment for the run number.
- Properties: 7clientType:
- consignmentType: string | null
Number The consignment number.
- consignmentType:
Tracking Properties: 10A collection of tracking for this consignment.
- consumablesType:Properties: 4
A collection of consumables associated with the consignment.
- containerType: number | nullFormat: double
Gross Weight K G The container gross weight in kilograms.
- containerType: string | null
Number The container number.
- containerType: string | nullFormat: date
Received Date When the container was received.
- containerType: string | nullFormat: date
Returned Date When the container was returned.
- containerType: string | null
Seal Number The container seal number.
- containerType: enum
Size Integer numbers.
valuesTenFoot = 1TwentyFoot = 2FortyFoot = 3FortyFiveFoot = 4 - containerType: enum
Status Integer numbers.
valuesPending = 1Received = 2Returned = 3 - containerType: number | nullFormat: double
Tare Weight K G The container tare weight in kilograms.
- containerType: enum
Type Integer numbers.
values- General
Purpose = 1 - General
Purpose High Cube = 2 - Refrigerated = 3
- Refrigerated
High Cube = 4 - Refrigerated
Not Operating = 5 - Refrigerated
Not Operating High Cube = 6 - Open
Top = 7 - Open
Top High Cube = 8 - Flat
Rack = 9 - Flat
Rack High Cube = 10 - Tank = 11
- Tank
High Cube = 12
- General
- containerType: string | null
Vessel Name Container vessel name.
- containerType: string | null
Voyage Container voyage name.
- Properties: 11containerType:
Yard - containerType: string | null
Yard Reference Container yard reference.
- dateType: stringFormat: date
Entered The date this consignment was entered into the system.
- Properties: 2defaultType:
Dispatch Warehouse Location - Properties: 2defaultType:
Receive Warehouse Location - deliveryType: string | null
Instructions Delivery instructions.
- Properties: 14destinationType:
Address - destinationType: string | null
Address Attention The attention for the destination address
- destinationType: boolean
Authority To Leave Indicates whether authority has been granted to leave the item at the destination address.
- Properties: 4dischargeType:
Shipping Port - ediType: integer | nullFormat: int32
Status The external EDI status of the consignment, for the current connection
- expectedType: string | nullFormat: date
Arrival Date Time The date this consignment is expected to arrive at its destination.
- expectedType: string | nullFormat: date
Delivery Date Time The date and time consignment is expected to be delivered to its destination.
- expectedType: string | nullFormat: date
Dispatch Date Time The date and time consignment is expected to be dispatched from its origin.
- externalType: string | null
Id The consignment's external id.
- idType: stringFormat: uuid
The ID of the consignment.
- idempotencyType: string | null
Key The consignment's idempotency key.
- isType: boolean
Immutable Indicates whether the consignment is immutable.
- isType: boolean
Void Indicates whether the consignment is voided.
- jobsType:Properties: 10
A collection of jobs that this consignment is associated with.
- Properties: 4loadType:
Shipping Port - logisticType:
Units Properties: 22A collection of the logistic units containing the consignment products
- metricsType:Properties: 4
A collection of metrics associated with the consignment.
- notesType:Properties: 4
A collection of notes attached to the consignment.
- Properties: 14originType:
Address - originType: string | null
Address Attention The attention for the origin address
- pickingType: string | null
Instructions Picking instructions.
- podsType:Properties: 5
A collection of proof-of-deliveries attached to the consignment.
- poType: string | null
Number Purchase order number.
- productsType:Properties: 32
A collection of the products which make up the consignment.
- receiversType: string | null
Reference Receivers reference.
- referenceType: string | null
Number The reference number.
- sendersType: string | null
Reference Senders reference.
- serviceType:
Types Properties: 3The service types assigned to the consignment.
- soType: string | null
Number Sales order number.
- sourceType: enum
Integration Type Integer numbers.
values- Custom = 1
- Xero = 2
- Icos = 3
- Zapier = 4
- Myob = 5
- Gofreight = 6
- Go
Sweet Spot = 8 - Hercules = 9
- statusType: enum
Integer numbers.
valuesComplete = 0Pending = 1ReadyToPick = 2ReadyToDispatch = 3ReadyToReceive = 4InProgress = 5Closed = 6InTransit = 7Draft = 8Void = -2Open = -1 - tasksType:Properties: 4
A collection of tasks associated with the consignment.
- typeType: enum
Integer numbers.
valuesPointToPoint = 0Inwards = 1Outwards = 2 - Properties: 8warehouseType: