Pack shipment lines or packing units

post

/fscmRestApi/resources/11.13.18.05/shipmentLineChangeRequests/action/pack

Packs the shipment lines or packing units into a packing unit.

Request

Header Parameters
  • 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".
  • 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
Request Body - application/vnd.oracle.adf.action+json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : linesToPack
Type: array
Contains the attribute used for specifying shipment lines to be packed. ShipmentLine: Value that uniquely identifies the shipment line to be packed.
Show Source
Nested Schema : packingUnitsToPack
Type: array
List of attributes used for specifying the packing units to be packed. PackingUnit: Name of the packing unit to be packed. PackingUnitId: Value that uniquely identifies the packing unit to be packed.
Show Source
Nested Schema : items
Type: object
Additional Properties Allowed
Show Source
Nested Schema : items
Type: object
Additional Properties Allowed
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : result
Type: object
Additional Properties Allowed
Show Source
Result of processing the request, which includes the processing status and error message, if any.
Back to Top

Examples

This example describes how to pack shipment lines into a packing unit and pack packing units into another outer packing unit.

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 pack shipment lines into a new packing unit. You can either use the packing unit type name or packing unit type 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": "pack",
    "parameters": [
        {
            "packingUnitType": "WSH-Container1"
        },
        {
            "organizationId": "204"
        },
        {
            "linesToPack": [
                {
                    "ShipmentLine": "3993946"
                },
                {
                    "ShipmentLine": "3993947"
                }
            ]
        }
    ]
}

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 pack shipment lines into an existing packing unit. 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 updates.

{
    "name": "pack",
    "parameters": [
        {
            "packingUnit": "50318"
        },
        {
            "organizationId": "204"
        },
        {
            "linesToPack": [
                {
                    "ShipmentLine": "3992949"
                }
            ]
        }
    ]
}

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 pack packing units into another packing unit. 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 updates.

{
    "name": "pack",
    "parameters": [
        {
            "packingUnitType": "WSH-Container2"
        },
        {
            "organizationId": 204
        },
        {
            "packingUnitsToPack": [
                {
                    "PackingUnit": 50319
                },
                {
                    "PackingUnit": 50320
                }
            ]
        }
    ]
}

Example 3 Response Body

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

{
    "result": {
        "Message": null,
        "ReturnStatus": "S"
    }
}

Example 4 Request Body

The following example includes the contents of the request body in JSON format to pack a combination of shipment lines and packing units into another packing unit. You can either use the packing unit type name or packing unit type 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 updates.

{
    "name": "pack",
    "parameters": [
        {
            "packingUnitType": "WSH-Container2"
        },
        {
            "organizationId": 204
        },
        {
            "packingUnitsToPack": [
                {
                    "PackingUnit": 50319
                },
                {
                    "PackingUnit": 50320
                }
            ]
        },
        {
            "linesToPack": [
                {
                    "ShipmentLine": "3993949"
                },
                {
                    "ShipmentLine": "3993951"
                }
            ]
        }
    ]
}

Example Response Body

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

{
    "result": {
        "Message": null,
        "ReturnStatus": "S"
    }
}
Back to Top