Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Shipday

Scalekit connector
Open markdown

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.

Tools
24
What they doRead · write · destructive
10 · 11 · 310 read11 write3 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .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.

  4. Authorize a user and make your first call

    quickstart.mts
    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)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Shipday credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • shipday_carriers_listList your drivers (carriers).Read-only

    List Drivers

    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.

    Inputs

    This tool takes no inputs.

  • shipday_ondemand_availability_checkCheck which third-party delivery services can deliver between two addresses, with quotes.Read-only

    Check On-Demand Availability

    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.

    Inputs

    delivery_addressstringrequired
    Delivery address. Example: 1000 5th Ave, New York, NY 10028, USA.
    pickup_addressstringrequired
    Pickup address. Example: 1 Wall St, New York, NY 10005, USA.
    delivery_timestring
    Expected delivery time, ISO 8601 UTC. Example: 2026-11-20T17:30:00Z.
    pickup_timestring
    Expected pickup time, ISO 8601 UTC. Example: 2026-11-20T17:00:00Z.
  • shipday_ondemand_details_getGet the status of an order handed to a third-party delivery service.Read-only

    Get On-Demand Delivery Details

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

    Inputs

    order_idintegerrequired
    Shipday order ID (the numeric orderId, not the order number), from shipday_orders_active_list or shipday_order_get. Example: 16039690.
  • shipday_ondemand_estimate_getGet delivery quotes from third-party services for an existing order.Read-only

    Get On-Demand Estimates

    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.

    Inputs

    order_idintegerrequired
    Shipday order ID (the numeric orderId, not the order number), from shipday_orders_active_list or shipday_order_get. Example: 16039690.
  • shipday_ondemand_services_listList the third-party delivery services (such as DoorDash or Uber) available to your account.Read-only

    List On-Demand Services

    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.

    Inputs

    This tool takes no inputs.

  • shipday_order_getGet delivery orders by your order number.Read-only

    Get Order

    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.

    Inputs

    order_numberstringrequired
    Your order number, as sent when the order was created. Example: 99qT5A.
  • shipday_order_progress_getGet live delivery progress and ETA for an order by its tracking ID (premium plans only).Read-only

    Get Order Delivery Progress

    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.

    Inputs

    include_static_datastringrequired
    true also returns fixedData (customer, restaurant and carrier details); false returns only the live tracking data. Example: false.one of truefalse
    tracking_idstringrequired
    Tracking ID of the order (from the order's tracking link). Example: gvkT2dyr.
  • shipday_orders_active_listList the delivery orders that are currently active in Shipday.Read-only

    List Active Orders

    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.

    Inputs

    This tool takes no inputs.