ConsignmentImportCreateModel

  • attachments
    Type:
    deprecated

    A collection of attachment files for the consignment.

    Properties: 4
  • 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: enum

    Integer numbers.

    values
    PointToPoint = 0Inwards = 1Outwards = 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: enum

    Integer numbers.

    values
    TenFoot = 1TwentyFoot = 2FortyFoot = 3FortyFiveFoot = 4
  • containerTareWeightKG
    Type: number | nullFormat: double

    The container tare weight in kilograms.

  • containerType
    Type: enum

    Integer numbers.

    values
    • GeneralPurpose = 1
    • GeneralPurposeHighCube = 2
    • Refrigerated = 3
    • RefrigeratedHighCube = 4
    • RefrigeratedNotOperating = 5
    • RefrigeratedNotOperatingHighCube = 6
    • OpenTop = 7
    • OpenTopHighCube = 8
    • FlatRack = 9
    • FlatRackHighCube = 10
    • Tank = 11
    • TankHighCube = 12
  • 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:
    Properties: 12
  • 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:

    A collection of notes for the consignment.

    Properties: 3
  • originAddress
    Type:
    Properties: 12
  • 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:

    A collection of products which make up the consignment.

    Properties: 15
  • 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 of 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.