[Home] [Help]
PACKAGE: APPS.WSH_SHIPMENT_ADVICE_PUB
Source
1 PACKAGE WSH_SHIPMENT_ADVICE_PUB AUTHID CURRENT_USER as
2 /* $Header: WSHSAPBS.pls 120.0.12010000.1 2010/02/25 17:14:03 sankarun noship $ */
3 /*#
4 * This is the public interface for the Shipment Advice entity. It allows
5 * execution of 'creation' of Shipment Advice and 'Processing' the same.
6 * @rep:scope public
7 * @rep:product WSH
8 * @rep:displayname Shipment Advice
9 * @rep:lifecycle active
10 * @rep:category BUSINESS_ENTITY WSH_SHIPMENT_ADVICE
11 */
12
13 --===================
14 -- PUBLIC VARS
15 --===================
16
17 TYPE Freight_Cost_Rec_Type IS RECORD (
18 freight_cost_type_code WSH_FREIGHT_COSTS_INTERFACE.freight_cost_type_code%TYPE,
19 unit_amount WSH_FREIGHT_COSTS_INTERFACE.unit_amount%TYPE,
20 currency_code WSH_FREIGHT_COSTS_INTERFACE.currency_code%TYPE,
21 attribute_category WSH_FREIGHT_COSTS_INTERFACE.attribute_category%TYPE,
22 attribute1 WSH_FREIGHT_COSTS_INTERFACE.attribute1%TYPE,
23 attribute2 WSH_FREIGHT_COSTS_INTERFACE.attribute2%TYPE,
24 attribute3 WSH_FREIGHT_COSTS_INTERFACE.attribute3%TYPE,
25 attribute4 WSH_FREIGHT_COSTS_INTERFACE.attribute4%TYPE,
26 attribute5 WSH_FREIGHT_COSTS_INTERFACE.attribute5%TYPE,
27 attribute6 WSH_FREIGHT_COSTS_INTERFACE.attribute6%TYPE,
28 attribute7 WSH_FREIGHT_COSTS_INTERFACE.attribute7%TYPE,
29 attribute8 WSH_FREIGHT_COSTS_INTERFACE.attribute8%TYPE,
30 attribute9 WSH_FREIGHT_COSTS_INTERFACE.attribute9%TYPE,
31 attribute10 WSH_FREIGHT_COSTS_INTERFACE.attribute10%TYPE,
32 attribute11 WSH_FREIGHT_COSTS_INTERFACE.attribute11%TYPE,
33 attribute12 WSH_FREIGHT_COSTS_INTERFACE.attribute12%TYPE,
34 attribute13 WSH_FREIGHT_COSTS_INTERFACE.attribute13%TYPE,
35 attribute14 WSH_FREIGHT_COSTS_INTERFACE.attribute14%TYPE,
36 attribute15 WSH_FREIGHT_COSTS_INTERFACE.attribute15%TYPE );
37
38 TYPE Freight_Cost_Rec_Tab IS TABLE OF Freight_Cost_Rec_Type index by binary_integer;
39
40 TYPE Container_Rec_Type IS RECORD (
41 delivery_detail_number WSH_DEL_DETAILS_INTERFACE.delivery_detail_id%TYPE,
42 attribute_category WSH_DEL_DETAILS_INTERFACE.attribute_category%TYPE,
43 attribute1 WSH_DEL_DETAILS_INTERFACE.attribute1%TYPE,
44 attribute2 WSH_DEL_DETAILS_INTERFACE.attribute2%TYPE,
45 attribute3 WSH_DEL_DETAILS_INTERFACE.attribute3%TYPE,
46 attribute4 WSH_DEL_DETAILS_INTERFACE.attribute4%TYPE,
47 attribute5 WSH_DEL_DETAILS_INTERFACE.attribute5%TYPE,
48 attribute6 WSH_DEL_DETAILS_INTERFACE.attribute6%TYPE,
49 attribute7 WSH_DEL_DETAILS_INTERFACE.attribute7%TYPE,
50 attribute8 WSH_DEL_DETAILS_INTERFACE.attribute8%TYPE,
51 attribute9 WSH_DEL_DETAILS_INTERFACE.attribute9%TYPE,
52 attribute10 WSH_DEL_DETAILS_INTERFACE.attribute10%TYPE,
53 attribute11 WSH_DEL_DETAILS_INTERFACE.attribute11%TYPE,
54 attribute12 WSH_DEL_DETAILS_INTERFACE.attribute12%TYPE,
55 attribute13 WSH_DEL_DETAILS_INTERFACE.attribute13%TYPE,
56 attribute14 WSH_DEL_DETAILS_INTERFACE.attribute14%TYPE,
57 attribute15 WSH_DEL_DETAILS_INTERFACE.attribute15%TYPE,
58 container_name WSH_DEL_DETAILS_INTERFACE.container_name%TYPE,
59 item_number WSH_DEL_DETAILS_INTERFACE.item_number%TYPE,
60 item_description WSH_DEL_DETAILS_INTERFACE.item_description%TYPE,
61 gross_weight WSH_DEL_DETAILS_INTERFACE.gross_weight%TYPE,
62 net_weight WSH_DEL_DETAILS_INTERFACE.net_weight%TYPE,
63 weight_uom_code WSH_DEL_DETAILS_INTERFACE.weight_uom_code%TYPE,
64 volume WSH_DEL_DETAILS_INTERFACE.volume%TYPE,
65 volume_uom_code WSH_DEL_DETAILS_INTERFACE.volume_uom_code%TYPE,
66 wv_frozen_flag WSH_DEL_DETAILS_INTERFACE.wv_frozen_flag%TYPE,
67 filled_volume WSH_DEL_DETAILS_INTERFACE.filled_volume%TYPE,
68 fill_percent WSH_DEL_DETAILS_INTERFACE.fill_percent%TYPE,
69 seal_code WSH_DEL_DETAILS_INTERFACE.seal_code%TYPE,
70 packing_instructions WSH_DEL_DETAILS_INTERFACE.packing_instructions%TYPE,
71 shipping_instructions WSH_DEL_DETAILS_INTERFACE.shipping_instructions%TYPE,
72 tracking_number WSH_DEL_DETAILS_INTERFACE.tracking_number%TYPE,
73 Container_Freight_Tab Freight_Cost_Rec_Tab );
74
75 TYPE Container_Rec_Tab IS TABLE OF Container_Rec_Type index by binary_integer;
76
77 TYPE Master_Container_Rec_Type IS RECORD (
78 delivery_detail_number WSH_DEL_DETAILS_INTERFACE.delivery_detail_id%TYPE,
79 attribute_category WSH_DEL_DETAILS_INTERFACE.attribute_category%TYPE,
80 attribute1 WSH_DEL_DETAILS_INTERFACE.attribute1%TYPE,
81 attribute2 WSH_DEL_DETAILS_INTERFACE.attribute2%TYPE,
82 attribute3 WSH_DEL_DETAILS_INTERFACE.attribute3%TYPE,
83 attribute4 WSH_DEL_DETAILS_INTERFACE.attribute4%TYPE,
84 attribute5 WSH_DEL_DETAILS_INTERFACE.attribute5%TYPE,
85 attribute6 WSH_DEL_DETAILS_INTERFACE.attribute6%TYPE,
86 attribute7 WSH_DEL_DETAILS_INTERFACE.attribute7%TYPE,
87 attribute8 WSH_DEL_DETAILS_INTERFACE.attribute8%TYPE,
88 attribute9 WSH_DEL_DETAILS_INTERFACE.attribute9%TYPE,
89 attribute10 WSH_DEL_DETAILS_INTERFACE.attribute10%TYPE,
90 attribute11 WSH_DEL_DETAILS_INTERFACE.attribute11%TYPE,
91 attribute12 WSH_DEL_DETAILS_INTERFACE.attribute12%TYPE,
92 attribute13 WSH_DEL_DETAILS_INTERFACE.attribute13%TYPE,
93 attribute14 WSH_DEL_DETAILS_INTERFACE.attribute14%TYPE,
94 attribute15 WSH_DEL_DETAILS_INTERFACE.attribute15%TYPE,
95 container_name WSH_DEL_DETAILS_INTERFACE.container_name%TYPE,
96 item_number WSH_DEL_DETAILS_INTERFACE.item_number%TYPE,
97 item_description WSH_DEL_DETAILS_INTERFACE.item_description%TYPE,
98 gross_weight WSH_DEL_DETAILS_INTERFACE.gross_weight%TYPE,
99 net_weight WSH_DEL_DETAILS_INTERFACE.net_weight%TYPE,
100 weight_uom_code WSH_DEL_DETAILS_INTERFACE.weight_uom_code%TYPE,
101 volume WSH_DEL_DETAILS_INTERFACE.volume%TYPE,
102 volume_uom_code WSH_DEL_DETAILS_INTERFACE.volume_uom_code%TYPE,
103 wv_frozen_flag WSH_DEL_DETAILS_INTERFACE.wv_frozen_flag%TYPE,
104 filled_volume WSH_DEL_DETAILS_INTERFACE.filled_volume%TYPE,
105 fill_percent WSH_DEL_DETAILS_INTERFACE.fill_percent%TYPE,
106 seal_code WSH_DEL_DETAILS_INTERFACE.seal_code%TYPE,
107 packing_instructions WSH_DEL_DETAILS_INTERFACE.packing_instructions%TYPE,
108 shipping_instructions WSH_DEL_DETAILS_INTERFACE.shipping_instructions%TYPE,
109 tracking_number WSH_DEL_DETAILS_INTERFACE.tracking_number%TYPE,
110 Master_Container_Freight_Tab Freight_Cost_Rec_Tab,
111 Container_Tab Container_Rec_Tab );
112
113 TYPE Master_Container_Rec_Tab IS TABLE OF Master_Container_Rec_Type index by binary_integer;
114
115 TYPE Delivery_Details_Rec_Type IS RECORD (
116 item_number WSH_DEL_DETAILS_INTERFACE.item_number%TYPE,
117 requested_quantity WSH_DEL_DETAILS_INTERFACE.requested_quantity%TYPE,
118 requested_quantity_uom WSH_DEL_DETAILS_INTERFACE.requested_quantity_uom%TYPE,
119 item_description WSH_DEL_DETAILS_INTERFACE.item_description%TYPE,
120 revision WSH_DEL_DETAILS_INTERFACE.revision%TYPE,
121 shipped_quantity WSH_DEL_DETAILS_INTERFACE.shipped_quantity%TYPE,
122 volume WSH_DEL_DETAILS_INTERFACE.volume%TYPE,
123 volume_uom_code WSH_DEL_DETAILS_INTERFACE.volume_uom_code%TYPE,
124 gross_weight WSH_DEL_DETAILS_INTERFACE.gross_weight%TYPE,
125 net_weight WSH_DEL_DETAILS_INTERFACE.net_weight%TYPE,
126 weight_uom_code WSH_DEL_DETAILS_INTERFACE.weight_uom_code%TYPE,
127 delivery_detail_number WSH_DEL_DETAILS_INTERFACE.delivery_detail_id%TYPE,
128 source_line_id WSH_DEL_DETAILS_INTERFACE.source_line_id%TYPE,
129 load_seq_number WSH_DEL_DETAILS_INTERFACE.load_seq_number%TYPE,
130 subinventory WSH_DEL_DETAILS_INTERFACE.subinventory%TYPE,
131 lot_number WSH_DEL_DETAILS_INTERFACE.lot_number%TYPE,
132 preferred_grade WSH_DEL_DETAILS_INTERFACE.preferred_grade%TYPE,
133 serial_number WSH_DEL_DETAILS_INTERFACE.serial_number%TYPE,
134 to_serial_number WSH_DEL_DETAILS_INTERFACE.to_serial_number%TYPE,
135 attribute_category WSH_DEL_DETAILS_INTERFACE.attribute_category%TYPE,
136 attribute1 WSH_DEL_DETAILS_INTERFACE.attribute1%TYPE,
137 attribute2 WSH_DEL_DETAILS_INTERFACE.attribute2%TYPE,
138 attribute3 WSH_DEL_DETAILS_INTERFACE.attribute3%TYPE,
139 attribute4 WSH_DEL_DETAILS_INTERFACE.attribute4%TYPE,
140 attribute5 WSH_DEL_DETAILS_INTERFACE.attribute5%TYPE,
141 attribute6 WSH_DEL_DETAILS_INTERFACE.attribute6%TYPE,
142 attribute7 WSH_DEL_DETAILS_INTERFACE.attribute7%TYPE,
143 attribute8 WSH_DEL_DETAILS_INTERFACE.attribute8%TYPE,
144 attribute9 WSH_DEL_DETAILS_INTERFACE.attribute9%TYPE,
145 attribute10 WSH_DEL_DETAILS_INTERFACE.attribute10%TYPE,
146 attribute11 WSH_DEL_DETAILS_INTERFACE.attribute11%TYPE,
147 attribute12 WSH_DEL_DETAILS_INTERFACE.attribute12%TYPE,
148 attribute13 WSH_DEL_DETAILS_INTERFACE.attribute13%TYPE,
149 attribute14 WSH_DEL_DETAILS_INTERFACE.attribute14%TYPE,
150 attribute15 WSH_DEL_DETAILS_INTERFACE.attribute15%TYPE,
151 source_header_number WSH_DEL_DETAILS_INTERFACE.source_header_number%TYPE,
152 line_direction WSH_DEL_DETAILS_INTERFACE.line_direction%TYPE,
153 wv_frozen_flag WSH_DEL_DETAILS_INTERFACE.wv_frozen_flag%TYPE,
154 cycle_count_quantity WSH_DEL_DETAILS_INTERFACE.cycle_count_quantity%TYPE,
155 locator_code WSH_DEL_DETAILS_INTERFACE.locator_code%TYPE,
156 parent_delivery_detail_number NUMBER,
157 Detail_Freight_Tab Freight_Cost_Rec_Tab );
158
159 TYPE Delivery_Details_Rec_Tab IS TABLE OF Delivery_Details_Rec_Type index by binary_integer;
160
161 TYPE Delivery_Rec_Type IS RECORD (
162 document_number WSH_TRANSACTIONS_HISTORY.document_number%TYPE,
163 name WSH_NEW_DEL_INTERFACE.name%TYPE,
164 description WSH_NEW_DEL_INTERFACE.description%TYPE,
165 initial_pickup_date WSH_NEW_DEL_INTERFACE.initial_pickup_date%TYPE,
166 ultimate_dropoff_date WSH_NEW_DEL_INTERFACE.ultimate_dropoff_date%TYPE,
167 freight_terms_code WSH_NEW_DEL_INTERFACE.freight_terms_code%TYPE,
168 gross_weight WSH_NEW_DEL_INTERFACE.gross_weight%TYPE,
169 net_weight WSH_NEW_DEL_INTERFACE.net_weight%TYPE,
170 weight_uom_code WSH_NEW_DEL_INTERFACE.weight_uom_code%TYPE,
171 number_of_lpn WSH_NEW_DEL_INTERFACE.number_of_lpn%TYPE,
172 volume WSH_NEW_DEL_INTERFACE.volume%TYPE,
173 volume_uom_code WSH_NEW_DEL_INTERFACE.volume_uom_code%TYPE,
174 shipping_marks WSH_NEW_DEL_INTERFACE.shipping_marks%TYPE,
175 fob_code WSH_NEW_DEL_INTERFACE.fob_code%TYPE,
176 ship_method_code WSH_NEW_DEL_INTERFACE.ship_method_code%TYPE,
177 organization_code WSH_NEW_DEL_INTERFACE.organization_code%TYPE,
178 loading_sequence WSH_NEW_DEL_INTERFACE.loading_sequence%TYPE,
179 attribute_category WSH_NEW_DEL_INTERFACE.attribute_category%TYPE,
180 attribute1 WSH_NEW_DEL_INTERFACE.attribute1%TYPE,
181 attribute2 WSH_NEW_DEL_INTERFACE.attribute2%TYPE,
182 attribute3 WSH_NEW_DEL_INTERFACE.attribute3%TYPE,
183 attribute4 WSH_NEW_DEL_INTERFACE.attribute4%TYPE,
184 attribute5 WSH_NEW_DEL_INTERFACE.attribute5%TYPE,
185 attribute6 WSH_NEW_DEL_INTERFACE.attribute6%TYPE,
186 attribute7 WSH_NEW_DEL_INTERFACE.attribute7%TYPE,
187 attribute8 WSH_NEW_DEL_INTERFACE.attribute8%TYPE,
188 attribute9 WSH_NEW_DEL_INTERFACE.attribute9%TYPE,
189 attribute10 WSH_NEW_DEL_INTERFACE.attribute10%TYPE,
190 attribute11 WSH_NEW_DEL_INTERFACE.attribute11%TYPE,
191 attribute12 WSH_NEW_DEL_INTERFACE.attribute12%TYPE,
192 attribute13 WSH_NEW_DEL_INTERFACE.attribute13%TYPE,
193 attribute14 WSH_NEW_DEL_INTERFACE.attribute14%TYPE,
194 attribute15 WSH_NEW_DEL_INTERFACE.attribute15%TYPE,
195 waybill WSH_NEW_DEL_INTERFACE.waybill%TYPE,
196 carrier_code WSH_NEW_DEL_INTERFACE.carrier_code%TYPE,
197 service_level WSH_NEW_DEL_INTERFACE.service_level%TYPE,
198 mode_of_transport WSH_NEW_DEL_INTERFACE.mode_of_transport%TYPE,
199 wv_frozen_flag WSH_NEW_DEL_INTERFACE.wv_frozen_flag%TYPE,
200 shipment_direction WSH_NEW_DEL_INTERFACE.shipment_direction%TYPE,
201 delivered_date WSH_NEW_DEL_INTERFACE.delivered_date%TYPE,
202 customer_name WSH_NEW_DEL_INTERFACE.customer_name%TYPE,
203 INITIAL_PICKUP_LOCATION_CODE WSH_NEW_DEL_INTERFACE.INITIAL_PICKUP_LOCATION_CODE%TYPE,
204 SHIP_TO_CUSTOMER_NAME WSH_NEW_DEL_INTERFACE.SHIP_TO_CUSTOMER_NAME%TYPE,
205 SHIP_TO_ADDRESS1 WSH_NEW_DEL_INTERFACE.SHIP_TO_ADDRESS1%TYPE,
206 SHIP_TO_ADDRESS2 WSH_NEW_DEL_INTERFACE.SHIP_TO_ADDRESS2%TYPE,
210 SHIP_TO_STATE WSH_NEW_DEL_INTERFACE.SHIP_TO_STATE%TYPE,
207 SHIP_TO_ADDRESS3 WSH_NEW_DEL_INTERFACE.SHIP_TO_ADDRESS3%TYPE,
208 SHIP_TO_ADDRESS4 WSH_NEW_DEL_INTERFACE.SHIP_TO_ADDRESS4%TYPE,
209 SHIP_TO_CITY WSH_NEW_DEL_INTERFACE.SHIP_TO_CITY%TYPE,
211 SHIP_TO_COUNTRY WSH_NEW_DEL_INTERFACE.SHIP_TO_COUNTRY%TYPE,
212 SHIP_TO_POSTAL_CODE WSH_NEW_DEL_INTERFACE.SHIP_TO_POSTAL_CODE%TYPE,
213 actual_departure_date WSH_TRIP_STOPS_INTERFACE.actual_departure_date%TYPE,
214 actual_arrival_date WSH_TRIP_STOPS_INTERFACE.actual_arrival_date%TYPE,
215 departure_seal_code WSH_TRIP_STOPS_INTERFACE.departure_seal_code%TYPE,
216 vehicle_number WSH_TRIPS_INTERFACE.vehicle_number%TYPE,
217 vehicle_num_prefix WSH_TRIPS_INTERFACE.vehicle_num_prefix%TYPE,
218 route_id WSH_TRIPS_INTERFACE.route_id%TYPE,
219 routing_instructions WSH_TRIPS_INTERFACE.routing_instructions%TYPE,
220 operator WSH_TRIPS_INTERFACE.operator%TYPE,
221 delivery_details_tab Delivery_Details_Rec_Tab,
222 container_tab Master_Container_Rec_Tab,
223 delivery_freight_tab Freight_Cost_Rec_Tab );
224
225 --===================
226 -- PROCEDURES
227 --===================
228
229 --========================================================================
230 -- PROCEDURE : Shipment_Advice PUBLIC
231 --
232 -- PARAMETERS: p_api_version_number known api version
233 -- p_init_msg_list FND_API.G_TRUE to reset list
234 -- p_action 'CREATE'
235 -- p_delivery_rec Attributes for the Shipment Advice entity
236 -- x_return_status return status
237 -- x_msg_count number of messages in the list
238 -- x_msg_data text of messages
239 -- VERSION : current version 1.0
240 -- initial version 1.0
241 --========================================================================
242 /*#
243 * Query or Create or update or delete a shipment request with information specified in p_shipment_request_info
244 * @param p_api_version_number version number of the API
245 * @param p_init_msg_list messages will be initialized if set as true
246 * @param p_delivery_rec Attributes for the Shipment Advice entity
247 * @param p_action action to be performed, could be 'CREATE'.
248 * @param p_commit commit flag
249 * @param x_return_status return status of the API
250 * @param x_msg_count number of messages, if any
251 * @param x_msg_data message text, if any
252 * @rep:scope public
253 * @rep:lifecycle active
254 * @rep:displayname Create Shipment Advice
255 */
256 PROCEDURE Shipment_Advice(
257 p_api_version_number IN NUMBER,
258 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_TRUE,
259 p_delivery_rec IN Delivery_Rec_Type,
260 p_action IN VARCHAR2,
261 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
262 x_return_status OUT NOCOPY VARCHAR2,
263 x_msg_count OUT NOCOPY NUMBER,
264 x_msg_data OUT NOCOPY VARCHAR2);
265
266 --========================================================================
267 -- PROCEDURE : Process_Shipment_Advice PUBLIC
268 --
269 -- PARAMETERS: p_api_version_number known api version
270 -- p_init_msg_list FND_API.G_TRUE to reset list
271 -- p_process_mode 'ONLINE' or 'CONCURRENT'
272 -- p_log_level 0 or 1 to control the log messages
273 -- p_transaction_status Status of Shipment Advice
274 -- p_from_document_number From Document Number
275 -- p_to_document_number To Document Number
276 -- p_from_creation_date From Creation Date
277 -- p_to_creation_date To Creation Date
278 -- p_transaction_id Trasaction Id of Transaction History to be processed
279 -- x_return_status return status
280 -- VERSION : current version 1.0
281 -- initial version 1.0
282 -- COMMENT : Processes Shipment Advice as per criteria
283 -- specified in p_transaction_status,p_from_document_number,
284 -- p_to_document_number,p_from_creation_date and p_to_creation_date
285 --========================================================================
286
287 /*#
288 * Processes shipment advices with information specified in prams
289 * @param p_api_version_number version number of the API
290 * @param p_init_msg_list messages will be initialized if set as true
291 * @param p_commit Commit flag
292 * @param p_process_mode ONLINE or CONCURRENT to process shipment requests
293 * @param p_log_level Controls the log messages generated
294 * @param p_transaction_status Status of Shipment Advice
295 * @param p_from_document_number From Document Number
296 * @param p_to_document_number To Document Number
297 * @param p_from_creation_date From Creation Date
298 * @param p_to_creation_date To Creation Date
299 * @param p_transaction_id Trasaction Id of Transaction History to be processed
300 * @param x_request_id Concurrent request Id of the 'Process Shipment Requests' program
301 * @param x_return_status return status of the API
302 * @param x_msg_count number of messages, if any
303 * @param x_msg_data message text, if any
304 * @rep:scope public
305 * @rep:lifecycle active
306 * @rep:displayname Process Shipment Advice
307 */
308
309 PROCEDURE Process_Shipment_Advice (
310 p_api_version_number IN NUMBER,
311 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_TRUE,
315 p_transaction_status IN VARCHAR2,
312 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
313 p_process_mode IN VARCHAR2 DEFAULT 'CONCURRENT',
314 p_log_level IN NUMBER DEFAULT 0,
316 p_from_document_number IN VARCHAR2,
317 p_to_document_number IN VARCHAR2,
318 p_from_creation_date IN DATE,
319 p_to_creation_date IN DATE,
320 p_transaction_id IN NUMBER,
321 x_request_id OUT NOCOPY NUMBER,
322 x_return_status OUT NOCOPY VARCHAR2,
323 x_msg_count OUT NOCOPY NUMBER,
324 x_msg_data OUT NOCOPY VARCHAR2);
325
326 END WSH_SHIPMENT_ADVICE_PUB;