eBay · Schema

Amount

A complex type that describes the value of a monetary amount as represented by a global currency. When passing in an amount in a request payload, both currency and value fields are required, and both fields are also always returned for an amount in a response field.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name	Type	Description
currency	string	The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter
value	string	The monetary amount in the specified currency.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Amount",
  "title": "Amount",
  "type": "object",
  "properties": {
    "currency": {
      "type": "string",
      "description": "The base currency applied to the <b>value</b> field to establish a monetary amount.  <br><br>The currency is represented as a 3-letter <a href=\"https://www.iso.org/iso-4217-currency-codes.html \" title=\"https://www.iso.org \" target=\"_blank\">ISO 4217</a> currency code. For example, the code for the Canadian Dollar is <code>CAD</code>.<br><br><b>Default:</b> The default currency of the eBay marketplace that hosts the listing. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:CurrencyCodeEnum'>eBay API documentation</a>"
    },
    "value": {
      "type": "string",
      "description": "The monetary amount in the specified <b>currency</b>."
    }
  },
  "description": "A complex type that describes the value of a monetary amount as represented by a global currency. When passing in an amount in a request payload, both <b>currency</b> and <b>value</b> fields are required, and both fields are also always returned for an amount in a response field."
}