createReturnRequest

post

/ccstore/v1/returnRequests

Creates return request and returns the appropriate ID. Persists in DB. Optionally takes the x-ccasset-language headers to get translated content in another language. Also, additionally takes X-CCOrganization and x-ccsite headers.

Request

Supported Media Types
Body ()
Root Schema : createReturnRequest_request
Type: object
Show Source
Example:
{
    "returnItems":[
        {
            "quantityToReturn":1,
            "commerceItemId":"ci8000005",
            "productId":"prod10003",
            "returnReason":"didNotLike",
            "shippingGroupId":"sg80003",
            "catRefId":"sku30019"
        }
    ],
    "orderId":"o80003"
}
Nested Schema : returnItems
Type: array
List of returnable Items.
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : createReturnRequest_response
Type: object
Show Source
Example Response (application/json)
{
    "result":"success",
    "returnRequestId":"700002",
    "links":[
        {
            "rel":"self",
            "href":"http://example.com/ccstoreui/v1/returnRequests"
        }
    ]
}

Default Response

The error response. In case of any failure in external tax or external shipping webhooks, the errors returned in the webhook response payload get added to the errors property in this endpoint???s 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| |200114|Order is not allowed for return.| |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| |210105|Specified order does not exist.| |200196|Item {0} is a part of configuration and therefore cannot be returned separately. Please return the whole configuration package.|
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