> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Shipday

The Shipday connector lets your AI agent act in each user's Shipday account. Each user connects their own Shipday API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 24 tools.

**Authentication:** API Key
**Categories:** Productivity, CRM & Sales
**Tools:** 24: 10 read, 11 write, 3 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=SHIPDAY)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Shipday connection

   In **AgentKit > Connections**, create a Shipday connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'shipday'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Shipday:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'shipday_carriers_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "shipday"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Shipday:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="shipday_carriers_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Shipday credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'shipday_carriers_list',
  toolInput: {},
  connector: 'shipday',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="shipday_carriers_list",
    tool_input={},
    connection_name="shipday",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `shipday_carriers_list`

List Drivers · Read-only

List your drivers (carriers).
Returns each driver's id, name, phone, email, photo, active and on-shift flags.
Use this to find a carrier ID for shipday_order_assign.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `shipday_ondemand_availability_check`

Check On-Demand Availability · Read-only

Check which third-party delivery services can deliver between two addresses, with quotes.
Returns each service's availability, fee and estimated times.
Use this before creating an order. Use shipday_ondemand_estimate_get for an existing order.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `delivery_address` (`string`, required): Delivery address. Example: 1000 5th Ave, New York, NY 10028, USA.
- `pickup_address` (`string`, required): Pickup address. Example: 1 Wall St, New York, NY 10005, USA.
- `delivery_time` (`string`, optional): Expected delivery time, ISO 8601 UTC. Example: 2026-11-20T17:30:00Z.
- `pickup_time` (`string`, optional): Expected pickup time, ISO 8601 UTC. Example: 2026-11-20T17:00:00Z.

Example input: `{"delivery_address":"<delivery_address>","pickup_address":"<pickup_address>"}`

### `shipday_ondemand_details_get`

Get On-Demand Delivery Details · Read-only

Get the status of an order handed to a third-party delivery service.
Returns the service, status, driver and fee details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `order_id` (`integer`, required): Shipday order ID (the numeric orderId, not the order number), from shipday_orders_active_list or shipday_order_get. Example: 16039690.

Example input: `{"order_id":16039690}`

### `shipday_ondemand_estimate_get`

Get On-Demand Estimates · Read-only

Get delivery quotes from third-party services for an existing order.
Returns each service's availability, fee, wait time and estimate reference.
Pass the chosen service name and estimate reference to shipday_ondemand_assign.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `order_id` (`integer`, required): Shipday order ID (the numeric orderId, not the order number), from shipday_orders_active_list or shipday_order_get. Example: 16039690.

Example input: `{"order_id":16039690}`

### `shipday_ondemand_services_list`

List On-Demand Services · Read-only

List the third-party delivery services (such as DoorDash or Uber) available to your account.
Returns the service names.
Use these names with shipday_ondemand_assign.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `shipday_order_get`

Get Order · Read-only

Get delivery orders by your order number.
Returns the matching orders with orderId, customer, restaurant, carrier, activity log, costs, status and tracking link.
Use this to look up the Shipday orderId that other order tools need.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `order_number` (`string`, required): Your order number, as sent when the order was created. Example: 99qT5A.

Example input: `{"order_number":"<order_number>"}`

### `shipday_order_progress_get`

Get Order Delivery Progress · Read-only

Get live delivery progress and ETA for an order by its tracking ID (premium plans only).
Returns the driver location, ETA and status, plus customer, restaurant and carrier details when include_static_data is true.
Use this for customer-facing tracking. Use shipday_order_get for the full order record.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `include_static_data` (`string`, required): true also returns fixedData (customer, restaurant and carrier details); false returns only the live tracking data. Example: false. One of: `true`, `false`.
- `tracking_id` (`string`, required): Tracking ID of the order (from the order's tracking link). Example: gvkT2dyr.

Example input: `{"include_static_data":"true","tracking_id":"<tracking_id>"}`

### `shipday_orders_active_list`

List Active Orders · Read-only

List the delivery orders that are currently active in Shipday.
Returns each order's orderId, orderNumber, customer, restaurant, assigned carrier, activity log times, costs, status and tracking link.
Use this to see work in progress. Use shipday_orders_query for past orders or a date range, and shipday_order_get for one order number.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `shipday_orders_query`

Query Orders · Read-only

Find delivery orders placed in a time range, optionally with one status, paged by row cursors (most recent first).
Returns the matching order objects with full details.
Use this for history and reporting. Use shipday_orders_active_list for active orders only.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_cursor` (`integer`, optional): Last row to return; with start_cursor=26 and end_cursor=50 you get rows 26 to 50. Defaults to 100. Example: 25.
- `end_time` (`string`, optional): Latest order placement time, ISO 8601 UTC. Example: 2026-11-15T23:59:59Z.
- `order_status` (`string`, optional): Only orders with this status. Example: ALREADY_DELIVERED. One of: `ACTIVE`, `NOT_ASSIGNED`, `NOT_ACCEPTED`, `NOT_STARTED_YET`, `STARTED`, `PICKED_UP`, `READY_TO_DELIVER`, `ALREADY_DELIVERED`, `FAILED_DELIVERY`, `INCOMPLETE`.
- `start_cursor` (`integer`, optional): First row to return, starting at 1. Defaults to 1. Example: 1.
- `start_time` (`string`, optional): Earliest order placement time, ISO 8601 UTC. Example: 2026-11-01T00:00:00Z.

Example input: `{}`

### `shipday_pickup_order_get`

Get Takeout Order · Read-only

Get one takeout (customer pickup) order.
Returns its order number, restaurant, customer, items, costs, pickup time and status.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `order_id` (`integer`, required): ID of the takeout order, from shipday_pickup_order_create. Example: 16039690.

Example input: `{"order_id":16039690}`

### `shipday_carrier_create`

Add Driver · Write

Add a driver (carrier) to your Shipday account; Shipday invites them to the driver app.
Returns the new driver.
Use shipday_carriers_list to see existing drivers.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `email` (`string`, required): Driver's email address. Example: driver@example.com.
- `name` (`string`, required): Driver's full name. Example: John Doe.
- `phone_number` (`string`, required): Driver's phone number with country code. Example: +15551234567.

Example input: `{"email":"<email>","name":"<name>","phone_number":"<phone_number>"}`

### `shipday_ondemand_assign`

Assign to On-Demand Service · Write

Hand an order to a third-party delivery service. This books a paid delivery.
Returns the assignment details.
Get the service name and estimate reference from shipday_ondemand_estimate_get. Use shipday_ondemand_cancel to cancel.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Service provider name, from shipday_ondemand_services_list or the estimate. Example: DoorDash.
- `order_id` (`integer`, required): Shipday order ID to assign. Example: 16039690.
- `contactless_delivery` (`boolean`, optional): Request contactless delivery. Example: false.
- `estimate_reference` (`string`, optional): Estimate reference from shipday_ondemand_estimate_get. Example: a1b2c3d4.
- `pod_type` (`string`, optional): Proof of delivery: PHOTO, SIGNATURE, PIN or NONE. Example: PHOTO. One of: `PHOTO`, `SIGNATURE`, `PIN`, `NONE`.
- `pod_types` (`array`, optional): Several proof of delivery types, for example ["PHOTO", "PIN"]. Example: ["PHOTO", "PIN"]
- `tip` (`number`, optional): Tip for the driver. Example: 3.

Example input: `{"name":"<name>","order_id":16039690}`

### `shipday_ondemand_cancel`

Cancel On-Demand Delivery · Write

Cancel an order's third-party delivery.
Returns the cancellation result.
Cancellation fees may apply depending on the service and timing.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `order_id` (`integer`, required): Shipday order ID (the numeric orderId, not the order number), from shipday_orders_active_list or shipday_order_get. Example: 16039690.

Example input: `{"order_id":16039690}`

### `shipday_order_assign`

Assign Order to Driver · Write

Assign a delivery order to one of your drivers (carriers).
Returns the assignment result.
Get the carrier ID from shipday_carriers_list. Use shipday_order_unassign to undo.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `carrier_id` (`integer`, required): Driver (carrier) ID, from shipday_carriers_list. Example: 30309.
- `order_id` (`integer`, required): Shipday order ID (the numeric orderId, not the order number), from shipday_orders_active_list or shipday_order_get. Example: 16039690.

Example input: `{"carrier_id":30309,"order_id":16039690}`

### `shipday_order_create`

Create Delivery Order · Write

Create a delivery order in Shipday for dispatch to a driver.
Returns success and the new orderId.
Assign it with shipday_order_assign or to a third-party service with shipday_ondemand_assign. Use shipday_pickup_order_create for customer pickup (takeout) orders.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `customer_address` (`string`, required): Delivery address. Example: 556 Crestlake Dr, San Francisco, CA 94132, USA.
- `customer_name` (`string`, required): Customer's name. Example: Jane Mason.
- `customer_phone_number` (`string`, required): Customer's phone number with country code. Example: +14152392212.
- `order_number` (`string`, required): Your identifier for the order. Example: 99qT5A.
- `restaurant_address` (`string`, required): Pickup address. Example: 890 Geneva Ave, San Francisco, CA 94112, USA.
- `restaurant_name` (`string`, required): Name of the pickup business (restaurant or store). Example: Kenny's Cafe.
- `additional_id` (`string`, optional): Your additional reference ID. Example: 4532.
- `client_restaurant_id` (`integer`, optional): Client restaurant ID. Example: 12.
- `credit_card_id` (`integer`, optional): Last four digits of the card when paid by card. Example: 1234.
- `credit_card_type` (`string`, optional): Card type when paid by card: VISA, MASTER_CARD, AMEX or OTHER. Example: VISA.
- `customer_email` (`string`, optional): Customer's email address. Example: jane@example.com.
- `delivery_fee` (`number`, optional): Delivery fee. Example: 3.
- `delivery_instruction` (`string`, optional): Instructions for the driver. Example: Ring the bell twice.
- `delivery_latitude` (`number`, optional): Delivery latitude. Example: 37.7106.
- `delivery_longitude` (`number`, optional): Delivery longitude. Example: -122.4793.
- `delivery_window_in_minutes` (`integer`, optional): Delivery window in minutes (positive). Example: 30.
- `discount_amount` (`number`, optional): Discount amount. Example: 1.0.
- `dropoff` (`object`, optional): Dropoff Structured address breakdown, as {"address": {"unit", "street", "city", "state", "zip", "country"}}. Example: {"address": {"street": "556 Crestlake Dr", "city": "San Francisco", "state": "CA", "zip": "94132", "country": "USA"}}
- `expected_delivery_date` (`string`, optional): Expected delivery date in UTC (YYYY-MM-DD). Example: 2026-11-20.
- `expected_delivery_time` (`string`, optional): Expected delivery time in UTC (hh:mm:ss). Example: 18:30:00.
- `expected_pickup_time` (`string`, optional): Expected pickup time in UTC (hh:mm:ss). Example: 17:45:00.
- `is_catering` (`boolean`, optional): Mark the order as a catering order. Example: false.
- `order_items` (`array`, optional): Order items. Each item has a name, quantity and unitPrice, and optionally addOns (list of strings) and a detail note. Example: [{"name": "Popcorn Shrimp", "quantity": 2, "unitPrice": 2.99, "detail": "Less salt"}]
- `order_source` (`string`, optional): Where the order came from. Example: Website.
- `payment_method` (`string`, optional): Payment method, for example cash or credit_card. Example: credit_card.
- `pickup` (`object`, optional): Pickup Structured address breakdown, as {"address": {"unit", "street", "city", "state", "zip", "country"}}. Example: {"address": {"street": "890 Geneva Ave", "city": "San Francisco", "state": "CA", "zip": "94112", "country": "USA"}}
- `pickup_instruction` (`string`, optional): Instructions for the pickup. Example: Ask for the order at the counter.
- `pickup_latitude` (`number`, optional): Pickup latitude. Example: 37.7219.
- `pickup_longitude` (`number`, optional): Pickup longitude. Example: -122.4442.
- `restaurant_phone_number` (`string`, optional): Pickup business phone number with country code. Example: +14152392013.
- `tax` (`number`, optional): Tax amount. Example: 1.5.
- `tip` (`number`, optional): Tip amount. Example: 2.5.
- `total_order_cost` (`number`, optional): Total cost of the order. Example: 13.47.

Example input: `{"customer_address":"<customer_address>","customer_name":"<customer_name>","customer_phone_number":"<customer_phone_number>","order_number":"<order_number>","restaurant_address":"<restaurant_address>","restaurant_name":"<restaurant_name>"}`

### `shipday_order_edit`

Edit Delivery Order · Write

Replace a delivery order's details (customer, pickup, times, items and costs).
Returns the update result.
Send the full set of required fields, not only the ones that change. Use shipday_order_status_update to change only the status.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_address` (`string`, required): Delivery address. Example: 556 Crestlake Dr, San Francisco, CA 94132, USA.
- `customer_email` (`string`, required): Customer's email address. Example: jane@example.com.
- `customer_name` (`string`, required): Customer's name. Example: Jane Mason.
- `customer_phone_number` (`string`, required): Customer's phone number with country code. Example: +14152392212.
- `order_id` (`integer`, required): Shipday order ID (the numeric orderId, not the order number), from shipday_orders_active_list or shipday_order_get. Example: 16039690.
- `order_number` (`string`, required): Your identifier for the order. Example: 99qT5A.
- `restaurant_address` (`string`, required): Pickup address. Example: 890 Geneva Ave, San Francisco, CA 94112, USA.
- `restaurant_name` (`string`, required): Name of the pickup business (restaurant or store). Example: Kenny's Cafe.
- `additional_id` (`string`, optional): Your additional reference ID. Example: 4532.
- `body_order_id` (`integer`, optional): Same order ID repeated in the body, as the API example shows. Leave empty to send the path order_id only. Example: 16039690.
- `client_restaurant_id` (`integer`, optional): Client restaurant ID. Example: 12.
- `credit_card_id` (`integer`, optional): Last four digits of the card when paid by card. Example: 1234.
- `credit_card_type` (`string`, optional): Card type when paid by card: VISA, MASTER_CARD, AMEX or OTHER. Example: VISA.
- `delivery_fee` (`number`, optional): Delivery fee. Example: 3.
- `delivery_instruction` (`string`, optional): Instructions for the driver. Example: Ring the bell twice.
- `delivery_latitude` (`number`, optional): Delivery latitude. Example: 37.7106.
- `delivery_longitude` (`number`, optional): Delivery longitude. Example: -122.4793.
- `delivery_window_in_minutes` (`integer`, optional): Delivery window in minutes (positive). Leave out to keep the current value. Example: 30.
- `discount_amount` (`number`, optional): Discount amount. Example: 1.0.
- `dropoff` (`object`, optional): Dropoff Structured address breakdown, as {"address": {"unit", "street", "city", "state", "zip", "country"}}. Example: {"address": {"street": "556 Crestlake Dr", "city": "San Francisco", "state": "CA", "zip": "94132", "country": "USA"}}
- `expected_delivery_date` (`string`, optional): Expected delivery date in UTC (YYYY-MM-DD). Example: 2026-11-20.
- `expected_delivery_time` (`string`, optional): Expected delivery time in UTC (hh:mm:ss). Example: 18:30:00.
- `expected_pickup_time` (`string`, optional): Expected pickup time in UTC (hh:mm:ss). Example: 17:45:00.
- `order_items` (`array`, optional): Order items. Each item has a name, quantity and unitPrice, and optionally addOns (list of strings) and a detail note. Example: [{"name": "Popcorn Shrimp", "quantity": 2, "unitPrice": 2.99, "detail": "Less salt"}]
- `order_source` (`string`, optional): Where the order came from. Example: Website.
- `payment_method` (`string`, optional): Payment method, for example cash or credit_card. Example: credit_card.
- `pickup` (`object`, optional): Pickup Structured address breakdown, as {"address": {"unit", "street", "city", "state", "zip", "country"}}. Example: {"address": {"street": "890 Geneva Ave", "city": "San Francisco", "state": "CA", "zip": "94112", "country": "USA"}}
- `pickup_latitude` (`number`, optional): Pickup latitude. Example: 37.7219.
- `pickup_longitude` (`number`, optional): Pickup longitude. Example: -122.4442.
- `restaurant_phone_number` (`string`, optional): Pickup business phone number with country code. Example: +14152392013.
- `tax` (`number`, optional): Tax amount. Example: 1.5.
- `tip` (`number`, optional): Tip amount. Example: 2.5.
- `total_cost` (`string`, optional): Total cost of the order, as a string. Example: 13.47.

Example input: `{"customer_address":"<customer_address>","customer_email":"<customer_email>","customer_name":"<customer_name>","customer_phone_number":"<customer_phone_number>","order_id":16039690,"order_number":"<order_number>","restaurant_address":"<restaurant_address>","restaurant_name":"<restaurant_name>"}`

### `shipday_order_ready_to_pickup_set`

Set Order Ready to Pickup · Write

Mark a delivery order as ready (or not ready) for the driver to pick up.
Returns the result.
Use shipday_order_status_update for delivery status changes.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `order_id` (`integer`, required): Shipday order ID (the numeric orderId, not the order number), from shipday_orders_active_list or shipday_order_get. Example: 16039690.
- `ready_to_pickup` (`boolean`, required): true when the order is ready for pickup. Example: true.

Example input: `{"order_id":16039690,"ready_to_pickup":true}`

### `shipday_order_status_update`

Update Order Status · Write

Set a delivery order's status (started, picked up, ready to deliver, delivered, incomplete or failed).
Returns orderId, success and the new status.
Use shipday_order_edit to change other details.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `order_id` (`integer`, required): Shipday order ID (the numeric orderId, not the order number), from shipday_orders_active_list or shipday_order_get. Example: 16039690.
- `status` (`string`, required): New status. Example: PICKED_UP. One of: `STARTED`, `PICKED_UP`, `READY_TO_DELIVER`, `ALREADY_DELIVERED`, `INCOMPLETE`, `FAILED_DELIVERY`.

Example input: `{"order_id":16039690,"status":"STARTED"}`

### `shipday_order_unassign`

Unassign Order from Driver · Write

Remove the driver assignment from a delivery order.
Returns the result.
Use shipday_order_assign to assign another driver.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `order_id` (`integer`, required): Shipday order ID (the numeric orderId, not the order number), from shipday_orders_active_list or shipday_order_get. Example: 16039690.

Example input: `{"order_id":16039690}`

### `shipday_pickup_order_create`

Create Takeout Order · Write

Create a takeout (customer pickup) order in Shipday.
Returns the new takeout order's ID.
Use shipday_order_create for delivery orders.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `customer_name` (`string`, required): Customer's name. Example: Jane Mason.
- `customer_phone` (`string`, required): Customer's phone number with country code. Example: +14152392212.
- `order_number` (`string`, required): Your identifier for the takeout order. Example: 99qT5A.
- `restaurant_address` (`string`, required): Address of the business. Example: 890 Geneva Ave, San Francisco, CA 94112, USA.
- `restaurant_name` (`string`, required): Name of the business preparing the order. Example: Kenny's Cafe.
- `additional_id` (`string`, optional): Your additional reference ID. Example: 4532.
- `customer_email` (`string`, optional): Customer's email address. Example: jane@example.com.
- `discount_amount` (`number`, optional): Discount amount. Example: 1.0.
- `expected_pickup_date` (`string`, optional): Expected pickup date in UTC (YYYY-MM-DD). Example: 2026-11-20.
- `expected_pickup_time` (`string`, optional): Expected pickup time in UTC (hh:mm:ss). Example: 20:45:00.
- `order_items` (`array`, optional): Order items. Each item has a name, quantity and unitPrice, and optionally addOns (list of strings) and a detail note. Example: [{"name": "Popcorn Shrimp", "quantity": 2, "unitPrice": 2.99, "detail": "Less salt"}]
- `order_source` (`string`, optional): Where the order came from. Example: Website.
- `payment_method` (`string`, optional): Payment method: CARD, CASH or ONLINE. Example: CARD. One of: `CARD`, `CASH`, `ONLINE`.
- `pickup_instruction` (`string`, optional): Instructions for the pickup. Example: Ask at the counter.
- `restaurant_phone` (`string`, optional): Business phone number with country code. Example: +14152392013.
- `tax` (`number`, optional): Tax amount. Example: 1.5.
- `tips` (`number`, optional): Tip amount. Example: 2.5.
- `total_order_cost` (`number`, optional): Total cost of the order. Example: 13.47.

Example input: `{"customer_name":"<customer_name>","customer_phone":"<customer_phone>","order_number":"<order_number>","restaurant_address":"<restaurant_address>","restaurant_name":"<restaurant_name>"}`

### `shipday_pickup_order_update`

Update Takeout Order · Write

Replace a takeout order's details or change its status (IN_PROGRESS, READY, DONE or CANCEL).
Returns the updated takeout order.
Send the required fields again with the changes.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_name` (`string`, required): Customer's name. Example: Jane Mason.
- `customer_phone` (`string`, required): Customer's phone number with country code. Example: +14152392212.
- `order_id` (`integer`, required): ID of the takeout order. Example: 16039690.
- `order_number` (`string`, required): Your identifier for the takeout order. Example: 99qT5A.
- `restaurant_address` (`string`, required): Address of the business. Example: 890 Geneva Ave, San Francisco, CA 94112, USA.
- `restaurant_name` (`string`, required): Name of the business preparing the order. Example: Kenny's Cafe.
- `additional_id` (`string`, optional): Your additional reference ID. Example: 4532.
- `company_id` (`integer`, optional): Shipday company ID the order belongs to. Example: 130616.
- `customer_email` (`string`, optional): Customer's email address. Example: jane@example.com.
- `discount_amount` (`number`, optional): Discount amount. Example: 1.0.
- `expected_pickup_date` (`string`, optional): Expected pickup date in UTC (YYYY-MM-DD). Example: 2026-11-20.
- `expected_pickup_time` (`string`, optional): Expected pickup time in UTC (hh:mm:ss). Example: 20:45:00.
- `order_items` (`array`, optional): Order items. Each item has a name, quantity and unitPrice, and optionally addOns (list of strings) and a detail note. Example: [{"name": "Popcorn Shrimp", "quantity": 2, "unitPrice": 2.99, "detail": "Less salt"}]
- `order_source` (`string`, optional): Where the order came from. Example: Website.
- `payment_method` (`string`, optional): Payment method: CARD, CASH or ONLINE. Example: CARD. One of: `CARD`, `CASH`, `ONLINE`.
- `pickup_instruction` (`string`, optional): Instructions for the pickup. Example: Ask at the counter.
- `restaurant_latitude` (`number`, optional): Business latitude. Example: 37.4832505.
- `restaurant_longitude` (`number`, optional): Business longitude. Example: -122.1743908.
- `restaurant_phone` (`string`, optional): Business phone number with country code. Example: +14152392013.
- `status` (`string`, optional): Takeout order status: IN_PROGRESS, READY, DONE or CANCEL. Example: READY. One of: `IN_PROGRESS`, `READY`, `DONE`, `CANCEL`.
- `tax` (`number`, optional): Tax amount. Example: 1.5.
- `tips` (`number`, optional): Tip amount. Example: 2.5.
- `total_order_cost` (`number`, optional): Total cost of the order. Example: 13.47.

Example input: `{"customer_name":"<customer_name>","customer_phone":"<customer_phone>","order_id":16039690,"order_number":"<order_number>","restaurant_address":"<restaurant_address>","restaurant_name":"<restaurant_name>"}`

### `shipday_carrier_delete`

Delete Driver · Destructive

Remove a driver (carrier) from your Shipday account.
Returns an empty success response.
This cannot be undone.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `carrier_id` (`integer`, required): Driver (carrier) ID, from shipday_carriers_list. Example: 30309.

Example input: `{"carrier_id":30309}`

### `shipday_order_delete`

Delete Order · Destructive

Delete a delivery order.
Returns an empty success response.
This cannot be undone.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `order_id` (`integer`, required): Shipday order ID (the numeric orderId, not the order number), from shipday_orders_active_list or shipday_order_get. Example: 16039690.

Example input: `{"order_id":16039690}`

### `shipday_pickup_order_delete`

Delete Takeout Order · Destructive

Delete a takeout order.
Returns an empty success response.
This cannot be undone.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `order_id` (`integer`, required): ID of the takeout order. Example: 16039690.

Example input: `{"order_id":16039690}`

## Related

Other Productivity connectors ([all 203](/agentkit/connectors/?category=productivity)):

- [Slack](/agentkit/connectors/slack/): Scalekit connector, OAuth, 96 tools
- [Notion](/agentkit/connectors/notion/): Scalekit connector, OAuth, 51 tools
- [Google Workspace (DWD)](/agentkit/connectors/googledwd/): Scalekit connector, Service account, 100 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
