addedOutput schema / properties / items
Added value: +{
+ "description": "One page of deals: each boat once, as a search row priced on its best deal stay.",
+ "items": {
+ "description": "One item.",
+ "properties": {
+ "aiDiscount": {
+ "description": "The AI booking discount on this row's price: with dates on the stay's price, without dates on the from-price.",
+ "properties": {
+ "paidAtBooking": {
+ "description": "With dates: what is paid at booking at the AI price (what is paid at the base is unchanged).",
+ "properties": {
+ "amount": {
+ "description": "In major units (euros, not cents).",
+ "type": "number"
+ },
+ "currency": {
+ "description": "ISO 4217.",
+ "type": "string"
+ },
+ "text": {
+ "description": "The amount written out, to quote to the person.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "percent": {
+ "description": "The discount, percent.",
+ "type": "number"
+ },
+ "price": {
+ "description": "The price after the discount.",
+ "properties": {
+ "amount": {
+ "description": "In major units (euros, not cents).",
+ "type": "number"
+ },
+ "currency": {
+ "description": "ISO 4217.",
+ "type": "string"
+ },
+ "text": {
+ "description": "The amount written out, to quote to the person.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "total": {
+ "description": "With dates, where the source states a total: that total with the price at the AI price (extras unchanged).",
+ "properties": {
+ "amount": {
+ "description": "In major units (euros, not cents).",
+ "type": "number"
+ },
+ "currency": {
+ "description": "ISO 4217.",
+ "type": "string"
+ },
+ "text": {
+ "description": "The amount written out, to quote to the person.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "base": {
+ "description": "Its base.",
+ "type": "string"
+ },
+ "country": {
+ "description": "Its country.",
+ "type": "string"
+ },
+ "currency": {
+ "description": "ISO 4217.",
+ "type": "string"
+ },
+ "extras": {
+ "description": "The default package's extras: show the mandatory ones by name and amount.",
+ "properties": {
+ "included": {
+ "description": "Included, nothing to pay.",
+ "items": {
+ "description": "One extra.",
+ "properties": {
+ "amount": {
+ "description": "An amount in the site currency.",
+ "properties": {
+ "amount": {
+ "description": "In major units (euros, not cents).",
+ "type": "number"
+ },
+ "currency": {
+ "description": "ISO 4217.",
+ "type": "string"
+ },
+ "text": {
+ "description": "The amount written out, to quote to the person.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "name": {
+ "description": "Its name.",
+ "type": "string"
+ },
+ "paid": {
+ "description": "at the base, or in advance.",
+ "type": "string"
+ },
+ "per": {
+ "description": "booking, hour, day, night, week or week-started.",
+ "type": "string"
+ },
+ "perPerson": {
+ "description": "Per person.",
+ "type": "boolean"
+ },
+ "percentOfPrice": {
+ "description": "A percentage of the price instead of an amount.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "optional": {
+ "description": "The person's choice, the first few.",
+ "items": {
+ "description": "One extra.",
+ "properties": {
+ "amount": {
+ "description": "An amount in the site currency.",
+ "properties": {
+ "amount": {
+ "description": "In major units (euros, not cents).",
+ "type": "number"
+ },
+ "currency": {
+ "description": "ISO 4217.",
+ "type": "string"
+ },
+ "text": {
+ "description": "The amount written out, to quote to the person.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "name": {
+ "description": "Its name.",
+ "type": "string"
+ },
+ "paid": {
+ "description": "at the base, or in advance.",
+ "type": "string"
+ },
+ "per": {
+ "description": "booking, hour, day, night, week or week-started.",
+ "type": "string"
+ },
+ "perPerson": {
+ "description": "Per person.",
+ "type": "boolean"
+ },
+ "percentOfPrice": {
+ "description": "A percentage of the price instead of an amount.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "required": {
+ "description": "Must be paid.",
+ "items": {
+ "description": "One extra.",
+ "properties": {
+ "amount": {
+ "description": "An amount in the site currency.",
+ "properties": {
+ "amount": {
+ "description": "In major units (euros, not cents).",
+ "type": "number"
+ },
+ "currency": {
+ "description": "ISO 4217.",
+ "type": "string"
+ },
+ "text": {
+ "description": "The amount written out, to quote to the person.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "name": {
+ "description": "Its name.",
+ "type": "string"
+ },
+ "paid": {
+ "description": "at the base, or in advance.",
+ "type": "string"
+ },
+ "per": {
+ "description": "booking, hour, day, night, week or week-started.",
+ "type": "string"
+ },
+ "perPerson": {
+ "description": "Per person.",
+ "type": "boolean"
+ },
+ "percentOfPrice": {
+ "description": "A percentage of the price instead of an amount.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "facts": {
+ "description": "The facts its page shows, labelled: sizes, rooms, engine, tanks, whatever the source states.",
+ "items": {
+ "description": "One fact.",
+ "properties": {},
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "gallery": {
+ "description": "Its photos, as the source names them.",
+ "items": {
+ "description": "One photo, an absolute URL.",
+ "properties": {
+ "alt": {
+ "description": "What it shows.",
+ "type": "string"
+ },
+ "src": {
+ "description": "https URL.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "href": {
+ "description": "Its page on this site, absolute URL.",
+ "type": "string"
+ },
+ "id": {
+ "description": "With place, placeId or nearLat: its BM id.",
+ "type": "string"
+ },
+ "image": {
+ "description": "One photo, an absolute URL.",
+ "properties": {
+ "alt": {
+ "description": "What it shows.",
+ "type": "string"
+ },
+ "src": {
+ "description": "https URL.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "kind": {
+ "description": "Its type, in the site's words.",
+ "type": "string"
+ },
+ "km": {
+ "description": "With nearLat: how far its base is.",
+ "type": "number"
+ },
+ "mainEquipment": {
+ "description": "The main equipment, the first few, as stated.",
+ "items": {
+ "description": "One item.",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "mandatoryExtras": {
+ "description": "Without dates: what its cheapest quote says is payable on top.",
+ "properties": {
+ "amount": {
+ "description": "In major units (euros, not cents).",
+ "type": "number"
+ },
+ "currency": {
+ "description": "ISO 4217.",
+ "type": "string"
+ },
+ "text": {
+ "description": "The amount written out, to quote to the person.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "model": {
+ "description": "Its model.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Its name.",
+ "type": "string"
+ },
+ "onRequest": {
+ "description": "What the source does not state: say \"on request\" for it, never leave it blank.",
+ "items": {
+ "description": "deposit or extras.",
+ "enum": [
+ "deposit",
+ "extras"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "priceBeforeAiDiscount": {
+ "description": "The price the AI booking discount is taken from (not the source's list price).",
+ "properties": {
+ "amount": {
+ "description": "In major units (euros, not cents).",
+ "type": "number"
+ },
+ "currency": {
+ "description": "ISO 4217.",
+ "type": "string"
+ },
+ "text": {
+ "description": "The amount written out, to quote to the person.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "priceFrom": {
+ "description": "The stay's price with dates, else its cheapest quoted stay, in major units.",
+ "type": "number"
+ },
+ "priceIs": {
+ "description": "What priceFrom is. dated: the price for the dates asked. from: the lowest advertised price, said only as \"from\" it, never as the price of a week or of the person's dates.",
+ "enum": [
+ "dated",
+ "from"
+ ],
+ "type": "string"
+ },
+ "priceNote": {
+ "description": "With dates and no price for them: what to tell the person instead of a price (price on request).",
+ "type": "string"
+ },
+ "quote": {
+ "description": "request_quote prefilled for this row: call request_quote with these args and the person's email or phone.",
+ "properties": {
+ "args": {
+ "description": "items (this link), from, to, party.",
+ "type": "object"
+ },
+ "tool": {
+ "description": "request_quote.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "soldAs": {
+ "description": "How it is sold: the default package.",
+ "properties": {
+ "name": {
+ "description": "Its name as the source states it.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "staffed": {
+ "description": "Sold with staff as standard.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "status": {
+ "description": "With dates: free = every night is free on the source's published calendar; on request = the source publishes no calendar, so it is NOT known to be free: say on request, never available.",
+ "enum": [
+ "free",
+ "on request"
+ ],
+ "type": "string"
+ },
+ "stay": {
+ "description": "With dates: that stay, read live.",
+ "properties": {
+ "aiDiscount": {
+ "description": "The AI booking discount: book through this assistant and this is the price. Show it with the price struck through.",
+ "properties": {
+ "paidAtBooking": {
+ "description": "With dates: what is paid at booking at the AI price (what is paid at the base is unchanged).",
+ "properties": {
+ "amount": {
+ "description": "In major units (euros, not cents).",
+ "type": "number"
+ },
+ "currency": {
+ "description": "ISO 4217.",
+ "type": "string"
+ },
+ "text": {
+ "description": "The amount written out, to quote to the person.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "percent": {
+ "description": "The discount, percent.",
+ "type": "number"
+ },
+ "price": {
+ "description": "The price after the discount.",
+ "properties": {
+ "amount": {
+ "description": "In major units (euros, not cents).",
+ "type": "number"
+ },
+ "currency": {
+ "description": "ISO 4217.",
+ "type": "string"
+ },
+ "text": {
+ "description": "The amount written out, to quote to the person.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "total": {
+ "description": "With dates, where the source states a total: that total with the price at the AI price (extras unchanged).",
+ "properties": {
+ "amount": {
+ "description": "In major units (euros, not cents).",
+ "type": "number"
+ },
+ "currency": {
+ "description": "ISO 4217.",
+ "type": "string"
+ },
+ "text": {
+ "description": "The amount written out, to quote to the person.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "checkIn": {
+ "description": "YYYY-MM-DD.",
+ "type": "string"
+ },
+ "checkOut": {
+ "description": "YYYY-MM-DD.",
+ "type": "string"
+ },
+ "checkedAt": {
+ "description": "When the source was read, ISO time.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "deposit": {
+ "description": "The deposit held.",
+ "properties": {
+ "amount": {
+ "description": "In major units (euros, not cents).",
+ "type": "number"
+ },
+ "currency": {
+ "description": "ISO 4217.",
+ "type": "string"
+ },
+ "text": {
+ "description": "The amount written out, to quote to the person.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "discountPct": {
+ "description": "The discount the source states.",
+ "type": "number"
+ },
+ "listPrice": {
+ "description": "The source's list price above price, when discounted.",
+ "properties": {
+ "amount": {
+ "description": "In major units (euros, not cents).",
+ "type": "number"
+ },
+ "currency": {
+ "description": "ISO 4217.",
+ "type": "string"
+ },
+ "text": {
+ "description": "The amount written out, to quote to the person.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "mandatoryExtras": {
+ "description": "What the source says is payable on top, whatever the person picks.",
+ "properties": {
+ "amount": {
+ "description": "In major units (euros, not cents).",
+ "type": "number"
+ },
+ "currency": {
+ "description": "ISO 4217.",
+ "type": "string"
+ },
+ "text": {
+ "description": "The amount written out, to quote to the person.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "nights": {
+ "description": "Nights.",
+ "type": "number"
+ },
+ "price": {
+ "description": "The stay's price.",
+ "properties": {
+ "amount": {
+ "description": "In major units (euros, not cents).",
+ "type": "number"
+ },
+ "currency": {
+ "description": "ISO 4217.",
+ "type": "string"
+ },
+ "text": {
+ "description": "The amount written out, to quote to the person.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "priceBasis": {
+ "description": "Where the price comes from (weeks-summed: the stay's stored weeks added up, the total for these dates; price-list: a from-price per week, never the stay total); none = no price for these dates: say price on request and offer a quote, never a price.",
+ "enum": [
+ "quoted",
+ "weekly-rates",
+ "weeks-summed",
+ "price-list",
+ "none"
+ ],
+ "type": "string"
+ },
+ "priceNote": {
+ "description": "With priceBasis none: what to tell the person instead of a price.",
+ "type": "string"
+ },
+ "status": {
+ "description": "Whether it can be booked.",
+ "enum": [
+ "free",
+ "booked",
+ "not-a-check-in-day",
+ "not-whole-blocks",
+ "outside-calendar",
+ "not-known"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "terms": {
+ "description": "Deposit, licence, check-in days and times, as stated.",
+ "properties": {},
+ "type": "object"
+ },
+ "unitNights": {
+ "description": "Without dates: the nights one from-price buys (7 = per week).",
+ "type": "number"
+ },
+ "year": {
+ "description": "Built.",
+ "type": [
+ "number",
+ "string"
+ ]
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+}
removedOutput schema / properties / rows
Removed value: -{
- "description": "One page of deals, one row per item with its departures.",
- "items": {
- "description": "One item.",
- "properties": {
- "base": {
- "description": "Its home base.",
- "type": [
- "string",
- "null"
- ]
- },
- "departures": {
- "description": "Its discounted departures in the window, in the order asked.",
- "items": {
- "description": "One departure at one price.",
- "properties": {
- "aiDiscount": {
- "description": "The AI booking discount: book through this assistant and this is the price. Show it with the price struck through.",
- "properties": {
- "percent": {
- "description": "The discount, percent.",
- "type": "number"
- },
- "price": {
- "description": "The price after the discount.",
- "properties": {
- "amount": {
- "description": "In major units (euros, not cents).",
- "type": "number"
- },
- "currency": {
- "description": "ISO 4217.",
- "type": "string"
- },
- "text": {
- "description": "The amount written out, to quote to the person.",
- "type": "string"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "dates": {
- "description": "When several departures share every field but their dates: each one's dates, the first included.",
- "items": {
- "description": "One departure's dates.",
- "properties": {
- "from": {
- "description": "YYYY-MM-DD.",
- "type": "string"
- },
- "to": {
- "description": "YYYY-MM-DD.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "departFrom": {
- "description": "YYYY-MM-DD.",
- "type": "string"
- },
- "departTo": {
- "description": "YYYY-MM-DD.",
- "type": "string"
- },
- "kind": {
- "description": "special or offer.",
- "type": "string"
- },
- "listPrice": {
- "description": "An amount in the site currency.",
- "properties": {
- "amount": {
- "description": "In major units (euros, not cents).",
- "type": "number"
- },
- "currency": {
- "description": "ISO 4217.",
- "type": "string"
- },
- "text": {
- "description": "The amount written out, to quote to the person.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "mandatoryExtras": {
- "description": "What the departure states is payable on top.",
- "properties": {
- "amount": {
- "description": "In major units (euros, not cents).",
- "type": "number"
- },
- "currency": {
- "description": "ISO 4217.",
- "type": "string"
- },
- "text": {
- "description": "The amount written out, to quote to the person.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "nights": {
- "description": "Nights.",
- "type": "number"
- },
- "price": {
- "description": "An amount in the site currency.",
- "properties": {
- "amount": {
- "description": "In major units (euros, not cents).",
- "type": "number"
- },
- "currency": {
- "description": "ISO 4217.",
- "type": "string"
- },
- "text": {
- "description": "The amount written out, to quote to the person.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "routes": {
- "description": "Every route it leaves on at this price.",
- "items": {
- "description": "A route.",
- "properties": {
- "from": {
- "description": "Leaves from.",
- "type": "string"
- },
- "to": {
- "description": "Ends at.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "savingPct": {
- "description": "The discount the source states.",
- "type": "number"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "guests": {
- "description": "How many it takes.",
- "type": [
- "number",
- "null"
- ]
- },
- "item": {
- "description": "Its name.",
- "type": "string"
- },
- "link": {
- "description": "Its page, absolute URL: the id get and request_quote take.",
- "type": "string"
- },
- "photo": {
- "description": "One photo, absolute URL.",
- "type": [
- "string",
- "null"
- ]
- },
- "quote": {
- "description": "request_quote prefilled for this row: call request_quote with these args and the person's email or phone.",
- "properties": {
- "args": {
- "description": "items (this link), from, to, party.",
- "type": "object"
- },
- "tool": {
- "description": "request_quote.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "Its type.",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- },
- "type": "array"
-}