# Shipday

Making Local Deliveries Easy Globally - Powering Local E-commerce

- **Category:** ecommerce
- **Auth:** API_KEY, API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 12
- **Triggers:** 0
- **Slug:** `SHIPDAY`
- **Version:** 20260312_00

## Tools

### Add a Carrier

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Full name of the carrier/driver |
| `email` | string | Yes | Email address for the carrier account |
| `areaId` | integer | No | Optional unique area ID for identifying the operational area |
| `codeName` | string | No | Optional code name for the carrier |
| `carrierPhoto` | string | No | Optional URL reference to the carrier's photo |
| `phone_number` | string | Yes | Phone number of the carrier with country code in E.164 format (e.g., +11234567891) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check On-Demand Delivery Availability

**Slug:** `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 an order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pickupAddress` | string | Yes | Complete pickup address as a single string (e.g., '350 5th Avenue, New York, NY 10118') |
| `deliveryAddress` | string | Yes | Complete delivery address as a single string (e.g., '20 West 34th Street, New York, NY 10001') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Delivery Order

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tip` | number | No | Tip amount for the delivery |
| `orderId` | string | Yes | The unique order identifier to edit. This is the order ID returned when the order was created. |
| `customer` | object | No | Customer information for the order. |
| `orderItems` | array | No | List of items in the order with name, quantity, unit price, and optional details |
| `restaurant` | object | No | Restaurant information for the order. |
| `deliveryFee` | number | No | Delivery fee amount |
| `orderNumber` | string | No | Order reference number or identifier |
| `totalOrderCost` | number | No | Total cost of the order |
| `expectedPickupTime` | string | No | Expected pickup time |
| `deliveryInstruction` | string | No | Special instructions for the delivery |
| `expectedDeliveryDate` | string | No | Expected delivery date in ISO format |
| `expectedDeliveryTime` | string | No | Expected delivery time |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get On-Demand Delivery Estimate

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `orderId` | string | Yes | The identifier for the delivery order to get estimates for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get On-Demand Delivery Services

**Slug:** `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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Insert Order

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tax` | number | No | Tax amount |
| `tips` | number | No | Tip/gratuity amount |
| `cashTips` | number | No | Cash tip amount |
| `orderItems` | array | Yes | Array of order items with name, unitPrice, and quantity |
| `deliveryFee` | number | No | Delivery/shipping fee |
| `orderNumber` | string | Yes | Unique order reference number from customer platform |
| `orderSource` | string | No | Origin of the order (e.g., 'Seamless', 'Website') |
| `additionalId` | string | No | Secondary reference identifier |
| `creditCardId` | string | No | Credit card reference identifier |
| `customerName` | string | Yes | Full name of the recipient |
| `restaurantId` | integer | No | Restaurant identifier |
| `customerEmail` | string | Yes | Customer email address |
| `paymentMethod` | string ("cash" | "credit_card" | "CASH" | "CARD" | "ONLINE" | "CREDIT_CARD" | "CARD_PHONE") | No | Payment method. Must be one of: cash, credit_card, CASH, CARD, ONLINE, CREDIT_CARD, CARD_PHONE |
| `creditCardType` | string ("visa" | "master_card" | "AMEX" | "other") | No | Type of credit card. Must be one of: visa, master_card, AMEX, other |
| `discountAmount` | number | No | Applied discount amount |
| `pickupLatitude` | number | No | Pickup location latitude coordinate |
| `restaurantName` | string | Yes | Business/pickup location name |
| `totalOrderCost` | number | Yes | Total order amount |
| `customerAddress` | string | Yes | Complete delivery address |
| `pickupLongitude` | number | No | Pickup location longitude coordinate |
| `deliveryLatitude` | number | No | Delivery location latitude coordinate |
| `deliveryLongitude` | number | No | Delivery location longitude coordinate |
| `pickupInstruction` | string | No | Pickup-related instructions |
| `restaurantAddress` | string | Yes | Pickup location address |
| `clientRestaurantId` | string | No | Client's internal restaurant identifier |
| `expectedPickupTime` | string | Yes | Pickup time in YYYY-MM-DD HH:MM format or HH:MM:SS format |
| `customerPhoneNumber` | string | Yes | Customer phone number with country code |
| `deliveryInstruction` | string | No | Special delivery instructions or notes |
| `expectedDeliveryDate` | string | Yes | Target delivery date in YYYY-MM-DD format |
| `expectedDeliveryTime` | string | Yes | Delivery time in YYYY-MM-DD HH:MM format or HH:MM:SS format |
| `restaurantPhoneNumber` | string | Yes | Business contact phone number |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Order Ready to Pickup

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `orderId` | string | Yes | Unique identifier for the delivery order to be marked as ready for pickup. This is the order ID returned when the order was created or can be retrieved from order details. |
| `readyToPickup` | boolean | No | Boolean flag indicating whether the order is ready for pickup. Set to true to mark the order as ready. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query Delivery Orders

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `endTime` | string | No | End time for the query in UTC ISO 8601 format (e.g., '2023-12-04T00:00:00Z'). Filters orders up to this timestamp. |
| `endCursor` | integer | No | Ending cursor for pagination (e.g., 2). Defines the end boundary for the paginated result set. |
| `startTime` | string | No | Start time for the query in UTC ISO 8601 format (e.g., '2023-11-28T00:00:00Z'). Filters orders from this timestamp onwards. |
| `startCursor` | integer | No | Starting cursor for pagination (e.g., 1). Used to paginate through result sets. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Active Orders

**Slug:** `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 100 orders at a time.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Carriers

**Slug:** `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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Order Details

**Slug:** `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, cost breakdown, order items, status, and tracking information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_number` | string | Yes | The order reference identifier to retrieve details for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unassign Order from Driver

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `orderId` | string | Yes | Unique identifier for the delivery order to be unassigned from its current driver. This ID is returned when the order is placed and can be retrieved from order placement responses or via the delivery order details. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |