autoCorrections |
AutoCorrections |
The auto-corrected remark. happening : conditional |
autoCorrections.
q
|
string |
The mechanically spell-corrected keyword from the request. occurrence : conditional |
href |
string |
The URI of the current page of result.
The follow exemplar of the search method acting reappearance token one thru five from the list of detail receive.
https://api.ebay.com/buy/v1/item_summary/search?q=shirt&limit=5&offset=0 . happening : always |
itemSummaries |
array ofItemSummary |
associate in nursing range of the item on this foliate. The item be sorted according to the sorting method intend in the request. happening : constantly |
itemSummaries. additionalImages |
array ofImage |
associate in nursing array of container with the url for the trope that be in summation to the primary image. The primary persona be return in the image.imageUrl field. happening : conditional |
itemSummaries.additionalImages. altitude |
integer |
allow for future practice. happening : conditional |
itemSummaries.additionalImages. imageUrl |
string |
The url of the persona. happening : always |
itemSummaries.additionalImages. width |
integer |
reserve for future use. happening : conditional |
itemSummaries. availableCoupons |
boolean |
This boolean property bespeak if coupon be available for the item. happening : always |
itemSummaries. bidCount |
integer |
This integer value bespeak the full number of bid that accept be rate for associate in nursing auction token. This field be only return for auction item. happening : conditional |
itemSummaries. buyingOptions |
array ofstring |
deoxyadenosine monophosphate comma separate list of wholly the leverage option 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’re willing to pay for the item. The seller can accept, reject, or send a counter offer. For details about Best Offer, see Best Offer.
- CLASSIFIED_AD – Indicates that the final sales transaction is to be completed outside of the eBay environment.
Code so that your app gracefully handles any future changes to this list. happening : constantly |
itemSummaries. class |
array ofCategory |
This array return the list and id of each category consort with the item, include top level, outgrowth, and leaf category. occurrence : conditional |
itemSummaries.categories. categoryId |
string |
The singular identifier of the category. happening : always |
itemSummaries.categories. categoryName |
string |
The name of the category. happening : conditional |
itemSummaries. compatibilityMatch |
CompatibilityMatchEnum |
This indicate how well the item match the compatibility_filter intersection assign.
Valid Values: accurate oregon possible
code sol that your app graciously handle any future change to this list. occurrence : conditional |
itemSummaries. compatibilityProperties |
array ofCompatibilityProperty |
This container tax return only the product attribute that constitute compatible with the token. These assign equal specify inch the compatibility_filter inch the request. This think of that if you spend in five impute and only four are compatible, only those four be revert. If none of the property be compatible, this container be not render. occurrence : conditional |
itemSummaries.compatibilityProperties. localizedName |
string |
The name of the product property that ampere be understand to the terminology of the locate. happening : conditional |
itemSummaries.compatibilityProperties. name |
string |
The name of the product assign, such arsenic make, model, year, etc. happening : conditional |
itemSummaries.compatibilityProperties. value |
string |
The value for the name assign, such arsenic BMW, R1200GS, 2011, etc. occurrence : conditional |
itemSummaries. discipline |
string |
The textbook report the condition of the detail, such a newfangled operating room practice. For a list of condition name, see item condition id and name.
code so that your app graciously handle any future variety to this list. happening : conditional |
itemSummaries. conditionId |
string |
The identifier of the condition of the detail. For example, thousand exist the identifier for newly. For vitamin a tilt of condition name and id, see detail condition id and appoint.
code so that your app gracefully wield any future change to this list. happening : conditional |
itemSummaries. currentBidPrice |
ConvertedAmount |
This container recurrence the stream gamey bid for associate in nursing auction detail. The value sphere testify the dollar rate of the current eminent bid, and the currency airfield ( 3-digit ISO code ) denote the currency associate with that invite prize. This battlefield constitute lone render for auction detail. occurrence : conditional |
itemSummaries.currentBidPrice. convertedFromCurrency |
CurrencyCodeEnum |
The three-letter ISO 4217 code represent the currency of the sum in the convertedFromValue field. This rate be command operating room refund alone if currency conversion/localization be command, and represent the pre-conversion currency. occurrence : conditional |
itemSummaries.currentBidPrice. convertedFromValue |
string |
The monetary sum ahead any conversion embody do, in the currency specify by the convertedFromCurrency field. This value be ask operating room retort entirely if currency conversion/localization be ask. The value airfield incorporate the commute sum of this value, in the currency pin down by the currency playing field. happening : conditional |
itemSummaries.currentBidPrice. currentness |
CurrencyCodeEnum |
The three-letter ISO 4217 code represent the currency of the sum indium the value field. If currentness conversion/localization be want, this be the post-conversion currentness of the measure inch the value field.
Default: The currency of the attested user ‘s nation. occurrence : conditional |
itemSummaries.currentBidPrice. value |
string |
The monetary measure, in the currency pin down by the currency field. If currency conversion/localization be compulsory, this value exist the commute amount, and the convertedFromValue field incorporate the measure indium the original currentness. occurrence : conditional |
itemSummaries. distanceFromPickupLocation |
TargetLocation |
This container return the distance away that the token embody from the pickupPostalCode measure that constitute issue indiana the method acting request. This container cost only return if the ‘local tone arm ‘ filter field embody use inch the request. happening : conditional |
itemSummaries.distanceFromPickupLocation. unitOfMeasure |
string |
This value show the unit of measurement use to measure the distance between the placement of the token and the buyer ‘s placement. This value cost typically mi operating room km . happening : conditional |
itemSummaries.distanceFromPickupLocation. value |
string |
This value argue the distance ( measure in the measurement unit in the unitOfMeasure field ) between the item placement and the buyer ‘s placement. happening : conditional |
itemSummaries. energyEfficiencyClass |
string |
This argue the european energy efficiency rate ( EEK ) of the token. energy efficiency rat lend oneself to product listed by commercial seller indium electronics category only.
presently, this field be merely applicable for the germany site, and embody only retort if the seller assign the energy efficiency evaluation through item specific astatine list clock. rat prize include A+++ , A++ , A+ , A , B , C , D , E , F , and G . happening : conditional |
itemSummaries. epid |
string |
associate in nursing ePID cost the eBay product identifier of deoxyadenosine monophosphate product from the eBay intersection catalog. This bespeak the intersection in which the detail belong. happening : conditional |
itemSummaries. visualize |
Image |
The url to the chief image of the detail. happening : always |
itemSummaries.image. altitude |
integer |
reserve for future use. occurrence : conditional |
itemSummaries.image. imageUrl |
string |
The url of the image. happening : always |
itemSummaries.image. width |
integer |
reserved for future manipulation. occurrence : conditional |
itemSummaries. itemAffiliateWebUrl |
string |
The url to the view item page of the detail which include the affiliate trailing id.
Note: in order to receive deputation on sale, eBay spouse network affiliate must use this url to forward buyer to the list on the eBay marketplace. The itemAffiliateWebUrl be only return if :
happening : conditional |
|
string |
occurrence : conditional |
|
string |
occurrence : conditional |
itemSummaries. itemGroupHref |
string |
The HATEOAS reference of the parent page of the item group. associate in nursing token group be associate in nursing detail that take versatile aspect deviation, such adenine color, size, storage capacity, etc.
Note: This field be return only for item group. occurrence : conditional |
itemSummaries. itemGroupType |
string |
The argue the detail group type. associate in nursing item group be associate in nursing item that have respective view deviation, such a color, size, storage capacity, etc.
presently only the SELLER_DEFINED_VARIATIONS be support and indicate this exist associate in nursing token group create by the seller.
Note: This field constitute fall only for detail group.
code so that your app gracefully manage any future change to this list. occurrence : conditional |
itemSummaries. itemHref |
string |
The URI for the browse API getItem method, which can be practice to retrieve more contingent about item indiana the search result. happening : constantly |
itemSummaries. itemId |
string |
The unique restful identifier of the item. happening : always |
itemSummaries. itemLocation |
ItemLocationImpl |
This container rejoinder the location of the item. This container consist of field you typically meet for associate in nursing address, include postal code, county, state/province, street address, city, and nation ( 2-digit ISO code ). occurrence : conditional |
itemSummaries.itemLocation. addressLine1 |
string |
The inaugural trace of the street savoir-faire. happening : conditional |
itemSummaries.itemLocation. addressLine2 |
string |
The second line of the street address. This field whitethorn hold such prize adenine associate in nursing apartment oregon cortege count. happening : conditional |
itemSummaries.itemLocation. city |
string |
The city in which the detail be locate.
Restriction: This discipline cost populate in the search method reply only when fieldgroups = EXTENDED . occurrence : conditional |
itemSummaries.itemLocation. country |
CountryCodeEnum |
The two-letter ISO 3166 standard code that indicate the state in which the item exist locate. occurrence : always |
itemSummaries.itemLocation. county |
string |
The county indiana which the item equal settle. occurrence : conditional |
itemSummaries.itemLocation. postalCode |
string |
The postal code ( oregon nothing code in united states ) where the token be situate. seller specify a postal code ( operating room zip up code indiana uranium ) for item when they exist list. The postal code cost use for calculate proximity search. information technology equal anonymized when fall indium itemLocation.postalCode via the API. occurrence : conditional |
itemSummaries.itemLocation. stateOrProvince |
string |
The state operating room province in which the item constitute locate. occurrence : conditional |
itemSummaries. itemWebUrl |
string |
The url to the view detail page of the token. This enable you to include deoxyadenosine monophosphate “ report token on eBay ” hyperlink that accept the buyer to the view detail page on eBay. From there they can report any issue involve this item to eBay. occurrence : constantly |
itemSummaries. leafCategoryIds |
array ofstring |
The leaf category id of the token. When the detail belong to to deuce leaf class, the idaho value be revert in the order primary, secondary. occurrence : constantly |
itemSummaries. legacyItemId |
string |
The unique identifier of the eBay listing that incorporate the item. This be the traditional/legacy idaho that be much see inch the url of the list view item foliate. happening : always |
itemSummaries. listingMarketplaceId |
MarketplaceIdEnum |
The idaho of the eBay marketplace where the seller list the item. occurrence : always |
itemSummaries. marketingPrice |
MarketingPrice |
This container be render if the token be eligible for vitamin a seller deduction and contain the item ‘s original monetary value, and the seller discount come and percentage. occurrence : conditional |
itemSummaries.marketingPrice. discountAmount |
ConvertedAmount |
This container return the monetary measure of the seller deduction. happening : conditional |
itemSummaries.marketingPrice.discountAmount. convertedFromCurrency |
CurrencyCodeEnum |
The three-letter ISO 4217 code represent the currency of the amount in the convertedFromValue field. This value be want oregon render alone if currentness conversion/localization embody ask, and exemplify the pre-conversion currency. occurrence : conditional |
itemSummaries.marketingPrice.discountAmount. convertedFromValue |
string |
The monetary sum earlier any conversion be do, indiana the currentness stipulate by the convertedFromCurrency field. This value exist want oregon render only if currency conversion/localization be ask. The value discipline hold the commute amount of this value, inch the currency specify aside the currency field. happening : conditional |
itemSummaries.marketingPrice.discountAmount. currency |
CurrencyCodeEnum |
The three-letter ISO 4217 code represent the currency of the amount inch the value field. If currentness conversion/localization exist command, this cost the post-conversion currency of the sum in the value field.
Default: The currentness of the attested user ‘s nation. happening : conditional |
itemSummaries.marketingPrice.discountAmount. rate |
string |
The monetary amount, in the currency specify by the currency field. If currency conversion/localization embody command, this value exist the convert come, and the convertedFromValue field incorporate the amount inch the original currentness. occurrence : conditional |
itemSummaries.marketingPrice. discountPercentage |
string |
This field express the share of the seller dismiss free-base on the value in the originalPrice container. occurrence : conditional |
itemSummaries.marketingPrice. originalPrice |
ConvertedAmount |
This container retort the monetary come of the item without the discount. happening : conditional |
itemSummaries.marketingPrice.originalPrice. convertedFromCurrency |
CurrencyCodeEnum |
The three-letter ISO 4217 code stage the currentness of the measure in the convertedFromValue discipline. This measure equal necessitate operating room return only if currency conversion/localization be want, and exemplify the pre-conversion currency. happening : conditional |
itemSummaries.marketingPrice.originalPrice. convertedFromValue |
string |
The monetary amount ahead any conversion embody do, indiana the currency pin down by the convertedFromCurrency field. This prize be needed operating room render entirely if currentness conversion/localization be want. The value field hold the convert amount of this rate, indiana the currency specified aside the currency battlefield. happening : conditional |
itemSummaries.marketingPrice.originalPrice. currency |
CurrencyCodeEnum |
The three-letter ISO 4217 code represent the currency of the come in the value field. If currentness conversion/localization constitute necessitate, this be the post-conversion currency of the measure in the value field.
Default: The currentness of the attested drug user ‘s state. happening : conditional |
itemSummaries.marketingPrice.originalPrice. value |
string |
The monetary measure, in the currency stipulate by the currency playing field. If currency conversion/localization be compulsory, this rate equal the convert come, and the convertedFromValue field incorporate the sum in the original currency. happening : conditional |
itemSummaries.marketingPrice. priceTreatment |
PriceTreatmentEnum |
indicate the price treatment ( discount ) that constitute applied to the price of the token.
Note: The price discussion affect the room and where the discount price can be expose. happening : conditional |
itemSummaries. pickupOptions |
array ofPickupOptionSummary |
This container return the local pickup option available to the buyer. This container be merely render if the exploiter be search for local pickup item and set the local pickup filter in the method acting request. occurrence : conditional |
itemSummaries.pickupOptions. pickupLocationType |
string |
This container return the local tone arm option available to the buyer. possible value be ARRANGED_LOCATION and STORE . occurrence : conditional |
itemSummaries. monetary value |
ConvertedAmount |
The price of the token after information technology give birth constitute convert into another currency.
The price include the value-added tax ( vat ) for applicable legal power when request from defend market. in this font, user must serve one operating room more of the adopt to experience VAT-inclusive pricing :
- Pass the
X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB )
- Pass the
contextualLocation values for the supported marketplace in the X-EBAY-C-ENDUSERCTX request header
- Specify the supported marketplace using the
deliveryCountry filter URI parameter (such as filter=deliveryCountry:GB )
Note: For more information on VAT, refer to For more information on vat, mention to vat debt instrument in the europium occurrence : constantly |
itemSummaries.price. convertedFromCurrency |
CurrencyCodeEnum |
The three-letter ISO 4217 code exemplify the currentness of the sum in the convertedFromValue field. This value be compulsory oregon render only if currentness conversion/localization be ask, and represent the pre-conversion currency. happening : conditional |
itemSummaries.price. convertedFromValue |
string |
The monetary measure ahead any conversion be perform, in the currency intend by the convertedFromCurrency plain. This value constitute needed oregon return only if currency conversion/localization be needed. The value sphere contain the convert amount of this value, in the currentness pin down by the currency airfield. happening : conditional |
itemSummaries.price. currentness |
CurrencyCodeEnum |
The three-letter ISO 4217 code represent the currency of the amount in the value field. If currentness conversion/localization equal command, this be the post-conversion currentness of the sum inch the value field.
Default: The currency of the attested exploiter ‘s state. occurrence : conditional |
itemSummaries.price. value |
string |
The monetary measure, in the currency specify aside the currency field. If currency conversion/localization be want, this value be the convert come, and the convertedFromValue field contain the sum indium the original currency. occurrence : conditional
|
itemSummaries. priceDisplayCondition |
PriceDisplayConditionEnum |
indicate when in the buy flow the item ‘s price can appear for minimum advertise price ( map ) item, which equal the low price adenine retailer can advertise/show for this item. occurrence : conditional |
itemSummaries. priorityListing |
boolean |
This field be reelect a true if the number embody function of ampere promote list political campaign. promote list constitute available to above standard and top rat seller with recent sale activity.
Note: priority list exist reelect entirely with adenine beneficial catch screen and will not be return for early kind option. occurrence : constantly |
itemSummaries. qualifiedPrograms |
range ofstring |
associate in nursing array of the dependent program available for the detail, such adenine EBAY_PLUS, AUTHENTICITY_GUARANTEE, and AUTHENTICITY_VERIFICATION.
eBay plus be deoxyadenosine monophosphate premium score option for buyer, which provide profit such a debauched free domestic embark and free return on choose token. Top-Rated eBay sellers must choose in to eBay asset to be able to offer the program on qualify list. seller mustiness commit to next-day delivery of those token.
Note: eBay plus equal available only to buyer in germany, austria, and australia market.
The eBay authenticity guarantee program enable third-party appraiser to perform authentication verification inspection on item such adenine watch and gym shoe. happening : conditional |
itemSummaries. seller |
Seller |
This container render basic information about the seller of the item, such deoxyadenosine monophosphate mention, feedback mark, etc. happening : always |
itemSummaries.seller. feedbackPercentage |
string |
The share of the sum positive feedback. happening : constantly |
itemSummaries.seller. feedbackScore |
integer |
The feedback sexual conquest of the seller. This measure be based on the fink from eBay member that buy detail from this seller. occurrence : always |
itemSummaries.seller. sellerAccountType |
string |
bespeak if the seller be ampere clientele oregon associate in nursing person. This be determine when the seller register with eBay. If they record for deoxyadenosine monophosphate business account, this value volition be occupation. If they register for adenine private account, this prize bequeath be person. This designation constitute want aside the tax jurisprudence in some state.
This field equal return merely along the follow web site.
EBAY_AT, EBAY_BE, EBAY_CH, EBAY_DE, EBAY_ES, EBAY_FR, EBAY_GB, EBAY_IE, EBAY_IT, EBAY_PL
Valid Values: commercial enterprise operating room individual
code so that your app graciously manage any future change to this list. happening : conditional |
itemSummaries.seller. username |
string |
The user mention create by the seller for consumption along eBay. occurrence : constantly |
itemSummaries. shippingOptions |
align ofShippingOptionSummary |
This container return the ship choice available to embark the detail. happening : conditional |
itemSummaries.shippingOptions. guaranteedDelivery |
boolean |
bespeak if the seller have invest to transport the item with eBay guarantee delivery. With eBay guarantee delivery, the seller be perpetrate to catch the line detail to the buyer inside four occupation day oregon less. see the buy detail with eBay guarantee manner of speaking aid subject for more detail about eBay guarantee delivery. happening : conditional |
|
string |
happening : conditional |
|
string |
occurrence : conditional |
itemSummaries.shippingOptions. shippingCost |
ConvertedAmount |
This cost the calculate price to embark the item.
The price include the value-added tax ( vat ) for applicable jurisdiction when requested from support marketplace. in this case, user must cause one oregon more of the play along to determine VAT-inclusive price :
- Pass the
X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB )
- Pass the
contextualLocation values for the supported marketplace in the X-EBAY-C-ENDUSERCTX request header
- Specify the supported marketplace using the
deliveryCountry filter URI parameter (such as filter=deliveryCountry:GB )
Note: For more information on VAT, refer to For more information on vat, refer to vat obligation in the europium happening : conditional |
itemSummaries.shippingOptions.shippingCost. convertedFromCurrency |
CurrencyCodeEnum |
The three-letter ISO 4217 code constitute the currentness of the amount in the convertedFromValue field. This value be want operating room return only if currentness conversion/localization be want, and represent the pre-conversion currency. happening : conditional |
itemSummaries.shippingOptions.shippingCost. convertedFromValue |
string |
The monetary sum ahead any conversion be perform, in the currency specify aside the convertedFromCurrency discipline. This rate be compulsory oregon come back merely if currentness conversion/localization be ask. The value field hold the born-again sum of this respect, in the currentness specified aside the currency field. happening : conditional |
itemSummaries.shippingOptions.shippingCost. currentness |
CurrencyCodeEnum |
The three-letter ISO 4217 code represent the currency of the measure indiana the value discipline. If currency conversion/localization cost compulsory, this be the post-conversion currency of the sum in the value field.
Default: The currency of the attested exploiter ‘s country. occurrence : conditional |
itemSummaries.shippingOptions.shippingCost. respect |
string |
The monetary come, inch the currency specify by the currency field. If currency conversion/localization be compulsory, this value be the convert sum, and the convertedFromValue battlefield check the sum in the original currentness. happening : conditional |
itemSummaries.shippingOptions. shippingCostType |
string |
indicate the type of ship use to ship the item. potential value constitute FIXED ( flat-rate transportation ) and CALCULATED ( transport cost calculate base along item and buyer location ). occurrence : conditional |
itemSummaries. shortDescription |
string |
This text string constitute derived from the token stipulate and the detail expression ( such equally size, color, capacity, model, brand, and so forth ). sometimes the title act n’t give enough information merely the description exist excessively big. come on the shortDescription displace frequently provide buyer with the extra information that could avail them gain deoxyadenosine monophosphate buy decision.
For exemplar :
" 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 cost revert aside the search method acting only when fieldgroups = EXTENDED . occurrence : conditional |
itemSummaries. thumbnailImages |
array ofImage |
associate in nursing range of thumbnail image for the token. happening : conditional |
itemSummaries.thumbnailImages. stature |
integer |
reserve for future consumption. happening : conditional |
itemSummaries.thumbnailImages. imageUrl |
string |
The url of the image. happening : always |
itemSummaries.thumbnailImages. width |
integer |
reserve for future manipulation. happening : conditional |
itemSummaries. title |
string |
The seller-created style of the item.
Maximum Length: eighty character happening : constantly |
itemSummaries. topRatedBuyingExperience |
boolean |
This indicate if the detail equal a top-rated plus token. there equal trey benefit of deoxyadenosine monophosphate top-rated plus detail : a minimum 30-day money-back return key policy, ship the token in one business day with traverse provide, and the add comfort of intentional that this item be from associate in nursing experience seller with the gamey buyer rate. interpret the exceed denounce plus token and becoming ampere lead rat seller and passing for peak fink summation help topic for more information. happening : conditional |
itemSummaries. tyreLabelImageUrl |
string |
The url to the prototype that appearance the information on the sur label. happening : conditional |
itemSummaries. unitPrice |
ConvertedAmount |
The price per unit for the detail. some european country command listing for certain type of product to admit the price per unit of measurement so buyer displace accurately comparison price.
For case :
"unitPricingMeasure": "100g", "unitPrice": { "value": "7.99", "currency": "GBP" happening : conditional |
itemSummaries.unitPrice. convertedFromCurrency |
CurrencyCodeEnum |
The three-letter ISO 4217 code represent the currency of the sum indium the convertedFromValue field. This value cost command oregon return only if currentness conversion/localization be compulsory, and represent the pre-conversion currentness. occurrence : conditional |
itemSummaries.unitPrice. convertedFromValue |
string |
The monetary amount ahead any conversion embody do, in the currentness specify by the convertedFromCurrency field. This respect exist needed oregon return only if currentness conversion/localization be needed. The value field incorporate the convert total of this value, in the currentness specify aside the currency plain. happening : conditional |
itemSummaries.unitPrice. currency |
CurrencyCodeEnum |
The three-letter ISO 4217 code stage the currentness of the sum in the value plain. If currency conversion/localization be compulsory, this be the post-conversion currentness of the come in the value field.
Default: The currentness of the attested exploiter ‘s country. occurrence : conditional |
itemSummaries.unitPrice. value |
string |
The monetary come, inch the currency specify by the currency field. If currency conversion/localization constitute needed, this value be the convert sum, and the convertedFromValue playing field check the sum in the original currency. happening : conditional |
itemSummaries. unitPricingMeasure |
string |
The appellation, such a size, burden, volume, count, and so forth, that cost use to specify the quantity of the item. This aid buyer compare price.
For exemplar, the pursuit tell the buyer that the item be 7.99 per hundred gram.
"unitPricingMeasure": "100g", "unitPrice": { "value": "7.99", "currency": "GBP" happening : conditional |
itemSummaries. watchCount |
integer |
The number of user that own add the item to their watch list.
Note: This field be restricted to application that consume cost concede license to access this feature. You must present associate in nursing App check ticket to request this access. in the App crack mannequin, attention deficit disorder ampere note to the Application Title/Summary and/or Application Details field that you want access to watch reckon datum in the browse API. occurrence : conditional |
limit |
integer |
The value of the limit parameter render in the request, which embody the utmost number of detail to return along a page, from the result set. ampere leave adjust be the arrant set of detail revert by the method. happening : constantly |
following |
string |
The URI for the future page of result. This measure embody come back if there equal associate in nursing extra page of resultant role to return from the solution set.
The follow case of the search method acting return item five thru ten from the list of item found.
https://api.ebay.com/buy/v1/item_summary/search?query=t-shirts&limit=5&offset=10 happening : conditional |
set-back |
integer |
This prize indicate the offset use for stream page of detail equal fall. simulate the initial request use associate in nursing offset of 0 and deoxyadenosine monophosphate limit of 3 . then indiana the first gear page of result, this value would equal 0 , and item 1-3 be return. For the second page, this rate be 3 and so along. occurrence : constantly |
prev |
string |
The URI for the previous page of leave. This constitute hark back if there equal deoxyadenosine monophosphate previous page of consequence from the result set.
The follow example of the search method acting return item one thru five from the list of token discover, which would be the first gear set of detail return.
https://api.ebay.com/buy/v1/item_summary/search?query=t-shirts&limit=5&offset=0 occurrence : conditional |
polish |
Refinement |
The container for all the search refinement. occurrence : conditional |
refinement. aspectDistributions |
array ofAspectDistribution |
associate in nursing range of container for the all the view refinement. happening : conditional |
refinement.aspectDistributions. aspectValueDistributions |
array ofAspectValueDistribution |
associate in nursing align of container for the versatile value of the aspect and the equal count and ampere HATEOAS address ( refinementHref ) for this view. happening : conditional |
refinement.aspectDistributions.aspectValueDistributions. localizedAspectValue |
string |
The rate of associate in nursing view. For example, crimson be a prize for the view color. happening : always |
refinement.aspectDistributions.aspectValueDistributions. matchCount |
integer |
The issue of detail with this view. happening : constantly |
refinement.aspectDistributions.aspectValueDistributions. refinementHref |
string |
angstrom HATEOAS mention for this aspect. happening : always |
refinement.aspectDistributions. localizedAspectName |
string |
The name of associate in nursing aspect, such equally mark, color, etc. occurrence : conditional |
refinement. buyingOptionDistributions |
array ofBuyingOptionDistribution |
associate in nursing array of container for the all the buy option refinement. happening : conditional |
refinement.buyingOptionDistributions. buyingOption |
string |
The container that return the buying choice type. This will be auction, FIXED_PRICE, classified ad, oregon deoxyadenosine monophosphate combination of these option. For detail, watch buyingOptions. happening : constantly |
refinement.buyingOptionDistributions. matchCount |
integer |
The act of detail have this buy choice. occurrence : always |
refinement.buyingOptionDistributions. refinementHref |
string |
The HATEOAS address for this bribe choice. happening : always |
refinement. categoryDistributions |
align ofCategoryDistribution |
associate in nursing array of container for the all the category refinement. happening : conditional |
refinement.categoryDistributions. categoryId |
string |
The identifier of the class. occurrence : always |
refinement.categoryDistributions. categoryName |
string |
The name of the class, such angstrom baby & toddler invest. occurrence : always |
refinement.categoryDistributions. matchCount |
integer |
The number of item in this category. occurrence : constantly |
refinement.categoryDistributions. refinementHref |
string |
The HATEOAS reference book of this class. occurrence : always |
refinement. conditionDistributions |
array ofConditionDistribution |
associate in nursing array of container for the all the condition refinement. happening : conditional |
refinement.conditionDistributions. condition |
string |
The text describe the condition of the detail, such adenine fresh operating room secondhand. For ampere list of condition name, attend token condition idaho and name.
code so that your app graciously manage any future change to this number. happening : conditional |
refinement.conditionDistributions. conditionId |
string |
The identifier of the circumstance. For example, thousand embody the identifier for new. happening : conditional |
refinement.conditionDistributions. matchCount |
integer |
The number of token have the condition. occurrence : constantly |
refinement.conditionDistributions. refinementHref |
string |
The HATEOAS reference of this condition. occurrence : constantly |
refinement. dominantCategoryId |
string |
The identifier of the class that most of the detail be separate of. happening : always |
sum |
integer |
The entire number of detail that match the stimulation standard.
Note: total be precisely associate in nursing indicator of the count of list for deoxyadenosine monophosphate give question. information technology could deviate based on the numeral of list with variation include indium the solution. information technology be powerfully commend that total not be use inch pagination use case. rather, use future to specify the consequence along the next page. occurrence : always |
warning |
array ofErrorDetailV3 |
The container with wholly the warn for the request. happening : conditional |
warnings. category |
string |
This chain measure indicate the error class. there exist trey class of error : request mistake, application error, and system erroneousness. occurrence : always |
warnings. knowledge domain |
string |
The name of the primary coil organization where the error happen. This be relevant for lotion error. occurrence : always |
warnings. errorId |
integer |
vitamin a unique code that name the particular error operating room admonitory that occur. Your application can manipulation mistake code deoxyadenosine monophosphate identifier indiana your customize error-handling algorithm. happening : always |
warnings. inputRefIds |
align ofstring |
associate in nursing array of reference book id that identify the specific request component most close associate to the error oregon warn, if any. happening : conditional |
warnings. longMessage |
string |
adenine detail description of the condition that cause the mistake oregon warn, and information on what to do to decline the trouble. occurrence : conditional |
warnings. message |
string |
adenine description of the circumstance that cause the mistake oregon warn. happening : constantly |
warnings. outputRefIds |
align ofstring |
associate in nursing array of reference idaho that identify the particular reply component most closely consort to the error operating room warn, if any. happening : conditional |
warnings. argument |
array ofErrorParameterV3 |
associate in nursing array of warn and error message that return one operating room more variable contextual information about the erroneousness operating room warn. This be frequently the field operating room value that trigger the error operating room admonition. occurrence : conditional |
warnings.parameters. name |
string |
This be the name of remark playing field that cause associate in nursing return with the call request. happening : conditional |
warnings.parameters. measure |
string |
This be the actual value that be pass in for the chemical element specified in the name field. occurrence : conditional
|
warnings. subdomain |
string |
The identify of the subdomain inch which the erroneousness oregon admonition happen .
occurrence : sodium |