REST API for Oracle Commerce Cloud December 2017

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: Type: string

Required: true

Commerce id of the order.

Header Parameters

X-CCOrganization: Type: string

The organization Id to which the order belongs
x-ccsite: Type: 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.

Body

Example 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|

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "orderId": "o30413",
  "cancelAmendSuccess": true,
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccagent/v1/orderAmendments/o30413"
  }]
}