TaskRabbit
App · 8 actions
Read and quote Taskrabbit Delivery orders, book deliveries and create routes.
Actions
| Action | What it does |
|---|---|
| Book quote | Book quote. |
| Cancel delivery | Cancel a delivery with a reason and comment. |
| Create delivery | Create a delivery with the approved partner store, items, addresses and time windows. |
| Create quote | Calculate a delivery quote using the approved partner store, delivery items, addresses and time windows. |
| Create route | Create route. |
| Get delivery | Get delivery. |
| Get partner | Get partner. |
| Get quote | Get quote. |
Book quote
Book quote.
Inputs
- Id
idtextRequired - Unique identifier of a delivery quote
- Clientid
clientidtext - The partner-provided clientid; leave empty unless your partner setup requires this header.
- Partnerid
partneridtext - The partner-provided partnerid; leave empty unless your partner setup requires this header.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Cancel delivery
Cancel a delivery with a reason and comment. Cancellation fees may apply.
Inputs
- Delivery id
delivery_idtextRequired - Delivery id.
- Cancel reason
cancel_reasontextRequired - Cancel reason.One of:
COLD_CHAIN_VIOLATION,ORDER_NOT_READY,SYSTEM_ERROR,DELIVERY_TIME_CHANGED,FRAUD_ORDER,CARRIER_CANCELLED,CAB_NOT_ARRIVED,OTHER. - Comment
commenttextRequired - Comment.
Outputs
dataobject- Cancellation response.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Create delivery
Create a delivery with the approved partner store, items, addresses and time windows. Live deliveries can incur charges.
Inputs
- Client id
client_idtextRequired - Client id.
- External delivery id
external_delivery_idtextRequired - External delivery id.
- External order id
external_order_idtextRequired - External order id.
- External store id
external_store_idtextRequired - External store id.
- Pickup start
pickup_startdate and timeRequired - Pickup start.
- Pickup end
pickup_enddate and timeRequired - Pickup end.
- Delivery start
delivery_startdate and timeRequired - Delivery start.
- Delivery end
delivery_enddate and timeRequired - Delivery end.
- Contains alcohol
contains_alcoholtrue/falseRequired - Contains alcohol.
- Autonomous delivery
autonomous_deliverytrue/falseRequired - Autonomous delivery.
- Pickup street
pickup_streettextRequired - Pickup street.
- Pickup street line 2
pickup_street_line_2text - Pickup street line 2.
- Pickup city
pickup_citytextRequired - Pickup city.
- Pickup state
pickup_statetextRequired - Pickup state.
- Pickup postal code
pickup_postal_codetextRequired - Pickup postal code.
- Pickup country
pickup_countrytext - Pickup country.One of:
US. - Pickup first name
pickup_first_nametextRequired - Pickup first name.
- Pickup last name
pickup_last_nametextRequired - Pickup last name.
- Pickup phone
pickup_phonetextRequired - Pickup phone.
- Pickup instructions
pickup_instructionstext - Pickup instructions.
- Pickup latitude
pickup_latitudenumber - Pickup latitude.From -90 to 90.
- Pickup longitude
pickup_longitudenumber - Pickup longitude.From -180 to 180.
- Dropoff street
dropoff_streettextRequired - Dropoff street.
- Dropoff street line 2
dropoff_street_line_2text - Dropoff street line 2.
- Dropoff city
dropoff_citytextRequired - Dropoff city.
- Dropoff state
dropoff_statetextRequired - Dropoff state.
- Dropoff postal code
dropoff_postal_codetextRequired - Dropoff postal code.
- Dropoff country
dropoff_countrytext - Dropoff country.One of:
US. - Dropoff first name
dropoff_first_nametextRequired - Dropoff first name.
- Dropoff last name
dropoff_last_nametextRequired - Dropoff last name.
- Dropoff phone
dropoff_phonetextRequired - Dropoff phone.
- Dropoff instructions
dropoff_instructionstext - Dropoff instructions.
- Dropoff latitude
dropoff_latitudenumber - Dropoff latitude.From -90 to 90.
- Dropoff longitude
dropoff_longitudenumber - Dropoff longitude.From -180 to 180.
- Items
itemslistRequired - Items in this order. Quantity is required for each item; dimensions use feet and weight uses pounds.
- Total weight
total_weightnumber - Total weight.At least 0.
- Total volume
total_volumenumber - Total volume.At least 0.
- Total quantity
total_quantitynumber - Total quantity.At least 0.
Outputs
Response.
dataobject- Delivery or quote returned by Taskrabbit.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"currency": "example",
"deliveryWindowEndTime": "example",
"deliveryWindowStartTime": "example",
"estimatedDeliveryTime": "example",
"estimatedPickupTime": "example",
"externalDeliveryId": "example",
"externalOrderId": "example",
"externalStoreId": "example",
"fee": 1,
"id": "example",
"pickupWindowEndTime": "example",
"pickupWindowStartTime": "example",
"tip": 1
},
"has_more": false,
"next_cursor": null
}Create quote
Calculate a delivery quote using the approved partner store, delivery items, addresses and time windows.
Inputs
- Client id
client_idtextRequired - Client id.
- External delivery id
external_delivery_idtextRequired - External delivery id.
- External order id
external_order_idtextRequired - External order id.
- External store id
external_store_idtextRequired - External store id.
- Pickup start
pickup_startdate and timeRequired - Pickup start.
- Pickup end
pickup_enddate and timeRequired - Pickup end.
- Delivery start
delivery_startdate and timeRequired - Delivery start.
- Delivery end
delivery_enddate and timeRequired - Delivery end.
- Contains alcohol
contains_alcoholtrue/falseRequired - Contains alcohol.
- Autonomous delivery
autonomous_deliverytrue/falseRequired - Autonomous delivery.
- Pickup street
pickup_streettextRequired - Pickup street.
- Pickup street line 2
pickup_street_line_2text - Pickup street line 2.
- Pickup city
pickup_citytextRequired - Pickup city.
- Pickup state
pickup_statetextRequired - Pickup state.
- Pickup postal code
pickup_postal_codetextRequired - Pickup postal code.
- Pickup country
pickup_countrytext - Pickup country.One of:
US. - Pickup first name
pickup_first_nametextRequired - Pickup first name.
- Pickup last name
pickup_last_nametextRequired - Pickup last name.
- Pickup phone
pickup_phonetextRequired - Pickup phone.
- Pickup instructions
pickup_instructionstext - Pickup instructions.
- Pickup latitude
pickup_latitudenumber - Pickup latitude.From -90 to 90.
- Pickup longitude
pickup_longitudenumber - Pickup longitude.From -180 to 180.
- Dropoff street
dropoff_streettextRequired - Dropoff street.
- Dropoff street line 2
dropoff_street_line_2text - Dropoff street line 2.
- Dropoff city
dropoff_citytextRequired - Dropoff city.
- Dropoff state
dropoff_statetextRequired - Dropoff state.
- Dropoff postal code
dropoff_postal_codetextRequired - Dropoff postal code.
- Dropoff country
dropoff_countrytext - Dropoff country.One of:
US. - Dropoff first name
dropoff_first_nametextRequired - Dropoff first name.
- Dropoff last name
dropoff_last_nametextRequired - Dropoff last name.
- Dropoff phone
dropoff_phonetextRequired - Dropoff phone.
- Dropoff instructions
dropoff_instructionstext - Dropoff instructions.
- Dropoff latitude
dropoff_latitudenumber - Dropoff latitude.From -90 to 90.
- Dropoff longitude
dropoff_longitudenumber - Dropoff longitude.From -180 to 180.
- Items
itemslistRequired - Items in this order. Quantity is required for each item; dimensions use feet and weight uses pounds.
- Total weight
total_weightnumber - Total weight.At least 0.
- Total volume
total_volumenumber - Total volume.At least 0.
- Total quantity
total_quantitynumber - Total quantity.At least 0.
Outputs
Response.
dataobject- Delivery or quote returned by Taskrabbit.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"actualOrderTime": "example",
"batchId": "example",
"containsAlcohol": false,
"currency": "example",
"deliveryWindowEndTime": "example",
"deliveryWindowStartTime": "example",
"dropOffInfo": {
"dropOffInstruction": "example",
"dropOffLocation": {
"latitude": 1,
"longitude": 1
},
"dropoffAddress": {
"addressLine1": "example",
"addressLine2": "example",
"city": "example",
"country": "example",
"state": "example",
"zipCode": "example"
},
"dropoffContact": {
"firstName": "example",
"lastName": "example",
"phone": "example"
},
"isUnattended": false,
"signatureRequired": false
},
"estimatedDeliveryTime": "example",
"estimatedPickupTime": "example",
"externalDeliveryId": "example",
"externalOrderId": "example",
"externalStoreId": "example",
"fee": 1,
"id": "example",
"isAutonomousDelivery": false,
"orderInfo": {
"barcodeInfo": [],
"orderLineItems": [],
"size": "example",
"totalQuantity": 1,
"totalVolume": 1,
"totalWeight": 1
},
"pickupInfo": {
"parkingBayEnabled": false,
"pickupAddress": {
"addressLine1": "example",
"addressLine2": "example",
"city": "example",
"country": "example",
"neighborhood": "example",
"state": "example",
"zipCode": "example"
},
"pickupContact": {
"firstName": "example",
"lastName": "example",
"phone": "example"
},
"pickupInstruction": "example",
"pickupLocation": {
"latitude": 1,
"longitude": 1
},
"signatureRequired": false
},
"pickupWindowEndTime": "example",
"pickupWindowStartTime": "example",
"status": "example",
"storeName": "example",
"tip": 1
},
"has_more": false,
"next_cursor": null
}Create route
Create route.
Inputs
- Client id
client_idtextRequired - client_id
- External route id
external_route_idtextRequired - external_route_id
- Orders
orderslistRequired - orders
- Requested vehicle info
requested_vehicle_infoobject - requested_vehicle_info
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"success": false
},
"has_more": false,
"next_cursor": null
}Get delivery
Get delivery.
Inputs
- Id
idtextRequired - Id.
- Clientid
clientidtext - The partner-provided clientid; leave empty unless your partner setup requires this header.
- Partnerid
partneridtext - The partner-provided partnerid; leave empty unless your partner setup requires this header.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"actualOrderTime": "example",
"batchId": "example",
"containsAlcohol": false,
"currency": "example",
"deliveryWindowEndTime": "example",
"deliveryWindowStartTime": "example",
"dropOffInfo": {
"dropOffInstruction": "example",
"dropOffLocation": {
"latitude": 1,
"longitude": 1
},
"dropoffAddress": {
"addressLine1": "example",
"addressLine2": "example",
"city": "example",
"country": "example",
"state": "example",
"zipCode": "example"
},
"dropoffContact": {
"firstName": "example",
"lastName": "example",
"phone": "example"
},
"isUnattended": false,
"signatureRequired": false
},
"estimatedDeliveryTime": "example",
"estimatedPickupTime": "example",
"externalDeliveryId": "example",
"externalOrderId": "example",
"externalStoreId": "example",
"fee": 1,
"id": "example",
"isAutonomousDelivery": false,
"orderInfo": {
"barcodeInfo": [],
"orderLineItems": [],
"size": "example",
"totalQuantity": 1,
"totalVolume": 1,
"totalWeight": 1
},
"pickupInfo": {
"parkingBayEnabled": false,
"pickupAddress": {
"addressLine1": "example",
"addressLine2": "example",
"city": "example",
"country": "example",
"neighborhood": "example",
"state": "example",
"zipCode": "example"
},
"pickupContact": {
"firstName": "example",
"lastName": "example",
"phone": "example"
},
"pickupInstruction": "example",
"pickupLocation": {
"latitude": 1,
"longitude": 1
},
"signatureRequired": false
},
"pickupWindowEndTime": "example",
"pickupWindowStartTime": "example",
"status": "example",
"storeName": "example",
"tip": 1
},
"has_more": false,
"next_cursor": null
}Get partner
Get partner.
Inputs
None.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get quote
Get quote.
Inputs
- Id
idtextRequired - Unique identifier of a delivery quote
- Clientid
clientidtext - The partner-provided clientid; leave empty unless your partner setup requires this header.
- Partnerid
partneridtext - The partner-provided partnerid; leave empty unless your partner setup requires this header.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"actualOrderTime": "example",
"batchId": "example",
"containsAlcohol": false,
"currency": "example",
"deliveryWindowEndTime": "example",
"deliveryWindowStartTime": "example",
"dropOffInfo": {
"dropOffInstruction": "example",
"dropOffLocation": {
"latitude": 1,
"longitude": 1
},
"dropoffAddress": {
"addressLine1": "example",
"addressLine2": "example",
"city": "example",
"country": "example",
"state": "example",
"zipCode": "example"
},
"dropoffContact": {
"firstName": "example",
"lastName": "example",
"phone": "example"
},
"isUnattended": false,
"signatureRequired": false
},
"estimatedDeliveryTime": "example",
"estimatedPickupTime": "example",
"externalDeliveryId": "example",
"externalOrderId": "example",
"externalStoreId": "example",
"fee": 1,
"id": "example",
"isAutonomousDelivery": false,
"orderInfo": {
"barcodeInfo": [],
"orderLineItems": [],
"size": "example",
"totalQuantity": 1,
"totalVolume": 1,
"totalWeight": 1
},
"pickupInfo": {
"parkingBayEnabled": false,
"pickupAddress": {
"addressLine1": "example",
"addressLine2": "example",
"city": "example",
"country": "example",
"neighborhood": "example",
"state": "example",
"zipCode": "example"
},
"pickupContact": {
"firstName": "example",
"lastName": "example",
"phone": "example"
},
"pickupInstruction": "example",
"pickupLocation": {
"latitude": 1,
"longitude": 1
},
"signatureRequired": false
},
"pickupWindowEndTime": "example",
"pickupWindowStartTime": "example",
"status": "example",
"storeName": "example",
"tip": 1
},
"has_more": false,
"next_cursor": null
}