Unassign shipment lines or packing units from a shipment
/fscmRestApi/resources/11.13.18.05/shipmentLineChangeRequests/action/unassign
Request
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
- application/vnd.oracle.adf.action+json
object
-
details: array
details
List of attributes used for unassigning a shipment line. EntityType: Indicates whether to unassign a shipment line or packing unit. Valid values are Line and PackingUnit. ShipmentLine: Value that uniquely identifies the shipment line to be unassigned. QuantityToUnassign: Quantity to be unassigned. PackingUnit: Name of the packing unit. PackingUnitId: Value that uniquely identifies the packing unit. ReassignToShipment: Name of the shipment to which the shipment line or packing unit should be added after removal from the current shipment.
array
-
Array of:
object items
Additional Properties Allowed: additionalProperties
Response
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
object
-
result(required): object
result
Additional Properties Allowed: additionalPropertiesResult of processing the request, which includes the processing status and error message, if any.
object
Examples
This example describes how to unassign shipment lines and packing units from the shipment.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/shipmentLineChangeRequests"
Example 1 Request Body
The following example includes the contents of the request body in JSON format to unassign shipment lines from the current shipment. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{ "name": "unassign", "parameters": [ { "details": [ { "EntityType": "Line", "ShipmentLine": "3992945" }, { "EntityType": "Line", "ShipmentLine": "3992947" } ] } ] }
Example 1 Response Body
The following example includes the contents of the response body in JSON format:
{ "result": { "Message": null, "ReturnStatus": "S" } }
Example 2 Request Body
The following example includes the contents of the request body in JSON format to unassign specific quantities of a shipment line from the shipment. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{ "name": "unassign", "parameters": [ { "details": [ { "EntityType": "Line", "ShipmentLine": "3992945", "QuantityToUnassign": 5 }, { "EntityType": "Line", "ShipmentLine": "3992947", "QuantityToUnassign": 5 } ] } ] }
Example 2 Response Body
The following example includes the contents of the response body in JSON format:
{ "result": { "Message": null, "ReturnStatus": "S" } }
Example 3 Request Body
The following example includes the contents of the request body in JSON format to unassign packing units from the shipment. You can either use the packing unit name or packing unit identifier. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{ "name": "unassign", "parameters": [ { "details": [ { "EntityType": "PackingUnit", "PackingUnit": 49317 }, { "EntityType": "PackingUnit", "PackingUnit": 46358 } ] } ] }
Example 3 Response Body
The following example includes the contents of the response body in JSON format:
{ "result": { "Message": null, "ReturnStatus": "S" } }