GET /api HTTP/1.1
Host: magpie.travel
Accept: application/json
X-Api-Key: your_api_key_here

GET /api?api_key=your_api_key_here HTTP/1.1
Host: magpie.travel
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json

{ "documentation": "https://docs.magpie.travel" }

GET /api/products HTTP/1.1
Host: magpie.travel
Accept: application/json
X-Api-Key: your_api_key_here

HTTP/1.1 200 OK
Content-Type: application/json

{
  "categories": [ ... ]
    "Air, Balloon & Helicopter Tours",
    "Attractions / Museums",
    ...
  ],
  "locations": [
    "1206 Front St, Sacramento, CA",
    "13755 Fiji Way, Marina del Rey, CA 90292",
    "207 Queens Quay W, Toronto, ON M5J 1A7, Canada",
    ...
  ],
  "limit_value": 100,
  "total_pages": 10,
  "current_page": 1,
  "next_page": 2,
  "prev_page": null,
  "products": [
    {
      "id": "3bba0442-7f76-4af2-8f90-a962a36833e8",
      "name": "Activity Private Xmas Markets & Alsace Villages",
      "internal_id": "55MJ4Q",
      "account": { "ID": "ABC123", "name": "Ophorus Tours in France" },
      "system_providers": [],
      "location": "Strasbourg",
      "category": "Tours & Sightseeing",
      "duration": "7 hours",
      "currency": "EUR",
      "language": "en",
      "timezone": "Europe/Paris",
      "highlights": [
        "Visit the famous markets of Colmar, knowledgeably guided by one of our local team.",
        "Visit Christmas markets in local villages along the Alsace Wine Route. ",
        ...
      ],
      "summary": "<div>Let us guide you through the most beautiful Alsatian villages and discover the wonders on Christmas markets in Alsace. Your suited private driver will drive you the whole day to places you want to explore. The tour is 100% tailor made and you can either visit the villages or experience a wine tasting in a typical winery.</div>",
      "description": "",
      "commentaries": [ "English: Guide", "French: Guide" ],
      "included": [
        "Visit Christmas markets in Colmar.",
        "English-speaking private driver & guide.",
        ...
      ],
      "excluded": [
        "Personal insurance and expenses.",
        "Meals & drinks.",
        ...
      ],
      "before_booking": [
        "Tour requires minimum 2 passengers (adults) to operate.",
        "Tour is operated in English, other languages on request.",
        ...
      ],
      "before_arrival": [
        "Tour involves some walking, comfortable walking shoes are recommended.",
        "Notify tour operator your Strasbourg hotel information as soon as receive confirmation. "
        ...
      ],
      "additional_info": "<div>Christmas market tour for 2 guests or a total of 8 guests, same party, in the private minivan. <br>Tour runs from 9:30am to 4:30pm, every day.<br>November 30th through December 23rd, 2019</div>",
      "restrictions": [ "Dresscode: Wear Warm Layered Clothing And Good Walking Shoes.", ... ],
      "start_date": null,
      "end_date": null,
      "booking_cutoff": [ 7, "days" ],
      "booking_min_pax": 2,
      "booking_max_pax": 8,
      "valid_for": "7 hours Only on date on reservation",
      "opening_hours": { "Sunday": "Closed", "Monday": "Open", "Tuesday": "Open", ... },
      "availability_notes": [ ],
      "addresses": [{ "location_type": "Starts", "directions": null, "notes": "Pick-up from your centrally located Strasbourg hotel.", "coordinates": "", "full_street_address": "Strasbourg, Alsace, FR" }],
      "cancellation_policy": "custom",
      "cancellation_cutoff": "7 days",
      "cancellation_notes": "Operator strictly adheres to its cancellation policy and will make no exceptions to the policy. If Guest chooses to cancel his or her reservation, ...",
      "terms_and_conditions": "Protection of personal data\r\n\r\nNCDK – OPHORUS attaches great importance to respecting the right to privacy. The policy on the protection of individuals ...",
      "voucher_info": "Notify tour operator your Strasbourg hotel information as soon as receive confirmation. ",
      "faqs": [],
      "confirmation_necessary": false,
      "redemption_type": "voucher | Evoucher"
      "covid_info": "Strict safety measures are taken"
    },
    ...
  ]
}

PUT /api/products/bulk-update HTTP/1.1
Host: magpie.travel
Accept: application/json
X-Api-Key: your_api_key_here
Content-Type: application/json

{
  "products": [
    {
      "id": "PRODUCT_ID",
      "name": "UPDATED_PRODUCT_NAME",
      ...
    }
  ]
}

HTTP/1.1 200 OK
Content-Type: application/json

{
  "message": "Products updated successfully"
}

POST /api/products/bulk-create HTTP/1.1
Host: magpie.travel
Accept: application/json
X-Api-Key: your_api_key_here
Content-Type: application/json

{
  "products": [
    {
      "name": "NEW_PRODUCT_NAME",
      ...
    }
  ]
}

HTTP/1.1 201 Created
Content-Type: application/json

[
  {
    "id": "09f33209-ece7-4166-9f5e-29a6a68da2a0",
    "account_id": "21054d26-f328-47ff-b8c2-ed1983437734",
    "code": null,
    "cancellation_notes": "Up to 24 hours before the beginning of the activity: full refund\nLess than 24 hours before the beginning of the activity or no-show: no refund",
    "created_at": "2024-08-30T09:11:03.154Z",
    "updated_at": "2024-08-30T09:11:03.248Z",
    "available_tiers": [
      "adult",
      "child"
    ],
    "tier_conditions": {},
    "weight": 900,
    "active": false,
    "currency": null,
    "freesale": false,
    "external_link": null,
    "category": null,
    "operating_type": "opening_hours",
    "url_path": null,
    "duration_type": "fixed",
    "duration_from": null,
    "duration_to": null,
    "duration_unit": null,
    "instant_confirmation": false,
    "booking_cutoff": null,
    "booking_cutoff_unit": null,
    "cancellation_cutoff": 24,
    "cancellation_cutoff_unit": "hours",
    "tier_ages": {
      "infant": {
        "from": 0,
        "to": 4
      },
      "child": {
        "from": 5,
        "to": 11
      },
      "youth": {
        "from": 12,
        "to": 17
      },
      "adult": {
        "from": 18,
        "to": 64
      },
      "senior": {
        "from": 65,
        "to": 120
      }
    },
    "limited_dates": false,
    "start_date": null,
    "end_date": null,
    "api_available": false,
    "api_mapping": null,
    "location": null,
    "min_pax": null,
    "max_pax": null,
    "has_commentary": false,
    "discarded_at": null,
    "pickup": "none",
    "private": false,
    "cancellation_policy": "standard",
    "internal_id": null,
    "percent_complete": "38.8888888888888889",
    "booking_system_id": null,
    "setup_complete": false,
    "language": "en",
    "multiday": null,
    "accommodation_included": null,
    "valid_type": null,
    "valid_for": null,
    "valid_unit": null,
    "booking_cutoff_type": null,
    "age_restrictions": {},
    "has_height_restrictions": null,
    "height_restrictions": {},
    "weight_restrictions": {},
    "health_restrictions": {},
    "dresscode_restrictions": null,
    "license_or_certification_restrictions": {},
    "additional_requirements": {},
    "item_requirements": {},
    "information_requirements": {},
    "confirmation_necessary": null,
    "redemption_type": null,
    "guide_type": null,
    "accessibility": {},
    "food_included": null,
    "beverages_included": null,
    "emergency_phone_prefix": null,
    "emergency_phone_number": null,
    "surcharges": {},
    "has_longer_description": false,
    "short_code": "HDWPQX",
    "tier_types": {},
    "rails_timezone": null,
    "timezone": null,
    "sellect_all": true,
    "external_code": {},
    "published": 1,
    "locationobj_id": null,
    "name": "test 1",
    "tier_labels": {
      "adult": "",
      "child": "",
      "youth": "",
      "infant": "",
      "senior": "",
      "student": ""
    },
    "summary": null,
    "description": null,
    "included": [],
    "excluded": [],
    "before_arrival": [],
    "before_booking": [],
    "additional_info": null,
    "highlights": [
      "asdasdasdasdas"
    ],
    "short_description": "tes1t",
    "voucher_info": null,
    "terms_and_conditions": null,
    "group_info": null,
    "special_service": null,
    "starts_notes": null,
    "max_group_size": null,
    "trip_difficulty": null,
    "videos": [],
    "contextual_keywords": null,
    "tracking_template": null,
    "custom_parameter": null,
    "health": null,
    "blocked_dates": [],
    "template": false,
    "primary_product_id": null,
    "version_type": "Primary",
    "version_name": "Primary Product",
    "version_description": null,
    "version_date_from": null,
    "version_date_to": null,
    "select_all_resellers_for_version": false,
    "health_items": [],
    "note_job_export_field": null,
    "note_job_copy_field": null,
    "linked_fields": [],
    "sharing_private": false,
    "sharing_directory": true,
    "sharing_api": true,
    "score": null,
    "listings_count": 0,
    "ignore": false,
    "ratings_average": null,
    "ratings_count": null,
    "product_name_ttd": null,
    "inventory_type": false,
    "crawl_info": {},
    "product_quality": 11,
    "ttd_brand": null,
    "partner_booking_url": null,
    "keywords": [],
    "reviews_product_page": false,
    "content_gpt": false,
    "review_widget_code": null,
    "suggestions_gpt": null,
    "conflicts_gpt": null,
    "gpt_status": null,
    "landing_page_url": null,
    "activate": false,
    "place_id_manually": null,
    "google_profile_name_manually": null,
    "option_name_ttd": {},
    "owner_of_poi": false,
    "owner_of_gbp": false,
    "product_system_providers_id": null,
    "connected_review_widget": false,
    "google_backend_connected_review_widget_id": null,
    "gpt_status_reseller": null,
    "collector": null
  }
]

{
  "created_products": [ ... ],
  "errors": [
    { "product": { "name": null, ... }, "errors": ["Name can't be blank"] }
  ]
}

GET /api/content-feed/accounts?format=json&content_type=company_info HTTP/1.1
Host: magpie.travel
Accept: application/json
X-Api-Key: your_api_key_here

GET /api/content-feed/accounts?content_type=company_info HTTP/1.1
Host: magpie.travel
X-Api-Key: your_api_key_here

GET /api/content-feed/accounts?content_type=all&format=jsonld HTTP/1.1
Host: magpie.travel
X-Api-Key: your_api_key_here

GET /api/content-feed/accounts?content_type=company_info&format=markdown HTTP/1.1
Host: magpie.travel
X-Api-Key: your_api_key_here

HTTP/1.1 200 OK
Content-Type: application/json

{
  "accounts": [
    {
      "id": "YOUR_ACCOUNT_ID",
      "name": "Account Name",
      "telephone": "+33 1 23 45 67 89",
      "website": "https://ophorus.com",
      "description": "Premium tour operator in France",
      "category": "Operator",
      "email": "[email protected]",
      "locale": "en",
      "timeZone": "Europe/Paris",
      "logo": "https://example.com/logo.png",
      "review_rating": "4.8",
      "number_review": 245,
      "bookingSystemsId": ["Ventrata", "Viator"],
      "media": [
        {
          "src": "https://example.com/logo.png",
          "type": "image/png",
          "rel": "LOGO"
        }
      ],
      "locations": [],
      "products": [],
      "faqs": [],
      "reviews": []
    }
  ],
  "count": 1
}

HTTP/1.1 200 OK
Content-Type: application/json

{
  "format": "markdown",
  "content": "# Account: Ophorus Tours in France\n\n## Company Information\n\n- **Website:** https://ophorus.com\n- **Telephone:** +33 1 23 45 67 89\n...",
  "count": 1
}

HTTP/1.1 200 OK
Content-Type: application/json

{
  "accounts": [
    {
      "id": "YOUR_ACCOUNT_ID",
      "name": "Account Name",
      "description": "Premium tour operator in France",
      "website": "https://ophorus.com",
      "contact": {
        "email": "[email protected]",
        "telephone": "+33 1 23 45 67 89"
      },
      "address": {
        "streetAddress": "123 Main St",
        "addressLocality": "Paris",
        "addressCountry": "FR"
      },
      "products": [...]
    }
  ],
  "count": 1
}

GET /api/content-feed/products?format=json&product_ids=ID1,ID2 HTTP/1.1
Host: magpie.travel
Accept: application/json
X-Api-Key: your_api_key_here

GET /api/content-feed/products?product_ids=YOUR_PRODUCT_ID_1,YOUR_PRODUCT_ID_2 HTTP/1.1
Host: magpie.travel
X-Api-Key: your_api_key_here

GET /api/content-feed/products?format=markdown&product_ids=YOUR_PRODUCT_ID HTTP/1.1
Host: magpie.travel
X-Api-Key: your_api_key_here

GET /api/content-feed/products?format=jsonl&product_ids=YOUR_PRODUCT_ID_1,YOUR_PRODUCT_ID_2,YOUR_PRODUCT_ID_3 HTTP/1.1
Host: magpie.travel
X-Api-Key: your_api_key_here

HTTP/1.1 200 OK
Content-Type: application/json

{
  "accounts": [
    {
      "products": [
        {
          "id": "YOUR_PRODUCT_ID",
          "title": "Activity Private Xmas Markets & Alsace Villages",
          "shortDescription": "Visit Christmas markets in beautiful Alsatian villages",
          "description": "Let us guide you through the most beautiful Alsatian villages...",
          "category": "Tours & Sightseeing",
          "duration": "7 hours",
          "currency": "EUR",
          "highlights": [
            "Visit the famous markets of Colmar",
            "Visit Christmas markets in local villages",
            "Wine tasting in Alsace"
          ],
          "included": [
            "Visit Christmas markets in Colmar",
            "English-speaking private driver & guide"
          ],
          "excluded": [
            "Personal insurance and expenses",
            "Meals & drinks"
          ],
          "media": [
            {
              "src": "https://example.com/image.jpg",
              "type": "image/jpeg",
              "rel": "GALLERY"
            }
          ]
        }
      ]
    }
  ],
  "count": 1
}

HTTP/1.1 200 OK
Content-Type: application/json

{
  "format": "jsonl",
  "content": "{\"type\":\"product\",\"id\":\"3bba0442-7f76-4af2-8f90-a962a36833e8\",\"name\":\"Activity Private Xmas Markets\",...}\n{\"type\":\"product\",\"id\":\"xyz789\",\"name\":\"Another Tour\",...}",
  "count": 2
}

{
  "error": "Invalid content_type. Supported types: all, company_info"
}

{
  "error": "No products found"
}

{
  "error": "Invalid format. Supported formats: json, jsonl, jsonld, json-octo, markdown, text"
}

X-Api-Key: your_api_key_here