Get stockouts with revenue at risk
fscmRestApi/scp/buyerPlanningItemStockouts/itemLocationInventoryImpacts
Request
-
Item Location Inventory Impacts:
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.
-
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".
- */*
object
-
EndDate: string
Date indicating the last day of the query result.
-
OrganizationCode: string
Abbreviation that identifies the organization.
-
PlanId: integer
(int64)
Value that uniquely identifies the plan.
-
StartDate: string
Date indicating the first day of the query result.
Response
- */*
Default Response
object
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the item.
-
Item: string
Number that identifies the item.
-
ItemDescription: string
Description of the item.
-
Location: string
Value that uniquely identifies the location where the item is shipped.
-
RevenueAtRisk: integer
(int64)
The potential financial loss from an item stockout, reported in US dollars.
-
SafetyStockoutViolationCount: integer
(int64)
Number of days with a safety stock violation for the item location.
-
StockoutCount: integer
(int64)
Number of stockout days for the item location.
Examples
These examples describe get stockouts with revenue at risk.
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/scp/buyerPlanningItemStockouts/itemLocationInventoryImpacts"
Example 1 Request Body
The following example includes the contents of the request body in JSON format to get the top 10 item location inventory impacts. 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 gets.
{"PlanId":300100573650379,"StartDate":"2024-01-18","EndDate":"2024-07-15"}
Example 1 Response Body
The following example includes the contents of the response body in JSON format:
[ { "Item" : "BP-Sterlizer-02", "StockoutCount" : 7, "RevenueAtRisk" : 230, "InventoryItemId" : 26563117, "OrganizationId" : 147202, "ItemDescription" : "BP-Sterlizer-02", "Location" : "BP2", "SafetyStockViolationCount" : 34 }, { "Item" : "BP-Sterlizer-05", "StockoutCount" : 7, "RevenueAtRisk" : 230, "InventoryItemId" : 26563140, "OrganizationId" : 147202, "ItemDescription" : "BP-Sterlizer-05", "Location" : "BP2", "SafetyStockViolationCount" : 0 } ... ]
Example 2 Request Body
The following example includes the contents of the request body in JSON format to get the top 25 item location inventory impacts for a location. 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.
{"PlanId":300100573650379,"StartDate":"2024-01-18","EndDate":"2024-07-15","OrganizationCode":"BP2"}
Example 2 Response Body
The following example includes the contents of the response body in JSON format:
[ { "Item" : "BP-Sterlizer-02", "StockoutCount" : 7, "RevenueAtRisk" : 230, "InventoryItemId" : 26563117, "OrganizationId" : 147202, "ItemDescription" : "BP-Sterlizer-02", "Location" : "BP2", "SafetyStockViolationCount" : 34 }, { "Item" : "BP-Sterlizer-05", "StockoutCount" : 7, "RevenueAtRisk" : 230, "InventoryItemId" : 26563140, "OrganizationId" : 147202, "ItemDescription" : "BP-Sterlizer-05", "Location" : "BP2", "SafetyStockViolationCount" : 0 } ... ]