Restrictions
For a list of supported sites and other restrictions, refer to Buy APIs Requirements.
eBay Partner Network: In order to be commissioned for your sales, you must use the URL returned in the
itemAffiliateWebUrl field to forward your buyer to the ebay.com site.",
"operationId": "getItemByLegacyId",
"parameters": [
{
"name": "fieldgroups",
"in": "query",
"description": "This field controls what is returned in the response. If this field is not set, the method returns all details about the item. Multiple fieldgroups can be set.Valid Values:
- PRODUCT
This field group adds the product container to the response. - ADDITIONAL_SELLER_DETAILS
This field group adds the userId field to the response. - CHARITY_DETAILS
This field group adds the charityTerms container to the response, if applicable.
Note: When passing in the ID for a multi-variation listing, you must also use the
legacy_variation_id field and pass in the ID of the specific item variation. If not, all variation within the multi-SKU listing will be retrieved.The following is an example of using the value of the ItemID field for a specific item to get the RESTful
itemId value.browse/v1/item/get_item_by_legacy_id?legacy_item_id=1**********9Important! A legacy_item_id value must always be passed in when specifying a legacy_variation_id value.
The following is an example of using the value of the
ItemID and SKU fields to get the RESTful itemId value.browse/v1/item/get_item_by_legacy_id?legacy_item_id=1**********9&legacy_variation_sku=V**********MImportant! A legacy_item_id value must always be passed in when specifying a legacy_variation_sku value.
- To retrieve the itemAffiliateWebUrl field in the response, the ePN affiliate can pass in their affiliate credentials using this header. For more information, see Header for affiliate information.
- If the listing is using calculated or flat-rate shipping with shipping rate tables, the user can use this header to provide country and postal code in order for the shippingOption container, which includes shipping costs and delivery estimates, to be returned. For more information, see Header for shipping information accuracy.
Note: If the marketplace ID value is invalid or missing, the default value of
EBAY_US is used.See MarketplaceIdEnum for a list of supported marketplaces.
Default:
EBAY_US",
"required": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
},
{
"name": "Accept-Language",
"in": "header",
"description": "This header is used to indicate the natural language and locale preferred by the user for the response.This header is required when targeting a specific locale of a marketplace that supports multiple locales. For example:
- When targeting the French locale of the Belgium marketplace, it is required to pass in
fr-BEto specify this. If this locale is not specified, the language will default to Dutch. - When targeting the French locale of the Canadian marketplace, it is required to pass in
fr-CAto specify this. If this locale is not specified, the language will default to English.
This value must be a positive integer value and should not exceed the quantity available in the listing. This field is not recommended for auction listings, as they will always have a quantity of 1.", "required": false, "schema": { "type": "integer" }, "style": "form", "explode": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Item" } } }, "x-response-codes": { "errors": { "11502": { "domain": "API_BROWSE", "category": "APPLICATION", "description": "There was a problem extracting product information for this Item. Please try again." }, "11508": { "domain": "API_BROWSE", "category": "APPLICATION", "description": "This seller is currently away. If you make a purchase, please allow additional time for your order to be processed." }, "11509": { "domain": "API_BROWSE", "category": "APPLICATION", "description": "This seller is currently away until {sellerReturnDate}. If you make a purchase, please allow additional time for your order to be processed." }, "11510": { "domain": "API_BROWSE", "category": "APPLICATION", "description": "There was a problem calculating the shipping cost. Please try again." } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "11003": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The specified legacy item ID was not found." }, "11004": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The item is not available for purchase. This can be for many reasons, such as when the listing is being updated by the seller. Wait a few minutes and try the call again." }, "11006": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The legacy ID is invalid. Use {itemGroupHref} to get the item group details." }, "11009": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The legacy variation sku is invalid." }, "11010": { "domain": "API_BROWSE", "category": "REQUEST", "description": "You cannot submit legacy_variation_sku and legacy_variation_id in the same request. For help, see the documentation." }, "11011": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The marketplace value {marketplaceId} is not supported. The supported values are: {allowedMarketplaces}" }, "11019": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The quantity_for_shipping_estimate value {quantityForShippingEstimate} is invalid. Please enter a positive value." }, "11020": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The X-EBAY-C-ENDUSERCTX header value is in an invalid format. Please ensure that all values are key=value pairs." }, "11501": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The 'fieldgroups' value(s) are invalid: {fieldgroups}. The supported fieldgroups are: {supportedFieldgroups}." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "11003": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The specified legacy item ID was not found." } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "11004": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The item is not available for purchase. This can be for many reasons, such as when the listing is being updated by the seller. Wait a few minutes and try the call again." }, "11011": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The marketplace value {marketplaceId} is not supported. The supported values are: {allowedMarketplaces}." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "11000": { "domain": "API_BROWSE", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/item": { "get": { "tags": [ "item" ], "description": "This method retrieves the details about specific items that buyers need to make a purchasing decision.
Note: This is a
![\"Limited](\"/cms/img/docs/partners-api.svg\" "\\"Limited")
(Limited Release) available only to select Partners.For this method, only the following fields are returned:
bidCount, currentBidPrice, eligibleForInlineCheckout, enabledForGuestCheckout, estimatedAvailabilities, gtin, immediatePay, itemAffiliateWebUrl, itemCreationDate, itemEndDate, itemId, itemWebUrl, legacyItemId, minimumPriceToBid, price, priorityListing, reservePriceMet, sellerItemRevision, taxes, topRatedBuyingExperience, and uniqueBidderCount.The array
shippingOptions, which comprises multiple fields, is also returned if the X-EBAY-C-ENDUSERCTX header is supplied.Restrictions
For a list of supported sites and other restrictions, refer to Buy APIs Requirements.
eBay Partner Network: In order to be commissioned for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.", "operationId": "getItems", "parameters": [ { "name": "item_ids", "in": "query", "description": "A comma separated list of the unique identifiers of the items to retrieve (maximum 20).
Note: In any given request, either
item_ids or item_group_ids can be retrieved. Attempting to retrieve both will result in an error.RESTful Item ID Format:
v1|#|#For a single SKU listing, pass in the item ID:
v1|2**********2|0For a multi-SKU listing, pass in the identifier of the variation:
v1|1**********2|4**********2
For more information about item IDs for RESTful APIs, refer to Item ID legacy API compatibility overview in the Buying Integration Guide.", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "item_group_ids", "in": "query", "description": "A comma separated list of the unique identifiers of the item groups being retrieved (maximum 10).
Note: In any given request, either
item_ids or item_group_ids can be retrieved. Attempting to retrieve both will result in an error.RESTful Group Item ID Format:
############For example:
3**********9", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "X-EBAY-C-ENDUSERCTX", "in": "header", "description": "This header is can be used in following two situations:
- To retrieve the itemAffiliateWebUrl field in the response, the ePN affiliate can pass in their affiliate credentials using this header. For more information, see Header for affiliate information.
- If the listing is using calculated or flat-rate shipping with shipping rate tables, the user can use this header to provide country and postal code in order for the shippingOption container, which includes shipping costs and delivery estimates, to be returned. For more information, see Header for shipping information accuracy.
Note: If the marketplace ID value is invalid or missing, the default value of
EBAY_US is used.See MarketplaceIdEnum for a list of supported marketplaces.
Default:
EBAY_US",
"required": false,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "Accept-Language",
"in": "header",
"description": "This header is used to indicate the natural language and locale preferred by the user for the response.This header is required when targeting a specific locale of a marketplace that supports multiple locales. For example:
- When targeting the French locale of the Belgium marketplace, it is required to pass in
fr-BEto specify this. If this locale is not specified, the language will default to Dutch. - When targeting the French locale of the Canadian marketplace, it is required to pass in
fr-CAto specify this. If this locale is not specified, the language will default to English.
This value must be a positive integer value and should not exceed the quantity available in the listing. This field is not recommended for auction listings, as they will always have a quantity of 1.", "required": false, "style": "form", "explode": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } } }, "x-response-codes": { "errors": { "11502": { "domain": "API_BROWSE", "category": "APPLICATION", "description": "There was a problem extracting product information for this item. Please try again." }, "11508": { "domain": "API_BROWSE", "category": "APPLICATION", "description": "This seller is currently away. If you make a purchase, please allow additional time for your order to be processed." }, "11509": { "domain": "API_BROWSE", "category": "APPLICATION", "description": "This seller is currently away until {sellerReturnDate}. If you make a purchase, please allow additional time for your order to be processed." }, "11510": { "domain": "API_BROWSE", "category": "APPLICATION", "description": "There was a problem calculating the shipping cost. Please try again." } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "11005": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The item group ID is invalid. Use {itemHref} to get the item details." }, "11012": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The specified item IDs are invalid, or the format of the specified values are invalid." }, "11013": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The specified group IDs are invalid, or the format of the specified values are invalid." }, "11014": { "domain": "API_BROWSE", "category": "REQUEST", "description": "An item_ids and an item_group_ids list cannot be used at same time. Please use only one of these lists." }, "11015": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The maximum number of item IDs has been exceeded. Please reduce the number of item IDs to {maxAllowedItemIds} or less." }, "11016": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The maximum number of item group IDs has been exceeded. Please reduce the number of item group ids to {maxAllowedItemGroupIds} or less." }, "11017": { "domain": "API_BROWSE", "category": "REQUEST", "description": "An item_ids or an item_group_ids list is required. Please use one of these lists." }, "11019": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The quantity_for_shipping_estimate value {quantityForShippingEstimate} is invalid. Please enter a positive value." }, "11020": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The X-EBAY-C-ENDUSERCTX header value is in an invalid format. Please ensure that all values are key=value pairs." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "11001": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The specified item ID was not found." }, "11002": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The specified item group was not found." } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "11004": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The item group is not available. This can be for many reasons, such as when the listing is being updated by the seller. Wait a few minutes and try the call again." }, "11008": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The item group is not available. This can be for many reasons, such as when the listing is being updated by the seller. Wait a few minutes and try the call again." }, "11011": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The marketplace value {marketplaceId} is not supported. The supported values are: {allowedMarketplaces}." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "11000": { "domain": "API_BROWSE", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/buy.item.bulk" ] } ] } }, "/item/get_items_by_item_group": { "get": { "tags": [ "item" ], "description": "This method retrieves details about individual items in an item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.
You pass in the item_group_id as a URI parameter.
This method returns two main containers:
- items
This container has an array of containers with the details about each item in the group. - commonDescriptions
This container has an array of containers for a description and theitem_idsfor all items that have this exact description. Because items within an item group often have the same description, this decreases the size of the response.
ADDITIONAL_SELLER_DETAILS adds an additional field to the response that returns the seller's user ID. Setting the fieldgroup to CHARITY_DETAILS adds additional fields to the response that returns charity information associated with the item, if applicable. For more information, refer to fieldgroups.Restrictions
For a list of supported sites and other restrictions, refer to Buy APIs Restrictions.
eBay Partner Network: In order to be commissioned for your sales, you must use the URL returned in the
itemAffiliateWebUrl field to forward your buyer to the ebay.com site.",
"operationId": "getItemsByItemGroup",
"parameters": [
{
"name": "fieldgroups",
"in": "query",
"description": "This field controls what is returned in the response. If this field is not set, the method returns all details about the item.Valid Values:
ADDITIONAL_SELLER_DETAILS - This field group adds the userId field to the response.
CHARITY_DETAILS - This field group adds the charityTerms container to the response, if applicable.", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true }, { "name": "item_group_id", "in": "query", "description": "This query parameter specifies the unique identifier of an item group for which information is to be returned. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.
This ID is returned in the itemGroupHref field of the search and getItem methods.
For Example:
https://api.ebay.com/buy/browse/v1/item/get_items_by_item_group?item_group_id=3**********6", "required": true, "schema": { "type": "string" }, "style": "form", "explode": true }, { "name": "X-EBAY-C-ENDUSERCTX", "in": "header", "description": "This header is can be used in following two situations:
- To retrieve the itemAffiliateWebUrl field in the response, the ePN affiliate can pass in their affiliate credentials using this header. For more information, see Header for affiliate information.
- If the listing is using calculated or flat-rate shipping with shipping rate tables, the user can use this header to provide country and postal code in order for the shippingOption container, which includes shipping costs and delivery estimates, to be returned. For more information, see Header for shipping information accuracy.
Note: If the marketplace ID value is invalid or missing, the default value of
EBAY_US is used.See MarketplaceIdEnum for a list of supported marketplaces.
Default:
EBAY_US",
"required": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
},
{
"name": "Accept-Language",
"in": "header",
"description": "This header is used to indicate the natural language and locale preferred by the user for the response.This header is required when targeting a specific locale of a marketplace that supports multiple locales. For example:
- When targeting the French locale of the Belgium marketplace, it is required to pass in
fr-BEto specify this. If this locale is not specified, the language will default to Dutch. - When targeting the French locale of the Canadian marketplace, it is required to pass in
fr-CAto specify this. If this locale is not specified, the language will default to English.
This value must be a positive integer value and should not exceed the quantity available in the listing. This field is not recommended for auction listings, as they will always have a quantity of 1.", "required": false, "schema": { "type": "integer" }, "style": "form", "explode": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemGroup" } } }, "x-response-codes": { "errors": { "11508": { "domain": "API_BROWSE", "category": "APPLICATION", "description": "This seller is currently away. If you make a purchase, please allow additional time for your order to be processed." }, "11509": { "domain": "API_BROWSE", "category": "APPLICATION", "description": "This seller is currently away until {sellerReturnDate}. If you make a purchase, please allow additional time for your order to be processed." }, "11510": { "domain": "API_BROWSE", "category": "APPLICATION", "description": "There was a problem calculating the shipping cost. Please try again." } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "11002": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The specified item group was not found." }, "11005": { "domain": "API_BROWSE", "category": "REQUEST", "description": "Item Group Id is invalid. Use {itemHref} to get the item details." }, "11008": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The item group is not available. This can be for many reasons, such as when the listing is being updated by the seller. Wait a few minutes and try the call again." }, "11011": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The marketplace value {marketplaceId} is not supported. The supported values are: {allowedMarketplaces}" }, "11019": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The quantity_for_shipping_estimate value {quantityForShippingEstimate} is invalid. Please enter a positive value." }, "11020": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The X-EBAY-C-ENDUSERCTX header value is in an invalid format. Please ensure that all values are key=value pairs." }, "11501": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The 'fieldgroups' value(s) are invalid: {fieldgroups}. The supported fieldgroups are: {supportedFieldgroups}." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "11002": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The specified item group was not found." } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "11008": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The item group is not available. This can be for many reasons, such as when the listing is being updated by the seller. Wait a few minutes and try the call again." }, "11011": { "domain": "API_BROWSE", "category": "REQUEST", "description": "The marketplace value {marketplaceId} is not supported. The supported values are: {allowedMarketplaces}." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "11000": { "domain": "API_BROWSE", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope" ] } ] } }, "/item/{item_id}/check_compatibility": { "post": { "tags": [ "item" ], "description": "This method checks if a product is compatible with the specified item. You can use this method to check the compatibility of cars, trucks, and motorcycles with a specific part listed on eBay.
For example, to check the compatibility of a part, you pass in the item_id of the part as a URI parameter and specify all the attributes used to define a specific car within the compatibilityProperties container. If the call is successful, the response will be
COMPATIBLE, NOT_COMPATIBLE, or UNDETERMINED. Refer to compatibilityStatus for details.Note: The only products supported are cars, trucks, and motorcycles.
To find the attributes and values for a specific marketplace, you can use the compatibility methods in the Taxonomy API. You can use this data to create menus to help buyers specify the product, such as their car.
For more information and a list of required attributes for the US marketplace that describe motor vehicles, refer to Check compatibility in the Buying Integration Guide.
For an example, refer to the Samples section.
Note: This method is supported in Sandbox but only when passing in the specified
item_id and compatibility name-value pairs listed in Sample: Sandbox Sample.Restrictions
For a list of supported sites and other restrictions, refer to Buy APIs Restrictions.", "operationId": "checkCompatibility", "parameters": [ { "name": "item_id", "in": "path", "description": "This path parameter specifies the unique RESTful identifier of an item (such as the park you want to check).
RESTful Item ID Format:
v1|#|#For a single SKU listing, pass in the item ID:
v1|2**********2|0For a multi-SKU listing, pass in the identifier of the variation:
v1|1**********2|4**********2
For more information about item IDs for RESTful APIs, refer to Item ID legacy API compatibility overview in the Buying Integration Guide.", "required": true, "schema": { "type": "string" }, "style": "simple", "explode": false }, { "name": "X-EBAY-C-MARKETPLACE-ID", "in": "header", "description": "This header identifies the seller's eBay marketplace. It is required for all marketplaces outside of the US.
Note: If the marketplace ID value is invalid or missing, the default value of
EBAY_US is used.See MarketplaceIdEnum for a list of supported marketplaces.
Default:
EBAY_US",
"required": false,
"schema": {
"type": "string"
},
"style": "simple",
"explode": false
},
{
"name": "Content-Type",
"in": "header",
"description": "This header indicates the format of the request body provided by the client.Its value should be set to
application/json.For more information, refer to HTTP request headers in the Using eBay RESTful APIs guide.", "required": true, "schema": { "type": "string" }, "style": "simple", "explode": false }, { "name": "Accept-Language", "in": "header", "description": "This header is used to indicate the natural language and locale preferred by the user for the response.
This header is required when targeting a specific locale of a marketplace that supports multiple locales. For example:
- When targeting the French locale of the Belgium marketplace, it is required to pass in
fr-BEto specify this. If this locale is not specified, the language will default to Dutch. - When targeting the French locale of the Canadian marketplace, it is required to pass in
fr-CAto specify this. If this locale is not specified, the language will default to English.
fieldgroups set to PRODUCT.The following table shows what is returned, based on the item information provided by the seller, when
fieldgroups is set to PRODUCT.| ePID Provided | Product ID(s) Provided | Response |
|---|---|---|
| No | No | The AdditionalProductIdentity container is not returned. |
| No | Yes | The AdditionalProductIdentity container is not returned but the product identifiers specified by the seller are returned in the localizedAspects container. |
| Yes | No | The AdditionalProductIdentity container is returned listing the product identifiers of the product. |
| Yes | Yes | The AdditionalProductIdentity container is returned listing all the product identifiers of the product and the product identifiers specified by the seller are returned in the localizedAspects container. |
fieldgroups is set to PRODUCT."
},
"AddonService": {
"type": "object",
"properties": {
"selection": {
"description": "This field indicates whether the add-on service must be selected for the item.",
"$ref": "#/components/schemas/AddonServiceSelectionEnum"
},
"serviceFee": {
"description": "The amount charged for the add-on service.",
"$ref": "#/components/schemas/ConvertedAmount"
},
"serviceId": {
"type": "string",
"description": "The ID number of the add-on service."
},
"serviceType": {
"description": "The type of add-on service, such as AUTHENTICITY_GUARANTEE.",
"$ref": "#/components/schemas/AddonServiceTypeEnum"
}
},
"description": "This type defines an add-on service that may be selected for an item or that may apply automatically. A charge may be associated with the add-on service."
},
"AddonServiceSelectionEnum": {
"type": "object",
"description": "An enumerated type that indicates if an add-on service is optional or automatically included. | - **OPTIONAL**: This value indicates that the add-on service may be selected as an option. - **REQUIRED**: This value indicates that the add-on service applies automatically and is not a selectable option.",
"enum": [
"OPTIONAL",
"REQUIRED"
]
},
"AddonServiceTypeEnum": {
"type": "object",
"description": "An enumerated type that defines add-on services. | - **AUTHENTICITY_GUARANTEE**: This enum value indicates that the add-on service is eBay Authenticity Guarantee service, in which a product's authenticity is verified by experts before shipping to the buyer. For more information, refer to Authenticity Guarantee on the eBay Seller site. ",
"enum": [
"AUTHENTICITY_GUARANTEE"
]
},
"Address": {
"type": "object",
"required": [
"city",
"country"
],
"properties": {
"addressLine1": {
"type": "string",
"description": "The first line of the street address.Note: This is conditionally returned in the
itemLocation field."
},
"addressLine2": {
"type": "string",
"description": "The second line of the street address. This field is not always used, but can be used for \"Suite Number\" or \"Apt Number\"."
},
"city": {
"type": "string",
"description": "The city of the address."
},
"country": {
"description": "The two-letter ISO 3166 standard code for the country of the address.",
"$ref": "#/components/schemas/CountryCodeEnum"
},
"county": {
"type": "string",
"description": "The county of the address."
},
"postalCode": {
"type": "string",
"description": "The postal code (or zip code in US) code of the address. Sellers set a postal code (or zip code in US) for items when they are listed. The postal code is used for calculating proximity searches. It is anonymized when returned in itemLocation.postalCode via the API."
},
"stateOrProvince": {
"type": "string",
"description": "The state or province of the address.Note: This is conditionally returned in the
itemLocation field."
}
},
"description": "The type that defines the fields for an address."
},
"Amount": {
"type": "object",
"description": "This type describes the value of a monetary amount as represented by a global currency. ",
"properties": {
"currency": {
"description": "The list of valid currencies. Each ISO 4217 currency code includes the currency name followed by the numeric value.For example, the Canadian Dollar code (CAD) would take the following form:
Canadian Dollar, 124.",
"$ref": "#/components/schemas/CurrencyCodeEnum"
},
"value": {
"type": "string",
"description": "The monetary value of the amount in the currency defined by the currency field."
}
}
},
"Aspect": {
"type": "object",
"properties": {
"localizedName": {
"type": "string",
"description": "The text representing the name of the aspect for the name/value pair, such as Brand."
},
"localizedValues": {
"type": "array",
"description": "The text representing the value of the aspect for the name/value pair, such as Apple.",
"items": {
"type": "string"
}
}
},
"description": "The type that defines the fields for the name/value pairs for the aspects of the product. For example: BRAND/Apple"
},
"AspectDistribution": {
"type": "object",
"properties": {
"aspectValueDistributions": {
"type": "array",
"description": "An array of containers for the various values of the aspect and the match count, and a HATEOAS reference (refinementHref) for this aspect.",
"items": {
"$ref": "#/components/schemas/AspectValueDistribution"
}
},
"localizedAspectName": {
"type": "string",
"description": "The name of an aspect, such as Brand, Color, etc."
}
},
"description": "The type that define the fields for the aspect information. Aspects are the variations of an item, such as color, size, etc."
},
"AspectFilter": {
"type": "object",
"properties": {
"categoryId": {
"type": "string",
"description": "The ID of the category. This limits the aspects filtering to this category."
},
"filters": {
"type": "array",
"description": "An array of aspects of the category identified by categoryId, with one or more aspect values in the form name:{value1|value2}. e.g. Brand:{adidas|Nike}. Possible values can be found in the category's refinement.aspectDistributions container.",
"items": {
"$ref": "#/components/schemas/FilterField"
}
}
},
"description": "This type contains an eBay category and an array of aspects of that category that can be used to narrow down the collection of product summaries returned by the search call. Aspects are product attributes that can represent different types of information for different products. Important: The AspectFilter type provides the underlying data structure for the aspect_filter parameter, which combines a category and one or more aspects of that category in a single string. However, this type is not used directly in the call. " }, "AspectGroup": { "type": "object", "description": "This type defines the aspects and localized name of a groups of an aspect group.", "properties": { "aspects": { "type": "array", "description": "An array of the name/value pairs for the aspects of the product. For example: BRAND/Apple", "items": { "$ref": "#/components/schemas/Aspect" } }, "localizedGroupName": { "type": "string", "description": "The name of a group of aspects.
In the following example, Product Identifiers and Process are product aspect group names. Under the group name are the product aspect name/value pairs.
Product Identifiers
Brand/Apple
Product Family/iMac
Processor
Processor Type/Intel
Processor Speed/3.10" } } }, "AspectValueDistribution": { "type": "object", "required": [ "localizedAspectValue", "matchCount", "refinementHref" ], "properties": { "localizedAspectValue": { "type": "string", "description": "The value of an aspect. For example, Red is a value for the aspect Color." }, "matchCount": { "type": "integer", "description": "The number of items with this aspect.", "format": "int32" }, "refinementHref": { "type": "string", "description": "A HATEOAS reference for this aspect." } }, "description": "This type contains information about one value of a specified aspect. This value serves as a product refinement." }, "AttributeNameValue": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the product attribute, such as Make, Model, Year, etc." }, "value": { "type": "string", "description": "The value for the
name attribute, such as BMW, R1200GS, 2011, etc."
}
},
"description": "The type the defines attribute name/value pair fields that specify a product. The type of data depends on the context. For example, if you were using this to specify a specific vehicle, the attribute names would be Make, Model, Year, etc."
},
"AuthenticityGuaranteeProgram": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "An indication that the item is qualified for the Authenticity Guarantee program."
},
"termsWebUrl": {
"type": "string",
"description": "The URL to the Authenticity Guarantee program terms of use."
}
},
"description": "A type that identifies whether the item is qualified for the Authenticity Guarantee program."
},
"AuthenticityVerificationProgram": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "An indication that the item is from a verified seller."
},
"termsWebUrl": {
"type": "string",
"description": "The URL to the Authenticity Verification program terms of use."
}
},
"description": "A type that identifies whether the item is from a verified seller."
},
"AutoCorrections": {
"type": "object",
"description": "This type defines the automatically spell-corrected keyword from the request.",
"properties": {
"q": {
"type": "string",
"description": "The automatically spell-corrected keyword from the request."
}
}
},
"AvailabilityStatusEnum": {
"type": "object",
"description": "An enumerated type for the values that represent the inventory status of an item. | - **IN_STOCK**: Indicates the item is available for purchase. - **LIMITED_STOCK**: Indicates the item is available for purchase but the supply of this item is low. - **OUT_OF_STOCK**: Indicates the item is not available for purchase because the supply of this item is currently zero. ",
"enum": [
"IN_STOCK",
"LIMITED_STOCK",
"OUT_OF_STOCK"
]
},
"AvailabilityThresholdEnum": {
"type": "object",
"description": "An enumerated type for the values that represent the availability of an item. | - **MORE_THAN**: Indicates that quantity of the item is more than 10. If the quantity is less than 10, the quantity is returned in the estimatedAvailableQuantity field.",
"enum": [
"MORE_THAN"
]
},
"AvailableCoupon": {
"type": "object",
"description": "This type defines the specifics of an available coupon, such as its constraints, discount amount, discount type, description, coupon code, and terms of use.",
"properties": {
"constraint": {
"description": "The limitations or restrictions of the coupon.",
"$ref": "#/components/schemas/CouponConstraint"
},
"discountAmount": {
"description": "The discount amount after the coupon is applied.",
"$ref": "#/components/schemas/Amount"
},
"discountType": {
"description": "The type of discount that the coupon applies.",
"$ref": "#/components/schemas/CouponDiscountTypeEnum"
},
"message": {
"type": "string",
"description": "A description of the coupon.Note: The value returned in the
termsWebUrl field should appear for all experiences when displaying coupons. The value in the availableCoupons.message field must also be included if returned in the API response."
},
"redemptionCode": {
"type": "string",
"description": "The coupon code."
},
"termsWebUrl": {
"type": "string",
"description": "The URL to the coupon terms of use.Note: The value returned in the
termsWebUrl field should appear for all experiences when displaying coupons. The value in the availableCoupons.message field must also be included if returned in the API response."
}
}
},
"BuyingOptionDistribution": {
"type": "object",
"required": [
"buyingOption",
"matchCount",
"refinementHref"
],
"properties": {
"buyingOption": {
"type": "string",
"description": "The container that returns the buying option type. This will be AUCTION, FIXED_PRICE, CLASSIFIED_AD, or a combination of these options. For details, see buyingOptions."
},
"matchCount": {
"type": "integer",
"description": "The number of items having this buying option.",
"format": "int32"
},
"refinementHref": {
"type": "string",
"description": "The HATEOAS reference for this buying option."
}
},
"description": "This type defines the fields for the buying options refinements. This container is returned when fieldgroups is set to BUYING_OPTION_REFINEMENTS or FULL in the request."
},
"Category": {
"type": "object",
"properties": {
"categoryId": {
"type": "string",
"description": "The unique identifier of the category."
},
"categoryName": {
"type": "string",
"description": "The name of the category."
}
},
"description": "This type is used by the categories container in the response of the search method, and contains the name and ID of the item category."
},
"CategoryDistribution": {
"type": "object",
"required": [
"categoryId",
"categoryName",
"matchCount",
"refinementHref"
],
"properties": {
"categoryId": {
"type": "string",
"description": "The unique identifier of the category."
},
"categoryName": {
"type": "string",
"description": "The name of the category, such as Baby & Toddler Clothing."
},
"matchCount": {
"type": "integer",
"description": "The number of items in this category.",
"format": "int32"
},
"refinementHref": {
"type": "string",
"description": "The HATEOAS reference of this category."
}
},
"description": "This type defines the fields for the category refinements. This container is returned when fieldgroups is set to CATEGORY_REFINEMENTS or FULL in the request."
},
"CommonDescriptions": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "The item description that is used by more than one of the item variations."
},
"itemIds": {
"type": "array",
"description": "A list of item ids that have this description.",
"items": {
"type": "string"
}
}
},
"description": "The type that defines the fields for the item_id values that all use a common description. Often the item variations within an item group all have the same description. Instead of repeating this description in the item details of each item, a description that is shared by at least one other item is returned in this container. If the description is unique, it is returned in the items.description field."
},
"CompanyAddress": {
"type": "object",
"properties": {
"addressLine1": {
"type": "string",
"description": "The first line of the product manufacturer's street address."
},
"addressLine2": {
"type": "string",
"description": "The second line of the product manufacturer's street address. This field is not always used, but can be used for secondary address information such as 'Suite Number' or 'Apt Number'."
},
"city": {
"type": "string",
"description": "The city of the product manufacturer's street address."
},
"companyName": {
"type": "string",
"description": "The company name of the product manufacturer."
},
"contactUrl": {
"type": "string",
"description": "The contact URL of the product manufacturer."
},
"country": {
"description": "The two-letter ISO 3166 standard code for the country of the address.",
"$ref": "#/components/schemas/CountryCodeEnum"
},
"countryName": {
"type": "string",
"description": "The country name of the product manufacturer's street address."
},
"county": {
"type": "string",
"description": "The county of the product manufacturer's street address."
},
"email": {
"type": "string",
"description": "The product manufacturer's business email address."
},
"phone": {
"type": "string",
"description": "The product manufacturer's business phone number."
},
"postalCode": {
"type": "string",
"description": "The postal code of the product manufacturer's street address."
},
"stateOrProvince": {
"type": "string",
"description": "The state or province of the product manufacturer's street address."
}
},
"description": "This type is used to provide contact information for the manufacturer of the product."
},
"CompatibilityFilter": {
"type": "object",
"properties": {
"filters": {
"type": "array",
"description": "This query parameter supports multiple field filters that can be used to limit/customize the result set. This is specific to checking if an item is compatible to the specified product.",
"items": {
"$ref": "#/components/schemas/FilterField"
}
}
},
"description": "The type that contains the fields that specify the attributes used to define a specific product that are used to check for item compatibility. This information is submitted in the request."
},
"CompatibilityMatchEnum": {
"type": "string",
"description": "An enumerated type for the values that represent how well the item matches the compatibility_filter product attributes. | - **EXACT**: Indicates the item is compatible with all the product attributes submitted. - **POSSIBLE**: Indicates the item could fit the product. To further check for compatibility, you can add more product attributes. ",
"enum": [
"EXACT",
"POSSIBLE"
]
},
"CompatibilityPayload": {
"type": "object",
"properties": {
"compatibilityProperties": {
"type": "array",
"description": "An array of attribute name/value pairs used to define a specific product. For example: If you wanted to specify a specific car, one of the name/value pairs would be\"name\" : \"Year\",
\"value\" : \"2019\"For a list of the attributes required for cars and trucks and motorcycles see Check compatibility in the Buy Integration Guide.", "items": { "$ref": "#/components/schemas/AttributeNameValue" } } }, "description": "This type defines an array of attribute name/value pairs used to define a specific product. For example: If you wanted to specify a specific car, one of the name/value pairs would be:
\"name\" : \"Year\",
\"value\" : \"2019\"For a list of the attributes required for cars and trucks and motorcycles refer to Check compatibility in the Buying Integration Guide." }, "CompatibilityProperty": { "type": "object", "properties": { "localizedName": { "type": "string", "description": "The name of the product attribute that as been translated to the language of the site." }, "name": { "type": "string", "description": "The name of the product attribute, such as Make, Model, Year, etc." }, "value": { "type": "string", "description": "The value for the
name attribute, such as BMW, R1200GS, 2011, etc."
}
},
"description": "This type returns the product attribute name/value pairs that are compatible with the keyword. These attributes are submitted in the compatibility_filter request field."
},
"CompatibilityResponse": {
"type": "object",
"properties": {
"compatibilityStatus": {
"description": "An enumeration value that tells you if the item is compatible with the product. The values are:
- COMPATIBLE - Indicates the item is compatible with the product specified in the request.
- NOT_COMPATIBLE - Indicates the item is not compatible with the product specified in the request. Be sure to check all the value fields to ensure they are correct as errors in the value can also cause this response.
- UNDETERMINED - Indicates one or more attributes for the specified product are missing so compatibility cannot be determined. The response returns the attributes that are missing.
Code so that your app gracefully handles any future changes to this list. | - **COMPATIBLE**: Indicates the item is compatible with the product specified in the request. - **NOT_COMPATIBLE**: Indicates the item is not compatible with the product specified in the request. Be sure to check all the value fields ensure they are correct as errors in the value can also cause this response. - **UNDETERMINED**: Indicates one or more attributes for the specified product are missing so compatibility cannot be determined. The response returns the attributes that are missing. ", "enum": [ "COMPATIBLE", "NOT_COMPATIBLE", "UNDETERMINED" ] }, "ConditionDescriptor": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of a condition descriptor. The value(s) for this condition descriptor is returned in the associated values array." }, "values": { "type": "array", "description": "This array displays the value(s) for a condition descriptor (denoted by the associated name field), as well as any other additional information about the condition of the item.", "items": { "$ref": "#/components/schemas/ConditionDescriptorValue" } } }, "description": "This type displays additional information about the condition of an item in a structured format." }, "ConditionDescriptorValue": { "type": "object", "properties": { "additionalInfo": { "type": "array", "description": "Additional information about the condition of an item as it relates to a condition descriptor. This array elaborates on the value specified in the content field and provides additional details about the condition of an item.", "items": { "type": "string" } }, "content": { "type": "string", "description": "The value for the condition descriptor indicated in the associated name field." } }, "description": "This type displays the value(s) associated with the specified condition descriptor name, as well as any additional information about a condition descriptor. " }, "ConditionDistribution": { "type": "object", "required": [ "condition", "conditionId", "matchCount", "refinementHref" ], "properties": { "condition": { "type": "string", "description": "The text describing the condition of the item, such as New or Used. For a list of condition names, refer to Item Condition IDs and Names." }, "conditionId": { "type": "string", "description": "The identifier of the condition. For example,
1000 is the identifier for NEW."
},
"matchCount": {
"type": "integer",
"description": "The number of items having the condition.",
"format": "int32"
},
"refinementHref": {
"type": "string",
"description": "The HATEOAS reference of this condition."
}
},
"description": "This type defines the fields for the conditions refinements. This container is returned when fieldgroups is set to CONDITION_REFINEMENTS or FULL in the request."
},
"ConvertedAmount": {
"type": "object",
"properties": {
"convertedFromCurrency": {
"description": "The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.",
"$ref": "#/components/schemas/CurrencyCodeEnum"
},
"convertedFromValue": {
"type": "string",
"description": "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/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field."
},
"currency": {
"description": "The three-letter ISO 4217 code representing the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.Default: The currency of the authenticated user's country.", "$ref": "#/components/schemas/CurrencyCodeEnum" }, "value": { "type": "string", "description": "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 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." }, "CoreItem": { "type": "object", "required": [ "adultOnly", "categoryId", "categoryPath", "description", "eligibleForInlineCheckout", "enabledForGuestCheckout", "image", "immediatePay", "itemId", "itemWebUrl", "legacyItemId", "price", "priorityListing", "seller", "title" ], "properties": { "additionalImages": { "type": "array", "description": "An array of containers with the URLs for the images that are in addition to the primary image. The primary image is returned in the image.imageUrl field.", "items": { "$ref": "#/components/schemas/Image" } }, "adultOnly": { "type": "boolean", "description": "This indicates if the item is for adults only. For more information about adult-only items on eBay, see Adult items policy for sellers and Adult-Only items on eBay for buyers." }, "ageGroup": { "type": "string", "description": "(Primary Item Aspect) The age group for which the product is recommended. For example, newborn, infant, toddler, kids, adult, etc. All the item aspects, including this aspect, are returned in the localizedAspects container." }, "authenticityGuarantee": { "description": "A container for information about whether an item is qualified for the Authenticity Guarantee program.
Under the Authenticity Guarantee program, the seller ships a purchased item to a a third-party authenticator who inspects the item and provides an authentication card for it before the item is shipped to the buyer. If the buyer returns the item, the authenticator first verifies that it is the same item in the same condition before returning it to the seller.
Note: Refer to the Authenticity Guarantee page for more information.", "$ref": "#/components/schemas/AuthenticityGuaranteeProgram" }, "authenticityVerification": { "description": "A container for information about whether an item is from a verified seller.", "$ref": "#/components/schemas/AuthenticityVerificationProgram" }, "availableCoupons": { "type": "array", "description": "A list of available coupons for the item.", "items": { "$ref": "#/components/schemas/AvailableCoupon" } }, "bidCount": { "type": "integer", "description": "This integer value indicates the total number of bids that have been placed against an auction item. This field is returned only for auction items.", "format": "int32" }, "brand": { "type": "string", "description": "(Primary Item Aspect) The name brand of the item, such as Nike, Apple, etc. All the item aspects, including this aspect, are returned in the localizedAspects container." }, "buyingOptions": { "type": "array", "description": "A comma separated list of all the purchase options available for the item. The values returned are:
FIXED_PRICE- Indicates the buyer can purchase the item for a set price using the Buy It Now button.AUCTION- Indicates the buyer can place a bid for the item. After the first bid is placed, this becomes a live auction item and is the only buying option for this item.BEST_OFFER- Indicates the buyer can send the seller a price they're willing to pay for the item. The seller can accept, reject, or send a counter offer. For more information on how this works, see Making a Best Offer.CLASSIFIED_AD- Indicates that the final sales transaction is to be completed outside of the eBay environment.
This container is only returned if the fieldgroups query parameter is set to
CHARITY_DETAILS.",
"$ref": "#/components/schemas/ItemCharityTerms"
},
"condition": {
"type": "string",
"description": "A short text description for the condition of the item, such as New or Used. For a list of condition names, see Item Condition IDs and Names. Code so that your app gracefully handles any future changes to this list." }, "conditionDescription": { "type": "string", "description": "A full text description for the condition of the item. This field elaborates on the value specified in the condition field and provides full details for the condition of the item." }, "conditionId": { "type": "string", "description": "The identifier of the condition of the item. For example, 1000 is the identifier for NEW. For a list of condition names and IDs, see Item Condition IDs and Names.
Code so that your app gracefully handles any future changes to this list." }, "currentBidPrice": { "description": "The container that returns the current highest bid for an auction item. The value (string) field shows the dollar value of the current highest bid, and the currency (3-digit ISO code) field denotes the currency associated with that bid value. This container will only be returned for auction items.", "$ref": "#/components/schemas/ConvertedAmount" }, "description": { "type": "string", "description": "The full description of the item that was created by the seller. This can be plain text or rich content and can be very large." }, "eligibleForInlineCheckout": { "type": "boolean", "description": "This field indicates if the item can be purchased using the Buy Order API.
- If the value of this field is
true, this indicates that the item can be purchased using the Order API. - If the value of this field is
false, this indicates that the item cannot be purchased using the Order API and must be purchased on the eBay site.
The rating is a set of energy efficiency classes from A to G, where 'A' is the most energy efficient and 'G' is the least efficient. This rating helps buyers choose between various models.
When the manufacturer's specifications for this item are available, the link to this information is returned in the productFicheWebUrl field." }, "epid": { "type": "string", "description": "An EPID is the eBay product identifier of a product from the eBay product catalog. This indicates the product in which the item belongs." }, "estimatedAvailabilities": { "type": "array", "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.", "items": { "$ref": "#/components/schemas/EstimatedAvailability" } }, "gender": { "type": "string", "description": "(Primary Item Aspect) The gender for the item. This is used for items that could vary by gender, such as clothing. For example: male, female, or unisex. All the item aspects, including this aspect, are returned in the localizedAspects container." }, "gtin": { "type": "string", "description": "The unique Global Trade Item number of the item as defined by https://www.gtin.info. This can be a UPC (Universal Product Code), EAN (European Article Number), or an ISBN (International Standard Book Number) value." }, "image": { "description": "The URL of the primary image of the item. The other images of the item are returned in the additionalImages container.", "$ref": "#/components/schemas/Image" }, "immediatePay": { "type": "boolean", "description": "A value of
true indicates that the seller requires immediate payment from the buyer when purchasing an item.Note: It is possible for this field to be set to
true, but not apply in some scenarios. For example, immediate payment is not applicable for auction listings that have a winning bidder, for buyers' purchases that involve the Best Offer feature, or for offline transactions."
},
"inferredEpid": {
"type": "string",
"description": "The ePID (eBay Product ID of a product from the eBay product catalog) for the item, which has been programmatically determined by eBay using the item's title, aspects, and other data. If the seller provided an ePID for the item, the seller's value is returned in the epid field.
Note: This field is returned only for authorized Partners." }, "itemAffiliateWebUrl": { "type": "string", "description": "The URL to the View Item page of the item which includes the affiliate tracking ID.
Note: In order to receive commissions on sales, eBay Partner Network affiliates must use this URL to forward buyers to the listing on the eBay marketplace.
The itemAffiliateWebUrl is only returned if:
- The marketplace through which the item is being viewed is part of the eBay Partner Network. Currently Singapore (
EBAY_SG) is not supported.
For additional information, refer to eBay Partner Network. - The seller enables affiliate tracking for the item by including the
X-EBAY-C-ENDUSERCTXrequest header in the method.
This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which can be converted into the local time of the buyer." }, "itemEndDate": { "type": "string", "description": "A timestamp that indicates the date and time an auction listing will end.
If a fixed-price listing has ended, this field indicates the date and time the listing ended.
This value is returned in UTC format (
yyyy-MM-ddThh:mm:ss.sssZ), which can be converted into the local time of the buyer."
},
"itemId": {
"type": "string",
"description": "The unique RESTful identifier of the item."
},
"itemLocation": {
"description": "The physical location of the item.",
"$ref": "#/components/schemas/Address"
},
"itemWebUrl": {
"type": "string",
"description": "The URL of the View Item page of the item. This enables you to include a \"Report Item on eBay\" link that takes the buyer to the View Item page on eBay. From there they can report any issues regarding this item to eBay."
},
"legacyItemId": {
"type": "string",
"description": "The unique identifier of the eBay listing that contains the item. This is the traditional/legacy ID that is often seen in the URL of the listing View Item page."
},
"localizedAspects": {
"type": "array",
"description": "An array of containers that show the complete list of the aspect name/value pairs that describe the variation of the item.",
"items": {
"$ref": "#/components/schemas/TypedNameValue"
}
},
"lotSize": {
"type": "integer",
"description": "The number of items in a lot. In other words, a lot size is the number of items that are being sold together. A lot is a set of two or more items included in a single listing that must be purchased together in a single order line item. All the items in the lot are the same but there can be multiple items in a single lot, such as the package of batteries shown in the example below.
| Item | Lot Definition | Lot Size |
|---|---|---|
| A package of 24 AA batteries | A box of 10 packages | 10 |
| A P235/75-15 Goodyear tire | 4 tires | 4 |
| Fashion Jewelry Rings | Package of 100 assorted rings | 100 |
Note: Lots are not supported in all categories. ", "format": "int32" }, "marketingPrice": { "description": "The original price and the discount amount and percentage.", "$ref": "#/components/schemas/MarketingPrice" }, "material": { "type": "string", "description": "(Primary Item Aspect) Text describing what the item is made of. For example, silk. All the item aspects, including this aspect, are returned in the localizedAspects container." }, "minimumPriceToBid": { "description": "The minimum price of the next bid, which means to place a bid it must be equal to or greater than this amount. If the auction hasn't received any bids, the minimum bid price is the same as the starting bid. Otherwise, the minimum bid price is equal to the current bid plus the bid increment. For details about bid increments, see Automatic bidding.", "$ref": "#/components/schemas/ConvertedAmount" }, "mpn": { "type": "string", "description": "The manufacturer's part number, which is a unique number that identifies a specific product. To identify the product, this is always used along with brand." }, "pattern": { "type": "string", "description": "(Primary Item Aspect) Text describing the pattern used on the item. For example, paisley. All the item aspects, including this aspect, are returned in the localizedAspects container." }, "paymentMethods": { "type": "array", "description": "The payment methods for the item, including the payment method types, brands, and instructions for the buyer.", "items": { "$ref": "#/components/schemas/PaymentMethod" } }, "price": { "description": "The cost of just the item. This amount does not include any adjustments such as discounts or shipping costs.
Note: The price does include the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the
X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB) to see the VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU.",
"$ref": "#/components/schemas/ConvertedAmount"
},
"priceDisplayCondition": {
"description": "Indicates when in the buying flow the item's price can appear for minimum advertised price (MAP) items, which is the lowest price a retailer can advertise/show for this item.",
"$ref": "#/components/schemas/PriceDisplayConditionEnum"
},
"primaryItemGroup": {
"description": "The container that returns details of a primary item group (parent ID of an item group). An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. When an item group is created, one of the item variations, such as the red shirt size L, is chosen as the \"parent\". All the other items in the group are the children, such as the blue shirt size L, red shirt size M, etc.
Note: This container is returned if the item_id in the request is for an item group (items with variations, such as color and size). This container is also returned on a request for item_group_ids.", "$ref": "#/components/schemas/ItemGroupSummary" }, "primaryProductReviewRating": { "description": "The container that returns the product rating details, such as review count, rating histogram, and average rating.", "$ref": "#/components/schemas/ReviewRating" }, "priorityListing": { "type": "boolean", "description": "This field is returned as
true if the listing is part of a Promoted Listing campaign. Promoted Listings are available to Above Standard and Top Rated sellers with recent sales activity.For more information, see Promoted Listings." }, "product": { "description": "The container that returns the product information of the item.", "$ref": "#/components/schemas/Product" }, "productFicheWebUrl": { "type": "string", "description": "The URL of a page containing the manufacturer's specification of this item, which helps buyers make a purchasing decision. This information is available only for items that include the European energy efficiency rating (EEK) but is not available for all items with an EEK rating and is returned only if this information is available. The EEK rating of the item is returned in the energyEfficiencyClass field." }, "qualifiedPrograms": { "type": "array", "description": "An array of the qualified programs available for the item, such as
EBAY_PLUS, AUTHENTICITY_GUARANTEE, and AUTHENTICITY_VERIFICATION.eBay Plus is a premium account option for buyers, which provides benefits such as fast, free domestic shipping and free returns on selected items. Sellers must commit to next-day delivery of those items.The eBay Authenticity Guarantee program enables third-party authenticators to perform authentication verification inspections on items such as watches and sneakers.
Note: eBay Plus was recently deprecated on the eBay Germany marketplace, and this feature is now only available on eBay Australia marketplace.", "items": { "type": "string" } }, "quantityLimitPerBuyer": { "type": "integer", "description": "The maximum number for a specific item that one buyer can purchase.", "format": "int32" }, "reservePriceMet": { "type": "boolean", "description": "This indicates if the reserve price of the item has been met. A reserve price is set by the seller and is the minimum amount the seller is willing to sell the item for.
If the highest bid is not equal to or higher than the reserve price when the auction ends, the listing ends and the item is not sold.
Note: This is returned only for auctions that have a reserve price.
" }, "returnTerms": { "description": "The container that returns an overview of the seller's return policy.", "$ref": "#/components/schemas/ItemReturnTerms" }, "seller": { "description": "The container that returns basic and detailed about the seller of the item, such as name, feedback score, and contact information.", "$ref": "#/components/schemas/SellerDetail" }, "sellerItemRevision": { "type": "string", "description": "An identifier generated/incremented when a seller revises the item. There are two types of item revisions:- Seller changes, such as changing the title
- eBay system changes, such as changing the quantity when an item is purchased
Note: For items with calculated shipping, this array is only returned if the X-EBAY-C-ENDUSERCTX header is supplied. ", "items": { "$ref": "#/components/schemas/ShippingOption" } }, "shipToLocations": { "description": "The container that returns the geographic regions to be included and excluded that define where the item can be shipped.", "$ref": "#/components/schemas/ShipToLocations" }, "shortDescription": { "type": "string", "description": "This text string is derived from the item condition and the item aspects (such as size, color, capacity, model, brand, etc.)." }, "size": { "type": "string", "description": "(Primary Item Aspect) The size of the item. For example, '7' for a size 7 shoe. All the item aspects, including this aspect, are returned in the localizedAspects container." }, "sizeSystem": { "type": "string", "description": "(Primary Item Aspect) The sizing system of the country. All the item aspects, including this aspect, are returned in the localizedAspects container.
Valid Values:
AU (Australia),
BR (Brazil),
CN (China),
DE (Germany),
EU (European Union),
FR (France),
IT (Italy),
JP (Japan),
MX (Mexico),
US (USA),
UK (United Kingdom)
Code so that your app gracefully handles any future changes to this list. " }, "sizeType": { "type": "string", "description": "(Primary Item Aspect) Text describing a size group in which the item would be included, such as regular, petite, plus, big-and-tall or maternity. All the item aspects, including this aspect, are returned in the localizedAspects container." }, "subtitle": { "type": "string", "description": "A subtitle is optional and allows the seller to provide more information about the product, possibly including keywords that may assist with search results." }, "taxes": { "type": "array", "description": "The container for the tax information for the item.", "items": { "$ref": "#/components/schemas/Taxes" } }, "title": { "type": "string", "description": "The seller-created title of the item.
Maximum Length: 80 characters" }, "topRatedBuyingExperience": { "type": "boolean", "description": "This indicates if the item a top-rated plus item. There are three benefits of a top-rated plus item: a minimum 30-day money-back return policy, shipping the items in 1 business day with tracking provided, and the added comfort of knowing this item is from experienced sellers with the highest buyer ratings. See the Top Rated Plus Items and Becoming a Top Rated Seller and qualifying for Top Rated Plus help topics for more information." }, "tyreLabelImageUrl": { "type": "string", "description": "The URL to the image that shows the information on the tyre label." }, "uniqueBidderCount": { "type": "integer", "description": "This integer value indicates the number of different eBay users who have placed one or more bids on an auction item. This field is only applicable to auction items.", "format": "int32" }, "unitPrice": { "description": "This is the price per unit for the item. Some European countries require listings for certain types of products to include the price per unit so buyers can accurately compare prices.
For example:
\"unitPricingMeasure\": \"100g\",
\"unitPrice\": {
\"value\": \"7.99\",
\"currency\": \"GBP\"",
"$ref": "#/components/schemas/ConvertedAmount"
},
"unitPricingMeasure": {
"type": "string",
"description": "The designation, such as size, weight, volume, count, etc., that was used to specify the quantity of the item. This helps buyers compare prices. For example, the following tells the buyer that the item is 7.99 per 100 grams.
\"unitPricingMeasure\": \"100g\",
\"unitPrice\": {
\"value\": \"7.99\",
\"currency\": \"GBP\""
}
},
"description": "This type defines the array of containers with the details for all of the items returned."
},
"CountryCodeEnum": {
"type": "string",
"description": "This enumerated type defines the two-letter ISO 3166 standard code representing a country. | - **AD**: Indicates the country is Andorra. - **AE**: Indicates the country is United Arab Emirates. - **AF**: Indicates the country is Afghanistan. - **AG**: Indicates the country is Antigua and Barbuda. - **AI**: Indicates the country is Anguilla. - **AL**: Indicates the country is Albania. - **AM**: Indicates the country is Armenia. - **AN**: Indicates the country is Netherlands Antilles. - **AO**: Indicates the country is Angola. - **AQ**: Indicates the country is Antarctica. - **AR**: Indicates the country is Argentina. - **AS**: Indicates the country is American Samoa. - **AT**: Indicates the country is Austria. - **AU**: Indicates the country is Australia. - **AW**: Indicates the country is Aruba. - **AX**: Indicates the country is Aland Islands. - **AZ**: Indicates the country is Azerbaijan. - **BA**: Indicates the country is Bosnia and Herzegovina. - **BB**: Indicates the country is Barbados. - **BD**: Indicates the country is Bangladesh. - **BE**: Indicates the country is Belgium. - **BF**: Indicates the country is Burkina Faso. - **BG**: Indicates the country is Bulgaria. - **BH**: Indicates the country is Bahrain. - **BI**: Indicates the country is Burundi. - **BJ**: Indicates the country is Benin. - **BL**: Indicates the country is Saint Barthelemy. - **BM**: Indicates the country is Bermuda. - **BN**: Indicates the country is Brunei Darussalam. - **BO**: Indicates the country is Bolivia. - **BQ**: Indicates the country is Bonaire, Sint Eustatius, and Saba. - **BR**: Indicates the country is Brazil. - **BS**: Indicates the country is Bahamas. - **BT**: Indicates the country is Bhutan. - **BV**: Indicates the country is Bouvet Island. - **BW**: Indicates the country is Botswana. - **BY**: Indicates the country is Belarus. - **BZ**: Indicates the country is Belize. - **CA**: Indicates the country is Canada. - **CC**: Indicates the country is Cocos (Keeling) Islands. - **CD**: Indicates the country is The Democratic Republic of the Congo. - **CF**: Indicates the country is Central African Republic. - **CG**: Indicates the country is Congo. - **CH**: Indicates the country is Switzerland. - **CI**: Indicates the country is Cote d'Ivoire. - **CK**: Indicates the country is Cook Islands. - **CL**: Indicates the country is Chile. - **CM**: Indicates the country is Cameroon. - **CN**: Indicates the country is China. - **CO**: Indicates the country is Colombia. - **CR**: Indicates the country is Costa Rica. - **CU**: Indicates the country is Cuba. - **CV**: Indicates the country is Cape Verde. - **CW**: Indicates the country is Curacao. - **CX**: Indicates the country is Christmas Island. - **CY**: Indicates the country is Cyprus. - **CZ**: Indicates the country is Czech Republic. - **DE**: Indicates the country is Germany. - **DJ**: Indicates the country is Djibouti. - **DK**: Indicates the country is Denmark. - **DM**: Indicates the country is Dominica. - **DO**: Indicates the country is Dominican Republic. - **DZ**: Indicates the country is Algeria. - **EC**: Indicates the country is Ecuador. - **EE**: Indicates the country is Estonia. - **EG**: Indicates the country is Egypt. - **EH**: Indicates the country is Western Sahara. - **ER**: Indicates the country is Eritrea. - **ES**: Indicates the country is Spain. - **ET**: Indicates the country is Ethiopia. - **FI**: Indicates the country is Finland. - **FJ**: Indicates the country is Fiji. - **FK**: Indicates the country is Falkland Islands (Malvinas). - **FM**: Indicates the country is Federated States of Micronesia. - **FO**: Indicates the country is Faroe Islands. - **FR**: Indicates the country is France. - **GA**: Indicates the country is Gabon. - **GB**: Indicates the country is United Kingdom. - **GD**: Indicates the country is Grenada. - **GE**: Indicates the country is Georgia. - **GF**: Indicates the country is French Guiana. - **GG**: Indicates the country is Guernsey. - **GH**: Indicates the country is Ghana. - **GI**: Indicates the country is Gibraltar. - **GL**: Indicates the country is Greenland. - **GM**: Indicates the country is Gambia. - **GN**: Indicates the country is Guinea. - **GP**: Indicates the country is Guadeloupe. - **GQ**: Indicates the country is Equatorial Guinea. - **GR**: Indicates the country is Greece. - **GS**: Indicates the country is South Georgia and the South Sandwich Islands. - **GT**: Indicates the country is Guatemala. - **GU**: Indicates the country is Guam. - **GW**: Indicates the country is Guinea-Bissau. - **GY**: Indicates the country is Guyana. - **HK**: Indicates the country is Hong Kong. - **HM**: Indicates the country is Heard Island and McDonald Islands. - **HN**: Indicates the country is Honduras. - **HR**: Indicates the country is Croatia. - **HT**: Indicates the country is Haiti. - **HU**: Indicates the country is Hungary. - **ID**: Indicates the country is Indonesia. - **IE**: Indicates the country is Ireland. - **IL**: Indicates the country is Israel. - **IM**: Indicates the country is Isle of Man. - **IN**: Indicates the country is India. - **IO**: Indicates the country is British Indian Ocean Territory. - **IQ**: Indicates the country is Iraq. - **IR**: Indicates the country is Islamic Republic of Iran. - **IS**: Indicates the country is Iceland. - **IT**: Indicates the country is Italy. - **JE**: Indicates the country is Jersey. - **JM**: Indicates the country is Jamaica. - **JO**: Indicates the country is Jordan. - **JP**: Indicates the country is Japan. - **KE**: Indicates the country is Kenya. - **KG**: Indicates the country is Kyrgyzstan. - **KH**: Indicates the country is Cambodia. - **KI**: Indicates the country is Kiribati. - **KM**: Indicates the country is Comoros. - **KN**: Indicates the country is Saint Kitts and Nevis. - **KP**: Indicates the country is Democratic People's Republic of Korea. - **KR**: Indicates the country is Republic of Korea. - **KW**: Indicates the country is Kuwait. - **KY**: Indicates the country is Cayman Islands. - **KZ**: Indicates the country is Kazakhstan. - **LA**: Indicates the country is Lao People's Democratic Republic. - **LB**: Indicates the country is Lebanon. - **LC**: Indicates the country is Saint Lucia. - **LI**: Indicates the country is Liechtenstein. - **LK**: Indicates the country is Sri Lanka. - **LR**: Indicates the country is Liberia. - **LS**: Indicates the country is Lesotho. - **LT**: Indicates the country is Lithuania. - **LU**: Indicates the country is Luxembourg. - **LV**: Indicates the country is Latvia. - **LY**: Indicates the country is Libyan Arab Jamahiriya. - **MA**: Indicates the country is Morocco. - **MC**: Indicates the country is Monaco. - **MD**: Indicates the country is Republic of Moldova. - **ME**: Indicates the country is Montenegro. - **MF**: Indicates the country is Saint Martin (French part). - **MG**: Indicates the country is Madagascar. - **MH**: Indicates the country is Marshall Islands. - **MK**: Indicates the country is The Former Yugoslav Republic of Macedonia. - **ML**: Indicates the country is Mali. - **MM**: Indicates the country is Myanmar. - **MN**: Indicates the country is Mongolia. - **MO**: Indicates the country is Macao. - **MP**: Indicates the country is Northern Mariana Islands. - **MQ**: Indicates the country is Martinique. - **MR**: Indicates the country is Mauritania. - **MS**: Indicates the country is Montserrat. - **MT**: Indicates the country is Malta. - **MU**: Indicates the country is Mauritius. - **MV**: Indicates the country is Maldives. - **MW**: Indicates the country is Malawi. - **MX**: Indicates the country is Mexico. - **MY**: Indicates the country is Malaysia. - **MZ**: Indicates the country is Mozambique. - **NA**: Indicates the country is Namibia. - **NC**: Indicates the country is New Caledonia. - **NE**: Indicates the country is Niger. - **NF**: Indicates the country is Norfolk Island. - **NG**: Indicates the country is Nigeria. - **NI**: Indicates the country is Nicaragua. - **NL**: Indicates the country is Netherlands. - **NO**: Indicates the country is Norway. - **NP**: Indicates the country is Nepal. - **NR**: Indicates the country is Nauru. - **NU**: Indicates the country is Niue. - **NZ**: Indicates the country is New Zealand. - **OM**: Indicates the country is Oman. - **PA**: Indicates the country is Panama. - **PE**: Indicates the country is Peru. - **PF**: Indicates the country is French Polynesia. Includes Tahiti. - **PG**: Indicates the country is Papua New Guinea. - **PH**: Indicates the country is Philippines. - **PK**: Indicates the country is Pakistan. - **PL**: Indicates the country is Poland. - **PM**: Indicates the country is Saint Pierre and Miquelon. - **PN**: Indicates the country is Pitcairn. - **PR**: Indicates the country is Puerto Rico. - **PS**: Indicates the country is Palestinian territory Occupied. - **PT**: Indicates the country is Portugal. - **PW**: Indicates the country is Palau. - **PY**: Indicates the country is Paraguay. - **QA**: Indicates the country is Qatar. - **RE**: Indicates the country is Reunion. - **RO**: Indicates the country is Romania. - **RS**: Indicates the country is Serbia. - **RU**: Indicates the country is Russian Federation. - **RW**: Indicates the country is Rwanda. - **SA**: Indicates the country is Saudi Arabia. - **SB**: Indicates the country is Solomon Islands. - **SC**: Indicates the country is Seychelles. - **SD**: Indicates the country is Sudan. - **SE**: Indicates the country is Sweden. - **SG**: Indicates the country is Singapore. - **SH**: Indicates the country is Saint Helena. - **SI**: Indicates the country is Slovenia. - **SJ**: Indicates the country is Svalbard and Jan Mayen. - **SK**: Indicates the country is Slovakia. - **SL**: Indicates the country is Sierra Leone. - **SM**: Indicates the country is San Marino. - **SN**: Indicates the country is Senegal. - **SO**: Indicates the country is Somalia. - **SR**: Indicates the country is Suriname. - **SS**: Indicates the country is South Sudan. - **ST**: Indicates the country is Sao Tome and Principe. - **SV**: Indicates the country is El Salvador. - **SX**: Indicates the country is Sint Maarten (Dutch part). - **SY**: Indicates the country is Syrian Arab Republic. - **SZ**: Indicates the country is Swaziland. - **TC**: Indicates the country is Turks and Caicos Islands. - **TD**: Indicates the country is Chad. - **TF**: Indicates the country is French Southern Territories. - **TG**: Indicates the country is Togo. - **TH**: Indicates the country is Thailand. - **TJ**: Indicates the country is Tajikistan. - **TK**: Indicates the country is Tokelau. - **TL**: Indicates the country is Timor-Leste. - **TM**: Indicates the country is Turkmenistan. - **TN**: Indicates the country is Tunisia. - **TO**: Indicates the country is Tonga. - **TR**: Indicates the country is Turkey. - **TT**: Indicates the country is Trinidad and Tobago. - **TV**: Indicates the country is Tuvalu. - **TW**: Indicates the country is Taiwan. - **TZ**: Indicates the country is Tanzania. - **UA**: Indicates the country is Ukraine. - **UG**: Indicates the country is Uganda. - **UM**: Indicates the country is United States Minor Outlying Islands. - **US**: Indicates the country is United States. - **UY**: Indicates the country is Uruguay. - **UZ**: Indicates the country is Uzbekistan. - **VA**: Indicates the country is Holy See (Vatican City state). - **VC**: Indicates the country is Saint Vincent and the Grenadines. - **VE**: Indicates the country is Venezuela. - **VG**: Indicates the country is British Virgin Islands. - **VI**: Indicates the country is the U.S. Virgin Islands. - **VN**: Indicates the country is Vietnam. - **VU**: Indicates the country is Vanuatu. - **WF**: Indicates the country is Wallis and Futuna. - **WS**: Indicates the country is Samoa. - **YE**: Indicates the country is Yemen. - **YT**: Indicates the country is Mayotte. - **ZA**: Indicates the country is South Africa. - **ZM**: Indicates the country is Zambia. - **ZW**: Indicates the country is Zimbabwe.",
"enum": [
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AN",
"AO",
"AQ",
"AR",
"AS",
"AT",
"AU",
"AW",
"AX",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BL",
"BM",
"BN",
"BO",
"BQ",
"BR",
"BS",
"BT",
"BV",
"BW",
"BY",
"BZ",
"CA",
"CC",
"CD",
"CF",
"CG",
"CH",
"CI",
"CK",
"CL",
"CM",
"CN",
"CO",
"CR",
"CU",
"CV",
"CW",
"CX",
"CY",
"CZ",
"DE",
"DJ",
"DK",
"DM",
"DO",
"DZ",
"EC",
"EE",
"EG",
"EH",
"ER",
"ES",
"ET",
"FI",
"FJ",
"FK",
"FM",
"FO",
"FR",
"GA",
"GB",
"GD",
"GE",
"GF",
"GG",
"GH",
"GI",
"GL",
"GM",
"GN",
"GP",
"GQ",
"GR",
"GS",
"GT",
"GU",
"GW",
"GY",
"HK",
"HM",
"HN",
"HR",
"HT",
"HU",
"ID",
"IE",
"IL",
"IM",
"IN",
"IO",
"IQ",
"IR",
"IS",
"IT",
"JE",
"JM",
"JO",
"JP",
"KE",
"KG",
"KH",
"KI",
"KM",
"KN",
"KP",
"KR",
"KW",
"KY",
"KZ",
"LA",
"LB",
"LC",
"LI",
"LK",
"LR",
"LS",
"LT",
"LU",
"LV",
"LY",
"MA",
"MC",
"MD",
"ME",
"MF",
"MG",
"MH",
"MK",
"ML",
"MM",
"MN",
"MO",
"MP",
"MQ",
"MR",
"MS",
"MT",
"MU",
"MV",
"MW",
"MX",
"MY",
"MZ",
"NA",
"NC",
"NE",
"NF",
"NG",
"NI",
"NL",
"NO",
"NP",
"NR",
"NU",
"NZ",
"OM",
"PA",
"PE",
"PF",
"PG",
"PH",
"PK",
"PL",
"PM",
"PN",
"PR",
"PS",
"PT",
"PW",
"PY",
"QA",
"RE",
"RO",
"RS",
"RU",
"RW",
"SA",
"SB",
"SC",
"SD",
"SE",
"SG",
"SH",
"SI",
"SJ",
"SK",
"SL",
"SM",
"SN",
"SO",
"SR",
"ST",
"SV",
"SX",
"SY",
"SZ",
"TC",
"TD",
"TF",
"TG",
"TH",
"TJ",
"TK",
"TL",
"TM",
"TN",
"TO",
"TR",
"TT",
"TV",
"TW",
"TZ",
"UA",
"UG",
"UM",
"US",
"UY",
"UZ",
"VA",
"VC",
"VE",
"VG",
"VI",
"VN",
"VU",
"WF",
"WS",
"YE",
"YT",
"ZA",
"ZM",
"ZW"
]
},
"CouponConstraint": {
"type": "object",
"properties": {
"expirationDate": {
"type": "string",
"description": "This timestamp provides the expiration date of the coded coupon."
}
},
"description": "This type is used to provide the expiration date of a coded coupon."
},
"CouponDiscountType": {
"type": "object",
"description": "This enumeration type contains the list of coded coupon discount types. Currently, the only supported discount type is an item price discount. | - **ITEM_PRICE**: Indicates that the discount applies to the price of the item.",
"enum": [
"ITEM_PRICE"
]
},
"CurrencyCodeEnum": {
"type": "string",
"description": "This enumerated type defines the three-letter ISO 4217 code representing a world currency. | - **AED**: Indicates the currency is United Arab Emirates dirham. - **AFN**: Indicates the currency is Afghan afghani. - **ALL**: Indicates the currency is Albanian lek. - **AMD**: Indicates the currency is Armenian dram. - **AOA**: Indicates the currency is Angolan kwanza. - **ARS**: Indicates the currency is Argentine peso. - **AWG**: Indicates the currency is Aruban florin. - **AZN**: Indicates the currency is Azerbaijani manat. - **BAM**: Indicates the currency is Bosnia and Herzegovina convertible mark. - **BBD**: Indicates the currency is Barbados dollar. - **BDT**: Indicates the currency is a Bangladeshi taka. - **BGN**: Indicates the currency is Bulgarian lev. - **BHD**: Indicates the currency is Bahraini dinar. - **BIF**: Indicates the currency is Burundian franc. - **BMD**: Indicates the currency is Bermudian dollar. - **BND**: Indicates the currency is Brunei dollar. - **BOB**: Indicates the currency is Bolivian Boliviano. - **BRL**: Indicates the currency is Brazilian real. - **BSD**: Indicates the currency is Bahamian dollar. - **BTN**: Indicates the currency is Bhutanese ngultrum. - **BWP**: Indicates the currency is Botswana pula. - **BYR**: Indicates the currency is Belarusian ruble. - **BZD**: Indicates the currency is Belize dollar. - **CAD**: Indicates the currency is Canadian dollar. - **CDF**: Indicates the currency is Congolese franc. - **CLP**: Indicates the currency is Chilean peso. - **CNY**: Indicates the currency is Chinese yuan renminbi. - **COP**: Indicates the currency is Colombian peso. - **CRC**: Indicates the currency is Costa Rican colon. - **CUP**: Indicates the currency is Cuban peso. - **CVE**: Indicates the currency is Cape Verde escudo. - **CZK**: Indicates the currency is Czech koruna. - **DJF**: Indicates the currency is Djiboutian franc. - **DOP**: Indicates the currency is Dominican peso. - **DZD**: Indicates the currency is Algerian dinar. - **EGP**: Indicates the currency is Egyptian pound. - **ERN**: Indicates the currency is Eritrean nakfa. - **ETB**: Indicates the currency is Ethiopian birr. - **FJD**: Indicates the currency is Fiji dollar. - **FKP**: Indicates the currency is Falkland Islands pound. - **GEL**: Indicates the currency is Georgian lari. - **GHS**: Indicates the currency is Ghanaian cedi. - **GIP**: Indicates the currency is Gibraltar pound. - **DKK**: Indicates the currency is Danish krone. - **GMD**: Indicates the currency is Gambian dalasi. - **GNF**: Indicates the currency is Guinean franc. - **GTQ**: Indicates the currency is Guatemalan quetzal. - **GYD**: Indicates the currency is Guyanese dollar. - **HKD**: Indicates the currency is Hong Kong dollar. - **HNL**: Indicates the currency is Honduran lempira. - **HRK**: Indicates the currency is Croatian kuna. - **HTG**: Indicates the currency is Haitian gourde. - **HUF**: Indicates the currency is Hungarian forint. - **IDR**: Indicates the currency is Indonesian rupiah. - **INR**: Indicates the currency is Indian rupee. - **IQD**: Indicates the currency is Iraqi dinar. - **IRR**: Indicates the currency is Iranian rial. - **ISK**: Indicates the currency is Icelandic krona. - **GBP**: Indicates the currency is British pound sterling. - **JMD**: Indicates the currency is Jamaican dollar. - **JOD**: Indicates the currency is Jordanian dinar. - **JPY**: Indicates the currency is Japanese yen. - **KES**: Indicates the currency is Kenyan shilling. - **KGS**: Indicates the currency is Kyrgyzstani som. - **KHR**: Indicates the currency is Cambodian riel. - **KMF**: Indicates the currency is Comoro franc. - **KPW**: Indicates the currency is North Korean won. - **KRW**: Indicates the currency is South Korean won. - **KWD**: Indicates the currency is Kuwaiti dinar. - **KYD**: Indicates the currency is Cayman Islands dollar. - **KZT**: Indicates the currency is Kazakhstani tenge. - **LAK**: Indicates the currency is Lao kip. - **LBP**: Indicates the currency is Lebanese pound. - **CHF**: Indicates the currency is a Swiss franc. - **LKR**: Indicates the currency is Sri Lankan rupee. - **LRD**: Indicates the currency is Liberian dollar. - **LSL**: Indicates the currency is Lesotho loti. - **LTL**: Indicates the currency is Lithuanian litas. - **LYD**: Indicates the currency is Libyan dinar. - **MAD**: Indicates the currency is Moroccan dirham. - **MDL**: Indicates the currency is Moldovan leu. - **MGA**: Indicates the currency is Malagasy ariary. - **MKD**: Indicates the currency is Macedonian denar. - **MMK**: Indicates the currency is Myanmar kyat. - **MNT**: Indicates the currency is Mongolian tugrik. - **MOP**: Indicates the currency is Macanese pataca. - **MRO**: Indicates the currency is Mauritanian ouguiya. - **XCD**: Indicates the currency is East Caribbean dollar. - **MUR**: Indicates the currency is Mauritian rupee. - **MVR**: Indicates the currency is Maldivian rufiyaa. - **MWK**: Indicates the currency is Malawian kwacha. - **MXN**: Indicates the currency is Mexican peso. - **MYR**: Indicates the currency is Malaysian ringgit. - **MZN**: Indicates the currency is Mozambican metical. - **NAD**: Indicates the currency is Namibian dollar. - **NGN**: Indicates the currency is Nigerian naira. - **NIO**: Indicates the currency is Nicaraguan cordoba oro. - **NPR**: Indicates the currency is Nepalese rupee. - **OMR**: Indicates the currency is Omani rial. - **PAB**: Indicates the currency is Panamanian balboa. - **PEN**: Indicates the currency is Peruvian sol. - **XPF**: Indicates the currency is CFP franc. - **PGK**: Indicates the currency is Papua New Guinean kina. - **PHP**: Indicates the currency is Philippine peso. - **PKR**: Indicates the currency is Pakistani rupee. - **PLN**: Indicates the currency is Polish zloty. - **ILS**: Indicates the currency is Israeli new shekel. - **PYG**: Indicates the currency is Paraguayan guarani. - **QAR**: Indicates the currency is Qatari riyal. - **RON**: Indicates the currency is Romanian leu. - **RSD**: Indicates the currency is Serbian dinar. - **RUB**: Indicates the currency is Russian ruble. - **RWF**: Indicates the currency is Rwandan franc. - **SAR**: Indicates the currency is Saudi riyal. - **SBD**: Indicates the currency is Solomon Islands dollar. - **SCR**: Indicates the currency is Seychelles rupee. - **SDG**: Indicates the currency is Sudanese pound. - **SEK**: Indicates the currency is Swedish krona. - **SGD**: Indicates the currency is Singapore dollar. - **SHP**: Indicates the currency is Saint Helena pound. - **NOK**: Indicates the currency is Norwegian krone. - **SLL**: Indicates the currency is Sierra Leonean leone. - **SOS**: Indicates the currency is Somali shilling. - **SRD**: Indicates the currency is Surinamese dollar. - **STD**: Indicates the currency is Sao Tome and Principe dobra. - **ANG**: Indicates the currency is Netherlands Antillean guilder. - **SYP**: Indicates the currency is Syrian pound. - **SZL**: Indicates the currency is Swazi lilangeni. - **XAF**: Indicates the currency is CFA franc BEAC. - **XOF**: Indicates the currency is CFA franc BCEAO. - **THB**: Indicates the currency is Thai baht. - **TJS**: Indicates the currency is Tajikistani somoni. - **NZD**: Indicates the currency is New Zealand dollar. - **TMT**: Indicates the currency is Turkmenistani manat. - **TND**: Indicates the currency is Tunisian dinar. - **TOP**: Indicates the currency is Tongan pa'anga. - **TRY**: Indicates the currency is Turkish lira. - **TTD**: Indicates the currency is Trinidad and Tobago dollar. - **AUD**: Indicates the currency is Australian dollar. - **TWD**: Indicates the currency is New Taiwan dollar. - **TZS**: Indicates the currency is Tanzanian shilling. - **UAH**: Indicates the currency is Ukrainian hryvnia. - **UGX**: Indicates the currency is Ugandan shilling. - **USD**: Indicates the currency is United States dollar. - **UYU**: Indicates the currency is Uruguayan peso. - **UZS**: Indicates the currency is Uzbekistani som. - **VEF**: Indicates the currency is Venezuelan bolivar. - **VND**: Indicates the currency is Vietnamese dong. - **VUV**: Indicates the currency is Vanuatu vatu. - **WST**: Indicates the currency is Samoan tala. - **YER**: Indicates the currency is Yemeni rial. - **EUR**: Indicates the currency is European Union euro. - **ZAR**: Indicates the currency is South African rand. - **ZMW**: Indicates the currency is Zambian kwacha. - **ZWL**: Indicates the currency is Zimbabwean dollar.",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTN",
"BWP",
"BYR",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LTL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRO",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"STD",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW",
"ZWL"
]
},
"DeliveryOptionsEnum": {
"type": "object",
"description": "The enumerated type that defines the values that represent how the item can be delivered. Code so that your app gracefully handles any future changes to this list. | - **SHIP_TO_HOME**: Indicates the item can be shipped to the recipient. - **SELLER_ARRANGED_LOCAL_PICKUP**: Indicates the seller will arrange to have the buyer pick-up the item. (Local delivery option) - **IN_STORE_PICKUP**: Indicates the buyer will pick-up the item in a store. (Local delivery option) - **PICKUP_DROP_OFF**: Indicates the item is dropped off or sent to a pickup location and the buyer collects the item at that location. - **DIGITAL_DELIVERY**: Indicates the item is delivered via email. ", "enum": [ "SHIP_TO_HOME", "SELLER_ARRANGED_LOCAL_PICKUP", "IN_STORE_PICKUP", "PICKUP_DROP_OFF", "DIGITAL_DELIVERY" ] }, "EconomicOperator": { "type": "object", "properties": { "companyName": { "type": "string", "description": "The company name of the registered Economic Operator." }, "addressLine1": { "type": "string", "description": "The first line of the registered Economic Operator's street address." }, "addressLine2": { "type": "string", "description": "The second line, if any, of the registered Economic Operator's street address. This field is not always used, but can be used for 'Suite Number' or 'Apt Number'." }, "city": { "type": "string", "description": "The city of the registered Economic Operator's street address." }, "stateOrProvince": { "type": "string", "description": "The state or province of the registered Economic Operator's street address." }, "postalCode": { "type": "string", "description": "The postal code of the registered Economic Operator's street address." }, "country": { "type": "string", "description": "The two-letter ISO 3166 standard abbreviation of the country of the registered Economic Operator's address." }, "phone": { "type": "string", "description": "The registered Economic Operator's business phone number." }, "email": { "type": "string", "description": "The registered Economic Operator's business email address." } }, "description": "The type that provides required Economic Operator information about the manufacturer and/or supplier of the item." }, "Error": { "type": "object", "properties": { "category": { "type": "string", "description": "Identifies the type of error." }, "domain": { "type": "string", "description": "Name for the primary system where the error occurred. This is relevant for application errors." }, "errorId": { "type": "integer", "description": "A unique number to identify the error.", "format": "int32" }, "inputRefIds": { "type": "array", "description": "An array of request elements most closely associated to the error.", "items": { "type": "string" } }, "longMessage": { "type": "string", "description": "A more detailed explanation of the error." }, "message": { "type": "string", "description": "Information on how to correct the problem, in the end user's terms and language where applicable." }, "outputRefIds": { "type": "array", "description": "An array of request elements most closely associated to the error.", "items": { "type": "string" } }, "parameters": { "type": "array", "description": "An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.", "items": { "$ref": "#/components/schemas/ErrorParameter" } }, "subdomain": { "type": "string", "description": "Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc." } }, "description": "This type defines the fields that can be returned in an error." }, "ErrorDetailV3": { "type": "object", "required": [ "category", "domain", "errorId", "message" ], "properties": { "category": { "type": "string", "description": "This string value indicates the error category. There are three categories of errors: request errors, application errors, and system errors." }, "domain": { "type": "string", "description": "The name of the primary system where the error occurred. This is relevant for application errors." }, "errorId": { "type": "integer", "description": "A unique code that identifies the particular error or warning that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.", "format": "int64" }, "inputRefIds": { "type": "array", "description": "An array of reference IDs that identify the specific request elements most closely associated to the error or warning, if any.", "items": { "type": "string" } }, "longMessage": { "type": "string", "description": "A detailed description of the condition that caused the error or warning, and information on what to do to correct the problem." }, "message": { "type": "string", "description": "A description of the condition that caused the error or warning." }, "outputRefIds": { "type": "array", "description": "An array of reference IDs that identify the specific response elements most closely associated to the error or warning, if any.", "items": { "type": "string" } }, "parameters": { "type": "array", "description": "An array of warning and error messages that return one or more variables contextual information about the error or warning. This is often the field or value that triggered the error or warning.", "items": { "$ref": "#/components/schemas/ErrorParameterV3" } }, "subdomain": { "type": "string", "description": "The name of the subdomain in which the error or warning occurred." } }, "description": "The type that defines the fields that can be returned in an error.", "examples": [ { "domain": "domain", "subdomain": "subdomain", "outputRefIds": [ "outputRefIds", "outputRefIds" ], "errorId": 6, "inputRefIds": [ "inputRefIds", "inputRefIds" ], "category": "category", "message": "message", "longMessage": "longMessage", "parameters": [ { "name": "name", "value": "value" }, { "name": "name", "value": "value" } ] } ] }, "ErrorParameter": { "type": "object", "properties": { "name": { "type": "string", "description": "The object of the error.", "examples": [ "categoryId" ] }, "value": { "type": "string", "description": "The value of the object.", "examples": [ "1234" ] } }, "description": "Used to specify information relevant to the end user/client." }, "ErrorParameterV3": { "type": "object", "properties": { "name": { "type": "string", "description": "This is the name of input field that caused an issue with the call request." }, "value": { "type": "string", "description": "This is the actual value that was passed in for the element specified in the
name field."
}
},
"description": "An array of name/value pairs that provide details regarding the error.",
"examples": [
{
"name": "name",
"value": "value"
}
]
},
"EstimatedAvailability": {
"type": "object",
"properties": {
"availabilityThreshold": {
"type": "integer",
"description": "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). The value of this field will be \"10\", which is the threshold value. Code so that your app gracefully handles any future changes to this value.", "format": "int32" }, "availabilityThresholdType": { "description": " 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). The value of this field will be
MORE_THAN. This indicates that the seller has more than the 'quantity display preference', which is 10, in stock for this item. The following are the display item quantity preferences the seller can set.
- Display \"More than 10 available\" in your listing (if applicable)
- If the seller enables this preference, this field is returned as long as there are more than 10 of this item in inventory.
- 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 estimatedAvailableQuantity field.
- Display the exact quantity in your items
If the seller enables this preference, the availabilityThresholdType and availabilityThreshold fields are not returned and the estimated quantity of the item is returned in the estimatedAvailableQuantity field.
Note: Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity.
Code so that your app gracefully handles any future changes to these preferences.", "$ref": "#/components/schemas/AvailabilityThresholdEnum" }, "deliveryOptions": { "type": "array", "description": "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 gracefully handles any future changes to this list. ", "items": { "$ref": "#/components/schemas/DeliveryOptionsEnum" } }, "estimatedAvailabilityStatus": { "description": "An enumeration value representing the inventory status of this item.
Note: Be sure to review the itemEndDate field to determine whether the item is available for purchase.
Valid Values: IN_STOCK, LIMITED_STOCK, or OUT_OF_STOCK
Code so that your app gracefully handles any future changes to this list.", "$ref": "#/components/schemas/AvailabilityStatusEnum" }, "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.
Note: To see if a listing is available for purchase, review the itemEndDate and estimatedAvailablityStatus fields. If the item has an EndDate in the past, or the estimatedAvailabilityStatus is
OUT_OF_STOCK, the item is unavailable for purchase.",
"format": "int32"
},
"estimatedRemainingQuantity": {
"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.Note: To see if a listing is available for purchase, review the itemEndDate and estimatedAvailablityStatus fields. If the item has an EndDate in the past, or the estimatedAvailabilityStatus is
OUT_OF_STOCK, the item is unavailable for purchase.",
"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."
},
"FilterField": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "Provides a way to specify the field for the filter."
},
"negated": {
"type": "boolean",
"description": "Note:Currently this filter is not supported."
},
"range": {
"description": "Provides a way to specify a range of values for the filter. ",
"$ref": "#/components/schemas/RangeValue"
},
"set": {
"type": "array",
"description": "Provides a way to specify a \"list of values\" for the filter.",
"items": {
"type": "string"
}
},
"value": {
"type": "string",
"description": "Provides a way to specify the value of the field."
}
},
"description": "The type that enables the service to filter result sets by field values. Refer to Buy API Field Filters for the list and examples of the supported filters."
},
"FulfilledThroughEnum": {
"type": "object",
"description": "An enumerated type that defines the values that represent fulfillment programs. | - **GLOBAL_SHIPPING**: Indicates the item is being shipped using the eBay Global Shipping Program. - **INTERNATIONAL_SHIPPING**: Indicates the item is being shipped using the eBay International Shipping program. ",
"enum": [
"GLOBAL_SHIPPING",
"INTERNATIONAL_SHIPPING"
]
},
"HazardPictogram": {
"type": "object",
"properties": {
"pictogramDescription": {
"type": "string",
"description": "The description of the hazard pictogram, such as Flammable."
},
"pictogramId": {
"type": "string",
"description": "The ID of the hazard pictogram."
},
"pictogramUrl": {
"type": "string",
"description": "The URL of the hazard pictogram."
}
},
"description": "A type that defines the pictogram for the type of hazard that a hazardous material represents."
},
"HazardStatement": {
"type": "object",
"properties": {
"statementDescription": {
"type": "string",
"description": "A description of the nature of the hazard, such as whether the material is toxic if swallowed."
},
"statementId": {
"type": "string",
"description": "The ID of the hazard statement."
}
},
"description": "A type that defines the hazard statement for a hazardous material."
},
"HazardousMaterialsLabels": {
"type": "object",
"properties": {
"additionalInformation": {
"type": "string",
"description": "Additional information about the hazardous materials labels."
},
"pictograms": {
"type": "array",
"description": "An array of hazard pictograms that apply to the item.",
"items": {
"$ref": "#/components/schemas/HazardPictogram"
}
},
"signalWord": {
"type": "string",
"description": "The signal word for the hazardous materials label (such as Danger or Warning)."
},
"signalWordId": {
"type": "string",
"description": "The ID of the signal word for the hazardous materials label."
},
"statements": {
"type": "array",
"description": "An array of hazard statements for the item.",
"items": {
"$ref": "#/components/schemas/HazardStatement"
}
}
},
"description": "A type that defines the hazardous materials labels for an item."
},
"Image": {
"type": "object",
"properties": {
"height": {
"type": "integer",
"description": "Reserved for future use.",
"format": "int32"
},
"imageUrl": {
"type": "string",
"description": "The URL of the image."
},
"width": {
"type": "integer",
"description": "Reserved for future use.",
"format": "int32"
}
},
"description": "This type defines the details of an image, such as size and image URL. Currently, only imageUrl is populated. The height and width are reserved for future use."
},
"Item": {
"type": "object",
"required": [
"categoryId",
"categoryIdPath",
"categoryPath",
"description",
"eligibleForInlineCheckout",
"enabledForGuestCheckout",
"immediatePay",
"itemId",
"itemWebUrl",
"legacyItemId",
"listingMarketplaceId",
"priorityListing",
"seller",
"title"
],
"properties": {
"additionalImages": {
"type": "array",
"description": "An array of containers with the URLs for the images that are in addition to the primary image. The primary image is returned in the image.imageUrl field.",
"items": {
"$ref": "#/components/schemas/Image"
}
},
"addonServices": {
"type": "array",
"description": "A list of add-on services that may be selected for the item or that may apply automatically.",
"items": {
"$ref": "#/components/schemas/AddonService"
}
},
"adultOnly": {
"type": "boolean",
"description": "This indicates if the item is for adults only. For more information about adult-only items on eBay, see Adult items policy for sellers and Adult-Only items on eBay for buyers."
},
"ageGroup": {
"type": "string",
"description": "(Primary Item Aspect) The age group for which the product is recommended. For example, newborn, infant, toddler, kids, adult, etc. All the item aspects, including this aspect, are returned in the localizedAspects container."
},
"authenticityGuarantee": {
"description": "A container for information about whether an item, or the item group when returned for the getItemsByItemGroup method, is qualified for the Authenticity Guarantee program.Note: The
AUTHENTICITY_GUARANTEE value being returned by the getItemsByItemGroup method indicates that at least one item in the item group supports this program, but doesn't guarantee that the program is available to all items in the item group. To verify if the Authenticity Program is indeed available for the item that you are interested in, grab the items.itemId value for that item and use the getItem method. This method will return specific details on that particular item, including whether or not the Authenticity Guarantee Program is available for the item. Look for the qualifiedPrograms array and authenticityGuarantee container in the getItem response for this information.Under the Authenticity Guarantee program, the seller ships a purchased item to a a third-party authenticator who inspects the item and provides an authentication card for it before the item is shipped to the buyer. If the buyer returns the item, the authenticator first verifies that it is the same item in the same condition before returning it to the seller.
Note: Refer to the Authenticity Guarantee page for more information.", "$ref": "#/components/schemas/AuthenticityGuaranteeProgram" }, "authenticityVerification": { "description": "A container for information about whether an item is from a verified seller.", "$ref": "#/components/schemas/AuthenticityVerificationProgram" }, "availableCoupons": { "type": "array", "description": "A list of available coupons for the item.
Note: The Browse API only acknowledges item-level coupons. This array will only return coupons linked with an item. Store-level coupons offered by sellers across their entire store will not be returned.", "items": { "$ref": "#/components/schemas/AvailableCoupon" } }, "bidCount": { "type": "integer", "description": "This integer value indicates the total number of bids that have been placed against an auction item. This field is returned only for auction items.", "format": "int32" }, "brand": { "type": "string", "description": "(Primary Item Aspect) The name brand of the item, such as Nike, Apple, etc. All the item aspects, including this aspect, are returned in the localizedAspects container." }, "buyingOptions": { "type": "array", "description": "A comma separated list of all the purchase options available for the item. The values returned are:
FIXED_PRICE- Indicates the buyer can purchase the item for a set price using the Buy It Now button.AUCTION- Indicates the buyer can place a bid for the item. After the first bid is placed, this becomes a live auction item and is the only buying option for this item.BEST_OFFER- Indicates the buyer can send the seller a price they're willing to pay for the item. The seller can accept, reject, or send a counter offer. For more information on how this works, see Making a Best Offer.CLASSIFIED_AD- Indicates that the final sales transaction is to be completed outside of the eBay environment.
For example, if an item belongs to the top level category Home and Garden (category ID 11700), followed by Home Improvement (159907), Heating, Cooling and Air (69197), and Thermostats (115947), the field would return the value:
11700|159907|69197|115947."
},
"categoryPath": {
"type": "string",
"description": "Text that shows the category hierarchy of the item. For example: Computers/Tablets & Networking, Laptops & Netbooks, PC Laptops & Netbooks"
},
"charityTerms": {
"description": "This container returns any applicable charity information associated with the specified item.This container is only returned if the fieldgroups query parameter is set to
CHARITY_DETAILS.",
"$ref": "#/components/schemas/ItemCharityTerms"
},
"color": {
"type": "string",
"description": "(Primary Item Aspect) Text describing the color of the item. All the item aspects, including this aspect, are returned in the localizedAspects container."
},
"condition": {
"type": "string",
"description": "A short text description for the condition of the item, such as New or Used. For a list of condition names, see Item Condition IDs and Names. Code so that your app gracefully handles any future changes to this list." }, "conditionDescription": { "type": "string", "description": "A full text description for the condition of the item. This field elaborates on the value specified in the condition field and provides full details for the condition of the item." }, "conditionDescriptors": { "type": "array", "description": "This array is used by the seller to provide additional information about the condition of an item in a structured format. Condition descriptors are name-value attributes that indicate details about a particular condition of an item.
Note: Condition descriptors are currently only available for the following trading card categories:
- Non-Sport Trading Card Singles
- CCG Individual Cards
- Sports Trading Card Singles
Code so that your app gracefully handles any future changes to this list." }, "currentBidPrice": { "description": "The container that returns the current highest bid for an auction item. The value (string) field shows the dollar value of the current highest bid, and the currency (3-digit ISO code) field denotes the currency associated with that bid value. This container will only be returned for auction items.", "$ref": "#/components/schemas/ConvertedAmount" }, "description": { "type": "string", "description": "The full description of the item that was created by the seller. This can be plain text or rich content and can be very large." }, "ecoParticipationFee": { "description": "The Eco Participation fee, a fee paid by the buyer that is applied to the cost of the eventual disposal of the purchased item. The fee is remitted in full to the eco organization.
Currently, this value is required for electronic devices and furniture.", "$ref": "#/components/schemas/ConvertedAmount" }, "eligibleForInlineCheckout": { "type": "boolean", "description": "This field indicates if the item can be purchased using the Buy Order API.
- If the value of this field is
true, this indicates that the item can be purchased using the Order API. - If the value of this field is
false, this indicates that the item cannot be purchased using the Order API and must be purchased on the eBay site.
The rating is a set of energy efficiency classes from A to G, where 'A' is the most energy efficient and 'G' is the least efficient. This rating helps buyers choose between various models.
When the manufacturer's specifications for this item are available, the link to this information is returned in the productFicheWebUrl field." }, "epid": { "type": "string", "description": "An EPID is the eBay product identifier of a product from the eBay product catalog. This indicates the product in which the item belongs." }, "estimatedAvailabilities": { "type": "array", "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.", "items": { "$ref": "#/components/schemas/EstimatedAvailability" } }, "gender": { "type": "string", "description": "(Primary Item Aspect) The gender for the item. This is used for items that could vary by gender, such as clothing. For example: male, female, or unisex. All the item aspects, including this aspect, are returned in the localizedAspects container." }, "gtin": { "type": "string", "description": "The unique Global Trade Item number of the item as defined by https://www.gtin.info. This can be a UPC (Universal Product Code), EAN (European Article Number), or an ISBN (International Standard Book Number) value." }, "hazardousMaterialsLabels": { "description": "Hazardous materials labels for the item.", "$ref": "#/components/schemas/HazardousMaterialsLabels" }, "image": { "description": "The URL of the primary image of the item. The other images of the item are returned in the additionalImages container.", "$ref": "#/components/schemas/Image" }, "immediatePay": { "type": "boolean", "description": "A value of
true indicates that the seller requires immediate payment from the buyer when purchasing an item.Note: It is possible for this field to be set to
true, but not apply in some scenarios. For example, immediate payment is not applicable for auction listings that have a winning bidder, for buyers purchases that involve the Best Offer feature, or for offline transactions."
},
"inferredEpid": {
"type": "string",
"description": "The ePID (eBay Product ID of a product from the eBay product catalog) for the item, which has been programmatically determined by eBay using the item's title, aspects, and other data. If the seller provided an ePID for the item, the seller's value is returned in the epid field.
Note: This field is returned only for authorized Partners." }, "itemAffiliateWebUrl": { "type": "string", "description": "The URL to the View Item page of the item which includes the affiliate tracking ID.
Note: In order to receive commissions on sales, eBay Partner Network affiliates must use this URL to forward buyers to the listing on the eBay marketplace.
The itemAffiliateWebUrl is only returned if:
- The marketplace through which the item is being viewed is part of the eBay Partner Network. Currently Singapore (
EBAY_SG) is not supported.
For additional information, refer to eBay Partner Network. - The seller enables affiliate tracking for the item by including the
X-EBAY-C-ENDUSERCTXrequest header in the method.
This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which can be converted into the local time of the buyer." }, "itemEndDate": { "type": "string", "description": "A timestamp that indicates the date and time an auction listing will end.
If a fixed-price listing has ended, this field indicates the date and time the listing ended.
This value is returned in UTC format (
yyyy-MM-ddThh:mm:ss.sssZ), which can be converted into the local time of the buyer."
},
"itemId": {
"type": "string",
"description": "The unique RESTful identifier of the item."
},
"itemLocation": {
"description": "The physical location of the item.",
"$ref": "#/components/schemas/Address"
},
"itemWebUrl": {
"type": "string",
"description": "The URL of the View Item page of the item. This enables you to include a \"Report Item on eBay\" link that takes the buyer to the View Item page on eBay. From there they can report any issues regarding this item to eBay."
},
"legacyItemId": {
"type": "string",
"description": "The unique identifier of the eBay listing that contains the item. This is the traditional/legacy ID that is often seen in the URL of the listing View Item page."
},
"listingMarketplaceId": {
"description": "The ID of the eBay marketplace where the item is listed.",
"$ref": "#/components/schemas/MarketplaceIdEnum"
},
"localizedAspects": {
"type": "array",
"description": "An array of containers that show the complete list of the aspect name/value pairs that describe the variation of the item.",
"items": {
"$ref": "#/components/schemas/TypedNameValue"
}
},
"lotSize": {
"type": "integer",
"description": "The number of items in a lot. In other words, a lot size is the number of items that are being sold together. A lot is a set of two or more items included in a single listing that must be purchased together in a single order line item. All the items in the lot are the same but there can be multiple items in a single lot, such as the package of batteries shown in the example below.
| Item | Lot Definition | Lot Size |
|---|---|---|
| A package of 24 AA batteries | A box of 10 packages | 10 |
| A P235/75-15 Goodyear tire | 4 tires | 4 |
| Fashion Jewelry Rings | Package of 100 assorted rings | 100 |
Note: Lots are not supported in all categories. ", "format": "int32" }, "manufacturer": { "description": "Contact information for the manufacturer of the product.", "$ref": "#/components/schemas/CompanyAddress" }, "marketingPrice": { "description": "The original price and the discount amount and percentage.", "$ref": "#/components/schemas/MarketingPrice" }, "material": { "type": "string", "description": "(Primary Item Aspect) Text describing what the item is made of. For example, silk. All the item aspects, including this aspect, are returned in the localizedAspects container." }, "minimumPriceToBid": { "description": "The minimum price of the next bid, which means to place a bid it must be equal to or greater than this amount. If the auction hasn't received any bids, the minimum bid price is the same as the starting bid. Otherwise, the minimum bid price is equal to the current bid plus the bid increment. For details about bid increments, see Automatic bidding.", "$ref": "#/components/schemas/ConvertedAmount" }, "mpn": { "type": "string", "description": "The manufacturer's part number, which is a unique number that identifies a specific product. To identify the product, this is always used along with brand." }, "pattern": { "type": "string", "description": "(Primary Item Aspect) Text describing the pattern used on the item. For example, paisley. All the item aspects, including this aspect, are returned in the localizedAspects container." }, "paymentMethods": { "type": "array", "description": "The payment methods for the item, including the payment method types, brands, and instructions for the buyer.", "items": { "$ref": "#/components/schemas/PaymentMethod" } }, "price": { "description": "The cost of just the item. This amount does not include any adjustments such as discounts or shipping costs.
Note: The price does include the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the
X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB) to see the VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU.",
"$ref": "#/components/schemas/ConvertedAmount"
},
"priceDisplayCondition": {
"description": "Indicates when in the buying flow the item's price can appear for minimum advertised price (MAP) items, which is the lowest price a retailer can advertise/show for this item.",
"$ref": "#/components/schemas/PriceDisplayConditionEnum"
},
"primaryItemGroup": {
"description": "The container that returns details of a primary item group (parent ID of an item group). An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. When an item group is created, one of the item variations, such as the red shirt size L, is chosen as the \"parent\". All the other items in the group are the children, such as the blue shirt size L, red shirt size M, etc.
Note: This container is returned only if the item_id in the request is for an item group (items with variations, such as color and size).", "$ref": "#/components/schemas/ItemGroupSummary" }, "primaryProductReviewRating": { "description": "The container that returns the product rating details, such as review count, rating histogram, and average rating.", "$ref": "#/components/schemas/ReviewRating" }, "priorityListing": { "type": "boolean", "description": "This field is returned as
true if the listing is part of a Promoted Listing campaign. Promoted Listings are available to Above Standard and Top Rated sellers with recent sales activity.For more information, see Promoted Listings." }, "product": { "description": "The container that returns the product information of the item.", "$ref": "#/components/schemas/Product" }, "productFicheWebUrl": { "type": "string", "description": "The URL of a page containing the manufacturer's specification of this item, which helps buyers make a purchasing decision. This information is available only for items that include the European energy efficiency rating (EEK) but is not available for all items with an EEK rating and is returned only if this information is available. The EEK rating of the item is returned in the energyEfficiencyClass field." }, "productSafetyLabels": { "description": "This container provides product safety labels which were provided by the seller, for the listing.
The getProductSafetyLabels method of the Sell Metadata API can be used to retrieve the full set of available Product Safety pictogram labels and safety statements.", "$ref": "#/components/schemas/ProductSafetyLabels" }, "qualifiedPrograms": { "type": "array", "description": "An array of the qualified programs available for the item, such as
EBAY_PLUS, AUTHENTICITY_GUARANTEE, and AUTHENTICITY_VERIFICATION.eBay Plus is a premium account option for buyers, which provides benefits such as fast, free domestic shipping and free returns on selected items. Sellers must commit to next-day delivery of those items.The eBay Authenticity Guarantee program enables third-party authenticators to perform authentication verification inspections on items such as watches and sneakers.
Note: eBay Plus was recently deprecated on the eBay Germany marketplace, and this feature is now only available on eBay Australia marketplace.", "items": { "type": "string" } }, "quantityLimitPerBuyer": { "type": "integer", "description": "The maximum number for a specific item that one buyer can purchase.", "format": "int32" }, "repairScore": { "type": "string", "description": "A score that describes how easy it is to repair the product. Score values range from 0.1 (hardest to repair) to 10.0 (easiest), always including a single decimal place." }, "reservePriceMet": { "type": "boolean", "description": "This indicates if the reserve price of the item has been met. A reserve price is set by the seller and is the minimum amount the seller is willing to sell the item for.
If the highest bid is not equal to or higher than the reserve price when the auction ends, the listing ends and the item is not sold.
Note: This is returned only for auctions that have a reserve price.
" }, "responsiblePersons": { "type": "array", "description": "This array provides information about one or more EU-based Responsible Persons or entities associated with the listing.", "items": { "$ref": "#/components/schemas/ResponsiblePerson" } }, "returnTerms": { "description": "The container that returns an overview of the seller's return policy.", "$ref": "#/components/schemas/ItemReturnTerms" }, "seller": { "description": "The container that returns basic and detailed about the seller of the item, such as name, feedback score, and contact information.", "$ref": "#/components/schemas/SellerDetail" }, "sellerCustomPolicies": { "type": "array", "description": "A list of the custom policies that are applied to a listing.", "items": { "$ref": "#/components/schemas/SellerCustomPolicy" } }, "sellerItemRevision": { "type": "string", "description": "An identifier generated/incremented when a seller revises the item. There are two types of item revisions:- Seller changes, such as changing the title
- eBay system changes, such as changing the quantity when an item is purchased
Note: For items with calculated shipping, this array is only returned if the X-EBAY-C-ENDUSERCTX header is supplied. ", "items": { "$ref": "#/components/schemas/ShippingOption" } }, "shipToLocations": { "description": "The container that returns the geographic regions to be included and excluded that define where the item can be shipped.", "$ref": "#/components/schemas/ShipToLocations" }, "shortDescription": { "type": "string", "description": "This text string is derived from the item condition and the item aspects (such as size, color, capacity, model, brand, etc.)." }, "size": { "type": "string", "description": "(Primary Item Aspect) The size of the item. For example, '7' for a size 7 shoe. All the item aspects, including this aspect, are returned in the localizedAspects container." }, "sizeSystem": { "type": "string", "description": "(Primary Item Aspect) The sizing system of the country. All the item aspects, including this aspect, are returned in the localizedAspects container.
Valid Values:
AU (Australia),
BR (Brazil),
CN (China),
DE (Germany),
EU (European Union),
FR (France),
IT (Italy),
JP (Japan),
MX (Mexico),
US (USA),
UK (United Kingdom)
Code so that your app gracefully handles any future changes to this list. " }, "sizeType": { "type": "string", "description": "(Primary Item Aspect) Text describing a size group in which the item would be included, such as regular, petite, plus, big-and-tall or maternity. All the item aspects, including this aspect, are returned in the localizedAspects container." }, "subtitle": { "type": "string", "description": "A subtitle is optional and allows the seller to provide more information about the product, possibly including keywords that may assist with search results." }, "taxes": { "type": "array", "description": "The container for the tax information for the item.", "items": { "$ref": "#/components/schemas/Taxes" } }, "title": { "type": "string", "description": "The seller-created title of the item.
Maximum Length: 80 characters" }, "topRatedBuyingExperience": { "type": "boolean", "description": "This indicates if the item a top-rated plus item. There are three benefits of a top-rated plus item: a minimum 30-day money-back return policy, shipping the items in 1 business day with tracking provided, and the added comfort of knowing this item is from experienced sellers with the highest buyer ratings. See the Top Rated Plus Items and Becoming a Top Rated Seller and qualifying for Top Rated Plus help topics for more information." }, "tyreLabelImageUrl": { "type": "string", "description": "The URL to the image that shows the information on the tyre label." }, "uniqueBidderCount": { "type": "integer", "description": "This integer value indicates the number of different eBay users who have placed one or more bids on an auction item. This field is only applicable to auction items.", "format": "int32" }, "unitPrice": { "description": "This is the price per unit for the item. Some European countries require listings for certain types of products to include the price per unit so buyers can accurately compare prices.
For example:
\"unitPricingMeasure\": \"100g\",
\"unitPrice\": {
\"value\": \"7.99\",
\"currency\": \"GBP\"",
"$ref": "#/components/schemas/ConvertedAmount"
},
"unitPricingMeasure": {
"type": "string",
"description": "The designation, such as size, weight, volume, count, etc., that was used to specify the quantity of the item. This helps buyers compare prices. For example, the following tells the buyer that the item is 7.99 per 100 grams.
\"unitPricingMeasure\": \"100g\",
\"unitPrice\": {
\"value\": \"7.99\",
\"currency\": \"GBP\""
},
"warnings": {
"type": "array",
"description": "An array of warning messages. These types of errors do not prevent the method from executing but should be checked.",
"items": {
"$ref": "#/components/schemas/ErrorDetailV3"
}
},
"watchCount": {
"type": "integer",
"description": "The number of users that have added the item to their watch list.Note: This field is restricted to applications that have been granted permission to access this feature. You must submit an App Check ticket to request this access. In the App Check form, add a note to the Application Title/Summary and/or Application Details fields that you want access to Watch Count data in the Browse API.", "format": "int32" } }, "description": "This type describes the details of an item that can be purchased." }, "ItemCharityTerms": { "type": "object", "properties": { "charityOrgId": { "type": "string", "description": "The eBay-assigned unique identifier of the charitable organization that will receive a percentage of the sales proceeds from the item." }, "donationPercentage": { "type": "number", "description": "The percentage of the purchase price of the item that the charitable organization (identified in the charityOrgId field) will receive for each sale." }, "LogoImage": { "description": "The details of the charity's logo image, such as the size and URL.
Note: Currently, only the imageUrl is populated.", "$ref": "#/components/schemas/Image" }, "name": { "type": "string", "description": "The name of the charity organization." }, "website": { "type": "string", "description": "The URL to the charity's eBay page." } }, "description": "This type defines the fields for any applicable charity information associated with an item." }, "ItemGroup": { "type": "object", "properties": { "commonDescriptions": { "type": "array", "description": "An array of containers for a description and the item IDs of all the items that have this exact description. Often the item variations within an item group all have the same description. Instead of repeating this description in the item details of each item, a description that is shared by at least one other item is returned in this container. If the description is unique, it is returned in the items.description field.", "items": { "$ref": "#/components/schemas/CommonDescriptions" } }, "items": { "type": "array", "description": "An array of containers for all the item variation details, excluding the description.", "items": { "$ref": "#/components/schemas/Item" } }, "warnings": { "type": "array", "description": "An array of warning messages. These types of errors do not prevent the method from executing but should be checked.", "items": { "$ref": "#/components/schemas/ErrorDetailV3" } } }, "description": "The type that defines the fields for the item details." }, "ItemGroupSummary": { "type": "object", "properties": { "itemGroupAdditionalImages": { "type": "array", "description": "An array of containers with the URLs for images that are in addition to the primary image of the item group. The primary image is returned in the itemGroupImage field.", "items": { "$ref": "#/components/schemas/Image" } }, "itemGroupHref": { "type": "string", "description": "The HATEOAS reference of the parent page of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. " }, "itemGroupId": { "type": "string", "description": "The unique identifier for the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. " }, "itemGroupImage": { "description": "The URL of the primary image of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. ", "$ref": "#/components/schemas/Image" }, "itemGroupTitle": { "type": "string", "description": "The title of the item that appears on the item group page. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. " }, "itemGroupType": { "description": "An enumeration value that indicates the type of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.", "$ref": "#/components/schemas/ItemGroupTypeEnum" } }, "description": "The type that defines the fields for the details of each item in an item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. When an item group is created, one of the item variations, such as the red shirt size L, is chosen as the \"parent\". All the other items in the group are the children, such as the blue shirt size L, red shirt size M, etc.
Note: This container is returned only if the item_id in the request is an item group (parent ID of an item with variations)." }, "ItemGroupTypeEnum": { "type": "object", "description": "An enumerated type for the values that represent the type of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.
Code so that your app gracefully handles any future changes to this list. | - **SELLER_DEFINED_VARIATIONS**: Indicates this group was created by the seller. Currently, this is the only value supported. ", "enum": [ "SELLER_DEFINED_VARIATIONS" ] }, "ItemLocationImpl": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "The first line of the street address." }, "addressLine2": { "type": "string", "description": "The second line of the street address. This field may contain such values as an apartment or suite number." }, "city": { "type": "string", "description": "The city in which the item is located.
Restriction: This field is populated in the
search method response only when fieldgroups = EXTENDED."
},
"country": {
"description": "The two-letter ISO 3166 standard code that indicates the country in which the item is located.",
"$ref": "#/components/schemas/CountryCodeEnum"
},
"county": {
"type": "string",
"description": "The county in which the item is located."
},
"postalCode": {
"type": "string",
"description": "The postal code (or zip code in US) where the item is located. Sellers set a postal code for items when they are listed. The postal code is used for calculating proximity searches. It is anonymized when returned in itemLocation.postalCode via the API."
},
"stateOrProvince": {
"type": "string",
"description": "The state or province in which the item is located."
}
},
"description": "The type that defines the fields for the location of an item, such as information typically used for an address, including postal code, county, state/province, street address, city, and country (2-digit ISO code)."
},
"ItemReturnTerms": {
"type": "object",
"properties": {
"extendedHolidayReturnsOffered": {
"type": "boolean",
"description": "This indicates if the seller has enabled the Extended Holiday Returns feature on the item. Extended Holiday Returns are only applicable during the US holiday season, and gives buyers extra time to return an item. This 'extra time' will typically extend beyond what is set through the returnPeriod value."
},
"refundMethod": {
"description": "An enumeration value that indicates how a buyer is refunded when an item is returned. Valid Values: MONEY_BACK or MERCHANDISE_CREDIT
Code so that your app gracefully handles any future changes to this list.", "$ref": "#/components/schemas/RefundMethodEnum" }, "restockingFeePercentage": { "type": "string", "description": "This string field indicates the restocking fee percentage that the seller has set on the item. Sellers have the option of setting no restocking fee for an item, or they can set the percentage to 10, 15, or 20 percent. So, if the cost of the item was $100, and the restocking percentage was 20 percent, the buyer would be charged $20 to return that item, so instead of receiving a $100 refund, they would receive $80 due to the restocking fee." }, "returnInstructions": { "type": "string", "description": "Text written by the seller describing what the buyer needs to do in order to return the item." }, "returnMethod": { "description": "An enumeration value that indicates the alternative methods for a full refund when an item is returned. This field is returned if the seller offers the buyer an item replacement or exchange instead of a monetary refund.
Valid Values:
- REPLACEMENT - Indicates that the buyer has the option of receiving money back for the returned item, or they can choose to have the seller replace the item with an identical item.
- EXCHANGE - Indicates that the buyer has the option of receiving money back for the returned item, or they can exchange the item for another similar item.
Valid Values:
- SELLER - Indicates the seller will pay for the shipping costs to return the item.
- BUYER - Indicates the buyer will pay for the shipping costs to return the item.
image.imageUrl field.",
"items": {
"$ref": "#/components/schemas/Image"
}
},
"adultOnly": {
"type": "boolean",
"description": "This indicates if the item is for adults only. For more information about adult-only items on eBay, refer to the Adult items policy."
},
"availableCoupons": {
"type": "boolean",
"description": "This boolean attribute indicates if coupons are available for the item.Note: The Browse API only acknowledges item-level coupons. This field will only be returned as true if a coupon is linked with an item. It does not recognize store-level coupons offered by sellers across their entire store." }, "bidCount": { "type": "integer", "description": "This integer value indicates the total number of bids that have been placed for an auction item. This field is only returned for auction items.", "format": "int32" }, "buyingOptions": { "type": "array", "description": "A comma separated list of all the purchase options available for the item.
Values Returned:
FIXED_PRICE
Indicates the buyer can purchase the item for a set price using the Buy It Now button.AUCTION
Indicates the buyer can place a bid for the item. After the first bid is placed, this becomes a live auction item and is the only buying option for this item.BEST_OFFER
Items where the buyer can send the seller a price they are willing to pay for the item. The seller can accept, reject, or send a counter offer. For additional information about Best Offer, refer to Adding Best Offer to your listing and sending offers to buyers.CLASSIFIED_AD
Indicates that the final sales transaction is to be completed outside of the eBay environment.
compatibility_filter product attributes.Valid Values:
EXACTPOSSIBLE
compatibility_filter in the request. This means that if you passed in 5 attributes and only 4 are compatible, only those 4 are returned. If none of the attributes are compatible, this container is not returned.",
"items": {
"$ref": "#/components/schemas/CompatibilityProperty"
}
},
"condition": {
"type": "string",
"description": "The text describing the condition of the item, such as New or Used. For a list of condition names, refer to Item Condition IDs and Names."
},
"conditionId": {
"type": "string",
"description": "The identifier of the condition of the item. For example, 1000 is the identifier for NEW. For a list of condition names and IDs, refer to Item Condition IDs and Names."
},
"currentBidPrice": {
"description": "This container returns the current highest bid for an auction item. The value field shows the dollar value of the current highest bid, and the currency field (3-digit ISO code) denotes the currency associated with that bid value. This field is only returned for auction items.",
"$ref": "#/components/schemas/ConvertedAmount"
},
"distanceFromPickupLocation": {
"description": "This container returns the distance away that the item is from the pickupPostalCode value that was supplied in the method request. This container is only returned if the \"local pickup\" filter fields are used in the request.",
"$ref": "#/components/schemas/TargetLocation"
},
"energyEfficiencyClass": {
"type": "string",
"description": "This indicates the European energy efficiency rating (EEK) of the item. Energy efficiency ratings apply to products listed by commercial vendors in electronics categories only. Currently, this field is only applicable for the Germany site, and is returned only if the seller specifies the energy efficiency rating through item specifics at listing time. Rating values include
A+++, A++, A+, A, B, C, D, E, F, and G."
},
"epid": {
"type": "string",
"description": "An ePID is the eBay product identifier of a product from the eBay product catalog. This indicates the product in which the item belongs."
},
"image": {
"description": "The URL to the primary image of the item.",
"$ref": "#/components/schemas/Image"
},
"itemAffiliateWebUrl": {
"type": "string",
"description": "The URL to the View Item page of the item which includes the affiliate tracking ID.Note: In order to receive commissions on sales, eBay Partner Network affiliates must use this URL to forward buyers to the listing on the eBay marketplace.
The
itemAffiliateWebUrl is returned only if:- The marketplace through which the item is being viewed is part of the eBay Partner Network. Currently Singapore (
EBAY_SG) is not supported.
For additional information, refer to eBay Partner Network. - The seller enables affiliate tracking for the item by including the
X-EBAY-C-ENDUSERCTXrequest header in the method.
yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer.This field is always returned with itemSummaries." }, "itemEndDate": { "type": "string", "description": "A timestamp that indicates the date and time a listing is scheduled to end.
This value is returned in UTC format (
yyyy-MM-ddThh:mm:ss.sssZ), which can be converted into the local time of the buyer."
},
"itemGroupHref": {
"type": "string",
"description": "The HATEOAS reference of the parent page of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.Note: This field is returned only for item groups." }, "itemGroupType": { "type": "string", "description": "The indicates the item group type. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.
Currently only the
SELLER_DEFINED_VARIATIONS is supported and indicates this is an item group created by the seller.Note: This field is returned only for item groups." }, "itemHref": { "type": "string", "description": "The URI for the Browse API getItem method, which can be used to retrieve more details about items in the search results." }, "itemId": { "type": "string", "description": "The unique RESTful identifier of the item." }, "itemLocation": { "description": "This container returns the location of the item. This container consists of fields you typically see for an address, including postal code, county, state/province, street address, city, and country (2-digit ISO code).", "$ref": "#/components/schemas/ItemLocationImpl" }, "itemOriginDate": { "type": "string", "description": "The date and time when the listing was first made available. This date will be retained if an item is relisted. This value is returned in UTC format (
yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer.This timestamp is used to sort the response when the
sort=newlyListed parameter is used.This field is always returned with itemSummaries." }, "itemWebUrl": { "type": "string", "description": "The URL to the View Item page of the item. This enables you to include a \"Report Item on eBay\" hyperlink that takes the buyer to the View Item page on eBay. From there they can report any issues regarding this item to eBay." }, "leafCategoryIds": { "type": "array", "description": "The leaf category IDs of the item. When the item belongs to two leaf categories, the ID values are returned in the order primary, secondary.", "items": { "type": "string" } }, "legacyItemId": { "type": "string", "description": "The unique identifier of the eBay listing that contains the item. This is the traditional/legacy ID that is often seen in the URL of the listing View Item page." }, "listingMarketplaceId": { "description": "The ID of the eBay marketplace on which the seller listed the item.", "$ref": "#/components/schemas/MarketplaceIdEnum" }, "marketingPrice": { "description": "This container is returned if the item is eligible for a seller discount and contains the item's original price, and the seller discount amount and percentage.", "$ref": "#/components/schemas/MarketingPrice" }, "pickupOptions": { "type": "array", "description": "This container returns the local pickup options available to the buyer. This container is returned only if the user is searching for local pickup items and set the local pickup filters in the method request.", "items": { "$ref": "#/components/schemas/PickupOptionSummary" } }, "price": { "description": "The price of the item after it has been converted into another currency.
The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must do one or more of the following to view VAT-inclusive pricing:
- Pass the
X-EBAY-C-MARKETPLACE-IDrequest header specifying the supported marketplace (such asEBAY_GB) - Pass the
contextualLocationvalues for the supported marketplace in theX-EBAY-C-ENDUSERCTXrequest header - Specify the supported marketplace using the
deliveryCountryfilterURI parameter (such asfilter=deliveryCountry:GB)
true if the listing is part of a Promoted Listing campaign. Promoted Listings are available to Above Standard and Top Rated sellers with recent sales activity.Note: Priority Listing is returned only with a Best Match sort and will not be returned for other sort options." }, "qualifiedPrograms": { "type": "array", "description": "An array of the qualified programs available for the item, such as
EBAY_PLUS, AUTHENTICITY_GUARANTEE, and AUTHENTICITY_VERIFICATION.eBay Plus is a premium account option for buyers, which provides benefits such as fast, free domestic shipping and free returns on selected items. Sellers must commit to next-day delivery of those items.The eBay Authenticity Guarantee program enables third-party authenticators to perform authentication verification inspections on items such as watches and sneakers.
Note: eBay Plus was recently deprecated on the eBay Germany marketplace, and this feature is now only available on eBay Australia marketplace.", "items": { "type": "string" } }, "seller": { "description": "This container returns basic information about the seller of the item, such as name, feedback score, etc.", "$ref": "#/components/schemas/Seller" }, "shippingOptions": { "type": "array", "description": "This container returns the shipping options available to ship the item.", "items": { "$ref": "#/components/schemas/ShippingOptionSummary" } }, "shortDescription": { "type": "string", "description": "This text string is derived from the item condition and the item aspects (such as size, color, capacity, model, brand, etc.) Sometimes the title does not provide enough information but the description is too big. Surfacing the
shortDescription can often provide buyers with the additional information that could help them make a buying decision.For example:
\"title\": \"Petrel U42W FPV Drone RC Quadcopter w/HD Camera Live Video One Key Off / Landing\",
\"shortDescription\": \"1 U42W Quadcopter. Syma X5SW-V3 Wifi FPV RC Drone Quadcopter 2.4Ghz 6-Axis Gyro with Headless Mode. Syma X20 Pocket Drone 2.4Ghz Mini RC Quadcopter Headless Mode Altitude Hold. One Key Take Off / Landing function: allow beginner to easy to fly the drone without any skill.\",
Restriction: This field is returned by the search method only when
fieldgroups = EXTENDED."
},
"thumbnailImages": {
"type": "array",
"description": "An array of thumbnail images for the item.",
"items": {
"$ref": "#/components/schemas/Image"
}
},
"title": {
"type": "string",
"description": "The seller-created title of the item.Maximum Length: 80 characters" }, "topRatedBuyingExperience": { "type": "boolean", "description": "This indicates if the item is a top-rated plus item. There are three benefits of a top-rated plus item: a minimum 30-day money-back return policy; shipping the item in 1 business day with tracking provided; and the added comfort of knowing that this item is from an experienced seller with the highest buyer ratings. For more information, refer to Look for Top Rated Plus Items and Seller performance overview." }, "tyreLabelImageUrl": { "type": "string", "description": "The URL to the image that shows the information on the tyre label." }, "unitPrice": { "description": "The price per unit for the item. Some European countries require listings for certain types of products to include the price per unit so buyers can accurately compare prices.
For example:
\"unitPricingMeasure\": \"100g\",", "$ref": "#/components/schemas/ConvertedAmount" }, "unitPricingMeasure": { "type": "string", "description": "The designation, such as size, weight, volume, count, etc., that was used to specify the quantity of the item. This helps buyers compare prices.
\"unitPrice\": {
\"value\": \"7.99\",
\"currency\": \"GBP\"
For example, the following tells the buyer that the item is 7.99 per 100 grams.
\"unitPricingMeasure\": \"100g\"," }, "watchCount": { "type": "integer", "description": "The number of users that have added the item to their watch list.
\"unitPrice\": {
\"value\": \"7.99\",
\"currency\": \"GBP\"
Note: This field is restricted to applications that have been granted permission to access this feature. You must submit an App Check ticket to request this access. In the App Check form, add a note to the Application Title/Summary and/or Application Details fields indicating that you want access to Watch Count data in the Browse API.", "format": "int32" } }, "description": "The type that defines the fields for the details of a specific item." }, "Items": { "type": "object", "properties": { "items": { "type": "array", "description": "An array/list of all the items.", "items": { "$ref": "#/components/schemas/CoreItem" } }, "total": { "type": "integer", "description": "The total number of items retrieved.", "format": "int32" }, "warnings": { "type": "array", "description": "An array of warning messages. These types of errors do not prevent the method from executing but should be checked.", "items": { "$ref": "#/components/schemas/ErrorDetailV3" } } }, "description": "This type defines a list of items." }, "LegalAddress": { "type": "object", "required": [ "city", "stateOrProvince" ], "properties": { "addressLine1": { "type": "string", "description": "The first line of the street address." }, "addressLine2": { "type": "string", "description": "The second line of the street address. This field is not always used, but can be used for 'Suite Number' or 'Apt Number'." }, "city": { "type": "string", "description": "The city of the address." }, "country": { "description": "The two-letter ISO 3166 standard code for the country of the address.", "$ref": "#/components/schemas/CountryCodeEnum" }, "countryName": { "type": "string", "description": "The name of the country of the address." }, "county": { "type": "string", "description": "The name of the county of the address." }, "postalCode": { "type": "string", "description": "The postal code of the address." }, "stateOrProvince": { "type": "string", "description": "The state or province of the address." } }, "description": "This type defines the fields for the seller's address." }, "MarketingPrice": { "type": "object", "properties": { "discountAmount": { "description": "This container returns the monetary amount of the seller discount.", "$ref": "#/components/schemas/ConvertedAmount" }, "discountPercentage": { "type": "string", "description": "This field expresses the percentage of the seller discount based on the value in the originalPrice container." }, "originalPrice": { "description": "This container returns the monetary amount of the item without the discount.", "$ref": "#/components/schemas/ConvertedAmount" }, "priceTreatment": { "description": "Indicates the pricing treatment (discount) that was applied to the price of the item.
Note: The pricing treatment affects the way and where the discounted price can be displayed.", "$ref": "#/components/schemas/PriceTreatmentEnum" } }, "description": "The type that defines the fields that describe a seller discount." }, "MarketplaceIdEnum": { "type": "string", "description": "An enumerated type for the values that represent eBay marketplaces. | - **EBAY_AU**: This enumeration value indicates that the eBay Marketplace is the Australia site (ebay.com.au). - **EBAY_AT**: This enumeration value indicates that the eBay Marketplace is the Austria site (ebay.at). - **EBAY_BE**: This enumeration value indicates that the eBay marketplace is the Belgium (Dutch) site (www.ebay.be). - **EBAY_CA**: This enumeration value indicates that the eBay Marketplace is the Canada (English) site (ebay.ca). - **EBAY_CH**: This enumeration value indicates that the eBay Marketplace is the Switzerland site (ebay.ch). - **EBAY_CN**: This enumeration value indicates that the eBay Marketplace is the China site (ebay.com/sch/China). - **EBAY_CZ**: This enumeration value indicates that the eBay Marketplace is the Czech Republic site (ebay.com/sch/Czech-Republic). - **EBAY_DE**: This enumeration value indicates that the eBay Marketplace is the Germany site (ebay.de). - **EBAY_DK**: This enumeration value indicates that the eBay Marketplace is the Denmark site (ebay.com/sch/Denmark). - **EBAY_ES**: This enumeration value indicates that the eBay Marketplace is the Spain site (ebay.es). - **EBAY_FI**: This enumeration value indicates that the eBay Marketplace is the Finland site (ebay.com/sch/Finland). - **EBAY_FR**: This enumeration value indicates that the eBay Marketplace is the France site (ebay.fr). - **EBAY_GB**: This enumeration value indicates that the eBay Marketplace is the UK site (ebay.co.uk). - **EBAY_GR**: This enumeration value indicates that the eBay Marketplace is the Greece site (ebay.com/sch/Greece). - **EBAY_HALF_US**: This enumeration value is no longer applicable as the Half.com site no longer exists. - **EBAY_HK**: This enumeration value indicates that the eBay Marketplace is the Hong Kong site (ebay.com.hk). - **EBAY_HU**: This enumeration value indicates that the eBay Marketplace is the Hungary site (ebay.com/sch/Hungary). - **EBAY_ID**: This enumeration value indicates that the eBay Marketplace is the Indonesia site (id.ebay.com). - **EBAY_IE**: This enumeration value indicates that the eBay Marketplace is the Ireland site (ebay.ie). - **EBAY_IL**: This enumeration value indicates that the eBay Marketplace is the Israel site (ebay.com/sch/Israel). - **EBAY_IN**: This enumeration value indicates that the eBay Marketplace is the India site (ebay.in). Note: eBay India is no longer a functioning eBay marketplace. - **EBAY_IT**: This enumeration value indicates that the eBay Marketplace is the Italy site (ebay.it). - **EBAY_JP**: This enumeration value indicates that the eBay Marketplace is the Japan site (ebay.co.jp). - **EBAY_MOTORS_US**: This enumeration value indicates that the eBay Marketplace is the US eBay Motors site (ebay.com/motors). - **EBAY_MY**: This enumeration value indicates that the eBay Marketplace is the Malaysia site (ebay.com/my). - **EBAY_NL**: This enumeration value indicates that the eBay Marketplace is the Netherlands site (ebay.nl). - **EBAY_NO**: This enumeration value indicates that the eBay Marketplace is the Norway site (ebay.com/sch/Norway). - **EBAY_NZ**: This enumeration value indicates that the eBay Marketplace is the New Zealand site (ebay.com/sch/New-Zealand). - **EBAY_PE**: This enumeration value indicates that the eBay Marketplace is the Peru site (ebay.com/sch/Peru). - **EBAY_PH**: This enumeration value indicates that the eBay Marketplace is the Philippines site (ebay.ph). - **EBAY_PL**: This enumeration value indicates that the eBay Marketplace is the Poland site (ebay.pl). - **EBAY_PR**: This enumeration value indicates that the eBay Marketplace is the Puerto Rico site (ebay.com/sch/Puerto-Rico). - **EBAY_PT**: This enumeration value indicates that the eBay Marketplace is the Portugal site (ebay.com/sch/Portugal). - **EBAY_RU**: This enumeration value indicates that the eBay Marketplace is the Russia site (ebay.com/sch/Russia). - **EBAY_SE**: This enumeration value indicates that the eBay Marketplace is the Sweden site (ebay.com/sch/Sweden). - **EBAY_SG**: This enumeration value indicates that the eBay Marketplace is the Singapore site (ebay.com/sg). - **EBAY_TH**: This enumeration value indicates that the eBay Marketplace is the Thailand site (export.ebay.co.th). - **EBAY_TW**: This enumeration value indicates that the eBay Marketplace is the Taiwan site (ebay.com/tw). - **EBAY_US**: This enumeration value indicates that the eBay Marketplace is the US site (ebay.com). - **EBAY_VN**: This enumeration value indicates that the eBay Marketplace is the Vietnam site (ebay.vn). - **EBAY_ZA**: This enumeration value indicates that the eBay Marketplace is the South Africa site (ebay.com/sch/South-Africa).", "enum": [ "EBAY_AU", "EBAY_AT", "EBAY_BE", "EBAY_CA", "EBAY_CH", "EBAY_CN", "EBAY_CZ", "EBAY_DE", "EBAY_DK", "EBAY_ES", "EBAY_FI", "EBAY_FR", "EBAY_GB", "EBAY_GR", "EBAY_HALF_US", "EBAY_HK", "EBAY_HU", "EBAY_ID", "EBAY_IE", "EBAY_IL", "EBAY_IN", "EBAY_IT", "EBAY_JP", "EBAY_MOTORS_US", "EBAY_MY", "EBAY_NL", "EBAY_NO", "EBAY_NZ", "EBAY_PE", "EBAY_PH", "EBAY_PL", "EBAY_PR", "EBAY_PT", "EBAY_RU", "EBAY_SE", "EBAY_SG", "EBAY_TH", "EBAY_TW", "EBAY_US", "EBAY_VN", "EBAY_ZA" ] }, "PaymentInstructionEnum": { "type": "object", "description": "An enumerated type for the values that represent the payment instructions, such as cash in person or contact seller. | - **DIRECT_DEBIT**: This enumeration value indicates that eBay will use the debit card information input by the buyer to process the payment. - **ACH**: This enumeration value indicates that the Payflow ACH Payment Service will be used, which enables eBay to process payments through the ACH network and request credit or debit information from the buyer's checking or savings account. - **EFT**: This enumeration value indicates that eBay will process the payment via electronic funds transfer. - **CIP**: This enumeration value indicates that the payment method will be cash, and the transaction will occur in-person. - **MONEY_TRANSFER**: This enumeration value indicates that eBay will process the payment via money transfer. - **CASH_IN_PERSON**: This enumeration value indicates that the payment method will be cash, and the transaction will occur in-person. - **CASH_ON_PICKUP**: This enumeration value indicates that the payment method will be cash, and the transaction will occur when the buyer picks up the item. - **CASH_ON_DELIVERY**: This enumeration value indicates that the payment method will be cash, and the transaction will occur after the item is delivered to the buyer. - **CONTACT_SELLER**: This enumeration value indicates that the buyer should contact the seller for payment instructions. - **PAY_UPON_INVOICE**: This enumeration value indicates that eBay will process the payment upon invoice. ", "enum": [ "DIRECT_DEBIT", "ACH", "EFT", "CIP", "MONEY_TRANSFER", "CASH_IN_PERSON", "CASH_ON_PICKUP", "CASH_ON_DELIVERY", "CONTACT_SELLER", "PAY_UPON_INVOICE" ] }, "PaymentMethod": { "type": "object", "description": "This type defines information about the payment method for a listing.", "properties": { "paymentMethodType": { "description": "The payment method type, such as credit card or cash.", "$ref": "#/components/schemas/PaymentMethodTypeEnum" }, "paymentMethodBrands": { "type": "array", "description": "The payment method brands, including the payment method brand type and logo image.", "items": { "$ref": "#/components/schemas/PaymentMethodBrand" } }, "paymentInstructions": { "type": "array", "description": "The payment instructions for the buyer, such as cash in person or contact seller.", "items": { "$ref": "#/components/schemas/PaymentInstructionEnum" } }, "sellerInstructions": { "type": "array", "description": "The seller instructions to the buyer, such as accepts credit cards or see description.", "items": { "$ref": "#/components/schemas/SellerInstructionEnum" } } } }, "PaymentMethodBrand": { "type": "object", "description": "This type defines information about the brand for a payment method.", "properties": { "paymentMethodBrandType": { "description": "The payment method brand, such as Visa or PayPal.", "$ref": "#/components/schemas/PaymentMethodBrandEnum" }, "logoImage": { "description": "The details of the logo image, such as the size and URL.
Note: Currently, only the imageUrl is populated.", "$ref": "#/components/schemas/Image" } } }, "PaymentMethodBrandEnum": { "type": "object", "description": "An enumerated type for the values that represent the payment method brand, such as Visa or PayPal. | - **VISA**: This enumeration value indicates that Visa is an authorized brand for credit or debit card transactions. - **MASTERCARD**: This enumeration value indicates that Mastercard is an authorized brand for credit or debit card transactions. - **DISCOVER**: This enumeration value indicates that Discover is an authorized brand for credit card transactions. - **AMERICAN_EXPRESS**: This enumeration value indicates that American Express is an authorized brand for credit card transactions. - **CB_NATIONALE**: This enumeration value indicates that Carte Bancaire (CB) Nationale is an authorized brand for credit card transactions. - **CETELEM**: This enumeration value indicates that Cetelem is an authorized brand for credit card transactions. - **COFIDIS**: This enumeration value indicates that Confidis is an authorized brand for credit card transactions. - **COFINOGA**: This enumeration value indicates that Cofinoga is an authorized brand for credit card transactions. - **MAESTRO**: This enumeration value indicates that Maestro is an authorized brand for credit card transactions. - **SWITCH**: This enumeration value indicates that Switch is an authorized brand for credit card transactions. - **POSTEPAY**: This enumeration value indicates that Postepay is an authorized brand for credit card transactions. - **CB**: This enumeration value indicates that Carte Bancaire is an authorized brand for credit card transactions. - **DINERS_CLUB**: This enumeration value indicates that Diners Club is an authorized brand for credit card transactions. - **UNION_PAY**: This enumeration value indicates that UnionPay is an authorized brand for credit card transactions. - **PAYPAL_CREDIT**: This enumeration value indicates that PayPal is an authorized brand for credit transactions. - **PAYPAL**: This enumeration value indicates that PayPal is an authorized brand for Wallet transactions. - ***GOOGLE_PAY*: This enumeration value indicates that Google Pay is an authorized brand for Wallet transactions. - **APPLE_PAY**: This enumeration value indicates that Apple Pay is an authorized brand for Wallet transactions. - **QIWI**: This enumeration value indicates that Qiwi is an authorized brand for Wallet transactions. ", "enum": [ "VISA", "MASTERCARD", "DISCOVER", "AMERICAN_EXPRESS", "CB_NATIONALE", "CETELEM", "COFIDIS", "COFINOGA", "MAESTRO", "SWITCH", "POSTEPAY", "CB", "DINERS_CLUB", "UNION_PAY", "PAYPAL_CREDIT", "PAYPAL", "GOOGLE_PAY", "APPLE_PAY", "QIWI" ] }, "PaymentMethodTypeEnum": { "type": "object", "description": "An enumerated type for the values that represent the payment method, such as credit card or cash.
Code so that your app gracefully handles any future changes to this list. | - **CREDIT_CARD**: This enumeration value indicates that the payment can be processed via credit card, using the brand(s) specified in the corresponding paymentMethodBrands array. - **WALLET**: This enumeration value indicates that the payment can be processed via wallet, using the brand(s) specified in the corresponding paymentMethodBrands array. - **DEBIT_CARD**: This enumeration value indicates that the payment can be processed via debit card, using the brand(s) specified in the corresponding paymentMethodBrands array. - **CREDIT**: This enumeration value indicates that the payment can be processed via PayPal credit. - **BANK**: This enumeration value indicates that the payment can be processed through bank transfer, using the method(s) specified in the corresponding paymentInstructions array. - **CASH**: This enumeration value indicates that the payment can be made via cash transaction, using the method(s) specified in the corresponding paymentInstructions array. - **OTHER**: This enumeration value indicates that no payment methods have been specified. Contact the seller for more information or see the SellerInstructionEnum response for details. - **CHECK**: This enumeration value indicates that the payment can be processed via check. - **MONEY_ORDER**: This enumeration value indicates that the payment can be processed via money order. - **WIRE_TRANSFER**: This enumeration value indicates that the payment can be processed via wire-transfer. - **DEFERRED**: This enumeration value indicates that the payment will be processed upon invoice, as specified in the paymentInstructions array. ", "enum": [ "CREDIT_CARD", "WALLET", "DEBIT_CARD", "CREDIT", "BANK", "CASH", "OTHER", "CHECK", "MONEY_ORDER", "WIRE_TRANSFER", "DEFERRED" ] }, "PickupOptionSummary": { "type": "object", "properties": { "pickupLocationType": { "type": "string", "description": "This container returns the local pickup options available to the buyer. Possible values are
ARRANGED_LOCATION and STORE."
}
},
"description": "The type that defines the fields for the local pickup options that are available for the item. It is used by the pickupOptions container."
},
"PriceDisplayConditionEnum": {
"type": "string",
"description": "An enumerated type for the values that represent when in the buying flow the item's price can appear for minimum advertised price (MAP) items, which is the lowest price a retailer can advertise/show for this item. | - **ONLY_SHOW_WHEN_ADDED_IN_CART**: Indicates the minimum advertised price of the item can be shown only after the item has been added to the cart. - **ONLY_SHOW_ON_REQUEST**: Indicates the minimum advertised price can be shown only when the buyer requests to see it. - **ALWAYS_SHOW**: Indicates there are no restrictions as to when the minimum advertised price of the item can be shown.",
"enum": [
"ONLY_SHOW_WHEN_ADDED_IN_CART",
"ONLY_SHOW_ON_REQUEST",
"ALWAYS_SHOW"
]
},
"PriceTreatmentEnum": {
"type": "string",
"description": "An enumerated type for the values that represent a discount type. | - **MINIMUM_ADVERTISED_PRICE**: Indicates the price treatment is Minimum Advertised Price (MAP). This is the lowest price the item is allowed to be advertised/shown at and can be shown only after the item has been added to the cart. For details about when in the buying flow the item's price can appear, refer to priceDisplayConditionEnum. - **LIST_PRICE**: Indicates the price treatment is Strike Through Pricing (STP). For this treatment, the list price, which is crossed off (struck through) and discounted price are shown. List price is the price a seller recently listed the item for sale or sold the item for. - **MARKDOWN**: Indicates the price treatment is a markdown. The price before the markdown (Was price) is shown as well as the discount price. This item is part of a seller promotion and has an end date. ",
"enum": [
"MINIMUM_ADVERTISED_PRICE",
"LIST_PRICE",
"MARKDOWN"
]
},
"Product": {
"type": "object",
"properties": {
"additionalImages": {
"type": "array",
"description": "An array of containers with the URLs for the product images that are in addition to the primary image. ",
"items": {
"$ref": "#/components/schemas/Image"
}
},
"additionalProductIdentities": {
"type": "array",
"description": "An array of product identifiers associated with the item. This container is returned if the seller has associated the eBay Product Identifier (ePID) with the item and in the request fieldgroups is set to PRODUCT.",
"items": {
"$ref": "#/components/schemas/AdditionalProductIdentity"
}
},
"aspectGroups": {
"type": "array",
"description": "An array of containers for the product aspects. Each group contains the aspect group name and the aspect name/value pairs.",
"items": {
"$ref": "#/components/schemas/AspectGroup"
}
},
"brand": {
"type": "string",
"description": "The brand associated with product. To identify the product, this is always used along with MPN (manufacturer part number)."
},
"description": {
"type": "string",
"description": "The rich description of an eBay product, which might contain HTML."
},
"gtins": {
"type": "array",
"description": "An array of all the possible GTINs values associated with the product. A GTIN is a unique Global Trade Item number of the item as defined by https://www.gtin.info. This can be a UPC (Universal Product Code), EAN (European Article Number), or an ISBN (International Standard Book Number) value.",
"items": {
"type": "string"
}
},
"image": {
"description": "The primary image of the product. This is often a stock photo.",
"$ref": "#/components/schemas/Image"
},
"mpns": {
"type": "array",
"description": "An array of all possible MPN values associated with the product. A MPNs is manufacturer part number of the product. To identify the product, this is always used along with brand.",
"items": {
"type": "string"
}
},
"title": {
"type": "string",
"description": "The title of the product."
}
},
"description": "The type that defines the fields for the product information of the item."
},
"ProductIdentity": {
"type": "object",
"properties": {
"identifierType": {
"type": "string",
"description": "The type of product identifier, such as UPC and EAN."
},
"identifierValue": {
"type": "string",
"description": "The product identifier value."
}
},
"description": "The type that defines the fields for the product identifier type/value pairs of product associated with an item."
},
"ProductSafetyLabelPictogram": {
"type": "object",
"properties": {
"pictogramDescription": {
"type": "string",
"description": "The description of the safety label pictogram."
},
"pictogramId": {
"type": "string",
"description": "The identifier of the safety label pictogram."
},
"pictogramUrl": {
"type": "string",
"description": "The URL of the safety label pictogram."
}
},
"description": "This type is used to provide product safety pictogram(s) for the listing."
},
"ProductSafetyLabelStatement": {
"type": "object",
"properties": {
"statementDescription": {
"type": "string",
"description": "A description of the nature of the product safety label statement."
},
"statementId": {
"type": "string",
"description": "The identifier of the product safety label statement."
}
},
"description": "This type is used to describe the seller provided product safety label statement."
},
"ProductSafetyLabels": {
"type": "object",
"properties": {
"pictograms": {
"type": "array",
"description": "An array of seller provided comma-separated string values that provides identifier, URL, and description for one or more pictograms associated with the listing.",
"items": {
"$ref": "#/components/schemas/ProductSafetyLabelPictogram"
}
},
"statements": {
"type": "array",
"description": "An array of seller provided comma-separated string values that provide identifier and description for one or more product safety statements associated with the listing.",
"items": {
"$ref": "#/components/schemas/ProductSafetyLabelStatement"
}
}
},
"description": "This type contains seller provided product safety pictograms and statements for the listing."
},
"RangeValue": {
"type": "object",
"properties": {
"end": {
"type": "string",
"description": "Specifies the end or upper limit of the range. This can be empty which equates to greater than or equal to the start or lower limit."
},
"exclusiveEnd": {
"type": "boolean",
"description": "Specifies whether the end value is to be included in the range. For example, if end is 100, and exclusiveEnd is true, the end range would be <100. But if it is set to false, it is <=100."
},
"exclusiveStart": {
"type": "boolean",
"description": "Specifies whether the start value is to be included in the range. For example, if start is 60, and exclusiveStart is true, the start range would be >60. But if it is set to false, it is >=60."
},
"range": {
"type": "boolean",
"description": "Specifies whether the filter is for a range of values."
},
"start": {
"type": "string",
"description": "Specifies the start or lower limit of the range. This can be empty which equates to lesser than or equal to the end or upper limit."
}
},
"description": "The type that defines the fields to support filtering by a range of values."
},
"RatingHistogram": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "The total number of user ratings that the product has received.",
"format": "int32"
},
"rating": {
"type": "string",
"description": "This is the average rating for the product. As part of a product review, users rate the product. Products are rated from one star (terrible) to five stars (excellent), with each star having a corresponding point value - one star gets 1 point, two stars get 2 points, and so on. If a product had one four-star rating and one five-star rating, its average rating would be 4.5, and this is the value that would appear in this field."
}
},
"description": "The type that defines the fields for product ratings. Only products that are in the eBay product catalog can be reviewed and rated."
},
"Refinement": {
"type": "object",
"required": [
"dominantCategoryId"
],
"properties": {
"aspectDistributions": {
"type": "array",
"description": "An array of containers for the all the aspect refinements.",
"items": {
"$ref": "#/components/schemas/AspectDistribution"
}
},
"buyingOptionDistributions": {
"type": "array",
"description": "An array of containers for the all the buying option refinements.",
"items": {
"$ref": "#/components/schemas/BuyingOptionDistribution"
}
},
"categoryDistributions": {
"type": "array",
"description": "An array of containers for the all the category refinements.",
"items": {
"$ref": "#/components/schemas/CategoryDistribution"
}
},
"conditionDistributions": {
"type": "array",
"description": "An array of containers for the all the condition refinements.",
"items": {
"$ref": "#/components/schemas/ConditionDistribution"
}
},
"dominantCategoryId": {
"type": "string",
"description": "The identifier of the category that most of the items are part of. "
}
},
"description": "This type defines the fields for the various refinements of an item. You can use the information in this container to create histograms, which help shoppers choose exactly what they want."
},
"RefundMethodEnum": {
"type": "object",
"description": "An enumerated type for the values that represent how a refund is given to the buyer when an item is returned. Code so that your app gracefully handles any future changes to this list. | - **MONEY_BACK**: Indicates the buyer gets their money back for the returned item. If the item has a restocking fee (see the restockingFeePercentage field), the buyer's refund will be reduced by this amount. - **MERCHANDISE_CREDIT**: If this field is returned, the buyer actually has the option of getting their money back, or the buyer may choose to request an exchange or replacement for the returned item. The value in the returnMethod field will indicate whether the seller does exchanges or replacements.", "enum": [ "MONEY_BACK", "MERCHANDISE_CREDIT" ] }, "Region": { "type": "object", "properties": { "regionName": { "type": "string", "description": "A localized text string that indicates the name of the region. Taxes are generally charged at the state/province level or at the country level in the case of VAT tax. " }, "regionType": { "description": "An enumeration value that indicates the type of region for the tax jurisdiction.
Valid Values:
- STATE_OR_PROVINCE - Indicates the region is a state or province within a country, such as California or New York in the US, or Ontario or Alberta in Canada.
- COUNTRY - Indicates the region is a single country.
For examples of
COUNTRY_REGION IDs and values, refer to the regionId and/or regionName field descriptions.This value is not applicable for a tax jurisdiction. - **STATE_OR_PROVINCE**: This enumeration value indicates the region is a state or province within a country, such as California or New York in the US, or Ontario or Alberta in Canada.
For examples of
STATE_OR_PROVINCE IDs and values, refer to the regionId and/or regionName field descriptions. - **COUNTRY**: This enumeration value indicates the region is a country. The two-letter code for the country, as defined by the ISO 3166 standard, will be returned in the regionId field, and in the regionName field, the name of the country will be a localized text string. - **WORLD_REGION**: This enumeration value indicates the region is a continent or a large geographical region.For examples of
WORLD_REGION IDs and values, refer to the regionId and/or regionName field descriptions.This value is not applicable for a tax jurisdiction. - **WORLDWIDE**: Indicates the region is the entire world.
This value is only applicable to included shipping regions and not apply to excluded shipping regions. If a seller ships to many global locations, but does have a few regions and/or countries that are exceptions, that seller may specify
WORLDWIDE as the included region, and will also specify the exceptions through the excluded regions list.In the
regionName field, \"Worldwide\" will be localized, and in the regionId field, the value will be WORLDWIDEThis value is not applicable for a tax jurisdiction.", "enum": [ "COUNTRY_REGION", "STATE_OR_PROVINCE", "COUNTRY", "WORLD_REGION", "WORLDWIDE" ] }, "ResponsiblePerson": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "The first line of the Responsible Person's street address." }, "addressLine2": { "type": "string", "description": "The second line of the Responsible Person's address. This field is not always used, but can be used for secondary address information such as 'Suite Number' or 'Apt Number'." }, "city": { "type": "string", "description": "The city of the Responsible Person's street address." }, "companyName": { "type": "string", "description": "The name of the Responsible Person or entity." }, "contactUrl": { "type": "string", "description": "The contact URL of the Responsible Person or entity." }, "country": { "description": "The two-letter ISO 3166 standard of the country of the address.", "$ref": "#/components/schemas/CountryCodeEnum" }, "countryName": { "type": "string", "description": "The country name of the Responsible Person's street address." }, "county": { "type": "string", "description": "The county of the Responsible Person's street address." }, "email": { "type": "string", "description": "The email of the Responsible Person's street address." }, "phone": { "type": "string", "description": "The phone number of the Responsible Person's street address." }, "postalCode": { "type": "string", "description": "The postal code of the Responsible Person's street address." }, "stateOrProvince": { "type": "string", "description": "The state or province of the Responsible Person's street address." }, "types": { "type": "array", "description": "The type(s) associated with the Responsible Person or entity.", "items": { "$ref": "#/components/schemas/ResponsiblePersonTypeEnum" } } }, "description": "This type provides information, such as name and contact details, for an EU-based Responsible Person or entity, associated with the product." }, "ResponsiblePersonTypeEnum": { "type": "object", "description": "This enumerated type is used to indicate the type of EU Responsible Person associated with a listing. | - **EU_RESPONSIBLE_PERSON**: This enum value indicates the Responsible person is an EU Responsible Person. An EU Responsible Person is crucial for ensuring that products comply with all relevant regulations and safety standards to protect human health.", "enum": [ "EU_RESPONSIBLE_PERSON" ] }, "ReturnMethodEnum": { "type": "object", "description": "An enumerated type for the values that represent the alternative methods for a full refund when an item is returned.
Code so that your app gracefully handles any future changes to this list. | - **REPLACEMENT**: Indicates that the buyer has the option of receiving money back for the returned item, or they can choose to have the seller replace the item with an identical item. - **EXCHANGE**: Indicates that the buyer has the option of receiving money back for the returned item, or they can exchange the item for another similar item.", "enum": [ "REPLACEMENT", "EXCHANGE" ] }, "ReturnShippingCostPayerEnum": { "type": "object", "description": "An enumerated type for the values that represent who will pay the return shipping costs. | - **SELLER**: Indicates the seller will pay for the shipping costs to return the item. - **BUYER**: Indicates the buyer will pay for the shipping costs to return the item. ", "enum": [ "SELLER", "BUYER" ] }, "ReviewRating": { "type": "object", "properties": { "averageRating": { "type": "string", "description": "The average rating given to a product based on customer reviews." }, "ratingHistograms": { "type": "array", "description": "An array of containers for the product rating histograms that shows the review counts and the product rating.", "items": { "$ref": "#/components/schemas/RatingHistogram" } }, "reviewCount": { "type": "integer", "description": "The total number of reviews for the item.", "format": "int32" } }, "description": "The type that defines the fields for the rating of a product review." }, "SearchByImageRequest": { "type": "object", "properties": { "image": { "type": "string", "description": "The Base64 string of the image.
To get the Base64 image string, you can use sites such as https://codebeautify.org/image-to-base64-converter." } }, "description": "The type that defines the fields for the image information." }, "SearchPagedCollection": { "type": "object", "required": [ "href", "limit", "offset", "total" ], "properties": { "autoCorrections": { "description": "The auto-corrected inputs.", "$ref": "#/components/schemas/AutoCorrections" }, "href": { "type": "string", "description": "The URI of the current page of results.
The following example of the search method returns items 1 thru 5 from the list of items found.
https://api.ebay.com/buy/v1/item_summary/search?q=shirt&limit=5&offset=0" }, "itemSummaries": { "type": "array", "description": "An array of the items on this page. The items are sorted according to the sorting method specified in the request.", "items": { "$ref": "#/components/schemas/ItemSummary" } }, "limit": { "type": "integer", "description": "The value of the
limit parameter submitted in the request, which is the maximum number of items to return on a page, from the result set. A result set is the complete set of items returned by the method.",
"format": "int32"
},
"next": {
"type": "string",
"description": "The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set.The following example of the search method returns items 5 thru 10 from the list of items found.
https://api.ebay.com/buy/v1/item_summary/search?query=t-shirts&limit=5&offset=10" }, "offset": { "type": "integer", "description": "This value indicates the
offset used for current page of items being returned. Assume the initial request used an offset of 0 and a limit of 3. Then in the first page of results, this value would be 0, and items 1-3 are returned. For the second page, this value is 3 and so on.",
"format": "int32"
},
"prev": {
"type": "string",
"description": "The URI for the previous page of results. This is returned if there is a previous page of results from the result set.The following example of the search method returns items 1 thru 5 from the list of items found, which would be the first set of items returned.
https://api.ebay.com/buy/v1/item_summary/search?query=t-shirts&limit=5&offset=0" }, "refinement": { "description": "The container for all the search refinements.", "$ref": "#/components/schemas/Refinement" }, "total": { "type": "integer", "description": "The total number of items that match the input criteria.
Note:
total is just an indicator of the number of listings for a given query. It could vary based on the number of listings with variations included in the result. It is strongly recommended that total not be used in pagination use cases. Instead, use next to determine the results on the next page.",
"format": "int32"
},
"warnings": {
"type": "array",
"description": "The container with all the warnings for the request.",
"items": {
"$ref": "#/components/schemas/ErrorDetailV3"
}
}
},
"description": "The type that defines the fields for a paginated result set. The response consists of 0 or more sequenced pages where each page has 0 or more items."
},
"Seller": {
"type": "object",
"properties": {
"feedbackPercentage": {
"type": "string",
"description": "The percentage of the total positive feedback."
},
"feedbackScore": {
"type": "integer",
"description": "The feedback score of the seller. This value is based on the ratings from eBay members that bought items from this seller.",
"format": "int32"
},
"sellerAccountType": {
"type": "string",
"description": "Indicates if the seller is a business or an individual. This is determined when the seller registers with eBay:- If they register for a business account, this value will be
BUSINESS. - If they register for a private account, this value will be
INDIVIDUAL.
This field is returned only on the following sites:
EBAY_AT, EBAY_BE, EBAY_CH, EBAY_DE, EBAY_ES, EBAY_FR, EBAY_GB, EBAY_IE, EBAY_IT, EBAY_PL
Valid Values:
BUSINESS or INDIVIDUAL"
},
"username": {
"type": "string",
"description": "The user name created by the seller for use on eBay.Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance. " } }, "description": "The type that defines the fields for basic information about the seller of the item returned by the
item_summary resource."
},
"SellerCustomPolicy": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "The seller-defined description of the policy."
},
"label": {
"type": "string",
"description": "The seller-defined label for an individual custom policy."
},
"type": {
"description": "The type of custom policy, such as PRODUCT_COMPLIANCE or TAKE_BACK.",
"$ref": "#/components/schemas/SellerCustomPolicyTypeEnum"
}
},
"description": "This type defines the custom policies that apply to a listed item."
},
"SellerCustomPolicyTypeEnum": {
"type": "object",
"description": "An enumerated type for the kinds of custom policy that sellers may apply to a listing. | - **PRODUCT_COMPLIANCE**: A policy that provides the required regulatory information and disclosures for certain product types. - **TAKE_BACK**: A policy that applies when applicable law requires the seller to take back a used product when the buyer buys a new product. ",
"enum": [
"PRODUCT_COMPLIANCE",
"TAKE_BACK"
]
},
"SellerDetail": {
"type": "object",
"required": [
"feedbackPercentage",
"feedbackScore",
"username"
],
"properties": {
"feedbackPercentage": {
"type": "string",
"description": "The percentage of the total positive feedback."
},
"feedbackScore": {
"type": "integer",
"description": "The feedback score of the seller. This value is based on the ratings from eBay members that bought items from this seller.",
"format": "int32"
},
"sellerAccountType": {
"type": "string",
"description": "This indicates if the seller is a business or an individual. This is determined when the seller registers with eBay. If they register for a business account, this value will be BUSINESS. If they register for a private account, this value will be INDIVIDUAL. This designation is required by the tax laws in the following countries: This field is applicable only on the following marketplaces:
- EBAY_AT
- EBAY_BE
- EBAY_CH
- EBAY_DE
- EBAY_ES
- EBAY_FR
- EBAY_GB
- EBAY_IE
- EBAY_IT
- EBAY_PL
Valid Values:
BUSINESS or INDIVIDUAL"
},
"sellerLegalInfo": {
"description": "The container with the seller's contact info and fields that are required by law.",
"$ref": "#/components/schemas/SellerLegalInfo"
},
"userId": {
"type": "string",
"description": "The unique identifier of an eBay user across all eBay sites. This value does not change, even when a user changes their username."
},
"username": {
"type": "string",
"description": "The user name created by the seller for use on eBay.Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance. " } }, "description": "The type that defines the fields for basic and detailed information about the seller of the item returned by the item resource." }, "SellerInstructionEnum": { "type": "object", "description": "An enumerated type for the values that represent the seller instructions to the buyer.
Code so that your app gracefully handles any future changes to this list. | - **ACCEPTS_CREDIT_CARD**: This enumeration value indicates that credit card is an acceptable payment method for the seller. - **SEE_DESCRIPTION**: This enumeration value indicates that the seller has provided special instructions within the listing description.", "enum": [ "ACCEPTS_CREDIT_CARD", "SEE_DESCRIPTION" ] }, "SellerLegalInfo": { "type": "object", "properties": { "email": { "type": "string", "description": "The seller's business email address." }, "fax": { "type": "string", "description": "The seller' business fax number." }, "imprint": { "type": "string", "description": "This is a free-form string created by the seller. This is information often found on business cards, such as address. This is information used by some countries." }, "legalContactFirstName": { "type": "string", "description": "The seller's first name." }, "legalContactLastName": { "type": "string", "description": "The seller's last name." }, "name": { "type": "string", "description": "The name of the seller's business." }, "phone": { "type": "string", "description": "The seller's business phone number." }, "registrationNumber": { "type": "string", "description": "The seller's registration number. This is information used by some countries." }, "sellerProvidedLegalAddress": { "description": "The container that returns the seller's address to be used to contact them.", "$ref": "#/components/schemas/LegalAddress" }, "termsOfService": { "type": "string", "description": "This is a free-form string created by the seller. This is the seller's terms or condition, which is in addition to the seller's return policies." }, "vatDetails": { "type": "array", "description": "An array of the seller's VAT (value added tax) IDs and the issuing country. VAT is a tax added by some European countries.", "items": { "$ref": "#/components/schemas/VatDetail" } }, "economicOperator": { "description": "Provides required information about the manufacturer and/or supplier of the item.", "$ref": "#/components/schemas/EconomicOperator" }, "weeeNumber": { "type": "string", "description": "The Waste Electrical and Electronic Equipment (WEEE) registration number required for any seller to place electrical and electronic equipment on the market in Germany. This manufacturer number is assigned to the first distributors of electrical and electronic equipment and comprises a country code and an 8-digit sequence of digits (e.g. 'WEEE Reg. No. DE 12345678')." } }, "description": "The type that defines the fields for the contact information for a seller." }, "ShipToLocation": { "type": "object", "properties": { "country": { "description": "The two-letter ISO 3166 standard of the country for where the item is to be shipped.", "$ref": "#/components/schemas/CountryCodeEnum" }, "postalCode": { "type": "string", "description": "The zip code (postal code) for where the item is to be shipped." } }, "description": "The type that defines the fields for the country and postal code of where an item is to be shipped." }, "ShipToLocations": { "type": "object", "properties": { "regionExcluded": { "type": "array", "description": "An array of containers that express the large geographical regions, countries, state/provinces, or special locations within a country where the seller is not willing to ship to.", "items": { "$ref": "#/components/schemas/ShipToRegion" } }, "regionIncluded": { "type": "array", "description": "An array of containers that express the large geographical regions, countries, or state/provinces within a country where the seller is willing to ship to. Prospective buyers must look at the shipping regions under this container, as well as the shipping regions that are under the regionExcluded to see where the seller is willing to ship items. Sellers can specify that they ship 'Worldwide', but then add several large geographical regions (e.g. Asia, Oceania, Middle East) to the exclusion list, or sellers can specify that they ship to Europe and Africa, but then add several individual countries to the exclusion list.", "items": { "$ref": "#/components/schemas/ShipToRegion" } } }, "description": "The type that defines the fields that include and exclude geographic regions affecting where the item can be shipped. The seller defines these regions when listing the item." }, "ShipToRegion": { "type": "object", "properties": { "regionId": { "type": "string", "description": "The unique identifier of the shipping region. The value returned here is dependent on the corresponding regionType value. The regionId value for a region does not vary based on the eBay marketplace. However, the corresponding regionName value for a region is a localized, text-based description of the shipping region.
If the regionType value is
WORLDWIDE, the regionId value will also be WORLDWIDE.If the regionType value is
WORLD_REGION, the regionId value will be one of the following: AFRICA, AMERICAS, ASIA, AUSTRALIA, CENTRAL_AMERICA_AND_CARIBBEAN, EUROPE, EUROPEAN_UNION, GREATER_CHINA, MIDDLE_EAST, NORTH_AMERICA, OCEANIA, SOUTH_AMERICA, SOUTHEAST_ASIA or CHANNEL_ISLANDS.If the regionType value is
COUNTRY, the regionId value will be the two-letter code for the country, as defined in the ISO 3166 standard.If the regionType value is
STATE_OR_PROVINCE, the regionId value will either be the two-letter code for US states and DC (as defined on this Social Security Administration page), or the two-letter code for Canadian provinces (as defined by this Canada Post page).If the regionType value is
COUNTRY_REGION, the regionId value may be one of following: _AH (if a seller is not willing to ship to Alaska/Hawaii), _PR (if the seller is not willing to ship to US Protectorates), _AP (if seller is not willing to ship to a US Army or Fleet Post Office), and PO_BOX (if the seller is not willing to ship to a Post Office Box)."
},
"regionName": {
"type": "string",
"description": "A localized text string that indicates the name of the shipping region. The value returned here is dependent on the corresponding regionType value. If the regionType value is
WORLDWIDE, the regionName value will show Worldwide.If the regionType value is
WORLD_REGION, the regionName value will be a localized text string for one of the following large geographical regions: Africa, Americas, Asia, Australia, Central America and Caribbean, Europe, European Union, Greater China, Middle East, North America, Oceania, South America, Southeast Asia, or Channel Islands.If the regionType value is
COUNTRY, the regionName value will be a localized text string for any country in the world.If the regionType value is
STATE_OR_PROVINCE, the regionName value will be a localized text string for any US state or Canadian province. If the regionType value is
COUNTRY_REGION, the regionName value may be a localized version of one of the following: Alaska/Hawaii, US Protectorates, APO/FPO (Army or Fleet Post Office), or PO BOX."
},
"regionType": {
"description": "An enumeration value that indicates the level or type of shipping region. Valid Values:
- COUNTRY_REGION - Indicates the region is a domestic region or special location within a country.
- STATE_OR_PROVINCE - Indicates the region is a state or province within a country, such as California or New York in the US, or Ontario or Alberta in Canada.
- COUNTRY - Indicates the region is a single country.
- WORLD_REGION - Indicates the region is a world region, such as Africa, the Middle East, or Southeast Asia.
- WORLDWIDE - Indicates the region is the entire world. This value is only applicable for included shiping regions, and not excluded shipping regions.
Code so that your app gracefully handles any future changes to this list.", "$ref": "#/components/schemas/RegionTypeEnum" } }, "description": "This type is used provide details about included and excluded shipping regions." }, "ShippingOption": { "type": "object", "required": [ "shippingCarrierCode", "shippingCost", "shippingCostType", "shippingServiceCode", "type" ], "properties": { "additionalShippingCostPerUnit": { "description": "Any per item additional shipping costs for a multi-item purchase. For example, let's say the shipping cost for a power cord is $3. But for an additional cord, the shipping cost is only $1. So if you bought 3 cords, the shippingCost would be $3 and this value would be $2 ($1 for each additional item).", "$ref": "#/components/schemas/ConvertedAmount" }, "cutOffDateUsedForEstimate": { "type": "string", "description": "The deadline date that the item must be purchased by in order to be received by the buyer within the delivery window ( maxEstimatedDeliveryDate and minEstimatedDeliveryDate fields). This field is returned only for items that are eligible for 'Same Day Handling'. For these items, the value of this field is what is displayed in the Delivery line on the View Item page.
This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer." }, "fulfilledThrough": { "description": "If the item is being shipped by the eBay Global Shipping program, this field returns
GLOBAL_SHIPPING.If the item is being shipped using the eBay International Shipping program, this field returns
INTERNATIONAL_SHIPPING. Otherwise, this field is null.", "$ref": "#/components/schemas/FulfilledThroughEnum" }, "guaranteedDelivery": { "type": "boolean", "description": "Although this field is still returned, it can be ignored since eBay Guaranteed Delivery is no longer a supported feature on any marketplace. This field may get removed from the schema in the future." }, "importCharges": { "description": "The Global Shipping Program import charges for this item.", "$ref": "#/components/schemas/ConvertedAmount" }, "maxEstimatedDeliveryDate": { "type": "string", "description": "The end date of the delivery window (latest projected delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer.
Note: For the best accuracy, always include the location of where the item is be shipped in the
contextualLocation values of the X-EBAY-C-ENDUSERCTX request header. "
},
"minEstimatedDeliveryDate": {
"type": "string",
"description": "The start date of the delivery window (earliest projected delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer. Note: For the best accuracy, always include the location of where the item is be shipped in the
contextualLocation values of the X-EBAY-C-ENDUSERCTX request header."
},
"quantityUsedForEstimate": {
"type": "integer",
"description": "The number of items used when calculating the estimation information.This field will reflect the value input in the quantity_for_shipping_estimate query parameter.", "format": "int32" }, "shippingCarrierCode": { "type": "string", "description": "The name of the shipping provider, such as FedEx, or USPS." }, "shippingCost": { "description": "The final shipping cost for all the items after all discounts are applied.
This container will reflect the cost for the quantity specified through the quantity_for_shipping_estimate query parameter.
Note: The cost does include the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the
X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB) to see the VAT-inclusive cost. For more information on VAT, refer to VAT Obligations in the EU.",
"$ref": "#/components/schemas/ConvertedAmount"
},
"shippingCostType": {
"type": "string",
"description": "Indicates the class of the shipping cost. Valid Values: FIXED or CALCULATED
Code so that your app gracefully handles any future changes to this list. " }, "shippingServiceCode": { "type": "string", "description": "The type of shipping service. For example, USPS First Class." }, "shipToLocationUsedForEstimate": { "description": "The container that returns the country and postal code of where the item is to be shipped. These values come from the
contextualLocation values in the X-EBAY-C-ENDUSERCTX request header. If the header is not submitted, marketplace is used.",
"$ref": "#/components/schemas/ShipToLocation"
},
"trademarkSymbol": {
"type": "string",
"description": "Any trademark symbol, such as ™ or ®, that needs to be shown in superscript next to the shipping service name."
},
"type": {
"type": "string",
"description": "The type of a shipping option, such as EXPEDITED, ONE_DAY, STANDARD, ECONOMY, PICKUP, etc."
}
},
"description": "The type that defines the fields for the details of a shipping provider."
},
"ShippingOptionSummary": {
"type": "object",
"properties": {
"guaranteedDelivery": {
"type": "boolean",
"description": "Although this field is still returned, it can be ignored since eBay Guaranteed Delivery is no longer a supported feature on any marketplace. This field may get removed from the schema in the future."
},
"maxEstimatedDeliveryDate": {
"type": "string",
"description": "The end date of the delivery window (latest projected delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer.Note: For the best accuracy, always include the
contextualLocation values in the X-EBAY-C-ENDUSERCTX request header.Note: Estimated delivery dates are not returned for CBT items." }, "minEstimatedDeliveryDate": { "type": "string", "description": "The start date of the delivery window (earliest projected delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer.
Note: For the best accuracy, always include the
contextualLocation values in the X-EBAY-C-ENDUSERCTX request header.Note: Estimated delivery dates are not returned for CBT items." }, "shippingCost": { "description": "This is the estimated price to ship the item.
The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must do one or more of the following to see VAT-inclusive pricing:
- Pass the
X-EBAY-C-MARKETPLACE-IDrequest header specifying the supported marketplace (such asEBAY_GB) - Pass the
contextualLocationvalues for the supported marketplace in theX-EBAY-C-ENDUSERCTXrequest header - Specify the supported marketplace using the
deliveryCountryfilter URI parameter (such asfilter=deliveryCountry:GB)
FIXED (flat-rate shipping) and CALCULATED (shipping cost calculated based on item and buyer location)."
}
},
"description": "The type that defines the fields for the shipping information."
},
"SortField": {
"type": "object",
"properties": {
"ascending": {
"type": "boolean",
"description": "Indicates if the results are sorted in ascending (smallest to greatest) order."
},
"field": {
"type": "string",
"description": "Specifies the name of a field in which to sort items using the value of that field. For example, if the field name is amount, the items will be sorted by the amount, or cost of the item."
}
},
"description": "The type that defines the fields that control how items in result sets are sorted."
},
"TargetLocation": {
"type": "object",
"properties": {
"unitOfMeasure": {
"type": "string",
"description": "This value shows the unit of measurement used to measure the distance between the location of the item and the buyer's location. This value is typically mi or km."
},
"value": {
"type": "string",
"description": "This value indicates the distance (measured in the measurement unit in the unitOfMeasure field) between the item location and the buyer's location."
}
},
"description": "The type that defines the fields for the distance between the item location and the buyer's location."
},
"TaxJurisdiction": {
"type": "object",
"properties": {
"region": {
"description": "The region of the tax jurisdiction.",
"$ref": "#/components/schemas/Region"
},
"taxJurisdictionId": {
"type": "string",
"description": "The identifier of the tax jurisdiction."
}
},
"description": "The type that defines the fields for the tax jurisdiction details."
},
"TaxType": {
"type": "object",
"description": "An enumerated type for the values that represent the type of tax. Code so that your app gracefully handles any future changes to this list. | - **STATE_SALES_TAX**: Indicates this is a state sales tax. - **VAT**: Indicates this is a value add tax (VAT) tax. - **PROVINCE_SALES_TAX**: Indicates this is a province sales tax. - **REGION**: Indicates this is a region tax. - **GST**: Indicates this is a Goods and Services Tax. This tax only applies to buyers on the eBay Australia site. ", "enum": [ "STATE_SALES_TAX", "VAT", "PROVINCE_SALES_TAX", "REGION", "GST" ] }, "Taxes": { "type": "object", "properties": { "ebayCollectAndRemitTax": { "type": "boolean", "description": "This field is only returned if
true, and indicates that eBay will collect tax (sales tax, Goods and Services tax, or VAT) for at least one line item in the order, and remit the tax to the taxing authority of the buyer's residence. "
},
"includedInPrice": {
"type": "boolean",
"description": "This indicates if tax was applied for the cost of the item."
},
"shippingAndHandlingTaxed": {
"type": "boolean",
"description": "This indicates if tax is applied for the shipping cost."
},
"taxJurisdiction": {
"description": "The container that returns the tax jurisdiction.",
"$ref": "#/components/schemas/TaxJurisdiction"
},
"taxPercentage": {
"type": "string",
"description": "The percentage of tax."
},
"taxType": {
"description": "This field indicates the type of tax that may be collected for the item.",
"$ref": "#/components/schemas/TaxTypeEnum"
}
},
"description": "The type that defines the tax fields."
},
"TimeDuration": {
"type": "object",
"properties": {
"unit": {
"description": "An enumeration value that indicates the units of the time span (e.g., HOURS). The enumeration value in this field defines the period of time being used to measure the duration.Refer to TimeDurationUnitEnum for the list of supported values.", "$ref": "#/components/schemas/TimeDurationUnitEnum" }, "value": { "type": "integer", "description": "Retrieves the duration of the time span (no units). The value in this field indicates the number of years, months, days, hours, or minutes in the defined period.", "format": "int32" } }, "description": "The type that defines the fields for a period of time in the time-measurement units supplied." }, "TimeDurationUnitEnum": { "type": "object", "description": "An enumerated type that defines the values that represent the period of time being used. | - **YEAR**: Indicates the time duration is based on the number of years. - **MONTH**: Indicates the time duration is based on the number of months. - **DAY**: Indicates the time duration is based on the number of days. - **HOUR**: Indicates the time duration is based on the number of hours. - **CALENDAR_DAY**: Indicates the time duration is based on the calendar, meaning Sunday through Saturday and does not exclude holidays. - **BUSINESS_DAY**: Indicates the time duration is based on the number of business days, meaning \"working days\". So it excludes all holidays for the location and in some locations can include Saturday. - **MINUTE**: Indicates the time duration is based on the number of minutes. - **SECOND**: Indicates the time duration is based on the number of seconds. - **MILLISECOND**: Indicates the time duration is based on the number of milliseconds. ", "enum": [ "YEAR", "MONTH", "DAY", "HOUR", "CALENDAR_DAY", "BUSINESS_DAY", "MINUTE", "SECOND", "MILLISECOND" ] }, "TypedNameValue": { "type": "object", "properties": { "name": { "type": "string", "description": "The text representing the name of the aspect for the name/value pair, such as Color." }, "type": { "description": "This indicates if the value being returned is a string or an array of values.
Valid Values:
- STRING - Indicates the value returned is a string.
- STRING_ARRAY - Indicates the value returned is an array of strings.
Code so that your app gracefully handles any future changes to this list.", "enum": [ "COMPATIBLE", "NOT_COMPATIBLE", "UNDETERMINED" ] }, "CouponDiscountTypeEnum": { "type": "object", "description": "This enumeration type contains the list of coded coupon discount types. Currently, the only supported discount type is an item price discount.", "enum": [ "ITEM_PRICE" ] }, "TaxTypeEnum": { "type": "object", "description": "An enumerated type for the values that represent the type of tax.
Code so that your app gracefully handles any future changes to this list.", "enum": [ "STATE_SALES_TAX", "VAT", "PROVINCE_SALES_TAX", "REGION", "GST" ] } }, "securitySchemes": { "api_auth": { "type": "oauth2", "description": "The security definitions for this API. Please check individual operations for applicable scopes.", "flows": { "clientCredentials": { "tokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "scopes": { "https://api.ebay.com/oauth/api_scope/buy.item.bulk": "Retrieve eBay items in bulk.", "https://api.ebay.com/oauth/api_scope": "View public data from eBay" } } } } } } }