addedInput schema / $defs / AmountData / properties / amount / description
Added value: +"Amount as an integer in the currency's minor unit (EUR cents; JPY whole yen)."
addedInput schema / $defs / AmountData / properties / currency / description
Added value: +"ISO 4217 code of the currency the amount is in."
addedInput schema / $defs / DateRangeSchema / properties / max / description
Added value: +"End of the range, as an ISO 8601 date-time with offset."
addedInput schema / $defs / DateRangeSchema / properties / min / description
Added value: +"Start of the range, as an ISO 8601 date-time with offset."
changedInput schema / $defs / DestinationData / oneOf
Previous value: -[
- {
- "additionalProperties": false,
- "properties": {
- "kind": {
- "const": "NONE",
- "type": "string"
- }
- },
- "required": [
- "kind"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "country": {
- "type": "string"
- },
- "kind": {
- "const": "COUNTRY",
- "type": "string"
- }
- },
- "required": [
- "kind",
- "country"
- ],
- "type": "object"
- }
-]New value: +[
+ {
+ "additionalProperties": false,
+ "description": "No destination country.",
+ "properties": {
+ "kind": {
+ "const": "NONE",
+ "description": "Selects this variant; always `NONE` here.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "kind"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "A destination country.",
+ "properties": {
+ "country": {
+ "description": "ISO 3166-1 alpha-2 country code.",
+ "type": "string"
+ },
+ "kind": {
+ "const": "COUNTRY",
+ "description": "Selects this variant; always `COUNTRY` here.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "kind",
+ "country"
+ ],
+ "type": "object"
+ }
+]
addedInput schema / $defs / GeographicSearchData / properties / countries / description
Added value: +"ISO 3166-1 alpha-2 country codes, at most 100; a listing matches when it is located in any of them."
addedInput schema / $defs / GeographicSearchData / properties / distanceOrder / description
Added value: +"Order results by distance from `origin`, `ASC` (nearest first) or `DESC`; requires `origin`."
addedInput schema / $defs / GeographicSearchData / properties / mode / description
Added value: +"Which locations count when measuring distance: `STRICT` (default) only exact premises, `APPROXIMATE` also street, locality and representative points; `APPROXIMATE` needs `origin` with `radius` or `distanceOrder`."
addedInput schema / $defs / GeographicSearchData / properties / origin / description
Added value: +"Point that `radius` and `distanceOrder` measure from; required by either of them."
changedInput schema / $defs / GeographicSearchData / properties / radius / anyOf
Previous value: -[
- {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "number"
- },
- "unit": {
- "type": "string"
- }
- },
- "required": [
- "amount",
- "unit"
- ],
- "type": "object"
- },
- {
- "type": "null"
- }
-]New value: +[
+ {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "description": "Distance in `unit`; greater than 0.",
+ "type": "number"
+ },
+ "unit": {
+ "description": "Unit of `amount`: one of MILES, YARDS, FEET, INCHES, KILOMETERS, METERS, CENTIMETERS, MILLIMETERS, NAUTICAL_MILES.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "amount",
+ "unit"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+]
addedInput schema / $defs / GeographicSearchData / properties / radius / description
Added value: +"Only listings within this distance of `origin`, at most 20,000 km."
addedInput schema / $defs / GeographicSearchData / properties / subdivisions / description
Added value: +"ISO 3166-2 subdivision codes, at most 100, that belong to `countries` when those are given; a listing matches when it is located in any of them."
addedInput schema / $defs / NumberRangeSchema / properties / max / description
Added value: +"Highest price to include, as an integer amount in the currency's minor unit."
addedInput schema / $defs / NumberRangeSchema / properties / min / description
Added value: +"Lowest price to include, as an integer amount in the currency's minor unit."
addedInput schema / $defs / OriginData / properties / latitude / description
Added value: +"Latitude in decimal degrees."
addedInput schema / $defs / OriginData / properties / longitude / description
Added value: +"Longitude in decimal degrees."
addedInput schema / $defs / ProductListingSearchCursorInputData / properties / fxRateId / description
Added value: +"Exchange-rate snapshot ID (`fx_…`) from the previous page's `searchAfter`, passed back unchanged."
changedInput schema / $defs / ProductListingSearchCursorInputData / properties / searchAfter
Previous value: -trueNew value: +{
+ "description": "Opaque sort values from the previous page's `searchAfter`, passed back unchanged."
+}
addedInput schema / $defs / ShippingSearchData / properties / collectionOffered / description
Added value: +"Only listings that offer collection in person; the only shipping condition that works without a destination country."
addedInput schema / $defs / ShippingSearchData / properties / destination / description
Added value: +"Country the listing must ship to, as `{\"kind\":\"COUNTRY\",\"country\":\"DE\"}`; `{\"kind\":\"NONE\"}` sets no destination."
addedInput schema / $defs / ShippingSearchData / properties / interpretation / description
Added value: +"`WHOLE_COUNTRY_PER_ITEM_V1` (default) or `WHOLE_COUNTRY_PER_ITEM_FX_V1`, which values `maximumPerItem` in its own currency at the request's exchange rates and requires `maximumPerItem`."
addedInput schema / $defs / ShippingSearchData / properties / maximumPerItem / description
Added value: +"Highest acceptable shipping price per item, in the amount's own currency; requires a `destination` country. Amounts are always integers in the currency's minor unit when one exists (EUR `119199` = €1,191.99; USD in cents). For currencies without minor units, such as JPY, the amount is whole units (`211453` = ¥211,453). Follow ISO 4217 exponents."
addedInput schema / $defs / ShippingSearchData / properties / referenceRelease / description
Added value: +"Version of the ISO 3166 code list the country code comes from; `iso-codes-4.20.1` is the only accepted value and the default."
addedInput schema / $defs / ShippingSearchData / properties / service / description
Added value: +"Shipping service code the terms must include, as free text of at most 128 characters; requires a `destination` country."
addedInput schema / properties / auctionId / description
Added value: +"Only listings that belong to these auctions, given as auction IDs (`auc_…`)."
addedInput schema / properties / availability / description
Added value: +"Only listings in one of these exact availability states; combined with `orderability`, a listing must satisfy both."
addedInput schema / properties / created / description
Added value: +"Range on the listing's creation time, as ISO 8601 date-times with offset; both bounds inclusive."
addedInput schema / properties / currency / description
Added value: +"Currency prices are returned in and `price` is interpreted in, as an ISO 4217 code (default `EUR`)."
addedInput schema / properties / enhancedSearchDescription / description
Added value: +"Optional natural-language description that refines the ranking of `productQuery` results. Only effective together with `productQuery`; on its own it returns unranked, unrelated results."
addedInput schema / properties / excludeListingSourceId / description
Added value: +"Leave out listings from these providers, given as listing source IDs (`ls_…`)."
addedInput schema / properties / excludeProductListingId / description
Added value: +"Listing IDs (`pl_…`) to leave out of the results."
addedInput schema / properties / geography / description
Added value: +"Where listings are located, by country, subdivision or distance from a point; every member given must hold."
addedInput schema / properties / includeUnspecifiedAvailability / description
Added value: +"Also include listings that state no availability (default false)."
addedInput schema / properties / language / description
Added value: +"Language of the returned listing text and of the titles `productQuery` is matched against, as an ISO 639-1 code (default `en`)."
addedInput schema / properties / listingSourceId / description
Added value: +"Only listings from these providers, given as listing source IDs (`ls_…`)."
addedInput schema / properties / lotBiddingOpens / description
Added value: +"Range on the time bidding on the lot opens, as ISO 8601 date-times with offset; `min` inclusive, `max` exclusive."
addedInput schema / properties / lotScheduledCloses / description
Added value: +"Range on the lot's scheduled closing time, as ISO 8601 date-times with offset; `min` inclusive, `max` exclusive."
addedInput schema / properties / order / description
Added value: +"Sort direction, `asc` or `desc` (default `desc`); only valid together with `sort`."
addedInput schema / properties / orderability / description
Added value: +"Only listings whose availability falls into one of these orderability groups; combined with `availability`, a listing must satisfy both."
addedInput schema / properties / price / description
Added value: +"Price range in the request's `currency`, with both bounds inclusive. Amounts are always integers in the currency's minor unit when one exists (EUR `119199` = €1,191.99; USD in cents). For currencies without minor units, such as JPY, the amount is whole units (`211453` = ¥211,453). Follow ISO 4217 exponents."
addedInput schema / properties / productQuery / description
Added value: +"Keyword phrases matched against listing titles; every word of one phrase must match, and a listing matches when any phrase does."
addedInput schema / properties / searchAfter / description
Added value: +"Continuation from the previous page: pass back exactly as returned by the previous page, with the same filters and sort."
addedInput schema / properties / shipping / description
Added value: +"Only listings whose advertised shipping terms meet these conditions for a destination country; every member given must hold."
changedInput schema / properties / size / description
Previous value: -"Values are clamped to the existing service-supported range 1..=100."New value: +"Number of results per page, from 1 to 100 (default 21); values outside that range are clamped."
addedInput schema / properties / sort / description
Added value: +"Field to order results by: `score` (relevance), `updated` or `created`; cannot be combined with `geography.distanceOrder`."
addedInput schema / properties / updated / description
Added value: +"Range on the listing's last update time, as ISO 8601 date-times with offset; both bounds inclusive."
addedOutput schema / $defs / OriginData / properties / latitude / description
Added value: +"Latitude in decimal degrees."
addedOutput schema / $defs / OriginData / properties / longitude / description
Added value: +"Longitude in decimal degrees."