1
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
�Exploring Oracle 11i Order Management and Shipping
Execution Public API's�
2
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
�Sample API TerminologyStandard parameters
�Order Management Public API�sOE_HOLDS_PUB.Apply_Holds,Release_HoldsOE_CREDIT_PUB.Check_Available_CreditOE_FND_ATTACHMENTS_PUB.Add_Attachment
�Shipping Execution Public API�s�Delivery Details Public Application Program Interface�Deliveries Public Application Program Interface�Freight Costs Public Application Program Interface�Trip Public Application Program Interface�Stop Public Application Program Interface�Container Public Application Program Interface
Agenda
3
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
Declare< Variable declaration >
Begin--Populate API parameters--API CallPackage.Procedure(
Standard parameters.
Specific Parameters);Error Handling
End;
Sample API
p_ => in parameterx_ => out parameter
4
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
�p_api_version_number => Known API version error buffer �p_init_msg_list => Used to Initialize message list ,use
FND_API.G_TRUE to reset the list�x_return_status => Return status(S-Success,W-Warning,
E-Error)�x_msg_count => Number of messages in the list�x_msg_data => Text messages
Standard parameters
5
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
�Applies Hold on the Order
�Specific parametersp_order_tbl => list of order header id�s for which hold has
to be appliedp_hold_id => Type of hold that has to be appliedp_hold_until_date => Date upto which the hold has to be appliedp_hold_comment => hold comment
Order Management Public API�s
OE_HOLDS_PUB.Apply_Holds
6
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
Order Management Public API�s
7
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
�Releases Hold on the Order
�Specific parametersp_order_tbl => list of order header id�s for which hold has
to be releasedp_hold_id => Type of hold that has to be releasedp_hold_until_date => Date upto which the hold has to be releasedp_hold_comment => hold comment
Order Management Public API�s
OE_HOLDS_PUB.Release_Holds
8
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
� Determines order should be credit checked or not , consumes available Credit and applies a credit hold if appropriate .
�Specific parameters
�p_header_id => order header �p_calling_action => calling action(BOOKING)
OE_CREDIT_PUB.Check_Available_Credit
Order Management Public API�s
9
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
� Attaches notes to order header or order line
�Specific parametersp_entity_name => Value �ORDER HEADER�
or �ORDER LINE�p_pk1_value => Order header idp_document_id => Document idx_attachment_id => attachment id is returned
OE_FND_ATTACHMENTS_PUB.Add_Attachment
Order Management Public API�s
10
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
OE_FND_ATTACHMENTS_PUB.Add_Attachment
Order Management Public API�s
11
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
Shipping Execution Public API�sDelivery Details Public Application Program Interface
12
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
WSH_DELIVERY_DETAILS_PUB. Detail_to_Delivery
�Assign Delivery Details to a Delivery�Unassign Delivery Details from a Delivery.
� Specific parametersp_TabOfDelDets => Table of Delivery Detail ID�s p_action => �ASSIGN� or �UNASSIGN�p_delivery_id => Delivery id to Unassignp_delivery_name => Delivery Name to Unassign
Delivery Details Public Application Program Interface
13
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
Delivery Details Public Application Program Interface
WSH_DELIVERY_DETAILS_PUB. Split_Line
�Splits a Delivery Detail into two Delivery Details. �Delivery Detail Splits when Ship partial or Back order occurs.
� Specific parametersp_from_detail_id => Delivery Detail ID of the line to be Split.x_new_detail_id => Delivery Detail ID of the new line x_split_quantity => quantity allocated to the new Delivery Detail
14
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
WSH_DELIVERY_DETAILS_PUB.Update_Shipping_Attributes
�Updates a delivery details with new information.
� Specific parametersp_changed_attributes=>Attributes of ChangedAttributesTabType
that are to be updated.p_source_code => Code for source system which updates
wsh_delivery_details table
Delivery Details Public Application Program Interface
15
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
WSH_DELIVERY_DETAILS_PUB.Autocreate_Deliveries
�Automatically creates deliveries for multiple delivery lines.
� Specific parametersp_line_rows=> Table of Delivery Detailsx_del_rows=> Table of Deliveries
Delivery Details Public Application Program Interface
16
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
WSH_DELIVERY_DETAILS_PUB.Autocreate_Del_Trip
�Automatically create trips and deliveries for multiple delivery lines.
�Specific parametersp_line_rows=> Table of Delivery Detailsx_del_rows=> Table of Deliveries
Delivery Details Public Application Program Interface
17
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
Deliveries Public Application Program Interface
18
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
Deliveries Public Application Program Interface
WSH_DELIVERIES_PUB.Create_update_delivery
�Enables you to create a new delivery record or update an existing delivery
�Specific Parametersp_action_code => values �CREATE� or �UPDATE�p_delivery_info => Attributes of the delivery entity of type
Delivery_Pub_Rec_Typep_delivery_name =>Name of delivery record being updated.x_delivery_id => New Delivery id being createdx_name => New Delivery Name being created
19
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
Deliveries Public Application Program Interface
WSH_DELIVERIES_PUB. Delivery_Action
Enables you to carry out actions on a delivery
�Actions�PLAN/UNPLAN = > plan or unplan deliveries.�WT-VOL=>Calculates weight and volume for the delivery�CONFIRM => Ship Confirms Delivery�PACK, RE-OPEN, IN-TRANSIT, CLOSE => Updates status of delivery�ASSIGN-TRIP =>Assigns a trip to delivery�UNASSIGN-TRIP => Unassigns Trip Form a delivery�AUTOCREATE-TRIP => To Autocreate a Trip�PICK_RELEASE => Releases Lines related to a delivery�DELETE=>Deletes a delivery
20
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
Deliveries Public Application Program Interface
WSH_DELIVERIES_PUB. Delivery_ActionSpecific Parameters
p_action_code = > Action to be performed on Deliveryp_delivery_name => name of delivery that action is performedp_trip_name = > Trip identifier for assignment of trip to deliveryp_asg_pickup_loc_code =>Stop location code for pickup assignmentp_asg_pickup_dep_date=>Stop location departure date for pickup assignmentp_asg_dropoff_loc_code=>Stop location code for dropoff assignmentp_asg_dropoff_dep_date=>Stop location departure date for dropoff assignmentp_sc_action_flag=>Ship Confirm option - S, B, T, A, C. Used when ship confirming a delivery.p_sc_intransit_flag=>Ship Confirm set in-transit flag. p_sc_close_trip_flag=>Ship Confirm close trip flag. p_sc_create_bol_flag=>Ship Confirm create Bill of Lading flagp_sc_stage_del_flag=>Ship Confirm create delivery for stage quantity flagp_sc_trip_ship_method=>Ship Confirm trip ship method. p_wv_override_flag =>Override flag for weight volume calculations.x_trip_name => Name of autocreated trip.
21
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
Freight Costs Public Application Program Interface
22
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
Freight Costs Public Application Program Interface
WSH_FREIGHT_COSTS _PUB.Create_Update_Freight_Costs
�Enables you to create a new freight cost record or update an existing freight cost
�Specific Parameters�p_pub_freight_costs =>Attributes of the freight cost
entity of type PubFreightCostRecType�p_action_code =>values �CREATE� or �UPDATE.��x_freight_cost_id =>ID of new freight cost record being created.
23
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
Freight Costs Public Application Program Interface
WSH_FREIGHT_COSTS_PUB.Delete_Freight_Costs
�Enables you to create a new freight cost record or update an existing freight cost
�Specific Parameters�p_pub_freight_costs =>Attributes of the freight cost
entity of type PubFreightCostRecType.
24
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
Trip Public Application Program Interface
25
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
Trip Public Application Program Interface
WSH_TRIPS_PUB.Create_Update_Trip
�Enables you to create a new trip or update an existing trip �Specific Parameters
�p_action_code => values �CREATE� or �UPDATE��p_trip_info =>Attributes of the trip entity of type
Trip_Pub_Rec_Type�p_trip_name => Name of trip that is needed to be updated.�x_trip_name => Name of new trip being created.
26
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
Trip Public Application Program Interface
WSH_TRIPS_PUB.Trip_Action
�Enables you to perform actions on a trip.
�Actions�PLAN/UNPLAN = > plan or unplan trips�WT-VOL=>Calculates weight and volume for the trip�PICK_RELEASE => Releases Lines related to a trip�DELETE=>Deletes a trip
�Specific Parameters�p_action_code => Specifies action on trip�p_trip_id =>Trip ID of trip on which actions are being performed.�p_trip_name =>Name of trip on which actions are being performed.�p_wv_override_flag =>weight and volume re-calculations are done for
all deliveries on the trip
27
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
Stop Public Application Program Interface
28
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
Stop Public Application Program Interface
WSH_TRIP_STOPS_PUB.Create_Update_Stop
�Enables you to create a new stop and update an existing stop .
�Specific Parameters�p_action_code => values �CREATE� or �UPDATE��p_stop_info=>Attributes of the stop entity of type
Trip_Stop_Pub_Rec_Type. �p_trip_name =>Name of trip that is needed to be updated�p_location_code =>stop location code of stop that is needed to be
updated.�p_planned_dep_date => planned date of departure.�x_stop_id =>stop ID of new stop record being created.
29
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
WSH_TRIP_STOP_PUB.Stop_Action �Actions
�PLAN/UNPLAN = > plan or unplan stops�ARRIVE/CLOSE=>update departure or arrival dates and to close a stop�PICK_RELEASE => Releases Lines related to a stop�DELETE=>Deletes a stop
�Specific Parameters�p_action_code =>Specifies which of the actions API should perform.�p_stop_id =>Stop ID of trip stop on which actions need to be performed.�p_trip_name=>Trip name of trip stop on which actions need to be performed.�p_stop_location_code=>Stop location code of trip stop on which actions need to be performed.�p_planned_dep_date=>Planned departure date of trip stop on which actions need to be performed.�p_actual_date =>Actual date of arrival/departure of trip stop.
Stop Public Application Program Interface
30
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
�WSH_CONTAINER_PUB: Create_ContainerEnables you to create a new container record.
�WSH_CONTAINER_PUB: Update_ContainerUpdates an existing container record.
�WSH_CONTAINER_PUB: Auto_PackLets you autopack containers.
�WSH_CONTAINER_PUB: Container_ActionsEnables you to perform actions on a container.
.
Container Public Application Program Interface
31
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
Bibliography
�Oracle Shipping Execution User's Guide Release 11i, A77030-01 Oracle Corporation.
�Oracle Shipping Execution 11i Public APIs-White Paper
�http://metalink.oracle.com�http://www.oracle.com/appsnet
32
OAUG Spring 2002 Copyright � 2002 by Shyam Kadigari
Top Related