Supply availability

post

/fscmRestApi/msp/latest/globalOrderPromises/supplyAvailability

Supply availability

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 : ItemAtOrgList
Type: array
Values that represent the input attributes related to item and organization for the SupplyAvailabilityInput request.
Show Source
Nested Schema : ItemAtSupplierList
Type: array
Values that represent the input attributes related to item and supplier for the SupplyAvailabilityInput request.
Show Source
Nested Schema : OrgItem
Type: object
Show Source
Nested Schema : OrgInfo
Type: object
Show Source
Nested Schema : SupplierSiteItem
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 sip method.
Body ()
Root Schema : SupplyAvailabilityOutput
Type: object
Show Source
Nested Schema : SupplyAvailabilityResultList
Type: array
Values that represent the attributes of supply availability details for the supply availability service request.
Show Source
Nested Schema : DailyAvailability
Type: object
Show Source
Back to Top

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
                    }
                ]
            }
        ]
    }
}
Back to Top