Shipping Instructions

Header Image
Project:
Shipping Instructions : Public Class
Created: 10/19/2023 2:43:53 PM
Modified: 12/20/2024 10:58:25 AM
Author: DCSA
Version: 2024.4
Project:
Advanced:
Note that multiple bookings can map to the same Shipping Instructions.<br/><br/>This is only possible when the following attributes are common for all:<br/><ul>
<li>Transport Plan</li><li>Shipment Locations</li><li>Receipt Type at Origin</li><li>Delivery Type at Destination</li><li>Cargo Movement Type at Origin</li><li>Cargo Movement Type at Destination</li><li>Service Contract Reference</li><li>Terms and Conditions</li><li>Invoice Payable AtPlace of B/L issue (if provided)</li></ul><p/>
  • Attributes
  • Associations To
  • Associations From
  • Advanced
  • Other Links
Attribute Scope Type
Shipping Instructions Reference Private String(100)
 
Shipping Instructions Status Code Private String(50)
 
Updated Shipping Instructions Status Code Private String(50)
Notes: The status of the Updated Shipping Instructions. It can only be UPDATE_CANCELLED<br/>
Transport Document Type Code Public String(3)
Notes: Specifies the type of the associated Transport Document (Bill of Lading or Sea Waybill)<br/>
Is Shipped On Board Type Protected Boolean
Notes: Specifies whether the Transport document type is a received for shipment or shipped onboard<br/>
Number Of Copies With Charges Private Integer
Notes: The requested number of copies of the Transport Document with charges to be issued by the carrier. Only applicable for physical documents <br/><b>If: </b><br/>Transport Document Type Code = BOL + Is Electronic = FALSE<br/><b>then:</b><br/>Indicates how many paper copies of the Original BL to be issued by the carrier with charges<br/><b>If:</b><br/>Transport Document Type Code = BOL + Is Electronic = TRUE<br/><b>then:</b><br/>Not applicable, there are no copies<br/>If:<br/>Transport Document Type Code = SWB + Is Electronic = FALSE<br/><b>then:</b><br/>Indicates that charges should be included in the SWB (pdf or other formats)<br/><b>If:</b><br/>Transport Document Type Code = SWB + Is Electronic = TRUE<br/><b>then:</b><br/>Indicates that charges should be included in the electronic SWB<br/>
Number Of Copies Without Charges Private Integer
Notes: The requested number of copies of the Transport Document without charges to be issued by the carrier. Only applicable for physical documents.<br/><b>If</b>:<br/>Transport Document Type Code = BOL + Is Electronic = FALSE<br/><b>then</b>:<br/>Indicates how many paper copies of the Original BL to be issued by the carrier without charges<br/><b>If</b>:<br/>Transport Document Type Code = BOL + Is Electronic = TRUE<br/><b>then</b>:<br/>Not applicable, there are no copies<br/><b>If</b>:<br/>Transport Document Type Code = SWB + Is Electronic = FALSE<br/><b>then</b>:<br/>Indicates that charges should NOT be included in the SWB (pdf or other formats)<br/><b>If</b>:<br/>Transport Document Type Code = SWB + Is Electronic = TRUE<br/><b>then</b>:<br/>Indicates that charges NOT should be included in the electronic SWB<br/>
Number Of Originals With Charges Private Integer
Notes: Number of originals of the bill of lading that have been requested by the customer with charges. Only applicable for physical documents<br/>
Number Of Originals Without Charges Private Integer
Notes: Number of originals of the bill of lading that have been requested by the customer without charges. Only applicable for physical documents<br/>
Freight Payment Term Code Private String(3)
Notes: An indicator of whether freight and ancillary fees for the main transport are prepaid (PRE) or collect (COL). When prepaid the charges are the responsibility of the shipper or the Invoice payer on behalf of the shipper (if provided). When collect, the charges are the responsibility of the consignee or the Invoice payer on behalf of the consignee (if provided).<br/>
Is Electronic Public Boolean
Notes: An indicator of whether the transport document is electronically transferred<br/>
Is To Order Public Boolean
Notes: Indicates whether the B/L is issued ‘to order’ or not. If TRUE, the B/L is considered negotiable and an Endorsee party can be defined in the Document parties. If no Endorsee is defined, the B/L is blank endorsed. If FALSE, the B/L is considered non-negotiable (also referred to as ‘straight’). Is to Order must be FALSE if Transport Document Type Code = SWB (Sea Waybill).<br/>
Is Carriers Agent At Destination Required Private Boolean
Notes: Indicates whether the Carrier's agent at destination name, address and contact details should be included in the `Transport Document`.<br/>
Displayed Name For Place Of Receipt Private String(35)
Notes: Note that this is an array of String.<br/>
Displayed Name For Port Of Load Private String(35)
Notes: Link to a Displayed Name to be used in order to specify how the Port of Load should be displayed on the transport document to match the name and/or address provided on the letter of credit<br/>
Displayed Name For Port Of Discharge Private String(35)
Notes: Link to a Displayed Name to be used in order to specify how the Port of Discharge should be displayed on the transport document to match the name and/or address provided on the letter of credit<br/>
Displayed Name For Place Of Delivery Private String(35)
Notes: Link to a Displayed Name to be used in order to specify how the Place of Delivery should be displayed on the transport document to match the name and/or address provided on the letter of credit<br/>
Is Cargo Delivered In ICS2 Zone Private Boolean
Notes: Indicates whether cargo is delivered to EU, Norway, Switzerland or Northern Ireland.<br/>
Is House Bill of Ladings Issued Private Boolean
Notes: Indicates whether one or more House Bill of Lading(s) have been issued.<br/><br/>Condition: Mandatory if manifestTypeCode is ENS<br/>
Requested Carrier Certificates Private String(100)
Notes: Name of the certificate. Detailed information about carrier certificates can be found here.<br/>
Requested Carrier Clauses Private Carrier Clause Code
 
Element Source Role Target Role
Party Contact Details
Class  
Name:  
 
Name:  
 
Details:
 
Invoice Payable At
Class  
Name:  
 
Name:  
 
Details:
 
Party
Class  
Name:  
 
Name: buyer
 
Details:
 
Location
Class  
Name:  
 
Name: place of shipping instructions issue
 
Details:
Must be provided by the shipper if the information is not part of the service contract or previously provided in the booking request.<br/>
Party
Class  
Name:  
 
Name: consignee
 
Details:
 
House Bill Of Lading
Class  
Name:  
 
Name:  
 
Details:
A list of `House Bill of Ladings` specified by the Shipper.<br/>
Feedback
Class  
Name:  
 
Name:  
 
Details:
 
Advance Manifest Filing
Class  
Name:  
 
Name:  
 
Details:
 
Party
Class  
Name:  
 
Name: issue to party
 
Details:
 
Shipping Instructions
Class  
Name: update
 
Name:  
 
Details:
 
Party
Class  
Name:  
 
Name: shipper
 
Details:
 
Party
Class  
Name:  
 
Name: other party
 
Details:
 
Party
Class  
Name:  
 
Name: seller
 
Details:
 
Element Source Role Target Role
Transport Document
Class  
Name:  
 
Name: Transport Document Reference
 
Details:
 
Party
Class  
Name: notify party
 
Name:  
 
Details:
The associated shipping instructions for the Document Party. There cannot be an association with both Shipping Instructions and Shipment.<br/>
Charges Payment Term
Class  
Name: origin charges
 
Name:  
 
Details:
 
Charges Payment Term
Class  
Name: destination charges
 
Name:  
 
Details:
 
Party
Class  
Name: endorsee
 
Name:  
 
Details:
 
Shipping Instructions
Class  
Name: update
 
Name:  
 
Details:
 
Consignment Item
Class  
Name:  
 
Name: Consignment Item Reference
 
Details:
 
Property Value
isFinalSpecialization: 0
Object Type Connection Direction Notes
Transport Document Class Dependency From  
Payment Term Type Code Enumeration Dependency To  
BR EBL Determination of Negotiable B/L with Named Endorsee Requirement Dependency To  
Transport Document Class Dependency From  
Shipping Instructions Update Code Enumeration Dependency To  
ShippingInstructions Class Dependency From  
Transport Document Class Dependency From  
ShippingInstructions Class Dependency From  
Transport Document Class Dependency From  
Transport Document Class Dependency From  
ShippingInstructions Class Dependency From  
BR EBL Determination of Straight Transport Document Requirement Dependency To  
Charges Payment Term Class Strong From  
Shipping Instructions Status Code Enumeration Dependency To  
Charges Payment Term Class Strong From  
Transport Document Class Dependency From  
ShippingInstructions Class Dependency From  
BR EBL Determination of Negotiable B/L with Named Endorsee Requirement Dependency To  
Shipping Instructions API Interface Dependency From  
Transport Document Type Code Enumeration Dependency To  
Transport Document Class Dependency From  
BR EBL Determination of Straight Transport Document Requirement Dependency To  
ShippingInstructions Class Dependency From  
ShippingInstructions Class Dependency From  
Transport Document Class Dependency From  
ShippingInstructions Class Dependency From  
Shipping Instructions API Interface Dependency From  
Transport Document Class Dependency From  
ShippingInstructions Class Dependency From  
ShippingInstructions Class Dependency From  
Carrier Certificate Group Code Enumeration Dependency To  
Transport Document Class Dependency From  
BR EBL Determination of Negotiable Blank Endorsed B/L Requirement Dependency To  
Transport Document Class Dependency From  
ShippingInstructions Class Dependency From  
ShippingInstructions Class Dependency From  
ShippingInstructions Class Dependency From  
ShippingInstructions Class Dependency From  
Transport Document Class Dependency From  
Shipping Instructions API Interface Dependency From  
ShippingInstructions Class Dependency From  
ShippingInstructions Class Dependency From  
ShippingInstructions Class Dependency From  
Transport Document Class Dependency From  
BR EBL Determination Shipping Instructions available as eBL Requirement Dependency To  
BK LDM IS this data type correct Issue Dependency From  
Transport Document Class Dependency From  
ShippingInstructions Class Dependency From  
Transport Document Status Code (DEPRECATED) Enumeration Dependency To  
Shipping Instructions API Interface Dependency From  
Carrier Clause Code Enumeration Dependency To  
BR EBL Determination of Negotiable Blank Endorsed B/L Requirement Dependency To  
ShippingInstructions Class Dependency From