eBay · Schema
EstimatedAvailability
The type that defines the fields for the estimated item availability information.
AuctionsCommerceProductsMarketplaceFortune 500
Properties
| Name | Type | Description |
|---|---|---|
| availabilityThreshold | integer | This field is return only when the seller sets their 'display item quantity' preference to Display "More than 10 available" in your listing (if applicable) |
| availabilityThresholdType | string | This field is return only when the seller sets their Display Item Quantity preference to Display "More than 10 available" in your listing (if applicabl |
| deliveryOptions | array | An array of available delivery options. Valid Values: SHIP_TO_HOME, SELLER_ARRANGED_LOCAL_PICKUP, IN_STORE_PICKUP, PICKUP_DROP_OFF, or DIGITAL_DELIVERY Code so that your app g |
| estimatedAvailabilityStatus | string | An enumeration value representing the inventory status of this item. Note: Be sure to review the itemEndDate field to determine whether the item is availa |
| estimatedAvailableQuantity | integer | The estimated number of this item that are available for purchase. Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity. So instead o |
| estimatedSoldQuantity | integer | The estimated number of this item that have been sold. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/EstimatedAvailability",
"title": "EstimatedAvailability",
"type": "object",
"properties": {
"availabilityThreshold": {
"type": "integer",
"description": "This field is return only when the seller sets their '<a href=\"#display-item-quantity\">display item quantity</a>' preference to <b> Display \"More than 10 available\" in your listing (if applicable)</b>. The value of this field will be \"10\", which is the threshold value. <br><br>Code so that your app gracefully handles any future changes to this value.",
"format": "int32"
},
"availabilityThresholdType": {
"type": "string",
"description": "<a name=\"display-item-quantity\"></a> This field is return only when the seller sets their <b> Display Item Quantity</b> preference to <b> Display \"More than 10 available\" in your listing (if applicable)</b>. The value of this field will be <code> MORE_THAN</code>. This indicates that the seller has more than the 'quantity display preference', which is 10, in stock for this item. <br><br> The following are the display item quantity preferences the seller can set. <br><ul><li> <b> Display \"More than 10 available\" in your listing (if applicable) </b><ul> <li>If the seller enables this preference, this field is returned as long as there are more than 10 of this item in inventory.</li> <li> If the quantity is equal to 10 or drops below 10, this field is not returned and the estimated quantity of the item is returned in the <b> estimatedAvailableQuantity</b> field.</li></ul> </li> <li> <b> Display the exact quantity in your items</b> <br>If the seller enables this preference, the <b> availabilityThresholdType</b> and <b> availabilityThreshold</b> fields are not returned and the estimated quantity of the item is returned in the <b> estimatedAvailableQuantity</b> field.<br><br><b> Note: </b> Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity. </li></ul> <br>Code so that your app gracefully handles any future changes to these preferences. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:AvailabilityThresholdEnum'>eBay API documentation</a>"
},
"deliveryOptions": {
"type": "array",
"description": "An array of available delivery options. <br><br><b> Valid Values: </b> SHIP_TO_HOME, SELLER_ARRANGED_LOCAL_PICKUP, IN_STORE_PICKUP, PICKUP_DROP_OFF, or DIGITAL_DELIVERY <br><br>Code so that your app gracefully handles any future changes to this list. ",
"items": {
"type": "string",
"description": " For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:DeliveryOptionsEnum'>eBay API documentation</a>"
}
},
"estimatedAvailabilityStatus": {
"type": "string",
"description": "An enumeration value representing the inventory status of this item.<br><br><span class=\"tablenote\"><b> Note: </b>Be sure to review the <b>itemEndDate</b> field to determine whether the item is available for purchase.</span><br><br><b> Valid Values: </b> IN_STOCK, LIMITED_STOCK, or OUT_OF_STOCK <br><br>Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:AvailabilityStatusEnum'>eBay API documentation</a>"
},
"estimatedAvailableQuantity": {
"type": "integer",
"description": "The estimated number of this item that are available for purchase. Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity. So instead of returning quantity, the estimated availability of the item is returned.",
"format": "int32"
},
"estimatedSoldQuantity": {
"type": "integer",
"description": "The estimated number of this item that have been sold.",
"format": "int32"
}
},
"description": "The type that defines the fields for the estimated item availability information."
}