Quick availability check

post

/fscmRestApi/msp/latest/globalOrderPromises/quickAvailabilityCheck

Quick availability check

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : ItemDetailList
Type: array
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.
Show Source
Nested Schema : ItemDetail
Type: object
Show Source
Nested Schema : OrgInfo
Type: object
Show Source
Nested Schema : OrgInfoList
Type: array
Values that determine the resource availability
Show Source
Nested Schema : SupplierInfoList
Type: array
Values that temporarily link the input objects. This value is populated by the service.
Show Source
Nested Schema : SupplierInfo
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

Request is processed and the results include the expected ship date, expected arrival date, expected ship from warehouse, and the expected ship method.
Body ()
Root Schema : QuickAvailabilityCheckOutput
Type: object
Show Source
Nested Schema : ItemAvailabilityList
Type: array
Values that determine the resource availability.
Show Source
Nested Schema : SubstituteItemAvailabilityList
Type: array
Values that determine the substitute of resource availability.
Show Source
Nested Schema : ItemAvailability
Type: object
Show Source
Nested Schema : ItemAvailabilityAtOrgList
Type: array
Values that determine the resource availability.
Show Source
Nested Schema : ItemAvailabilityAtSupplierList
Type: array
Values that determine the resource availability.
Show Source
Nested Schema : ItemAvailabilityAtOrg
Type: object
Show Source
Nested Schema : OrgInfoList
Type: array
Values that determine the resource availability.
Show Source
Nested Schema : OrgInfo
Type: object
Show Source
Nested Schema : ItemAvailabilityAtSupplier
Type: object
Show Source
Nested Schema : SupplierInfoList
Type: array
Values that determine the resource availability.
Show Source
Nested Schema : SupplierInfo
Type: object
Show Source
Back to Top

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

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": "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

The following example includes the contents of the response body in JSON format:
{
    "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

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": "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

The following example includes the contents of the response body in JSON format:
{
    "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

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": "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

The following example includes the contents of the response body in JSON format:
{
    "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"
                        }
                    }
                ]
            }
        ]
    }
}
Back to Top