• Installs:
  • Today: 17
  • All Time: 3689
Developer:uservolodimir.kudriachenko

Tookan API Package

Manage deliveries and a mobile workforce in real time.

List of Endpoints
This is the list of endpoints this API includes. To add any of the endpoints to your app, please click on “Connect to endpoint” text.
See All
Discussions
See All
Readme

Tookan

Tookan Package

Simple, Powerful & Effective way to manage your delivery process.

  • Domain: Tookan
  • Credentials: apiKey

How to get credentials:

  1. Login to your Tookan account
  2. Go to Menu > More > API Key
  3. In V2 API KEYS section click on Generate Key button.

Custom datatypes:

DatatypeDescriptionExample
DatepickerString which includes date and time2016-05-28 00:00:00
MapString which includes latitude and longitude coma separated50.37, 26.56
ListSimple array["123", "sample"]
SelectString with predefined valuessample
ArrayArray of objects[{"Second name":"123","Age":"12","Photo":"sdf","Draft":"sdfsdf"},{"name":"adi","Second name":"bla","Age":"4","Photo":"asfserwe","Draft":"sdfsdf"}]

pickupMetadata field example:

"pickupMetadata": [
  {
   "label": "Price",
   "data": "100"
  },
  {
   "label": "Price",
   "data": "100"
  }
]

refImages field example:

"pRefImages": [
  "http://tookanapp.com/wp-content/uploads/2015/11/logo_dark.png",
  "http://tookanapp.com/wp-content/uploads/2015/11/logo_dark.png"
]

Tookan.createPickupTask

This API is used to create a Pickup Task.

FieldTypeDescription
apiKeycredentialsYou can get a key from settings(Login>Menu>More>API Key) in your tookan account.
orderIdStringYour can pass this key as your own transaction number which can be used to identify tasks in tookan
jobDescriptionStringThe description of the task to be done
jobPickupPhoneStringThe contact number of the person from whom the pickup should be collected
jobPickupNameStringThe name of the person from whom the pickup should be collected
jobPickupEmailStringThe email of the person from whom the pickup should be collected
jobPickupAddressStringThe address from which the pickup should be collected
jobPickupCoordinateMapThis is the latitiude and longitude coma separated of the pickup location
jobPickupDatetimeDatePickerThis is time before which the pickup should be collected
trackingLinkStringIf this value is 1 it will return a url in the response where the driver's movement can be tracked.if not no url will be returned
timezoneStringTimezone difference with UTC in minutes for e.g., For PST:+480 (PDT: +420),For MST +420 (MDT:+360) for EST: +300(EDT:+240), for AEST: -600 (AEDT: -660), for IST: -330, for CST: +360 (CDT:+300)
pickupCustomFieldTemplateStringThis is the custom fields template name that is pre-defined in your workflow page in the admin account
pickupMetadataListThis is array of object containing label and data where label defines the custom field name and data will be his value.(Provided label should be in specified template.)
teamIdStringThis is the Unique id of every team. You can get it from the dashBoard. More>teams>respective id of the team will displayed.
autoAssignmentBooleanIf this value is 1 The task will be auto assigned to the members of the specific team mentioned. or if this value is 0 it will be unassigned task created.
fleetIdStringThis is unique agent id given to each agent, if given the task will be assigned to the respective agent. You can get it from dashboard Menu>More>agents.
pRefImagesListThis is an array of strings containing links of images.
notifyNumberThis is used to enable the notifications.
geofenceNumberThis is used to enable the geofencing.
tagsListThis is an array of tags as filters for agents in auto assignment.

Tookan.createDeliveryTask

This API is used to create a Delivery Task.

FieldTypeDescription
apiKeycredentialsYou can get a key from settings(Login>Menu>More>API Key) in your tookan account.
orderIdStringYour can pass this key as your own transaction number which can be used to identify tasks in tookan
jobDescriptionStringThe description of the task to be done
jobPickupPhoneStringThe contact number of the person from whom the pickup should be collected
customerEmailStringThis is email of the customer to whom the product should be delivered
customerUsernameStringThis is the name of the customer to whom the product should be delivered
customerPhoneStringThis is the contact number of the customer to whom the product should be delivered
customerAddressStringThis is the address of the customer to whom the product should be delivered
coordinateMapThis is the latitude and longitude coma separated of the pickup location if you have it. Otherwise leave it blank. We will get it through geocoding API
jobDeliveryDatetimeDatePickerThis is time before which the product should be delivered
trackingLinkBooleanIf this value is 1 it will return a url in the respone where the driver's movement can be tracked.
timezoneStringTimezone difference with UTC in minutes for e.g., For PST:+480 (PDT: +420),For MST +420 (MDT:+360) for EST: +300(EDT:+240), for AEST: -600 (AEDT: -660), for IST: -330
metadataListThis is array of object containing label and data where label defines the custom field name and data will be his value.(Provided label should be in specified template.)
teamIdStringThis is the Unique id of every team. You can get it from the dashBoard. More>teams>respective id of the team will displayed.
autoAssignmentStringIf this value is 1. The task will be auto assigned to the members of the specific team mentioned. or if this value is 0 it will be unassigned task created.
fleetIdStringThis is unique agent id given to each agent, if given the task will be assigned to the respective agent. You can get it from dashboard Menu>More>agents.
refImagesListThis is an array of strings containing links of images
notifyNumberThis is used to enable the notifications
geofenceNumberThis is used to enable the geofencing
tagsListThis is an array of tags as filters for agents in auto assignment

Tookan.createPickupAndDeliveryTask

This api is used to create Pickup and delivery task.

FieldTypeDescription
apiKeycredentialsYou can get a key from settings(Login>Menu>More>API Key) in your tookan account.
orderIdStringYour can pass this key as your own transaction number which can be used to identify tasks in tookan
teamIdNumberThis is the Unique id of every team. You can get it from the dashBoard. More>teams>respective id of the team will displayed
autoAssignmentStringIf this value is 1. The task will be auto assigned to the members of the specific team mentioned. or if this value is 0 it will be unassigned task created.
jobDescriptionStringThe description of the task to be done
jobPickupPhoneStringThe contact number of the person from whom the pickup should be collected
jobPickupNameStringThe name of the person from whom the pickup should be collected
jobPickupEmailStringThe email of the person from whom the pickup should be collected
jobPickupAddressStringThe address from which the pickup should be collected
jobPickupAddressStringThe address from which the pickup should be collected
jobPickupDatetimeDatePickerThis is time before which the pickup should be collected
pickupMetadataListThis is array of object containing label and data where label defines the custom field name and data will be his value.(Provided label should be in specified template.)
customerEmailStringThis is email of the customer to whom the product should be delivered
customerUsernameStringThis is the name of the customer to whom the product should be delivered
customerPhoneStringThis is the contact number of the customer to whom the product should be delivered
customerAddressStringThis is the address of the customer to whom the product should be delivered
coordinateMapThis is the latitude and longitude coma separated of the delivery location
jobDeliveryDatetimeDatePickerThis is time before which the product should be delivered
customFieldTemplateStringThis is the custom fields template name that is pre-defined in your workflow page in the admin account
metadataListThis is array of object containing label and data where label defines the custom field name and data will be his value.(Provided label should be in specified template.)
timezoneNumberTimezone difference with UTC in minutes for e.g., For PST:+480 (PDT: +420),For MST +420 (MDT:+360) for EST: +300(EDT:+240), for AEST: -600 (AEDT: -660), for IST: -330
trackingLinkStringIf this value is 1 it will return a url in the respone where the driver's movement can be tracked.
fleetIdStringThis is unique agent id given to each agent, if given the task will be assigned to the respective agent. You can get it from dashboard Menu>More>agents.
pRefImagesList(Pickup) This is an array of strings containing links of images.
refImagesList(Delivery) This is an array of strings containing links of images.
notifyNumberThis is used to enable the notifications
geofenceNumberThis is used to enable the geofencing.
tagsListThis is an array of tags as filters for agents in auto assignment.

Tookan.createAppointmentTask

This api is used to create an appointment task.

FieldTypeDescription
apiKeycredentialsYou can get a key from settings(Login>Menu>More>API Key) in your tookan account.
orderIdStringYour can pass this key as your own transaction number which can be used to identify tasks in tookan
teamIdStringThis is the Unique id of every team. You can get it from the dashBoard. More>teams>respective id of the team will displayed.
autoAssignmentStringIf this value is 1 the task will be auto assigned to the members of the specific team mentioned. or if this value is 0 it will be unassigned task created.
jobDescriptionStringThe description of the task to be done
jobPickupPhoneStringThe contact number of the person from whom the pickup should be collected
jobPickupNameStringThe name of the person from whom the pickup should be collected
jobPickupEmailStringThe email of the person from whom the pickup should be collected
jobPickupAddressStringThe address from which the pickup should be collected.
jobPickupCoordinateMapThis is the latitiude and longitude coma separated of the pickup location
jobPickupDatetimeDatePickerThis is time before which the pickup should be collected
pickupCustomFieldTemplateStringThis is the custom fields template name that is pre-defined in your workflow page in the admin account
pickupMetadataListThis is array of object containing label and data where label defines the custom field name and data will be his value.(Provided label should be in specified template.)
customerEmailStringThis is email of the customer to whom the product should be delivered
customerUsernameStringThis is the name of the customer to whom the product should be delivered
customerPhoneStringThis is the contact number of the customer to whom the product should be delivered
customerAddressStringThis is the address of the customer to whom the product should be delivered
coordinateMapThis is the latitiude and longitude coma separated of the delivery location
jobDeliveryDatetimeDatePickerThis is time before which the product should be delivered
customFieldTemplateStringThis is the custom fields template name that is pre-defined in your workflow page in the admin account.
metadataListThis is array of object containing label and data where label defines the custom field name and data will be his value.(Provided label should be in specified template.)
timezoneNumberTimezone difference with UTC in minutes for e.g., For PST:+480 (PDT: +420),For MST +420 (MDT:+360) for EST: +300(EDT:+240), for AEST: -600 (AEDT: -660), for IST: -330
trackingLinkStringIf this value is 1 it will return a url in the respone where the driver's movement can be tracked.
fleetIdStringThis is unique agent id given to each agent, if given the task will be assigned to the respective agent. You can get it from dashboard Menu>More>agents.
pRefImagesList(Pickup) This is an array of strings containing links of images.
refImagesList(Delivery) This is an array of strings containing links of images.
notifyStringThis is used to enable the notifications.
geofenceStringThis is used to enable the geofencing.
tagsListThis is an array of tags as filters for agents in auto assignment.

Tookan.updateTask

This api used to edit a task that has already been added.

FieldTypeDescription
apiKeycredentialsYou can get a key from settings(Login>Menu>More>API Key) in your tookan account.
jobIdStringThis is the unique id given to every job which is returned while creating a task
orderIdStringYour can pass this key as your own transaction number which can be used to identify tasks in tookan
hasPickupStringSet 0 for delivery task or 1 for pickup task.
hasDeliveryStringSet 1 for delivery task or 0 for pickup task.
layoutTypeStringFor an appointment task this value is fixed to 1 else set to 0.
jobDescriptionStringThe description of the task to be done
jobPickupPhoneStringThe contact number of the person from whom the pickup should be collected
jobPickupNameStringThe name of the person from whom the pickup should be collected
jobPickupEmailStringThe email of the person from whom the pickup should be collected
jobPickupAddressStringThe address from which the pickup should be collected
jobPickupCoordinateMapThis is the latitude and longitude coma separated of the pickup location
jobPickupDatetimeDatePickerThis is time before which the pickup should be collected
trackingLinkStringIf this value is 1 it will return a url in the response where the driver's movement can be tracked.if not no url will be returned
timezoneStringTimezone difference with UTC in minutes for e.g., For PST:+480 (PDT: +420),For MST +420 (MDT:+360) for EST: +300(EDT:+240), for AEST: -600 (AEDT: -660), for IST: -330, for CST: +360 (CDT:+300)
pickupCustomFieldTemplateStringThis is the custom fields template name that is pre-defined in your workflow page in the admin account
pickupMetadataListThis is array of object containing label and data where label defines the custom field name and data will be his value.(Provided label should be in specified template.)
teamIdStringThis is the Unique id of every team. You can get it from the dashBoard. More>teams>respective id of the team will displayed.
autoAssignmentBooleanIf this value is 1 The task will be auto assigned to the members of the specific team mentioned. or if this value is 0 it will be unassigned task created.
fleetIdStringThis is unique agent id given to each agent, if given the task will be assigned to the respective agent. You can get it from dashboard Menu>More>agents.
pRefImagesListThis is an array of strings containing links of images.
notifyNumberThis is used to enable the notifications.
geofenceNumberThis is used to enable the geofencing.
tagsListThis is an array of tags as filters for agents in auto assignment.
customerEmailStringThis is email of the customer to whom the product should be delivered
customerUsernameStringThis is the name of the customer to whom the product should be delivered
customerPhoneStringThis is the contact number of the customer to whom the product should be delivered
customerAddressStringThis is the address of the customer to whom the product should be delivered
coordinateMapThis is the latitude and longitude of the pickup location if you have it. Otherwise leave it blank. We will get it through geocoding API
jobDeliveryDatetimeDatePickerThis is time before which the product should be delivered
metadataListThis is array of object containing label and data where label defines the custom field name and data will be his value.(Provided label should be in specified template.)
refImagesListThis is an array of strings containing links of images
customFieldTemplateStringThis is the custom fields template name that is pre-defined in your workflow page in the admin account

Tookan.getTask

This api is used to get the details of the task.

FieldTypeDescription
apiKeycredentialsYou can get a key from settings(Login>Menu>More>API Key) in your tookan account.
jobIdNumberYou can get it from task details.
userIdNumberYou can get it from account details page in Tookan dashboard.

Tookan.getTaskFromOrderID

This endpoint is used to get the details of the task by order ID.

FieldTypeDescription
apiKeycredentialsYou can get a key from settings(Login>Menu>More>API Key) in your tookan account.
orderIdStringThis will be set by you.
userIdStringYou can get it from account details page in Tookan dashboard.

Tookan.deleteTask

This API is used to Delete a task which is not necessary.

FieldTypeDescription
apiKeycredentialsYou can get a key from settings(Login>Menu>More>API Key) in your tookan account.
jobIdStringYou can get it from task details.

Tookan.updateTaskStatus

This API is used to force update the status of a task.

FieldTypeDescription
apiKeycredentialsYou can get a key from settings(Login>Menu>More>API Key) in your tookan account.
jobIdStringSingle or comma separated values. You can get it from task details.
jobStatusNumberRefer status codes section above for various statuses available.

Tookan.assignTask

This API is used to assign/reassign a unassigned/assigned task or an assigned task to Agent.

FieldTypeDescription
apiKeycredentialsYou can get a key from settings(Login>Menu>More>API Key) in your tookan account.
jobIdStringYou can get it from task details
fleetIdStringYou can get it from your tookan account or you can use 'Get All Agents' API for retrieving list from your account.
teamIdStringYou can get it from your tookan account in teams section.

Tookan.getAllTasks

This API is used to get all the tasks as per the get all the tasks data as per the filters

FieldTypeDescription
apiKeycredentialsYou can get a key from settings(Login>Menu>More>API Key) in your tookan account.
jobStatusNumberFilter the list of tasks via their status
jobTypeSelectFilter via Job Type - 0 for Pick Up, 1 for Delivery, 2 for Appointment and 3 for FOS
startDateDatepickerStart Date for the date range
endDateDatepickerEnd Date for the date range
customFieldsNumberYou can pass this flag as 1, if you want the custom fields data to be included in the response. default is 0
isPaginationNumberYou can set this as 1 to enable pagination
requestedPageNumberCurrent(Which) page according to the page number of tasks in the filter
customerUsernameStringFilter the list based on the customer name.
customerPhoneStringFilter the list based on the customer phone number.

Tookan.getAgents

This endpoint is used to get all the Agents/drivers/fleets information with respect to a location.

FieldTypeDescription
apiKeycredentialsYou can get a key from settings(Login>Menu>More>API Key) in your tookan account.
teamIdStringTeam ID
tagsListYou can pass the tags, comma separated, if you want to filter the list of agents via tags.
fleetIdStringYou can pass on the fleetId to get the data of a single fleet.
coordinateMapYou can pass lat long values to get the distance between agent location and this location pointed by the lat long values.
geofenceStringThis is used to enable the geofencing filter w.r.t to the lat long values

Tookan.addAgent

This API is used to register a new Agent in your account.

FieldTypeDescription
apiKeycredentialsYou can get a key from settings(Login>Menu>More>API Key) in your tookan account.
emailStringEmail of your agent
phoneStringAdd the phone number of the agent. He will get a notification with the links and credentials to download the app
transportTypeSelectSend 1 for Car, 2 for Motor Cycle, 3 for Bicycle, 4 for Scooter, 5 for Foot, 6 for Truck
transportDescStringTransport description.
licenseStringLicense
colorStringColor
timezoneStringTimezone difference with UTC in minutes for e.g., For PST:+480 (PDT: +420),For MST +420 (MDT:+360) for EST: +300(EDT:+240), for AEST: -600 (AEDT: -660), for IST: -330, for CST: +360 (CDT:+300)
teamIdStringYou need to pass a team of which the agent will be a part of. Team Ids are visible on the All teams page
passwordStringYou can set the password yourself, or leave it empty, in which case the system will auto-generate the password
usernameStringUnique username, which the agent will use to login to the Tookan Agent App
firstNameStringThis is the First name of the manager to be added.
lastNameStringThis is the Last name of the manager to be added.

Tookan.createTeam

This API is used to create a team

FieldTypeDescription
apiKeycredentialsYou can get a key from settings(Login>Menu>More>API Key) in your tookan account.
teamNameStringThis is the name of the team to be created.
batteryUsageStringThis is parameter decides the battery usage and accuracy level of agent's mobile.If '0' it is low,if '1' it is Medium, '2' It is High.
tagsListThis is tags that you can mention for any team.

Tookan.getTeams

This API is used to get the all the team details along with their agents' data

FieldTypeDescription
apiKeycredentialsYou can get a key from settings(Login>Menu>More>API Key) in your tookan account.

Tookan.createManager

This API is used to Create a Manager.

FieldTypeDescription
apiKeycredentialsYou can get a key from settings(Login>Menu>More>API Key) in your tookan account.
emailStringThis is email of the manager to be added which is used while Login.
passwordStringThis is the password for the manager account to login.
firstNameStringThis is the First name of the manager to be added.
lastNameStringThis is the Last name of the manager to be added.
phoneStringThis is the phone number of the manager to be added.
timezoneStringTimezone difference with UTC in minutes for e.g., For PST:+480 (PDT: +420),For MST +420 (MDT:+360) for EST: +300(EDT:+240), for AEST: -600 (AEDT: -660), for IST: -330, for CST: +360 (CDT:+300)
taskAccessStringThis is to give access for the unasigned tasks. Set this to '1' to give access and '0' not to give the access
addDriverAccessStringThis is to give access for the manager to create Agents. Set this to '1' to give access and '0' not to give the access
dispatcherTeamsListPass the team_ids in this parameter with comma seperated values to which the manager can access.

Tookan.getCustomer

This API is used to get the all the Customer details.

FieldTypeDescription
apiKeycredentialsYou can get a key from settings(Login>Menu>More>API Key) in your tookan account.
isPaginationStringYou can set this as 1 to enable pagination
requestedPageStringCurrent(Which) page according to the page number of tasks in the filter
x
circle
Tookan
$ / m
We will charge your card every month for the plan amount, as well as any overages incurred in the previous month.
?

Oops, we are missing some details

Looks like there are a few missing details that you haven't filled in yet.
These details are important and will help us protect you and let you know about anything new.

x

Why sign up to RapidAPI?

  • integrate
    Integrate APIs into your app
    Ruby, Java, Elixir, Node.js, Phyton, Objective C, Swift, PHP and MORE
  • keys
    Save all API keys in one place
  • notifications
    Get notifications about API changes
  • stats
    Get stats and monitor API connections
__SING_UP_WITH_GITHUB__
__SING_UP_WITH_FACEBOOK__
__SING_UP_WITH_GOOGLE__
  • We're not going to post anything on your wall.
  • We're not planning to spam you.
  • esccloses this view
    x

    Authentication

    Authenticate
    esccloses this view