Partner API

For travel agencies who want to offer ARCH UMRAH COMPANY Umrah groups from their own systems.

For travel agencies

Connect your systems to our Umrah groups

The Partner API lets registered agencies read live group availability, prices, hotels and flights, place on-hold reservations, and track those bookings — all under their own ARCH UMRAH COMPANY account.

What partners can do

A dedicated interface for agencies — built for how you already work with our groups.

Live group availability

See which Umrah groups are open and how many seats remain, as the figures stand now.

Prices, hotels and flights

Read package prices together with the hotels and flights attached to each group.

Book on-hold reservations

Place a reservation that is held for your agency until our staff confirm it.

Track your reservations

Look up the reservations created under your agency account and follow their status.

How it works

From first request to confirmed booking, the process stays with our staff.

  1. 01

    Request access

    Send a short enquiry with your agency details using the form on this page, email or WhatsApp.

  2. 02

    We issue your key

    Our staff review the request and, if approved, issue a private API key for your agency only.

  3. 03

    Integrate

    Your developers connect to the live documentation and start reading groups or placing on-hold bookings.

  4. 04

    We confirm bookings

    Reservations are created on hold. Our team confirms them in the usual way before they go ahead.

Built with care for your data

Access is issued by our staff, scoped to your agency, and carried over a secure connection.

HTTPS only

The API is available only over an encrypted HTTPS connection.

Per-agency keys

Each approved agency receives its own credentials. Keys must be sent in request headers, not in a web address.

Your data only

An agency can see and book only against its own account — not another partner's reservations or details.

Rate limits

Request limits protect the service so it stays reliable for every partner.

Endpoint overview

A short map of the service. The live documentation has request and response details.

MethodPathPurposeAccess
GET/api/umrah/pingService statusOpen
GET/api/umrah/docsHuman-readable documentationOpen
GET/api/umrah/openapi.jsonMachine-readable API descriptionOpen
GET/api/umrah/public/packagesPublished Umrah packages on this website (no key)Open
GET/api/umrah/public/packages/{packageCode}One published package by code (no key)Open
GET/api/umrah/groupsBookable groups, availability, prices, hotels and flightsAgency key
GET/api/umrah/room-typesRoom type reference listAgency key
GET/api/umrah/gendersGender reference listAgency key
GET/api/umrah/reservationsList reservations for your agencyAgency key
GET/api/umrah/reservations/{no}Look up one reservationAgency key
POST/api/umrah/reservationsCreate an on-hold reservationAgency key

Public Packages API — open to everyone

Anyone can read the same bookable Umrah packages shown on this website. No API key or login is required.

The public feed lists package codes, titles, travel dates, hotel names, flights and public prices exactly as they appear on this website.

Booking still requires a partner key. The public packages API is read-only.

Sample request

GET /api/umrah/public/packages
curl -sS /api/umrah/public/packages

Sample response

{
  "packages": [
    {
      "packageCode": "UP-100001",
      "groupCode": "UG-100001",
      "title": "7 Nights Makkah & Madinah",
      "summary": "Direct flights with 4-star hotels.",
      "pageUrl": "https://crm.archsoftware.net.pk/umrah-packages/7-nights-makkah-madinah",
      "travelDate": "2026-12-01",
      "returnDate": "2026-12-08",
      "makkahNights": 4,
      "madinahNights": 3,
      "nights": 7,
      "currency": "SAR",
      "priceFrom": 4500,
      "pricesVisible": true,
      "prices": [
        { "code": "sharing", "label": "Sharing", "amount": 4500 },
        { "code": "quad", "label": "Quad room", "amount": 4800 },
        { "code": "triple", "label": "Triple room", "amount": 5200 },
        { "code": "double", "label": "Double room", "amount": 5800 }
      ],
      "availability": "available",
      "availableSeats": 18,
      "totalSeats": 45,
      "airline": { "name": "Saudia", "code": "SV" },
      "route": "LHE-JED",
      "departure": { "flightNo": "SV123", "from": "LHE", "to": "JED", "date": "2026-12-01", "etd": "10:00", "eta": "13:30", "baggage": "30kg" },
      "returnFlight": { "flightNo": "SV124", "from": "MED", "to": "LHE", "date": "2026-12-08", "etd": "15:00", "eta": "22:00", "baggage": "30kg" },
      "includes": { "visa": true, "transport": "AC Bus" },
      "terms": "Prices are per person and subject to availability.",
      "hotels": [
        { "city": "Makkah", "name": "Example Makkah Hotel", "stars": 4, "rating": "4 Star", "distance": "400 m to Haram" },
        { "city": "Madinah", "name": "Example Madinah Hotel", "stars": 4, "rating": "4 Star", "distance": "300 m to Haram" }
      ]
    }
  ]
}

JavaScript example

fetch("/api/umrah/public/packages")
  .then(function (r) { return r.json(); })
  .then(function (data) { console.log(data.packages); });

Request API access

Tell us about your agency. Our team will review your request and, if it is approved, issue your API credentials.