tookan v1.3.1

Tookan

Tookan, this project is to intract the application with tookan API's this lib us using v2 of tookan to intagrate with you can find the API on following link https://tookanapi.docs.apiary.io

Config the tookan library

Set the environment variable where we keep the tookan key and the tookan user id

save our tookan key with this env variable

tookan_key

the user id you can get it in your tookan login

tookan_userid

Install

npm i tookan

Initialization

A simple example to create client

let Tookan_help = require("tookan");

All Functions

Get all agents available

just call this method to get the available agents in our tookan

tookan_res = await Tookan_help.get_agents()

Create a Delivery Task

Create a payload as follows

 let payload = {
        order_id: "1582325102",
        job_description: "Its a delivery order for testing the tookan delivery network",
        job_delivery_phone: "19999999999",
        job_delivery_datetime: "09/01/2018 19:00:01",
        job_delivery_address: "Big Streeet, North Earth, Galaxy unknown",
        customer_username: "Mark",
        customer_email: "mark@unknown.com",
    } 

And send this payload to a tookan

tookan_res = await Tookan_help.create_delivery(payload)

Create a Pickup Task

Create a payload as follows

  let payload_pickup = {
        order_id: "1582325101",
        job_description: 'Its a delivery order for testing the tookan delivery network',
        job_pickup_phone: "19999999999",
        job_pickup_datetime: "09/01/2018 19:00:01",
        job_pickup_address: "Big Streeet, North Earth, Galaxy unknown",
        job_pickup_name:  "Mark",
        job_pickup_email: "mark@unknown.com",
    } 

And send this payload to a tookan

tookan_res = await Tookan_help.create_pickup(payload)

Check the task by its job id

Create a payload as follows

let payload = {
        'job_id':"61112352",
    } 

And send this payload to a tookan

tookan_res = await Tookan_help.check_task(payload)

Check the task by its order_id

Create a payload as follows

let payload = {
        'order_id':"1582325102",
    } 

And send this payload to a tookan

tookan_res = await Tookan_help.check_task_by_orderid(payload)

Delete any task either Pickup/Devlivery

Create a payload as follows

let payload = {
        'job_id':"61112352",
    } 

And send this payload to a tookan

tookan_res = await Tookan_help.rm_task(payload)

Edit delivery task

This api used to edit a task that has already been added. Request Body Parameters : Every parameter is same as while creating a task the only parameter that should added while editing a task is job_id which required to identify the task.

Create a Payload as follows

let payload = {
        "job_id":"1582325102",
        "job_delivery_phone": "19999999999",
        "job_delivery_address": "Big Streeet, North Earth, Galaxy unknown",
        "customer_email":"john@example.com",
        "customer_username":"John Doe",
        "customer_phone":"+919999999999",
        "latitude":"28.5494489",
        "longitude":"77.2001368",
        "job_description":"Beauty services",
        "job_delivery_datetime":"2016-09-30 17:00:00",
        "notify": 1
    } 

And send this payload to a tookan

tookan_res = await Tookan_help.edit_delivery_task(payload)

Edit pickup task

This api used to edit a task that has already been added. Request Body Parameters : Every parameter is same as while creating a task the only parameter that should added while editing a task is job_id which required to identify the task.

Create a Payload as follows

let payload = {
        "job_id":"1582325102",
        "job_description":"Beauty services",
        "job_pickup_phone": "19999999999",
        "job_pickup_datetime":"2016-09-30 16:00:00",
        "job_pickup_address": "Big Streeet, North Earth, Galaxy unknown",
        "job_pickup_name":  "Mark",
        "job_pickup_email": "mark@unknown.com",
        "notify": 1
        "auto_assignment":1
        "job_pickup_latitude":"28.5494489",
        "job_pickup_longitude":"77.2001368",
}

And send this payload to a tookan

tookan_res = await Tookan_help.edit_pickup_task(payload)