1. REST API for Oracle Commerce Cloud
  2. Tasks
  3. Store
  4. Return Requests

initiateReturn

post

/ccstore/v1/returnRequests/initiate

Initiate Return. It initiates a new return request. Gets list of items from an order for which return request can be created. 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 : initiateReturn_request
Type: object
Show Source
  • Specify the operation to be performed. Related Endpoint Operations - InitiateReturn, CalculateRefundAmounts, CreateReturnRequest
  • Commerce id of order. Related Endpoint Operations - InitiateReturn, CalculateRefundAmounts, CreateReturnRequest
  • returnItems
    List of returnable Items. Related Endpoint Operations - CalculateRefundAmounts, CreateReturnRequest
Example:
{
    "op":"initiateReturn",
    "orderId":"o10400"
}
Nested Schema : returnItems
Type: array
List of returnable Items. Related Endpoint Operations - CalculateRefundAmounts, CreateReturnRequest
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 : initiateReturn_response
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
Additional properties of the return request
Show Source
Nested Schema : orderInfo
Type: object
Order Information. Related Endpoint Operations - InitiateReturn, CalculateRefundAmounts
Show Source
Nested Schema : paymentReversalInfo
Type: array
Payment Reversal Info for Order. Related Endpoint Operations - CalculateRefundAmounts
Show Source
Nested Schema : profileInfo
Type: object
Profile Information for the order. Related Endpoint Operations - InitiateReturn, CalculateRefundAmounts
Show Source
Nested Schema : promotionAdjustments
Type: object
Total promotions at Return item and Order level. Related Endpoint Operations - CalculateRefundAmounts
Show Source
Nested Schema : quoteInfo
Type: object
the quote information of the order. Related Endpoint Operations - InitiateReturn, CalculateRefundAmounts
Show Source
Nested Schema : refundInfo
Type: object
Refund Information at the returnRequest Level. Related Endpoint Operations - CalculateRefundAmounts
Show Source
Nested Schema : returnItems
Type: array
List of returnable Items. Related Endpoint Operations - InitiateReturn, CalculateRefundAmounts
Show Source
Nested Schema : trackingNumber
Type: array
List of tracking numbers for the return request
Show Source
Nested Schema : priceInfo
Type: object
Price information of the order.
Show Source
  • The raw number that represents the price.
  • Indicates the currency of the price. For example, USD indicates that the price is in US dollars.
  • Indicates if tax is included in item price
  • Total Order Discount Ampunt
  • An order can be paid in points and monetary currency. This field represent order value which will be paid in points. It includes items amount, item discount, order discount. Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in custom currency. 2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
  • This field represents the shipping amount, shipping discount and shipping surcharge in monetary Currency. Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in custom currency. 2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
  • The secondary currency shipping surcharge amount.
  • This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. Prerequisites for the value in this Attribute: Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in custom currency. 2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled. 3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency.
  • An order can be paid in points and monetary currency. This field represent order value which will be paid in monetary currency. It includes shipping charges, shipping surcharges, shipping discount and total tax in monetary currency. Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in custom currency. 2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled. 3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency.
  • The shipping cost of the order.
  • The subtotal of the order before applying order-level promotions.
  • The tax on the order.
  • The current working total, including all promotions, tax, and billing costs.
  • The total cost without Tax.
Nested Schema : priceListGroup
Type: object
PriceList group of the order.
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Detailed information of the recurring charges at the shipping groups level
Show Source
Nested Schema : currency
Type: object
Currency of the PriceList group.
Show Source
Nested Schema : listPriceList
Type: object
Price List for list prices
Show Source
Nested Schema : salePriceList
Type: object
Price List for sale prices
Show Source
Nested Schema : shippingSurchargePriceList
Type: object
Price List for shipping surcharge prices
Show Source
Nested Schema : subTotalByFrequency
Type: array
subtotal of the item by frequency
Show Source
Nested Schema : taxByFrequency
Type: array
tax by frequency
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : creditCardInfo
Type: object
Credit Card Details.
Show Source
Nested Schema : organization
Type: object
The Organization associated with the B2B customer profile.
Show Source
Nested Schema : itemPromotionValueAdjustments
Type: object
Item level promotion adjustments
Show Source
Nested Schema : nonReturnItemCostAdjustment
Type: object
The cost adjustment for item which are not returned.
Show Source
Nested Schema : orderPromotionValueAdjustments
Type: object
Order Level promotion adjustments
Show Source
Nested Schema : errorInfo
Type: array
the array of errors, if any
Show Source
Nested Schema : notes
Type: array
the notes (history) for the order
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : refundDueMap
Type: object
Additional Properties Allowed
Show Source
  • refund due amount in respective currency
A hashmap with currency code as a key and the refund due amount as the value.Map will be returned in response if payment is done with multiple currencies
Nested Schema : items
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
Additional properties of the return item
Show Source
Nested Schema : childItems
Type: array
Returned Item child items
Show Source
Nested Schema : dynamicProperties
Type: array
Array of custom properties at order line item level.
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : shippingGroup
Type: object
Shipping group details
Show Source
  • The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
  • The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).
  • The first name of the person picking up the items in store (if type is inStorePickupShippingGroup).
  • The last name of the person picking up the items in store (if type is inStorePickupShippingGroup).
  • The middle name of the person picking up the items in store (if type is inStorePickupShippingGroup).
  • The phone number of the person picking up the items in store (if type is inStorePickupShippingGroup).
  • The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
  • shippingAddress
    shipping address for the order.
  • shippingMethod
    Shipping method information.
  • store
    Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)
  • The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup
Nested Schema : skuOptionInfo
Type: array
Product Variant Information.
Show Source
Nested Schema : skuProperties
Type: array
Sku properties Information
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
Returned Item child items
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : selectedOptions
Type: array
Child Product Variant Information.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : selectedOptions
Type: array
Child Product Variant Information.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : shippingAddress
Type: object
shipping address for the order.
Show Source
Nested Schema : shippingMethod
Type: object
Shipping method information.
Show Source
Nested Schema : store
Type: object
Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "returnLabel":"r1234",
    "returnItems":[
        {
            "quantityReturned":0,
            "deactivationDate":null,
            "nonreturnable":false,
            "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"
                }
            ],
            "externalData":[
            ],
            "childItems":[
                {
                    "serviceAccountId":"serviceAcc-123",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "quantity":2,
                    "productId":"prod10040",
                    "displayName":"Super Smash Brothers Brawl",
                    "externalData":[
                    ],
                    "parentAssetKey":"12345",
                    "billingProfileId":"billingProfile-123",
                    "billingAccountId":"billingAcc-123",
                    "rootAssetKey":"12345",
                    "transactionDate":"2018-06-27T12:59:59Z",
                    "catRefId":"sku10041",
                    "assetKey":"23456",
                    "route":"product/prod10040",
                    "customerAccountId":"customerAcc-123",
                    "selectedOptions":[
                    ],
                    "actionCode":"Add",
                    "activationDate":"2017-06-27T15:30:00Z",
                    "serviceId":"service-123",
                    "asset":false
                },
                {
                    "serviceAccountId":"serviceAcc-123",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "quantity":1,
                    "productId":"prod10038",
                    "displayName":"Wii Music",
                    "externalData":[
                    ],
                    "parentAssetKey":"12345",
                    "billingProfileId":"billingProfile-123",
                    "billingAccountId":"billingAcc-123",
                    "rootAssetKey":"12345",
                    "transactionDate":"2018-06-27T12:59:59Z",
                    "catRefId":"sku10042",
                    "assetKey":"34567",
                    "route":"product/prod10038",
                    "customerAccountId":"customerAcc-123",
                    "selectedOptions":[
                    ],
                    "actionCode":"Add",
                    "activationDate":"2017-06-27T15:30:00Z",
                    "serviceId":"service-123",
                    "asset":false
                }
            ],
            "configuratorId":"12345677",
            "skuOptionInfo":[
            ],
            "assetKey":"12345",
            "quantityAvailableForReturn":3,
            "commerceItemId":"ci9000467",
            "price":29.97,
            "actionCode":"Add",
            "nonReturnableReason":"Item is non returnable",
            "serviceAccountId":null,
            "unitPrice":9.99,
            "shippingGroup":{
                "shippingMethod":{
                    "shippingMethod":"standardShippingMethod",
                    "shippingMethodDescription":"Standard"
                },
                "shippingGroupId":"sg40411",
                "shippingAddress":{
                    "lastName":"Spencers",
                    "country":"US",
                    "address3":null,
                    "address2":null,
                    "city":"Montgomery",
                    "prefix":null,
                    "address1":"600 Dexter Avenue",
                    "postalCode":"36130",
                    "companyName":null,
                    "jobTitle":null,
                    "county":null,
                    "suffix":null,
                    "firstName":"Mark",
                    "phoneNumber":"973-974-1234",
                    "faxNumber":null,
                    "alias":null,
                    "middleName":null,
                    "state":"AL",
                    "email":"mspens@example.com"
                }
            },
            "comments":null,
            "productId":"prod10035",
            "detailedItemPriceInfo":[
                {
                    "discounted":false,
                    "secondaryCurrencyTaxAmount":0,
                    "amount":9.99,
                    "quantity":1,
                    "tax":1.29,
                    "orderDiscountShare":0,
                    "detailedUnitPrice":9.99,
                    "currencyCode":"USD"
                }
            ],
            "parentAssetKey":null,
            "rootAssetKey":null,
            "transactionDate":"2018-06-27T12:59:59Z",
            "catRefId":"sku10037",
            "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,
            "additionalProperties":{
                "key1":"value1",
                "key2":"value2"
            }
        }
    ],
    "authorizationNumber":"a1234",
    "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,
            "shippingSurchargeValue":0,
            "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://example.com/ccstoreui/v1/returnRequests/initiate"
        }
    ],
    "additionalProperties":{
        "key1":"value1",
        "key2":"value2"
    },
    "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"
    },
    "trackingNumber":[
        "t12344",
        "t12345"
    ]
}

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