Supply availability
/fscmRestApi/msp/latest/globalOrderPromises/supplyAvailability
Request
There are no request parameters for this operation.
- application/json
object
-
CallingInstance: string
Value that uniquely identifies the source application from which the order promising service request originated.
-
CallingModule: string
Value that identifies the module from which the order promising service request originated.
-
EndDateTime: string
(date-time)
Date when the supply availability information stops being returned. This attribute represents the end date of the supply availability request date range.
-
ItemAtOrgList: array
ItemAtOrgList
Values that represent the input attributes related to item and organization for the SupplyAvailabilityInput request.
-
ItemAtSupplierList: array
ItemAtSupplierList
Values that represent the input attributes related to item and supplier for the SupplyAvailabilityInput request.
-
QueryIdentifier: string
Value that uniquely identifies the order promising web service query.
-
RequestCreationDateTime: string
(date-time)
Date and time when the supply availability request was created.
-
RequestTimeZone: string
Time zone from which the supply availability input originated.
-
StartDateTime: string
(date-time)
Date when the supply availability information starts to be returned. This attribute represents the start date of the supply availability request date range.
array
array
object
-
ItemIdentifier: string
Value that uniquely identifies the item.
-
OrgInfo: object
OrgInfo
object
-
InstanceNumber: string
Number that identifies the source application from which the order promising service request originated.
-
OrgIdentifier: string
Value that uniquely identifies the organization associated with the item.
object
-
ItemIdentifier: string
Value that uniquely identifies the item.
-
SupplierIdentifier: string
Value that uniquely identifies the supplier.
-
SupplierSiteIdentifier: string
Value that uniquely identifies the supplier site.
Response
- application/json
Default Response
object
-
ErrorCode: string
Abbreviation that identifies the error, if any. Its value is NULL if request is fulfilled or It can be 26 or OP_RUNTIME_ERROR.
-
ErrorMessage: string
Text of the error message, if any, for the error code.
-
PromiseDateTime: string
(date-time)
Date and time when the promise is generated by the Oracle Global Order Promising Cloud.
-
PromisingInstance: string
Value that uniquely identifies the source application in which order promising is performed.
-
PromisingSystem: string
Value that identifies the Oracle Global Order Promising Cloud application that performed the supply availability.
-
QueryIdentifier: string
Value that uniquely identifies the order promising web service query.
-
SupplyAvailabilityResultList: array
SupplyAvailabilityResultList
Values that represent the attributes of supply availability details for the supply availability service request.
array
object
-
ConsumedQuantity: number
(double)
Quantity of the available to promise inventory consumed by both the independent and dependant demands.
-
CummulativeQuantity: number
(double)
Quantity available to promise quantity that is accumulated from horizon start date onwards, adjusted after considering the net quantity.
-
EffectiveDateTime: string
(date-time)
Date and Time when the daily availability information is returned.
-
NetQuantity: number
(double)
Quantity Difference between supply quantity and consumed quantity.
-
SupplyQuantity: number
(double)
Quantity of available supply for the specified set of input parameters.
Examples
This example describes how to supply availability.
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/json" -d 'request payload' "https://servername/fscmRestApi/resources/version/globalOrderPromises/supplyAvailability"
Example 1 Request Body
The following example includes the contents of the request body in JSON format. 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.
{ "CallingModule": "GOP", "CallingInstance": "GOP", "RequestCreationDateTime":"2020-09-17", "QueryIdentifier": "2", "StartDateTime": "2020-09-17", "EndDateTime": "2020-09-17", "ItemAtOrgList" : [{ "ItemIdentifier" : "RI-HV-GOP-Computer", "OrgInfo":{ "OrgIdentifier": "GOP:HVGOPE01" } } ] }
Example 1 Response Body
The following example includes the contents of the response body in JSON format:
{ "SupplyAvailabilityOutput": { "PromisingSystem": "NewGop", "PromisingInstance": "GOP", "PromiseDateTime": "2020-09-17T00:00:00.000+0000", "QueryIdentifier": "2", "ErrorCode": "S", "SupplyAvailabilityResultList": [ { "ItemIdentifier": "RI-HV-GOP-Computer", "OrgInfoList": [ { "OrgIdentifier": "GOP:HVGOPE01" } ], "DailyAvailabilitiesList": [ { "EffectiveDateTime": "2020-09-17T00:00:00.000+0000", "SupplyQuantity": 100, "ConsumedQuantity": 20, "NetQuantity": 80, "CummulativeQuantity": 80 } ] } ] } }
Example 2 Request Body
The following example includes the contents of the request body in JSON format. 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.
{ "CallingModule": "GOP", "CallingInstance": "GOP", "RequestCreationDateTime":"2020-09-17", "QueryIdentifier": "2", "StartDateTime": "2020-09-17", "EndDateTime": "2020-09-17", "ItemAtOrgList" : [{ "ItemIdentifier" : "RI-HV-GOP-Computer", "OrgInfo":{ "OrgIdentifier": "GOP:HVGOPE01" } } ] }
Example 2 Response Body
The following example includes the contents of the response body in JSON format:
{ "SupplyAvailabilityOutput": { "PromisingSystem": "NewGop", "PromisingInstance": "GOP", "PromiseDateTime": "2020-09-17T00:00:00.000+0000", "QueryIdentifier": "2", "ErrorCode": "S", "SupplyAvailabilityResultList": [ { "ItemIdentifier": "RI-HV-GOP-Computer", "OrgInfoList": [ { "OrgIdentifier": "GOP:HVGOPE01" } ], "DailyAvailabilitiesList": [ { "EffectiveDateTime": "2020-09-17T00:00:00.000+0000", "SupplyQuantity": 100, "ConsumedQuantity": 0, "NetQuantity": 100, "CummulativeQuantity": 100 } ] } ] } }