Cancel sales orders
/fscmRestApi/msp/latest/globalOrderPromises/cancelSalesOrders
Request
There are no request parameters for this operation.
- application/json
object
-
CallingInstance: string
Value that 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.
-
CancelFulfillmentLineEntryList: array
CancelFulfillmentLineEntryList
Values that represent the request attributes of cancelSalesOrder request for the request entry.
-
RequestCreationDate: string
(date-time)
Date and time when the sales order cancel request was created.
-
RequestTimeZone: string
Time zone in which the sales order cancel request was created.
-
UniqueOrderIdentifier: string
Value that uniquely identifies the sales order cancel request.
array
object
-
FulfillmentLineIdentifier: string
Value that uniquely identifies the fulfillment line
-
InstanceNumber: string
Value that uniquely identifies the source application from which the order promising service request originated.
-
SalesOrderLineNumber: string
Value that identifies the sales order line in the source application for which the fulfillment line is created.
-
SalesOrderNumber: string
Value that identifies the sales order in the source application for which the fulfillment line is created.
-
ShipFromOrg: object
OrgInfo
-
SplitLineIdentifier: string
Value that uniquely identifies the fulfillment line split. A unique number is generated in case of split.
-
UpdateTime: string
(date-time)
Date and time when the fulfillment line cancel request was sent to Oracle Global Order Promising Cloud.
object
-
CancelFulfillmentLineList: array
CancelFulfillmentLineList
Values that represent the attributes of cancelSalesOrder request for a particular fulfillment line.
-
RootParentFulfillIdentifier: string
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.
object
-
CancelFulfillmentLineList: array
CancelFulfillmentLineList
Values that represent the request attributes of the particular fulfillment line for the cancelSalesOrder request.
-
CancelFulfillmentLineModelList: array
CancelFulfillmentLineModelList
Values that represent the request attributes of the particular fulfillment line model.
-
SetIdentifier: string
Value that uniquely identifies the fulfillment line set.
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
array
array
Response
- application/json
Default Response
object
-
CancelDate: string
(date-time)
Date and time when the sales order is canceled in Oracle Global Order Promising Cloud.
-
CancelFulfillmentLineEntryReplyList: array
CancelFulfillmentLineEntryReplyList
Values that represent the request attributes for the cancelSalesOrder request.
-
ErrorCode: string
Abbreviation that identifies the error, if any, returned by Oracle Global Order Promising Cloud for the fulfillment line cancellation request.
-
ErrorMessage: string
Text of the error message, if any, for the cancel sales order request.
-
PromisingInstance: string
Value that uniquely identifies the source application in which order promising request is performed.
-
PromisingSystem: string
Value that identifies the order promising application in which the fulfillment line is canceled.
array
object
-
CancelFulfillmentLineModelReplyList: array
CancelFulfillmentLineModelReplyList
Values that contain the attributes of the cancelFulfillmentLineModel request.
-
CancelFulfillmentLineReplyList: array
CancelFulfillmentLineReplyList
Values that represent the attributes of CancelFulfillmentLine request for a particular fulfillment line.
-
CancelFulfillmentLineSetReplyList: array
CancelFulfillmentLineSetReplyList
Values that represent the response attributes of cancelFulfillmentLineSet request for the fulfillment line set.
array
array
array
object
-
CancelFulfillmentLineReplyList: array
CancelFulfillmentLineReplyList
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.
-
ErrorCode: string
Abbreviation that identifies the error, if any, returned by Oracle Global Order Promising Cloud for the fulfillment line model cancellation request.
-
ErrorMessage: string
Text of the error message, if any, for the error code.
-
RootParentFulfillIdentifier: string
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.
-
UpdateTime: string
(date-time)
Date and time when the fulfillment line model cancel request was canceled in Oracle Global Order Promising Cloud.
array
object
-
ErrorCode: string
Abbreviation that identifies the error, if any, returned by Oracle Global Order Promising Cloud for the fulfillment line cancellation request.
-
ErrorMessage: string
Text of the error message, if any, for the fulfillment line cancellation request.
-
FulfillmentLineIdentifier: string
Value that uniquely identifies the fulfillment line.
-
InstanceNumber: string
Value that identifies the source application from which the order promising service request originated.
-
SalesOrderLineNumber: string
Value that identifies the sales order line in the source application for which the fulfillment line is created.
-
SalesOrderNumber: string
Value that identifies the sales order for which the fulfillment line is created.
-
SplitLineIdentifier: string
Value that uniquely identifies the fulfillment line split.
-
UpdateTime: string
(date-time)
Date and time when the fulfillment line was canceled in Oracle Fusion Global Order Promising.
object
-
CancelFulfillmentLineModelReplyList: array
CancelFulfillmentLineModelReplyList
Values that represent the response attributes from the cancelSalesOrder service for a particular model request.
-
CancelFulfillmentLineReplyList: array
CancelFulfillmentLineReplyList
Values that represent the response attributes from the cancelSalesOrder service for a particular fulfillment line request.
-
ErrorCode: string
Abbreviation that identifies the error, if any, returned by Oracle Global Order Promising Cloud for the service request.
-
ErrorMessage: string
Text of the error message, if any, for the fulfillment line set cancellation request.
-
SetIdentifier: string
Value that identifies the fulfillment line set.
-
UpdateTime: string
(date-time)
Date and time when the fulfillment line set was canceled in Oracle Global Order Promising Cloud.
array
array
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
{ "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
{ "CancelSalesOrdersOutput": { "PromisingSystem": "HVGOP", "PromisingInstance": "GOP", "CancelFulfillmentLineEntryReplyList": [ { "CancelFulfillmentLineReplyList": [ { "FulfillmentLineIdentifier": "12345", "SalesOrderNumber": "SO1", "UpdateDateTime": "2022-08-26T11:08:07.228+0000", "ErrorCode": "", "ErrorMessage": "" } ] } ] } }