eBay · Schema

Offers

This type is used by the base response of the getOffers call, and it is an array of one or more of the seller's offers, along with pagination data.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
href string This is the URL to the current page of offers.
limit integer This integer value is the number of offers that will be displayed on each results page.
next string This is the URL to the next page of offers. This field will only be returned if there are additional offers to view.
offers array This container is an array of one or more of the seller's offers for the SKU value that is passed in through the required sku query parameter.

prev string This is the URL to the previous page of offers. This field will only be returned if there are previous offers to view.
size integer This integer value indicates the number of offers being displayed on the current page of results. This number will generally be the same as the limit value if there are additional pag
total integer This integer value is the total number of offers that exist for the specified SKU value. Based on this number and on the limit value, the seller may have to toggle through multiple pa
View JSON Schema on GitHub

JSON Schema

ebay-offers-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Offers",
  "title": "Offers",
  "type": "object",
  "properties": {
    "href": {
      "type": "string",
      "description": "This is the URL to the current page of offers."
    },
    "limit": {
      "type": "integer",
      "description": "This integer value is the number of offers that will be displayed on each results page.",
      "format": "int32"
    },
    "next": {
      "type": "string",
      "description": "This is the URL to the next page of offers. This field will only be returned if there are additional offers to view."
    },
    "offers": {
      "type": "array",
      "description": "This container is an array of one or more of the seller's offers for the SKU value that is passed in through the required <strong>sku</strong> query parameter.<br><br> <span class=\"tablenote\"> <strong>Note:</strong> Currently, the Inventory API does not support the same SKU across multiple eBay marketplaces.</span><br><strong>Max Occurs:</strong> 25",
      "items": {
        "$ref": "#/components/schemas/EbayOfferDetailsWithAll"
      }
    },
    "prev": {
      "type": "string",
      "description": "This is the URL to the previous page of offers. This field will only be returned if there are previous offers to view."
    },
    "size": {
      "type": "integer",
      "description": "This integer value indicates the number of offers being displayed on the current page of results. This number will generally be the same as the <strong>limit</strong> value if there are additional pages of results to view.  <br><br><span class=\"tablenote\"><strong>Note:</strong> The same SKU can be offered through an auction and a fixed-price listing concurrently. If this is the case, <b>getOffers</b> will return two offers and this value will be <code>2</code>. Otherwise, only one offer will be returned and this value will be <code>1</code>.</span>",
      "format": "int32"
    },
    "total": {
      "type": "integer",
      "description": "This integer value is the total number of offers that exist for the specified SKU value. Based on this number and on the <strong>limit</strong> value, the seller may have to toggle through multiple pages to view all offers. <br><br><span class=\"tablenote\"><strong>Note:</strong> The same SKU can be offered through an auction and a fixed-price listing concurrently. If this is the case, <b>getOffers</b> will return two offers, so this value would be <code>2</code>. Otherwise, only one offer will be returned and this value will be <code>1</code>.</span>",
      "format": "int32"
    }
  },
  "description": "This type is used by the base response of the <strong>getOffers</strong> call, and it is an array of one or more of the seller's offers, along with pagination data."
}