Create Task Async

post

https://integrationgateway.falconflex.ai/api/v1/tasks/init

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This API allows for creating a Task. Following are some additional details for some of the body parameters.

TransportType

In order to provide more flexibility, different tasks can be assigned to different modes of transport. The current supported transport type and their IDs are shown in the table below:

Transport Type	transportTypeId
No Preference	1
Bicycle	2
Bike	3
Car	4
Truck	5

Pickup / Delivery

The value for the pickup or delivery body parameters.

pickup / delivery
International Location, for example: `{ "Address": "Dummy", "Name": "Jhon Doe", "PhoneNumber": "+97400000000", "Latitude": 25.8871, "Longitude": 51.33455, "Notes": "vip" }`

Body Params

CheckDuplicates

boolean

Defaults to false

Raise an error when the same ClientGeneratedId was sent (Existing Order returned by default)

ClientGeneratedId

string

Optional Identifier. If you do not have an identifier for the Task, FalconFlex will generate one automatically upon Task creation

TransportTypeId

int32

required

Specifies the type of transport to be used for the task. For allowed values, refer to the table above.

AmountToBeCollected

double

required

Specifies the amount to be collected. A value = 0 sets the task's payment status as Paid. A value > 0 sets the payment status as Unpaid.

PickupByUtc

date

required

The timestamp by which the task has to be picked up. The AutoAssignment process starts <=15mins before this.

DeliverByUtc

string

The timestamp by which the task has to be delivered.

Pickup

object

required

This parameter provides the data for the pickup location of the Task. For allowed values, refer to the table above (Use JSON without stringification)

Delivery

object

required

This parameter provides the data for the delivery location of the Task. For allowed values, refer to the table above (Use JSON without stringification)

Notes

string

Defaults to null

Any notes to be displayed for the Task

SendTrackingMessage

boolean

Defaults to false

Whether a message with tracking link should be sent to the phone number mentioned on the Delivery address

IsProofOfDeliveryRequired

boolean

Defaults to false

Whether proof of delivery is required for the Task

IsProofOfPickupRequired

boolean

Whether proof of Pickup is required for the Task

TaskItems

array of objects

required

The list of items which are to be delivered

TaskItems*

UserMetaDataDtos

array of objects

Array of MetaData objects which you want to define for the Task

UserMetaDataDtos

SkillCriteria

object

Responses

TransportType

Pickup / Delivery

200200

401401

500500