Jump to

• Request
• Response

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getReturnRequest_response

Type: object

Show Source

• 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

{
    "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"
                    },
                    "dynamicProperties":{
                        "description":"Array of custom properties at order line item level.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "id":{
                                    "description":"The ID of the dynamic property.",
                                    "type":"string"
                                },
                                "label":{
                                    "description":"The label of the dynamic property.",
                                    "type":"string"
                                },
                                "value":{
                                    "description":"The value of the dynamic property.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "billingProfileId":{
                        "description":"The billing profile ID associated to the current item.",
                        "type":"string"
                    },
                    "billingAccountId":{
                        "description":"The billing account ID associated to the current item.",
                        "type":"string"
                    },
                    "childItems":{
                        "description":"Returned Item child items",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "serviceAccountId":{
                                    "description":"The service account ID associated to the current item.",
                                    "type":"string"
                                },
                                "deactivationDate":{
                                    "description":"The deactivation date in ISO format.",
                                    "type":"string"
                                },
                                "quantity":{
                                    "description":"quantity of the child Item",
                                    "type":"number"
                                },
                                "productId":{
                                    "description":"Product Id of teh ",
                                    "type":"string"
                                },
                                "displayName":{
                                    "description":"Product display name of the sub sku commerce item",
                                    "type":"string"
                                },
                                "externalData":{
                                    "description":"External data to be associated with a commerce item, provided by a configurator system.",
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "values":{
                                                "description":"The array of values associated with an externalData item.",
                                                "type":"object",
                                                "properties":{
                                                    "dynamic_property_key":{
                                                        "description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
                                                        "type":"string"
                                                    }
                                                }
                                            },
                                            "name":{
                                                "description":"The name to be associated with the externalData item.",
                                                "type":"string"
                                            },
                                            "actionCode":{
                                                "description":"The action code that has been set on the externalData item by the configurator system.",
                                                "type":"string"
                                            }
                                        }
                                    }
                                },
                                "parentAssetKey":{
                                    "description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
                                    "type":"string"
                                },
                                "billingProfileId":{
                                    "description":"The billing profile ID associated to the current item.",
                                    "type":"string"
                                },
                                "billingAccountId":{
                                    "description":"The billing account ID associated to the current item.",
                                    "type":"string"
                                },
                                "rootAssetKey":{
                                    "description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
                                    "type":"string"
                                },
                                "transactionDate":{
                                    "description":"ISO formatted Date on which the service action should be triggered.",
                                    "type":"string"
                                },
                                "catRefId":{
                                    "description":"Catalog Reference Id of the child Item",
                                    "type":"string"
                                },
                                "assetKey":{
                                    "description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
                                    "type":"string"
                                },
                                "route":{
                                    "description":"Product path",
                                    "type":"string"
                                },
                                "customerAccountId":{
                                    "description":"The customer account ID associated to the current 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"
                                            }
                                        }
                                    }
                                },
                                "actionCode":{
                                    "description":"The action code that has been set on the item by the configurator system.",
                                    "type":"string"
                                },
                                "activationDate":{
                                    "description":"The activation date in ISO format.",
                                    "type":"string"
                                },
                                "serviceId":{
                                    "description":"The service ID associated to the current item.",
                                    "type":"string"
                                },
                                "asset":{
                                    "description":"The flag that determines if the current item is an asset or not.",
                                    "type":"boolean"
                                }
                            }
                        }
                    },
                    "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"
                    },
                    "assetKey":{
                        "description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
                        "type":"string"
                    },
                    "quantityAvailableForReturn":{
                        "description":"Quantity Available",
                        "type":"number"
                    },
                    "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"
                    },
                    "actionCode":{
                        "description":"The action code that has been set on the item by the configurator system.",
                        "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"
                    },
                    "productId":{
                        "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"
                            }
                        }
                    },
                    "parentAssetKey":{
                        "description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
                        "type":"string"
                    },
                    "catRefId":{
                        "description":"Catalog Reference Id",
                        "type":"string"
                    },
                    "customerAccountId":{
                        "description":"The customer account ID associated to the current item.",
                        "type":"string"
                    },
                    "quantityShipped":{
                        "description":"Quantity Shipped",
                        "type":"number"
                    },
                    "additionalProperties":{
                        "description":"Additional Properties if any returned by webhook.",
                        "type":"object"
                    },
                    "activationDate":{
                        "description":"The activation date in ISO format.",
                        "type":"string"
                    },
                    "actualRefundAmount":{
                        "description":"Actual Refund Amount at Item level",
                        "type":"number"
                    },
                    "suggestedRefundAmount":{
                        "description":"Refund Cost for a returnItem",
                        "type":"number"
                    },
                    "deactivationDate":{
                        "description":"The deactivation date in ISO format.",
                        "type":"string"
                    },
                    "nonreturnable":{
                        "description":"Indicates whether the item is returnable or not",
                        "type":"boolean"
                    },
                    "displayName":{
                        "description":"Display Name of the Product",
                        "type":"string"
                    },
                    "externalData":{
                        "description":"External data to be associated with a commerce item, provided by a configurator system.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "values":{
                                    "description":"The array of values associated with an externalData item.",
                                    "type":"object",
                                    "properties":{
                                        "dynamic_property_key":{
                                            "description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
                                            "type":"string"
                                        }
                                    }
                                },
                                "name":{
                                    "description":"The name to be associated with the externalData item.",
                                    "type":"string"
                                },
                                "actionCode":{
                                    "description":"The action code that has been set on the externalData item by the configurator system.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "orderDiscountShare":{
                        "description":"OrderDiscountShare for a returnItem",
                        "type":"number"
                    },
                    "commerceItemId":{
                        "description":"Commerce Id of the returned item",
                        "type":"string"
                    },
                    "returnReason":{
                        "description":"Reason to return an Item",
                        "type":"string"
                    },
                    "serviceId":{
                        "description":"The service ID associated to the current item.",
                        "type":"string"
                    },
                    "nonReturnableReason":{
                        "description":"Non returnable reason if item is non returnable",
                        "type":"string"
                    },
                    "serviceAccountId":{
                        "description":"The service account ID associated to the current item.",
                        "type":"string"
                    },
                    "quantityToReturn":{
                        "description":"Quantity To Return",
                        "type":"number"
                    },
                    "comments":{
                        "description":"Comments at ReturnItem Level",
                        "type":"string"
                    },
                    "returnItemId":{
                        "description":"Id of the return Item",
                        "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"
                    },
                    "rootAssetKey":{
                        "description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
                        "type":"string"
                    },
                    "transactionDate":{
                        "description":"ISO formatted Date on which the service action should be triggered.",
                        "type":"string"
                    },
                    "returnRequired":{
                        "description":"Boolean value to determine if the item has to be physically received.",
                        "type":"boolean"
                    },
                    "skuProperties":{
                        "description":"Sku properties Information",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "propertyType":{
                                    "description":"Type that indicates whether it is a base or a custom SKU property,",
                                    "type":"string"
                                },
                                "name":{
                                    "description":"Name of the Dynamic SKU Property.",
                                    "type":"string"
                                },
                                "id":{
                                    "description":"ID of the Dynamic SKU Property.",
                                    "type":"string"
                                },
                                "value":{
                                    "description":"Value of the Dynamic SKU Property.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "adjustedPromotionReferences":{
                        "description":"Reference to the Promotions linked to this returnItem",
                        "type":"string"
                    },
                    "childReturnItems":{
                        "description":"List of child return Items",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "$ref":"#/definitions/childReturnItems_def"
                        }
                    },
                    "asset":{
                        "description":"The flag that determines if the current item is an asset or not.",
                        "type":"boolean"
                    }
                }
            }
        },
        "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"
        },
        "returnLabel":{
            "description":"return label of the return request",
            "type":"string"
        },
        "isManuallyAdjusted":{
            "description":"Manually Adjusted Return Request",
            "type":"boolean"
        },
        "authorizationNumber":{
            "description":"RMA number of Return Request if available otherwise return request id",
            "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 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"
                },
                "siteId":{
                    "description":"Site Id on which the Order was placed.",
                    "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"
                },
                "appeasementRefundAdjustment":{
                    "description":"The refund amount adjustment needed for the existing appeasements on the same order",
                    "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"
                },
                "secondaryCurrencyAppeasementRefundAdjustment":{
                    "description":"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.",
                    "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"
                        }
                    }
                }
            }
        },
        "additionalProperties":{
            "description":"Additional properties if any returned by the webhook.",
            "type":"object"
        },
        "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":{
                            "providerNote":{
                                "description":"the provider note for the quoted order",
                                "type":"string"
                            },
                            "profileType":{
                                "description":"the profile type of the user that requested the quote",
                                "type":"string"
                            },
                            "profileId":{
                                "description":"the profile id of the user",
                                "type":"string"
                            },
                            "rejectionDate":{
                                "description":"the rejection date an order whose quote has been rejected by user",
                                "type":"number"
                            },
                            "requestDate":{
                                "description":"the date when the quote was requested in ISO format",
                                "type":"number"
                            },
                            "quoteDate":{
                                "description":"the date the order was quoted in milliseconds",
                                "type":"number"
                            },
                            "rejectionNote":{
                                "description":"the rejection note for an order whose quote has been rejected by user",
                                "type":"string"
                            },
                            "requesterNote":{
                                "description":"the requester note",
                                "type":"string"
                            }
                        }
                    }
                },
                "rejectionDate":{
                    "description":"the rejection date for an order whose quote has been rejected by user",
                    "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"
                }
            }
        },
        "trackingNumber":{
            "description":"Tracking Number of the return request",
            "type":"array",
            "items":{
                "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"
                    }
                }
            }
        }
    }
}

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.

{
    "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"
        },
        "siteId":{
            "description":"Site Id on which the Order was placed.",
            "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"
        }
    }
}

Nested Schema : paymentReversalInfo

Type: array

Payment Reversal Info for Order.

Show Source

• Array of: object items

{
    "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"
            }
        }
    }
}

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.

{
    "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"
        }
    }
}

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

{
    "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"
                }
            }
        }
    }
}

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

{
    "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":{
                    "providerNote":{
                        "description":"the provider note for the quoted order",
                        "type":"string"
                    },
                    "profileType":{
                        "description":"the profile type of the user that requested the quote",
                        "type":"string"
                    },
                    "profileId":{
                        "description":"the profile id of the user",
                        "type":"string"
                    },
                    "rejectionDate":{
                        "description":"the rejection date an order whose quote has been rejected by user",
                        "type":"number"
                    },
                    "requestDate":{
                        "description":"the date when the quote was requested in ISO format",
                        "type":"number"
                    },
                    "quoteDate":{
                        "description":"the date the order was quoted in milliseconds",
                        "type":"number"
                    },
                    "rejectionNote":{
                        "description":"the rejection note for an order whose quote has been rejected by user",
                        "type":"string"
                    },
                    "requesterNote":{
                        "description":"the requester note",
                        "type":"string"
                    }
                }
            }
        },
        "rejectionDate":{
            "description":"the rejection date for an order whose quote has been rejected by user",
            "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"
        }
    }
}

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.

{
    "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"
        },
        "appeasementRefundAdjustment":{
            "description":"The refund amount adjustment needed for the existing appeasements on the same order",
            "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"
        },
        "secondaryCurrencyAppeasementRefundAdjustment":{
            "description":"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.",
            "type":"number"
        },
        "actualTaxRefund":{
            "description":"Actual Tax Refund at Item level",
            "type":"number"
        }
    }
}

Nested Schema : returnItems

Type: array

List of returnable Items

Show Source

• Array of: object items

{
    "description":"List of returnable Items",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "quantityReturned":{
                "description":"Quantity Returned",
                "type":"number"
            },
            "dynamicProperties":{
                "description":"Array of custom properties at order line item level.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "id":{
                            "description":"The ID of the dynamic property.",
                            "type":"string"
                        },
                        "label":{
                            "description":"The label of the dynamic property.",
                            "type":"string"
                        },
                        "value":{
                            "description":"The value of the dynamic property.",
                            "type":"string"
                        }
                    }
                }
            },
            "billingProfileId":{
                "description":"The billing profile ID associated to the current item.",
                "type":"string"
            },
            "billingAccountId":{
                "description":"The billing account ID associated to the current item.",
                "type":"string"
            },
            "childItems":{
                "description":"Returned Item child items",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "serviceAccountId":{
                            "description":"The service account ID associated to the current item.",
                            "type":"string"
                        },
                        "deactivationDate":{
                            "description":"The deactivation date in ISO format.",
                            "type":"string"
                        },
                        "quantity":{
                            "description":"quantity of the child Item",
                            "type":"number"
                        },
                        "productId":{
                            "description":"Product Id of teh ",
                            "type":"string"
                        },
                        "displayName":{
                            "description":"Product display name of the sub sku commerce item",
                            "type":"string"
                        },
                        "externalData":{
                            "description":"External data to be associated with a commerce item, provided by a configurator system.",
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "values":{
                                        "description":"The array of values associated with an externalData item.",
                                        "type":"object",
                                        "properties":{
                                            "dynamic_property_key":{
                                                "description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
                                                "type":"string"
                                            }
                                        }
                                    },
                                    "name":{
                                        "description":"The name to be associated with the externalData item.",
                                        "type":"string"
                                    },
                                    "actionCode":{
                                        "description":"The action code that has been set on the externalData item by the configurator system.",
                                        "type":"string"
                                    }
                                }
                            }
                        },
                        "parentAssetKey":{
                            "description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
                            "type":"string"
                        },
                        "billingProfileId":{
                            "description":"The billing profile ID associated to the current item.",
                            "type":"string"
                        },
                        "billingAccountId":{
                            "description":"The billing account ID associated to the current item.",
                            "type":"string"
                        },
                        "rootAssetKey":{
                            "description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
                            "type":"string"
                        },
                        "transactionDate":{
                            "description":"ISO formatted Date on which the service action should be triggered.",
                            "type":"string"
                        },
                        "catRefId":{
                            "description":"Catalog Reference Id of the child Item",
                            "type":"string"
                        },
                        "assetKey":{
                            "description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
                            "type":"string"
                        },
                        "route":{
                            "description":"Product path",
                            "type":"string"
                        },
                        "customerAccountId":{
                            "description":"The customer account ID associated to the current 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"
                                    }
                                }
                            }
                        },
                        "actionCode":{
                            "description":"The action code that has been set on the item by the configurator system.",
                            "type":"string"
                        },
                        "activationDate":{
                            "description":"The activation date in ISO format.",
                            "type":"string"
                        },
                        "serviceId":{
                            "description":"The service ID associated to the current item.",
                            "type":"string"
                        },
                        "asset":{
                            "description":"The flag that determines if the current item is an asset or not.",
                            "type":"boolean"
                        }
                    }
                }
            },
            "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"
            },
            "assetKey":{
                "description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
                "type":"string"
            },
            "quantityAvailableForReturn":{
                "description":"Quantity Available",
                "type":"number"
            },
            "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"
            },
            "actionCode":{
                "description":"The action code that has been set on the item by the configurator system.",
                "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"
            },
            "productId":{
                "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"
                    }
                }
            },
            "parentAssetKey":{
                "description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
                "type":"string"
            },
            "catRefId":{
                "description":"Catalog Reference Id",
                "type":"string"
            },
            "customerAccountId":{
                "description":"The customer account ID associated to the current item.",
                "type":"string"
            },
            "quantityShipped":{
                "description":"Quantity Shipped",
                "type":"number"
            },
            "additionalProperties":{
                "description":"Additional Properties if any returned by webhook.",
                "type":"object"
            },
            "activationDate":{
                "description":"The activation date in ISO format.",
                "type":"string"
            },
            "actualRefundAmount":{
                "description":"Actual Refund Amount at Item level",
                "type":"number"
            },
            "suggestedRefundAmount":{
                "description":"Refund Cost for a returnItem",
                "type":"number"
            },
            "deactivationDate":{
                "description":"The deactivation date in ISO format.",
                "type":"string"
            },
            "nonreturnable":{
                "description":"Indicates whether the item is returnable or not",
                "type":"boolean"
            },
            "displayName":{
                "description":"Display Name of the Product",
                "type":"string"
            },
            "externalData":{
                "description":"External data to be associated with a commerce item, provided by a configurator system.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "values":{
                            "description":"The array of values associated with an externalData item.",
                            "type":"object",
                            "properties":{
                                "dynamic_property_key":{
                                    "description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
                                    "type":"string"
                                }
                            }
                        },
                        "name":{
                            "description":"The name to be associated with the externalData item.",
                            "type":"string"
                        },
                        "actionCode":{
                            "description":"The action code that has been set on the externalData item by the configurator system.",
                            "type":"string"
                        }
                    }
                }
            },
            "orderDiscountShare":{
                "description":"OrderDiscountShare for a returnItem",
                "type":"number"
            },
            "commerceItemId":{
                "description":"Commerce Id of the returned item",
                "type":"string"
            },
            "returnReason":{
                "description":"Reason to return an Item",
                "type":"string"
            },
            "serviceId":{
                "description":"The service ID associated to the current item.",
                "type":"string"
            },
            "nonReturnableReason":{
                "description":"Non returnable reason if item is non returnable",
                "type":"string"
            },
            "serviceAccountId":{
                "description":"The service account ID associated to the current item.",
                "type":"string"
            },
            "quantityToReturn":{
                "description":"Quantity To Return",
                "type":"number"
            },
            "comments":{
                "description":"Comments at ReturnItem Level",
                "type":"string"
            },
            "returnItemId":{
                "description":"Id of the return Item",
                "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"
            },
            "rootAssetKey":{
                "description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
                "type":"string"
            },
            "transactionDate":{
                "description":"ISO formatted Date on which the service action should be triggered.",
                "type":"string"
            },
            "returnRequired":{
                "description":"Boolean value to determine if the item has to be physically received.",
                "type":"boolean"
            },
            "skuProperties":{
                "description":"Sku properties Information",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "propertyType":{
                            "description":"Type that indicates whether it is a base or a custom SKU property,",
                            "type":"string"
                        },
                        "name":{
                            "description":"Name of the Dynamic SKU Property.",
                            "type":"string"
                        },
                        "id":{
                            "description":"ID of the Dynamic SKU Property.",
                            "type":"string"
                        },
                        "value":{
                            "description":"Value of the Dynamic SKU Property.",
                            "type":"string"
                        }
                    }
                }
            },
            "adjustedPromotionReferences":{
                "description":"Reference to the Promotions linked to this returnItem",
                "type":"string"
            },
            "childReturnItems":{
                "description":"List of child return Items",
                "type":"array",
                "items":{
                    "type":"object",
                    "$ref":"#/definitions/childReturnItems_def"
                }
            },
            "asset":{
                "description":"The flag that determines if the current item is an asset or not.",
                "type":"boolean"
            }
        }
    }
}

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.

{
    "description":"state ",
    "type":"object",
    "properties":{
        "displayKey":{
            "description":"Key of returned request status.",
            "type":"string"
        },
        "displayName":{
            "description":"Translated Value of returned request status.",
            "type":"string"
        }
    }
}

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

{
    "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"
        }
    }
}

Nested Schema : trackingNumber

Type: array

Tracking Number of the return request

Show Source

• Array of: string

{
    "description":"Tracking Number of the return request",
    "type":"array",
    "items":{
        "type":"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.

{
    "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"
        }
    }
}

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

{
    "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"
                }
            }
        }
    }
}

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.

{
    "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"
        }
    }
}

Nested Schema : listPriceList

Type: object

Price List for list prices

Show Source

• repositoryId(optional): string
  Repository ID of the list prices

{
    "description":"Price List for list prices",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository ID of the list prices",
            "type":"string"
        }
    }
}

Nested Schema : salePriceList

Type: object

Price List for sale prices

Show Source

• repositoryId(optional): string
  Repository ID of the sale prices

{
    "description":"Price List for sale prices",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository ID of the sale prices",
            "type":"string"
        }
    }
}

Nested Schema : shippingSurchargePriceList

Type: object

Price List for shipping surcharge prices

Show Source

• repositoryId(optional): string
  Repository ID of the shipping surcharge prices

{
    "description":"Price List for shipping surcharge prices",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository ID of the shipping surcharge prices",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "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"
        }
    }
}

Nested Schema : creditCardInfo

Type: object

Credit Card Details.

Show Source

• cardNumber(optional): string
  Credit Card Number

{
    "description":"Credit Card Details.",
    "type":"object",
    "properties":{
        "cardNumber":{
            "description":"Credit Card Number",
            "type":"string"
        }
    }
}

Nested Schema : organization

Type: array

The Organization associated with the B2B customer profile.

Show Source

• Array of: object items

{
    "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"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id(optional): string
  The id of the organization.
• name(optional): string
  The name of of the organization.

{
    "type":"object",
    "properties":{
        "name":{
            "description":"The name of of the organization.",
            "type":"string"
        },
        "id":{
            "description":"The id of the organization.",
            "type":"string"
        }
    }
}

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

{
    "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"
        }
    }
}

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
  Manual Adjustment made.
• orderDiscountShareAdjustment(optional): number
  The adjustment of order discount.
• quantityAdjusted(optional): number
  The number of item adjusted.
• shippingGroupId(optional): string
  Id of the shipping group.
• shippingShareAdjustment(optional): number
  Adjustment made on the shipping group.
• taxShareAdjustment(optional): number
  Adjustment of the applied Tax.

{
    "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"
        }
    }
}

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

{
    "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"
        }
    }
}

Nested Schema : errorInfo

Type: array

the array of errors, if any

Show Source

• Array of: string

{
    "description":"the array of errors, if any",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : notes

Type: array

the notes (history) for the order

Show Source

• Array of: object items

{
    "description":"the notes (history) for the order",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "providerNote":{
                "description":"the provider note for the quoted order",
                "type":"string"
            },
            "profileType":{
                "description":"the profile type of the user that requested the quote",
                "type":"string"
            },
            "profileId":{
                "description":"the profile id of the user",
                "type":"string"
            },
            "rejectionDate":{
                "description":"the rejection date an order whose quote has been rejected by user",
                "type":"number"
            },
            "requestDate":{
                "description":"the date when the quote was requested in ISO format",
                "type":"number"
            },
            "quoteDate":{
                "description":"the date the order was quoted in milliseconds",
                "type":"number"
            },
            "rejectionNote":{
                "description":"the rejection note for an order whose quote has been rejected by user",
                "type":"string"
            },
            "requesterNote":{
                "description":"the requester note",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "providerNote":{
            "description":"the provider note for the quoted order",
            "type":"string"
        },
        "profileType":{
            "description":"the profile type of the user that requested the quote",
            "type":"string"
        },
        "profileId":{
            "description":"the profile id of the user",
            "type":"string"
        },
        "rejectionDate":{
            "description":"the rejection date an order whose quote has been rejected by user",
            "type":"number"
        },
        "requestDate":{
            "description":"the date when the quote was requested in ISO format",
            "type":"number"
        },
        "quoteDate":{
            "description":"the date the order was quoted in milliseconds",
            "type":"number"
        },
        "rejectionNote":{
            "description":"the rejection note for an order whose quote has been rejected by user",
            "type":"string"
        },
        "requesterNote":{
            "description":"the requester note",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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
  ManualAdjustmentShare for a returnItem
• 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
  OrderDiscountShare for a returnItem
• 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

{
    "type":"object",
    "properties":{
        "quantityReturned":{
            "description":"Quantity Returned",
            "type":"number"
        },
        "dynamicProperties":{
            "description":"Array of custom properties at order line item level.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"The ID of the dynamic property.",
                        "type":"string"
                    },
                    "label":{
                        "description":"The label of the dynamic property.",
                        "type":"string"
                    },
                    "value":{
                        "description":"The value of the dynamic property.",
                        "type":"string"
                    }
                }
            }
        },
        "billingProfileId":{
            "description":"The billing profile ID associated to the current item.",
            "type":"string"
        },
        "billingAccountId":{
            "description":"The billing account ID associated to the current item.",
            "type":"string"
        },
        "childItems":{
            "description":"Returned Item child items",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceAccountId":{
                        "description":"The service account ID associated to the current item.",
                        "type":"string"
                    },
                    "deactivationDate":{
                        "description":"The deactivation date in ISO format.",
                        "type":"string"
                    },
                    "quantity":{
                        "description":"quantity of the child Item",
                        "type":"number"
                    },
                    "productId":{
                        "description":"Product Id of teh ",
                        "type":"string"
                    },
                    "displayName":{
                        "description":"Product display name of the sub sku commerce item",
                        "type":"string"
                    },
                    "externalData":{
                        "description":"External data to be associated with a commerce item, provided by a configurator system.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "values":{
                                    "description":"The array of values associated with an externalData item.",
                                    "type":"object",
                                    "properties":{
                                        "dynamic_property_key":{
                                            "description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
                                            "type":"string"
                                        }
                                    }
                                },
                                "name":{
                                    "description":"The name to be associated with the externalData item.",
                                    "type":"string"
                                },
                                "actionCode":{
                                    "description":"The action code that has been set on the externalData item by the configurator system.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "parentAssetKey":{
                        "description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
                        "type":"string"
                    },
                    "billingProfileId":{
                        "description":"The billing profile ID associated to the current item.",
                        "type":"string"
                    },
                    "billingAccountId":{
                        "description":"The billing account ID associated to the current item.",
                        "type":"string"
                    },
                    "rootAssetKey":{
                        "description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
                        "type":"string"
                    },
                    "transactionDate":{
                        "description":"ISO formatted Date on which the service action should be triggered.",
                        "type":"string"
                    },
                    "catRefId":{
                        "description":"Catalog Reference Id of the child Item",
                        "type":"string"
                    },
                    "assetKey":{
                        "description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
                        "type":"string"
                    },
                    "route":{
                        "description":"Product path",
                        "type":"string"
                    },
                    "customerAccountId":{
                        "description":"The customer account ID associated to the current 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"
                                }
                            }
                        }
                    },
                    "actionCode":{
                        "description":"The action code that has been set on the item by the configurator system.",
                        "type":"string"
                    },
                    "activationDate":{
                        "description":"The activation date in ISO format.",
                        "type":"string"
                    },
                    "serviceId":{
                        "description":"The service ID associated to the current item.",
                        "type":"string"
                    },
                    "asset":{
                        "description":"The flag that determines if the current item is an asset or not.",
                        "type":"boolean"
                    }
                }
            }
        },
        "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"
        },
        "assetKey":{
            "description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
            "type":"string"
        },
        "quantityAvailableForReturn":{
            "description":"Quantity Available",
            "type":"number"
        },
        "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"
        },
        "actionCode":{
            "description":"The action code that has been set on the item by the configurator system.",
            "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"
        },
        "productId":{
            "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"
                }
            }
        },
        "parentAssetKey":{
            "description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
            "type":"string"
        },
        "catRefId":{
            "description":"Catalog Reference Id",
            "type":"string"
        },
        "customerAccountId":{
            "description":"The customer account ID associated to the current item.",
            "type":"string"
        },
        "quantityShipped":{
            "description":"Quantity Shipped",
            "type":"number"
        },
        "additionalProperties":{
            "description":"Additional Properties if any returned by webhook.",
            "type":"object"
        },
        "activationDate":{
            "description":"The activation date in ISO format.",
            "type":"string"
        },
        "actualRefundAmount":{
            "description":"Actual Refund Amount at Item level",
            "type":"number"
        },
        "suggestedRefundAmount":{
            "description":"Refund Cost for a returnItem",
            "type":"number"
        },
        "deactivationDate":{
            "description":"The deactivation date in ISO format.",
            "type":"string"
        },
        "nonreturnable":{
            "description":"Indicates whether the item is returnable or not",
            "type":"boolean"
        },
        "displayName":{
            "description":"Display Name of the Product",
            "type":"string"
        },
        "externalData":{
            "description":"External data to be associated with a commerce item, provided by a configurator system.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "values":{
                        "description":"The array of values associated with an externalData item.",
                        "type":"object",
                        "properties":{
                            "dynamic_property_key":{
                                "description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
                                "type":"string"
                            }
                        }
                    },
                    "name":{
                        "description":"The name to be associated with the externalData item.",
                        "type":"string"
                    },
                    "actionCode":{
                        "description":"The action code that has been set on the externalData item by the configurator system.",
                        "type":"string"
                    }
                }
            }
        },
        "orderDiscountShare":{
            "description":"OrderDiscountShare for a returnItem",
            "type":"number"
        },
        "commerceItemId":{
            "description":"Commerce Id of the returned item",
            "type":"string"
        },
        "returnReason":{
            "description":"Reason to return an Item",
            "type":"string"
        },
        "serviceId":{
            "description":"The service ID associated to the current item.",
            "type":"string"
        },
        "nonReturnableReason":{
            "description":"Non returnable reason if item is non returnable",
            "type":"string"
        },
        "serviceAccountId":{
            "description":"The service account ID associated to the current item.",
            "type":"string"
        },
        "quantityToReturn":{
            "description":"Quantity To Return",
            "type":"number"
        },
        "comments":{
            "description":"Comments at ReturnItem Level",
            "type":"string"
        },
        "returnItemId":{
            "description":"Id of the return Item",
            "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"
        },
        "rootAssetKey":{
            "description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
            "type":"string"
        },
        "transactionDate":{
            "description":"ISO formatted Date on which the service action should be triggered.",
            "type":"string"
        },
        "returnRequired":{
            "description":"Boolean value to determine if the item has to be physically received.",
            "type":"boolean"
        },
        "skuProperties":{
            "description":"Sku properties Information",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "propertyType":{
                        "description":"Type that indicates whether it is a base or a custom SKU property,",
                        "type":"string"
                    },
                    "name":{
                        "description":"Name of the Dynamic SKU Property.",
                        "type":"string"
                    },
                    "id":{
                        "description":"ID of the Dynamic SKU Property.",
                        "type":"string"
                    },
                    "value":{
                        "description":"Value of the Dynamic SKU Property.",
                        "type":"string"
                    }
                }
            }
        },
        "adjustedPromotionReferences":{
            "description":"Reference to the Promotions linked to this returnItem",
            "type":"string"
        },
        "childReturnItems":{
            "description":"List of child return Items",
            "type":"array",
            "items":{
                "type":"object",
                "$ref":"#/definitions/childReturnItems_def"
            }
        },
        "asset":{
            "description":"The flag that determines if the current item is an asset or not.",
            "type":"boolean"
        }
    }
}

Nested Schema : additionalProperties

Type: object

Additional Properties if any returned by webhook.

Nested Schema : childItems

Type: array

Returned Item child items

Show Source

• Array of: object items

{
    "description":"Returned Item child items",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "serviceAccountId":{
                "description":"The service account ID associated to the current item.",
                "type":"string"
            },
            "deactivationDate":{
                "description":"The deactivation date in ISO format.",
                "type":"string"
            },
            "quantity":{
                "description":"quantity of the child Item",
                "type":"number"
            },
            "productId":{
                "description":"Product Id of teh ",
                "type":"string"
            },
            "displayName":{
                "description":"Product display name of the sub sku commerce item",
                "type":"string"
            },
            "externalData":{
                "description":"External data to be associated with a commerce item, provided by a configurator system.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "values":{
                            "description":"The array of values associated with an externalData item.",
                            "type":"object",
                            "properties":{
                                "dynamic_property_key":{
                                    "description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
                                    "type":"string"
                                }
                            }
                        },
                        "name":{
                            "description":"The name to be associated with the externalData item.",
                            "type":"string"
                        },
                        "actionCode":{
                            "description":"The action code that has been set on the externalData item by the configurator system.",
                            "type":"string"
                        }
                    }
                }
            },
            "parentAssetKey":{
                "description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
                "type":"string"
            },
            "billingProfileId":{
                "description":"The billing profile ID associated to the current item.",
                "type":"string"
            },
            "billingAccountId":{
                "description":"The billing account ID associated to the current item.",
                "type":"string"
            },
            "rootAssetKey":{
                "description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
                "type":"string"
            },
            "transactionDate":{
                "description":"ISO formatted Date on which the service action should be triggered.",
                "type":"string"
            },
            "catRefId":{
                "description":"Catalog Reference Id of the child Item",
                "type":"string"
            },
            "assetKey":{
                "description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
                "type":"string"
            },
            "route":{
                "description":"Product path",
                "type":"string"
            },
            "customerAccountId":{
                "description":"The customer account ID associated to the current 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"
                        }
                    }
                }
            },
            "actionCode":{
                "description":"The action code that has been set on the item by the configurator system.",
                "type":"string"
            },
            "activationDate":{
                "description":"The activation date in ISO format.",
                "type":"string"
            },
            "serviceId":{
                "description":"The service ID associated to the current item.",
                "type":"string"
            },
            "asset":{
                "description":"The flag that determines if the current item is an asset or not.",
                "type":"boolean"
            }
        }
    }
}

Nested Schema : childReturnItems

Type: array

List of child return Items

Show Source

• Array of: object childReturnItems_def

{
    "description":"List of child return Items",
    "type":"array",
    "items":{
        "type":"object",
        "$ref":"#/definitions/childReturnItems_def"
    }
}

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

{
    "description":"Disposition Reason",
    "type":"object",
    "properties":{
        "displayKey":{
            "description":"Key of the disposition Reason",
            "type":"string"
        },
        "displayName":{
            "description":"Name of the disposition Reason",
            "type":"string"
        }
    }
}

Nested Schema : dynamicProperties

Type: array

Array of custom properties at order line item level.

Show Source

• Array of: object items

{
    "description":"Array of custom properties at order line item level.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"The ID of the dynamic property.",
                "type":"string"
            },
            "label":{
                "description":"The label of the dynamic property.",
                "type":"string"
            },
            "value":{
                "description":"The value of the dynamic property.",
                "type":"string"
            }
        }
    }
}

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a configurator system.

Show Source

• Array of: object items

{
    "description":"External data to be associated with a commerce item, provided by a configurator system.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "values":{
                "description":"The array of values associated with an externalData item.",
                "type":"object",
                "properties":{
                    "dynamic_property_key":{
                        "description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
                        "type":"string"
                    }
                }
            },
            "name":{
                "description":"The name to be associated with the externalData item.",
                "type":"string"
            },
            "actionCode":{
                "description":"The action code that has been set on the externalData item by the configurator system.",
                "type":"string"
            }
        }
    }
}

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

{
    "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"
        }
    }
}

Nested Schema : skuOptionInfo

Type: array

Product Variant Information.

Show Source

• Array of: object items

{
    "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"
            }
        }
    }
}

Nested Schema : skuProperties

Type: array

Sku properties Information

Show Source

• Array of: object items

{
    "description":"Sku properties Information",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "propertyType":{
                "description":"Type that indicates whether it is a base or a custom SKU property,",
                "type":"string"
            },
            "name":{
                "description":"Name of the Dynamic SKU Property.",
                "type":"string"
            },
            "id":{
                "description":"ID of the Dynamic SKU Property.",
                "type":"string"
            },
            "value":{
                "description":"Value of the Dynamic SKU Property.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "serviceAccountId":{
            "description":"The service account ID associated to the current item.",
            "type":"string"
        },
        "deactivationDate":{
            "description":"The deactivation date in ISO format.",
            "type":"string"
        },
        "quantity":{
            "description":"quantity of the child Item",
            "type":"number"
        },
        "productId":{
            "description":"Product Id of teh ",
            "type":"string"
        },
        "displayName":{
            "description":"Product display name of the sub sku commerce item",
            "type":"string"
        },
        "externalData":{
            "description":"External data to be associated with a commerce item, provided by a configurator system.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "values":{
                        "description":"The array of values associated with an externalData item.",
                        "type":"object",
                        "properties":{
                            "dynamic_property_key":{
                                "description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
                                "type":"string"
                            }
                        }
                    },
                    "name":{
                        "description":"The name to be associated with the externalData item.",
                        "type":"string"
                    },
                    "actionCode":{
                        "description":"The action code that has been set on the externalData item by the configurator system.",
                        "type":"string"
                    }
                }
            }
        },
        "parentAssetKey":{
            "description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
            "type":"string"
        },
        "billingProfileId":{
            "description":"The billing profile ID associated to the current item.",
            "type":"string"
        },
        "billingAccountId":{
            "description":"The billing account ID associated to the current item.",
            "type":"string"
        },
        "rootAssetKey":{
            "description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
            "type":"string"
        },
        "transactionDate":{
            "description":"ISO formatted Date on which the service action should be triggered.",
            "type":"string"
        },
        "catRefId":{
            "description":"Catalog Reference Id of the child Item",
            "type":"string"
        },
        "assetKey":{
            "description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
            "type":"string"
        },
        "route":{
            "description":"Product path",
            "type":"string"
        },
        "customerAccountId":{
            "description":"The customer account ID associated to the current 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"
                    }
                }
            }
        },
        "actionCode":{
            "description":"The action code that has been set on the item by the configurator system.",
            "type":"string"
        },
        "activationDate":{
            "description":"The activation date in ISO format.",
            "type":"string"
        },
        "serviceId":{
            "description":"The service ID associated to the current item.",
            "type":"string"
        },
        "asset":{
            "description":"The flag that determines if the current item is an asset or not.",
            "type":"boolean"
        }
    }
}

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a configurator system.

Show Source

• Array of: object items

{
    "description":"External data to be associated with a commerce item, provided by a configurator system.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "values":{
                "description":"The array of values associated with an externalData item.",
                "type":"object",
                "properties":{
                    "dynamic_property_key":{
                        "description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
                        "type":"string"
                    }
                }
            },
            "name":{
                "description":"The name to be associated with the externalData item.",
                "type":"string"
            },
            "actionCode":{
                "description":"The action code that has been set on the externalData item by the configurator system.",
                "type":"string"
            }
        }
    }
}

Nested Schema : selectedOptions

Type: array

Child Product Variant Information.

Show Source

• Array of: object items

{
    "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"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "values":{
            "description":"The array of values associated with an externalData item.",
            "type":"object",
            "properties":{
                "dynamic_property_key":{
                    "description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
                    "type":"string"
                }
            }
        },
        "name":{
            "description":"The name to be associated with the externalData item.",
            "type":"string"
        },
        "actionCode":{
            "description":"The action code that has been set on the externalData item by the configurator system.",
            "type":"string"
        }
    }
}

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.

{
    "description":"The array of values associated with an externalData item.",
    "type":"object",
    "properties":{
        "dynamic_property_key":{
            "description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• optionName(optional): string
  Name of the Dynamic attribute.
• optionValue(optional): string
  Value of the Dynamic attribute.

{
    "type":"object",
    "properties":{
        "optionValue":{
            "description":"Value of the Dynamic attribute.",
            "type":"string"
        },
        "optionName":{
            "description":"Name of the Dynamic attribute.",
            "type":"string"
        }
    }
}

Nested Schema : childReturnItems_def

Type: object

Show Source

• 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
  ManualAdjustmentShare for a returnItem
• 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
  OrderDiscountShare for a returnItem
• 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

{
    "type":"object",
    "properties":{
        "quantityReturned":{
            "description":"Quantity Returned",
            "type":"number"
        },
        "dynamicProperties":{
            "description":"Array of custom properties at order line item level.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"The ID of the dynamic property.",
                        "type":"string"
                    },
                    "label":{
                        "description":"The label of the dynamic property.",
                        "type":"string"
                    },
                    "value":{
                        "description":"The value of the dynamic property.",
                        "type":"string"
                    }
                }
            }
        },
        "billingProfileId":{
            "description":"The billing profile ID associated to the current item.",
            "type":"string"
        },
        "billingAccountId":{
            "description":"The billing account ID associated to the current 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"
        },
        "assetKey":{
            "description":"The assetKey ID associated to the current item.",
            "type":"string"
        },
        "quantityAvailableForReturn":{
            "description":"Quantity Available",
            "type":"number"
        },
        "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"
        },
        "actionCode":{
            "description":"The action code that has been set on the item by the configurator system.",
            "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"
        },
        "productId":{
            "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"
                }
            }
        },
        "parentAssetKey":{
            "description":"The parentAssetKey ID associated to the current item.",
            "type":"string"
        },
        "catRefId":{
            "description":"Catalog Reference Id",
            "type":"string"
        },
        "customerAccountId":{
            "description":"The customer account ID associated to the current item.",
            "type":"string"
        },
        "quantityShipped":{
            "description":"Quantity Shipped",
            "type":"number"
        },
        "additionalProperties":{
            "description":"Additional Properties if any returned by webhook.",
            "type":"object"
        },
        "activationDate":{
            "description":"The activation date in ISO format.",
            "type":"string"
        },
        "actualRefundAmount":{
            "description":"Actual Refund Amount at Item level",
            "type":"number"
        },
        "suggestedRefundAmount":{
            "description":"Refund Cost for a returnItem",
            "type":"number"
        },
        "deactivationDate":{
            "description":"The deactivation date in ISO format.",
            "type":"string"
        },
        "nonreturnable":{
            "description":"Indicates whether the item is returnable or not",
            "type":"boolean"
        },
        "displayName":{
            "description":"Display Name of the Product",
            "type":"string"
        },
        "externalData":{
            "description":"External data to be associated with a commerce item, provided by a configurator system.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "values":{
                        "description":"The array of values associated with an externalData item.",
                        "type":"object",
                        "properties":{
                            "dynamic_property_key":{
                                "description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
                                "type":"string"
                            }
                        }
                    },
                    "name":{
                        "description":"The name to be associated with the externalData item.",
                        "type":"string"
                    },
                    "actionCode":{
                        "description":"The action code that has been set on the externalData item by the configurator system.",
                        "type":"string"
                    }
                }
            }
        },
        "orderDiscountShare":{
            "description":"OrderDiscountShare for a returnItem",
            "type":"number"
        },
        "commerceItemId":{
            "description":"Commerce Id of the returned item",
            "type":"string"
        },
        "assetId":{
            "description":"The asset ID corresponding to the current item.",
            "type":"string"
        },
        "returnReason":{
            "description":"Reason to return an Item",
            "type":"string"
        },
        "serviceId":{
            "description":"The service ID associated to the current item.",
            "type":"string"
        },
        "nonReturnableReason":{
            "description":"Non returnable reason if item is non returnable",
            "type":"string"
        },
        "serviceAccountId":{
            "description":"The service account ID associated to the current item.",
            "type":"string"
        },
        "quantityToReturn":{
            "description":"Quantity To Return",
            "type":"number"
        },
        "comments":{
            "description":"Comments at ReturnItem Level",
            "type":"string"
        },
        "returnItemId":{
            "description":"Id of the return Item",
            "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"
        },
        "rootAssetKey":{
            "description":"The rootAssetKey ID associated to the current item.",
            "type":"string"
        },
        "transactionDate":{
            "description":"ISO formatted Date on which the service action should be triggered.",
            "type":"string"
        },
        "returnRequired":{
            "description":"Boolean value to determine if the item has to be physically received.",
            "type":"boolean"
        },
        "skuProperties":{
            "description":"Sku properties Information",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "propertyType":{
                        "description":"Type that indicates whether it is a base or a custom SKU property,",
                        "type":"string"
                    },
                    "name":{
                        "description":"Name of the Dynamic SKU Property.",
                        "type":"string"
                    },
                    "id":{
                        "description":"ID of the Dynamic SKU Property.",
                        "type":"string"
                    },
                    "value":{
                        "description":"Value of the Dynamic SKU Property.",
                        "type":"string"
                    }
                }
            }
        },
        "adjustedPromotionReferences":{
            "description":"Reference to the Promotions linked to this returnItem",
            "type":"string"
        },
        "childReturnItems":{
            "description":"List of child return Items",
            "type":"array",
            "items":{
                "type":"object",
                "$ref":"#/definitions/childReturnItems_def"
            }
        },
        "asset":{
            "description":"The flag that determines if the current item is an asset or not.",
            "type":"boolean"
        }
    }
}

Nested Schema : additionalProperties

Type: object

Additional Properties if any returned by webhook.

Nested Schema : childReturnItems

Type: array

List of child return Items

Show Source

• Array of: object childReturnItems_def

{
    "description":"List of child return Items",
    "type":"array",
    "items":{
        "type":"object",
        "$ref":"#/definitions/childReturnItems_def"
    }
}

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

{
    "description":"Disposition Reason",
    "type":"object",
    "properties":{
        "displayKey":{
            "description":"Key of the disposition Reason",
            "type":"string"
        },
        "displayName":{
            "description":"Name of the disposition Reason",
            "type":"string"
        }
    }
}

Nested Schema : dynamicProperties

Type: array

Array of custom properties at order line item level.

Show Source

• Array of: object items

{
    "description":"Array of custom properties at order line item level.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"The ID of the dynamic property.",
                "type":"string"
            },
            "label":{
                "description":"The label of the dynamic property.",
                "type":"string"
            },
            "value":{
                "description":"The value of the dynamic property.",
                "type":"string"
            }
        }
    }
}

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a configurator system.

Show Source

• Array of: object items

{
    "description":"External data to be associated with a commerce item, provided by a configurator system.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "values":{
                "description":"The array of values associated with an externalData item.",
                "type":"object",
                "properties":{
                    "dynamic_property_key":{
                        "description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
                        "type":"string"
                    }
                }
            },
            "name":{
                "description":"The name to be associated with the externalData item.",
                "type":"string"
            },
            "actionCode":{
                "description":"The action code that has been set on the externalData item by the configurator system.",
                "type":"string"
            }
        }
    }
}

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

{
    "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"
        }
    }
}

Nested Schema : skuOptionInfo

Type: array

Product Variant Information.

Show Source

• Array of: object items

{
    "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"
            }
        }
    }
}

Nested Schema : skuProperties

Type: array

Sku properties Information

Show Source

• Array of: object items

{
    "description":"Sku properties Information",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "propertyType":{
                "description":"Type that indicates whether it is a base or a custom SKU property,",
                "type":"string"
            },
            "name":{
                "description":"Name of the Dynamic SKU Property.",
                "type":"string"
            },
            "id":{
                "description":"ID of the Dynamic SKU Property.",
                "type":"string"
            },
            "value":{
                "description":"Value of the Dynamic SKU Property.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "id":{
            "description":"The ID of the dynamic property.",
            "type":"string"
        },
        "label":{
            "description":"The label of the dynamic property.",
            "type":"string"
        },
        "value":{
            "description":"The value of the dynamic property.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "values":{
            "description":"The array of values associated with an externalData item.",
            "type":"object",
            "properties":{
                "dynamic_property_key":{
                    "description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
                    "type":"string"
                }
            }
        },
        "name":{
            "description":"The name to be associated with the externalData item.",
            "type":"string"
        },
        "actionCode":{
            "description":"The action code that has been set on the externalData item by the configurator system.",
            "type":"string"
        }
    }
}

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.

{
    "description":"The array of values associated with an externalData item.",
    "type":"object",
    "properties":{
        "dynamic_property_key":{
            "description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• optionName(optional): string
  Name of the Dynamic attribute
• optionValue(optional): string
  Value of the Dynamic attribute

{
    "type":"object",
    "properties":{
        "optionValue":{
            "description":"Value of the Dynamic attribute",
            "type":"string"
        },
        "optionName":{
            "description":"Name of the Dynamic attribute",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "propertyType":{
            "description":"Type that indicates whether it is a base or a custom SKU property,",
            "type":"string"
        },
        "name":{
            "description":"Name of the Dynamic SKU Property.",
            "type":"string"
        },
        "id":{
            "description":"ID of the Dynamic SKU Property.",
            "type":"string"
        },
        "value":{
            "description":"Value of the Dynamic SKU Property.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "id":{
            "description":"The ID of the dynamic property.",
            "type":"string"
        },
        "label":{
            "description":"The label of the dynamic property.",
            "type":"string"
        },
        "value":{
            "description":"The value of the dynamic property.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "values":{
            "description":"The array of values associated with an externalData item.",
            "type":"object",
            "properties":{
                "dynamic_property_key":{
                    "description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
                    "type":"string"
                }
            }
        },
        "name":{
            "description":"The name to be associated with the externalData item.",
            "type":"string"
        },
        "actionCode":{
            "description":"The action code that has been set on the externalData item by the configurator system.",
            "type":"string"
        }
    }
}

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.

{
    "description":"The array of values associated with an externalData item.",
    "type":"object",
    "properties":{
        "dynamic_property_key":{
            "description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• optionName(optional): string
  Name of the Dynamic attribute
• optionValue(optional): string
  Value of the Dynamic attribute

{
    "type":"object",
    "properties":{
        "optionValue":{
            "description":"Value of the Dynamic attribute",
            "type":"string"
        },
        "optionName":{
            "description":"Name of the Dynamic attribute",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "propertyType":{
            "description":"Type that indicates whether it is a base or a custom SKU property,",
            "type":"string"
        },
        "name":{
            "description":"Name of the Dynamic SKU Property.",
            "type":"string"
        },
        "id":{
            "description":"ID of the Dynamic SKU Property.",
            "type":"string"
        },
        "value":{
            "description":"Value of the Dynamic SKU Property.",
            "type":"string"
        }
    }
}

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

{
    "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"
            }
        }
    }
}

Nested Schema : productIds

Type: array

list of product id's

Show Source

• Array of: string

{
    "description":"list of product id's",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : skuIds

Type: array

list of sku id's

Show Source

• Array of: string

{
    "description":"list of sku id's",
    "type":"array",
    "items":{
        "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| |------------------|------------------| |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|

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top