Material Shipment

Relationships

The following table describes how this service data object is related to other service data objects or business object services.

Relationship Type	Object or Service
Handles	Shipment Response SDO
Handles	Ship Confirm Packing Unit Interface SDO
Handles	Shipment Information SDO
Handles	Ship Confirm Shipping Cost Interface SDO
Handles	Ship Confirm Lot Interface SDO
Handles	Ship Confirm Shipment Line Interface SDO
Handles	Shipment Notes SDO
Handles	Shipment Document Response Line SDO
Handles	Ship Confirm Shipment Interface SDO
Handles	Shipment Shipping Cost SDO
Handles	Ship Confirm Serial Number Interface SDO
Handles	Shipment Document Response Header SDO
Handles	Processing Shipment Message SDO

processCreateUpdateShipment

Create or update a shipment using the specified information.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
apiVersionNumber	decimal	Version number of the API.
InitMsgList	string	Initialize the message stack. Valid values are T and F.
ActionCode	string	Action to be performed on shipment. Valid values are 'CREATE' or 'UPDATE'.
ShipmentInformation	Shipment Information	User specified details for creating or updating a shipment.

Response Payload

Element Name	Type	Description
result	Shipment Response	Status of creating or updating the shipment and the related messages.

processShippingCost

Create, update, or delete the shipping cost for a shipment.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
shippingCost	Shipment Shipping Cost	User specified details for the shipping cost.

Response Payload

Element Name	Type	Description
result	Shipment Response	Status of creating, updating, or deleting the shipping cost and the related messages.

processShipmentAction

Perform user requested action on an existing shipment.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
apiVersionNumber	decimal	Version number of the API.
InitMsgList	string	Initialize the message stack. Valid values are T and F.
ActionCode	string	User specified action to be performed on the shipment. Valid values are CONFIRM, BACKORDER-ALL, CYCLE-COUNT-ALL, CHANGE-SC-OPTIONS, RE-OPEN, CLOSE, WT-VOL, PICK-RELEASE, and DELETE.
Shipment	string	Shipment to be acted upon.
ActionType	string	Type of action to be taken on shipment. Valid values are S, B, T, and A. S to ship entered quantities or full requested quantities. B to ship entered quantities and backorder the remaining quantities. T to ship entered quantities and stage the remaining quantities. A to ship all lines.
CreateBillOfLading	string	Generate a bill of lading. Valid values are Y and N.
CreateShipmentForStagedQuantity	string	Create the shipment for the staged quantities. Valid values are Y and N.
ActualShipDate	{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp	The date with time when the shipment was actually sent.
CloseShipment	string	Option to close shipment. Valid values are Y and N.
DeferInventoryUpdates	string	Option to defer sending inventory updates to integrated applications. Valid values are Y and N.
ShipConfirmRule	string	The rule to be associated with the process of confirming the shipment lines of the shipment have been shipped.
OverrideWeightVolume	string	Option to override the weight and volume calculations. Value values are Y and N.
OutboundMessageCode	string	Option to send a request or a cancellation message to the manifesting system. Valid values are SR and SC.
PackingSlipStatus	string	Defines Packing Slip Status. Valid values are F, D and C.
DocumentJobSet	string	Indicates the name of jobset to generate reports during the ship confirm action.

Response Payload

Element Name	Type	Description
result	Shipment Response	Status of the action taken on shipment and the related messages.

fetchShipmentDocuments

Fetch shipping documents for an existing shipment.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
Shipment	string	Identifier for a collection of goods or materials to be shipped.
FromCreationDate	{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp	Start Date of shipment creation date to identify shipments to be considered for fetching the documents.
ToCreationDate	{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp	End Date of shipment creation date to identify shipments to be considered for fetching the documents.
FromConfirmedDate	{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp	Start Date of ship confirmation date to identify shipments to be considered for fetching the documents.
ToConfirmedDate	{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp	End Date of ship confirmation date to identify shipments to be considered for fetching the documents.
FromActualShipDate	{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp	Start Date of shipment close date to identify shipments to be considered for fetching the documents.
ToActualShipDate	{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp	End Date of shipment close date to identify shipments to be considered for fetching the documents.

Response Payload

Element Name	Type	Description
result	Shipment Document Response Header SDO	A list of objects to store the header details for the shipment documents that include the shipment number, transportation shipment number, and shipment status.

createAndConfirm

Service to operate on the shipment such as create and update.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
shipment	Ship Confirm Shipment Interface	Order to be processed.

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/apps/scm/shipping/shipConfirm/deliveries/shipmentService/}ShipmentInterfaceResult	Status of creating the shipment and the related messages.

getDfltObjAttrHints

An operation to retrieve user interface hints, such as the service data object label and object attribute labels, for the specified service data object and locale. As a prerequisite, invoke the getEntityList operation defined on this service to get the list of possible values for the viewName request payload element.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
viewName	string	The service view usage name, an internal name for the service data object. Specify the value of the <name> element from the getEntityList operation response payload.
localeName	string	The locale to use when evaluating locale-based user interface hints. The localeName is in ISO 639-1 format.

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/adf/svc/types/}ObjAttrHints	The label and user interface hints for the specified service data object and its attributes in a name-value pair format

getServiceLastUpdateTime

An operation that returns the date and time when the schema files referenced in the service definition last changed.

Life Cycle Status: Active

Request Payload

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp	The date and time when the service definition last changed in ISO 8601 format.

getEntityList

An operation to get the list of service data objects defined on this service.

Life Cycle Status: Active

Request Payload

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/adf/svc/types/}ServiceViewInfo	A list of service data objects defined on this service. For each service data object, the result includes the QName, internal name, and Boolean values indicating whether create, update, merge, and delete operations can be performed on the object.

Security

The following tables list the privileges required to perform the service operations, and the duty roles that each privilege is granted to.

Service Operations to Privileges Mapping

Operation Name	Privilege Code	Privilege Name	Privilege Description
All Operations	WSH_MANAGE_SHIPMENT_WEB_SERVICE_PRIV	Manage Shipment Web Service	Allows access to Web service to manage shipments.

Privileges to Duty Roles Mapping

Privilege Code	Granted to Duty Role Code	Granted to Duty Role Name	Granted To Duty Role Description
WSH_MANAGE_SHIPMENT_WEB_SERVICE_PRIV	ORA_WSH_DELIVERY_PROCESSING_DUTY	Shipment Processing	Processes and confirms shipments and shipment lines. Records shipping costs and generates shipping related reports.

Duty Roles to Duty or Job Roles Mapping

Duty Role Code	Granted to Duty or Job Role Code	Granted to Duty or Job Role Name	Granted To Duty or Job Role Description
ORA_WSH_DELIVERY_PROCESSING_DUTY	ORA_FUN_FSCM_LOAD_INTERFACE_ADMIN_DUTY	FSCM Load Interface Administration	Manages load interface file for import
ORA_WSH_DELIVERY_PROCESSING_DUTY	ORA_EGP_ITEM_INQUIRY_DUTY	Item Inquiry	Queries and views items in the enterprise.