Results for “wsh_interface_grp”
50+ results
AI-generated from documented ETRM metadata — verify critical details on the linked pages.
Overview
APPS.WSH_INTERFACE_GRP is the public group (GRP) API layer for Oracle Shipping Execution in Oracle E-Business Suite 12.1.1 and 12.2.2. Its documented purpose is to expose a stable, versioned interface through which callers perform actions against the core shipping business entities: deliveries, delivery details, trips, trip stops, and freight costs. The header comment in the package body identifies the Delivery_Action wrapper as a "PUBLIC" API, confirming that the group is intended for external consumption rather than internal-only use. The package declares a current API version of 1.0 and uses AUTHID CURRENT_USER, so privileges resolve against the calling schema rather than the APPS schema owner.
The group also defines public constants for Stop Sequence Mode, distinguishing SSN mode (constant value 1) from PAD mode (constant value 2), which govern how stop sequence numbering is generated when stops are created or updated.
Key Procedures and Functions
ETRM documents ten procedures and functions in this package. The best-known is DELIVERY_ACTION, the entry point users reach when searching for delivery_action. It performs an action specified in the p_action_prms.action_code element of the action-parameters record against an existing delivery identified by delivery ID or name. Parameter roles are documented as follows: p_api_version_number passes the known API version, p_init_msg_list resets the message list when set to FND_API.G_TRUE, p_commit controls transaction commit, p_delivery_id_tab supplies an ID table, and the output parameters x_delivery_out_rec, x_return_status, x_msg_count, and x_msg_data return the delivery result record and standard FND message information. The remaining documented entry points are:
CREATE_UPDATE_DELIVERY— create or modify a delivery header.DELIVERY_DETAIL_ACTION— perform an action on an existing delivery detail line.CREATE_UPDATE_DELIVERY_DETAIL— create or modify delivery detail records.CREATE_UPDATE_TRIPandTRIP_ACTION— create, modify, or act upon trips.CREATE_UPDATE_STOPandSTOP_ACTION— create, modify, or act upon trip stops.CREATE_UPDATE_FREIGHT_COSTS— maintain freight cost records.UPDATE_DELIVERY_LEG— maintain delivery leg information.
Each follows the FND API conventions of return status plus message count and data, providing a consistent error-handling contract across the group.
Tables Accessed
The package operates against the following tables through APPS synonyms: WSH_NEW_DELIVERIES for delivery headers, WSH_DELIVERY_DETAILS for delivery lines, WSH_DELIVERY_LEGS for leg routing and status, WSH_TRIPS and WSH_TRIP_STOPS for trip and stop data, WSH_SHIP_CONFIRM_RULES for ship-confirmation behavior, WSH_REPORT_SETS for reporting configuration, and PLITBLM, an FND message-table synonym used by the standard message-stack mechanism.
Usage Notes
WSH_INTERFACE_GRP is referenced by 37 other packages, indicating it is a hub for shipping API calls rather than a leaf module. It is typically invoked from Shipping Execution forms, from concurrent programs that mass-update deliveries, trips, and stops, and from custom PL/SQL integrations that need supported shipping actions without touching base tables directly. Callers should supply a valid p_api_version_number, honor the returned x_return_status, and drain the message stack using x_msg_count and x_msg_data before proceeding. Because p_commit defaults to FND_API.G_FALSE, transactional control remains with the caller unless explicitly delegated.