# Shipday — how to use (mcp.ai)

Connect your Shipday account and use 12 tools for ecommerce straight from your AI agent. Connect with your own API key. Making Local Deliveries Easy Globally - Powering Local E-commerce.

## Option A — via MCP (recommended)
Remote MCP endpoint (HTTP, streamable): `https://api.mcp.ai/p_shipday?ms=1787295840000`
Add it as a custom/remote MCP connector in your client (Claude, Cursor, VS Code…), then authenticate when prompted. Once connected, ask the agent to use the server's tools (e.g. `shipday_add_a_carrier`).

## Option B — via direct REST API
Base URL: `https://api.mcp.ai/api/shipday`
Auth: `Authorization: Bearer sk_live_…` — create a workspace API key at https://mcp.ai/settings/api-keys
Discover endpoints: `GET https://api.mcp.ai/api/shipday/_endpoints`

### Endpoints
- `POST https://api.mcp.ai/api/shipday/add/a/carrier` — Tool to add a new carrier/driver to the Shipday system with credentials. Use when you need to create a new carrier account with name, email, and phone number.
  - body: { name: string, email: string, areaId?: integer, codeName?: string, phoneNumber: string, carrierPhoto?: string }
- `POST https://api.mcp.ai/api/shipday/check/on/demand/availability` — Tool to check on-demand delivery availability from third-party service providers. Use when you need to verify service availability, pricing estimates, and delivery times for a route without creating a
  - body: { pickupAddress: string, deliveryAddress: string }
- `POST https://api.mcp.ai/api/shipday/edit/delivery/order` — Tool to edit an existing delivery order in Shipday. Use when you need to update order details such as customer information, restaurant details, order items, delivery fees, or tips.
  - body: { tip?: number, orderId: string, customer?: object, orderItems?: object[], restaurant?: object, deliveryFee?: number, orderNumber?: string, totalOrderCost?: number, expectedPickupTime?: string, deliveryInstruction?: string, expectedDeliveryDate?: string, expectedDeliveryTime?: string }
- `POST https://api.mcp.ai/api/shipday/get/on/demand/estimate` — Tool to get on-demand delivery estimates from third-party service providers for a specific order. Use when you need to retrieve pricing, pickup/delivery times, and durations for a delivery order.
  - body: { orderId: string }
- `POST https://api.mcp.ai/api/shipday/get/on/demand/services` — Tool to retrieve available third-party on-demand delivery service providers. Use when you need to check which delivery services are available or enabled for the account.
- `POST https://api.mcp.ai/api/shipday/insert/order` — Tool to create a new delivery order in Shipday. Use when you need to insert a delivery order with customer details, restaurant information, order items, and delivery schedule.
  - body: { tax?: number, tips?: number, cashTips?: number, orderItems: object[], deliveryFee?: number, orderNumber: string, orderSource?: string, additionalId?: string, creditCardId?: string, customerName: string, restaurantId?: integer, customerEmail: string, paymentMethod?: string, creditCardType?: string, discountAmount?: number, pickupLatitude?: number, restaurantName: string, totalOrderCost: number, customerAddress: string, pickupLongitude?: number, deliveryLatitude?: number, deliveryLongitude?: number, pickupInstruction?: string, restaurantAddress: string, clientRestaurantId?: string, expectedPickupTime: string, customerPhoneNumber: string, deliveryInstruction?: string, expectedDeliveryDate: string, expectedDeliveryTime: string, restaurantPhoneNumber: string }
- `POST https://api.mcp.ai/api/shipday/order/ready/to/pickup` — Tool to mark a delivery order as ready for pickup. Use when you need to notify Shipday that an order is prepared and ready for driver pickup at a specific time.
  - body: { orderId: string, readyToPickup?: boolean }
- `POST https://api.mcp.ai/api/shipday/query/delivery/orders` — Tool to query delivery orders with time-based filters and cursor pagination. Use when you need to retrieve multiple orders within a specific time range or paginate through order results.
  - body: { endTime?: string, endCursor?: integer, startTime?: string, startCursor?: integer }
- `POST https://api.mcp.ai/api/shipday/retrieve/active/orders` — Tool to retrieve all active delivery orders from Shipday system. Use when you need to get currently active orders (excludes ALREADY_DELIVERED, FAILED_DELIVERY, and INCOMPLETE orders). Returns at most 
- `POST https://api.mcp.ai/api/shipday/retrieve/carriers` — Tool to retrieve all carriers/drivers with profile and status details. Use when you need to get a list of all carriers in the system.
- `POST https://api.mcp.ai/api/shipday/retrieve/order/details` — Tool to retrieve detailed information for a specific delivery order by order number. Use when you need to get comprehensive order details including customer info, restaurant info, carrier assignment, 
  - body: { order_number: string }
- `POST https://api.mcp.ai/api/shipday/unassign/order/from/driver` — Tool to remove driver assignment from a delivery order. Use when you need to unassign a driver from an order to make it available for reassignment to a different driver.
  - body: { orderId: string }

## Example prompts
- "What can I do in Shipday?"
- "Show me a summary of my Shipday account"

## More
- Page: https://mcp.ai/shipday
- Agent spec (llms.txt): https://mcp.ai/shipday/llms.txt
- Postman collection: https://mcp.ai/shipday/postman.json