1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Agent
  4. Return Order

initiateReturn

post

/ccagent/v1/returnRequests

Initiate Return. It creates the return request based on the operation value. Operation value can be any of initiateReturn/calculateRefundAmounts/createReturnRequest. Gets list of items from an order for which return request can be created with operation set as 'initiateReturn'.Additonally takes x-ccsite header. If the site information is not provided by default it 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
Header Parameters
X-CCOrganization
Type: string
The organization Id to which the order belongs
x-ccsite
Type: string
the site id on which the orders is laced
Body Parameter
Root Schema : initiateReturn_request

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : initiateReturn_response
Nested Schema : orderInfo
Type: object
Order Information.
Nested Schema : profileInfo
Type: object
Profile Information for the order.
Nested Schema : quoteInfo
Type: object
The quote information of the order.
Nested Schema : returnItems
Type: array
List of returnable Items.
Nested Schema : priceInfo
Type: object
Price information of the order.
Nested Schema : priceListGroup
Type: object
PriceList group of the order.
Nested Schema : currency
Type: object
Currency of the PriceList group.
Nested Schema : listPriceList
Type: object
Price List for list prices
Nested Schema : salePriceList
Type: object
Price List for sale prices
Nested Schema : shippingSurchargePriceList
Type: object
Price List for shipping surcharge prices
Nested Schema : organization
Type: object
The Organization associated with the B2B customer profile.
Nested Schema : errorInfo
Type: array
the array of errors, if any
Nested Schema : notes
Type: array
the notes (history) for the order
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : childItems
Type: array
Returned Item child items
Nested Schema : dynamicProperties
Type: array
Array of custom properties at order line item level.
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Nested Schema : skuOptionInfo
Type: array
Product Variant Information.
Nested Schema : skuProperties
Type: array
Sku properties Information
Nested Schema : items
Type: object
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Nested Schema : selectedOptions
Type: array
Child Product Variant Information.
Nested Schema : items
Type: object
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Example application/json

{
    "returnItems":[
        {
            "quantityReturned":0,
            "unitPrice":9.99,
            "comments":null,
            "productId":"prod10035",
            "displayName":"Fifa 2010",
            "dynamicProperties":[
                {
                    "id":"ReferralCode",
                    "label":"ReferralCode",
                    "value":null
                },
                {
                    "id":"OfferEndsDate",
                    "label":"OfferEndsDate",
                    "value":"2020-07-02T03:42:42.962Z"
                },
                {
                    "id":"Discount",
                    "label":"Discount",
                    "value":10
                },
                {
                    "id":"GiftWrapping",
                    "label":"Gift Wrapping",
                    "value":false
                },
                {
                    "id":"name",
                    "label":"Name on product(Mug)",
                    "value":"My name"
                }
            ],
            "shippingGroupId":"sg80417",
            "externalData":[
            ],
            "childItems":[
                {
                    "serviceAccountId":"serviceAcc-123",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "quantity":2,
                    "productId":"prod10040",
                    "displayName":"Super Smash Brothers Brawl",
                    "externalData":[
                    ],
                    "billingAccountId":"billingAcc-123",
                    "childItems":[
                        {
                            "serviceAccountId":"serviceAcc-123",
                            "deactivationDate":"2018-06-27T12:59:59Z",
                            "quantity":1,
                            "productId":"prod10039",
                            "displayName":"Wii Music I ",
                            "externalData":[
                            ],
                            "billingAccountId":"billingAcc-123",
                            "catRefId":"sku10049",
                            "route":"product/prod10039",
                            "customerAccountId":"customerAcc-123",
                            "assetId":"asset10001",
                            "selectedOptions":[
                            ],
                            "actionCode":"Add",
                            "activationDate":"2017-06-27T15:30:00Z",
                            "serviceId":"service-123"
                        }
                    ],
                    "catRefId":"sku10041",
                    "route":"product/prod10040",
                    "customerAccountId":"customerAcc-123",
                    "assetId":"asset10001",
                    "selectedOptions":[
                    ],
                    "actionCode":"Add",
                    "activationDate":"2017-06-27T15:30:00Z",
                    "serviceId":"service-123"
                },
                {
                    "serviceAccountId":"serviceAcc-123",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "quantity":1,
                    "productId":"prod10038",
                    "displayName":"Wii Music",
                    "externalData":[
                    ],
                    "billingAccountId":"billingAcc-123",
                    "catRefId":"sku10042",
                    "route":"product/prod10038",
                    "customerAccountId":"customerAcc-123",
                    "assetId":"asset10001",
                    "selectedOptions":[
                    ],
                    "actionCode":"Add",
                    "activationDate":"2017-06-27T15:30:00Z",
                    "serviceId":"service-123"
                }
            ],
            "catRefId":"sku10037",
            "configuratorId":"12345677",
            "skuOptionInfo":[
            ],
            "quantityAvailableForReturn":3,
            "commerceItemId":"ci9000467",
            "skuProperties":[
                {
                    "propertyType":"sku-base",
                    "name":"Name",
                    "id":"displayName",
                    "value":null
                },
                {
                    "propertyType":"sku-base",
                    "name":"Id",
                    "id":"id",
                    "value":"camerasku_1_1"
                },
                {
                    "propertyType":"sku-custom",
                    "name":"dynamicskuprop1",
                    "id":"dynamicskuprop1",
                    "value":"dynamicskuprop1"
                }
            ],
            "quantityShipped":3,
            "price":29.97,
            "actionCode":"Add"
        }
    ],
    "profileInfo":{
        "lastName":"Anderson",
        "firstName":"Kim",
        "organization":{
            "name":"Oracle India Pvt Ltd",
            "id":"oracle"
        },
        "middleName":null,
        "email":"kim@example.com"
    },
    "orderInfo":{
        "priceInfo":{
            "total":58.4,
            "amount":29.97,
            "shipping":25,
            "isTaxIncluded":false,
            "tax":3.43,
            "subTotal":29.97,
            "orderDiscountAmount":0,
            "currencyCode":"USD",
            "totalWithoutTax":127.97
        },
        "orderId":"o10400",
        "priceListGroup":{
            "deleted":false,
            "displayName":"UsDollar",
            "repositoryId":"UsDollar",
            "listPriceList":{
                "repositoryId":"listPrices"
            },
            "active":true,
            "salePriceList":{
                "repositoryId":"salePrices"
            },
            "currency":{
                "symbol":"$",
                "displayName":"US Dollar",
                "repositoryId":"hi_US",
                "fractionalDigits":2,
                "currencyCode":"USD",
                "numericCode":"356"
            },
            "id":"UsDollar",
            "locale":"hi_US",
            "shippingSurchargePriceList":{
                "repositoryId":"shippingSurchargePrices"
            }
        },
        "siteId":"siteUS",
        "creationDate":"2014-05-20 16:06:44.0",
        "submittedDate":"2014-05-20 16:07:44.0"
    },
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagentui/v1/returnRequests"
        }
    ],
    "quoteInfo":{
        "providerNote":null,
        "notes":[
            {
                "providerDate":"2016-11-25T13:33:48.000Z",
                "providerNote":"The quote is approved as per the request",
                "profileType":null,
                "profileId":"se-570031"
            },
            {
                "profileType":null,
                "profileId":"se-570031",
                "requestDate":"2016-10-25T13:33:48.000Z",
                "requesterNote":"provide 10 percent off on the total quantity"
            }
        ],
        "rejectionDate":null,
        "requestDate":"2016-10-25T13:33:48.000Z",
        "errorInfo":null,
        "externalID":null,
        "rejectionNote":null,
        "quoteDate":"2016-10-25T13:35:32.000Z",
        "expirationDate":"2026-04-28T18:53:48.000Z"
    }
}
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| |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.|
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Request:

{
  "op": "initiateReturn",
  "orderId": "o10400"
}

Sample Response Payload returned by endpoint:

{
  "returnItems": [{
    "quantityReturned": 0,
    "unitPrice": 9.99,
    "comments": null,
    "productId": "prod10035",
    "displayName": "Fifa 2010",
    "dynamicProperties": [
      {
        "id": "ReferralCode",
        "label": "ReferralCode",
        "value": null
      },
      {
        "id": "OfferEndsDate",
        "label": "OfferEndsDate",
        "value": "2020-07-02T03:42:42.962Z"
      },
      {
        "id": "Discount",
        "label": "Discount",
        "value": 10
      },
      {
        "id": "GiftWrapping",
        "label": "Gift Wrapping",
        "value": false
      },
      {
        "id": "name",
        "label": "Name on product(Mug)",
        "value": "My name"
      }
    ],
    "shippingGroupId": "sg80417",
    "externalData": [],
    "childItems": [
      {
        "serviceAccountId": "serviceAcc-123",
        "deactivationDate": "2018-06-27T12:59:59Z",
        "quantity": 2,
        "productId": "prod10040",
        "displayName": "Super Smash Brothers Brawl",
        "externalData": [],
        "billingAccountId": "billingAcc-123",
        "childItems": [{
          "serviceAccountId": "serviceAcc-123",
          "deactivationDate": "2018-06-27T12:59:59Z",
          "quantity": 1,
          "productId": "prod10039",
          "displayName": "Wii Music I ",
          "externalData": [],
          "billingAccountId": "billingAcc-123",
          "catRefId": "sku10049",
          "route": "product/prod10039",
          "customerAccountId": "customerAcc-123",
          "assetId": "asset10001",
          "selectedOptions": [],
          "actionCode": "Add",
          "activationDate": "2017-06-27T15:30:00Z",
          "serviceId": "service-123"
        }],
        "catRefId": "sku10041",
        "route": "product/prod10040",
        "customerAccountId": "customerAcc-123",
        "assetId": "asset10001",
        "selectedOptions": [],
        "actionCode": "Add",
        "activationDate": "2017-06-27T15:30:00Z",
        "serviceId": "service-123"
      },
      {
        "serviceAccountId": "serviceAcc-123",
        "deactivationDate": "2018-06-27T12:59:59Z",
        "quantity": 1,
        "productId": "prod10038",
        "displayName": "Wii Music",
        "externalData": [],
        "billingAccountId": "billingAcc-123",
        "catRefId": "sku10042",
        "route": "product/prod10038",
        "customerAccountId": "customerAcc-123",
        "assetId": "asset10001",
        "selectedOptions": [],
        "actionCode": "Add",
        "activationDate": "2017-06-27T15:30:00Z",
        "serviceId": "service-123"
      }
    ],
    "catRefId": "sku10037",
    "configuratorId": "12345677",
    "skuOptionInfo": [],
    "quantityAvailableForReturn": 3,
    "commerceItemId": "ci9000467",
    "skuProperties": [
      {
        "propertyType": "sku-base",
        "name": "Name",
        "id": "displayName",
        "value": null
      },
      {
        "propertyType": "sku-base",
        "name": "Id",
        "id": "id",
        "value": "camerasku_1_1"
      },
      {
        "propertyType": "sku-custom",
        "name": "dynamicskuprop1",
        "id": "dynamicskuprop1",
        "value": "dynamicskuprop1"
      }
    ],
    "quantityShipped": 3,
    "price": 29.97,
    "actionCode": "Add"
  }],
  "profileInfo": {
    "lastName": "Anderson",
    "firstName": "Kim",
    "organization": {
      "name": "Oracle India Pvt Ltd",
      "id": "oracle"
    },
    "middleName": null,
    "email": "kim@example.com"
  },
  "orderInfo": {
    "priceInfo": {
      "total": 58.4,
      "amount": 29.97,
      "shipping": 25,
      "isTaxIncluded": false,
      "tax": 3.43,
      "subTotal": 29.97,
      "orderDiscountAmount": 0,
      "currencyCode": "USD",
      "totalWithoutTax": 127.97
    },
    "orderId": "o10400",
    "priceListGroup": {
      "deleted": false,
      "displayName": "UsDollar",
      "repositoryId": "UsDollar",
      "listPriceList": {"repositoryId": "listPrices"},
      "active": true,
      "salePriceList": {"repositoryId": "salePrices"},
      "currency": {
        "symbol": "$",
        "displayName": "US Dollar",
        "repositoryId": "hi_US",
        "fractionalDigits": 2,
        "currencyCode": "USD",
        "numericCode": "356"
      },
      "id": "UsDollar",
      "locale": "hi_US",
      "shippingSurchargePriceList": {"repositoryId": "shippingSurchargePrices"}
    },
    "siteId": "siteUS",
    "creationDate": "2014-05-20 16:06:44.0",
    "submittedDate": "2014-05-20 16:07:44.0"
  },
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccagentui/v1/returnRequests"
  }],
  "quoteInfo": {
    "providerNote": null,
    "notes": [
      {
        "providerDate": "2016-11-25T13:33:48.000Z",
        "providerNote": "The quote is approved as per the request",
        "profileType": null,
        "profileId": "se-570031"
      },
      {
        "profileType": null,
        "profileId": "se-570031",
        "requestDate": "2016-10-25T13:33:48.000Z",
        "requesterNote": "provide 10 percent off on the total quantity"
      }
    ],
    "rejectionDate": null,
    "requestDate": "2016-10-25T13:33:48.000Z",
    "errorInfo": null,
    "externalID": null,
    "rejectionNote": null,
    "quoteDate": "2016-10-25T13:35:32.000Z",
    "expirationDate": "2026-04-28T18:53:48.000Z"
  }
}