Jump to

• Request
• Response

Split a shipment line into multiple lines

post

/fscmRestApi/resources/11.13.18.05/shipmentLineChangeRequests/action/splitToMultipleLines

Splits a shipment line into multiple lines. When a shipment line is split, a new line is created for the specified quantity by copying the existing line and reducing the quantity in the original line.

Request

Header Parameters

• Metadata-Context: string
  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: string
  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: array details
  List of attributes used for splitting a shipment line.
  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.
  StagedQuantityToSplit: Staged quantity to be split in the primary unit of measure for the item.
  SecondaryStagedQuantityToSplit: Staged quantity to be split in the secondary unit of measure for the item.
• shipmentLine: number
  Value that uniquely identifies the shipment line to be backordered.

{
    "type":"object",
    "properties":{
        "shipmentLine":{
            "type":"number",
            "description":"Value that uniquely identifies the shipment line to be backordered.",
            "nullable":true
        },
        "details":{
            "type":"array",
            "description":"List of attributes used for splitting a shipment line.<br>QuantityToSplit: Quantity to be split in the primary unit of measure for the item.<br>SecondaryQuantityToSplit: Quantity to be split in the secondary unit of measure for the item.<br>StagedQuantityToSplit: Staged quantity to be split in the primary unit of measure for the item.<br>SecondaryStagedQuantityToSplit: Staged quantity to be split in the secondary unit of measure for the item.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : details

Type: array

List of attributes used for splitting a shipment line.
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.
StagedQuantityToSplit: Staged quantity to be split in the primary unit of measure for the item.
SecondaryStagedQuantityToSplit: Staged quantity to be split in the secondary unit of measure for the item.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"List of attributes used for splitting a shipment line.<br>QuantityToSplit: Quantity to be split in the primary unit of measure for the item.<br>SecondaryQuantityToSplit: Quantity to be split in the secondary unit of measure for the item.<br>StagedQuantityToSplit: Staged quantity to be split in the primary unit of measure for the item.<br>SecondaryStagedQuantityToSplit: Staged quantity to be split in the secondary unit of measure for the item.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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 list of new shipment lines created after splitting, processing status, and error message, if any.

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

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

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

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

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top