data-science-document-ai 1.56.1__py3-none-any.whl → 1.57.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (21) hide show
  1. {data_science_document_ai-1.56.1.dist-info → data_science_document_ai-1.57.0.dist-info}/METADATA +1 -1
  2. {data_science_document_ai-1.56.1.dist-info → data_science_document_ai-1.57.0.dist-info}/RECORD +21 -21
  3. src/constants.py +8 -26
  4. src/docai_processor_config.yaml +0 -13
  5. src/pdf_processing.py +29 -27
  6. src/prompts/library/bookingConfirmation/evergreen/placeholders.json +135 -21
  7. src/prompts/library/bookingConfirmation/evergreen/prompt.txt +21 -17
  8. src/prompts/library/bookingConfirmation/hapag-lloyd/placeholders.json +136 -22
  9. src/prompts/library/bookingConfirmation/hapag-lloyd/prompt.txt +52 -58
  10. src/prompts/library/bookingConfirmation/maersk/placeholders.json +135 -21
  11. src/prompts/library/bookingConfirmation/maersk/prompt.txt +10 -1
  12. src/prompts/library/bookingConfirmation/msc/placeholders.json +135 -21
  13. src/prompts/library/bookingConfirmation/msc/prompt.txt +10 -1
  14. src/prompts/library/bookingConfirmation/oocl/placeholders.json +149 -21
  15. src/prompts/library/bookingConfirmation/oocl/prompt.txt +11 -3
  16. src/prompts/library/bookingConfirmation/other/placeholders.json +149 -21
  17. src/prompts/library/bookingConfirmation/other/prompt.txt +56 -57
  18. src/prompts/library/bookingConfirmation/yangming/placeholders.json +149 -21
  19. src/prompts/library/bookingConfirmation/yangming/prompt.txt +11 -1
  20. src/setup.py +11 -9
  21. {data_science_document_ai-1.56.1.dist-info → data_science_document_ai-1.57.0.dist-info}/WHEEL +0 -0
src/prompts/library/bookingConfirmation/msc/placeholders.json CHANGED
@@ -1,32 +1,146 @@
1
1
  {
2
2
  "type": "OBJECT",
3
3
  "properties": {
4
- "cfsCutOff": {"type": "STRING", "nullable": true, "description": "the date by which an LCL (Less than Container Load) shipment needs to be checked in to a CFS (Container Freight Station) to meet its scheduled sailing"},
5
- "bookingNumber": {"type": "STRING", "nullable": true},
6
- "cyCutOff": {"type": "STRING", "nullable": true},
7
- "gateInReference": {"type": "STRING", "nullable": true},
8
- "gateInTerminal": {"type": "STRING", "nullable": true},
9
- "mblNumber": {"type": "STRING", "nullable": true},
10
- "pickUpReference": {"type": "STRING", "nullable": true},
11
- "pickUpTerminal": {"type": "STRING", "nullable": true},
12
- "siCutOff": {"type": "STRING", "nullable": true},
13
- "vgmCutOff": {"type": "STRING", "nullable": true},
4
+ "bookingNumber": {
5
+ "type": "STRING",
6
+ "nullable": true,
7
+ "description": "A unique identifier assigned to the shipment booking, used for tracking and reference. They are often referred to as 'Booking No.', 'Booking Reference', 'Our Reference', or 'Order Ref'."
8
+ },
9
+ "contractNumber": {
10
+ "type": "STRING",
11
+ "nullable": true,
12
+ "description": "It's a contract number between the carrier and Forto Logistics SE & Co KG."
13
+ },
14
+ "pickUpTerminalCode": {
15
+ "type": "STRING",
16
+ "nullable": true,
17
+ "description": "The specific terminal for cargo pickup during the import shipment."
18
+ },
19
+ "gateInTerminalCode": {
20
+ "type": "STRING",
21
+ "nullable": true,
22
+ "description": "The specific terminal where cargo is gated in especially Export terminal delivery address. E.g., Export terminal delivery address, Export terminal location, or Export terminal name."
23
+ },
24
+ "performaDate": {
25
+ "type": "STRING",
26
+ "nullable": true,
27
+ "description": "The date considered to apply the rates and charges specified in the booking confirmation"
28
+ },
29
+ "cyCutOff": {
30
+ "type": "STRING",
31
+ "nullable": true,
32
+ "description": "The datetime by which the cargo to be delivered to the Container Yard. It can be found with keys FCL delivery cut-off, FCL DG delivery cut-off, CY CUT OFF, CY Closing."
33
+ },
34
+ "gateInReference": {
35
+ "type": "STRING",
36
+ "nullable": true,
37
+ "description": "A reference code for cargo entering the terminal to drop the loaded cargo for Export. Sometimes it can be 'Our Reference'."
38
+ },
39
+ "mblNumber": {
40
+ "type": "STRING",
41
+ "nullable": true,
42
+ "description": "Bill of Lading number (B/L NO.), a document issued by the carrier."
43
+ },
44
+ "pickUpReference": {
45
+ "type": "STRING",
46
+ "nullable": true,
47
+ "description": "A reference code for cargo pickup during the import shipment. Sometimes it can be 'Our Reference'."
48
+ },
49
+ "siCutOff": {
50
+ "type": "STRING",
51
+ "nullable": true,
52
+ "description": "The deadline datetime for submitting the Shipping Instructions (SI) to the carrier. It can be found with keys Shipping Instruction Closing."
53
+ },
54
+ "vgmCutOff": {
55
+ "type": "STRING",
56
+ "nullable": true,
57
+ "description": "The deadline datetime for submitting the Verified Gross Mass (VGM) to the carrier. It can be found with keys VGM DEADLINE, VGM DUE, VGM CUT OFF."
58
+ },
59
+ "containers": {
60
+ "type": "ARRAY",
61
+ "items": {
62
+ "type": "OBJECT",
63
+ "properties": {
64
+ "containerType": {
65
+ "type": "STRING",
66
+ "nullable": true,
67
+ "description": "The size / type of the container, such as 20ft, 40ft, 40HC, 20DC etc under Type/Size column."
68
+ },
69
+ "pickUpDepotCode": {
70
+ "type": "STRING",
71
+ "nullable": true,
72
+ "description": "The depot code where the empty container will be picked up. It is identified as Empty Pick Up Depot or Export Empty Pick Up Depot(s)."
73
+ },
74
+ "dropOffDepotCode": {
75
+ "type": "STRING",
76
+ "nullable": true,
77
+ "description": "The depot code where the empty container will be dropped off."
78
+ }
79
+ }
80
+ },
81
+ "required": ["containerType", "pickupDepotCode", "dropoffDepotCode"]
82
+ },
14
83
  "transportLegs": {
15
84
  "type": "ARRAY",
16
85
  "items": {
17
86
  "type": "OBJECT",
18
87
  "properties": {
19
- "eta": {"type": "STRING", "nullable": true},
20
- "etd": {"type": "STRING", "nullable": true},
21
- "imoNumber": {"type": "STRING", "nullable": true},
22
- "portOfDischarge": {"type": "STRING", "nullable": true},
23
- "portOfLoading": {"type": "STRING", "nullable": true},
24
- "vesselName": {"type": "STRING", "nullable": true},
25
- "voyage": {"type": "STRING", "nullable": true}
26
- },
27
- "required": []
28
- }
88
+ "eta": {
89
+ "type": "STRING",
90
+ "nullable": true,
91
+ "description": "Estimated Time of Arrival (ETA) is the expected date when the shipment will arrive at its destination."
92
+ },
93
+ "etd": {
94
+ "type": "STRING",
95
+ "nullable": true,
96
+ "description": "Estimated Time of Departure (ETD) is the expected date when the shipment will leave the origin port."
97
+ },
98
+ "imoNumber": {
99
+ "type": "STRING",
100
+ "nullable": true,
101
+ "description": "The International Maritime Organization number for a specific leg. It can be found as IMO No, IMO number."
102
+ },
103
+ "portOfDischarge": {
104
+ "type": "STRING",
105
+ "nullable": true,
106
+ "description": "The port where the goods are discharged from the vessel. This is the destination port for the shipment. It can be found at POD, Port of Discharge, To, Discharge Port"
107
+ },
108
+ "portOfLoading": {
109
+ "type": "STRING",
110
+ "nullable": true,
111
+ "description": "The port where the goods are loaded onto the vessel. This is the origin port for the shipment. It can be found at POL, Port of Loading, From, Load Port"
112
+ },
113
+ "vesselName": {
114
+ "type": "STRING",
115
+ "nullable": true,
116
+ "description": "The name of the vessel carrying the shipment. It can be found at vessel, INTENDED VESSEL/VOYAGE"
117
+ },
118
+ "voyage": {
119
+ "type": "STRING",
120
+ "nullable": true,
121
+ "description": "The journey or route taken by the vessel for a specific leg. It can be found at Voy. no, INTENDED VESSEL/VOYAGE"
122
+ }
123
+ }
124
+ },
125
+ "required": [
126
+ "eta",
127
+ "etd",
128
+ "portOfDischarge",
129
+ "portOfLoading",
130
+ "vesselName",
131
+ "voyage"
132
+ ]
133
+ },
134
+ "carrierAddress": {
135
+ "type": "STRING",
136
+ "nullable": true,
137
+ "description": "The address of the carrier who provides service and issued the document."
138
+ },
139
+ "carrierName": {
140
+ "type": "STRING",
141
+ "nullable": true,
142
+ "description": "The name of the carrier who issued the document e,g, Hapag-Lloyd."
29
143
  }
30
144
  },
31
- "required": []
145
+ "required": ["bookingNumber", "transportLegs", "containers", "cyCutOff", "vgmCutOff", "siCutOff"]
32
146
  }
src/prompts/library/bookingConfirmation/msc/prompt.txt CHANGED
@@ -1,4 +1,13 @@
1
- You are a document entity extraction specialist. Given a document, the explained datapoint need to extract.
1
+ <PERSONA> You are an efficient document entity data extraction specialist working for a Freight Forwarding company. <PERSONA>
2
+
3
+ <TASK> Your task is to extract data from Booking Confirmation documents as per the given response schema structure. <TASK>
4
+
5
+ <CONTEXT>
6
+ The Freight Forwarding company receives Booking Confirmation from MSC Carrier (Shipping Lines) partners.
7
+ These Booking Confirmations contain various details related to booking, container pick up and drop off depot details, vessel details, as well as other transport Legs data.
8
+ They may be written in different languages such as English, German, Vietnamese, Chinese, and other European languages, and can appear in a variety of formats and layouts.
9
+ Your role is to accurately extract specific entities from these Booking Confirmations to support efficient processing and accurate record-keeping.
10
+ <CONTEXT>
2
11
 
3
12
  bookingNumber: A unique identifier for the booking.
4
13
  cyCutOff: The deadline for cargo to be delivered to the Container Yard.
src/prompts/library/bookingConfirmation/oocl/placeholders.json CHANGED
@@ -1,32 +1,160 @@
1
1
  {
2
2
  "type": "OBJECT",
3
3
  "properties": {
4
- "cfsCutOff": {"type": "STRING", "nullable": true, "description": "the date by which an LCL (Less than Container Load) shipment needs to be checked in to a CFS (Container Freight Station) to meet its scheduled sailing"},
5
- "bookingNumber": {"type": "STRING", "nullable": true},
6
- "cyCutOff": {"type": "STRING", "nullable": true},
7
- "gateInReference": {"type": "STRING", "nullable": true},
8
- "gateInTerminal": {"type": "STRING", "nullable": true},
9
- "mblNumber": {"type": "STRING", "nullable": true},
10
- "pickUpReference": {"type": "STRING", "nullable": true},
11
- "pickUpTerminal": {"type": "STRING", "nullable": true},
12
- "siCutOff": {"type": "STRING", "nullable": true},
13
- "vgmCutOff": {"type": "STRING", "nullable": true},
4
+ "bookingNumber": {
5
+ "type": "STRING",
6
+ "nullable": true,
7
+ "description": "A unique identifier assigned to the shipment booking, used for tracking and reference. They are often referred to as 'Booking Number', 'Booking No.', 'Booking Ref.', 'Booking Reference', 'Booking ID', 'carrier's reference' or 'Order Ref'."
8
+ },
9
+ "contractNumber": {
10
+ "type": "STRING",
11
+ "nullable": true,
12
+ "description": "It's a contract number between the carrier and Forto Logistics SE & Co KG."
13
+ },
14
+ "pickUpTerminalCode": {
15
+ "type": "STRING",
16
+ "nullable": true,
17
+ "description": "The specific terminal for cargo pickup during the import shipment."
18
+ },
19
+ "gateInTerminalCode": {
20
+ "type": "STRING",
21
+ "nullable": true,
22
+ "description": "The specific terminal where cargo is gated in especially Export terminal delivery address"
23
+ },
24
+ "serviceCode": {
25
+ "type": "STRING",
26
+ "nullable": true,
27
+ "description": "The Shipping service code associated with the booking confirmation."
28
+ },
29
+ "performaDate": {
30
+ "type": "STRING",
31
+ "nullable": true,
32
+ "description": "the date considered to apply the rates and charges specified in the booking confirmation"
33
+ },
34
+ "cfsCutOff": {
35
+ "type": "STRING",
36
+ "nullable": true,
37
+ "description": "the date by which an LCL (Less than Container Load) shipment needs to be checked in to a CFS (Container Freight Station) to meet its scheduled sailing"
38
+ },
39
+ "cyCutOff": {
40
+ "type": "STRING",
41
+ "nullable": true,
42
+ "description": "The date by which the cargo to be delivered to the Container Yard. It can be found with keys FCL delivery cut-off, CY CUT OFF, CY Closing."
43
+ },
44
+ "gateInReference": {
45
+ "type": "STRING",
46
+ "nullable": true,
47
+ "description": "A reference code for cargo entering the terminal to drop the loaded cargo for Export. Sometimes it can be 'Our Reference'."
48
+ },
49
+ "mblNumber": {
50
+ "type": "STRING",
51
+ "nullable": true,
52
+ "description": "Bill of Lading number (B/L NO.), a document issued by the carrier."
53
+ },
54
+ "pickUpReference": {
55
+ "type": "STRING",
56
+ "nullable": true,
57
+ "description": "A reference code for cargo pickup during the import shipment. Sometimes it can be 'Our Reference'"
58
+ },
59
+ "siCutOff": {
60
+ "type": "STRING",
61
+ "nullable": true,
62
+ "description": "The deadline date for submitting the Shipping Instructions (SI) to the carrier. It can be found with keys SI DEADLINE, SI DUE, SI CUT OFF, B/L INSTRUCTION DEADLINE."
63
+ },
64
+ "vgmCutOff": {
65
+ "type": "STRING",
66
+ "nullable": true,
67
+ "description": "The deadline date for submitting the Verified Gross Mass (VGM) to the carrier. It can be found with keys VGM DEADLINE, VGM DUE, VGM CUT OFF."
68
+ },
69
+ "containers": {
70
+ "type": "ARRAY",
71
+ "items": {
72
+ "type": "OBJECT",
73
+ "properties": {
74
+ "containerType": {
75
+ "type": "STRING",
76
+ "nullable": true,
77
+ "description": "The size / type of the container, such as 20ft, 40ft, 40HC, 20DC etc."
78
+ },
79
+ "pickUpDepotCode": {
80
+ "type": "STRING",
81
+ "nullable": true,
82
+ "description": "The depot code where the empty container will be picked up."
83
+ },
84
+ "dropOffDepotCode": {
85
+ "type": "STRING",
86
+ "nullable": true,
87
+ "description": "The depot code where the empty container will be dropped off."
88
+ }
89
+ }
90
+ },
91
+ "required": [
92
+ "containerType",
93
+ "pickupDepotCode",
94
+ "dropoffDepotCode"
95
+ ]
96
+ },
14
97
  "transportLegs": {
15
98
  "type": "ARRAY",
16
99
  "items": {
17
100
  "type": "OBJECT",
18
101
  "properties": {
19
- "eta": {"type": "STRING", "nullable": true},
20
- "etd": {"type": "STRING", "nullable": true},
21
- "portOfDischarge": {"type": "STRING", "nullable": true},
22
- "portOfLoading": {"type": "STRING", "nullable": true},
23
- "vesselName": {"type": "STRING", "nullable": true},
24
- "voyage": {"type": "STRING", "nullable": true},
25
- "imoNumber": {"type": "STRING", "nullable": true}
26
- },
27
- "required": []
28
- }
102
+ "eta": {
103
+ "type": "STRING",
104
+ "nullable": true,
105
+ "description": "Estimated Time of Arrival (ETA) is the expected date when the shipment will arrive at its destination."
106
+ },
107
+ "etd": {
108
+ "type": "STRING",
109
+ "nullable": true,
110
+ "description": "Estimated Time of Departure (ETD) is the expected date when the shipment will leave the origin port."
111
+ },
112
+ "imoNumber": {
113
+ "type": "STRING",
114
+ "nullable": true,
115
+ "description": "The International Maritime Organization number for a specific leg. It can be found as IMO No, IMO number."
116
+ },
117
+ "portOfDischarge": {
118
+ "type": "STRING",
119
+ "nullable": true,
120
+ "description": "The port where the goods are discharged from the vessel. This is the destination port for the shipment."
121
+ },
122
+ "portOfLoading": {
123
+ "type": "STRING",
124
+ "nullable": true,
125
+ "description": "The port where the goods are loaded onto the vessel. This is the origin port for the shipment."
126
+ },
127
+ "vesselName": {
128
+ "type": "STRING",
129
+ "nullable": true,
130
+ "description": "The name of the vessel carrying the shipment. It can be found at vessel, INTENDED VESSEL/VOYAGE"
131
+ },
132
+ "voyage": {
133
+ "type": "STRING",
134
+ "nullable": true,
135
+ "description": "The journey or route taken by the vessel for a specific leg. It can be found at Voy. no, INTENDED VESSEL/VOYAGE"
136
+ }
137
+ }
138
+ },
139
+ "required": [
140
+ "eta",
141
+ "etd",
142
+ "portOfDischarge",
143
+ "portOfLoading",
144
+ "vesselName",
145
+ "voyage"
146
+ ]
147
+ },
148
+ "carrierAddress": {
149
+ "type": "STRING",
150
+ "nullable": true,
151
+ "description": "The address of the carrier who provides service and issued the document."
152
+ },
153
+ "carrierName": {
154
+ "type": "STRING",
155
+ "nullable": true,
156
+ "description": "The name of the carrier who issued the document."
29
157
  }
30
158
  },
31
- "required": []
159
+ "required": ["bookingNumber", "transportLegs", "containers", "cyCutOff", "vgmCutOff", "siCutOff"]
32
160
  }
src/prompts/library/bookingConfirmation/oocl/prompt.txt CHANGED
@@ -1,11 +1,20 @@
1
- your task is to extract the text value of the following entities and page numbers starting from 0 where the value was found in the document:
1
+ <PERSONA> You are an efficient document entity data extraction specialist working for a Freight Forwarding company. <PERSONA>
2
+
3
+ <TASK> Your task is to extract data from Booking Confirmation documents as per the given response schema structure. <TASK>
4
+
5
+ <CONTEXT>
6
+ The Freight Forwarding company receives Booking Confirmation from OOCL Carrier (Shipping Lines) partners.
7
+ These Booking Confirmations contain various details related to booking, container pick up and drop off depot details, vessel details, as well as other transport Legs data.
8
+ They may be written in different languages such as English, German, Vietnamese, Chinese, and other European languages, and can appear in a variety of formats and layouts.
9
+ Your role is to accurately extract specific entities from these Booking Confirmations to support efficient processing and accurate record-keeping.
10
+ <CONTEXT>
2
11
 
3
12
  bookingNumber: Extract the booking number. This information can be found near the labels "BOOKING ACKNOWLEDGEMENT" or "BOOKING NUMBER".
4
13
  gateInReference: This field should have the same value as the bookingNumber.
5
14
  cyCutOff: Look for the "INTENDED FCL CY CUT-OFF" label and extract the date and time value.
6
15
  vgmCutOff: Look for the "INTENDED VGM CUT-OFF" label and extract the date and time value.
7
16
  siCutOff: Look for the "INTENDED SI CUT-OFF" label and extract the date and time value.
8
- pickUpTerminal: Extract the pick-up terminal information, which can be found near the "EMPTY PICKUP LOCATION" label.
17
+ pickUpTerminal: Extract the pick-up terminal information, which can be found near the "EMPTY PICKUP LOCATION" label.
9
18
  transportLegs: This field should contain a list of two dictionaries. The first dictionary represents the first transport leg, starting with the initial "PORT OF LOADING" and ending with the "TRANSSHIPMENT PORT". The second dictionary represents the second transport leg, starting with the "TRANSSHIPMENT PORT" and ending with the "FINAL DESTINATION".
10
19
  eta: Within each transport leg, extract the estimated time of arrival (ETA) value, which is usually located near the "ETA" label. Eta should be a later date than etd! Ignore the first ETA label in the document that is on the line that starts with "INTENDED VESSEL/VOYAGE". For the first transport leg the correct eta is on the line that starts with "T/S". For the second leg the correct eta is on the line that starts with "FINAL DESTINATION".
11
20
  etd: Within each transport leg, extract the estimated time of departure (ETD) value, which is usually located near the "ETD" label.
@@ -13,4 +22,3 @@ portOfDischarge: Within the second transport leg, extract the port of discharge
13
22
  portOfLoading: Extract the port of loading information, which can be found near the "PORT OF LOADING" label.
14
23
  vesselName: Within each transport leg, extract the vessel name, which can be found near the labels "INTENDED VESSEL/VOYAGE" or "T/S INTENDED VESSEL/VOYAGE".
15
24
  voyage: Within each transport leg, extract the voyage number, which is usually located right after the vessel name.
16
-
src/prompts/library/bookingConfirmation/other/placeholders.json CHANGED
@@ -1,32 +1,160 @@
1
1
  {
2
2
  "type": "OBJECT",
3
3
  "properties": {
4
- "cfsCutOff": {"type": "STRING", "nullable": true, "description": "the date by which an LCL (Less than Container Load) shipment needs to be checked in to a CFS (Container Freight Station) to meet its scheduled sailing"},
5
- "bookingNumber": {"type": "STRING", "nullable": true},
6
- "cyCutOff": {"type": "STRING", "nullable": true},
7
- "gateInReference": {"type": "STRING", "nullable": true},
8
- "gateInTerminal": {"type": "STRING", "nullable": true},
9
- "mblNumber": {"type": "STRING", "nullable": true},
10
- "pickUpReference": {"type": "STRING", "nullable": true},
11
- "pickUpTerminal": {"type": "STRING", "nullable": true},
12
- "siCutOff": {"type": "STRING", "nullable": true},
13
- "vgmCutOff": {"type": "STRING", "nullable": true},
4
+ "bookingNumber": {
5
+ "type": "STRING",
6
+ "nullable": true,
7
+ "description": "A unique identifier assigned to the shipment booking, used for tracking and reference. They are often referred to as 'Booking Number', 'Booking No.', 'Booking Ref.', 'Booking Reference', 'Booking ID', 'carrier's reference' or 'Order Ref'."
8
+ },
9
+ "contractNumber": {
10
+ "type": "STRING",
11
+ "nullable": true,
12
+ "description": "It's a contract number between the carrier and Forto Logistics SE & Co KG."
13
+ },
14
+ "pickUpTerminalCode": {
15
+ "type": "STRING",
16
+ "nullable": true,
17
+ "description": "The specific terminal for cargo pickup during the import shipment."
18
+ },
19
+ "gateInTerminalCode": {
20
+ "type": "STRING",
21
+ "nullable": true,
22
+ "description": "The specific terminal where cargo is gated in especially Export terminal delivery address"
23
+ },
24
+ "serviceCode": {
25
+ "type": "STRING",
26
+ "nullable": true,
27
+ "description": "The Shipping service code associated with the booking confirmation."
28
+ },
29
+ "performaDate": {
30
+ "type": "STRING",
31
+ "nullable": true,
32
+ "description": "the date considered to apply the rates and charges specified in the booking confirmation"
33
+ },
34
+ "cfsCutOff": {
35
+ "type": "STRING",
36
+ "nullable": true,
37
+ "description": "the date by which an LCL (Less than Container Load) shipment needs to be checked in to a CFS (Container Freight Station) to meet its scheduled sailing"
38
+ },
39
+ "cyCutOff": {
40
+ "type": "STRING",
41
+ "nullable": true,
42
+ "description": "The date by which the cargo to be delivered to the Container Yard. It can be found with keys FCL delivery cut-off, CY CUT OFF, CY Closing."
43
+ },
44
+ "gateInReference": {
45
+ "type": "STRING",
46
+ "nullable": true,
47
+ "description": "A reference code for cargo entering the terminal to drop the loaded cargo for Export. Sometimes it can be 'Our Reference'."
48
+ },
49
+ "mblNumber": {
50
+ "type": "STRING",
51
+ "nullable": true,
52
+ "description": "Bill of Lading number (B/L NO.), a document issued by the carrier."
53
+ },
54
+ "pickUpReference": {
55
+ "type": "STRING",
56
+ "nullable": true,
57
+ "description": "A reference code for cargo pickup during the import shipment. Sometimes it can be 'Our Reference'"
58
+ },
59
+ "siCutOff": {
60
+ "type": "STRING",
61
+ "nullable": true,
62
+ "description": "The deadline date for submitting the Shipping Instructions (SI) to the carrier. It can be found with keys SI DEADLINE, SI DUE, SI CUT OFF, B/L INSTRUCTION DEADLINE."
63
+ },
64
+ "vgmCutOff": {
65
+ "type": "STRING",
66
+ "nullable": true,
67
+ "description": "The deadline date for submitting the Verified Gross Mass (VGM) to the carrier. It can be found with keys VGM DEADLINE, VGM DUE, VGM CUT OFF."
68
+ },
69
+ "containers": {
70
+ "type": "ARRAY",
71
+ "items": {
72
+ "type": "OBJECT",
73
+ "properties": {
74
+ "containerType": {
75
+ "type": "STRING",
76
+ "nullable": true,
77
+ "description": "The size / type of the container, such as 20ft, 40ft, 40HC, 20DC etc."
78
+ },
79
+ "pickUpDepotCode": {
80
+ "type": "STRING",
81
+ "nullable": true,
82
+ "description": "The depot code where the empty container will be picked up."
83
+ },
84
+ "dropOffDepotCode": {
85
+ "type": "STRING",
86
+ "nullable": true,
87
+ "description": "The depot code where the empty container will be dropped off."
88
+ }
89
+ }
90
+ },
91
+ "required": [
92
+ "containerType",
93
+ "pickupDepotCode",
94
+ "dropoffDepotCode"
95
+ ]
96
+ },
14
97
  "transportLegs": {
15
98
  "type": "ARRAY",
16
99
  "items": {
17
100
  "type": "OBJECT",
18
101
  "properties": {
19
- "eta": {"type": "STRING", "nullable": true},
20
- "etd": {"type": "STRING", "nullable": true},
21
- "imoNumber": {"type": "STRING", "nullable": true},
22
- "portOfDischarge": {"type": "STRING", "nullable": true},
23
- "portOfLoading": {"type": "STRING", "nullable": true},
24
- "vesselName": {"type": "STRING", "nullable": true},
25
- "voyage": {"type": "STRING", "nullable": true}
26
- },
27
- "required": []
28
- }
102
+ "eta": {
103
+ "type": "STRING",
104
+ "nullable": true,
105
+ "description": "Estimated Time of Arrival (ETA) is the expected date when the shipment will arrive at its destination."
106
+ },
107
+ "etd": {
108
+ "type": "STRING",
109
+ "nullable": true,
110
+ "description": "Estimated Time of Departure (ETD) is the expected date when the shipment will leave the origin port."
111
+ },
112
+ "imoNumber": {
113
+ "type": "STRING",
114
+ "nullable": true,
115
+ "description": "The International Maritime Organization number for a specific leg. It can be found as IMO No, IMO number."
116
+ },
117
+ "portOfDischarge": {
118
+ "type": "STRING",
119
+ "nullable": true,
120
+ "description": "The port where the goods are discharged from the vessel. This is the destination port for the shipment."
121
+ },
122
+ "portOfLoading": {
123
+ "type": "STRING",
124
+ "nullable": true,
125
+ "description": "The port where the goods are loaded onto the vessel. This is the origin port for the shipment."
126
+ },
127
+ "vesselName": {
128
+ "type": "STRING",
129
+ "nullable": true,
130
+ "description": "The name of the vessel carrying the shipment. It can be found at vessel, INTENDED VESSEL/VOYAGE"
131
+ },
132
+ "voyage": {
133
+ "type": "STRING",
134
+ "nullable": true,
135
+ "description": "The journey or route taken by the vessel for a specific leg. It can be found at Voy. no, INTENDED VESSEL/VOYAGE"
136
+ }
137
+ }
138
+ },
139
+ "required": [
140
+ "eta",
141
+ "etd",
142
+ "portOfDischarge",
143
+ "portOfLoading",
144
+ "vesselName",
145
+ "voyage"
146
+ ]
147
+ },
148
+ "carrierAddress": {
149
+ "type": "STRING",
150
+ "nullable": true,
151
+ "description": "The address of the carrier who provides service and issued the document."
152
+ },
153
+ "carrierName": {
154
+ "type": "STRING",
155
+ "nullable": true,
156
+ "description": "The name of the carrier who issued the document."
29
157
  }
30
158
  },
31
- "required": []
159
+ "required": ["bookingNumber", "transportLegs", "containers", "cyCutOff", "vgmCutOff", "siCutOff"]
32
160
  }