# TaskRabbit

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

App · 8 actions. Web page: https://docs.lodol.com/docs/integrations/taskrabbit

## Actions

### Book quote

Book quote.

**Inputs**

- Id (`id`, text, required): Unique identifier of a delivery quote
- Clientid (`clientid`, text): The partner-provided clientid; leave empty unless your partner setup requires this header.
- Partnerid (`partnerid`, text): The partner-provided partnerid; leave empty unless your partner setup requires this header.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "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_id`, text, required): Delivery id.
- Cancel reason (`cancel_reason`, text, required): Cancel reason. One of: `COLD_CHAIN_VIOLATION`, `ORDER_NOT_READY`, `SYSTEM_ERROR`, `DELIVERY_TIME_CHANGED`, `FRAUD_ORDER`, `CARRIER_CANCELLED`, `CAB_NOT_ARRIVED`, `OTHER`.
- Comment (`comment`, text, required): Comment.

**Outputs**

- `data` (object): Cancellation response.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "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_id`, text, required): Client id.
- External delivery id (`external_delivery_id`, text, required): External delivery id.
- External order id (`external_order_id`, text, required): External order id.
- External store id (`external_store_id`, text, required): External store id.
- Pickup start (`pickup_start`, date and time, required): Pickup start.
- Pickup end (`pickup_end`, date and time, required): Pickup end.
- Delivery start (`delivery_start`, date and time, required): Delivery start.
- Delivery end (`delivery_end`, date and time, required): Delivery end.
- Contains alcohol (`contains_alcohol`, true/false, required): Contains alcohol.
- Autonomous delivery (`autonomous_delivery`, true/false, required): Autonomous delivery.
- Pickup street (`pickup_street`, text, required): Pickup street.
- Pickup street line 2 (`pickup_street_line_2`, text): Pickup street line 2.
- Pickup city (`pickup_city`, text, required): Pickup city.
- Pickup state (`pickup_state`, text, required): Pickup state.
- Pickup postal code (`pickup_postal_code`, text, required): Pickup postal code.
- Pickup country (`pickup_country`, text): Pickup country. One of: `US`.
- Pickup first name (`pickup_first_name`, text, required): Pickup first name.
- Pickup last name (`pickup_last_name`, text, required): Pickup last name.
- Pickup phone (`pickup_phone`, text, required): Pickup phone.
- Pickup instructions (`pickup_instructions`, text): Pickup instructions.
- Pickup latitude (`pickup_latitude`, number): Pickup latitude. From -90 to 90.
- Pickup longitude (`pickup_longitude`, number): Pickup longitude. From -180 to 180.
- Dropoff street (`dropoff_street`, text, required): Dropoff street.
- Dropoff street line 2 (`dropoff_street_line_2`, text): Dropoff street line 2.
- Dropoff city (`dropoff_city`, text, required): Dropoff city.
- Dropoff state (`dropoff_state`, text, required): Dropoff state.
- Dropoff postal code (`dropoff_postal_code`, text, required): Dropoff postal code.
- Dropoff country (`dropoff_country`, text): Dropoff country. One of: `US`.
- Dropoff first name (`dropoff_first_name`, text, required): Dropoff first name.
- Dropoff last name (`dropoff_last_name`, text, required): Dropoff last name.
- Dropoff phone (`dropoff_phone`, text, required): Dropoff phone.
- Dropoff instructions (`dropoff_instructions`, text): Dropoff instructions.
- Dropoff latitude (`dropoff_latitude`, number): Dropoff latitude. From -90 to 90.
- Dropoff longitude (`dropoff_longitude`, number): Dropoff longitude. From -180 to 180.
- Items (`items`, list, required): Items in this order. Quantity is required for each item; dimensions use feet and weight uses pounds.
- Total weight (`total_weight`, number): Total weight. At least 0.
- Total volume (`total_volume`, number): Total volume. At least 0.
- Total quantity (`total_quantity`, number): Total quantity. At least 0.

**Outputs**: Response.

- `data` (object): Delivery or quote returned by Taskrabbit.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "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_id`, text, required): Client id.
- External delivery id (`external_delivery_id`, text, required): External delivery id.
- External order id (`external_order_id`, text, required): External order id.
- External store id (`external_store_id`, text, required): External store id.
- Pickup start (`pickup_start`, date and time, required): Pickup start.
- Pickup end (`pickup_end`, date and time, required): Pickup end.
- Delivery start (`delivery_start`, date and time, required): Delivery start.
- Delivery end (`delivery_end`, date and time, required): Delivery end.
- Contains alcohol (`contains_alcohol`, true/false, required): Contains alcohol.
- Autonomous delivery (`autonomous_delivery`, true/false, required): Autonomous delivery.
- Pickup street (`pickup_street`, text, required): Pickup street.
- Pickup street line 2 (`pickup_street_line_2`, text): Pickup street line 2.
- Pickup city (`pickup_city`, text, required): Pickup city.
- Pickup state (`pickup_state`, text, required): Pickup state.
- Pickup postal code (`pickup_postal_code`, text, required): Pickup postal code.
- Pickup country (`pickup_country`, text): Pickup country. One of: `US`.
- Pickup first name (`pickup_first_name`, text, required): Pickup first name.
- Pickup last name (`pickup_last_name`, text, required): Pickup last name.
- Pickup phone (`pickup_phone`, text, required): Pickup phone.
- Pickup instructions (`pickup_instructions`, text): Pickup instructions.
- Pickup latitude (`pickup_latitude`, number): Pickup latitude. From -90 to 90.
- Pickup longitude (`pickup_longitude`, number): Pickup longitude. From -180 to 180.
- Dropoff street (`dropoff_street`, text, required): Dropoff street.
- Dropoff street line 2 (`dropoff_street_line_2`, text): Dropoff street line 2.
- Dropoff city (`dropoff_city`, text, required): Dropoff city.
- Dropoff state (`dropoff_state`, text, required): Dropoff state.
- Dropoff postal code (`dropoff_postal_code`, text, required): Dropoff postal code.
- Dropoff country (`dropoff_country`, text): Dropoff country. One of: `US`.
- Dropoff first name (`dropoff_first_name`, text, required): Dropoff first name.
- Dropoff last name (`dropoff_last_name`, text, required): Dropoff last name.
- Dropoff phone (`dropoff_phone`, text, required): Dropoff phone.
- Dropoff instructions (`dropoff_instructions`, text): Dropoff instructions.
- Dropoff latitude (`dropoff_latitude`, number): Dropoff latitude. From -90 to 90.
- Dropoff longitude (`dropoff_longitude`, number): Dropoff longitude. From -180 to 180.
- Items (`items`, list, required): Items in this order. Quantity is required for each item; dimensions use feet and weight uses pounds.
- Total weight (`total_weight`, number): Total weight. At least 0.
- Total volume (`total_volume`, number): Total volume. At least 0.
- Total quantity (`total_quantity`, number): Total quantity. At least 0.

**Outputs**: Response.

- `data` (object): Delivery or quote returned by Taskrabbit.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "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_id`, text, required): client_id
- External route id (`external_route_id`, text, required): external_route_id
- Orders (`orders`, list, required): orders
- Requested vehicle info (`requested_vehicle_info`, object): requested_vehicle_info

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "success": false
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get delivery

Get delivery.

**Inputs**

- Id (`id`, text, required): Id.
- Clientid (`clientid`, text): The partner-provided clientid; leave empty unless your partner setup requires this header.
- Partnerid (`partnerid`, text): The partner-provided partnerid; leave empty unless your partner setup requires this header.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "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.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get quote

Get quote.

**Inputs**

- Id (`id`, text, required): Unique identifier of a delivery quote
- Clientid (`clientid`, text): The partner-provided clientid; leave empty unless your partner setup requires this header.
- Partnerid (`partnerid`, text): The partner-provided partnerid; leave empty unless your partner setup requires this header.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "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
}
```
