Generate a shipment request
/fscmRestApi/resources/11.13.18.05/shipmentLineChangeRequests/action/generateShipmentRequest
Request
-
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.
- application/vnd.oracle.adf.action+json
object
-
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.
Response
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
object
-
result(required): string
Result of processing the request, which includes the picking batch identifier, processing status, and error message, if any.
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 }