addedInput schema / properties / budgetMax
Added value: +{
+ "default": null,
+ "description": "Maximum price for a full-size bottle, in the currency of the user's country (USD for US, EUR for DE, GBP for GB). Only prices in that currency are filtered.",
+ "type": [
+ "number",
+ "null"
+ ]
+}
removedInput schema / properties / budgetMaxGbp
Removed value: -{
- "default": null,
- "description": "Maximum price in GBP for a full-size bottle.",
- "type": [
- "number",
- "null"
- ]
-}
addedInput schema / properties / country
Added value: +{
+ "default": null,
+ "description": "The user's country as an ISO 3166-1 alpha-2 code, for example US, DE or GB. Prices are for this country, in the shop's own currency. Pass it whenever you know where the user is. When omitted, the client's location hint is used if it sent one, otherwise GB.",
+ "type": [
+ "string",
+ "null"
+ ]
+}
addedOutput schema / properties / market
Added value: +{
+ "default": null,
+ "description": "The country the prices in this result are for, its currency, and how it was chosen.",
+ "properties": {
+ "country": {
+ "description": "ISO 3166-1 alpha-2 country the prices are for, for example GB, US or DE.",
+ "type": "string"
+ },
+ "countryName": {
+ "description": "The country's name in English.",
+ "type": "string"
+ },
+ "currency": {
+ "description": "ISO 4217 code of that country's currency. Budgets are read in this currency.",
+ "type": "string"
+ },
+ "source": {
+ "description": "How the country was chosen: 'argument' (the country you passed), 'clientHint' (the client's location hint), or 'default' (GB, used when neither was given - ask the user for their country if it matters).",
+ "type": "string"
+ }
+ },
+ "required": [
+ "country",
+ "countryName",
+ "currency",
+ "source"
+ ],
+ "type": [
+ "object",
+ "null"
+ ]
+}
addedOutput schema / properties / results / items / properties / price
Added value: +{
+ "description": "Cheapest full-size bottle for the user's country, in the shop's own currency. Excludes samples and decants. Null when we hold no bottle price a shop will sell to that country.",
+ "properties": {
+ "amount": {
+ "description": "The bottle price, in Currency. This is the shop's own price, never a conversion.",
+ "type": "number"
+ },
+ "currency": {
+ "description": "ISO 4217 currency code of Amount, for example GBP, USD or EUR. The shop's own currency.",
+ "type": "string"
+ },
+ "estimate": {
+ "description": "Rough value of Amount in the user's currency, at a published reference rate. Present only when Currency differs from the user's currency and a recent rate exists. For orientation only: never use it to rank, compare or filter prices.",
+ "properties": {
+ "amount": {
+ "description": "The price converted to Currency, in whole units. Approximate.",
+ "type": "number"
+ },
+ "currency": {
+ "description": "ISO 4217 code of the user's currency.",
+ "type": "string"
+ },
+ "rateDate": {
+ "description": "Date of the reference rate used, as YYYY-MM-DD. The European Central Bank's rate, or Frankfurter's for a currency the ECB does not publish.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "amount",
+ "currency",
+ "rateDate"
+ ],
+ "type": [
+ "object",
+ "null"
+ ]
+ },
+ "excludesTax": {
+ "description": "True when the shop quotes this price before sales tax, as US shops do. Say so when you quote it.",
+ "type": "boolean"
+ },
+ "fromAbroad": {
+ "description": "True when no shop in the user's own customs area sells a bottle, so this is the cheapest bottle from a shop in another country that delivers to them.",
+ "type": "boolean"
+ },
+ "importChargesMayApply": {
+ "description": "True when the user may have to pay import charges on top of Amount. Say 'import charges may apply' when you quote it.",
+ "type": "boolean"
+ },
+ "pricePerMl": {
+ "description": "Amount divided by SizeMl, in Currency. USE THIS to compare value between fragrances priced in the same currency, never the bottle price - a small bottle can look cheap while costing far more per millilitre. Null when the size is unknown.",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "shipsFrom": {
+ "description": "ISO 3166-1 alpha-2 country the shop sells from, for example GB or US.",
+ "type": "string"
+ },
+ "sizeMl": {
+ "description": "Bottle size in millilitres that Amount applies to. 0 means the shop did not state a size.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "amount",
+ "currency",
+ "sizeMl",
+ "pricePerMl",
+ "excludesTax",
+ "fromAbroad",
+ "shipsFrom",
+ "importChargesMayApply",
+ "estimate"
+ ],
+ "type": [
+ "object",
+ "null"
+ ]
+}
removedOutput schema / properties / results / items / properties / priceFromGbp
Removed value: -{
- "description": "Lowest UK price we hold for a full-size bottle, in GBP. Excludes samples and decants. Null when we hold no full-size price.",
- "type": [
- "number",
- "null"
- ]
-}
removedOutput schema / properties / results / items / properties / pricePerMlGbp
Removed value: -{
- "description": "PriceFromGbp divided by PriceSizeMl. USE THIS to compare value between fragrances, never the bottle price - a small bottle can look cheap while costing far more per millilitre. Null when the size is unknown.",
- "type": [
- "number",
- "null"
- ]
-}
removedOutput schema / properties / results / items / properties / priceSizeMl
Removed value: -{
- "description": "Bottle size in millilitres that PriceFromGbp applies to. 0 means the retailer did not state a size.",
- "type": [
- "number",
- "null"
- ]
-}
changedOutput schema / properties / results / items / required
Previous value: -[
- "slug",
- "name",
- "brand",
- "brandSlug",
- "concentration",
- "yearLaunched",
- "verdictBadge",
- "verdict",
- "keyNotes",
- "priceFromGbp",
- "priceSizeMl",
- "pricePerMlGbp",
- "imageUrl",
- "scentArtUrl",
- "url"
-]New value: +[
+ "slug",
+ "name",
+ "brand",
+ "brandSlug",
+ "concentration",
+ "yearLaunched",
+ "verdictBadge",
+ "verdict",
+ "keyNotes",
+ "price",
+ "imageUrl",
+ "scentArtUrl",
+ "url"
+]