API Dashboard

Taffy 3.6.0

Resources:

zoneCollection DELETE PATCH PUT POST GET /zones

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs

zoneOrdersCollection DELETE PATCH PUT POST GET /zone/{zoneID}/orders

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
GET /zone/{zoneID}/orders Get upcoming orders within the zone's polygons
Inputs
required numeric zoneID

zoneNotesCollection DELETE PATCH PUT POST GET /zone/{zoneID}/notes

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
GET /zone/{zoneID}/notes Get notes within the zone's polygons
Inputs
required numeric zoneID

zoneMember DELETE PATCH PUT POST GET /zone/{zoneID}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Inputs
required numeric zoneID

zoneZipCodeCollection DELETE PATCH PUT POST GET /zipcodezones

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs

wireoutsCollection DELETE PATCH PUT POST GET /wireouts

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs

wiredoutsCollection DELETE PATCH PUT POST GET /wiredouts

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs

wiredinsCollection DELETE PATCH PUT POST GET /wiredins

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs

willcallCollection DELETE PATCH PUT POST GET /willcall

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs

webhookCollection DELETE PATCH PUT POST GET /webhook-management/{action}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

WebhookCollection.cfc API endpoints for managing webhook service configurations Provides CRUD operations for multi-tenant webhook infrastructure
put
PUT endpoints for webhook management
Inputs
optional string action
delete
DELETE endpoints for webhook management
Inputs
optional string action
post
POST endpoints for webhook management
Inputs
optional string action
get
GET endpoints for webhook management
Inputs
optional string action

userMember DELETE PATCH PUT POST GET /users/{userID}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Inputs
optional string userID

userCollection DELETE PATCH PUT POST GET /users

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs

mutationsCollection DELETE PATCH PUT POST GET /update/{action}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

post
Inputs
optional string action

fleetCollection DELETE PATCH PUT POST GET /trucks

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs

transport DELETE PATCH PUT POST GET /transport/{action}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
GET /api/transport/status/{orderId} Fetch transport status information for an order
Inputs
optional string action
optional string orderId (default: "")
optional numeric cacheTTL (default: 5)
post
POST /api/transport/{action} Handle POST actions for transport operations
Inputs
optional string action

transferCollection DELETE PATCH PUT POST GET /transfers

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs

transferMember DELETE PATCH PUT POST GET /transfer/{traID}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Inputs
required numeric traID

tagsCollection DELETE PATCH PUT POST GET /tags/{type}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Inputs
optional string type

storageLocationMember DELETE PATCH PUT POST GET /storageLocations/{locID}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Inputs
required numeric locID

storageLocationCollection DELETE PATCH PUT POST GET /storageLocations

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs

stockTasksCollection DELETE PATCH PUT POST GET /stock-tasks/{action}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

post
Inputs
optional string action
put
Inputs
optional string action
delete
Inputs
optional string action
get
Inputs
optional string action

stockPullTasksCollection DELETE PATCH PUT POST GET /stock-pull-tasks/{action}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

put
Inputs
optional string action
delete
Inputs
optional string action
post
Inputs
optional string action
get
Inputs
optional string action

scheduledRunner DELETE PATCH PUT POST GET /scheduled/{action}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

scheduledRunner.cfc REST API endpoint for running scheduled tasks This provides a web-accessible way to trigger the hotlist checker
get
GET endpoint to run scheduled tasks (for scheduler compatibility)
Inputs
optional string action
post
POST endpoint to run scheduled tasks
Inputs
optional string action

scheduledTaskManager DELETE PATCH PUT POST GET /scheduled-tasks/{action}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

scheduledTaskManager.cfc REST API endpoints for managing ColdFusion scheduled tasks
post
POST endpoints for scheduled task management
Inputs
optional string action
get
GET endpoints for scheduled task information
Inputs
optional string action

commonDepartureTimesCollection DELETE PATCH PUT POST GET /routes/common-departure-times

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
GET /api/routes/common-departure-times?dayOfWeek=1 Returns the top 5 most common departure times from historical routes Optional dayOfWeek parameter (0=Sunday, 1=Monday, ..., 6=Saturday) If dayOfWeek is provided and no results found, falls back to all days
Inputs
optional numeric dayOfWeek (default: -1)

routeCollection DELETE PATCH PUT POST GET /routes

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs

routeMember DELETE PATCH PUT POST GET /route/{routeID}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Inputs
required numeric routeID

reportsCollection DELETE PATCH PUT POST GET /reports/{action}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Inputs
optional string action
optional numeric empID
optional any dateFrom (default: "")
optional any dateTo (default: "")
optional any deliveryDateFrom (default: "")
optional any deliveryDateTo (default: "")
optional any orderDateMode (default: deliveryDate)
optional any deliveryDateMode (default: deliveryDate)
optional any orderDatePrefix (default: by)

recipeMember DELETE PATCH PUT POST GET /recipe

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs
optional string iteID (default: "")
optional string varID (default: "")

qrCodeMember DELETE PATCH PUT POST GET /qrCode/{qrCodeID}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Inputs
optional string qrCodeID

qcMember DELETE PATCH PUT POST GET /qc/{linID}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Individual QC line item endpoints

qcCollection DELETE PATCH PUT POST GET /qc-management/{action}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Quality Control endpoints
get
Get QC pending items or metrics
Inputs
optional string action (default: pending)
optional string startDate
optional string endDate
optional string empID
post
Perform QC on line item
Inputs
required numeric linID
required numeric ordID
required string qcResult
optional string failureReason (default: "")
required numeric empID
optional boolean designerNotesAcknowledged (default: false)
optional boolean cardVersionConfirmed (default: false)
optional boolean cardPhysicallyPresent (default: false)

posAutoPackageMember DELETE PATCH PUT POST GET /posAutoPackage/{packageType}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

post
Inputs
optional string packageType
optional string linID (default: 0)
optional string ordID (default: 0)

orderCollection DELETE PATCH PUT POST GET /orders

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs
optional string orderIDs (default: "")

zoneValidationMember DELETE PATCH PUT POST GET /order/{ordID}/zone-validation

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
GET /order/{ordID}/zone-validation Check if an order's geocoded location is within its assigned zone polygon
Inputs
required numeric ordID

orderMember DELETE PATCH PUT POST GET /order/{ordID}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Inputs

orderNotesCollection DELETE PATCH PUT POST GET /order-notes/{action}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
GET /order-notes/nearby Get notes within a specified radius of an order's delivery location Query params: ordID (required), radiusMiles (optional, default 1)
Inputs
optional string action
optional numeric ordID
optional numeric radiusMiles (default: 1)

notificationCollection DELETE PATCH PUT POST GET /notification/{action}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

post
Inputs
optional string action (default: "")
put
Inputs
optional string action (default: "")
patch
Inputs
optional string action (default: "")
delete
Inputs
optional string action (default: "")
get
Main notification endpoint router Routes different notification actions based on the URL parameter
Inputs
optional string action (default: getNotifications)

notificationWebhookCollection DELETE PATCH PUT POST GET /notification-webhook/{service}/{action}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

post
POST endpoint for webhook delivery status updates
Inputs
optional string service (default: "")
optional string action (default: "")

multiRouteCreator DELETE PATCH PUT POST GET /multiRouteCreator/{action}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

post
Inputs
optional string action

messageMentionCollection DELETE PATCH PUT POST GET /messages/mentions/{action}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
GET /messages/mentions/pending Get pending mention notifications (for admin console)
Inputs
optional string action (default: pending)

messageAttachmentCollection DELETE PATCH PUT POST GET /messages/attachments

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

post
POST /messages/attachments Upload file to S3 for message attachment
Inputs

messageAdminCollection DELETE PATCH PUT POST GET /messages/admin/{action}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
GET /messages/admin/statistics Get messaging system statistics (admin only)
Inputs
required string action

messageReplyMember DELETE PATCH PUT POST GET /messages/{mesID}/reply

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

post
POST /messages/{mesID}/reply Create reply message
Inputs
required string mesID

messageMember DELETE PATCH PUT POST GET /messages/{mesID}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
GET /messages/{mesID} Get message details with thread
Inputs
required string mesID
delete
DELETE /messages/{mesID} Soft delete message
Inputs
required string mesID
put
PUT /messages/{mesID} Update message (revoke, edit, pin, archive)
Inputs
required string mesID
patch
POST /messages/{mesID}/mark-read Mark message as read for current user
Inputs
required string mesID

messageCollection DELETE PATCH PUT POST GET /messages

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
GET /messages List messages with filters (order, user, status, unread, search)
Inputs
optional string ordID (default: "")
optional string empID (default: "")
optional string mesStatus (default: "")
optional string unread (default: "")
optional string mentions (default: "")
optional string mesType (default: "")
optional string mesPriority (default: "")
optional string mesCategory (default: "")
optional string search (default: "")
optional string startDate (default: "")
optional string endDate (default: "")
optional string pinned (default: "")
optional string archived (default: "")
optional string page (default: 1)
optional string limit (default: 50)
optional string sortBy (default: created_at)
optional string sortOrder (default: DESC)
post
POST /messages Create new message
Inputs

mapsCollection DELETE PATCH PUT POST GET /maps/{action}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

post
Inputs
optional string action

lockCollection DELETE PATCH PUT POST GET /locks/{action}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Inputs
optional string action
post
Inputs
optional string action
required numeric ordID
optional boolean confirmation (default: false)
optional string reason (default: "")

lockMember DELETE PATCH PUT POST GET /lock/responses/{locID}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Inputs

lineItemMember DELETE PATCH PUT POST GET /lineitem/{linID}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Inputs

incomingOrderCollection DELETE PATCH PUT POST GET /incomingorderscache

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs

hotlistCollection DELETE PATCH PUT POST GET /hotlist/{action}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

post
Inputs
optional string action

hotlistExpiration DELETE PATCH PUT POST GET /hotlist-expiration/{action}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

hotlistExpiration.cfc API endpoint for hotlist expiration checking Can be called manually or by external schedulers (cron, etc.)
get
GET endpoint to view upcoming expiring items
Inputs
optional string action (default: preview)
post
POST endpoint to trigger hotlist expiration check
Inputs
optional string action (default: check)

helloMember DELETE PATCH PUT POST GET /hello

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs

googleAuthCollection DELETE PATCH PUT POST GET /googleAuth

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs
optional boolean forceRefresh (default: false)

geoLocationCollection DELETE PATCH PUT POST GET /geo/{action}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

post
Inputs
optional string action

fsnCollection DELETE PATCH PUT POST GET /fsn/{action}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

post
Inputs
optional string action

employeeCollection DELETE PATCH PUT POST GET /employees

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs

employeeMember DELETE PATCH PUT POST GET /employee/{empID}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Inputs
optional string empID

employeeScheduleCollection DELETE PATCH PUT POST GET /employee-schedules

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

delete
DELETE /employee-schedules Delete schedule items (shifts, blocks, check-ins) Query params: type (shift, availability-block, checkin), id (the ID of the item to delete)
Inputs
post
POST /employee-schedules Create or update schedule items (shifts, blocks, check-ins, templates) JSON body should include "type" field: "shift", "availability-block", "checkin", or "template"
Inputs
get
GET /employee-schedules Get employee schedules with optional filters Query params: empID, role, dateFrom, dateTo
Inputs

employeeCheckinsCollection DELETE PATCH PUT POST GET /employee-checkins

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
GET /employee-checkins Get check-ins for all active employees for a date range Query params: dateFrom (required), dateTo (required), role (optional: 'driver', 'designer', or 'all')
Inputs

driverCollection DELETE PATCH PUT POST GET /drivers

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs

domainHashCollection DELETE PATCH PUT POST GET /domain-hashes

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs

devtasksMember DELETE PATCH PUT POST GET /devtasks/{action}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Inputs
optional string action
optional numeric numToCreate (default: 1)
optional numeric daysFromToday (default: 99)
optional string configuration (default: "")
post
Inputs
optional string action (default: "")
optional numeric numToCreate (default: 1)
optional numeric daysFromToday (default: 99)
optional string configuration (default: "")

designerCollection DELETE PATCH PUT POST GET /designers

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs

designerCreditCollection DELETE PATCH PUT POST GET /designer-credit/{action}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Inputs
optional string action

deliveryAddressTypeCollection DELETE PATCH PUT POST GET /deliveryAddressTypes

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs

deliveryAnomaliesCollection DELETE PATCH PUT POST GET /delivery-anomalies

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs

deliveryCollection DELETE PATCH PUT POST GET /deliveries

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs

commandPreferencesCollection DELETE PATCH PUT POST GET /command-preferences/{action}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Main command preferences endpoint router Routes different actions based on the URL parameter
Inputs
optional string action (default: getPreferences)
post
Inputs
optional string action (default: "")

catalogCollection DELETE PATCH PUT POST GET /catalog/{action}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

post
Inputs
optional string action
optional string query (default: "")
optional string id (default: "")

burq DELETE PATCH PUT POST GET /burq/{action}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

post
Inputs
optional string action
get
Inputs
optional string action

branchCollection DELETE PATCH PUT POST GET /branches

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs

activityCollection DELETE PATCH PUT POST GET /activitylog

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs

Warning: Your reload key and password are using the framework default settings. It's advised that you change these in production.
Resources are listed in matching order. From top to bottom, the first URI to match the request is used.