Quick availability check
/fscmRestApi/msp/latest/globalOrderPromises/quickAvailabilityCheck
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.
-
ItemDetailList: array
ItemDetailList
Values that identify the unique configuration item corresponding the configuration sent for promising. This is applicable only in the case of assemble to order demands.
-
RequestCreationDateTime: string
(date-time)
Date and time when the check availability request was created for the fulfillment line.
-
RequestTimeZone: string
Time zone from which the check availability request has originated.
array
object
-
AvailabilityForDropShipSupplierFlag: boolean
Contains one of the following values: true or false. If true, then the availability at drop ship suppliers should be considered. If false, then the availability at drop ship suppliers should not be considered. The default value is false.
-
AvailabilityForSubstitutesFlag: boolean
Contains one of the following values: true or false. If true, then the availability of substitute items should be considered. If false, then the availability of substitute items should not be considered. The default value is false.
-
CustomerIdentifier: string
Value that uniquely identifies the customer.
-
CustomerSiteIdentifier: string
Value that uniquely identifies the customer site.
-
InternalSalesOrderDestOrg: object
OrgInfo
-
ItemIdentifier: string
Value that uniquely identifies the item.
-
OrgInfoList: array
OrgInfoList
Values that determine the resource availability
-
PartyIdentifier: string
Value that uniquely identifies the party representing the customer.
-
PartySiteIdentifier: string
Value that uniquely identifies the party site corresponding to the customer ship-to site.
-
Region: string
Value that identifies the region of the customer.
-
RequestedDateTime: string
(date-time)
Date when the resource availability information needs to be returned.
-
SupplierInfoList: array
SupplierInfoList
Values that temporarily link the input objects. This value is populated by the service.
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.
array
object
-
Supplier: string
Name of the drop ship supplier that ships items directly to the customer.
-
SupplierSite: string
Name of the drop ship supplier site that ships items directly to the customer.
Response
- application/json
Default Response
object
-
ItemAvailabilityList: array
ItemAvailabilityList
Values that determine the resource availability.
-
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 quick availability check
-
SubstituteItemAvailabilityList: array
SubstituteItemAvailabilityList
Values that determine the substitute of resource availability.
array
array
object
-
ErrorCode: string
Abbreviation that identifies the error code, if any, returned by Oracle Global Order Promising Cloud for the service request.
-
ErrorMessage: string
Text of the error message, if any, for the error code.
-
ItemAvailabilityAtOrgList: array
ItemAvailabilityAtOrgList
Values that determine the resource availability.
-
ItemAvailabilityAtSupplierList: array
ItemAvailabilityAtSupplierList
Values that determine the resource availability.
-
ItemIdentifier: string
Value that uniquely identifies the item.
-
RequestedDateTime: string
(date-time)
Date when the material is requested to be available. Depending on the request type this attribute represents the requested ship date or request arrival date.
array
array
object
-
AvailableQuantity: number
(double)
Quantity of the available to promise inventory consumed by both the independent and dependant demands.
-
OrgInfoList: array
OrgInfoList
Values that determine the resource availability.
-
ShelfQuantity: number
(double)
Supply at the organization or supplier location.
array
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
-
AvailableQuantity: number
(double)
Quantity of the available to promise inventory consumed by both the independent and dependant demands.
-
ShelfQuantity: number
(double)
Supply at the organization or supplier location.
-
SupplierInfoList: array
SupplierInfoList
Values that determine the resource availability.
array
object
-
Supplier: string
Name of the drop ship supplier that ships items directly to the customer.
-
SupplierSite: string
Name of the drop ship supplier site that ships items directly to the customer.
Examples
These examples describe how to quick availability check.
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/quickAvailabilityCheck"
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-17T15:50:00", "ItemDetailList": [{ "ItemIdentifier": "RI-HV-GOP-Computer", "RequestedDateTime": "2020-09-17T15:00:00" }] }
Example 1 Response Body
The following example includes the contents of the response body in JSON format:
{ "QuickAvailabilityCheckOutput": { "PromisingSystem": "NewGop", "PromisingInstance": "GOP", "PromiseDateTime": "2020-09-17T15:50:00.000+0000", "ItemAvailabilityList": [ { "ItemIdentifier": "RI-HV-GOP-Computer", "RequestedDateTime": "2020-09-17T15:00:00.000+0000", "ItemAvailabilityAtOrgList": [ { "ShelfQuantity": 100, "AvailableQuantity": 100, "OrgInfoList": [ { "OrgIdentifier": "GOP:HVGOPE01" } ] }, { "ShelfQuantity": 20, "AvailableQuantity": 20, "OrgInfoList": [ { "OrgIdentifier": "GOP:HVGOPE02" } ] } ] } ] } }
Example 2 Request Body
{ "CallingModule": "GOP", "CallingInstance": "GOP", "RequestCreationDateTime": "2022-08-26", "ItemDetailList": [ { "ItemIdentifier": "RI-HV-ANALOG-MS2", "OrgInfoList": [ { "OrgIdentifier": "M2" } ], "RequestedDateTime": "2022-08-26", "AllocationNodeList": [ { "AllocationNodeFirstLevel": "ALL", "AllocationNodeSecondLevel": "BLM-South", "AllocationNodeThirdLevel": "BLM-South-High Priority" }, { "AllocationNodeFirstLevel": "ALL", "AllocationNodeSecondLevel": "BLM-South" }, { "AllocationNodeFirstLevel": "ALL" } ] } ] }
Example 2 Response Body
{ "QuickAvailabilityCheckOutput": { "PromisingSystem": "HVGOP", "PromisingInstance": "GOP", "PromiseDateTime": "2022-08-26T00:00:00.000+0000", "ItemAvailabilityList": [ { "ItemIdentifier": "RI-HV-ANALOG-MS2", "RequestedDateTime": "2022-08-26T00:00:00.000+0000", "ItemAvailabilityAtOrgList": [ { "ShelfQuantity": 100, "AvailableQuantity": 56, "WeeklyAllocatedNodeQuantity": 12, "WeeklyAllocatedTotalQuantity": 56, "OrgInfoList": [ { "OrgIdentifier": "M2" } ], "AllocationNode": { "AllocationNodeFirstLevel": "ALL", "AllocationNodeSecondLevel": "BLM-South", "AllocationNodeThirdLevel": "BLM-South-High Priority" } }, { "ShelfQuantity": 100, "AvailableQuantity": 33, "WeeklyAllocatedNodeQuantity": 23, "WeeklyAllocatedTotalQuantity": 33, "OrgInfoList": [ { "OrgIdentifier": "M2" } ], "AllocationNode": { "AllocationNodeFirstLevel": "ALL", "AllocationNodeSecondLevel": "BLM-South" } }, { "ShelfQuantity": 100, "AvailableQuantity": 10, "WeeklyAllocatedNodeQuantity": 10, "WeeklyAllocatedTotalQuantity": 10, "OrgInfoList": [ { "OrgIdentifier": "M2" } ], "AllocationNode": { "AllocationNodeFirstLevel": "ALL" } } ] } ] } }
Example 3 Request Body
{ "CallingModule": "GOP", "CallingInstance": "GOP", "RequestCreationDateTime": "2022-08-10", "ItemDetailList": [ { "ItemIdentifier": "GOP-PHONE", "RequestedDateTime": "2022-09-10", "AvailabilityForSubstituteItemsFlag": true, "OrgInfoList": { "OrgIdentifier": "M1" }, "AllocationNodeList": [ { "AllocationNodeFirstLevel":"ALL" }, { "AllocationNodeFirstLevel":"ALL", "AllocationNodeSecondLevel":"BLM-Rest" } ] }, { "ItemIdentifier": "GOP-PHONE-XS", "RequestedDateTime": "2022-09-11", "AvailabilityForSubstituteItemsFlag": true, "OrgInfoList": { "OrgIdentifier": "M1" }, "AllocationNodeList": [ { "AllocationNodeFirstLevel":"ALL" } ] } ] }
Example 3 Response Body
{ "QuickAvailabilityCheckOutput": { "PromisingSystem": "HVGOP", "PromisingInstance": "GOP", "PromiseDateTime": "2022-08-10T00:00:00.000+0000", "ItemAvailabilityList": [ { "ItemIdentifier": "GOP-PHONE", "RequestedDateTime": "2022-09-10T00:00:00.000+0000", "ItemAvailabilityAtOrgList": [ { "ShelfQuantity": 1000, "AvailableQuantity": 200, "WeeklyAllocatedNodeQuantity": 200, "WeeklyAllocatedTotalQuantity": 200, "OrgInfoList": [ { "OrgIdentifier": "M1" } ], "AllocationNode": { "AllocationNodeFirstLevel": "ALL" } }, { "ShelfQuantity": 1000, "AvailableQuantity": 600, "WeeklyAllocatedNodeQuantity": 400, "WeeklyAllocatedTotalQuantity": 600, "OrgInfoList": [ { "OrgIdentifier": "M1" } ], "AllocationNode": { "AllocationNodeFirstLevel": "ALL", "AllocationNodeSecondLevel": "BLM-Rest" } } ] }, { "ItemIdentifier": "GOP-PHONE-XS", "RequestedDateTime": "2022-09-11T00:00:00.000+0000", "ItemAvailabilityAtOrgList": [ { "ShelfQuantity": 1000, "AvailableQuantity": 1000, "OrgInfoList": [ { "OrgIdentifier": "M1" } ] } ] } ] } }
Example 4 Request Body
{ "CallingModule": "GOP", "CallingInstance": "GOP", "RequestCreationDateTime": "2022-06-08", "ItemDetailList": [ { "ItemIdentifier": "RI-HV-ANALOG-NUMS2", "RequestedDateTime": "2022-06-08", "AllocationNodeList": [ { "AllocationNodeFirstLevel": "ALL", "AllocationNodeSecondLevel": "BLM-South", "AllocationNodeThirdLevel": "BLM-SouthWest" }, { "AllocationNodeFirstLevel": "ALL", "AllocationNodeSecondLevel": "BLM-Rest" }, { "AllocationNodeFirstLevel": "ALL" } ] } ] }
Example 4 Response Body
{ "QuickAvailabilityCheckOutput": { "PromisingSystem": "HVGOP", "PromisingInstance": "GOP", "PromiseDateTime": "2022-06-08T00:00:00.000+0000", "ItemAvailabilityList": [ { "ItemIdentifier": "RI-HV-ANALOG-NUMS2", "RequestedDateTime": "2022-06-08T00:00:00.000+0000", "ItemAvailabilityAtOrgList": [ { "ShelfQuantity": 100, "AvailableQuantity": 38, "WeeklyAllocatedNodeQuantity": 8, "WeeklyAllocatedTotalQuantity": 38, "OrgInfoList": [ { "OrgIdentifier": "M1" } ], "AllocationNode": { "AllocationNodeFirstLevel": "ALL", "AllocationNodeSecondLevel": "BLM-South", "AllocationNodeThirdLevel": "BLM-SouthWest" } }, { "ShelfQuantity": 100, "AvailableQuantity": 25, "WeeklyAllocatedNodeQuantity": 15, "WeeklyAllocatedTotalQuantity": 25, "OrgInfoList": [ { "OrgIdentifier": "M1" } ], "AllocationNode": { "AllocationNodeFirstLevel": "ALL", "AllocationNodeSecondLevel": "BLM-Rest" } }, { "ShelfQuantity": 100, "AvailableQuantity": 10, "WeeklyAllocatedNodeQuantity": 10, "WeeklyAllocatedTotalQuantity": 10, "OrgInfoList": [ { "OrgIdentifier": "M1" } ], "AllocationNode": { "AllocationNodeFirstLevel": "ALL" } }, { "ShelfQuantity": 100, "AvailableQuantity": 45, "WeeklyAllocatedNodeQuantity": 5, "WeeklyAllocatedTotalQuantity": 45, "OrgInfoList": [ { "OrgIdentifier": "M2" } ], "AllocationNode": { "AllocationNodeFirstLevel": "ALL", "AllocationNodeSecondLevel": "BLM-South", "AllocationNodeThirdLevel": "BLM-SouthWest" } }, { "ShelfQuantity": 100, "AvailableQuantity": 17, "WeeklyAllocatedNodeQuantity": 7, "WeeklyAllocatedTotalQuantity": 17, "OrgInfoList": [ { "OrgIdentifier": "M2" } ], "AllocationNode": { "AllocationNodeFirstLevel": "ALL", "AllocationNodeSecondLevel": "BLM-Rest" } }, { "ShelfQuantity": 100, "AvailableQuantity": 10, "WeeklyAllocatedNodeQuantity": 10, "WeeklyAllocatedTotalQuantity": 10, "OrgInfoList": [ { "OrgIdentifier": "M2" } ], "AllocationNode": { "AllocationNodeFirstLevel": "ALL" } } ] } ] } }