eBay · Schema

ConvertedAmount

This type defines the monetary value of an amount. It can provide the amount in both the currency used on the eBay site where an item is being offered and the conversion of that value into another currency, if applicable.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name	Type	Description
convertedFromCurrency	string	The three-letter ISO 4217 code representing the currency of the amount in the `convertedFromValue` field. Thi
convertedFromValue	string	The monetary amount before any conversion is performed, in the currency specified by the `convertedFromCurrency` field. This value is required or returned only if currency conversion/locali
currency	string	The three-letter ISO 4217 code representing the currency of the amount in the `value` field. If currency conv
value	string	The monetary amount in the currency specified by the `currency` field. If currency conversion/localization is required, this value is the converted amount, and the `convertedFromValue<`

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ConvertedAmount",
  "title": "ConvertedAmount",
  "type": "object",
  "properties": {
    "convertedFromCurrency": {
      "type": "string",
      "description": "The three-letter <a href=\"https://www.iso.org/iso-4217-currency-codes.html \" target=\"_blank\">ISO 4217</a> code representing the currency of the amount in the <code>convertedFromValue</code> field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:CurrencyCodeEnum'>eBay API documentation</a>"
    },
    "convertedFromValue": {
      "type": "string",
      "description": "The monetary amount before any conversion is performed, in the currency specified by the <code>convertedFromCurrency</code> field. This value is required or returned only if currency conversion/localization is required. The <code>value</code> field contains the converted amount of this value, in the currency specified by the <code>currency</code> field."
    },
    "currency": {
      "type": "string",
      "description": "The three-letter <a href=\"https://www.iso.org/iso-4217-currency-codes.html \" target=\"_blank\">ISO 4217</a> code representing the currency of the amount in the <code>value</code> field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the <code>value</code> field.<br><br><b>Default:</b> The currency of the authenticated user's country. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:CurrencyCodeEnum'>eBay API documentation</a>"
    },
    "value": {
      "type": "string",
      "description": "The monetary amount in the currency specified by the <code>currency</code> field. If currency conversion/localization is required, this value is the converted amount, and the <code>convertedFromValue</code> field contains the amount in the original currency."
    }
  },
  "description": "This type defines the monetary value of an amount. It can provide the amount in both the currency used on the eBay site where an item is being offered and the conversion of that value into another currency, if applicable."
}