eBay · Schema

RefundItem

This type is used 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 orderLevelRefundAmount container to specify the amount of the refund for the entire order.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
refundAmount object This container is used to specify the amount of the refund for the corresponding order line item. If a seller wants to issue a refund for an entire order, the seller would use the orderLevelRefundA
lineItemId string The unique identifier of an order line item. This identifier is created once a buyer purchases a 'Buy It Now' item or if an auction listing ends with a winning bidder.

Either this field or the
legacyReference object This container is needed if the seller is issuing a refund for an individual order line item, and wishes to use an item ID/transaction ID pair to identify the order line item.

Either this conta
View JSON Schema on GitHub

JSON Schema

ebay-refunditem-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RefundItem",
  "title": "RefundItem",
  "type": "object",
  "properties": {
    "refundAmount": {
      "description": "This container is used to specify the amount of the refund for the corresponding order line item. If a seller wants to issue a refund for an entire order, the seller would use the <b>orderLevelRefundAmount</b> container instead.",
      "$ref": "#/components/schemas/SimpleAmount"
    },
    "lineItemId": {
      "type": "string",
      "description": "The unique identifier of an order line item. This identifier is created once a buyer purchases a 'Buy It Now' item or if an auction listing ends with a winning bidder.<br><br>Either this field or the <b>legacyReference</b> container is needed to identify an individual order line item that will receive a refund.<br><br> This value is returned using the <a href=\"/api-docs/sell/fulfillment/resources/order/methods/getOrders\" target=\"_blank \">getOrders</a> method."
    },
    "legacyReference": {
      "description": "This container is needed if the seller is issuing a refund for an individual order line item, and wishes to use an item ID/transaction ID pair to identify the order line item.<br><br>Either this container or the <b>lineItemId</b> field is needed to identify an individual order line item that will receive a refund. <br><br><span class=\"tablenote\"><strong>Note:</strong> This container should <b>only</b> be used if a seller is using the <a href=\"/devzone/xml/docs/reference/ebay/getorders.html\" target=\"_blank \">GetOrders</a> method of the <b>Trading API</b>.</span>",
      "$ref": "#/components/schemas/LegacyReference"
    }
  },
  "description": "This type is used 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."
}