1 PACKAGE WSH_SHIPMENT_BATCH_PUB AUTHID CURRENT_USER as
2 /* $Header: WSHSBPBS.pls 120.0.12020000.2 2013/01/17 03:51:51 ueshanka ship $ */
3 /*#
4 * This is the public interface for creating Shipment Batches. It allows
5 * grouping of eligible delivery lines into a Shipment Batch.
6 * @rep:scope public
7 * @rep:product WSH
8 * @rep:displayname Shipment Batch
9 * @rep:lifecycle active
10 * @rep:category BUSINESS_ENTITY WSH_SHIPMENT_BATCH
11 */
12
13 --===================
14 -- PUBLIC VARS
15 --===================
16
17 --===================
18 -- PROCEDURES
19 --===================
20
21 --========================================================================
22 -- PROCEDURE : Create_Shipment_Batch PUBLIC
23 --
24 -- PARAMETERS: p_api_version_number version number of the API
25 -- p_init_msg_list messages will be initialized if set as true
26 -- p_process_mode 'ONLINE' or 'CONCURRENT', Default Value 'CONCURRENT'
27 -- p_organization_id Organization Id
28 -- p_customer_id Customer Id
29 -- p_ship_to_location_id Ship From Location
30 -- p_transaction_type_id Sales Order Type Id
31 -- p_from_order_number From Sales Order Number
32 -- p_to_order_number To Sales Order Number
33 -- p_from_request_date From Request Date
34 -- p_to_request_date To Request Date
35 -- p_from_schedule_date From Schedule Date
36 -- p_to_schedule_date To Schedule Date
37 -- p_shipment_priority Shipment Priority Code
38 -- p_include_internal_so Include Internal Sales Order
39 -- Bug 14620571: Added parameter p_include_lines_with_hold
40 -- p_include_lines_with_hold Include order lines with Hold
41 -- p_log_level 0 or 1 to control the log messages, Default Value 0
42 -- p_commit Commit Flag
43 -- x_request_id Concurrent Request Id submitted for 'Create Shipment Batches' program
44 -- x_return_status return status
45 -- x_msg_count number of messages in the list
46 -- x_msg_data text of messages
47 -- VERSION : current version 1.0
48 -- initial version 1.0
49 -- COMMENT : Public API to create shipment batches.
50 --
51 --========================================================================
52
53 /*#
54 * Creates Shipment Batches
55 * @param p_api_version_number version number of the API
56 * @param p_init_msg_list messages will be initialized if set as true
57 * @param p_process_mode ONLINE or CONCURRENT mode to create shipment batches. Default value 'CONCURRENT'
58 * @param p_organization_id Organization Id
59 * @param p_customer_id Customer Id
60 * @param p_ship_to_location_id Ship From Location
61 * @param p_transaction_type_id Sales Order Type Id
62 * @param p_from_order_number From Sales Order Number
63 * @param p_to_order_number To Sales Order Number
64 * @param p_from_request_date From Request Date
65 * @param p_to_request_date To Request Date
66 * @param p_from_schedule_date From Schedule Date
67 * @param p_to_schedule_date To Schedule Date
68 * @param p_shipment_priority Shipment Priority Code
69 * @param p_include_internal_so Include Internal Sales Order, Default Value 'N'
70 * @param p_include_lines_with_hold Include order lines with Hold applied, Default Value 'N'
71 * @param p_log_level Controls the log messages generated, Default Value 0
72 * @param p_commit commit flag
73 * @param x_request_id Concurrent request Id of the 'Create Shipment Batches' program
74 * @param x_return_status return status of the API
75 * @param x_msg_count number of messages, if any
76 * @param x_msg_data message text, if any
77 * @rep:scope public
78 * @rep:lifecycle active
79 * @rep:displayname Create Shipment Batches
80 */
81 PROCEDURE Create_Shipment_Batch(
82 p_api_version_number IN NUMBER,
83 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_TRUE,
84 p_process_mode IN VARCHAR2 DEFAULT 'CONCURRENT',
85 p_organization_id IN NUMBER,
86 p_customer_id IN NUMBER,
87 p_ship_to_location_id IN NUMBER,
88 p_transaction_type_id IN NUMBER,
89 p_from_order_number IN VARCHAR2,
90 p_to_order_number IN VARCHAR2,
91 p_from_request_date IN DATE,
92 p_to_request_date IN DATE,
93 p_from_schedule_date IN DATE,
94 p_to_schedule_date IN DATE,
95 p_shipment_priority IN VARCHAR,
96 p_include_internal_so IN VARCHAR DEFAULT 'N',
97 p_include_lines_with_hold IN VARCHAR DEFAULT 'N',
98 p_log_level IN NUMBER DEFAULT 0,
99 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
100 x_request_id OUT NOCOPY NUMBER,
101 x_return_status OUT NOCOPY VARCHAR2,
102 x_msg_count OUT NOCOPY NUMBER,
103 x_msg_data OUT NOCOPY VARCHAR2 );
104
105 --
106 --========================================================================
107 -- PROCEDURE : Cancel_Line PUBLIC
108 --
109 -- PARAMETERS: p_api_version_number version number of the API
110 -- p_init_msg_list messages will be initialized if set as true
111 -- p_commit commit Flag
112 -- p_document_number document number
113 -- p_line_number line number
114 -- p_cancel_quantity quantity to unassign from Shipment batch
115 -- x_return_status return status
116 -- x_msg_count number of messages in the list
117 -- x_msg_data text of messages
118 -- VERSION : current version 1.0
119 -- initial version 1.0
120 -- COMMENT : Public API to unassign delivery line from a Shipment Batch.
121 --
122 --========================================================================
123
124 /*#
125 * Unassing delivery line from Shipment Batch
126 * @param p_api_version_number version number of the API
127 * @param p_init_msg_list messages will be initialized if set as true
128 * @param p_commit commit flag
129 * @param p_document_number document number
130 * @param p_line_number line number
131 * @param p_cancel_quantity quantity to unassign from Shipment Batch
132 * @param x_return_status return status of the API
133 * @param x_msg_count number of messages, if any
134 * @param x_msg_data message text, if any
135 * @rep:scope public
136 * @rep:lifecycle active
137 * @rep:displayname Unassign Delivery Line From Shipment Batch
138 */
139 PROCEDURE Cancel_Line(
140 p_api_version_number IN NUMBER,
141 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_TRUE,
142 p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
143 p_document_number IN VARCHAR2,
144 p_line_number IN VARCHAR2,
145 p_cancel_quantity IN NUMBER,
146 x_return_status OUT NOCOPY VARCHAR2,
147 x_msg_count OUT NOCOPY NUMBER,
148 x_msg_data OUT NOCOPY VARCHAR2 );
149
150 END WSH_SHIPMENT_BATCH_PUB;
[Home] [Help]