Shipday integration guide
VerifiedHow to connect Shipday to WEXTL and use its 2 triggers and 27 actions in your workflows. About Shipday: Delivery management for dispatching and tracking local orders.
- 2 triggers
- 12 searches
- 15 actions
- Instant (webhooks)
- Auth: API key
AI-assisted documentation13 min read
This documentation is compiled from our integration source code, internal specs for Shipday, its official API documentation and anonymized requests logs we collect from our support team[2].
Requirements
Get your Shipday credentials
Shipday - API Key
- API KeypasswordRequired
In the dispatch dashboard open My Account and copy the API key.[1]
Shipday - Partner Key
- Partner KeypasswordRequired
Only for Shipday partner accounts. Ask Shipday for a partner API key.[1]
Connect Shipday in WEXTL
- Log in to your WEXTL account, add the Shipday node module to your workflow, and click Create new credential.Instant triggers use webhooks. Click Create a webhook first when adding one, then create the credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Shipday account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Shipday triggers and actions on WEXTL
The list below is a reference of every Shipday node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Open any Shipday node module below to inspect its input parameters, outputs, and connection requirements.
Watch Events
TriggerInstant webhook for Shipday order and driver events.
| Field | Type |
|---|---|
| Timestamp | number |
| Event | text |
| Order Status | text |
| Order | object |
| ID | number |
| Order Number | text |
| Provider | text |
| Order Item | array |
| Delivery Note | text |
| Order Source | text |
| Payment Method | text |
| Total Cost | number |
| Delivery Fee | number |
| Predefined Tip | number |
| Company | object |
| ID | number |
| Name | text |
| Carrier | object |
| ID | number |
| Name | text |
| Phone | text |
| text | |
| Pickup Location | object |
| Address | text |
| Latitude | number |
| Longitude | number |
| Delivery Details | object |
| Name | text |
| Address | text |
| Phone Number | text |
| text | |
| Latitude | number |
| Longitude | number |
| Order ID | number |
| Company ID | number |
| Latitude | number |
| Longitude | number |
| Current Time Stamp | number |
Watch New Orders
TriggerScheduled pull of new Shipday orders.
| Field | Type |
|---|---|
| Order ID | number |
| Order Number | text |
| Company ID | number |
| Order Item | text |
| Accepted | boolean |
| Placement Time | date |
| Requested Pickup Time | date |
| Requested Delivery Time | date |
| Assigned Time | date |
| Start Time | date |
| Pickedup Time | date |
| Arrived Time | date |
| Delivery Time | date |
| Failed Delivery Time | text |
| Delivery Note | text |
| Delivery Instruction | text |
| Dispatcher Note | text |
| Payment Method | text |
| Order Source | text |
| Additional ID | text |
12other output fields
Check Third-Party Availability
SearchCourier options and fees between two places.
| Field | Type |
|---|---|
Pickup AddressRequired | text |
Delivery AddressRequired | text |
LimitRequired | number |
| Pickup Time | date |
| Delivery Time | date |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Fee | number |
| Pickup Time | date |
| Delivery Time | date |
| Pickup Duration | number |
| Delivery Duration | number |
| Error | boolean |
| Error Code | text |
| Error Message | text |
| Error Description | text |
| Is Prod | boolean |
| Is Internal | boolean |
| Probable Assignment | boolean |
| Min Billable Fee | text |
| Regulatory Fee | number |
Get a Delivery Order
SearchDelivery order looked up by your own number.
| Field | Type |
|---|---|
Order NumberRequired | text |
| Field | Type |
|---|---|
| Order ID | number |
| Order Number | text |
| Company ID | number |
| Area ID | number |
| Customer | text |
| Restaurant | text |
| Assigned Carrier | text |
| Distance | number |
| Activity Log | text |
| Costing | text |
| Payment Method | text |
| Order Items | text |
| Assigned Carrier ID | number |
| Order Status | text |
| Tracking Link | text |
| Feedback | text |
| Schedule | boolean |
| Parent ID | number |
| Eta Time | text |
| Delivery Instruction | text |
1other output field
Get a Pickup Order
SearchDetails of a collection order.
| Field | Type |
|---|---|
Order IDRequired | text |
| Field | Type |
|---|---|
| Order Number | text |
| Restaurant | text |
| Customer | text |
| Tips | number |
| Tax | number |
| Discount Amount | number |
| Total Order Cost | number |
| Order Item | text |
| Payment Method | text |
| Pickup Instruction | text |
| Expected Pickup Date | text |
| Expected Pickup Time | text |
| Order Source | text |
| Company ID | number |
| Order ID | number |
| Status | text |
Get a Third-Party Delivery
SearchDetails of the on-demand courier booked for an order.
| Field | Type |
|---|---|
Order IDRequired | text |
| Field | Type |
|---|---|
| ID | number |
| Order ID | number |
| Company ID | number |
| Admin ID | number |
| Third Party Name | text |
| Reference ID | text |
| Reference Tag | text |
| Third Party Fee | number |
| Shipday Charge | number |
| Total Billable Amount | number |
| Charged | boolean |
| Timestamp | date |
| Inserted At | number |
| Data | text |
| Tracking URL | text |
| Driver Name | text |
| Driver Phone | text |
| Driver Lat | number |
| Driver Lng | number |
| Driver Image URL | text |
5other output fields
Get Delivery Progress
SearchLive status of a delivery in transit.
| Field | Type |
|---|---|
Tracking IDRequired | text |
| Include Static Data | boolean |
| Field | Type |
|---|---|
| Fixed Data | text |
| Dynamic Data | text |
Get Third-Party Delivery Estimates
SearchCourier quotes for an existing order.
| Field | Type |
|---|---|
Order IDRequired | text |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Fee | number |
| Pickup Time | date |
| Delivery Time | date |
| Pickup Duration | number |
| Delivery Duration | number |
| Error | boolean |
| Error Code | text |
| Error Message | text |
List Active Orders
SearchOpen orders right now.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Order ID | number |
| Order Number | text |
| Company ID | number |
| Area ID | number |
| Customer | text |
| Restaurant | text |
| Assigned Carrier | text |
| Distance | number |
| Activity Log | text |
| Costing | text |
| Payment Method | text |
| Order Items | text |
| Assigned Carrier ID | text |
| Order Status | text |
| Tracking Link | text |
| Feedback | text |
| Schedule | boolean |
| Parent ID | number |
| Eta Time | text |
| Delivery Instruction | text |
List Drivers
SearchEveryone on your driver roster.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | number |
| Personal ID | text |
| Name | text |
| Code Name | text |
| Phone Number | text |
| Company ID | number |
| Area ID | number |
| Is On Shift | boolean |
| text | |
| Carrier Photo | text |
| Is Active | boolean |
| Carrrier Location Lat | number |
| Carrrier Location Lng | number |
List Member Completed Orders
SearchFinished orders for a partner member, each with its Order Item.
| Field | Type |
|---|---|
CompanyRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| Order ID | number |
| Order Number | text |
| Company ID | number |
| Order Item | text |
| Accepted | boolean |
| Placement Time | date |
| Requested Pickup Time | date |
| Requested Delivery Time | date |
| Assigned Time | date |
| Start Time | date |
| Pickedup Time | date |
| Arrived Time | date |
| Delivery Time | date |
| Failed Delivery Time | text |
| Delivery Note | text |
| Delivery Instruction | text |
| Dispatcher Note | text |
| Payment Method | text |
| Order Source | text |
| Incomplete | boolean |
10other output fields
List Members
SearchCompanies in your partner network.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Dispatcher ID | number |
| Dispatcher Name | text |
| Company ID | number |
| Company Name | text |
| Company Address | text |
| Phone | text |
| text |
Search Orders
SearchOrders within a time window.
| Field | Type |
|---|---|
LimitRequired | number |
| From | date |
| To | date |
| Order Status | choice |
| Field | Type |
|---|---|
| Order ID | number |
| Order Number | text |
| Company ID | number |
| Order Item | text |
| Accepted | boolean |
| Placement Time | date |
| Requested Pickup Time | date |
| Requested Delivery Time | date |
| Assigned Time | date |
| Start Time | date |
| Pickedup Time | date |
| Arrived Time | date |
| Delivery Time | date |
| Failed Delivery Time | text |
| Delivery Note | text |
| Delivery Instruction | text |
| Dispatcher Note | text |
| Payment Method | text |
| Order Source | text |
| Additional ID | text |
12other output fields
Search Partner Orders
SearchOrders across partner member companies.
| Field | Type |
|---|---|
CompanyRequired | choice |
LimitRequired | number |
| From | date |
| To | date |
| Order Status | choice |
| Driver ID | text |
| Pickup ID | text |
| Field | Type |
|---|---|
| Order ID | number |
| Order Number | text |
| Company ID | number |
| Order Item | text |
| Accepted | boolean |
| Placement Time | date |
| Requested Pickup Time | date |
| Requested Delivery Time | date |
| Assigned Time | date |
| Start Time | date |
| Pickedup Time | date |
| Arrived Time | date |
| Delivery Time | date |
| Failed Delivery Time | text |
| Delivery Note | text |
| Delivery Instruction | text |
| Dispatcher Note | text |
| Payment Method | text |
| Order Source | text |
| Incomplete | boolean |
10other output fields
Assign a Third-Party Provider
ActionGives an order to an on-demand courier.
| Field | Type |
|---|---|
Provider NameRequired | text |
Order IDRequired | text |
| Tip | number |
| Estimate Reference | text |
| Contactless Delivery | boolean |
| Proof of Delivery | choice |
| Proof of Delivery Types | array |
| Type | text |
| Field | Type |
|---|---|
| ID | number |
| Order ID | number |
| Company ID | number |
| Admin ID | number |
| Third Party Name | text |
| Reference ID | text |
| Reference Tag | text |
| Third Party Fee | number |
| Shipday Charge | number |
| Total Billable Amount | number |
| Charged | boolean |
| Timestamp | date |
| Inserted At | number |
| Data | text |
| Tracking URL | text |
| Driver Name | text |
| Driver Phone | text |
| Driver Lat | number |
| Driver Lng | number |
| Driver Image URL | text |
6other output fields
Assign an Order to a Driver
ActionDispatches an order to a driver on your team.
| Field | Type |
|---|---|
Order IDRequired | text |
DriverRequired | choice |
| Field | Type |
|---|---|
| Order ID | text |
| Carrier ID | text |
| Success | boolean |
| Response | text |
Cancel a Third-Party Delivery
ActionStops an on-demand courier job.
| Field | Type |
|---|---|
Order IDRequired | text |
| Field | Type |
|---|---|
| Order ID | text |
| Success | boolean |
Create a Delivery Order
ActionNew delivery job for a customer address.
| Field | Type |
|---|---|
Order NumberRequired | text |
Customer NameRequired | text |
Customer AddressRequired | text |
Customer PhoneRequired | text |
Pickup NameRequired | text |
Pickup AddressRequired | text |
| Customer Email | text |
| Pickup Phone | text |
| Expected Delivery Date | date |
| Expected Pickup Time | text |
| Expected Delivery Time | text |
| Items | array |
| Item | object |
| Tips | number |
| Tax | number |
| Discount | number |
| Delivery Fee | number |
| Total Order Cost | number |
| Pickup Instruction | text |
| Delivery Instruction | text |
| Order Source | text |
22other input fields
| Field | Type |
|---|---|
| Success | boolean |
| Response | text |
| Order ID | number |
Create a Driver
ActionAdds a courier to your fleet.
| Field | Type |
|---|---|
NameRequired | text |
EmailRequired | text |
PhoneRequired | text |
| Field | Type |
|---|---|
| Carrier ID | number |
| text | |
| Password | text |
| Message | text |
Create a Pickup Order
ActionNew order for customer collection.
| Field | Type |
|---|---|
Order NumberRequired | text |
Pickup NameRequired | text |
Pickup AddressRequired | text |
Customer NameRequired | text |
Customer PhoneRequired | text |
| Pickup Phone | text |
| Customer Email | text |
| Tips | number |
| Tax | number |
| Discount | number |
| Total Order Cost | number |
| Items | array |
| Item | object |
| Payment Method | choice |
| Pickup Instruction | text |
| Expected Pickup Date | date |
| Expected Pickup Time | text |
| Order Source | text |
| Additional ID | text |
| Field | Type |
|---|---|
| Success | boolean |
| Order ID | number |
| Message | text |
Delete a Delivery Order
ActionDeletes a single delivery job from the account.
| Field | Type |
|---|---|
Order IDRequired | text |
| Field | Type |
|---|---|
| Order ID | text |
| Deleted | boolean |
Delete a Driver
ActionCourier roster entry removed from your account.
| Field | Type |
|---|---|
DriverRequired | choice |
| Field | Type |
|---|---|
| Carrier ID | text |
| Success | boolean |
| Response | text |
Delete a Pickup Order
ActionRemoves one customer-collection order.
| Field | Type |
|---|---|
Order IDRequired | text |
| Field | Type |
|---|---|
| Order ID | text |
| Deleted | boolean |
Make an API Call
universalFree-form Shipday REST API request.
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
| Headers | array |
| Header | object |
| Query string | array |
| Parameter | object |
| Body | text |
| Field | Type |
|---|---|
| Body | text |
| Headers | object |
| Key | text |
| Value | text |
| Status code | number |
Mark an Order Ready for Pickup
ActionSignals an order is ready for the driver.
| Field | Type |
|---|---|
Order IDRequired | text |
| Ready for Pickup | boolean |
| Field | Type |
|---|---|
| Order ID | text |
| Ready To Pickup | boolean |
Unassign an Order from a Driver
ActionReverses a driver assignment on a delivery order.
| Field | Type |
|---|---|
Order IDRequired | text |
| Field | Type |
|---|---|
| Order ID | text |
| Success | boolean |
| Response | text |
Update a Delivery Order
ActionResubmits changes to a delivery order.
| Field | Type |
|---|---|
Order IDRequired | text |
Order NumberRequired | text |
Customer NameRequired | text |
Customer AddressRequired | text |
Customer PhoneRequired | text |
Pickup NameRequired | text |
Pickup AddressRequired | text |
Customer EmailRequired | text |
| Pickup Phone | text |
| Expected Delivery Date | date |
| Expected Pickup Time | text |
| Expected Delivery Time | text |
| Items | array |
| Item | object |
| Tips | number |
| Tax | number |
| Discount | number |
| Delivery Fee | number |
| Total Cost | number |
| Delivery Instruction | text |
| Order Source | text |
22other input fields
| Field | Type |
|---|---|
| Success | boolean |
| Response | text |
Update a Pickup Order
ActionResubmits changes to a collection order.
| Field | Type |
|---|---|
Order IDRequired | text |
Order NumberRequired | text |
Pickup NameRequired | text |
Pickup AddressRequired | text |
Customer NameRequired | text |
Customer PhoneRequired | text |
| Pickup Latitude | number |
| Pickup Longitude | number |
| Pickup Phone | text |
| Customer Email | text |
| Tips | number |
| Tax | number |
| Discount | number |
| Total Order Cost | number |
| Items | array |
| Item | object |
| Payment Method | choice |
| Pickup Instruction | text |
| Expected Pickup Date | date |
| Expected Pickup Time | text |
| Order Source | text |
3other input fields
| Field | Type |
|---|---|
| Success | boolean |
| Order ID | number |
| Message | text |
Templates
Look for Shipday templates in the WEXTL template library.
Browse templates →Other commerce integrations on WEXTL
DHL[2]DHL Express shipping and cross-division shipment tracking, with rates, products, shipments, labels, pickups, customs documents and delivery status.
UnleashedCloud inventory management for products, stock, and orders.
BoxHeroInventory management for items, stock, orders, returns and grouped items.
ShipStationShipping with orders, labels, shipments and fulfillment.
OnfleetDispatch delivery tasks, workers, and routes with Onfleet.
References
- WEXTL® Shipday Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Shipday.
- WEXTL® visual workflow builder data.
Last updated: Nov 14, 2026 14:55
How we write our apps documentation
How we compile these docs: sources, the role of AI, and how we verify.


























