Skip to main content
Shipday logo
  • Category: ecommerce
  • Auth: BASIC, API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 12
  • Triggers: 0
  • Slug: SHIPDAY
  • Version: 20261101_00

Tools

Slug: SHIPDAY_ADD_A_CARRIERTool 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

string
required
Full name of the carrier/driver
string
required
Email address for the carrier account
integer
Optional unique area ID for identifying the operational area
string
Optional code name for the carrier
string
required
Phone number of the carrier with country code in E.164 format (e.g., +11234567891)
string
Optional URL reference to the carrier’s photo

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPDAY_CHECK_ON_DEMAND_AVAILABILITYTool 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

string
required
Complete pickup address as a single string (e.g., ‘350 5th Avenue, New York, NY 10118’)
string
required
Complete delivery address as a single string (e.g., ‘20 West 34th Street, New York, NY 10001’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPDAY_EDIT_DELIVERY_ORDERTool 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

number
Tip amount for the delivery
string
required
The unique order identifier to edit. This is the order ID returned when the order was created.
object
Customer information for the order.
array
List of items in the order with name, quantity, unit price, and optional details
object
Restaurant information for the order.
number
Delivery fee amount
string
Order reference number or identifier
number
Total cost of the order
string
Expected pickup time
string
Special instructions for the delivery
string
Expected delivery date in ISO format
string
Expected delivery time

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPDAY_GET_ON_DEMAND_ESTIMATETool 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

string
required
The identifier for the delivery order to get estimates for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPDAY_GET_ON_DEMAND_SERVICESTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPDAY_INSERT_ORDERTool 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

number
Tax amount
number
Tip/gratuity amount
number
Cash tip amount
array
required
Array of order items with name, unitPrice, and quantity
number
Delivery/shipping fee
string
required
Unique order reference number from customer platform
string
Origin of the order (e.g., ‘Seamless’, ‘Website’)
string
Secondary reference identifier
string
Credit card reference identifier
string
required
Full name of the recipient
integer
Restaurant identifier
string
required
Customer email address
string ("cash" | "credit_card" | "CASH" | "CARD" | "ONLINE" | "CREDIT_CARD" | "CARD_PHONE")
Payment method. Must be one of: cash, credit_card, CASH, CARD, ONLINE, CREDIT_CARD, CARD_PHONE
string ("visa" | "master_card" | "AMEX" | "other")
Type of credit card. Must be one of: visa, master_card, AMEX, other
number
Applied discount amount
number
Pickup location latitude coordinate
string
required
Business/pickup location name
number
required
Total order amount
string
required
Complete delivery address
number
Pickup location longitude coordinate
number
Delivery location latitude coordinate
number
Delivery location longitude coordinate
string
Pickup-related instructions
string
required
Pickup location address
string
Client’s internal restaurant identifier
string
required
Pickup time in YYYY-MM-DD HH:MM format or HH:MM:SS format
string
required
Customer phone number with country code
string
Special delivery instructions or notes
string
required
Target delivery date in YYYY-MM-DD format
string
required
Delivery time in YYYY-MM-DD HH:MM format or HH:MM:SS format
string
required
Business contact phone number

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPDAY_ORDER_READY_TO_PICKUPSet a delivery order’s ready-for-pickup flag in Shipday, marking it ready or not ready for driver pickup.

Input Parameters

string
required
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.
boolean
Boolean flag indicating whether the order is ready for pickup. Set to true to mark the order as ready.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPDAY_QUERY_DELIVERY_ORDERSTool 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

string
End time for the query in UTC ISO 8601 format (e.g., ‘2023-12-04T00:00:00Z’). Filters orders up to this timestamp.
integer
Ending cursor for pagination (e.g., 2). Defines the end boundary for the paginated result set.
string
Start time for the query in UTC ISO 8601 format (e.g., ‘2023-11-28T00:00:00Z’). Filters orders from this timestamp onwards.
integer
Starting cursor for pagination (e.g., 1). Used to paginate through result sets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPDAY_RETRIEVE_ACTIVE_ORDERSTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPDAY_RETRIEVE_CARRIERSTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPDAY_RETRIEVE_ORDER_DETAILSTool 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

string
required
The order reference identifier to retrieve details for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHIPDAY_UNASSIGN_ORDER_FROM_DRIVERTool 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

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not