eBay · Schema

IssueRefundRequest

The base type used by the request payload of the issueRefund method.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
reasonForRefund string The enumeration value passed into this field indicates the reason for the refund. One of the defined enumeration values in the ReasonForRefundEnum type must be used.

This field is requir
comment string This free-text field allows the seller to clarify why the refund is being issued to the buyer.

Max Length: 100
refundItems array The refundItems array is only required if the seller is issuing a refund for one or more individual order line items in a multiple line item order. Otherwise, the seller just uses the orderL
orderLevelRefundAmount object This container is used to specify the amount of the refund for the entire order. If a seller wants to issue a refund for an individual line item within a multiple line item order, the seller would use
View JSON Schema on GitHub

JSON Schema

ebay-issuerefundrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/IssueRefundRequest",
  "title": "IssueRefundRequest",
  "type": "object",
  "properties": {
    "reasonForRefund": {
      "type": "string",
      "description": "The enumeration value passed into this field indicates the reason for the refund. One of the defined enumeration values in the <b>ReasonForRefundEnum</b> type must be used.<br><br>This field is required, and it is highly recommended that sellers use the correct refund reason, especially in the case of a buyer-requested cancellation or 'buyer remorse' return to indicate that there was nothing wrong with the item(s) or with the shipment of the order.<br><br><span class=\"tablenote\"><strong>Note:</strong> If issuing refunds for more than one order line item, keep in mind that the refund reason must be the same for each of the order line items. If the refund reason is different for one or more order line items in an order, the seller would need to make separate <b>issueRefund</b> calls, one for each refund reason. </span> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/api:ReasonForRefundEnum'>eBay API documentation</a>"
    },
    "comment": {
      "type": "string",
      "description": "This free-text field allows the seller to clarify why the refund is being issued to the buyer.<br><br><b>Max Length</b>: 100"
    },
    "refundItems": {
      "type": "array",
      "description": "The <b>refundItems</b> array is only required if the seller is issuing a refund for one or more individual order line items in a multiple line item order. Otherwise, the seller just uses the <b>orderLevelRefundAmount</b> container to specify the amount of the refund for the entire order.",
      "items": {
        "$ref": "#/components/schemas/RefundItem"
      }
    },
    "orderLevelRefundAmount": {
      "description": "This container is used to specify the amount of the refund for the entire order. If a seller wants to issue a refund for an individual line item within a multiple line item order, the seller would use the <b>refundItems</b> array instead.",
      "$ref": "#/components/schemas/SimpleAmount"
    }
  },
  "description": "The base type used by the request payload of the <b>issueRefund</b> method."
}