1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Order Management
  4. Global Order Promising

Schedule sales orders

post

/fscmRestApi/msp/latest/globalOrderPromises/scheduleSalesOrders

Schedule sales orders

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 : ScheduleFulfillmentLineEntryList
Type: array
Values that represent the attributes of schedule fulfillment entry line request.
Show Source
Nested Schema : ScheduleFulfillmentLineEntry
Type: object
Show Source
Nested Schema : ScheduleFulfillmentLine
Type: object
Show Source
Nested Schema : ScheduleFulfillmentLineModel
Type: object
Show Source
  • Contains one of the following values: true or false. If true, then the included items for PTO model are specified on the request. If false, then the included items for PTO model are derived internally. This attribute does not have a default value.
  • Type of the configure to order communicated in the service request. Valid values include ATO, PTO-SMC, and PTO-NSMC.
  • Value that uniquely identifies the fulfillment line for the root parent configure to order (CTO) model. This attribute is applicable only for configured to order items.
  • ScheduleFulfillmentLineList
    Values that represent the attributes of schedule fulfillment line request.
Nested Schema : ScheduleFulfillmentLineSet
Type: object
Show Source
Nested Schema : OrgInfo
Type: object
Show Source
Nested Schema : ScheduleFulfillmentLineList
Type: array
Values that represent the attributes of schedule fulfillment line request.
Show Source
Nested Schema : ScheduleFulfillmentLineList
Type: array
Values that represent the attributes of schedule fulfillment line request.
Show Source
Nested Schema : ScheduleFulfillmentLineModelList
Type: array
Values that represent the attributes of schedule fulfillment model line request.
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 expected ship method.
Body ()
Root Schema : ScheduleSalesOrdersOutput
Type: object
Show Source
Nested Schema : ScheduleFulfillmentLineEntryResultList
Type: array
Values that represent the attributes of fulfillment line response.
Show Source
Nested Schema : ScheduleFulfillmentLineEntryResult
Type: object
Show Source
Nested Schema : ScheduleFulfillmentLineModelReplyList
Type: array
Values that represent the attributes of schedule fulfillment line model response
Show Source
Nested Schema : ScheduleFulfillmentLineReplyList
Type: array
Values that represent the attributes of schedule fulfillment line response.
Show Source
Nested Schema : ScheduleFulfillmentLineSetReplyList
Type: array
Values that represent the attributes of schedule fulfillment line set response.
Show Source
Nested Schema : ScheduleFulfillmentLineModelReply
Type: object
Show Source
Nested Schema : ScheduleFulfillmentLineReplyList
Type: array
Values that represent the attributes of schedule fulfillment line response.
Show Source
Nested Schema : ScheduleFulfillmentLineReply
Type: object
Show Source
Nested Schema : PeggingDetailList
Type: array
Values to manage the supply and demand pegging for a given fulfillment line.
Show Source
Nested Schema : PeggingDetail
Type: object
Show Source
Nested Schema : AllocationDetailList
Type: array
Details about the allocation that promising uses. Displays on the allocation header.
Show Source
Nested Schema : AtpDetailList
Type: array
Values that temporarily link the input objects. Value is populated by the service.
Show Source
Nested Schema : BuyFromDetailList
Type: array
Values that represent the unique identifier of the department to which the consumed resource belongs to.
Show Source
Nested Schema : CtpDetailList
Type: array
Values that indicate the date when the resource consumption ends.
Show Source
Nested Schema : OrgInfoList
Type: array
Values that identify the resource used to 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 : TransferFromDetailList
Type: array
Values that represent the unique identifier of the department to which the consumed resource belongs.
Show Source
Nested Schema : AllocationDetail
Type: object
Show Source
Nested Schema : ATPDetail
Type: object
Show Source
Nested Schema : AllocationDetailList
Type: array
Details about the allocation that promising uses. Displays on the allocation header.
Show Source
Nested Schema : BuyFromDetail
Type: object
Show Source
Nested Schema : CTPDetail
Type: object
Show Source
Nested Schema : ConsumedMaterialList
Type: array
Values that identify the material consumed in the manufacturing process.
Show Source
Nested Schema : ConsumedResourceList
Type: array
Values that identify the resource consumed in the manufacturing process.
Show Source
Nested Schema : MaterialDetail
Type: object
Show Source
Nested Schema : PeggingDetailList
Type: array
Values that indicate the supply and demand pegging for a given fulfillment line.
Show Source
Nested Schema : ResourceDetail
Type: object
Show Source
Nested Schema : OrgInfo
Type: object
Show Source
Nested Schema : SupplierInfo
Type: object
Show Source
Nested Schema : TransferFromDetail
Type: object
Show Source
Nested Schema : PeggingDetailList
Type: array
Values that indicate the list of supply and demand pegging for a given fulfillment line.
Show Source
Nested Schema : SourceOrgInfoList
Type: array
Values that represent the attributes of the source organization.
Show Source
Nested Schema : ScheduleFulfillmentLineSetReply
Type: object
Show Source
Nested Schema : ScheduleFulfillmentLineModelReplyList
Type: array
Values that represent the attributes of schedule fulfillment line model response.
Show Source
Nested Schema : ScheduleFulfillmentLineReplyList
Type: array
Values that represent the attributes of schedule fulfillment line response.
Show Source
Back to Top

Examples

This example describes how to schedule sales orders.

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

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",
	"ScheduleFulfillmentLineEntryList": {
		"ScheduleFulfillmentLine": {
			"FulfillmentLineIdentifier": "1",
			"InstanceNumber": "GOP",
			"SalesOrderNumber": "S01",
			"RequestedDateTime": "2020-09-17T17:00:00",
			"Quantity": "20",
			"QuantityUOM": "EA",
			"RequestType": "Order",
			"PromisingType": "Ship",
			"ShipDateTime": "2020-09-17T17:00:00",
			"ArrivalDateTime": "2020-09-17T17:00:00",
			"PartyIdentifier": "Singapore Distribution Center-GOP",
			"PartySiteIdentifier": "Customer Location LG17",
			"RequestedItem": "RI-HV-GOP-Computer",
			"RequestedOrgIdentifier": {
				"OrgIdentifier": "GOP:HVGOPE01"
			}
		}
	}
}

Example 1 Response Body

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

{
	"ScheduleSalesOrdersOutput": {
		"PromisingSystem": "NewGop",
		"PromisingInstance": "GOP",
		"ScheduleFulfillmentLineEntryResultList": [
		{
			"ScheduleFulfillmentLineReplyList": [
			{
				"FulfillmentLineIdentifier": "1",
				"InstanceNumber": "GOP",
				"UpdateDateTime": "2020-09-17T08:49:14.152+0000",
				"ExpectedShipDateTime": "2020-09-17T17:00:00.000+0000",
				"ExpectedArrivalDateTime": "2020-09-17T17:00:00.000+0000",
				"ExpectedCarrier": "",
				"ExpectedService": "",
				"ExpectedMode": "",
				"CarrierCalendar": "",
				"PeggingDetail": {
					"ItemIdentifier": "RI-HV-GOP-Computer",
					"ShippingCalendar": "GOP CAL 2012-30",
					"ReceivingCalendar": "GOP CAL 2012-30",
					"ManufacturingCalendar": "GOP CAL 2012-30",
					"BackToBackFlag": false,
					"AtpDetailList": [
					{
						"Quantity": 20,
						"QuantityUom": "EA",
						"AtpCost": 0,
						"AtpMode": "3",
						"LeadTime": 0,
						"RequiredQuantity": 20,
						"RequiredDateTime": "2020-09-17T23:59:59.000+0000"
					}
					],
					"OrgInfoList": [
					{
						"OrgIdentifier": "GOP:HVGOPE01"
					}
					]
				}
			}
			]
		}
		]
	}
}

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",
    "ReleaseNumber": "1110900",
              "RequestCreationDateTime": "2022-08-22",
              "ScheduleFulfillmentLineEntryList": {
                             "ScheduleFulfillmentLine": {
                                           "FulfillmentLineIdentifier": "12345",
                                           "InstanceNumber": "GPR",
                                           "SalesOrderNumber": "S01",
                                           "RequestedDateTime": "2022-08-22T17:00:00",
                                           "Quantity": "55",
                                           "QuantityUOM": "Ea",
                                           "RequestType": "Order",
                                           "PromisingType": "Ship",
                                           "ShipDateTime": "2022-08-22T17:00:00",
                                           "ArrivalDateTime": "2022-08-22T17:00:00",
                                           "PartyIdentifier": "Computer Service and Rentals",
                                           "PartySiteIdentifier": "1220",
                                           "RequestedItem": "RI-HV-ANALOG-MS2",
                                          "AllocationNodeFirstLevel":"ALL",
      "AllocationNodeSecondLevel":"BLM-South",
      "AllocationNodeThirdLevel":"BLM-South-High Priority",
      "RequestedOrgIdentifier": {
                                                          "OrgIdentifier": "M2"
                                           }
                             }
              }
}

Example 2 Response Body

The following example includes the contents of the response body in JSON format:
{
    "ScheduleSalesOrdersOutput": {
        "PromisingSystem": "HVGOP",
        "PromisingInstance": "GOP",
        "ScheduleFulfillmentLineEntryResultList": [
            {
                "ScheduleFulfillmentLineReplyList": [
                    {
                        "FulfillmentLineIdentifier": "12345",
                        "InstanceNumber": "GPR",
                        "UpdateDateTime": "2022-08-26T11:10:53.322+0000",
                        "ExpectedShipDateTime": "2022-08-22T17:00:00.000+0000",
                        "ExpectedArrivalDateTime": "2022-08-22T17:00:00.000+0000",
                        "ExpectedCarrier": "",
                        "ExpectedService": "",
                        "ExpectedMode": "",
                        "CarrierCalendar": "",
                        "PeggingDetail": {
                            "ItemIdentifier": "RI-HV-ANALOG-MS2",
                            "ShippingCalendar": "APS Calendar",
                            "ReceivingCalendar": "APS Calendar",
                            "ManufacturingCalendar": "APS Calendar",
                            "BackToBackFlag": false,
                            "AtpDetailList": [
                                {
                                    "Quantity": 55,
                                    "QuantityUom": "Ea",
                                    "AtpCost": 0,
                                    "AtpMode": "3",
                                    "LeadTime": 0,
                                    "RequiredQuantity": 55,
                                    "RequiredDateTime": "2022-08-26T23:59:59.000+0000",
                                    "AllocationDetailList": [
                                        {
                                            "AllocationNodeId": "BLM-South-High Priority",
                                            "RedeployedFlag": false,
                                            "ConsumedAllocation": 12,
                                            "AllocationConsumptionWeekStartDate": "2022-08-22T23:59:59.000+0000"
                                        },
                                        {
                                            "AllocationNodeId": "BLM-South",
                                            "RedeployedFlag": false,
                                            "ConsumedAllocation": 23,
                                            "AllocationConsumptionWeekStartDate": "2022-08-22T23:59:59.000+0000"
                                        },
                                        {
                                            "AllocationNodeId": "ALL",
                                            "RedeployedFlag": false,
                                            "ConsumedAllocation": 10,
                                            "AllocationConsumptionWeekStartDate": "2022-08-22T23:59:59.000+0000"
                                        },
                                        {
                                            "AllocationNodeId": "BLM-Low Priority",
                                            "RedeployedFlag": true,
                                            "ConsumedAllocation": 7,
                                            "AllocationConsumptionWeekStartDate": "2022-08-22T23:59:59.000+0000"
                                        },
                                        {
                                            "AllocationNodeId": "BLM-SouthEast",
                                            "RedeployedFlag": true,
                                            "ConsumedAllocation": 3,
                                            "AllocationConsumptionWeekStartDate": "2022-08-22T23:59:59.000+0000"
                                        }
                                    ]
                                }
                            ],
                            "OrgInfoList": [
                                {
                                    "OrgIdentifier": "M2"
                                }
                            ]
                        }
                    }
                ]
            }
        ]
    }
}
Back to Top