Jump to

• Request
• Response
• Examples

Get item location stockout days

post

fscmRestApi/scp/buyerPlanningItemStockouts/itemLocationRevenueAtRiskStockouts

Returns a list of the top 10 items stockouts in each location by the number of stockout days.

Request

Header Parameters

• Item Location Revenue at Risk Stockouts:
  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".

Supported Media Types

• */*

Request Body - */* ()

Root Schema : schema

Type: object

Show Source

• EndDate: string
  Date indicating the last day of the query result.
• PlanId: integer (int64)
  Value that uniquely identifies the plan.
• StartDate: string
  Date indicating the first day of the query result.

{
    "type":"object",
    "properties":{
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "format":"int64"
        },
        "StartDate":{
            "type":"string",
            "description":"Date indicating the first day of the query result."
        },
        "EndDate":{
            "type":"string",
            "description":"Date indicating the last day of the query result."
        }
    }
}

Back to Top

Response

Supported Media Types

• */*

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : buyerPlanningItemStockouts-itemLocationRevenueAtRiskStockoutsItem-response

Type: object

Show Source

• CurrencyCode: string
  Title: CurrencyCode

  Abbreviation that identifies the currency for the RevenueAtRisk value.
• Item: string
  Title: Item

  Name of the item with the stockout.
• OrganizationCode: string
  Abbreviation that identifies the organization with the item stockout.
• RevenueAtRisk: integer (int64)
  The potential financial loss from an item stockout, reported in US dollars.
• StockoutCount: integer (int64)
  Number of stockout days, measured by the number of times the Updated Projected Available Balance measure value is less than 0 for a given date range.

{
    "type":"object",
    "properties":{
        "OrganizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the organization with the item stockout."
        },
        "StockoutCount":{
            "type":"integer",
            "description":"Number of stockout days, measured by the number of times the Updated Projected Available Balance measure value is less than 0 for a given date range.",
            "format":"int64"
        },
        "RevenueAtRisk":{
            "type":"integer",
            "description":"The potential financial loss from an item stockout, reported in US dollars.",
            "format":"int64"
        },
        "CurrencyCode":{
            "title":"CurrencyCode",
            "type":"string",
            "description":"Abbreviation that identifies the currency for the RevenueAtRisk value."
        },
        "Item":{
            "title":"Item",
            "type":"string",
            "description":"Name of the item with the stockout."
        }
    }
}

Back to Top

Examples

This example describes how to get item location stockout days.

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/itemLocationRevenueAtRiskStockouts"

Example Request Body

The following example includes the contents of the request body in JSON format to get all item location stockouts by revenue at risk. 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 Response Body

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

[ {
  "CurrencyCode" : "USD",
  "StockoutCount" : 7,
  "Item" : "BP-BandAid-01",
  "RevenueAtRisk" : 230.0,
  "OrganizationCode" : "BP1"
}, {
  "CurrencyCode" : "USD",
  "StockoutCount" : 7,
  "Item" : "BP-BandAid-01",
  "RevenueAtRisk" : 230.0,
  "OrganizationCode" : "BP2"
} ... ]

Back to Top