NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Shipday connects to a Nagent workspace. Once it is connected, agents can call 12 Shipday actions, such as "Add a Carrier", "Get On-Demand Delivery Estimate" and "Get On-Demand Delivery Services". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Shipday, with input parameters and output schema.
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
Full name of the carrier/driver
Email address for the carrier account
Optional unique area ID for identifying the operational area
Optional code name for the carrier
Phone number of the carrier with country code in E.164 format (e.g., +11234567891)
Optional URL reference to the carrier's photo
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Complete pickup address as a single string (e.g., '350 5th Avenue, New York, NY 10118')
Complete delivery address as a single string (e.g., '20 West 34th Street, New York, NY 10001')
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Tip amount for the delivery
The unique order identifier to edit. This is the order ID returned when the order was created.
Customer information for the order.
List of items in the order with name, quantity, unit price, and optional details
Restaurant information for the order.
Delivery fee amount
Order reference number or identifier
Total cost of the order
Expected pickup time
Special instructions for the delivery
Expected delivery date in ISO format
Expected delivery time
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The identifier for the delivery order to get estimates for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Tax amount
Tip/gratuity amount
Cash tip amount
Array of order items with name, unitPrice, and quantity
Delivery/shipping fee
Unique order reference number from customer platform
Origin of the order (e.g., 'Seamless', 'Website')
Secondary reference identifier
Credit card reference identifier
Full name of the recipient
Restaurant identifier
Customer email address
Payment method. Must be one of: cash, credit_card, CASH, CARD, ONLINE, CREDIT_CARD, CARD_PHONE
Type of credit card. Must be one of: visa, master_card, AMEX, other
Applied discount amount
Pickup location latitude coordinate
Business/pickup location name
Total order amount
Complete delivery address
Pickup location longitude coordinate
Delivery location latitude coordinate
Delivery location longitude coordinate
Pickup-related instructions
Pickup location address
Client's internal restaurant identifier
Pickup time in YYYY-MM-DD HH:MM format or HH:MM:SS format
Customer phone number with country code
Special delivery instructions or notes
Target delivery date in YYYY-MM-DD format
Delivery time in YYYY-MM-DD HH:MM format or HH:MM:SS format
Business contact phone number
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SHIPDAY_ORDER_READY_TO_PICKUPTool 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
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 flag indicating whether the order is ready for pickup. Set to true to mark the order as ready.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
End time for the query in UTC ISO 8601 format (e.g., '2023-12-04T00:00:00Z'). Filters orders up to this timestamp.
Ending cursor for pagination (e.g., 2). Defines the end boundary for the paginated result set.
Start time for the query in UTC ISO 8601 format (e.g., '2023-11-28T00:00:00Z'). Filters orders from this timestamp onwards.
Starting cursor for pagination (e.g., 1). Used to paginate through result sets.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The order reference identifier to retrieve details for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 12 Shipday actions on Nagent, including "Add a Carrier", "Get On-Demand Delivery Estimate" and "Get On-Demand Delivery Services". Add a Carrier: Add a new carrier/driver to the Shipday system with credentials. Each action is listed on this page with its input parameters and its output.
Add a Carrier takes 3 required inputs: name, email and phoneNumber. It also takes 3 optional inputs: areaId, codeName and carrierPhoto. It returns data, error and successful.