updateReturnRequest
put
/ccagent/v1/returnRequests/{id}
Update Return Request. It updates the returnRequest based on the operation value. Operation value can be any of receiveReturns/initiateRefund/adjustRefundAmounts/markManualRefund/markAsComplete. Updates details of items received against a return request with operation set as 'receiveReturns'.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
Path Parameters
-
id: string
Return Request Id.
Header Parameters
-
X-CCOrganization(optional): string
The organization Id to which the order belongs
-
x-ccsite(optional): string
the site id on which the orders is laced
Root Schema : updateReturnRequest_request
Type:
Show Source
object
-
adjustedShippingRefund(optional):
number
Adjusted Shipping refund amount. Related Endpoint Operations - AdjustRefundAmounts
-
adjustedTaxRefund(optional):
number
Adjusted item refund amount. Related Endpoint Operations - AdjustRefundAmounts
-
appeasementRefundAdjustment(optional):
number
The refund amount adjustment needed for the completed appeasement refunds on the same order
-
authorizationNumber(optional):
string
A Return Merchandise Authorization number of the return Request. Related Endpoint Operations - ReceiveReturns
-
comment(optional):
string
Comments at returnRequest level. Related Endpoint Operations - AdjustRefundAmounts, MarkAsComplete
-
op:
string
Specify the operation to be performed. Related Endpoint Operations - ReceiveReturns, InitiateRefund, AdjustRefundAmounts, MarkManualRefund, MarkAsComplete
-
otherRefund(optional):
number
Adjusted Other refund amount. Related Endpoint Operations - AdjustRefundAmounts
-
returnFee(optional):
number
Adjusted return fee amount. Related Endpoint Operations - AdjustRefundAmounts
-
returnItems:
array returnItems
List of returnable Items. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts
-
returnLabel(optional):
string
Return label of the return Request. Related Endpoint Operations - ReceiveReturns
-
returnRequestId(optional):
string
Id of the return Request. Related Endpoint Operations - InitiateRefund
-
secondaryCurrencyAppeasementRefundAdjustment(optional):
number
The refund amount adjustment needed for the completed appeasement refunds on the same order for evaluating seconday currency refund total.
-
trackingNumber(optional):
string
Tracking number of the return request. Related Endpoint Operations - ReceiveReturns
-
validateState(optional):
boolean
If the flag is true, it is expected that the return request that is to be marked for Manual Refund is currently in the state of Pending Refund, else an exception is thrown. If this flag is false then there is no validation made on the current state of the return request that is to be marked for Manual Refund.
Example:
{
"op":"receiveReturns",
"returnItems":[
{
"returnItemId":"100003",
"dispositionReason":"acceptedWithRefund",
"quantityReceived":1
}
]
}
Nested Schema : returnItems
Type:
array
List of returnable Items. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts
Show Source
Nested Schema : items
Type:
Show Source
object
-
childReturnItems(optional):
array childReturnItems
List of child return Items
-
dispositionReason(optional):
string
Disposition Reason for Return Item
-
quantityReceived(optional):
number
Quantity Received
-
returnItemId(optional):
string
Id of the Return Item.
Nested Schema : childReturnItems_request
Type:
Show Source
object
-
childReturnItems(optional):
array childReturnItems
List of child return Items
-
comments(optional):
string
Return comments
-
dispositionReason(optional):
string
Disposition Reason for Return
-
quantityReceived(optional):
number
Quantity Received
-
returnItemId(optional):
string
Id of the child Return Item.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updateReturnRequest_response
Type:
Show Source
object
-
additionalProperties(optional):
object additionalProperties
Additional properties of the return request
-
isExchangeRequest(optional):
boolean
Either it is exchange / return request. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts, MarkManualRefund
-
isManuallyAdjusted(optional):
boolean
Manually Adjusted Return Request. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts, MarkManualRefund, MarkAsComplete
-
isSetteled(optional):
boolean
Settled Return Request. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts, MarkManualRefund, MarkAsComplete
-
isSubmitExchangeOrderAllowed(optional):
boolean
Indicates whether submit exchange order allowed or not.It will get populated only in exchange flow. Related Endpoint Operations - ReceiveReturns
-
operation(optional):
string
The corresponding operation. Related Endpoint Operations - MarkManualRefund, MarkAsComplete
-
orderInfo(optional):
object orderInfo
Order Information. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts, MarkManualRefund, MarkAsComplete
-
paymentReversalInfo(optional):
object paymentReversalInfo
Payment Reversal Info for Order. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts, MarkManualRefund, MarkAsComplete
-
profileInfo(optional):
object profileInfo
Profile Information for the order. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts
-
promotionAdjustments(optional):
object promotionAdjustments
Total promotions at Return item and Order level. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts, MarkManualRefund, MarkAsComplete
-
quoteInfo(optional):
object quoteInfo
the quote information of the order. Related Endpoint Operations - ReceiveReturns, MarkManualRefund, MarkAsComplete
-
refundInfo(optional):
object refundInfo
Refund Information at the returnRequest Level. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts, MarkManualRefund, MarkAsComplete
-
returnItems(optional):
array returnItems
List of returnable Items. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts, MarkManualRefund, MarkAsComplete
-
returnLabel(optional):
string
Return Label of the return request
-
returnRequestStatus(optional):
string
Status of Return Request. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts, MarkManualRefund, MarkAsComplete
-
state(optional):
string
The corresponding operation. Related Endpoint Operations - MarkManualRefund, MarkAsComplete
-
submitExchangeAllowedValidationMessage(optional):
object submitExchangeAllowedValidationMessage
submitExchangeAllowedValidationMessage will come in json response if isSubmitExchangeOrderAllowed property is false. Related Endpoint Operations - ReceiveReturns
-
trackingNumber(optional):
array trackingNumber
List of tracking numbers for the return request
Nested Schema : additionalProperties
Type:
object
Additional properties of the return request
Show Source
-
property1(optional):
string
Additional Property 1
-
property2(optional):
string
Additional Property 2
Nested Schema : orderInfo
Type:
object
Order Information. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts, MarkManualRefund, MarkAsComplete
Show Source
-
allowAlternateCurrency(optional):
boolean
A site level setting which enables the shopper to split the payment amount in points and monetary currency, irrespective of the order level price list group.
-
creationDate(optional):
string
Date on which the Order was created.
-
orderId(optional):
string
Commerce id for this order.
-
originOfOrder(optional):
string
The source from which order got created.
-
priceInfo(optional):
object priceInfo
Price information of the order.
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Detailed information of the recurring charges at the shipping groups level
-
siteId(optional):
string
Site Id on which the Order was placed.
-
submittedDate(optional):
string
Date on which the Order was submitted.
Nested Schema : paymentReversalInfo
Type:
object
Payment Reversal Info for Order. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts, MarkManualRefund, MarkAsComplete
Show Source
-
creditCardInfo(optional):
object creditCardInfo
Credit Card Details.
-
currencyCode(optional):
string
Currency code
-
reversalMethod(optional):
string
Payment Reversal Method
Nested Schema : profileInfo
Type:
object
Profile Information for the order. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts
Show Source
-
email(optional):
string
Email address of the profile
-
firstName(optional):
string
First name of profile.
-
lastName(optional):
string
Last name of profile.
-
middleName(optional):
string
Middle name of profile.
Nested Schema : promotionAdjustments
Type:
object
Total promotions at Return item and Order level. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts, MarkManualRefund, MarkAsComplete
Show Source
-
itemPromotionValueAdjustments(optional):
object itemPromotionValueAdjustments
Item level promotion adjustments
-
nonReturnItemCostAdjustment(optional):
object nonReturnItemCostAdjustment
The cost adjustment for item which are not returned.
-
orderPromotionValueAdjustments(optional):
object orderPromotionValueAdjustments
Order Level promotion adjustments
-
promotionAdjustmentsCount(optional):
integer
Count of the total number of promotions applied
-
totalOrderDiscountAdjustment(optional):
number
The total change in order level promotion value adjustments due to the return
Nested Schema : quoteInfo
Type:
object
the quote information of the order. Related Endpoint Operations - ReceiveReturns, MarkManualRefund, MarkAsComplete
Show Source
-
errorInfo(optional):
array errorInfo
the array of errors, if any
-
expirationDate(optional):
string
the expiration date of the quoted order, if any
-
externalId(optional):
string
the external id for the quote
-
notes(optional):
array notes
the notes (history) for the order
-
providerNote(optional):
string
the provider note for the quoted order
-
quoteDate(optional):
number
the date the order was quoted in milliseconds
-
rejectionDate(optional):
string
the rejection date for an order whose quote has been rejected by user
-
rejectionNote(optional):
string
the rejection note for an order whose quote has been rejected by user
-
requestDate(optional):
string
the date when the quote was requested in ISO format
Nested Schema : refundInfo
Type:
object
Refund Information at the returnRequest Level. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts, MarkManualRefund, MarkAsComplete
Show Source
-
actualShippingRefund(optional):
number
Actual Shipping Refund at Item level
-
actualTaxRefund(optional):
number
Actual Tax Refund at Item level
-
appeasementRefundAdjustment(optional):
number
The refund amount adjustment needed for the completed appeasement refunds on the same order
-
otherRefund(optional):
number
Other Refund
-
refundDue(optional):
number
Total Amount of the Refund
-
refundDueMap(optional):
object refundDueMap
Additional Properties Allowed: additionalPropertiesA 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
-
returnFee(optional):
number
ReturnFee
-
secondaryCurrencyActualShippingRefund(optional):
number
Actual shipping refund of all Return Items in secondary currency
-
secondaryCurrencyActualShippingSurchargeRefund(optional):
number
Actual shipping surcharge refund of all Return Items in secondary currency
-
secondaryCurrencyActualTaxRefund(optional):
number
Actual tax refund of all Return Items in secondary currency
-
secondaryCurrencyAppeasementRefundAdjustment(optional):
number
The refund amount adjustment needed for the completed appeasement refunds on the same order for evaluating seconday currency refund total.
-
secondaryCurrencySuggestedShippingRefund(optional):
number
Suggested shipping Refund of all Return Items in secondary currency
-
secondaryCurrencySuggestedShippingSurchargeRefund(optional):
number
Suggested shipping surcharge refund of all Return Items in secondary currency
-
secondaryCurrencySuggestedTaxRefund(optional):
number
Suggested tax Refund of all Return Items in secondary currency
-
shippingTaxRefund(optional):
number
Shipping tax Refund of all Return Items
-
suggestedOrderRefund(optional):
number
Refund Amount of all Return Items
-
suggestedShippingRefund(optional):
number
Shipping Refund of all Return Items
-
suggestedTaxRefund(optional):
number
Tax Refund of all Return Items
-
totalRefund(optional):
number
Total sum of all the Refunds
-
unAdjustedRefundSubtotal(optional):
number
Refund SubTotal calculated as summation of unAdjustedRefundAmount for all return Items.
Nested Schema : returnItems
Type:
array
List of returnable Items. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts, MarkManualRefund, MarkAsComplete
Show Source
Nested Schema : submitExchangeAllowedValidationMessage
Type:
object
submitExchangeAllowedValidationMessage will come in json response if isSubmitExchangeOrderAllowed property is false. Related Endpoint Operations - ReceiveReturns
Show Source
-
description(optional):
object description
contains detailed info
-
errorCode(optional):
string
error code
-
message(optional):
string
message string
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
-
amount(optional):
number
The raw number that represents the price.
-
currencyCode(optional):
string
Indicates the currency of the price. For example, USD indicates that the price is in US dollars.
-
isTaxIncluded(optional):
boolean
Indicates if tax is included in item price
-
orderDiscountAmount(optional):
number
Total order Discount Amount.
-
primaryCurrencyTotal(optional):
number
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.
-
secondaryCurrencyShippingAmount(optional):
number
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.
-
secondaryCurrencyShippingSurchargeValue(optional):
number
The secondary currency shipping surcharge amount.
-
secondaryCurrencyTaxAmount(optional):
number
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.
-
secondaryCurrencyTotal(optional):
number
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.
-
shipping(optional):
number
The shipping cost of the order.
-
subTotal(optional):
number
The subtotal of the order before applying order-level promotions.
-
tax(optional):
number
The tax on the order.
-
total(optional):
number
The current working total, including all promotions, tax, and billing costs.
-
totalWithoutTax(optional):
number
The total cost without Tax.
Nested Schema : recurringChargePriceInfo
Type:
object
Detailed information of the recurring charges at the shipping groups level
Show Source
-
amount(optional):
integer
amount
-
currencyCode(optional):
string
Currency code
-
shipping(optional):
integer
shipping charge
-
subtotal(optional):
integer
sub total
-
subTotalByFrequency(optional):
array subTotalByFrequency
subtotal of the item by frequency
-
tax(optional):
integer
total tax
-
taxByFrequency(optional):
array taxByFrequency
tax by frequency
-
total(optional):
integer
total amount
-
totalWithoutTax(optional):
integer
total without tax
Nested Schema : taxByFrequency
Type:
array
tax by frequency
Show Source
-
Array of:
integer
tax for each frequency
Nested Schema : items
Type:
Show Source
object
-
amount(optional):
integer
amount
-
frequency(optional):
string
frequency of the recurring charges
Nested Schema : creditCardInfo
Type:
object
Credit Card Details.
Show Source
-
cardNumber(optional):
string
Credit Card Number
Nested Schema : itemPromotionValueAdjustments
Type:
object
Item level promotion adjustments
Show Source
-
adjustedAmount(optional):
number
Amount adjusted as a result of applied promotion.
-
couponCode(optional):
string
Code of the coupon applied.
-
itemPromotionRefNo(optional):
string
Reference to the Item Level Promotion.
-
promotionAdjustmentType(optional):
string
Type of promotion Adjustment. Possible values are Adjusted / Removed.
-
promotionDesc(optional):
string
Description of promotion
-
promotionId(optional):
string
Id of the promotion
Nested Schema : nonReturnItemCostAdjustment
Type:
object
The cost adjustment for item which are not returned.
Show Source
-
amountAdjustment(optional):
number
Amount adjusted as result of item returned.
-
commerceItemId(optional):
string
Id of the commerce Item.
- manualAdjustmentShareAdjustment(optional): number
- orderDiscountShareAdjustment(optional): number
-
quantityAdjusted(optional):
number
The number of item adjusted.
-
shippingGroupId(optional):
string
Id of the shipping group.
- shippingShareAdjustment(optional): number
- taxShareAdjustment(optional): number
Nested Schema : orderPromotionValueAdjustments
Type:
object
Order Level promotion adjustments
Show Source
-
adjustedAmount(optional):
number
Amount adjusted as a result of applied promotion.
-
couponCode(optional):
string
Code of the coupon applied.
-
itemPromotionRefNo(optional):
string
Reference to the Item Level Promotion.
-
promotionAdjustmentType(optional):
string
Type of promotion Adjustment. Possible values are Adjusted / Removed.
-
promotionDesc(optional):
string
Description of promotion
-
promotionId(optional):
string
Id of the promotion
Nested Schema : items
Type:
Show Source
object
-
profileId(optional):
string
the profile id of the user
-
profileType(optional):
string
the profile type of the user that requested the quote
-
providerNote(optional):
string
the provider note for the quoted order
-
quoteDate(optional):
number
the date the order was quoted in milliseconds
-
rejectionDate(optional):
number
the rejection date for an order whose quote has been rejected by user
-
rejectionNote(optional):
string
the rejection note for an order whose quote has been rejected by user
-
requestDate(optional):
number
the date when the quote was requested in ISO format
-
requesterNote(optional):
string
the requester note
Nested Schema : refundDueMap
Type:
object
Additional Properties Allowed
Show Source
-
number
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:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
actualRefundAmount(optional):
number
Actual Refund Amount at Item level
-
additionalProperties(optional):
object additionalProperties
Additional properties of the return item
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId(optional):
string
Catalog Reference Id
-
childItems(optional):
array childItems
Returned Item child items
-
childReturnItems(optional):
array childReturnItems
List of child return Items
-
comments(optional):
string
Comments at ReturnItem Level
-
commerceItemId(optional):
string
Commerce Id of the returned item
-
configuratorId(optional):
string
Configurator Id of the returned item
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
displayName(optional):
string
Display Name of the Product
-
dispositionReason(optional):
object dispositionReason
Disposition Reason
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
itemPromotionValueAdjustments(optional):
object itemPromotionValueAdjustments
Item level promotion adjustments.
- manualAdjustmentShare(optional): number
-
nonreturnable(optional):
boolean
Indicates whether an item is returnable or not
-
nonReturnableReason(optional):
string
Indicates the reason for non-returnable
- orderDiscountShare(optional): number
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
price(optional):
number
Total price of the item
-
productId(optional):
string
Id of the return Item
-
quantityAvailableForReturn(optional):
number
Quantity Available
-
quantityReceived(optional):
number
Quantity Received
-
quantityReturned(optional):
number
Quantity Returned
-
quantityShipped(optional):
number
Quantity Shipped
-
quantityToReceive(optional):
number
Quantity To Return
-
quantityToReturn(optional):
number
Quantity To Return
-
returnItemId(optional):
string
Id of the return Item
-
returnReason(optional):
string
Reason to return an Item
-
returnRequired(optional):
boolean
Boolean value to determine if the item has to be physically received.
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shippingGroupId(optional):
string
Shipping group Id of the returned item
-
skuOptionInfo(optional):
array skuOptionInfo
Product Variant Information.
-
skuProperties(optional):
array skuProperties
Sku properties Information
-
suggestedRefundAmount(optional):
number
Refund Cost for a returnItem
-
suggestedShippingRefund(optional):
number
Shipping Refund for a returnItem
-
suggestedTaxRefund(optional):
number
Tax Refund for a returnItem
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
-
unAdjustedRefundAmount(optional):
number
Refund Amount of the item excluding orderDiscountShare and ManualAdjustmentShare
-
unitPrice(optional):
number
Unit price of the item
Nested Schema : additionalProperties
Type:
object
Additional properties of the return item
Show Source
-
property1(optional):
string
Additional Property 1
-
property2(optional):
string
Additional Property 2
Nested Schema : dispositionReason
Type:
object
Disposition Reason
Show Source
-
displayKey(optional):
string
Key of the disposition Reason
-
displayName(optional):
string
Name of the disposition Reason
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : itemPromotionValueAdjustments
Type:
object
Item level promotion adjustments.
Show Source
-
adjustedAmount(optional):
number
Amount adjusted as a result of applied promotion.
-
couponCode(optional):
string
Code of the coupon applied.
-
itemPromotionRefNo(optional):
string
Reference to the Item Level Promotion.
-
promotionAdjustmentType(optional):
string
Type of promotion Adjustment. Possible values are Adjusted / Removed.
-
promotionDesc(optional):
string
Description of promotion
-
promotionId(optional):
string
Id of the promotion
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId(optional):
string
Catalog Reference Id of the child Item
-
childItems(optional):
array childItems
Returned Item child items
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
displayName(optional):
string
Product display name of the sub sku commerce item
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId(optional):
string
Product Id of teh
-
quantity(optional):
number
quantity of the child Item
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
route(optional):
string
Product path
-
selectedOptions(optional):
array selectedOptions
Child Product Variant Information.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId(optional):
string
Catalog Reference Id of the child Item
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
displayName(optional):
string
Product display name of the sub sku commerce item
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId(optional):
string
Product Id of teh
-
quantity(optional):
number
quantity of the child Item
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
route(optional):
string
Product path
-
selectedOptions(optional):
array selectedOptions
Child Product Variant Information.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(optional):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
Name of the Dynamic attribute.
-
optionValue(optional):
string
Value of the Dynamic attribute.
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(optional):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
Name of the Dynamic attribute.
-
optionValue(optional):
string
Value of the Dynamic attribute.
Nested Schema : childReturnItems_response
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
actualRefundAmount(optional):
number
Actual Refund Amount at Item level
-
additionalProperties(optional):
object additionalProperties
Additional Properties if any returned by webhook.
-
adjustedPromotionReferences(optional):
string
Reference to the Promotions linked to this returnItem
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetId(optional):
string
The asset ID corresponding to the current item.
-
assetKey(optional):
string
The assetKey ID associated to the current item.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId(optional):
string
Catalog Reference Id
-
childReturnItems(optional):
array childReturnItems
List of child return Items
-
comments(optional):
string
Comments at ReturnItem Level
-
commerceItemId(optional):
string
Commerce Id of the returned item
-
configuratorId(optional):
string
Configurator Id of the returned item
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
displayName(optional):
string
Display Name of the Product
-
dispositionReason(optional):
object dispositionReason
Disposition Reason
-
dynamicProperties(optional):
array dynamicProperties
Array of custom properties at order line item level.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
itemPromotionValueAdjustments(optional):
object itemPromotionValueAdjustments
Item level promotion adjustments.
- manualAdjustmentShare(optional): number
-
nonreturnable(optional):
boolean
Indicates whether the item is returnable or not
-
nonReturnableReason(optional):
string
Non returnable reason if item is non returnable
- orderDiscountShare(optional): number
-
parentAssetKey(optional):
string
The parentAssetKey ID associated to the current item.
-
price(optional):
number
Total price of the item
-
productId(optional):
string
Id of the return Item
-
quantityAvailableForReturn(optional):
number
Quantity Available
-
quantityReceived(optional):
number
Quantity Received
-
quantityReturned(optional):
number
Quantity Returned
-
quantityShipped(optional):
number
Quantity Shipped
-
quantityToReceive(optional):
number
Quantity To Return
-
quantityToReturn(optional):
number
Quantity To Return
-
returnItemId(optional):
string
Id of the return Item
-
returnReason(optional):
string
Reason to return an Item
-
returnRequired(optional):
boolean
Boolean value to determine if the item has to be physically received.
-
rootAssetKey(optional):
string
The rootAssetKey ID associated to the current item.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shippingGroupId(optional):
string
Shipping group Id of the returned item
-
skuOptionInfo(optional):
array skuOptionInfo
Product Variant Information.
-
skuProperties(optional):
array skuProperties
Sku properties Information
-
suggestedRefundAmount(optional):
number
Refund Cost for a returnItem
-
suggestedShippingRefund(optional):
number
Shipping Refund for a returnItem
-
suggestedTaxRefund(optional):
number
Tax Refund for a returnItem
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
-
unAdjustedRefundAmount(optional):
number
Refund Amount of the item excluding orderDiscountShare and ManualAdjustmentShare
-
unitPrice(optional):
number
Unit price of the item
Nested Schema : additionalProperties
Type:
object
Additional Properties if any returned by webhook.
Nested Schema : dispositionReason
Type:
object
Disposition Reason
Show Source
-
displayKey(optional):
string
Key of the disposition Reason
-
displayName(optional):
string
Name of the disposition Reason
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 : itemPromotionValueAdjustments
Type:
object
Item level promotion adjustments.
Show Source
-
adjustedAmount(optional):
number
Amount adjusted as a result of applied promotion.
-
couponCode(optional):
string
Code of the coupon applied.
-
itemPromotionRefNo(optional):
string
Reference to the Item Level Promotion.
-
promotionAdjustmentType(optional):
string
Type of promotion Adjustment. Possible values are Adjusted / Removed.
-
promotionDesc(optional):
string
Description of promotion
-
promotionId(optional):
string
Id of the promotion
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
The ID of the dynamic property.
-
label(optional):
string
The label of the dynamic property.
-
value(optional):
string
The value of the dynamic property.
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(optional):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
Name of the Dynamic attribute
-
optionValue(optional):
string
Value of the Dynamic attribute
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
ID of the Dynamic SKU Property.
-
name(optional):
string
Name of the Dynamic SKU Property.
-
propertyType(optional):
string
Type that indicates whether it is a base or a custom SKU property,
-
value(optional):
string
Value of the Dynamic SKU Property.
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(optional):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
Name of the Dynamic attribute
-
optionValue(optional):
string
Value of the Dynamic attribute
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
ID of the Dynamic SKU Property.
-
name(optional):
string
Name of the Dynamic SKU Property.
-
propertyType(optional):
string
Type that indicates whether it is a base or a custom SKU property,
-
value(optional):
string
Value of the Dynamic SKU Property.
Nested Schema : description
Type:
object
contains detailed info
Show Source
-
productIds(optional):
array productIds
list of product id's
-
skuIds(optional):
array skuIds
list of sku id's
Example Response (application/json)
{
"returnRequestStatus":"Full return",
"isExchangeRequest":false,
"returnItems":[
{
"quantityReturned":1,
"deactivationDate":"2018-06-27T12:59:59Z",
"dynamicProperties":[
{
"id":"ReferralCode",
"label":"ReferralCode",
"value":null
},
{
"id":"OfferEndsDate",
"label":"OfferEndsDate",
"value":"2020-07-02T03:42:42.962Z"
},
{
"id":"Discount",
"label":"Discount",
"value":0
},
{
"id":"GiftWrapping",
"label":"Gift Wrapping",
"value":false
},
{
"id":"CustomMessage",
"label":"Custom Message",
"value":null
},
{
"id":"name",
"label":"Name on product(Mug)",
"value":"My name"
},
{
"id":"ShippingInstructions",
"label":"Shipping Instructions",
"value":null
}
],
"displayName":"OM-D E-M10 Digital Compact System Camera",
"externalData":[
],
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"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",
"childItems":[
{
"serviceAccountId":"serviceAcc-123",
"deactivationDate":"2018-06-27T12:59:59Z",
"quantity":1,
"productId":"prod10039",
"displayName":"Wii Music",
"externalData":[
],
"parentAssetKey":"23456",
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"rootAssetKey":"12345",
"transactionDate":"2018-06-27T12:59:59Z",
"catRefId":"sku10049",
"assetKey":"34567",
"route":"product/prod10039",
"customerAccountId":"customerAcc-123",
"selectedOptions":[
],
"actionCode":"Add",
"activationDate":"2017-06-27T15:30:00Z",
"serviceId":"service-123",
"asset":false
}
],
"rootAssetKey":"12345",
"transactionDate":"2018-06-27T12:59:59Z",
"catRefId":"sku10041",
"assetKey":"84848",
"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":"93754",
"route":"product/prod10038",
"customerAccountId":"customerAcc-123",
"selectedOptions":[
],
"actionCode":"Add",
"activationDate":"2017-06-27T15:30:00Z",
"serviceId":"service-123",
"asset":false
}
],
"configuratorId":"12345677",
"skuOptionInfo":[
{
"optionValue":"Tan",
"optionName":"color"
},
{
"optionValue":"30.8-megapixels",
"optionName":"resolution"
}
],
"assetKey":"12345",
"quantityAvailableForReturn":0,
"commerceItemId":"ci9000467",
"suggestedShippingRefund":35,
"price":200,
"returnReason":"Incorrect Item",
"actionCode":"Add",
"promotionAdjustments":[
],
"serviceId":"service-123",
"quantityReceived":1,
"dispositionReason":{
"displayKey":"acceptedWithRefund",
"displayName":"Accepted With Refund"
},
"serviceAccountId":"serviceAcc-123",
"unitPrice":200,
"quantityToReturn":1,
"comments":null,
"productId":"camera_1",
"returnItemId":"100003",
"quantityToReceive":0,
"shippingGroupId":"sg80417",
"suggestedTaxRefund":23.31,
"parentAssetKey":null,
"rootAssetKey":null,
"transactionDate":"2018-06-27T12:59:59Z",
"catRefId":"camerasku_1_5",
"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"
}
],
"customerAccountId":"customerAcc-123",
"quantityShipped":1,
"adjustedPromotionReferences":"",
"additionalProperties":{
"property2":"tag",
"property":"display"
},
"activationDate":"2017-06-27T15:30:00Z",
"asset":false,
"actualRefundAmount":200,
"suggestedRefundAmount":200
}
],
"returnLabel":"return label 1",
"isManuallyAdjusted":false,
"orderInfo":{
"originOfOrder":"contactCenter",
"priceInfo":{
"total":256.31,
"amount":198,
"shipping":35,
"isTaxIncluded":false,
"tax":23.31,
"subTotal":200,
"orderDiscountAmount":2,
"currencyCode":"USD",
"totalWithoutTax":189.9
},
"recurringChargePriceInfo":{
"amount":20,
"total":20,
"shipping":0,
"subTotalByFrequency":[
{
"amount":20,
"frequency":"Monthly"
}
],
"taxByFrequency":[
{
"amount":0,
"frequency":"Monthly"
}
],
"tax":0,
"subTotal":20,
"currencyCode":"USD",
"totalWithoutTax":20
},
"orderId":"o10423",
"siteId":"siteUS",
"creationDate":"2015-03-27 15:53:01.0",
"submittedDate":"2015-03-27 15:54:01.0"
},
"refundInfo":{
"refundDue":256.31,
"suggestedShippingRefund":35,
"returnFee":0,
"suggestedOrderRefund":200,
"suggestedTaxRefund":23.31,
"suggestedTotalRefund":256.31,
"appeasementRefundAdjustment":0,
"actualShippingRefund":35,
"actualTaxRefund":23.31,
"otherRefund":0,
"secondaryCurrencyAppeasementRefundAdjustment":0
},
"isSetteled":false,
"promotionAdjustments":{
"promotionAdjustmentsCount":1,
"orderPromotionValueAdjustments":[
{
"adjustedAmount":2,
"promotionAdjustmentType":"Removed",
"promotionDesc":"Order Discount - SAVE$2ON20 - Coupon",
"couponCode":"SAVE2ON20",
"promotionId":"explicitOrderDiscount2on20"
}
],
"totalOrderDiscountAdjustment":2,
"nonReturnItemCostAdjustment":[
],
"itemPromotionValueAdjustments":[
],
"manyToManyPromotionCouponAdjustment":{
"SAVE2ON20":[
{
"adjustedAmount":2,
"promotionAdjustmentType":"Removed",
"promotionDesc":"Order Discount - SAVE$2ON20 - Coupon",
"promotionId":"explicitOrderDiscount2on20"
}
]
}
},
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccagentui/v1/returnRequests/100003"
}
],
"additionalProperties":{
"property2":"tag",
"property":"display"
},
"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":[
"http://localhost:9080/trackingNumber",
"http://localhost:9080/trackingNumber2"
],
"paymentReversalInfo":{
"creditCardInfo":{
"cardNumber":"xxxxxxxxxxxx1111"
},
"reversalMethod":"Card Payment Reversal"
}
}
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|
|200127|Internal error occurred.|
|200218|{0} is an invalid reason.|
|200126|Invalid Input Parameter.|
|200125|Input passed in is null.|
|200131|Return Request Id passed in is null.|
|200132|Return Request is not in pending refund state.|
|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|
|200145|Refund amount cannot exceed payment group's amount.(Payment Group Type: {0}, Payment Group Id: {1})|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code