removeOrderAmendment
delete
/ccagent/v1/orderAmendments/{orderId}
Remove Order Amendment. Discards the order amendment process by removing the clone order.Additonally takes x-ccsite header to submit the edited order in a site. If the site information is not provided takes the order site. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value.
Request
Supported Media Types
- application/json
Path Parameters
-
orderId: string
Commerce id of the order.
Header Parameters
-
X-CCOrganization(optional): string
The organization Id to which the order belongs
-
x-ccsite(optional): string
the site id in which the orders is placed
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : removeOrderAmendment_response
Type:
Show Source
object
-
cancelAmendSuccess(optional):
boolean
Indicates whether the amend operation has been cancelled successfully..
-
orderId(optional):
string
Commerce id for this order.
Example Response (application/json)
{
"orderId":"o30413",
"cancelAmendSuccess":true,
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccagent/v1/orderAmendments/o30413"
}
]
}
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|100094|Organization passed in the header is currently inactive|
|100095|The order or return request does not belong to the current organization of the shopper profile|
|100096|The organization associated to the order or return request was deleted / does not exist|
|100097|The organization associated to the order or return request is currently inactive|
|100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization|
|100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization|
|200105|Order id passed is null or empty|
|20107|Specified order does not exist|
|200114|Internal error occurred|
|200120|No edit in progress to cancel|
|30015|SiteId passed in x-ccsite header is currently inactive|
|30014|SiteId passed in x-ccsite header is invalid or the site was deleted|
|30020|The Site to which the order belongs was deleted|
|30021|The Site to which the order belongs is currently inactive|
|100101|The shopper profile does not belong to organization passed in the header|
|30019|SiteId passed in x-ccsite header is not related to the order being worked upon|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code