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

Cancel sales orders

post

/fscmRestApi/msp/latest/globalOrderPromises/cancelSalesOrders

Cancel 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 : CancelFulfillmentLineEntryList
Type: array
Values that represent the request attributes of cancelSalesOrder request for the request entry.
Show Source
Nested Schema : CancelFulfillmentLineEntry
Type: object
Show Source
Nested Schema : CancelFulfillmentLine
Type: object
Show Source
Nested Schema : CancelFulfillmentLineModel
Type: object
Show Source
Nested Schema : CancelFulfillmentLineSet
Type: object
Show Source
Nested Schema : OrgInfo
Type: object
Show Source
Nested Schema : CancelFulfillmentLineList
Type: array
Values that represent the attributes of cancelSalesOrder request for a particular fulfillment line.
Show Source
Nested Schema : CancelFulfillmentLineList
Type: array
Values that represent the request attributes of the particular fulfillment line for the cancelSalesOrder request.
Show Source
Nested Schema : CancelFulfillmentLineModelList
Type: array
Values that represent the request attributes of the particular fulfillment line model.
Show Source
Back to Top

Response

Supported Media Types

Default Response

Result of processing the request, which includes the expected ship date, expected arrival date, expected ship from warehouse, and expected ship method.
Body ()
Root Schema : CancelSalesOrdersOutput
Type: object
Show Source
Nested Schema : CancelFulfillmentLineEntryReplyList
Type: array
Values that represent the request attributes for the cancelSalesOrder request.
Show Source
Nested Schema : CancelFulfillmentLineEntryReply
Type: object
Show Source
Nested Schema : CancelFulfillmentLineModelReplyList
Type: array
Values that contain the attributes of the cancelFulfillmentLineModel request.
Show Source
Nested Schema : CancelFulfillmentLineReplyList
Type: array
Values that represent the attributes of CancelFulfillmentLine request for a particular fulfillment line.
Show Source
Nested Schema : CancelFulfillmentLineSetReplyList
Type: array
Values that represent the response attributes of cancelFulfillmentLineSet request for the fulfillment line set.
Show Source
Nested Schema : CancelFulfillmentLineModelReply
Type: object
Show Source
Nested Schema : CancelFulfillmentLineReplyList
Type: array
Values that indicate the unique fulfillment line identifier for the root parent configure to order (CTO) model. This attribute is applicable only for configured to order items.
Show Source
Nested Schema : CancelFulfillmentLineReply
Type: object
Show Source
Nested Schema : CancelFulfillmentLineSetReply
Type: object
Show Source
Nested Schema : CancelFulfillmentLineModelReplyList
Type: array
Values that represent the response attributes from the cancelSalesOrder service for a particular model request.
Show Source
Nested Schema : CancelFulfillmentLineReplyList
Type: array
Values that represent the response attributes from the cancelSalesOrder service for a particular fulfillment line request.
Show Source
Back to Top

Examples

These examples describe how to cancel 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/cancelSalesOrders"

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",
	"RequestCreationDate": "2020-09-15",
	"RequestTimeZone": "EST",
	"CancelFulfillmentLineEntryList": {
		"CancelFulfillmentLine": {
			"FulfillmentLineIdentifier": "1",
			"SalesOrderNumber": "SO1"
		}
	}
}

Example 1 Response Body

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

{
	"CancelSalesOrdersOutput": {
		"PromisingSystem": "NewGop",
		"PromisingInstance": "GOP",
		"CancelFulfillmentLineEntryReplyList": [
		{
			"CancelFulfillmentLineReplyList": [
			{
				"FulfillmentLineIdentifier": "1",
				"SalesOrderNumber": "SO1",
				"UpdateDateTime": "2020-09-15T15:19:56.894+0000",
				"ErrorCode": "",
				"ErrorMessage": ""
			}
			]
		}
		]
	}
}

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",
	"RequestCreationDate": "2020-09-15",
	"RequestTimeZone": "EST",
	"CancelFulfillmentLineEntryList": {
		"CancelFulfillmentLine": {
			"FulfillmentLineIdentifier": "1",
			"SalesOrderNumber": "SO1"
		}
	}
}

Example 2 Response Body

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

{
	"CancelSalesOrdersOutput": {
		"PromisingSystem": "NewGop",
		"PromisingInstance": "GOP",
		"CancelFulfillmentLineEntryReplyList": [
		{
			"CancelFulfillmentLineReplyList": [
			{
				"FulfillmentLineIdentifier": "1",
				"SalesOrderNumber": "SO1",
				"UpdateDateTime": "2020-09-15T15:23:36.655+0000",
				"ErrorCode": "",
				"ErrorMessage": ""
			}
			]
		}
		]
	}
}

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",   
	"RequestCreationDate": "2020-09-17",
	"RequestTimeZone": "EST",
	"CancelFulfillmentLineEntryList": [{
		"CancelFulfillmentLine": 
		{
			"FulfillmentLineIdentifier": "1",
			"SalesOrderNumber": "SO1"
		}
		
	},
	{
		"CancelFulfillmentLine": 
		{
			"FulfillmentLineIdentifier": "1.1600333416292.1",
			"SalesOrderNumber": "SO1"
		}
		
	}
	]        
}

Example 3 Response Body

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

{
	"CancelSalesOrdersOutput": {
		"PromisingSystem": "NewGop",
		"PromisingInstance": "GOP",
		"CancelFulfillmentLineEntryReplyList": [
		{
			"CancelFulfillmentLineReplyList": [
			{
				"FulfillmentLineIdentifier": "1",
				"SalesOrderNumber": "SO1",
				"UpdateDateTime": "2020-09-17T09:08:43.642+0000",
				"ErrorCode": "",
				"ErrorMessage": ""
			}
			]
		},
		{
			"CancelFulfillmentLineReplyList": [
			{
				"FulfillmentLineIdentifier": "1.1600333416292.1",
				"SalesOrderNumber": "SO1",
				"UpdateDateTime": "2020-09-17T09:08:43.708+0000",
				"ErrorCode": "",
				"ErrorMessage": ""
			}
			]
		}
		]
	}
}

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",
    "RequestCreationDate": "2022-08-26",
    "RequestTimeZone": "EST",
    "CancelFulfillmentLineEntryList": {
        "CancelFulfillmentLine": {
            "FulfillmentLineIdentifier": "12345",
            "RequestedItem": "RI-HV-ANALOG-MS2",
            "SalesOrderNumber": "SO1"
        }
    }
}

Example 4 Response Body

The following example includes the contents of the response body in JSON format:
{
    "CancelSalesOrdersOutput": {
        "PromisingSystem": "HVGOP",
        "PromisingInstance": "GOP",
        "CancelFulfillmentLineEntryReplyList": [
            {
                "CancelFulfillmentLineReplyList": [
                    {
                        "FulfillmentLineIdentifier": "12345",
                        "SalesOrderNumber": "SO1",
                        "UpdateDateTime": "2022-08-26T11:08:07.228+0000",
                        "ErrorCode": "",
                        "ErrorMessage": ""
                    }
                ]
            }
        ]
    }
}
Back to Top