Skip to docs navigation

Shipday integration guide

Verified

How 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].

Open Shipday on WEXTL →
  • Shipday
  • WEXTL
  • DHL
  • Unleashed
  • BoxHero
  • ShipStation
  • Onfleet
  • Shippo
  • Chowdeck
  • BigCommerce
  • ShipEngine
  • MemberPress
  • Gift Up
  • Booqable
  • Recharge
  • Glovo
  • SamCart
  • Speedaf Express
  • Ticket Tailor
  • Printavo
  • Zid
  • Loyverse
  • Salla
  • Patreon
  • Hotmart
  • Lightspeed Retail
  • Amazon Seller Partner
  • Sharetribe
Credential type option 1

Shipday - API Key

  • API KeypasswordRequired

    In the dispatch dashboard open My Account and copy the API key.[1]

Credential type option 2

Shipday - Partner Key

  • Partner KeypasswordRequired

    Only for Shipday partner accounts. Ask Shipday for a partner API key.[1]

  1. 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.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Shipday account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Watch Events

TriggerInstant webhook for Shipday order and driver events.
Output fields[3]
FieldType
Timestampnumber
Eventtext
Order Statustext
Orderobject
IDnumber
Order Numbertext
Providertext
Order Itemarray
Delivery Notetext
Order Sourcetext
Payment Methodtext
Total Costnumber
Delivery Feenumber
Predefined Tipnumber
Companyobject
IDnumber
Nametext
Carrierobject
IDnumber
Nametext
Phonetext
Emailtext
Pickup Locationobject
Addresstext
Latitudenumber
Longitudenumber
Delivery Detailsobject
Nametext
Addresstext
Phone Numbertext
Emailtext
Latitudenumber
Longitudenumber
Order IDnumber
Company IDnumber
Latitudenumber
Longitudenumber
Current Time Stampnumber

Watch New Orders

TriggerScheduled pull of new Shipday orders.
Output fields[3]
FieldType
Order IDnumber
Order Numbertext
Company IDnumber
Order Itemtext
Acceptedboolean
Placement Timedate
Requested Pickup Timedate
Requested Delivery Timedate
Assigned Timedate
Start Timedate
Pickedup Timedate
Arrived Timedate
Delivery Timedate
Failed Delivery Timetext
Delivery Notetext
Delivery Instructiontext
Dispatcher Notetext
Payment Methodtext
Order Sourcetext
Additional IDtext

12other output fields

Check Third-Party Availability

SearchCourier options and fees between two places.
Input fields[3]
FieldType
Pickup AddressRequired
text
Delivery AddressRequired
text
LimitRequired
number
Pickup Timedate
Delivery Timedate
Output fields[3]
FieldType
IDtext
Nametext
Feenumber
Pickup Timedate
Delivery Timedate
Pickup Durationnumber
Delivery Durationnumber
Errorboolean
Error Codetext
Error Messagetext
Error Descriptiontext
Is Prodboolean
Is Internalboolean
Probable Assignmentboolean
Min Billable Feetext
Regulatory Feenumber

Get a Delivery Order

SearchDelivery order looked up by your own number.
Input fields[3]
FieldType
Order NumberRequired
text
Output fields[3]
FieldType
Order IDnumber
Order Numbertext
Company IDnumber
Area IDnumber
Customertext
Restauranttext
Assigned Carriertext
Distancenumber
Activity Logtext
Costingtext
Payment Methodtext
Order Itemstext
Assigned Carrier IDnumber
Order Statustext
Tracking Linktext
Feedbacktext
Scheduleboolean
Parent IDnumber
Eta Timetext
Delivery Instructiontext

1other output field

Get a Pickup Order

SearchDetails of a collection order.
Input fields[3]
FieldType
Order IDRequired
text
Output fields[3]
FieldType
Order Numbertext
Restauranttext
Customertext
Tipsnumber
Taxnumber
Discount Amountnumber
Total Order Costnumber
Order Itemtext
Payment Methodtext
Pickup Instructiontext
Expected Pickup Datetext
Expected Pickup Timetext
Order Sourcetext
Company IDnumber
Order IDnumber
Statustext

Get a Third-Party Delivery

SearchDetails of the on-demand courier booked for an order.
Input fields[3]
FieldType
Order IDRequired
text
Output fields[3]
FieldType
IDnumber
Order IDnumber
Company IDnumber
Admin IDnumber
Third Party Nametext
Reference IDtext
Reference Tagtext
Third Party Feenumber
Shipday Chargenumber
Total Billable Amountnumber
Chargedboolean
Timestampdate
Inserted Atnumber
Datatext
Tracking URLtext
Driver Nametext
Driver Phonetext
Driver Latnumber
Driver Lngnumber
Driver Image URLtext

5other output fields

Get Delivery Progress

SearchLive status of a delivery in transit.
Input fields[3]
FieldType
Tracking IDRequired
text
Include Static Databoolean
Output fields[3]
FieldType
Fixed Datatext
Dynamic Datatext

Get Third-Party Delivery Estimates

SearchCourier quotes for an existing order.
Input fields[3]
FieldType
Order IDRequired
text
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Feenumber
Pickup Timedate
Delivery Timedate
Pickup Durationnumber
Delivery Durationnumber
Errorboolean
Error Codetext
Error Messagetext

List Active Orders

SearchOpen orders right now.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Order IDnumber
Order Numbertext
Company IDnumber
Area IDnumber
Customertext
Restauranttext
Assigned Carriertext
Distancenumber
Activity Logtext
Costingtext
Payment Methodtext
Order Itemstext
Assigned Carrier IDtext
Order Statustext
Tracking Linktext
Feedbacktext
Scheduleboolean
Parent IDnumber
Eta Timetext
Delivery Instructiontext

List Drivers

SearchEveryone on your driver roster.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDnumber
Personal IDtext
Nametext
Code Nametext
Phone Numbertext
Company IDnumber
Area IDnumber
Is On Shiftboolean
Emailtext
Carrier Phototext
Is Activeboolean
Carrrier Location Latnumber
Carrrier Location Lngnumber

List Member Completed Orders

SearchFinished orders for a partner member, each with its Order Item.
Input fields[3]
FieldType
CompanyRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Order IDnumber
Order Numbertext
Company IDnumber
Order Itemtext
Acceptedboolean
Placement Timedate
Requested Pickup Timedate
Requested Delivery Timedate
Assigned Timedate
Start Timedate
Pickedup Timedate
Arrived Timedate
Delivery Timedate
Failed Delivery Timetext
Delivery Notetext
Delivery Instructiontext
Dispatcher Notetext
Payment Methodtext
Order Sourcetext
Incompleteboolean

10other output fields

List Members

SearchCompanies in your partner network.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Dispatcher IDnumber
Dispatcher Nametext
Company IDnumber
Company Nametext
Company Addresstext
Phonetext
Emailtext

Search Orders

SearchOrders within a time window.
Input fields[3]
FieldType
LimitRequired
number
Fromdate
Todate
Order Statuschoice
Output fields[3]
FieldType
Order IDnumber
Order Numbertext
Company IDnumber
Order Itemtext
Acceptedboolean
Placement Timedate
Requested Pickup Timedate
Requested Delivery Timedate
Assigned Timedate
Start Timedate
Pickedup Timedate
Arrived Timedate
Delivery Timedate
Failed Delivery Timetext
Delivery Notetext
Delivery Instructiontext
Dispatcher Notetext
Payment Methodtext
Order Sourcetext
Additional IDtext

12other output fields

Search Partner Orders

SearchOrders across partner member companies.
Input fields[3]
FieldType
CompanyRequired
choice
LimitRequired
number
Fromdate
Todate
Order Statuschoice
Driver IDtext
Pickup IDtext
Output fields[3]
FieldType
Order IDnumber
Order Numbertext
Company IDnumber
Order Itemtext
Acceptedboolean
Placement Timedate
Requested Pickup Timedate
Requested Delivery Timedate
Assigned Timedate
Start Timedate
Pickedup Timedate
Arrived Timedate
Delivery Timedate
Failed Delivery Timetext
Delivery Notetext
Delivery Instructiontext
Dispatcher Notetext
Payment Methodtext
Order Sourcetext
Incompleteboolean

10other output fields

Assign a Third-Party Provider

ActionGives an order to an on-demand courier.
Input fields[3]
FieldType
Provider NameRequired
text
Order IDRequired
text
Tipnumber
Estimate Referencetext
Contactless Deliveryboolean
Proof of Deliverychoice
Proof of Delivery Typesarray
Typetext
Output fields[3]
FieldType
IDnumber
Order IDnumber
Company IDnumber
Admin IDnumber
Third Party Nametext
Reference IDtext
Reference Tagtext
Third Party Feenumber
Shipday Chargenumber
Total Billable Amountnumber
Chargedboolean
Timestampdate
Inserted Atnumber
Datatext
Tracking URLtext
Driver Nametext
Driver Phonetext
Driver Latnumber
Driver Lngnumber
Driver Image URLtext

6other output fields

Assign an Order to a Driver

ActionDispatches an order to a driver on your team.
Input fields[3]
FieldType
Order IDRequired
text
DriverRequired
choice
Output fields[3]
FieldType
Order IDtext
Carrier IDtext
Successboolean
Responsetext

Cancel a Third-Party Delivery

ActionStops an on-demand courier job.
Input fields[3]
FieldType
Order IDRequired
text
Output fields[3]
FieldType
Order IDtext
Successboolean

Create a Delivery Order

ActionNew delivery job for a customer address.
Input fields[3]
FieldType
Order NumberRequired
text
Customer NameRequired
text
Customer AddressRequired
text
Customer PhoneRequired
text
Pickup NameRequired
text
Pickup AddressRequired
text
Customer Emailtext
Pickup Phonetext
Expected Delivery Datedate
Expected Pickup Timetext
Expected Delivery Timetext
Itemsarray
Itemobject
Tipsnumber
Taxnumber
Discountnumber
Delivery Feenumber
Total Order Costnumber
Pickup Instructiontext
Delivery Instructiontext
Order Sourcetext

22other input fields

Output fields[3]
FieldType
Successboolean
Responsetext
Order IDnumber

Create a Driver

ActionAdds a courier to your fleet.
Input fields[3]
FieldType
NameRequired
text
EmailRequired
text
PhoneRequired
text
Output fields[3]
FieldType
Carrier IDnumber
Emailtext
Passwordtext
Messagetext

Create a Pickup Order

ActionNew order for customer collection.
Input fields[3]
FieldType
Order NumberRequired
text
Pickup NameRequired
text
Pickup AddressRequired
text
Customer NameRequired
text
Customer PhoneRequired
text
Pickup Phonetext
Customer Emailtext
Tipsnumber
Taxnumber
Discountnumber
Total Order Costnumber
Itemsarray
Itemobject
Payment Methodchoice
Pickup Instructiontext
Expected Pickup Datedate
Expected Pickup Timetext
Order Sourcetext
Additional IDtext
Output fields[3]
FieldType
Successboolean
Order IDnumber
Messagetext

Delete a Delivery Order

ActionDeletes a single delivery job from the account.
Input fields[3]
FieldType
Order IDRequired
text
Output fields[3]
FieldType
Order IDtext
Deletedboolean

Delete a Driver

ActionCourier roster entry removed from your account.
Input fields[3]
FieldType
DriverRequired
choice
Output fields[3]
FieldType
Carrier IDtext
Successboolean
Responsetext

Delete a Pickup Order

ActionRemoves one customer-collection order.
Input fields[3]
FieldType
Order IDRequired
text
Output fields[3]
FieldType
Order IDtext
Deletedboolean

Make an API Call

universalFree-form Shipday REST API request.
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Keytext
Valuetext
Status codenumber

Mark an Order Ready for Pickup

ActionSignals an order is ready for the driver.
Input fields[3]
FieldType
Order IDRequired
text
Ready for Pickupboolean
Output fields[3]
FieldType
Order IDtext
Ready To Pickupboolean

Unassign an Order from a Driver

ActionReverses a driver assignment on a delivery order.
Input fields[3]
FieldType
Order IDRequired
text
Output fields[3]
FieldType
Order IDtext
Successboolean
Responsetext

Update a Delivery Order

ActionResubmits changes to a delivery order.
Input fields[3]
FieldType
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 Phonetext
Expected Delivery Datedate
Expected Pickup Timetext
Expected Delivery Timetext
Itemsarray
Itemobject
Tipsnumber
Taxnumber
Discountnumber
Delivery Feenumber
Total Costnumber
Delivery Instructiontext
Order Sourcetext

22other input fields

Output fields[3]
FieldType
Successboolean
Responsetext

Update a Pickup Order

ActionResubmits changes to a collection order.
Input fields[3]
FieldType
Order IDRequired
text
Order NumberRequired
text
Pickup NameRequired
text
Pickup AddressRequired
text
Customer NameRequired
text
Customer PhoneRequired
text
Pickup Latitudenumber
Pickup Longitudenumber
Pickup Phonetext
Customer Emailtext
Tipsnumber
Taxnumber
Discountnumber
Total Order Costnumber
Itemsarray
Itemobject
Payment Methodchoice
Pickup Instructiontext
Expected Pickup Datedate
Expected Pickup Timetext
Order Sourcetext

3other input fields

Output fields[3]
FieldType
Successboolean
Order IDnumber
Messagetext

Update an Order Status

ActionSets the stage of a delivery order.
Input fields[3]
FieldType
Order IDRequired
text
StatusRequired
choice
Output fields[3]
FieldType
Order IDnumber
Successboolean
Responsetext

Look for Shipday templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Shipday Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Shipday.
  4. 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.