Jump to

• Request
• Response
• Examples

Split one shipment line

post

/fscmRestApi/resources/11.13.18.05/shipmentLineChangeRequests/action/split

Splits a shipment line. When splitting a shipment line, a new line is created for the specified quantity by copying the existing line, and the quantity in the original line is reduced.

Request

Header Parameters

• 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.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• details: object details
  Additional Properties Allowed: additionalProperties

  List of attributes used for splitting a shipment line. ShipmentLine: Value that uniquely identifies the shipment line to be split. QuantityToSplit: Quantity to be split in the primary unit of measure for the item. SecondaryQuantityToSplit: Quantity to be split in the secondary unit of measure for the item.

{
    "type":"object",
    "properties":{
        "details":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"List of attributes used for splitting a shipment line.\nShipmentLine: Value that uniquely identifies the shipment line to be split.\nQuantityToSplit: Quantity to be split in the primary unit of measure for the item.\nSecondaryQuantityToSplit: Quantity to be split in the secondary unit of measure for the item.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : details

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"List of attributes used for splitting a shipment line.\nShipmentLine: Value that uniquely identifies the shipment line to be split.\nQuantityToSplit: Quantity to be split in the primary unit of measure for the item.\nSecondaryQuantityToSplit: Quantity to be split in the secondary unit of measure for the item.",
    "nullable":true
}

List of attributes used for splitting a shipment line. ShipmentLine: Value that uniquely identifies the shipment line to be split. QuantityToSplit: Quantity to be split in the primary unit of measure for the item. SecondaryQuantityToSplit: Quantity to be split in the secondary unit of measure for the item.

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  Result of processing the request, which includes the shipment line, new shipment line created after splitting, processing status, and error message, if any.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Result of processing the request, which includes the shipment line, new shipment line created after splitting, processing status, and error message, if any."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Result of processing the request, which includes the shipment line, new shipment line created after splitting, processing status, and error message, if any."
}

Result of processing the request, which includes the shipment line, new shipment line created after splitting, processing status, and error message, if any.

Back to Top

Examples

This example describes how to split shipment lines.

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 Request Body

The following example includes the contents of the request body in JSON format to split a shipment line. 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": "split",
    "parameters": [
        {
            "details": {
                "ShipmentLine": "3992949",
                "QuantityToSplit": "5"
            }
        }
    ]
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "result": {
        "ShipmentLine": "3992949",
        "SplitShipmentLine": "3993946",
        "ReturnStatus": "S",
        "Message": null
    }
}

Back to Top