Material Shipment Line
Service to operate on shipment lines. Users can manage shipment assignments, split, update, autocreate shipments, and get the status of a shipment line.
Life Cycle Status: Active
QName: {http://xmlns.oracle.com/apps/scm/shipping/shipConfirm/deliveries/shipmentLineService/}ShipmentLineService
Service WSDL URL: https://servername/fscmService/ShipmentLineService?WSDL
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 |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
Operations
UpdateShipmentLines
Update the existing shipment lines.
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 for True and F for False. |
ShipmentLineInformation |
Shipment Line Information |
List of shipment lines with details, such as item, quantity, required date, etc. |
SerialInformation |
Serial Number |
Details of serial numbers for shipment lines to be acted upon. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
Status of updating the shipment lines and related messages. |
AutocreateShipments
Creates a shipment and assigns the shipment lines.
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 for True and F for False. |
ShipmentLineList |
long |
List of unique identifiers for shipment lines to be acted on. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
Status of creating shipments and related messages. |
ManageShipmentAssignments
Manage assignment of shipment lines to shipments.
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 for True and F for False. |
ShipmentLineList |
long |
List of unique identifiers for shipment lines to be acted on. |
ActionCode |
string |
User specified action to be performed on the shipment line. Allowed values are ASSIGN and UNASSIGN. |
Shipment |
string |
Unique identifier for a shipment. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
Status of managing assignment of shipment lines and related messages. |
SplitShipmentLine
Split an existing shipment line.
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 for True and F for False. |
ShipmentLine |
long |
Unique identifier for a shipment line. |
SplitQuantity |
decimal |
Quantity to split in primary UOM. |
SecondarySplitQuantity |
decimal |
Quantity to split in secondary UOM. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
Status of splitting a shipment line and the related messages. |
GenerateShipmentRequest
Create a payload that includes Shipment and Shipment Line details.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
inputParams |
Outbound Shipment Request Criteria |
Object that contains the input parameters. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
Status of Generate Shipment Request and its related messages. |
processShippingCost
Create, update, or delete the shipping cost for a shipment line.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
shippingCost |
Shipment Line Shipping Cost |
User specified details for the shipping cost. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
Status of creating, updating, or deleting the shipping cost and the related messages. |
pack
Pack the shipment lines automatically or manually.
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. |
ShipmentLineList |
long |
List of unique identifiers for shipment lines to be packed. |
ActionCode |
string |
User specified action to be performed on the shipment lines. Allowed values are AUTO-PACK, AUTO-PACK-MASTER, PACK, and UNPACK. |
PackingUnit |
string |
Packing unit which the shipment lines to be packed into. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
Status of packing shipment lines and related messages. |
getShipmentLineData
An operation to get the list of service data objects defined on this service.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
shipmentLineArray |
long |
Input list of array of Shipment lines containing delivery detail id's. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
List of Shipment lines data |
UpdateTradeComplianceResults
Updates trade compliance screening results on shipment line
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
tradeComplianceStatus |
Update Trade Compliance Status Request SDO |
Details of screening results of shipment line such as such as trade compliance status and trade compliance reason. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
Status of updating trade compliance screening results and related messages |
GetBackorderLineData
Retrieve the details of a back ordered shipment line.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
backOrderedLineArray |
Backorder Line Request SDO |
Unique identifier of a shipment line. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
Status and the details of the back ordered shipment line. |
resetIntegrationStatus
Resetting integration status on shipment lines.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
ShipmentLineList |
long |
List of shipment line identifiers. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
Status of reset integration status result and 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. |