ConsignmentImportCreateModel

attachments
Type: array object[] | null · ConsignmentImportCreateModel.NoteModel.AttachmentModel[]
deprecated

A collection of attachment files for the consignment.
- content
  Type: string | null
  
  The Base64 content of the attachment file
- contentType
  Type: string | null
  
  The content type of the attachment file
- downloadUrl
  Type: string | null
  
  The url to download the attachment from, when the attachment is not provided in the request
- fileName
  Type: string | null
  
  The name of the attachment file
carrierCode
Type: string | null

The 3- or 4-digit code identifying the carrier.
carrierReference
Type: string | null

The carrier's reference
clientCode
Type: string | null

The client code.
consignmentType
Type: integerenum

Integer numbers.
values
- PointToPoint = 0
- Inwards = 1
- Outwards = 2
containerGrossWeightKG
Type: number | nullFormat: double

The container gross weight in kilograms.
containerNumber
Type: string | null

The container number.
containerSealNumber
Type: string | null

The container seal number.
containerSize
Type: integerenum

Integer numbers.
values
- TenFoot = 1
- TwentyFoot = 2
- FortyFoot = 3
- FortyFiveFoot = 4
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

The container's vessel's name.
containerVoyage
Type: string | null

The container's voyage name.
containerYardCode
Type: string | null

The 3-4 digit code identifying the container yard.
containerYardReference
Type: string | null

The container yards reference.
deliveryInstructions
Type: string | null

Any delivery instructions. 1000 char max.
destinationAddress
Type: object
- city
  Type: string | null
  
  The city of the address.
- code
  Type: string | null
  
  The code of the addressed person/company.
- country
  Type: string | null
  
  The country of the address.
- email
  Type: string | null
  
  The email of the addressed person/company.
- latitude
  Type: number | nullFormat: double
  
  The latitude coordinate for the address.
- longitude
  Type: number | nullFormat: double
  
  The longitude coordinate for the address.
- name
  Type: string | null
  
  The name of the addressed person/company.
- phone
  Type: string | null
  
  The phone of the addressed person/company.
- 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.
destinationAddressAttention
Type: string | null

The attention for the destination address
destinationAuthorityToLeave
Type: boolean | null

The authority to leave for the destination address
dischargeShippingPortCode
Type: string | null

The discharge shipping port. Use a 5 character port code, e.g. SGSIN.
enteredDate
Type: string | nullFormat: date-time

When this import was created.
expectedArrivalDateTime
Type: string | nullFormat: date-time

When this consignment is expected to arrive at its destination.
expectedDeliveryDateTime
Type: string | nullFormat: date-time

When this consignment is expected to be delivered to its destination.
expectedDispatchDateTime
Type: string | nullFormat: date-time

When this consignment is expected to be dispatched from its origin warehouse.
externalId
Type: string | null

The external identifier for the consigment import.
idempotencyKey
Type: string | null

The unique key for this import, subsequent calls with this value will be rejected. 200 char max.
loadShippingPortCode
Type: string | null

The load shipping port. Use a 5 character port code, e.g. SGSIN.
notes
Type: array object[] | null · ConsignmentImportCreateModel.NoteModel[]

A collection of notes for the consignment.
- attachments
  Type: array object[] | null · ConsignmentImportCreateModel.NoteModel.AttachmentModel[]
  
  A collection of attachment files on this note.
- displayOnPrintOut
  Type: boolean
  
  Whether this note should be displayed on printouts.
- note
  Type: string | null
  
  The note on this consignment.
originAddress
Type: object
- city
  Type: string | null
  
  The city of the address.
- code
  Type: string | null
  
  The code of the addressed person/company.
- country
  Type: string | null
  
  The country of the address.
- email
  Type: string | null
  
  The email of the addressed person/company.
- latitude
  Type: number | nullFormat: double
  
  The latitude coordinate for the address.
- longitude
  Type: number | nullFormat: double
  
  The longitude coordinate for the address.
- name
  Type: string | null
  
  The name of the addressed person/company.
- phone
  Type: string | null
  
  The phone of the addressed person/company.
- 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.
originAddressAttention
Type: string | null

The attention for the origin address
pickingInstructions
Type: string | null

Any picking instructions. 1000 char max.
poNumber
Type: string | null

Purchase order number. 100 char max.
products
Type: array object[] | null · ConsignmentImportCreateModel.ProductModel[]

A collection of products which make up the consignment.
- attributes
  Type: array object[] | null · ConsignmentImportCreateModel.ProductModel.AttributeModel[]
  
  A collection of the attributes to describe the product
- batch
  Type: string | null
  
  The batch number of the product.
- bestBeforeDate
  Type: string | nullFormat: date-time
  
  This product's best before date.
- criticalStockStatus
  Type: integerenum
  
  Integer numbers.
  
  values
  CriticalStock = 1
  NonCriticalStock = 2
- expiryDate
  Type: string | nullFormat: date-time
  
  This product's expiry date.
- goodsDescription
  Type: string | null
  
  A brief description of the product.
- isManualReconciliationRequired
  Type: boolean
  
  If this product requires manual import reconciliation
- items
  Type: array object[] | null · ConsignmentImportCreateModel.ProductModel.ItemModel[]
  
  A collection of the items to contained in the product group
- logisticUnitReferenceNumber
  Type: string | null
  
  This product's pallet's reference number
- logisticUnitSsccNumber
  Type: string | null
  
  This product's pallet's SSCC number
- packagingDate
  Type: string | nullFormat: date-time
  
  This product's packaging date.
- productCode
  Type: string | null
  
  The product code.
- productionDate
  Type: string | nullFormat: date-time
  
  This product's production date.
- sellByDate
  Type: string | nullFormat: date-time
  
  This product's sell by date.
receiversReference
Type: string | null

Receivers reference. 100 char max.
referenceNumber
Type: string | null

The consignment reference number.
sendersReference
Type: string | null

Senders reference. 100 char max.
serviceTypeCodes
Type: array string[] | null

A collection of service type codes for the consignment.
soNumber
Type: string | null

Sales order number. 100 char max.
warehouseCode
Type: string | null

The 3- or 4-digit code identifying the warehouse location.