Jump to

• Request
• Response
• Examples

Generate a shipment request

post

/fscmRestApi/resources/11.13.18.05/shipmentLineChangeRequests/action/generateShipmentRequest

Selects and sends shipment lines to external applications such as a warehouse management system and also indicates the lines as interfaced. The shipment lines are selected using input parameters, assigned to a picking batch, and their integration status is set to interfaced. The input parameters can be an existing picking batch name, an organization code, or a pick wave release rule.

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

• organizationCode: string
  Abbreviation that identifies the organization to retrieve the shipment lines to include on shipment request.
• pickBatchName: string
  Name of the picking batch to use for retrieving the shipment lines to include on the shipment request.
• releaseRuleName: string
  Name of the release rule to use for retrieving the shipment lines to include on the shipment request.

{
    "type":"object",
    "properties":{
        "organizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the organization to retrieve the shipment lines to include on shipment request.",
            "nullable":true
        },
        "pickBatchName":{
            "type":"string",
            "description":"Name of the picking batch to use for retrieving the shipment lines to include on the shipment request.",
            "nullable":true
        },
        "releaseRuleName":{
            "type":"string",
            "description":"Name of the release rule to use for retrieving the shipment lines to include on the shipment request.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

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): string
  Result of processing the request, which includes the picking batch identifier, processing status, and error message, if any.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Result of processing the request, which includes the picking batch identifier, processing status, and error message, if any."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

This example describes how to generate a shipment request that selects the shipment lines to interface with an external application, assign them to a picking batch, and sets their integration status to interfaced.

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 generate the shipment request for a specific picking batch name. 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.

{
	"pickBatchName":"5400787"
}

Example Response Body

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

{
	"ShipmentRequestId":5400787,
	"ShipmentRequest":"5400787",
	"ReturnStatus":"SUCCESS",
	"Message":null
}

Back to Top