| Name | Type | Description |
|---|---|---|
| api_key | string | You can generate a key from settings(Login>Menu>Settings>API Keys) in your tookan account. Or click here to get API key |
| merchant_id | string | This is the unique ID given to each merchant. Enter the ID of the merchant whose task you want to create. You can get it from dashboard Menu>More>Merchant |
| order_id | string | Your can pass this key as your own transaction number which can be used to identify tasks in tookan |
| job_description | String | The description of the task to be done |
| job_pickup_phone | string | The contact number of the person from whom the pickup should be collected |
| job_pickup_name | string (optional) | The email of the person from whom the pickup should be collected |
| job_pickup_email | string | The email of the person from whom the pickup should be collected |
| job_pickup_address | string | The address from which the pickup should be collected. |
| job_pickup_latitude | string (optional) | This is the latitiude of the pickup location |
| job_pickup_longitude | string (optional) | This is the longitude of the pickup location |
| job_pickup_datetime | string | This is time before which the pickup should be collected |
| has_pickup | boolean (Fixed) | For a Pickup task, this is fixed to 1 |
| has_delivery | boolean (Fixed) | For a Pickup task, this is fixed to 0 |
| layout_type | integer (Fixed) | For a Pickup task, this is fixed to 0 |
| tracking_link | boolean | If 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 |
| timezone | string | Timezone 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). |
| pickup_custom_field_template | string | This is the custom fields template name that is pre-defined in your workflow page in the admin account and you just need to replace space in template with underscore(_). |
| pickup_meta_data | json array | This 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.) |
| team_id | integer | This is the Unique id of every team. You can get it from the dashBoard. More>teams>respective id of the team will displayed. |
| auto_assignment | boolean | If 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. |
| fleet_id | string | This 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. |
| p_ref_images | Array | This is an array of strings containing links of images. |
| notify | integer | This is used to enable the notifications. |
| geofence | integer | This is used to enable the geofencing. |
| tags | string | This is a string containing comma separated tags as filters for agents in auto assignment |
This API is used to create a Delivery Task for merchant. Request Body Parameters :
| Name | Type | Description |
|---|---|---|
| api_key | string | You can generate a key from settings(Login>Menu>Settings>API Keys) in your tookan account. Or click here to get API key |
| merchant_id | string | This is the unique ID given to each merchant. Enter the ID of the merchant whose task you want to create. You can get it from dashboard Menu>More>Merchant |
| order_id | string | Your can pass this key as your own transaction number which can be used to identify tasks in tookan |
| job_description | String | The description of the task to be done |
| job_pickup_phone | string | The contact number of the person from whom the pickup should be collected |
| customer_email | email(optional) | This is email of the customer to whom the product should be delivered |
| customer_username | string(optional) | This is the name of the customer to whom the product should be delivered |
| customer_username | string(optional) | This is the name of the customer to whom the product should be delivered |
| customer_phone | string | This is the contact number of the customer to whom the product should be delivered |
| customer_address | string | This is the address of the customer to whom the product should be delivered |
| latitude | string (optional) | This is the latitiude of the pickup location if you have it. Otherwise leave it blank. We will get it through geocoding API |
| longitude | string (optional) | This is the latitiude of the pickup location if you have it. Otherwise leave it blank. We will get it through geocoding API |
| job_delivery_datetime | Date/String | This is time before which the product should be delivered |
| has_pickup | boolean (Fixed) | For a Pickup task, this is fixed to 1 |
| has_delivery | boolean (Fixed) | For a Pickup task, this is fixed to 0 |
| layout_type | integer (Fixed) | For a Pickup task, this is fixed to 0 |
| tracking_link | boolean | If 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 |
| timezone | string | Timezone 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). |
| pickup_custom_field_template | string | This is the custom fields template name that is pre-defined in your workflow page in the admin account and you just need to replace space in template with underscore(_). |
| pickup_meta_data | json array | This 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.) |
| team_id | integer | This is the Unique id of every team. You can get it from the dashBoard. More>teams>respective id of the team will displayed. |
| auto_assignment | boolean | If 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. |
| fleet_id | string | This 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. |
| p_ref_images | Array | This is an array of strings containing links of images. |
| notify | integer | This is used to enable the notifications. |
| geofence | integer | This is used to enable the geofencing. |
| tags | string | This is a string containing comma separated tags as filters for agents in auto assignment |
This API is used to create a pickup and Delivery Task for merchant. Request Body Parameters :
| Name | Type | Description |
|---|---|---|
| api_key | string | You can generate a key from settings(Login>Menu>Settings>API Keys) in your tookan account. Or click here to get API key |
| merchant_id | string | This is the unique ID given to each merchant. Enter the ID of the merchant whose task you want to create. You can get it from dashboard Menu>More>Merchant |
| order_id | string | Your can pass this key as your own transaction number which can be used to identify tasks in tookan |
| job_description | String | The description of the task to be done |
| job_pickup_phone | string | The contact number of the person from whom the pickup should be collected |
| job_pickup_name | string (optional) | The email of the person from whom the pickup should be collected |
| job_pickup_email | string | The email of the person from whom the pickup should be collected |
| job_pickup_address | string | The address from which the pickup should be collected. |
| job_pickup_latitude | string (optional) | This is the latitiude of the pickup location |
| job_pickup_longitude | string (optional) | This is the longitude of the pickup location |
| job_pickup_datetime | string | This is time before which the pickup should be collected |
| customer_email | email(optional) | This is email of the customer to whom the product should be delivered |
| customer_username | string(optional) | This is the name of the customer to whom the product should be delivered |
| customer_username | string(optional) | This is the name of the customer to whom the product should be delivered |
| customer_phone | string | This is the contact number of the customer to whom the product should be delivered |
| customer_address | string | This is the address of the customer to whom the product should be delivered |
| latitude | string (optional) | This is the latitiude of the pickup location if you have it. Otherwise leave it blank. We will get it through geocoding API |
| longitude | string (optional) | This is the latitiude of the pickup location if you have it. Otherwise leave it blank. We will get it through geocoding API |
| job_delivery_datetime | Date/String | This is time before which the product should be delivered |
| has_pickup | boolean (Fixed) | For a Pickup task, this is fixed to 1 |
| has_delivery | boolean (Fixed) | For a Pickup task, this is fixed to 0 |
| layout_type | integer (Fixed) | For a Pickup task, this is fixed to 0 |
| tracking_link | boolean | If 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 |
| timezone | string | Timezone 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). |
| pickup_custom_field_template | string | This is the custom fields template name that is pre-defined in your workflow page in the admin account and you just need to replace space in template with underscore(_). |
| pickup_meta_data | json array | This 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.) |
| meta_data | JSON array | This 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.) |
| auto_assignment | boolean | If 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. |
| fleet_id | string | This 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. |
| p_ref_images | Array | This is an array of strings containing links of images. |
| notify | integer | This is used to enable the notifications. |
| geofence | integer | This is used to enable the geofencing. |
| tags | string | This is a string containing comma separated tags as filters for agents in auto assignment |
| ride_type | number | 0 for Non-Pool Task, 1 for Pool Task. |
This API is used to create a appointment Task for merchant. Request Body Parameters :
| Name | Type | Description |
|---|---|---|
| api_key | string | You can generate a key from settings(Login>Menu>Settings>API Keys) in your tookan account. Or click here to get API key |
| merchant_id | string | This is the unique ID given to each merchant. Enter the ID of the merchant whose task you want to create. You can get it from dashboard Menu>More>Merchant |
| order_id | string | Your can pass this key as your own transaction number which can be used to identify tasks in tookan |
| customer_email | email(optional) | This is email of the customer to whom the product should be delivered |
| customer_username | string(optional) | This is the name of the customer to whom the product should be delivered |
| customer_username | string(optional) | This is the name of the customer to whom the product should be delivered |
| customer_phone | string | This is the contact number of the customer to whom the product should be delivered |
| customer_address | string | This is the address of the customer to whom the product should be delivered |
| latitude | string (optional) | This is the latitiude of the pickup location if you have it. Otherwise leave it blank. We will get it through geocoding API |
| longitude | string (optional) | This is the latitiude of the pickup location if you have it. Otherwise leave it blank. We will get it through geocoding API |
| job_pickup_datetime | Date/String | This is the start time of the appointment. |
| job_delivery_datetime | Date/String | This is time before which the product should be delivered |
| timezone | string | Timezone 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). |
| has_pickup | boolean (Fixed) | For a Pickup task, this is fixed to 1 |
| has_delivery | boolean (Fixed) | For a Pickup task, this is fixed to 0 |
| layout_type | integer (Fixed) | For a Pickup task, this is fixed to 0 |
| tracking_link | boolean | If 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 |
| custom_field_template | string | This is the custom fields template name that is pre-defined in your workflow page in the admin account and you just need to replace space in template with underscore(_). |
| meta_data | json array | This 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.) |
| team_id | integer | This is the Unique id of every team. You can get it from the dashBoard. More>teams>respective id of the team will displayed. |
| auto_assignment | boolean | If 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. |
| fleet_id | string | This 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. |
| ref_images | Array | This is an array of strings containing links of images. |
| notify | integer | This is used to enable the notifications. |
| geofence | integer | This is used to enable the geofencing. |
| tags | string | This is a string containing comma separated tags as filters for agents in auto assignment |