1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Agent
  4. Orders

handleOrderActions

post

/ccagent/v1/orders/{id}

Handle Order Actions. It handles the order actions based on Op value. Op value can be any of cancel/validateOrder/validatePaymentAuthorization/validActions/invalidateOrder/sendPlacedOrderEmailNotification. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value. If this header is not provided, then the endPoint will consider first active organization as the current organization for a B2B user.

Request

Supported Media Types
Path Parameters
Header Parameters
Body ()
Root Schema : handleOrderActions_request
Type: object
Show Source
  • Indicates which operation to perform and contains required data to perform operation
Example:
{
    "op":"cancel",
    "cancelReason":"badProductReview"
}
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : handleOrderActions_response
Type: object
Show Source
Example Response (application/json)
{
    "links":[
        {
            "rel":"self",
            "href":"/ccagentui/v1/orders/o10008"
        }
    ],
    "id":"o10008",
    "message":"Order [o10008] has been successfully cancelled."
}

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| |200219|{0} is an inactive reason.| |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| |200218|{0} is an invalid reason.| |200101|Cancel failed as order is in [{0}] state.| |200104|The shipping group commerce item relationship [{0}] is in an invalid [{1}] state.| |200103|The shipping group [{0}] is in a no pending action state.| |30015|SiteId passed in x-ccsite header is currently inactive| |200100|Internal error occurred while processing the request.| |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| |210105|Specified order does not exist.|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top