Documentation || GoTravelly

Booklist

Dokumentasi ini menjelaskan cara mengakses layanan API GoTravelly untuk method Booklist.

API ini berfungsi untuk mendapatkan, menambahkan, dan mengubah data pesanan pengguna di GoTravelly.

Ada banyak macam method pada API ini. Untuk lebih jelasnya silahkan baca dokumentasi halaman ini secara detail.

Berikut daftar API Booklist yang tergabung jadi satu sesuai method nya:

GET (mode=browse)
GET (mode=detail)
GET (mode=pax_names)
GET (mode=custom_itin)
POST (booking)
POST (book_guide)
PUT (itineraries)
PUT (approve)
PUT (reject)
PUT (auto_reject)
PUT (reprocess)
PUT (remind_tour_incoming)
PUT (remind_complete_tour)
PUT (remind_review_tour)

Method & URL

Method	URL
GET, POST, PUT	https://www.gotravelly.com/api/booklist

Request & Response

GET (Request)

Method	Parameter	Tipe	Wajib	Keterangan
GET/HEADER	key	String	Tidak	Token code / key
GET/PARAM	mode	String	Ya	isi dengan `browse`
GET/PARAM	user_id*	Integer	Ya	User ID pada akun pengguna di GoTravelly
GET/PARAM	guide_id*	Integer	Ya	Guide ID pada akun pengguna di GoTravelly
GET/PARAM	per_page	Integer	Ya	Jumlah tampilan data pesanan pengguna per halaman
GET/PARAM	page_pending	Integer	Tidak	Halaman / offset data yang ditampilkan (biasanya digenerate otomatis)

*) pilih salah satu antara parameter user_id / guide_id.
*) user_id: parameter ini wajib untuk akses data mybooking di akun pengguna (user biasa) GoTravelly.
*) guide_id: parameter ini wajib untuk akses data booklist di akun pemandu (guide) GoTravelly.

Contoh GET {browse} (Request):

untuk mybooking / user_id

https://www.gotravelly.com/api/booklist?mode=browse&user_id=99&per_page=5&page_pending=1

untuk booklist / guide_id

https://www.gotravelly.com/api/booklist?mode=browse&guide_id=88&per_page=5&page_pending=1

Method	Parameter	Tipe	Wajib	Keterangan
GET/HEADER	key	String	Tidak	Token code / key
GET/PARAM	mode	String	Ya	isi dengan `detail`
GET/PARAM	id	Integer	Ya	Book ID / Order ID pada data pesanan di GoTravelly

Contoh GET {detail} (Request):
https://www.gotravelly.com/api/booklist?mode=detail&id=8

Method	Parameter	Tipe	Wajib	Keterangan
GET/HEADER	key	String	Tidak	Token code / key
GET/PARAM	mode	String	Ya	isi dengan `pax_names`
GET/PARAM	book_id	Integer	Ya	Book ID / Order ID pada data pesanan di GoTravelly

Contoh GET {pax_names} (Request):
https://www.gotravelly.com/api/booklist?mode=pax_names&book_id=8

Method	Parameter	Tipe	Wajib	Keterangan
GET/HEADER	key	String	Tidak	Token code / key
GET/PARAM	mode	String	Ya	isi dengan `custom_itin`
GET/PARAM	book_id	Integer	Ya	Book ID / Order ID pada data pesanan di GoTravelly

Contoh GET {custom_itin} (Request):
https://www.gotravelly.com/api/booklist?mode=custom_itin&book_id=8

GET (Response)

    {
        "status": "OK",
        "data": [
            {
                "book": {
                    "id": "24",
                    "name": "Joko Bodo",
                    "email": "sanzcruzer@gmail.com",
                    "phone": "08123234355",
                    "total_pax": "1",
                    "start_date": "2019-02-07 10:42:00",
                    "end_date": "2019-02-08 10:42:00",
                    "special_request": "tes custom itin",
                    "price": "5000",
                    "user_status": "waiting_for_itinerary",
                    "guide_status": "modify_itinerary",
                    "user_reason": null,
                    "guide_reason": null,
                    "created": "2019-01-28 10:43:19",
                    "modified_by_user": "0000-00-00 00:00:00",
                    "modified_by_guide": "2019-02-04 17:41:00",
                    "type": "tour_package",
                    "reminder_h3": "0",
                    "reminder_h1": "0",
                    "reminder_complete": "0",
                    "reminder_review": "0",
                    "is_read_guide": "1",
                    "is_read_user": "1",
                    "user_id": "93",
                    "guide_id": "105",
                    "object_reference_id": "525"
                },
                "tour_package": {
                    "id": "525",
                    "cover_photo": "45ef548b2fff480489f83c384df86671.jpg",
                    "title": "Sasasdasd",
                    "startdate": null,
                    "enddate": null,
                    "price": "100000.00",
                    "quota_filled": "2",
                    "minimum_pax": "2",
                    "maximum_pax": "5"
                },
                "guide": {
                    "id": "88",
                    "username": "lukaku",
                    "name": "lukaku guide",
                    "email": "sanzcruzer@gmail.com",
                    "photo": "b6aa8c0b6cb9cabe761205f656a994f8.jpg",
                    "phone": "123456788"
                },
                "user": {
                    "id": "99",
                    "username": "rian",
                    "name": "Rian Kurniawan",
                    "email": "rian@yahoo.com",
                    "photo": "f73d5f7372919c0cb101bfdaa0b31567.jpg"
                }
            },
            {
                "book": {
                    "id": "36",
                    "name": "Amber Heard",
                    "email": "sanzcruzer@gmail.com",
                    "phone": "087855086994",
                    "total_pax": "1",
                    "start_date": "2019-03-20 13:48:00",
                    "end_date": "2019-03-22 13:48:00",
                    "special_request": "-",
                    "price": "75000",
                    "user_status": "waiting_for_itinerary",
                    "guide_status": "modify_itinerary",
                    "user_reason": null,
                    "guide_reason": null,
                    "created": "2019-03-15 13:49:08",
                    "modified_by_user": "2019-03-15 13:49:07",
                    "modified_by_guide": "2019-03-15 13:49:45",
                    "type": "guide",
                    "reminder_h3": "0",
                    "reminder_h1": "0",
                    "reminder_complete": "0",
                    "reminder_review": "0",
                    "is_read_guide": "1",
                    "is_read_user": "1",
                    "user_id": "93",
                    "guide_id": "105",
                    "object_reference_id": "105"
                },
                "tour_package": {
                    "id": "525",
                    "cover_photo": "45ef548b2fff480489f83c384df86671.jpg",
                    "title": "Sasasdasd",
                    "startdate": null,
                    "enddate": null,
                    "price": "100000.00",
                    "quota_filled": "2",
                    "minimum_pax": "2",
                    "maximum_pax": "5"
                },
                "guide": {
                    "id": "88",
                    "username": "lukaku",
                    "name": "lukaku guide",
                    "email": "sanzcruzer@gmail.com",
                    "photo": "b6aa8c0b6cb9cabe761205f656a994f8.jpg",
                    "phone": "123456788"
                },
                "user": {
                    "id": "99",
                    "username": "rian",
                    "name": "Rian Kurniawan",
                    "email": "rian@yahoo.com",
                    "photo": "f73d5f7372919c0cb101bfdaa0b31567.jpg"
                }
            }
        ],
        "total": 2
    }

    {
        "status": "OK",
        "data": [
            {
                "book": {
                    "id": "8",
                    "name": "Joko Bodo",
                    "email": "sanzcruzer@gmail.com",
                    "phone": "08123234355",
                    "total_pax": "1",
                    "start_date": "2019-02-07 10:42:00",
                    "end_date": "2019-02-08 10:42:00",
                    "special_request": "tes custom itin",
                    "price": "5000",
                    "user_status": "waiting_for_itinerary",
                    "guide_status": "modify_itinerary",
                    "user_reason": null,
                    "guide_reason": null,
                    "created": "2019-01-28 10:43:19",
                    "modified_by_user": "0000-00-00 00:00:00",
                    "modified_by_guide": "2019-02-04 17:41:00",
                    "type": "tour_package",
                    "reminder_h3": "0",
                    "reminder_h1": "0",
                    "reminder_complete": "0",
                    "reminder_review": "0",
                    "is_read_guide": "1",
                    "is_read_user": "1",
                    "user_id": "93",
                    "guide_id": "105",
                    "object_reference_id": "525"
                },
                "tour_package": {
                    "id": "525",
                    "cover_photo": "45ef548b2fff480489f83c384df86671.jpg",
                    "title": "Sasasdasd",
                    "startdate": null,
                    "enddate": null,
                    "price": "100000.00",
                    "quota_filled": "2",
                    "minimum_pax": "2",
                    "maximum_pax": "5"
                },
                "guide": {
                    "id": "105",
                    "username": "lukaku",
                    "name": "lukaku guide",
                    "email": "sanzcruzer@gmail.com",
                    "photo": "b6aa8c0b6cb9cabe761205f656a994f8.jpg",
                    "phone": "123456788"
                },
                "user": {
                    "id": "93",
                    "username": "rian",
                    "name": "Rian Kurniawan",
                    "email": "rian@yahoo.com",
                    "photo": "f73d5f7372919c0cb101bfdaa0b31567.jpg"
                }
            }
        ]
    }

    {
        "status": "OK",
        "data": [
            {
                "id": "26",
                "title": "Mr",
                "full_name": "JOKO BODO",
                "booklist_id": "24"
            }
        ],
        "count": 1
    }

    {
        "status": "OK",
        "data": [
            {
                "id": "7",
                "body": "- Penjemputan di Bandara Yogyakarta pukul 07.00
                        - Menuju Hotel di wilayah Malioboro",
                "booklist_id": "24"
            },
            {
                "id": "8",
                "body": "- Melakukan perjalan ke Pantai Parangtritis
                        - Berbelanja Oleh Oleh di Malioboro",
                "booklist_id": "24"
            }
        ],
        "count": 2
    }

POST (Request)

booking
book_guide

Method	Parameter	Tipe	Wajib	Keterangan
POST/HEADER	key	String	Ya	Token code / key
POST/BODY	full_name	String	Ya	Nama lengkap data pemesan
POST/BODY	email	String	Ya	Email data pemesan
POST/BODY	phone_number	Integer	Ya	Nomor telepon data pemesan
POST/BODY	total_pax	Integer	Ya	Jumlah orang / penumpang yang akan ikut dalam tur
POST/BODY	start_date	Datetime	Ya	Tanggal berangkat tur yang akan dipesan
POST/BODY	end_date	Datetime	Ya	Tanggal pulang tur yang akan dipesan
POST/BODY	special_request	String	Tidak	Permintaan khusus dari pengguna pemesan
POST/BODY	user_status	String	Ya	Default berisi `pending`
POST/BODY	guide_status	String	Ya	Default berisi `pending`
POST/BODY	type	String	Ya	Isi dengan `tour_package`
POST/BODY	user_id	Integer	Ya	User ID pemesan pada akun di GoTravelly
POST/BODY	guide_id	Integer	Ya	Guide ID yang dipesan oleh pengguna pada akun di GoTravelly
POST/BODY	object_reference_id	Integer	Ya	ID dari paket tur yang akan dipesan
POST/BODY	pax_title	Array	Ya	Kata sapaan dari data penumpang yang diisi oleh pemesan
POST/BODY	pax_name	Array	Ya	Nama lengkap dari data penumpang yang diisi oleh pemesan
POST/BODY	is_custom	Boolean	Tidak	Default berisi `false`, jika `true` maka tur yang dipesan memiliki tanggal keberangkatan khusus
POST/BODY	mode	String	Ya	Isi dengan `booking`
POST/BODY	lang_id	String	Tidak	Isi dengan `english`/`indonesian`

Method	Parameter	Tipe	Wajib	Keterangan
POST/HEADER	key	String	Ya	Token code / key
POST/BODY	full_name	String	Ya	Nama lengkap data pemesan
POST/BODY	email	String	Ya	Email data pemesan
POST/BODY	phone_number	Integer	Ya	Nomor telepon data pemesan
POST/BODY	total_pax	Integer	Ya	Jumlah orang / penumpang yang akan ikut dalam jasa tur guide
POST/BODY	start_date	Datetime	Ya	Tanggal berangkat jasa tur guide yang akan dipesan
POST/BODY	end_date	Datetime	Ya	Tanggal pulang jasa tur guide yang akan dipesan
POST/BODY	user_status	String	Ya	Default berisi `pending`
POST/BODY	guide_status	String	Ya	Default berisi `pending`
POST/BODY	type	String	Ya	Isi dengan `guide`
POST/BODY	user_id	Integer	Ya	User ID pemesan pada akun di GoTravelly
POST/BODY	guide_id	Integer	Ya	Guide ID yang dipesan oleh pengguna pada akun di GoTravelly
POST/BODY	object_reference_id	Integer	Ya	ID dari jasa tur guide yang akan dipesan
POST/BODY	pax_title	Array	Ya	Kata sapaan dari data penumpang yang diisi oleh pemesan
POST/BODY	pax_name	Array	Ya	Nama lengkap dari data penumpang yang diisi oleh pemesan
POST/BODY	mode	String	Ya	Isi dengan `book_guide`
POST/BODY	lang_id	String	Tidak	Isi dengan `english`/`indonesian`

POST (Response)

Untuk response dari POST request baik booking maupun book_guide hasilnya sama.

    {
        "status": "OK",
        "message": "Data Reservasi Anda berhasil disimpan",
        "inserted_id": "8",
    }

PUT (Request)

Method	Parameter	Tipe	Wajib	Keterangan
PUT/HEADER	key	String	Ya	Token code / key
PUT/BODY	custom	Array	Ya	Jumlah dan data itinerary tur per hari
PUT/BODY	is_guide	Boolean	Tidak	Kondisi untuk memastikan data guide
PUT/BODY	guide_id	Integer	Tidak	Guide ID pada akun guide di GoTravelly
PUT/BODY	user_id	Integer	Tidak	User ID pada akun pengguna di GoTravelly
PUT/BODY	price	Integer	Ya	Harga tur yang belum disepakati
PUT/BODY	special_request	String	Ya	Permintaan khusus pengguna pemesan yang akan diproses kedalam itinerary khusus
PUT/BODY	book_id	Integer	Ya	Book ID / ID pesanan tur di GoTravelly
PUT/BODY	lang	String	Tidak	Isi dengan `english`/`indonesian`
PUT/BODY	ndetails	Integer	Ya	Jumlah hari pada itinerary khusus, misal: 3 (hari)
PUT/BODY	action	Integer	Ya	Isi dengan `itineraries`

Method	Parameter	Tipe	Wajib	Keterangan
PUT/HEADER	key	String	Ya	Token code / key
PUT/BODY	action	String	Ya	Isi dengan `approve`
PUT/BODY	book_id	Integer	Ya	Book ID / ID pesanan tur di GoTravelly
PUT/BODY	is_guide	Boolean	Tidak	Kondisi untuk memastikan data guide
PUT/BODY	user_id	Integer	Tidak	User ID pada akun pengguna di GoTravelly
PUT/BODY	guide_id	Integer	Tidak	Guide ID pada akun guide di GoTravelly
PUT/BODY	lang	String	Tidak	Isi dengan `english`/`indonesian`

Method	Parameter	Tipe	Wajib	Keterangan
PUT/HEADER	key	String	Ya	Token code / key
PUT/BODY	action	String	Ya	Isi dengan `reject`
PUT/BODY	reason	String	Ya	Alasan membatalkan pesanan
PUT/BODY	book_id	Integer	Ya	Book ID / ID pesanan tur di GoTravelly
PUT/BODY	is_guide	Boolean	Tidak	Kondisi untuk memastikan data guide
PUT/BODY	user_id	Integer	Tidak	User ID pada akun pengguna di GoTravelly
PUT/BODY	guide_id	Integer	Tidak	Guide ID pada akun guide di GoTravelly
PUT/BODY	lang	String	Tidak	Isi dengan `english`/`indonesian`

Method	Parameter	Tipe	Wajib	Keterangan
PUT/HEADER	key	String	Ya	Token code / key
PUT/BODY	action	String	Ya	Isi dengan `auto_reject`
PUT/BODY	book_id	Integer	Ya	Book ID / ID pesanan tur di GoTravelly
PUT/BODY	is_guide	Boolean	Tidak	Kondisi untuk memastikan data guide
PUT/BODY	user_id	Integer	Tidak	User ID pada akun pengguna di GoTravelly
PUT/BODY	guide_id	Integer	Tidak	Guide ID pada akun guide di GoTravelly

Method	Parameter	Tipe	Wajib	Keterangan
PUT/HEADER	key	String	Ya	Token code / key
PUT/BODY	action	String	Ya	Isi dengan `reprocess`
PUT/BODY	book_id	Integer	Ya	Book ID / ID pesanan tur di GoTravelly
PUT/BODY	is_guide	Boolean	Tidak	Kondisi untuk memastikan data guide
PUT/BODY	user_id	Integer	Tidak	User ID pada akun pengguna di GoTravelly
PUT/BODY	guide_id	Integer	Tidak	Guide ID pada akun guide di GoTravelly
PUT/BODY	lang	String	Tidak	Isi dengan `english`/`indonesian`

Method	Parameter	Tipe	Wajib	Keterangan
PUT/HEADER	key	String	Ya	Token code / key
PUT/BODY	action	String	Ya	Isi dengan `remind_tour_incoming`
PUT/BODY	book_id	Integer	Ya	Book ID / ID pesanan tur di GoTravelly
PUT/BODY	day	Integer	Ya	Jumlah hari saat pengingat tur akan berangkat

Method	Parameter	Tipe	Wajib	Keterangan
PUT/HEADER	key	String	Ya	Token code / key
PUT/BODY	action	String	Ya	Isi dengan `remind_complete_tour`
PUT/BODY	book_id	Integer	Ya	Book ID / ID pesanan tur di GoTravelly

Method	Parameter	Tipe	Wajib	Keterangan
PUT/HEADER	key	String	Ya	Token code / key
PUT/BODY	action	String	Ya	Isi dengan `remind_review_tour`
PUT/BODY	book_id	Integer	Ya	Book ID / ID pesanan tur di GoTravelly

PUT (Response)

    {
        "status": "OK",
        "message": "Data Tour Itinerary Anda berhasil disimpan",
    }

    {
        "status": "OK",
        "message": "Data Reservasi Anda berhasil disetujui",
        "guide_id": "999",
    }

    {
        "status": "OK",
        "message": "Data Reservasi Anda berhasil ditolak",
    }

    {
        "status": "OK",
        "message": "Success Auto Reject",
    }

    {
        "status": "OK",
        "message": "Anda telah berhasil melakukan pemrosesan ulang",
    }

    {
        "status": "OK",
        "message": "Success remind tour incoming",
    }

    {
        "status": "OK",
        "message": "Success remind complete tour",
    }

    {
        "status": "OK",
        "message": "Success remind complete tour",
    }