addedInput schema / properties / body
Added value: +{
+ "additionalProperties": false,
+ "properties": {
+ "comment": {
+ "description": "Optional comment about the refund",
+ "type": "string"
+ },
+ "orderLevelRefundAmount": {
+ "$ref": "#/properties/body/properties/refundItems/items/properties/refundAmount",
+ "description": "Order-level refund amount (for partial refunds)"
+ },
+ "reasonForRefund": {
+ "description": "Reason for issuing the refund",
+ "enum": [
+ "BUYER_CANCEL",
+ "OUT_OF_STOCK",
+ "FOUND_CHEAPER_PRICE",
+ "INCORRECT_PRICE",
+ "ITEM_DAMAGED",
+ "ITEM_DEFECTIVE",
+ "LOST_IN_TRANSIT",
+ "MUTUALLY_AGREED",
+ "SELLER_CANCEL"
+ ],
+ "type": "string"
+ },
+ "refundItems": {
+ "description": "Line items to refund",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "legacyReference": {
+ "additionalProperties": false,
+ "properties": {
+ "legacyItemId": {
+ "type": "string"
+ },
+ "legacyTransactionId": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "lineItemId": {
+ "type": "string"
+ },
+ "refundAmount": {
+ "additionalProperties": false,
+ "properties": {
+ "convertedFromCurrency": {
+ "type": "string"
+ },
+ "convertedFromValue": {
+ "type": "string"
+ },
+ "currency": {
+ "type": "string"
+ },
+ "exchangeRate": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "currency",
+ "value"
+ ],
+ "type": "object"
+ }
+ },
+ "required": [
+ "lineItemId"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "reasonForRefund"
+ ],
+ "type": "object"
+}
removedInput schema / properties / refundData
Removed value: -{
- "additionalProperties": false,
- "description": "Refund details including amount, reason, and optional comment. Must include reasonForRefund (required), and either refundItems (for line item refunds) OR orderLevelRefundAmount (for full order refunds).",
- "properties": {
- "comment": {
- "description": "Optional comment to buyer about the refund (max 100 characters)",
- "type": "string"
- },
- "orderLevelRefundAmount": {
- "additionalProperties": false,
- "description": "Use this to refund the entire order amount. Alternative to refundItems. Include value and currency.",
- "properties": {
- "currency": {
- "description": "Three-letter ISO 4217 currency code (e.g., \"USD\")",
- "type": "string"
- },
- "value": {
- "description": "The monetary amount (e.g., \"99.99\")",
- "type": "string"
- }
- },
- "required": [
- "value",
- "currency"
- ],
- "type": "object"
- },
- "reasonForRefund": {
- "description": "REQUIRED. Reason code: BUYER_CANCEL, OUT_OF_STOCK, FOUND_CHEAPER_PRICE, INCORRECT_PRICE, ITEM_DAMAGED, ITEM_DEFECTIVE, LOST_IN_TRANSIT, MUTUALLY_AGREED, SELLER_CANCEL",
- "type": "string"
- },
- "refundItems": {
- "description": "Array of individual line items to refund. Use this for partial refunds of specific items. Each item requires lineItemId and refundAmount.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "legacyReference": {
- "additionalProperties": false,
- "description": "Optional legacy item ID/transaction ID pair for identifying the line item",
- "properties": {
- "legacyItemId": {
- "type": "string"
- },
- "legacyTransactionId": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "lineItemId": {
- "description": "The unique identifier of the order line item to refund",
- "type": "string"
- },
- "refundAmount": {
- "additionalProperties": false,
- "description": "The amount to refund for this line item",
- "properties": {
- "currency": {
- "description": "Three-letter ISO 4217 currency code (e.g., \"USD\")",
- "type": "string"
- },
- "value": {
- "description": "The monetary amount (e.g., \"25.99\")",
- "type": "string"
- }
- },
- "required": [
- "value",
- "currency"
- ],
- "type": "object"
- }
- },
- "required": [
- "lineItemId"
- ],
- "type": "object"
- },
- "type": "array"
- }
- },
- "required": [
- "reasonForRefund"
- ],
- "type": "object"
-}