Jump to

• Request
• Response
• Examples

Add shipment lines or packing units to a shipment

post

/fscmRestApi/resources/11.13.18.05/shipmentLineChangeRequests/action/assign

Adds the shipment lines or packing units in a shipment. Optionally, a shipment line or packing unit assigned to another shipment can be added by unassigning it from the current shipment and adding it to the specified shipment.

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: array details
  List of attributes used for adding a shipment line to a shipment. EntityType: Indicates whether to add a shipment line or packing unit to a shipment. Valid values are Line and PackingUnit. ShipmentLine: Value that uniquely identifies the shipment line to be added. QuantityToAssign: Quantity to be added to the shipment. PackingUnit: Name of the packing unit. PackingUnitId: Value that uniquely identifies the packing unit.
• shipment: string
  Name of the shipment to which the shipment line or packing unit should be added to.
• unassignFromExistingShipmentFlag: boolean
  Contains one of the following values: true or false. If true, then the shipment line or packing unit is unassigned from the current shipment and added to the specified shipment. If false, then adding a shipment line or packing unit assigned to a different shipment isn't allowed. The default value is false.

{
    "type":"object",
    "properties":{
        "shipment":{
            "type":"string",
            "description":"Name of the shipment to which the shipment line or packing unit should be added to.",
            "nullable":true
        },
        "unassignFromExistingShipmentFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the shipment line or packing unit is unassigned from the current shipment and added to the specified shipment. If false, then adding a shipment line or packing unit assigned to a different shipment isn't allowed. The default value is false.",
            "nullable":true
        },
        "details":{
            "type":"array",
            "description":"List of attributes used for adding a shipment line to a shipment.\nEntityType: Indicates whether to add a shipment line or packing unit to a shipment. Valid values are Line and PackingUnit.\nShipmentLine: Value that uniquely identifies the shipment line to be added.\nQuantityToAssign: Quantity to be added to the shipment.\nPackingUnit: Name of the packing unit.\nPackingUnitId: Value that uniquely identifies the packing unit.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : details

Type: array

List of attributes used for adding a shipment line to a shipment. EntityType: Indicates whether to add a shipment line or packing unit to a shipment. Valid values are Line and PackingUnit. ShipmentLine: Value that uniquely identifies the shipment line to be added. QuantityToAssign: Quantity to be added to the shipment. PackingUnit: Name of the packing unit. PackingUnitId: Value that uniquely identifies the packing unit.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"List of attributes used for adding a shipment line to a shipment.\nEntityType: Indicates whether to add a shipment line or packing unit to a shipment. Valid values are Line and PackingUnit.\nShipmentLine: Value that uniquely identifies the shipment line to be added.\nQuantityToAssign: Quantity to be added to the shipment.\nPackingUnit: Name of the packing unit.\nPackingUnitId: Value that uniquely identifies the packing unit.",
    "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 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 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 processing status and error message, if any."
}

Result of processing the request, which includes the processing status and error message, if any.

Back to Top

Examples

This example describes how to add shipment lines and packing units to a 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 add shipment lines to 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": "assign",
    "parameters": [
        {
            "shipment": "2527629"
        },
        {
            "unassignFromExistingShipmentFlag": true
        },
        {
            "details": [
                {
                    "EntityType": "Line",
                    "ShipmentLine": 3992943
                },
                {
                    "EntityType": "Line",
                    "ShipmentLine": 3992945
                }
            ]
        }
    ]
}

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 add specific quantities from a shipment line to 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": "assign",
    "parameters": [
        {
            "shipment": "2527629"
        },
        {
            "unassignFromExistingShipmentFlag": true
        },
        {
            "details": [
                {
                    "EntityType": "Line",
                    "ShipmentLine": 3992943,
                    "QuantityToAssign": 10
                },
                {
                    "EntityType": "Line",
                    "ShipmentLine": 3992945,
                    "QuantityToAssign": 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 add packing units to 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": "assign",
    "parameters": [
        {
            "shipment": "2527629"
        },
        {
            "unassignFromExistingShipmentFlag": true
        },
        {
            "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"
    }
}

Back to Top