Cancel one purchase order
/fscmRestApi/resources/11.13.18.05/purchaseOrders/{purchaseOrdersUniqID}/action/cancel
Request
-
purchaseOrdersUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Purchase Orders resource and used to uniquely identify an instance of Purchase Orders. The client should not generate the hash key value. Instead, the client should query on the Purchase Orders collection resource in order to navigate to a specific instance of Purchase Orders to get the hash key.
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
- application/vnd.oracle.adf.action+json
object-
acknowledgeWithinDays: number
Number of days the supplier can decide to accept or reject the purchase order cancellation.
-
BCCEmail: string
Email address to which a copy of the purchase order cancellation email is sent without letting other recipients know.
-
cancellationReason: string
Text that describes the reason or purpose of the purchase order cancellation.
-
cancelUnfulfilledDemandFlag: boolean
Contains one of the following values: True or False. If True, then cancel all the associated requisitions while canceling an order. If False, then don't cancel the associated requisitions while canceling an order. This attribute doesn't have a default value.
-
CCEmail: string
Email address to which a copy of the purchase order cancellation email is sent.
-
communicationMethod: string
Method by which the purchase order cancellation is communicated to the supplier, such as email or fax.
-
email: string
Email address of the supplier to whom the purchase order cancellation is communicated.
-
fax: string
Fax number used to communicate the purchase order cancellation to the supplier.
-
initiatingParty: string
Name of the party that requested the cancellation of the change order. Valid values are buyer, requester, and supplier.
-
requiredAcknowledgment: string
Acknowledgment that the application requires from the supplier to cancel a purchase order. Valid values are Document and Schedule, Document and None.
Response
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
object-
result(required): string
If the request is successful, then this action returns Success.
Examples
This example describes how to cancel a purchase order.
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/vnd.oracle.adf.action+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/purchaseOrders/purchaseOrdersUniqID"
Example 1 Request Body
The following example includes the contents of the request body in JSON format. In this example, a purchase order is canceled successfully. 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.
{
"name": "cancel",
"parameters": [
{
"cancellationReason": "No longer required"
},
{
"initiatingParty": "buyer"
}
]
}
Example 1 Response Body
The following example includes the contents of the response body in JSON format:
{
"result": "SUCCESS"
}
Example 2 Request Body
The following example includes the contents of the request body in JSON format. In this example, a purchase order is canceled successfully and reinstated the unfulfilled demand. 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.
{
"name": "cancel",
"parameters": [
{
"cancellationReason": "Cancel a purchase order"
},
{
"initiatingParty": "buyer"
},
{
"cancelUnfulfilledDemandFlag": "false"
}
]
}
Example 2 Response Body
The following example includes the contents of the response body in JSON format:
{
"result": "SUCCESS"
}
Example 3 Request Body
The following example includes the contents of the request body in JSON format. In this example, a purchase order is canceled successfully, and the purchase order cancelation is communicated to supplier by email. If you previously opted in to the Communicate Purchase Orders to Secondary Recipients Using Cc and Bcc feature, then you can choose to communicate the purchase order cancelation to additional supplier contacts and internal stakeholders by sending them carbon copies and blind carbon copies. 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.
{
"name": "cancel",
"parameters": [
{
"cancellationReason": "Duplicate order"
},
{
"initiatingParty": "buyer"
},
{
"communicationMethod": "E-mail"
},
{
"email": "TallManufacturing@example.com"
},
{
"CCEmail": "SmallManufacturing@example.com"
},
{
"BCCEmail": "LongManufacturing@example.com"
}
]
}
Example 3 Response Body
The following example includes the contents of the response body in JSON format:
{
"result": "SUCCESS"
}
Example 4 Request Body
The following example includes the contents of the request body in JSON format. In this example, a purchase order is canceled successfully and requested supplier to acknowledge the purchase order cancellation. 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.
{
"name": "cancel",
"parameters": [
{
"cancellationReason": "Cancel a purchase order"
},
{
"initiatingParty": "buyer"
},
{
"requiredAcknowledgment": "Document"
},
{
"acknowledgeWithinDays": "5"
}
]
}
Example 4 Response Body
The following example includes the contents of the response body in JSON format:
{
"result": "SUCCESS"
}