Backorder a shipment line
post
/fscmRestApi/resources/11.13.18.05/shipmentLineChangeRequests/action/backorderLine
Backorders a shipment line according to the shipment line number. The input parameters can include the quantity to be backordered.
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
Root Schema : schema
Type:
Show Source
object
-
quantityToBackorder: number
Quantity to be backordered.
-
shipmentLine: number
Value that uniquely identifies the shipment line to be backordered.
Response
Supported Media Types
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
The following table describes the default response for this task.
Root Schema : schema
Type:
Show Source
object
-
result(required): object
result
Additional Properties Allowed: additionalPropertiesResult of processing the request, which includes the shipment line, backordered shipment line, processing status, and error message, if any.
Nested Schema : result
Type:
object
Additional Properties Allowed
Show Source
Result of processing the request, which includes the shipment line, backordered shipment line, processing status, and error message, if any.
Examples
This example describes how to backorder a shipment line according to the shipment line number.
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
This example includes the contents of the request body in JSON
format to backorder an interfaced shipment line by providing the shipment line
number and the quantity to backorder. 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 uses in the
record that it creates.
{ "name": "backorderLine", "parameters": [ { "shipmentLine": 3838173 }, { "quantityToBackorder": 20 } ] }
Example Response Body
This example includes the contents of the response body in JSON
format:
{ "result": { "ShipmentLine ": "3838173", "BackorderedShipmentLine ": "3838191", "ReturnStatus ": "S", "Message ": null } }