{"_id":"5951d7499213000015b57f69","project":"56f962d8d522d81700600280","version":{"_id":"56f962d8d522d81700600283","hasDoc":true,"__v":5,"hasReference":true,"project":"56f962d8d522d81700600280","createdAt":"2016-03-28T16:59:04.166Z","releaseDate":"2016-03-28T16:59:04.166Z","categories":["56f962d8d522d81700600284","5951d5489435c30015923d54","5951d6de50727a00155053c6","5951d99224e2f70015dec6c6","5951e40ef5c137001533814b"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5951d6de50727a00155053c6","project":"56f962d8d522d81700600280","version":"56f962d8d522d81700600283","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-06-27T03:54:06.338Z","from_sync":false,"order":2,"slug":"reference","title":"Run API"},"user":"57736a020a6d610e00dea1fd","githubsync":"","__v":6,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-06-27T03:55:53.222Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[{"code":"{\n  \"awb\":\"1234567890\",\n  \"details\":\"Deliver this package\",\n  \"address\": {\n    \"address\":\"Street 4 - Dubai - United Arab Emirates\",\n    \"city\":\"Dubai\",\n    \"area\": \"Discovery Gardens\",\n    \"country\": \"AE\",\n    \"streetNumber\":\"4\",\n    \"streetName\": \"Street 4\",\n    \"lat\": 25.0445575,\n    \"lng\": 55.1418511\n  },\n  \"customer\": {\n    \"name\": \"Customer 01\",\n    \"phone\": \"+971501234567\"\n  },\n  \"pickupTask\": true,\n  \"totalPrice\": 100,\n  \"paymentTypeId\": 1,\n  \"completeAfter\":\"2017-12-16 09:00:00\",\n  \"completeBefore\":\"2017-12-17 09:00:00\"\n}","language":"json","name":"Json Request :"}]},"method":"post","auth":"required","params":[{"_id":"5951d78b0fd2f8001b7b5933","ref":"","in":"body","required":true,"desc":"Awb for the task.","default":"","type":"string","name":"awb"},{"_id":"5951d7d89213000015b57f6a","ref":"","in":"body","required":true,"desc":"Whether the task is a pickup task.","default":"","type":"boolean","name":"pickupTask"},{"_id":"595208cb291f9a001b6e9a60","ref":"","in":"body","required":true,"desc":"Details for the task.","default":"","type":"string","name":"details"},{"_id":"595208cb291f9a001b6e9a5e","ref":"","in":"body","required":true,"desc":"The total amount that the customer must pay for this task.","default":"","type":"int","name":"totalPrice"},{"_id":"595208cb291f9a001b6e9a5d","ref":"","in":"body","required":true,"desc":"Whether the orders are paid by card or credit card. 1: card 2: credit card","default":"","type":"int","name":"paymentTypeId"},{"_id":"595208cb291f9a001b6e9a5c","ref":"","in":"body","required":false,"desc":"The Task must be completed after this time.","default":"","type":"string","name":"completeAfter"},{"_id":"595208cb291f9a001b6e9a5b","ref":"","in":"body","required":false,"desc":"The Task must be completed before this time.","default":"","type":"string","name":"completeBefore"},{"_id":"5951d78b0fd2f8001b7b5932","ref":"","in":"body","required":false,"desc":"The task's address. Contain the information such as: address, city, area, country, streetNumber, streetName, lat, lng.","default":"","type":"object","name":"address"},{"_id":"595208cb291f9a001b6e9a5f","ref":"","in":"body","required":false,"desc":"The task's customer. Contain the in formation such as: name, phone.","default":"","type":"object","name":"customer"},{"_id":"5951d83c50727a00155053c7","ref":"","in":"header","required":true,"desc":"Authentication Key","default":"","type":"string","name":"Authorization"}],"url":"/api/v1/tasks"},"isReference":false,"order":14,"body":"","excerpt":"","slug":"create-task-1","type":"endpoint","title":"Create Task"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

awb:
required
string
Awb for the task.
pickupTask:
required
boolean
Whether the task is a pickup task.
details:
required
string
Details for the task.
totalPrice:
required
integer
The total amount that the customer must pay for this task.
paymentTypeId:
required
integer
Whether the orders are paid by card or credit card. 1: card 2: credit card
completeAfter:
string
The Task must be completed after this time.
completeBefore:
string
The Task must be completed before this time.
address:
object
The task's address. Contain the information such as: address, city, area, country, streetNumber, streetName, lat, lng.
customer:
object
The task's customer. Contain the in formation such as: name, phone.

Headers

Authorization:
required
string
Authentication Key

Examples


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}