TaskRabbit

App · 8 actions

Read and quote Taskrabbit Delivery orders, book deliveries and create routes.

Actions

ActionWhat it does
Book quoteBook quote.
Cancel deliveryCancel a delivery with a reason and comment.
Create deliveryCreate a delivery with the approved partner store, items, addresses and time windows.
Create quoteCalculate a delivery quote using the approved partner store, delivery items, addresses and time windows.
Create routeCreate route.
Get deliveryGet delivery.
Get partnerGet partner.
Get quoteGet quote.

Book quote

Book quote.

Inputs

IdidtextRequired
Unique identifier of a delivery quote
Clientidclientidtext
The partner-provided clientid; leave empty unless your partner setup requires this header.
Partneridpartneridtext
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 iddelivery_idtextRequired
Delivery id.
Cancel reasoncancel_reasontextRequired
Cancel reason.One of: COLD_CHAIN_VIOLATION, ORDER_NOT_READY, SYSTEM_ERROR, DELIVERY_TIME_CHANGED, FRAUD_ORDER, CARRIER_CANCELLED, CAB_NOT_ARRIVED, OTHER.
CommentcommenttextRequired
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 idclient_idtextRequired
Client id.
External delivery idexternal_delivery_idtextRequired
External delivery id.
External order idexternal_order_idtextRequired
External order id.
External store idexternal_store_idtextRequired
External store id.
Pickup startpickup_startdate and timeRequired
Pickup start.
Pickup endpickup_enddate and timeRequired
Pickup end.
Delivery startdelivery_startdate and timeRequired
Delivery start.
Delivery enddelivery_enddate and timeRequired
Delivery end.
Contains alcoholcontains_alcoholtrue/falseRequired
Contains alcohol.
Autonomous deliveryautonomous_deliverytrue/falseRequired
Autonomous delivery.
Pickup streetpickup_streettextRequired
Pickup street.
Pickup street line 2pickup_street_line_2text
Pickup street line 2.
Pickup citypickup_citytextRequired
Pickup city.
Pickup statepickup_statetextRequired
Pickup state.
Pickup postal codepickup_postal_codetextRequired
Pickup postal code.
Pickup countrypickup_countrytext
Pickup country.One of: US.
Pickup first namepickup_first_nametextRequired
Pickup first name.
Pickup last namepickup_last_nametextRequired
Pickup last name.
Pickup phonepickup_phonetextRequired
Pickup phone.
Pickup instructionspickup_instructionstext
Pickup instructions.
Pickup latitudepickup_latitudenumber
Pickup latitude.From -90 to 90.
Pickup longitudepickup_longitudenumber
Pickup longitude.From -180 to 180.
Dropoff streetdropoff_streettextRequired
Dropoff street.
Dropoff street line 2dropoff_street_line_2text
Dropoff street line 2.
Dropoff citydropoff_citytextRequired
Dropoff city.
Dropoff statedropoff_statetextRequired
Dropoff state.
Dropoff postal codedropoff_postal_codetextRequired
Dropoff postal code.
Dropoff countrydropoff_countrytext
Dropoff country.One of: US.
Dropoff first namedropoff_first_nametextRequired
Dropoff first name.
Dropoff last namedropoff_last_nametextRequired
Dropoff last name.
Dropoff phonedropoff_phonetextRequired
Dropoff phone.
Dropoff instructionsdropoff_instructionstext
Dropoff instructions.
Dropoff latitudedropoff_latitudenumber
Dropoff latitude.From -90 to 90.
Dropoff longitudedropoff_longitudenumber
Dropoff longitude.From -180 to 180.
ItemsitemslistRequired
Items in this order. Quantity is required for each item; dimensions use feet and weight uses pounds.
Total weighttotal_weightnumber
Total weight.At least 0.
Total volumetotal_volumenumber
Total volume.At least 0.
Total quantitytotal_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 idclient_idtextRequired
Client id.
External delivery idexternal_delivery_idtextRequired
External delivery id.
External order idexternal_order_idtextRequired
External order id.
External store idexternal_store_idtextRequired
External store id.
Pickup startpickup_startdate and timeRequired
Pickup start.
Pickup endpickup_enddate and timeRequired
Pickup end.
Delivery startdelivery_startdate and timeRequired
Delivery start.
Delivery enddelivery_enddate and timeRequired
Delivery end.
Contains alcoholcontains_alcoholtrue/falseRequired
Contains alcohol.
Autonomous deliveryautonomous_deliverytrue/falseRequired
Autonomous delivery.
Pickup streetpickup_streettextRequired
Pickup street.
Pickup street line 2pickup_street_line_2text
Pickup street line 2.
Pickup citypickup_citytextRequired
Pickup city.
Pickup statepickup_statetextRequired
Pickup state.
Pickup postal codepickup_postal_codetextRequired
Pickup postal code.
Pickup countrypickup_countrytext
Pickup country.One of: US.
Pickup first namepickup_first_nametextRequired
Pickup first name.
Pickup last namepickup_last_nametextRequired
Pickup last name.
Pickup phonepickup_phonetextRequired
Pickup phone.
Pickup instructionspickup_instructionstext
Pickup instructions.
Pickup latitudepickup_latitudenumber
Pickup latitude.From -90 to 90.
Pickup longitudepickup_longitudenumber
Pickup longitude.From -180 to 180.
Dropoff streetdropoff_streettextRequired
Dropoff street.
Dropoff street line 2dropoff_street_line_2text
Dropoff street line 2.
Dropoff citydropoff_citytextRequired
Dropoff city.
Dropoff statedropoff_statetextRequired
Dropoff state.
Dropoff postal codedropoff_postal_codetextRequired
Dropoff postal code.
Dropoff countrydropoff_countrytext
Dropoff country.One of: US.
Dropoff first namedropoff_first_nametextRequired
Dropoff first name.
Dropoff last namedropoff_last_nametextRequired
Dropoff last name.
Dropoff phonedropoff_phonetextRequired
Dropoff phone.
Dropoff instructionsdropoff_instructionstext
Dropoff instructions.
Dropoff latitudedropoff_latitudenumber
Dropoff latitude.From -90 to 90.
Dropoff longitudedropoff_longitudenumber
Dropoff longitude.From -180 to 180.
ItemsitemslistRequired
Items in this order. Quantity is required for each item; dimensions use feet and weight uses pounds.
Total weighttotal_weightnumber
Total weight.At least 0.
Total volumetotal_volumenumber
Total volume.At least 0.
Total quantitytotal_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 idclient_idtextRequired
client_id
External route idexternal_route_idtextRequired
external_route_id
OrdersorderslistRequired
orders
Requested vehicle inforequested_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

IdidtextRequired
Id.
Clientidclientidtext
The partner-provided clientid; leave empty unless your partner setup requires this header.
Partneridpartneridtext
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

IdidtextRequired
Unique identifier of a delivery quote
Clientidclientidtext
The partner-provided clientid; leave empty unless your partner setup requires this header.
Partneridpartneridtext
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
}

On this page