getResourceMetadata
get
/ccagent/v1/metadata-catalog/{id}
Get Resource Metadata. Returns the metadata catalog of the resource specified. The response will be in hyper schema format. The **JSON hyper schema** being served is **deprecated**. Use Swagger.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the resource
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getResourceMetadata_response
Type:
Show Source
object-
$schema(optional):
string
location of schema for the given resource
-
definitions(optional):
object definitions
respective properties of the resource
-
description(optional):
string
description of the resource being retrieved
-
title(optional):
string
title of metadata resource
-
token(optional):
string
The auth token for the Endpoint
-
type(optional):
string
type of metadata resource
Nested Schema : definitions
Type:
objectrespective properties of the resource
Example Response (application/json)
{
"$schema":"rest-schemas/",
"description":"Return Order endpoints",
"title":"returnOrder",
"type":"object",
"definitions":{
"updateReturnRequest_request":{
"properties":{
"op":{
"description":"Specify the operation to be performed",
"type":"string"
},
"returnItems":{
"description":"List of returnable Items",
"type":"array",
"items":{
"type":"object",
"properties":{
"returnItemId":{
"description":"Id of the Return Item.",
"type":"string"
},
"dispositionReason":{
"description":"Disposition Reason for Return Item",
"type":"string"
},
"quantityReceived":{
"description":"Quantity Received",
"type":"number"
}
}
}
}
},
"required":[
"op",
"returnItems"
]
},
"getReturnRequest_response":{
"properties":{
"returnRequestStatus":{
"description":"Status of Return Request",
"type":"string"
},
"isExchangeRequest":{
"description":"Either it is exchange / return request",
"type":"boolean"
},
"returnItems":{
"description":"List of returnable Items",
"type":"array",
"items":{
"type":"object",
"properties":{
"quantityReturned":{
"description":"Quantity Returned",
"type":"number"
},
"displayName":{
"description":"Display Name of the Product",
"type":"string"
},
"orderDiscountShare":{
"description":"OrderDiscountShare for a returnItem",
"type":"number"
},
"childItems":{
"description":"Returned Item child items",
"type":"array",
"items":{
"type":"object",
"properties":{
"quantity":{
"description":"quantity of the child Item",
"type":"number"
},
"route":{
"description":"Product path",
"type":"string"
},
"productId":{
"description":"Product Id of teh ",
"type":"string"
},
"displayName":{
"description":"Product display name of the sub sku commerce item",
"type":"string"
},
"selectedOptions":{
"description":"Child Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"type":"string"
}
}
}
},
"catRefId":{
"description":"Catalog Reference Id of the child Item",
"type":"string"
}
}
}
},
"skuOptionInfo":{
"description":"Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute",
"type":"string"
}
}
}
},
"configuratorId":{
"description":"Configurator Id of the returned item",
"type":"string"
},
"quantityAvailableForReturn":{
"description":"Quantity Available",
"type":"number"
},
"commerceItemId":{
"description":"Commerce Id of the returned item",
"type":"string"
},
"suggestedShippingRefund":{
"description":"Shipping Refund for a returnItem",
"type":"number"
},
"unAdjustedRefundAmount":{
"description":"Refund Amount of the item excluding orderDiscountShare and ManualAdjustmentShare",
"type":"number"
},
"price":{
"description":"Total price of the item",
"type":"number"
},
"returnReason":{
"description":"Reason to return an Item",
"type":"string"
},
"quantityReceived":{
"description":"Quantity Received",
"type":"number"
},
"dispositionReason":{
"description":"Disposition Reason",
"type":"object",
"properties":{
"displayKey":{
"description":"Key of the disposition Reason",
"type":"string"
},
"displayName":{
"description":"Name of the disposition Reason",
"type":"string"
}
}
},
"unitPrice":{
"description":"Unit price of the item",
"type":"number"
},
"quantityToReturn":{
"description":"Quantity To Return",
"type":"number"
},
"comments":{
"description":"Comments at ReturnItem Level",
"type":"string"
},
"productId":{
"description":"Id of the return Item",
"type":"string"
},
"returnItemId":{
"description":"Id of the return Item",
"type":"string"
},
"itemPromotionValueAdjustments":{
"description":"Item level promotion adjustments.",
"type":"object",
"properties":{
"itemPromotionRefNo":{
"description":"Reference to the Item Level Promotion.",
"type":"string"
},
"adjustedAmount":{
"description":"Amount adjusted as a result of applied promotion.",
"type":"number"
},
"promotionAdjustmentType":{
"description":"Type of promotion Adjustment. Possible values are Adjusted / Removed.",
"type":"string"
},
"promotionDesc":{
"description":"Description of promotion",
"type":"string"
},
"couponCode":{
"description":"Code of the coupon applied.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion",
"type":"string"
}
}
},
"quantityToReceive":{
"description":"Quantity To Return",
"type":"number"
},
"suggestedTaxRefund":{
"description":"Tax Refund for a returnItem",
"type":"number"
},
"shippingGroupId":{
"description":"Shipping group Id of the returned item",
"type":"string"
},
"manualAdjustmentShare":{
"description":"ManualAdjustmentShare for a returnItem",
"type":"number"
},
"catRefId":{
"description":"Catalog Reference Id",
"type":"string"
},
"quantityShipped":{
"description":"Quantity Shipped",
"type":"number"
},
"adjustedPromotionReferences":{
"description":"Reference to the Promotions linked to this returnItem",
"type":"string"
},
"actualRefundAmount":{
"description":"Actual Refund Amount at Item level",
"type":"number"
},
"suggestedRefundAmount":{
"description":"Refund Cost for a returnItem",
"type":"number"
}
}
}
},
"submitExchangeAllowedValidationMessage":{
"description":"submitExchangeAllowedValidationMessage will come in json response if isSubmitExchangeOrderAllowed property is false",
"type":"object",
"properties":{
"errorCode":{
"description":"error code",
"type":"string"
},
"description":{
"description":"contains detailed info",
"type":"object",
"properties":{
"productIds":{
"description":"list of product id's",
"type":"array",
"items":{
"type":"string"
}
},
"skuIds":{
"description":"list of sku id's",
"type":"array",
"items":{
"type":"string"
}
}
}
},
"message":{
"description":"message string",
"type":"string"
}
}
},
"profileInfo":{
"description":"Profile Information for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name of profile.",
"type":"string"
},
"firstName":{
"description":"First name of profile.",
"type":"string"
},
"organization":{
"description":"The Organization associated with the B2B customer profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"name":{
"description":"The name of of the organization.",
"type":"string"
},
"id":{
"description":"The id of the organization.",
"type":"string"
}
}
}
},
"middleName":{
"description":"Middle name of profile.",
"type":"string"
},
"email":{
"description":"Email address of the profile",
"type":"string"
}
}
},
"isSubmitExchangeOrderAllowed":{
"description":"Indicates whether submit exchange order allowed or not.It will get populated only in exchange flow.",
"type":"boolean"
},
"isManuallyAdjusted":{
"description":"Manually Adjusted Return Request",
"type":"boolean"
},
"orderInfo":{
"description":"Order Information.",
"type":"object",
"properties":{
"priceInfo":{
"description":"Price information of the order.",
"type":"object",
"properties":{
"amount":{
"description":"The raw number that represents the price.",
"type":"number"
},
"total":{
"description":"The current working total, including all promotions, tax, and billing costs.",
"type":"number"
},
"shipping":{
"description":"The shipping cost of the order.",
"type":"number"
},
"isTaxIncluded":{
"description":"Indicates if tax is included in item price",
"type":"boolean"
},
"tax":{
"description":"The tax on the order.",
"type":"number"
},
"subTotal":{
"description":" The subtotal of the order before applying order-level promotions.",
"type":"number"
},
"orderDiscountAmount":{
"description":" Total order Discount Amount.",
"type":"number"
},
"currencyCode":{
"description":"Indicates the currency of the price. For example, USD indicates that the price is in US dollars.",
"type":"string"
},
"totalWithoutTax":{
"description":"The total cost without Tax.",
"type":"number"
}
}
},
"orderId":{
"description":"Commerce id for this order.",
"type":"string"
},
"priceListGroup":{
"description":"PriceList group of the order.",
"type":"object",
"properties":{
"deleted":{
"description":"Pricelist group deleted status.",
"type":"boolean"
},
"displayName":{
"description":"Display Name.",
"type":"string"
},
"repositoryId":{
"description":"Repository Id.",
"type":"string"
},
"listPriceList":{
"description":"Price List for list prices",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository ID of the list prices",
"type":"string"
}
}
},
"active":{
"description":"Active status of pricelist group.",
"type":"boolean"
},
"salePriceList":{
"description":"Price List for sale prices",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository ID of the sale prices",
"type":"string"
}
}
},
"currency":{
"description":"Currency of the PriceList group.",
"type":"object",
"properties":{
"symbol":{
"description":"currency Symbol.",
"type":"string"
},
"displayName":{
"description":"Display Name.",
"type":"string"
},
"repositoryId":{
"description":"Repository Id.",
"type":"string"
},
"fractionalDigits":{
"description":"Fractional Digits.",
"type":"integer"
},
"currencyCode":{
"description":"Currency Code.",
"type":"string"
},
"numericCode":{
"description":"Numeric Code.",
"type":"string"
}
}
},
"id":{
"description":"Id.",
"type":"string"
},
"locale":{
"description":"Locale.",
"type":"string"
},
"shippingSurchargePriceList":{
"description":"Price List for shipping surcharge prices",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository ID of the shipping surcharge prices",
"type":"string"
}
}
}
}
},
"creationDate":{
"description":"Date on which the Order was created.",
"type":"string"
},
"submittedDate":{
"description":"Date on which the Order was submitted.",
"type":"string"
}
}
},
"refundInfo":{
"description":"Refund Information at the returnRequest Level.",
"type":"object",
"properties":{
"suggestedShippingRefund":{
"description":"Shipping Refund of all Return Items",
"type":"number"
},
"refundDue":{
"description":"Total Amount of the Refund",
"type":"number"
},
"returnFee":{
"description":"ReturnFee",
"type":"number"
},
"totalRefund":{
"description":"Total sum of all the Refunds",
"type":"number"
},
"suggestedOrderRefund":{
"description":"Refund Amount of all Return Items",
"type":"number"
},
"suggestedTaxRefund":{
"description":"Tax Refund of all Return Items",
"type":"number"
},
"unAdjustedRefundSubtotal":{
"description":"Refund SubTotal calculated as summation of unAdjustedRefundAmount for all return Items.",
"type":"number"
},
"actualShippingRefund":{
"description":"Actual Shipping Refund at Item level",
"type":"number"
},
"otherRefund":{
"description":"Other Refund",
"type":"number"
},
"actualTaxRefund":{
"description":"Actual Tax Refund at Item level",
"type":"number"
}
}
},
"isSetteled":{
"description":"Settled Return Request",
"type":"boolean"
},
"promotionAdjustments":{
"description":"Total promotions at Return item and Order level",
"type":"object",
"properties":{
"promotionAdjustmentsCount":{
"description":"Count of the total number of promotions applied",
"type":"integer"
},
"orderPromotionValueAdjustments":{
"description":"Order Level promotion adjustments",
"type":"object",
"properties":{
"itemPromotionRefNo":{
"description":"Reference to the Item Level Promotion.",
"type":"string"
},
"adjustedAmount":{
"description":"Amount adjusted as a result of applied promotion.",
"type":"number"
},
"promotionAdjustmentType":{
"description":"Type of promotion Adjustment. Possible values are Adjusted / Removed.",
"type":"string"
},
"promotionDesc":{
"description":"Description of promotion",
"type":"string"
},
"couponCode":{
"description":"Code of the coupon applied.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion",
"type":"string"
}
}
},
"totalOrderDiscountAdjustment":{
"description":"The total change in order level promotion value adjustments due to the return",
"type":"number"
},
"nonReturnItemCostAdjustment":{
"description":"The cost adjustment for item which are not returned.",
"type":"object",
"properties":{
"commerceItemId":{
"description":"Id of the commerce Item.",
"type":"string"
},
"amountAdjustment":{
"description":"Amount adjusted as result of item returned.",
"type":"number"
},
"shippingGroupId":{
"description":"Id of the shipping group.",
"type":"string"
},
"quantityAdjusted":{
"description":"The number of item adjusted.",
"type":"number"
},
"shippingShareAdjustment":{
"description":"Adjustment made on the shipping group.",
"type":"number"
},
"orderDiscountShareAdjustment":{
"description":"The adjustment of order discount.",
"type":"number"
},
"manualAdjustmentShareAdjustment":{
"description":"Manual Adjustment made.",
"type":"number"
},
"taxShareAdjustment":{
"description":"Adjustment of the applied Tax.",
"type":"number"
}
}
},
"itemPromotionValueAdjustments":{
"description":"Item level promotion adjustments",
"type":"object",
"properties":{
"itemPromotionRefNo":{
"description":"Reference to the Item Level Promotion.",
"type":"string"
},
"adjustedAmount":{
"description":"Amount adjusted as a result of applied promotion.",
"type":"number"
},
"promotionAdjustmentType":{
"description":"Type of promotion Adjustment. Possible values are Adjusted / Removed.",
"type":"string"
},
"promotionDesc":{
"description":"Description of promotion",
"type":"string"
},
"couponCode":{
"description":"Code of the coupon applied.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion",
"type":"string"
}
}
}
}
},
"state":{
"description":"state ",
"type":"object",
"properties":{
"displayKey":{
"description":"Key of returned request status.",
"type":"string"
},
"displayName":{
"description":"Translated Value of returned request status.",
"type":"string"
}
}
},
"quoteInfo":{
"description":"the quote information of the order",
"type":"object",
"properties":{
"providerNote":{
"description":"the provider note for the quoted order",
"type":"string"
},
"notes":{
"description":"the notes (history) for the order",
"type":"array",
"items":{
"type":"object",
"properties":{
"requestDate/quoteDate/rejectionDate":{
"description":"the request/quote/rejection date for the note",
"type":"number"
},
"profileType":{
"description":"the profile type of the user that requested the quote",
"type":"string"
},
"profileId":{
"description":"the profile id of the user",
"type":"string"
},
"requesterNote/providerNote/rejectionNote":{
"description":"the requester/provider/rejection note",
"type":"string"
}
}
}
},
"rejectionDate":{
"description":"rejection date of the quoted order",
"type":"string"
},
"requestDate":{
"description":"the date when the quote was requested in ISO format",
"type":"string"
},
"errorInfo":{
"description":"the array of errors, if any",
"type":"array",
"items":{
"type":"string"
}
},
"externalId":{
"description":"the external id for the quote",
"type":"string"
},
"rejectionNote":{
"description":"the rejection note for an order whose quote has been rejected by user",
"type":"string"
},
"quoteDate":{
"description":"the date the order was quoted in milliseconds",
"type":"number"
},
"expirationDate":{
"description":"the expiration date of the quoted order, if any",
"type":"string"
}
}
},
"paymentReversalInfo":{
"description":"Payment Reversal Info for Order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"paymentGroupId":{
"description":"Id of the payment group",
"type":"string"
},
"refundType":{
"description":"Type of the refund. For example this can be tokenized credit card",
"type":"string"
},
"amount":{
"description":"The amount pertaining to the credit card",
"type":"number"
},
"creditCardInfo":{
"description":"Credit Card Details.",
"type":"object",
"properties":{
"cardNumber":{
"description":"Credit Card Number",
"type":"string"
}
}
},
"creditCardType":{
"description":"The type of the credit card",
"type":"string"
},
"state":{
"description":"The state of the return request",
"type":"string"
},
"reversalMethod":{
"description":"Payment Reversal Method",
"type":"string"
},
"maxRefundAmount":{
"description":"The maximum amount that can be refunded from the card",
"type":"number"
}
}
}
}
}
},
"initiateReturn_request":{
"properties":{
"op":{
"description":"Specify the operation to be performed",
"type":"string"
},
"orderId":{
"description":"Commerce id of order.",
"type":"string"
}
},
"required":[
"op",
"orderId"
]
},
"returnOrder":{
"links":[
{
"schema":{
"ref":"#/definitions/updateReturnRequest_request"
},
"targetSchema":{
"ref":"#/definitions/updateReturnRequest_response"
},
"method":"PUT",
"rel":"updateReturnRequest",
"mediaType":"application/json",
"href":"http://agent.example.com:9080/ccagent/v1/returnRequests/{id}",
"title":"Update Return Request. Updates details of items received against a return request with operation set as 'receiveReturns'."
},
{
"schema":{
"ref":"#/definitions/initiateReturn_request"
},
"targetSchema":{
"ref":"#/definitions/initiateReturn_response"
},
"method":"POST",
"rel":"initiateReturn",
"mediaType":"application/json",
"href":"http://agent.example.com:9080/ccagent/v1/returnRequests",
"title":"Initiate Return. Gets list of items from an order for which return request can be created with operation set as 'initiateReturn'."
},
{
"schema":{
"type":"object",
"properties":{
"q":{
"description":"The query string.",
"type":"string"
}
},
"required":[
"q"
]
},
"targetSchema":{
"ref":"#/definitions/initiateReturn_response"
},
"method":"GET",
"rel":"searchReturns",
"mediaType":"application/json",
"href":"http://agent.example.com:9080/ccagent/v1/returnRequests",
"title":"Search Returns. Gets a list of return requests from the repository based on given search criteria"
},
{
"targetSchema":{
"ref":"#/definitions/getReturnRequest_response"
},
"method":"GET",
"rel":"getReturnRequest",
"mediaType":"application/json",
"href":"http://agent.example.com:9080/ccagent/v1/returnRequests/{id}",
"title":"Get Return Request. Gets the return request details for a given ReturnRequestId."
},
{
"schema":{
"ref":"#/definitions/receiveReturnRequest_request"
},
"targetSchema":{
"ref":"#/definitions/receiveReturnRequest_response"
},
"method":"PUT",
"rel":"receiveReturnRequest",
"mediaType":"application/json",
"href":"http://agent.example.com:9080/ccagent/v1/returnRequests/{id}/receive",
"title":"Receive Return Request. Updates details of items received against a return request with operation set as 'receiveReturns'."
}
],
"required":[
"q"
],
"properties":{
"totalRequests":{
"description":"Total return requests details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"returnRequestId":{
"description":"request id",
"type":"string"
},
"firstName":{
"description":" First Name ",
"type":"string"
},
"lastName":{
"description":"Last Name",
"type":"string"
},
"createdDate":{
"description":"date of creation",
"type":"string"
},
"orderId":{
"description":"Order id",
"type":"string"
},
"totalRefund":{
"description":"refund amount",
"type":"string"
},
"priceListGroup":{
"description":"PriceList group of the order.",
"type":"object",
"properties":{
"deleted":{
"description":"Pricelist group deleted status.",
"type":"boolean"
},
"displayName":{
"description":"Display Name.",
"type":"string"
},
"repositoryId":{
"description":"Repository Id.",
"type":"string"
},
"listPriceList":{
"description":"Price List for list prices",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository ID of the list prices",
"type":"string"
}
}
},
"active":{
"description":"Active status of pricelist group.",
"type":"boolean"
},
"salePriceList":{
"description":"Price List for sale prices",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository ID of the sale prices",
"type":"string"
}
}
},
"currency":{
"description":"Currency of the PriceList group.",
"type":"object",
"properties":{
"symbol":{
"description":"currency Symbol.",
"type":"string"
},
"displayName":{
"description":"Display Name.",
"type":"string"
},
"repositoryId":{
"description":"Repository Id.",
"type":"string"
},
"fractionalDigits":{
"description":"Fractional Digits.",
"type":"integer"
},
"currencyCode":{
"description":"Currency Code.",
"type":"string"
},
"numericCode":{
"description":"Numeric Code.",
"type":"string"
}
}
},
"id":{
"description":"Id.",
"type":"string"
},
"locale":{
"description":"Locale.",
"type":"string"
},
"shippingSurchargePriceList":{
"description":"Price List for shipping surcharge prices",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository ID of the shipping surcharge prices",
"type":"string"
}
}
}
}
},
"state":{
"description":"return state",
"type":"string"
},
"totalReturnQuantity":{
"description":"returned quantities",
"type":"string"
},
"operation":{
"description":"Return operation",
"type":"string"
}
}
}
},
"searchResults":{
"description":"Total number of return requests present in search result.",
"type":"integer"
}
}
},
"updateReturnRequest_response":{
"properties":{
"returnRequestStatus":{
"description":"Status of Return Request",
"type":"string"
},
"isExchangeRequest":{
"description":"Either it is exchange / return request",
"type":"boolean"
},
"returnItems":{
"description":"List of returnable Items",
"type":"array",
"items":{
"type":"object",
"properties":{
"quantityReturned":{
"description":"Quantity Returned",
"type":"number"
},
"displayName":{
"description":"Display Name of the Product",
"type":"string"
},
"orderDiscountShare":{
"description":"OrderDiscountShare for a returnItem",
"type":"number"
},
"childItems":{
"description":"Returned Item child items",
"type":"array",
"items":{
"type":"object",
"properties":{
"quantity":{
"description":"quantity of the child Item",
"type":"number"
},
"route":{
"description":"Product path",
"type":"string"
},
"productId":{
"description":"Product Id of teh ",
"type":"string"
},
"displayName":{
"description":"Product display name of the sub sku commerce item",
"type":"string"
},
"selectedOptions":{
"description":"Child Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"type":"string"
}
}
}
},
"catRefId":{
"description":"Catalog Reference Id of the child Item",
"type":"string"
}
}
}
},
"configuratorId":{
"description":"Configurator Id of the returned item",
"type":"string"
},
"skuOptionInfo":{
"description":"Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute",
"type":"string"
}
}
}
},
"quantityAvailableForReturn":{
"description":"Quantity Available",
"type":"number"
},
"commerceItemId":{
"description":"Commerce Id of the returned item",
"type":"string"
},
"suggestedShippingRefund":{
"description":"Shipping Refund for a returnItem",
"type":"number"
},
"unAdjustedRefundAmount":{
"description":"Refund Amount of the item excluding orderDiscountShare and ManualAdjustmentShare",
"type":"number"
},
"price":{
"description":"Total price of the item",
"type":"number"
},
"returnReason":{
"description":"Reason to return an Item",
"type":"string"
},
"quantityReceived":{
"description":"Quantity Received",
"type":"number"
},
"dispositionReason":{
"description":"Disposition Reason",
"type":"object",
"properties":{
"displayKey":{
"description":"Key of the disposition Reason",
"type":"string"
},
"displayName":{
"description":"Name of the disposition Reason",
"type":"string"
}
}
},
"unitPrice":{
"description":"Unit price of the item",
"type":"number"
},
"quantityToReturn":{
"description":"Quantity To Return",
"type":"number"
},
"comments":{
"description":"Comments at ReturnItem Level",
"type":"string"
},
"productId":{
"description":"Id of the return Item",
"type":"string"
},
"returnItemId":{
"description":"Id of the return Item",
"type":"string"
},
"itemPromotionValueAdjustments":{
"description":"Item level promotion adjustments.",
"type":"object",
"properties":{
"itemPromotionRefNo":{
"description":"Reference to the Item Level Promotion.",
"type":"string"
},
"adjustedAmount":{
"description":"Amount adjusted as a result of applied promotion.",
"type":"number"
},
"promotionAdjustmentType":{
"description":"Type of promotion Adjustment. Possible values are Adjusted / Removed.",
"type":"string"
},
"promotionDesc":{
"description":"Description of promotion",
"type":"string"
},
"couponCode":{
"description":"Code of the coupon applied.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion",
"type":"string"
}
}
},
"quantityToReceive":{
"description":"Quantity To Return",
"type":"number"
},
"suggestedTaxRefund":{
"description":"Tax Refund for a returnItem",
"type":"number"
},
"shippingGroupId":{
"description":"Shipping group Id of the returned item",
"type":"string"
},
"manualAdjustmentShare":{
"description":"ManualAdjustmentShare for a returnItem",
"type":"number"
},
"catRefId":{
"description":"Catalog Reference Id",
"type":"string"
},
"quantityShipped":{
"description":"Quantity Shipped",
"type":"number"
},
"actualRefundAmount":{
"description":"Actual Refund Amount at Item level",
"type":"number"
},
"suggestedRefundAmount":{
"description":"Refund Cost for a returnItem",
"type":"number"
}
}
}
},
"submitExchangeAllowedValidationMessage":{
"description":"submitExchangeAllowedValidationMessage will come in json response if isSubmitExchangeOrderAllowed property is false",
"type":"object",
"properties":{
"errorCode":{
"description":"error code",
"type":"string"
},
"description":{
"description":"contains detailed info",
"type":"object",
"properties":{
"productIds":{
"description":"list of product id's",
"type":"array",
"items":{
"type":"string"
}
},
"skuIds":{
"description":"list of sku id's",
"type":"array",
"items":{
"type":"string"
}
}
}
},
"message":{
"description":"message string",
"type":"string"
}
}
},
"profileInfo":{
"description":"Profile Information for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name of profile.",
"type":"string"
},
"firstName":{
"description":"First name of profile.",
"type":"string"
},
"middleName":{
"description":"Middle name of profile.",
"type":"string"
},
"email":{
"description":"Email address of the profile",
"type":"string"
}
}
},
"isSubmitExchangeOrderAllowed":{
"description":"Indicates whether submit exchange order allowed or not.It will get populated only in exchange flow.",
"type":"boolean"
},
"isManuallyAdjusted":{
"description":"Manually Adjusted Return Request",
"type":"boolean"
},
"orderInfo":{
"description":"Order Information.",
"type":"object",
"properties":{
"priceInfo":{
"description":"Price information of the order.",
"type":"object",
"properties":{
"amount":{
"description":"The raw number that represents the price.",
"type":"number"
},
"total":{
"description":"The current working total, including all promotions, tax, and billing costs.",
"type":"number"
},
"shipping":{
"description":"The shipping cost of the order.",
"type":"number"
},
"isTaxIncluded":{
"description":"Indicates if tax is included in item price",
"type":"boolean"
},
"tax":{
"description":"The tax on the order.",
"type":"number"
},
"subTotal":{
"description":" The subtotal of the order before applying order-level promotions.",
"type":"number"
},
"orderDiscountAmount":{
"description":" Total order Discount Amount.",
"type":"number"
},
"currencyCode":{
"description":"Indicates the currency of the price. For example, USD indicates that the price is in US dollars.",
"type":"string"
},
"totalWithoutTax":{
"description":"The total cost without Tax.",
"type":"number"
}
}
},
"orderId":{
"description":"Commerce id for this order.",
"type":"string"
},
"creationDate":{
"description":"Date on which the Order was created.",
"type":"string"
},
"submittedDate":{
"description":"Date on which the Order was submitted.",
"type":"string"
}
}
},
"refundInfo":{
"description":"Refund Information at the returnRequest Level.",
"type":"object",
"properties":{
"shippingTaxRefund":{
"description":"Shipping tax Refund of all Return Items",
"type":"number"
},
"suggestedShippingRefund":{
"description":"Shipping Refund of all Return Items",
"type":"number"
},
"refundDue":{
"description":"Total Amount of the Refund",
"type":"number"
},
"returnFee":{
"description":"ReturnFee",
"type":"number"
},
"totalRefund":{
"description":"Total sum of all the Refunds",
"type":"number"
},
"suggestedOrderRefund":{
"description":"Refund Amount of all Return Items",
"type":"number"
},
"suggestedTaxRefund":{
"description":"Tax Refund of all Return Items",
"type":"number"
},
"unAdjustedRefundSubtotal":{
"description":"Refund SubTotal calculated as summation of unAdjustedRefundAmount for all return Items.",
"type":"number"
},
"actualShippingRefund":{
"description":"Actual Shipping Refund at Item level",
"type":"number"
},
"otherRefund":{
"description":"Other Refund",
"type":"number"
},
"actualTaxRefund":{
"description":"Actual Tax Refund at Item level",
"type":"number"
}
}
},
"isSetteled":{
"description":"Settled Return Request",
"type":"boolean"
},
"promotionAdjustments":{
"description":"Total promotions at Return item and Order level",
"type":"object",
"properties":{
"promotionAdjustmentsCount":{
"description":"Count of the total number of promotions applied",
"type":"integer"
},
"orderPromotionValueAdjustments":{
"description":"Order Level promotion adjustments",
"type":"object",
"properties":{
"itemPromotionRefNo":{
"description":"Reference to the Item Level Promotion.",
"type":"string"
},
"adjustedAmount":{
"description":"Amount adjusted as a result of applied promotion.",
"type":"number"
},
"promotionAdjustmentType":{
"description":"Type of promotion Adjustment. Possible values are Adjusted / Removed.",
"type":"string"
},
"promotionDesc":{
"description":"Description of promotion",
"type":"string"
},
"couponCode":{
"description":"Code of the coupon applied.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion",
"type":"string"
}
}
},
"totalOrderDiscountAdjustment":{
"description":"The total change in order level promotion value adjustments due to the return",
"type":"number"
},
"nonReturnItemCostAdjustment":{
"description":"The cost adjustment for item which are not returned.",
"type":"object",
"properties":{
"commerceItemId":{
"description":"Id of the commerce Item.",
"type":"string"
},
"amountAdjustment":{
"description":"Amount adjusted as result of item returned.",
"type":"number"
},
"shippingGroupId":{
"description":"Id of the shipping group.",
"type":"string"
},
"quantityAdjusted":{
"description":"The number of item adjusted.",
"type":"number"
},
"shippingShareAdjustment":{
"description":"Adjustment made on the shipping group.",
"type":"number"
},
"orderDiscountShareAdjustment":{
"description":"The adjustment of order discount.",
"type":"number"
},
"manualAdjustmentShareAdjustment":{
"description":"Manual Adjustment made.",
"type":"number"
},
"taxShareAdjustment":{
"description":"Adjustment of the applied Tax.",
"type":"number"
}
}
},
"itemPromotionValueAdjustments":{
"description":"Item level promotion adjustments",
"type":"object",
"properties":{
"itemPromotionRefNo":{
"description":"Reference to the Item Level Promotion.",
"type":"string"
},
"adjustedAmount":{
"description":"Amount adjusted as a result of applied promotion.",
"type":"number"
},
"promotionAdjustmentType":{
"description":"Type of promotion Adjustment. Possible values are Adjusted / Removed.",
"type":"string"
},
"promotionDesc":{
"description":"Description of promotion",
"type":"string"
},
"couponCode":{
"description":"Code of the coupon applied.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion",
"type":"string"
}
}
}
}
},
"quoteInfo":{
"description":"the quote information of the order",
"type":"object",
"properties":{
"providerNote":{
"description":"the provider note for the quoted order",
"type":"string"
},
"notes":{
"description":"the notes (history) for the order",
"type":"array",
"items":{
"type":"object",
"properties":{
"requestDate/quoteDate/rejectionDate":{
"description":"the request/quote/rejection date for the note",
"type":"number"
},
"profileType":{
"description":"the profile type of the user that requested the quote",
"type":"string"
},
"profileId":{
"description":"the profile id of the user",
"type":"string"
},
"requesterNote/providerNote/rejectionNote":{
"description":"the requester/provider/rejection note",
"type":"string"
}
}
}
},
"rejectionDate":{
"description":"rejection date of the quoted order",
"type":"string"
},
"requestDate":{
"description":"the date when the quote was requested in ISO format",
"type":"string"
},
"errorInfo":{
"description":"the array of errors, if any",
"type":"array",
"items":{
"type":"string"
}
},
"externalId":{
"description":"the external id for the quote",
"type":"string"
},
"rejectionNote":{
"description":"the rejection note for an order whose quote has been rejected by user",
"type":"string"
},
"quoteDate":{
"description":"the date the order was quoted in milliseconds",
"type":"number"
},
"expirationDate":{
"description":"the expiration date of the quoted order, if any",
"type":"string"
}
}
},
"paymentReversalInfo":{
"description":"Payment Reversal Info for Order.",
"type":"object",
"properties":{
"creditCardInfo":{
"description":"Credit Card Details.",
"type":"object",
"properties":{
"cardNumber":{
"description":"Credit Card Number",
"type":"string"
}
}
},
"reversalMethod":{
"description":"Payment Reversal Method",
"type":"string"
}
}
}
}
},
"receiveReturnRequest_request":{
"properties":{
"returnItems":{
"description":"List of returnable Items",
"type":"array",
"items":{
"type":"object",
"properties":{
"returnItemId":{
"description":"Id of the Return Item.",
"type":"string"
},
"dispositionReason":{
"description":"Disposition Reason for Return Item",
"type":"string"
},
"quantityReceived":{
"description":"Quantity Received",
"type":"number"
}
}
}
}
},
"required":[
"returnItems"
]
},
"receiveReturnRequest_response":{
"properties":{
"returnRequestStatus":{
"description":"Status of Return Request",
"type":"string"
},
"isExchangeRequest":{
"description":"Either it is exchange / return request",
"type":"boolean"
},
"returnItems":{
"description":"List of returnable Items",
"type":"array",
"items":{
"type":"object",
"properties":{
"quantityReturned":{
"description":"Quantity Returned",
"type":"number"
},
"displayName":{
"description":"Display Name of the Product",
"type":"string"
},
"orderDiscountShare":{
"description":"OrderDiscountShare for a returnItem",
"type":"number"
},
"childItems":{
"description":"Returned Item child items",
"type":"array",
"items":{
"type":"object",
"properties":{
"quantity":{
"description":"quantity of the child Item",
"type":"number"
},
"route":{
"description":"Product path",
"type":"string"
},
"productId":{
"description":"Product Id of teh ",
"type":"string"
},
"displayName":{
"description":"Product display name of the sub sku commerce item",
"type":"string"
},
"selectedOptions":{
"description":"Child Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"type":"string"
}
}
}
},
"catRefId":{
"description":"Catalog Reference Id of the child Item",
"type":"string"
}
}
}
},
"configuratorId":{
"description":"Configurator Id of the returned item",
"type":"string"
},
"skuOptionInfo":{
"description":"Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute",
"type":"string"
}
}
}
},
"quantityAvailableForReturn":{
"description":"Quantity Available",
"type":"number"
},
"commerceItemId":{
"description":"Commerce Id of the returned item",
"type":"string"
},
"suggestedShippingRefund":{
"description":"Shipping Refund for a returnItem",
"type":"number"
},
"unAdjustedRefundAmount":{
"description":"Refund Amount of the item excluding orderDiscountShare and ManualAdjustmentShare",
"type":"number"
},
"price":{
"description":"Total price of the item",
"type":"number"
},
"returnReason":{
"description":"Reason to return an Item",
"type":"string"
},
"quantityReceived":{
"description":"Quantity Received",
"type":"number"
},
"dispositionReason":{
"description":"Disposition Reason",
"type":"object",
"properties":{
"displayKey":{
"description":"Key of the disposition Reason",
"type":"string"
},
"displayName":{
"description":"Name of the disposition Reason",
"type":"string"
}
}
},
"unitPrice":{
"description":"Unit price of the item",
"type":"number"
},
"quantityToReturn":{
"description":"Quantity To Return",
"type":"number"
},
"comments":{
"description":"Comments at ReturnItem Level",
"type":"string"
},
"productId":{
"description":"Id of the return Item",
"type":"string"
},
"returnItemId":{
"description":"Id of the return Item",
"type":"string"
},
"itemPromotionValueAdjustments":{
"description":"Item level promotion adjustments.",
"type":"object",
"properties":{
"itemPromotionRefNo":{
"description":"Reference to the Item Level Promotion.",
"type":"string"
},
"adjustedAmount":{
"description":"Amount adjusted as a result of applied promotion.",
"type":"number"
},
"promotionAdjustmentType":{
"description":"Type of promotion Adjustment. Possible values are Adjusted / Removed.",
"type":"string"
},
"promotionDesc":{
"description":"Description of promotion",
"type":"string"
},
"couponCode":{
"description":"Code of the coupon applied.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion",
"type":"string"
}
}
},
"quantityToReceive":{
"description":"Quantity To Return",
"type":"number"
},
"suggestedTaxRefund":{
"description":"Tax Refund for a returnItem",
"type":"number"
},
"shippingGroupId":{
"description":"Shipping group Id of the returned item",
"type":"string"
},
"manualAdjustmentShare":{
"description":"ManualAdjustmentShare for a returnItem",
"type":"number"
},
"catRefId":{
"description":"Catalog Reference Id",
"type":"string"
},
"quantityShipped":{
"description":"Quantity Shipped",
"type":"number"
},
"actualRefundAmount":{
"description":"Actual Refund Amount at Item level",
"type":"number"
},
"suggestedRefundAmount":{
"description":"Refund Cost for a returnItem",
"type":"number"
}
}
}
},
"submitExchangeAllowedValidationMessage":{
"description":"submitExchangeAllowedValidationMessage will come in json response if isSubmitExchangeOrderAllowed property is false",
"type":"object",
"properties":{
"errorCode":{
"description":"error code",
"type":"string"
},
"description":{
"description":"contains detailed info",
"type":"object",
"properties":{
"productIds":{
"description":"list of product id's",
"type":"array",
"items":{
"type":"string"
}
},
"skuIds":{
"description":"list of sku id's",
"type":"array",
"items":{
"type":"string"
}
}
}
},
"message":{
"description":"message string",
"type":"string"
}
}
},
"profileInfo":{
"description":"Profile Information for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name of profile.",
"type":"string"
},
"firstName":{
"description":"First name of profile.",
"type":"string"
},
"middleName":{
"description":"Middle name of profile.",
"type":"string"
},
"email":{
"description":"Email address of the profile",
"type":"string"
}
}
},
"isSubmitExchangeOrderAllowed":{
"description":"Indicates whether submit exchange order allowed or not.It will get populated only in exchange flow.",
"type":"boolean"
},
"isManuallyAdjusted":{
"description":"Manually Adjusted Return Request",
"type":"boolean"
},
"orderInfo":{
"description":"Order Information.",
"type":"object",
"properties":{
"priceInfo":{
"description":"Price information of the order.",
"type":"object",
"properties":{
"amount":{
"description":"The raw number that represents the price.",
"type":"number"
},
"total":{
"description":"The current working total, including all promotions, tax, and billing costs.",
"type":"number"
},
"shipping":{
"description":"The shipping cost of the order.",
"type":"number"
},
"isTaxIncluded":{
"description":"Indicates if tax is included in item price",
"type":"boolean"
},
"tax":{
"description":"The tax on the order.",
"type":"number"
},
"subTotal":{
"description":" The subtotal of the order before applying order-level promotions.",
"type":"number"
},
"orderDiscountAmount":{
"description":" Total order Discount Amount.",
"type":"number"
},
"currencyCode":{
"description":"Indicates the currency of the price. For example, USD indicates that the price is in US dollars.",
"type":"string"
},
"totalWithoutTax":{
"description":"The total cost without Tax.",
"type":"number"
}
}
},
"orderId":{
"description":"Commerce id for this order.",
"type":"string"
},
"creationDate":{
"description":"Date on which the Order was created.",
"type":"string"
},
"submittedDate":{
"description":"Date on which the Order was submitted.",
"type":"string"
}
}
},
"refundInfo":{
"description":"Refund Information at the returnRequest Level.",
"type":"object",
"properties":{
"shippingTaxRefund":{
"description":"Shipping tax Refund of all Return Items",
"type":"number"
},
"suggestedShippingRefund":{
"description":"Shipping Refund of all Return Items",
"type":"number"
},
"refundDue":{
"description":"Total Amount of the Refund",
"type":"number"
},
"returnFee":{
"description":"ReturnFee",
"type":"number"
},
"totalRefund":{
"description":"Total sum of all the Refunds",
"type":"number"
},
"suggestedOrderRefund":{
"description":"Refund Amount of all Return Items",
"type":"number"
},
"suggestedTaxRefund":{
"description":"Tax Refund of all Return Items",
"type":"number"
},
"unAdjustedRefundSubtotal":{
"description":"Refund SubTotal calculated as summation of unAdjustedRefundAmount for all return Items.",
"type":"number"
},
"actualShippingRefund":{
"description":"Actual Shipping Refund at Item level",
"type":"number"
},
"otherRefund":{
"description":"Other Refund",
"type":"number"
},
"actualTaxRefund":{
"description":"Actual Tax Refund at Item level",
"type":"number"
}
}
},
"isSetteled":{
"description":"Settled Return Request",
"type":"boolean"
},
"promotionAdjustments":{
"description":"Total promotions at Return item and Order level",
"type":"object",
"properties":{
"promotionAdjustmentsCount":{
"description":"Count of the total number of promotions applied",
"type":"integer"
},
"orderPromotionValueAdjustments":{
"description":"Order Level promotion adjustments",
"type":"object",
"properties":{
"itemPromotionRefNo":{
"description":"Reference to the Item Level Promotion.",
"type":"string"
},
"adjustedAmount":{
"description":"Amount adjusted as a result of applied promotion.",
"type":"number"
},
"promotionAdjustmentType":{
"description":"Type of promotion Adjustment. Possible values are Adjusted / Removed.",
"type":"string"
},
"promotionDesc":{
"description":"Description of promotion",
"type":"string"
},
"couponCode":{
"description":"Code of the coupon applied.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion",
"type":"string"
}
}
},
"totalOrderDiscountAdjustment":{
"description":"The total change in order level promotion value adjustments due to the return",
"type":"number"
},
"nonReturnItemCostAdjustment":{
"description":"The cost adjustment for item which are not returned.",
"type":"object",
"properties":{
"commerceItemId":{
"description":"Id of the commerce Item.",
"type":"string"
},
"amountAdjustment":{
"description":"Amount adjusted as result of item returned.",
"type":"number"
},
"shippingGroupId":{
"description":"Id of the shipping group.",
"type":"string"
},
"quantityAdjusted":{
"description":"The number of item adjusted.",
"type":"number"
},
"shippingShareAdjustment":{
"description":"Adjustment made on the shipping group.",
"type":"number"
},
"orderDiscountShareAdjustment":{
"description":"The adjustment of order discount.",
"type":"number"
},
"manualAdjustmentShareAdjustment":{
"description":"Manual Adjustment made.",
"type":"number"
},
"taxShareAdjustment":{
"description":"Adjustment of the applied Tax.",
"type":"number"
}
}
},
"itemPromotionValueAdjustments":{
"description":"Item level promotion adjustments",
"type":"object",
"properties":{
"itemPromotionRefNo":{
"description":"Reference to the Item Level Promotion.",
"type":"string"
},
"adjustedAmount":{
"description":"Amount adjusted as a result of applied promotion.",
"type":"number"
},
"promotionAdjustmentType":{
"description":"Type of promotion Adjustment. Possible values are Adjusted / Removed.",
"type":"string"
},
"promotionDesc":{
"description":"Description of promotion",
"type":"string"
},
"couponCode":{
"description":"Code of the coupon applied.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion",
"type":"string"
}
}
}
}
},
"quoteInfo":{
"description":"the quote information of the order",
"type":"object",
"properties":{
"providerNote":{
"description":"the provider note for the quoted order",
"type":"string"
},
"notes":{
"description":"the notes (history) for the order",
"type":"array",
"items":{
"type":"object",
"properties":{
"requestDate/quoteDate/rejectionDate":{
"description":"the request/quote/rejection date for the note",
"type":"number"
},
"profileType":{
"description":"the profile type of the user that requested the quote",
"type":"string"
},
"profileId":{
"description":"the profile id of the user",
"type":"string"
},
"requesterNote/providerNote/rejectionNote":{
"description":"the requester/provider/rejection note",
"type":"string"
}
}
}
},
"rejectionDate":{
"description":"rejection date of the quoted order",
"type":"string"
},
"requestDate":{
"description":"the date when the quote was requested in ISO format",
"type":"string"
},
"errorInfo":{
"description":"the array of errors, if any",
"type":"array",
"items":{
"type":"string"
}
},
"externalId":{
"description":"the external id for the quote",
"type":"string"
},
"rejectionNote":{
"description":"the rejection note for an order whose quote has been rejected by user",
"type":"string"
},
"quoteDate":{
"description":"the date the order was quoted in milliseconds",
"type":"number"
},
"expirationDate":{
"description":"the expiration date of the quoted order, if any",
"type":"string"
}
}
},
"paymentReversalInfo":{
"description":"Payment Reversal Info for Order.",
"type":"object",
"properties":{
"creditCardInfo":{
"description":"Credit Card Details.",
"type":"object",
"properties":{
"cardNumber":{
"description":"Credit Card Number",
"type":"string"
}
}
},
"reversalMethod":{
"description":"Payment Reversal Method",
"type":"string"
}
}
}
}
},
"initiateReturn_response":{
"properties":{
"returnItems":{
"description":"List of returnable Items",
"type":"array",
"items":{
"type":"object",
"properties":{
"quantityReturned":{
"description":"Quantity Returned",
"type":"number"
},
"unitPrice":{
"description":"Unit price of the item",
"type":"number"
},
"comments":{
"description":"Comments at returnItem level",
"type":"string"
},
"productId":{
"description":"Id of the Product",
"type":"string"
},
"displayName":{
"description":"Display Name of the Product",
"type":"string"
},
"shippingGroupId":{
"description":"Shipping group Id of the returned item",
"type":"string"
},
"childItems":{
"description":"Returned Item child items",
"type":"array",
"items":{
"type":"object",
"properties":{
"quantity":{
"description":"quantity of the child Item",
"type":"number"
},
"route":{
"description":"Product path",
"type":"string"
},
"productId":{
"description":"Product Id of teh ",
"type":"string"
},
"displayName":{
"description":"Product display name of the sub sku commerce item",
"type":"string"
},
"selectedOptions":{
"description":"Child Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"type":"string"
}
}
}
},
"catRefId":{
"description":"Catalog Reference Id of the child Item",
"type":"string"
}
}
}
},
"catRefId":{
"description":"Catalog Reference Id",
"type":"string"
},
"skuOptionInfo":{
"description":"Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute",
"type":"string"
}
}
}
},
"configuratorId":{
"description":"Configurator Id of the returned item",
"type":"string"
},
"quantityAvailableForReturn":{
"description":"Quantity Available",
"type":"number"
},
"commerceItemId":{
"description":"Commerce Id of the returned item",
"type":"string"
},
"quantityShipped":{
"description":"Quantity Shipped",
"type":"number"
},
"price":{
"description":"Total price of items",
"type":"number"
}
}
}
},
"profileInfo":{
"description":"Profile Information for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name of profile.",
"type":"string"
},
"firstName":{
"description":"First name of profile.",
"type":"string"
},
"organization":{
"description":"The Organization associated with the B2B customer profile.",
"type":"object",
"properties":{
"name":{
"description":"The name of of the organization.",
"type":"string"
},
"id":{
"description":"The id of the organization.",
"type":"string"
}
}
},
"middleName":{
"description":"Middle name of profile.",
"type":"string"
},
"email":{
"description":"Email address of the profile",
"type":"string"
}
}
},
"orderInfo":{
"description":"Order Information.",
"type":"object",
"properties":{
"priceInfo":{
"description":"Price information of the order.",
"type":"object",
"properties":{
"amount":{
"description":"The raw number that represents the price.",
"type":"number"
},
"total":{
"description":"The current working total, including all promotions, tax, and billing costs.",
"type":"number"
},
"shipping":{
"description":"The shipping cost of the order.",
"type":"number"
},
"isTaxIncluded":{
"description":"Indicates if tax is included in item price",
"type":"boolean"
},
"tax":{
"description":"The tax on the order.",
"type":"number"
},
"subTotal":{
"description":" The subtotal of the order before applying order-level promotions.",
"type":"number"
},
"orderDiscountAmount":{
"description":"Total Order Discount Ampunt",
"type":"number"
},
"currencyCode":{
"description":"Indicates the currency of the price. For example, USD indicates that the price is in US dollars.",
"type":"string"
},
"totalWithoutTax":{
"description":"The total cost without Tax.",
"type":"number"
}
}
},
"orderId":{
"description":"Commerce id for this order.",
"type":"string"
},
"priceListGroup":{
"description":"PriceList group of the order.",
"type":"object",
"properties":{
"deleted":{
"description":"Pricelist group deleted status.",
"type":"boolean"
},
"displayName":{
"description":"Display Name.",
"type":"string"
},
"repositoryId":{
"description":"Repository Id.",
"type":"string"
},
"listPriceList":{
"description":"Price List for list prices",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository ID of the list prices",
"type":"string"
}
}
},
"active":{
"description":"Active status of pricelist group.",
"type":"boolean"
},
"salePriceList":{
"description":"Price List for sale prices",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository ID of the sale prices",
"type":"string"
}
}
},
"currency":{
"description":"Currency of the PriceList group.",
"type":"object",
"properties":{
"symbol":{
"description":"currency Symbol.",
"type":"string"
},
"displayName":{
"description":"Display Name.",
"type":"string"
},
"repositoryId":{
"description":"Repository Id.",
"type":"string"
},
"fractionalDigits":{
"description":"Fractional Digits.",
"type":"integer"
},
"currencyCode":{
"description":"Currency Code.",
"type":"string"
},
"numericCode":{
"description":"Numeric Code.",
"type":"string"
}
}
},
"id":{
"description":"Id.",
"type":"string"
},
"locale":{
"description":"Locale.",
"type":"string"
},
"shippingSurchargePriceList":{
"description":"Price List for shipping surcharge prices",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository ID of the shipping surcharge prices",
"type":"string"
}
}
}
}
},
"creationDate":{
"description":"Date on which the Order was created.",
"type":"string"
},
"submittedDate":{
"description":"Date on which the Order was submitted.",
"type":"string"
}
}
},
"quoteInfo":{
"description":"the quote information of the order",
"type":"object",
"properties":{
"providerNote":{
"description":"the provider note for the quoted order",
"type":"string"
},
"notes":{
"description":"the notes (history) for the order",
"type":"array",
"items":{
"type":"object",
"properties":{
"requestDate/quoteDate/rejectionDate":{
"description":"the request/quote/rejection date for the note",
"type":"number"
},
"profileType":{
"description":"the profile type of the user that requested the quote",
"type":"string"
},
"profileId":{
"description":"the profile id of the user",
"type":"string"
},
"requesterNote/providerNote/rejectionNote":{
"description":"the requester/provider/rejection note",
"type":"string"
}
}
}
},
"rejectionDate":{
"description":"rejection date of the quoted order",
"type":"string"
},
"requestDate":{
"description":"the date when the quote was requested in ISO format",
"type":"string"
},
"errorInfo":{
"description":"the array of errors, if any",
"type":"array",
"items":{
"type":"string"
}
},
"externalId":{
"description":"the external id for the quote",
"type":"string"
},
"rejectionNote":{
"description":"the rejection note for an order whose quote has been rejected by user",
"type":"string"
},
"quoteDate":{
"description":"the date the order was quoted in milliseconds",
"type":"number"
},
"expirationDate":{
"description":"the expiration date of the quoted order, if any",
"type":"string"
}
}
}
}
}
}
}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|
|------------------|------------------|
|13101|METADATA INTERNAL ERROR|
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:
arrayAn 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