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
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. 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>Create the Shipday connection
In AgentKit > Connections, create a Shipday connection. The name you give it is the
connection_nameyour code passes. See Configure connections.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.actionsconst connector = 'shipday'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst result = await actions.executeTool({connector,identifier,toolName: 'shipday_carriers_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_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.actionsconnection_name = "shipday"identifier = "user_123"# Generate an authorization link for the userlink_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 callresult = actions.execute_tool(tool_input={},tool_name="shipday_carriers_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach 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 toexecute_toolshipday_carriers_listList your drivers (carriers).Read-onlyList 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-onlyCheck 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-onlyGet 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-onlyGet 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-onlyList 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-onlyGet 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-onlyGet 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-onlyList 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.
shipday_orders_queryFind delivery orders placed in a time range, optionally with one status, paged by row cursors (most recent first).Read-onlyQuery Orders
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.
Inputs
end_cursorinteger- Last row to return; with start_cursor=26 and end_cursor=50 you get rows 26 to 50. Defaults to 100. Example: 25.
end_timestring- Latest order placement time, ISO 8601 UTC. Example: 2026-11-15T23:59:59Z.
order_statusstring- Only orders with this status. Example: ALREADY_DELIVERED.one of
ACTIVENOT_ASSIGNEDNOT_ACCEPTEDNOT_STARTED_YETSTARTEDPICKED_UPREADY_TO_DELIVERALREADY_DELIVEREDFAILED_DELIVERYINCOMPLETE start_cursorinteger- First row to return, starting at 1. Defaults to 1. Example: 1.
start_timestring- Earliest order placement time, ISO 8601 UTC. Example: 2026-11-01T00:00:00Z.
shipday_pickup_order_getGet one takeout (customer pickup) order.Read-onlyGet Takeout Order
Get one takeout (customer pickup) order. Returns its order number, restaurant, customer, items, costs, pickup time and status.
Inputs
order_idintegerrequired- ID of the takeout order, from shipday_pickup_order_create. Example: 16039690.
shipday_carrier_createAdd a driver (carrier) to your Shipday account; Shipday invites them to the driver app.WriteAdd Driver
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.
Inputs
emailstringrequired- Driver's email address. Example: driver@example.com.
namestringrequired- Driver's full name. Example: John Doe.
phone_numberstringrequired- Driver's phone number with country code. Example: +15551234567.
shipday_ondemand_assignHand an order to a third-party delivery service.WriteAssign to On-Demand Service
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.
Inputs
namestringrequired- Service provider name, from shipday_ondemand_services_list or the estimate. Example: DoorDash.
order_idintegerrequired- Shipday order ID to assign. Example: 16039690.
contactless_deliveryboolean- Request contactless delivery. Example: false.
estimate_referencestring- Estimate reference from shipday_ondemand_estimate_get. Example: a1b2c3d4.
pod_typestring- Proof of delivery: PHOTO, SIGNATURE, PIN or NONE. Example: PHOTO.one of
PHOTOSIGNATUREPINNONE pod_typesarray- Several proof of delivery types, for example ["PHOTO", "PIN"]. Example: ["PHOTO", "PIN"]
tipnumber- Tip for the driver. Example: 3.
shipday_ondemand_cancelCancel an order's third-party delivery.WriteCancel On-Demand Delivery
Cancel an order's third-party delivery. Returns the cancellation result. Cancellation fees may apply depending on the service and timing.
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_order_assignAssign a delivery order to one of your drivers (carriers).WriteAssign Order to Driver
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.
- Idempotent
Inputs
carrier_idintegerrequired- Driver (carrier) ID, from shipday_carriers_list. Example: 30309.
order_idintegerrequired- Shipday order ID (the numeric orderId, not the order number), from shipday_orders_active_list or shipday_order_get. Example: 16039690.
shipday_order_createCreate a delivery order in Shipday for dispatch to a driver.WriteCreate Delivery Order
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.
Inputs
customer_addressstringrequired- Delivery address. Example: 556 Crestlake Dr, San Francisco, CA 94132, USA.
customer_namestringrequired- Customer's name. Example: Jane Mason.
customer_phone_numberstringrequired- Customer's phone number with country code. Example: +14152392212.
order_numberstringrequired- Your identifier for the order. Example: 99qT5A.
restaurant_addressstringrequired- Pickup address. Example: 890 Geneva Ave, San Francisco, CA 94112, USA.
restaurant_namestringrequired- Name of the pickup business (restaurant or store). Example: Kenny's Cafe.
additional_idstring- Your additional reference ID. Example: 4532.
client_restaurant_idinteger- Client restaurant ID. Example: 12.
credit_card_idinteger- Last four digits of the card when paid by card. Example: 1234.
credit_card_typestring- Card type when paid by card: VISA, MASTER_CARD, AMEX or OTHER. Example: VISA.
customer_emailstring- Customer's email address. Example: jane@example.com.
delivery_feenumber- Delivery fee. Example: 3.
delivery_instructionstring- Instructions for the driver. Example: Ring the bell twice.
delivery_latitudenumber- Delivery latitude. Example: 37.7106.
delivery_longitudenumber- Delivery longitude. Example: -122.4793.
delivery_window_in_minutesinteger- Delivery window in minutes (positive). Example: 30.
discount_amountnumber- Discount amount. Example: 1.0.
dropoffobject- 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_datestring- Expected delivery date in UTC (YYYY-MM-DD). Example: 2026-11-20.
expected_delivery_timestring- Expected delivery time in UTC (hh:mm:ss). Example: 18:30:00.
expected_pickup_timestring- Expected pickup time in UTC (hh:mm:ss). Example: 17:45:00.
is_cateringboolean- Mark the order as a catering order. Example: false.
order_itemsarray- 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_sourcestring- Where the order came from. Example: Website.
payment_methodstring- Payment method, for example cash or credit_card. Example: credit_card.
pickupobject- 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_instructionstring- Instructions for the pickup. Example: Ask for the order at the counter.
pickup_latitudenumber- Pickup latitude. Example: 37.7219.
pickup_longitudenumber- Pickup longitude. Example: -122.4442.
restaurant_phone_numberstring- Pickup business phone number with country code. Example: +14152392013.
taxnumber- Tax amount. Example: 1.5.
tipnumber- Tip amount. Example: 2.5.
total_order_costnumber- Total cost of the order. Example: 13.47.
shipday_order_editReplace a delivery order's details (customer, pickup, times, items and costs).WriteEdit Delivery Order
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.
- Idempotent
Inputs
customer_addressstringrequired- Delivery address. Example: 556 Crestlake Dr, San Francisco, CA 94132, USA.
customer_emailstringrequired- Customer's email address. Example: jane@example.com.
customer_namestringrequired- Customer's name. Example: Jane Mason.
customer_phone_numberstringrequired- Customer's phone number with country code. Example: +14152392212.
order_idintegerrequired- Shipday order ID (the numeric orderId, not the order number), from shipday_orders_active_list or shipday_order_get. Example: 16039690.
order_numberstringrequired- Your identifier for the order. Example: 99qT5A.
restaurant_addressstringrequired- Pickup address. Example: 890 Geneva Ave, San Francisco, CA 94112, USA.
restaurant_namestringrequired- Name of the pickup business (restaurant or store). Example: Kenny's Cafe.
additional_idstring- Your additional reference ID. Example: 4532.
body_order_idinteger- 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_idinteger- Client restaurant ID. Example: 12.
credit_card_idinteger- Last four digits of the card when paid by card. Example: 1234.
credit_card_typestring- Card type when paid by card: VISA, MASTER_CARD, AMEX or OTHER. Example: VISA.
delivery_feenumber- Delivery fee. Example: 3.
delivery_instructionstring- Instructions for the driver. Example: Ring the bell twice.
delivery_latitudenumber- Delivery latitude. Example: 37.7106.
delivery_longitudenumber- Delivery longitude. Example: -122.4793.
delivery_window_in_minutesinteger- Delivery window in minutes (positive). Leave out to keep the current value. Example: 30.
discount_amountnumber- Discount amount. Example: 1.0.
dropoffobject- 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_datestring- Expected delivery date in UTC (YYYY-MM-DD). Example: 2026-11-20.
expected_delivery_timestring- Expected delivery time in UTC (hh:mm:ss). Example: 18:30:00.
expected_pickup_timestring- Expected pickup time in UTC (hh:mm:ss). Example: 17:45:00.
order_itemsarray- 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_sourcestring- Where the order came from. Example: Website.
payment_methodstring- Payment method, for example cash or credit_card. Example: credit_card.
pickupobject- 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_latitudenumber- Pickup latitude. Example: 37.7219.
pickup_longitudenumber- Pickup longitude. Example: -122.4442.
restaurant_phone_numberstring- Pickup business phone number with country code. Example: +14152392013.
taxnumber- Tax amount. Example: 1.5.
tipnumber- Tip amount. Example: 2.5.
total_coststring- Total cost of the order, as a string. Example: 13.47.
shipday_order_ready_to_pickup_setMark a delivery order as ready (or not ready) for the driver to pick up.WriteSet Order Ready to Pickup
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.
- Idempotent
Inputs
order_idintegerrequired- Shipday order ID (the numeric orderId, not the order number), from shipday_orders_active_list or shipday_order_get. Example: 16039690.
ready_to_pickupbooleanrequired- true when the order is ready for pickup. Example: true.
shipday_order_status_updateSet a delivery order's status (started, picked up, ready to deliver, delivered, incomplete or failed).WriteUpdate Order Status
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.
- Idempotent
Inputs
order_idintegerrequired- Shipday order ID (the numeric orderId, not the order number), from shipday_orders_active_list or shipday_order_get. Example: 16039690.
statusstringrequired- New status. Example: PICKED_UP.one of
STARTEDPICKED_UPREADY_TO_DELIVERALREADY_DELIVEREDINCOMPLETEFAILED_DELIVERY
shipday_order_unassignRemove the driver assignment from a delivery order.WriteUnassign Order from Driver
Remove the driver assignment from a delivery order. Returns the result. Use shipday_order_assign to assign another driver.
- Idempotent
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_pickup_order_createCreate a takeout (customer pickup) order in Shipday.WriteCreate Takeout Order
Create a takeout (customer pickup) order in Shipday. Returns the new takeout order's ID. Use shipday_order_create for delivery orders.
Inputs
customer_namestringrequired- Customer's name. Example: Jane Mason.
customer_phonestringrequired- Customer's phone number with country code. Example: +14152392212.
order_numberstringrequired- Your identifier for the takeout order. Example: 99qT5A.
restaurant_addressstringrequired- Address of the business. Example: 890 Geneva Ave, San Francisco, CA 94112, USA.
restaurant_namestringrequired- Name of the business preparing the order. Example: Kenny's Cafe.
additional_idstring- Your additional reference ID. Example: 4532.
customer_emailstring- Customer's email address. Example: jane@example.com.
discount_amountnumber- Discount amount. Example: 1.0.
expected_pickup_datestring- Expected pickup date in UTC (YYYY-MM-DD). Example: 2026-11-20.
expected_pickup_timestring- Expected pickup time in UTC (hh:mm:ss). Example: 20:45:00.
order_itemsarray- 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_sourcestring- Where the order came from. Example: Website.
payment_methodstring- Payment method: CARD, CASH or ONLINE. Example: CARD.one of
CARDCASHONLINE pickup_instructionstring- Instructions for the pickup. Example: Ask at the counter.
restaurant_phonestring- Business phone number with country code. Example: +14152392013.
taxnumber- Tax amount. Example: 1.5.
tipsnumber- Tip amount. Example: 2.5.
total_order_costnumber- Total cost of the order. Example: 13.47.
shipday_pickup_order_updateReplace a takeout order's details or change its status (IN_PROGRESS, READY, DONE or CANCEL).WriteUpdate Takeout Order
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.
- Idempotent
Inputs
customer_namestringrequired- Customer's name. Example: Jane Mason.
customer_phonestringrequired- Customer's phone number with country code. Example: +14152392212.
order_idintegerrequired- ID of the takeout order. Example: 16039690.
order_numberstringrequired- Your identifier for the takeout order. Example: 99qT5A.
restaurant_addressstringrequired- Address of the business. Example: 890 Geneva Ave, San Francisco, CA 94112, USA.
restaurant_namestringrequired- Name of the business preparing the order. Example: Kenny's Cafe.
additional_idstring- Your additional reference ID. Example: 4532.
company_idinteger- Shipday company ID the order belongs to. Example: 130616.
customer_emailstring- Customer's email address. Example: jane@example.com.
discount_amountnumber- Discount amount. Example: 1.0.
expected_pickup_datestring- Expected pickup date in UTC (YYYY-MM-DD). Example: 2026-11-20.
expected_pickup_timestring- Expected pickup time in UTC (hh:mm:ss). Example: 20:45:00.
order_itemsarray- 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_sourcestring- Where the order came from. Example: Website.
payment_methodstring- Payment method: CARD, CASH or ONLINE. Example: CARD.one of
CARDCASHONLINE pickup_instructionstring- Instructions for the pickup. Example: Ask at the counter.
restaurant_latitudenumber- Business latitude. Example: 37.4832505.
restaurant_longitudenumber- Business longitude. Example: -122.1743908.
restaurant_phonestring- Business phone number with country code. Example: +14152392013.
statusstring- Takeout order status: IN_PROGRESS, READY, DONE or CANCEL. Example: READY.one of
IN_PROGRESSREADYDONECANCEL taxnumber- Tax amount. Example: 1.5.
tipsnumber- Tip amount. Example: 2.5.
total_order_costnumber- Total cost of the order. Example: 13.47.
shipday_carrier_deleteRemove a driver (carrier) from your Shipday account.DestructiveDelete Driver
Remove a driver (carrier) from your Shipday account. Returns an empty success response. This cannot be undone.
- Idempotent
Inputs
carrier_idintegerrequired- Driver (carrier) ID, from shipday_carriers_list. Example: 30309.
shipday_order_deleteDelete a delivery order.DestructiveDelete Order
Delete a delivery order. Returns an empty success response. This cannot be undone.
- Idempotent
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_pickup_order_deleteDelete a takeout order.DestructiveDelete Takeout Order
Delete a takeout order. Returns an empty success response. This cannot be undone.
- Idempotent
Inputs
order_idintegerrequired- ID of the takeout order. Example: 16039690.
No tools match.