getReturnRequest
get
/ccadmin/v1/returnRequests/{id}
gives return request details
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the return request.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getReturnRequest_response
Type:
Show Source
object
-
additionalProperties(optional):
object additionalProperties
Additional properties if any returned by the webhook.
-
authorizationNumber(optional):
string
RMA number of Return Request if available otherwise return request id
-
isExchangeRequest(optional):
boolean
Either it is exchange / return request
-
isManuallyAdjusted(optional):
boolean
Manually Adjusted Return Request
-
isSetteled(optional):
boolean
Settled Return Request
-
isSubmitExchangeOrderAllowed(optional):
boolean
Indicates whether submit exchange order allowed or not.It will get populated only in exchange flow.
-
orderInfo(optional):
object orderInfo
Order Information.
-
paymentReversalInfo(optional):
array paymentReversalInfo
Payment Reversal Info for Order.
-
profileInfo(optional):
object profileInfo
Profile Information for the order.
-
promotionAdjustments(optional):
object promotionAdjustments
Total promotions at Return item and Order level
-
quoteInfo(optional):
object quoteInfo
the quote information of the order
-
refundInfo(optional):
object refundInfo
Refund Information at the returnRequest Level.
-
returnItems(optional):
array returnItems
List of returnable Items
-
returnLabel(optional):
string
return label of the return request
-
returnRequestStatus(optional):
string
Status of Return Request
-
state(optional):
object state
state
-
submitExchangeAllowedValidationMessage(optional):
object submitExchangeAllowedValidationMessage
submitExchangeAllowedValidationMessage will come in json response if isSubmitExchangeOrderAllowed property is false
-
trackingNumber(optional):
array trackingNumber
Tracking Number of the return request
Nested Schema : additionalProperties
Type:
object
Additional properties if any returned by the webhook.
Nested Schema : orderInfo
Type:
object
Order Information.
Show Source
-
creationDate(optional):
string
Date on which the Order was created.
-
orderId(optional):
string
Commerce id for this order.
-
priceInfo(optional):
object priceInfo
Price information of the order.
-
priceListGroup(optional):
object priceListGroup
PriceList group of the order.
-
siteId(optional):
string
Site Id on which the Order was placed.
-
submittedDate(optional):
string
Date on which the Order was submitted.
Nested Schema : profileInfo
Type:
object
Profile Information for the order.
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.
-
organization(optional):
array organization
The Organization associated with the B2B customer profile.
Nested Schema : promotionAdjustments
Type:
object
Total promotions at Return item and Order level
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
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.
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 existing appeasements on the same order
-
otherRefund(optional):
number
Other Refund
-
refundDue(optional):
number
Total Amount of the Refund
-
returnFee(optional):
number
ReturnFee
-
secondaryCurrencyAppeasementRefundAdjustment(optional):
number
The secondary currency refund amount adjustment needed for the existing appeasements on the same order. This amount is deducted from the seconday currency refund total.
-
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 : state
Type:
object
state
Show Source
-
displayKey(optional):
string
Key of returned request status.
-
displayName(optional):
string
Translated Value of returned request status.
Nested Schema : submitExchangeAllowedValidationMessage
Type:
object
submitExchangeAllowedValidationMessage will come in json response if isSubmitExchangeOrderAllowed property is false
Show Source
-
description(optional):
object description
contains detailed info
-
errorCode(optional):
string
error code
-
message(optional):
string
message string
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.
-
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 : priceListGroup
Type:
object
PriceList group of the order.
Show Source
-
active(optional):
boolean
Active status of pricelist group.
-
currency(optional):
object currency
Currency of the PriceList group.
-
deleted(optional):
boolean
Pricelist group deleted status.
-
displayName(optional):
string
Display Name.
-
id(optional):
string
Id.
-
listPriceList(optional):
object listPriceList
Price List for list prices
-
locale(optional):
string
Locale.
-
repositoryId(optional):
string
Repository Id.
-
salePriceList(optional):
object salePriceList
Price List for sale prices
-
shippingSurchargePriceList(optional):
object shippingSurchargePriceList
Price List for shipping surcharge prices
Nested Schema : currency
Type:
object
Currency of the PriceList group.
Show Source
-
currencyCode(optional):
string
Currency Code.
-
displayName(optional):
string
Display Name.
-
fractionalDigits(optional):
integer
Fractional Digits.
-
numericCode(optional):
string
Numeric Code.
-
repositoryId(optional):
string
Repository Id.
-
symbol(optional):
string
currency Symbol.
Nested Schema : listPriceList
Type:
object
Price List for list prices
Show Source
-
repositoryId(optional):
string
Repository ID of the list prices
Nested Schema : salePriceList
Type:
object
Price List for sale prices
Show Source
-
repositoryId(optional):
string
Repository ID of the sale prices
Nested Schema : shippingSurchargePriceList
Type:
object
Price List for shipping surcharge prices
Show Source
-
repositoryId(optional):
string
Repository ID of the shipping surcharge prices
Nested Schema : items
Type:
Show Source
object
-
amount(optional):
number
The amount pertaining to the credit card
-
creditCardInfo(optional):
object creditCardInfo
Credit Card Details.
-
creditCardType(optional):
string
The type of the credit card
-
maxRefundAmount(optional):
number
The maximum amount that can be refunded from the card
-
paymentGroupId(optional):
string
Id of the payment group
-
refundType(optional):
string
Type of the refund. For example this can be tokenized credit card
-
reversalMethod(optional):
string
Payment Reversal Method
-
state(optional):
string
The state of the return request
Nested Schema : creditCardInfo
Type:
object
Credit Card Details.
Show Source
-
cardNumber(optional):
string
Credit Card Number
Nested Schema : organization
Type:
array
The Organization associated with the B2B customer profile.
Show Source
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
The id of the organization.
-
name(optional):
string
The name of of the organization.
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 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 : 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 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.
-
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
-
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 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 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
-
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 : childReturnItems_def
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
-
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 : 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
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|
|------------------|------------------|
|200125|Input passed is null.|
|200194|The given Request Id is an exchange request id. Update action not supported.|
|00000000|Return Request Update Failed.|
|200126|Invalid Input Parameter.|
|200195|Original order site id doesn't match current site id|
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