Skip to main content

Employees

Manage employee records and delivery driver information.

Base URL: /api/v1/partner/employees

Endpoints Overview

MethodEndpointDescription
GET/Search Employees
GET/{employeeId}Search Employees
GET/drivers/nearbyGet employee distance details
GET/drivers/auto-assignedGet auto-assigned driver

Search Employees

GET /api/v1/partner/employees

Retrieve a paginated list of employees. Optionally pass currentEmployeeId to scope the search context.

Query Parameters

ParameterTypeRequiredDescription
startintegerNoNumber of records to skip
limitintegerNoMaximum records to return
currentEmployeeIdstringNocurrent employee i d

Response

Returns a paginated SearchResult of EmployeeResult objects.

FieldTypeRequiredDescription
idstringNoUnique identifier
companyIdstringNoCompany identifier
createdlongNoCreated timestamp (epoch ms)
modifiedlongNoLast modified timestamp (epoch ms)
deletedbooleanNoWhether the record is deleted
updatedbooleanNoWhether the record has been updated
authUserIdstringNoAuth User identifier
firstNamestringYesFirst name
lastNamestringYesLast name
pinstringNoPin
roleIdstringYesRole identifier
emailstringNoEmail address
passwordstringNoPassword
driversLicensestringNoDrivers License
occupationLicenseNumberstringNoOccupation License Number
dlExpirationDatestringNoDl Expiration timestamp (epoch ms)
vehicleMakestringNoVehicle Make
notesNote[]NoNotes
shopsstring[]NoShops
disabledbooleanNoDisabled (default: false)
phoneNumberstringNoPhone Number
assignedInventoryIdstringNoAssigned Inventory identifier
assignedTerminalIdstringNoAssigned Terminal identifier
addressAddressNoAddress
timecardIdstringNoTimecard identifier
timeCardTimeCardNoTime Card
roleRoleNoRole
canApplyCustomDiscountbooleanNoCan Apply Custom Discount (default: true)
insuranceExpireDatelongNoInsurance Expire timestamp (epoch ms)
insuranceCompanyNamestringNoInsurance Company Name
policyNumberstringNoPolicy Number
registrationExpireDatelongNoRegistration Expire timestamp (epoch ms)
vehiclePinstringNoVehicle Pin
vinNostringNoVin No
vehicleModelstringNoVehicle Model
vehicleLicensePlatestringNoVehicle License Plate
tripIdstringNoTrip identifier
recentLocationTerminalLocationNoRecent Location (default: null)
employeeOnFleetInfoListEmployeeOnFleetInfo[]NoEmployee On Fleet Info List
tookanInfoListEmployeeTookanInfo[]NoTookan Info List
lastLoggedInShopIdstringNoLast Logged In Shop identifier
lastLoginTimelongNoLast Login timestamp (epoch ms)
driverbooleanNoDriver (default: false)
externalIdstringNoExternal system identifier
organizationIdsstring[]NoOrganization Ids
yellowfinRoleCodeyellowfinrolecodeNoYellowfin Role Code
defaultVehicleIdstringNoDefault Vehicle identifier
biotrackbooleanNoBiotrack (default: false)
biotrackTransIdstringNoBiotrack Trans identifier
biotrackTransIdOriginalstringNoBiotrack Trans Id Original
birthDatelongNoBirth timestamp (epoch ms)
hireDatelongNoHire timestamp (epoch ms)
sessionTimelongNoSession timestamp (epoch ms)
lastPasswordChangedOnlongNoLast Password Changed On
packerbooleanNoPacker (default: false)
internalbooleanNoInternal (default: false)
isBlazeAdminbooleanNoBlaze Admin
importIdstringNoImport identifier
metrcRetailerDeliveryIdlongNoMetrc Retailer Delivery identifier
platformUserIdstringNoPlatform User identifier
platformCognitoIdstringNoPlatform Cognito identifier
isSuperAdminbooleanNoSuper Admin
terminalNamestringNoTerminal Name
employeeOnFleetInfoResultsEmployeeOnFleetInfoResult[]NoEmployee On Fleet Info Results

Search Employees

GET /api/v1/partner/employees/{employeeId}

Retrieve a single employee by their ID. Returns the full employee record.

Path Parameters

ParameterTypeDescription
employeeIdstringThe employee i d

Response

Returns a Employee object.

FieldTypeRequiredDescription
idstringNoUnique identifier
companyIdstringNoCompany identifier
createdlongNoCreated timestamp (epoch ms)
modifiedlongNoLast modified timestamp (epoch ms)
deletedbooleanNoWhether the record is deleted
updatedbooleanNoWhether the record has been updated
authUserIdstringNoAuth User identifier
firstNamestringYesFirst name
lastNamestringYesLast name
pinstringNoPin
roleIdstringYesRole identifier
emailstringNoEmail address
passwordstringNoPassword
driversLicensestringNoDrivers License
occupationLicenseNumberstringNoOccupation License Number
dlExpirationDatestringNoDl Expiration timestamp (epoch ms)
vehicleMakestringNoVehicle Make
notesNote[]NoNotes
shopsstring[]NoShops
disabledbooleanNoDisabled (default: false)
phoneNumberstringNoPhone Number
assignedInventoryIdstringNoAssigned Inventory identifier
assignedTerminalIdstringNoAssigned Terminal identifier
addressAddressNoAddress
timecardIdstringNoTimecard identifier
timeCardTimeCardNoTime Card
roleRoleNoRole
canApplyCustomDiscountbooleanNoCan Apply Custom Discount (default: true)
insuranceExpireDatelongNoInsurance Expire timestamp (epoch ms)
insuranceCompanyNamestringNoInsurance Company Name
policyNumberstringNoPolicy Number
registrationExpireDatelongNoRegistration Expire timestamp (epoch ms)
vehiclePinstringNoVehicle Pin
vinNostringNoVin No
vehicleModelstringNoVehicle Model
vehicleLicensePlatestringNoVehicle License Plate
tripIdstringNoTrip identifier
recentLocationTerminalLocationNoRecent Location (default: null)
employeeOnFleetInfoListEmployeeOnFleetInfo[]NoEmployee On Fleet Info List
tookanInfoListEmployeeTookanInfo[]NoTookan Info List
lastLoggedInShopIdstringNoLast Logged In Shop identifier
lastLoginTimelongNoLast Login timestamp (epoch ms)
driverbooleanNoDriver (default: false)
externalIdstringNoExternal system identifier
organizationIdsstring[]NoOrganization Ids
yellowfinRoleCodeyellowfinrolecodeNoYellowfin Role Code
defaultVehicleIdstringNoDefault Vehicle identifier
biotrackbooleanNoBiotrack (default: false)
biotrackTransIdstringNoBiotrack Trans identifier
biotrackTransIdOriginalstringNoBiotrack Trans Id Original
birthDatelongNoBirth timestamp (epoch ms)
hireDatelongNoHire timestamp (epoch ms)
sessionTimelongNoSession timestamp (epoch ms)
lastPasswordChangedOnlongNoLast Password Changed On
packerbooleanNoPacker (default: false)
internalbooleanNoInternal (default: false)
isBlazeAdminbooleanNoBlaze Admin
importIdstringNoImport identifier
metrcRetailerDeliveryIdlongNoMetrc Retailer Delivery identifier
platformUserIdstringNoPlatform User identifier
platformCognitoIdstringNoPlatform Cognito identifier
isSuperAdminbooleanNoSuper Admin

Get employee distance details

GET /api/v1/partner/employees/drivers/nearby

Find delivery drivers near a geographic location. Provide lat and long coordinates. Set useRegion to true to filter drivers by delivery region (also provide zipCode), or useTerminal to true to filter by both region and terminal assignment. If both flags are false, returns drivers by proximity alone. Requires a store context.

Query Parameters

ParameterTypeRequiredDescription
latdoubleNoLatitude coordinate
longdoubleNoLongitude coordinate
useRegionbooleanNoWhether to use region-based filtering
useTerminalbooleanNouse terminal
zipCodestringNoZIP code for location lookup

Response

Returns a list of DeliveryEmployeeDetails objects.

FieldTypeRequiredDescription
driverNamestringNoDriver Name
employeeIdstringNoEmployee identifier
inventoryIdstringNoInventory identifier
distancedoubleNoDistance
terminalIdstringNoTerminal identifier
terminalNamestringNoTerminal Name
inventoryNamestringNoInventory Name
onlinebooleanNoOnline

Get auto-assigned driver

GET /api/v1/partner/employees/drivers/auto-assigned

Get the system's recommended delivery driver for a given location. Provide lat, long, and zipCode. The system automatically selects the best available driver based on proximity and assignment rules. Requires both user and store authentication.

Query Parameters

ParameterTypeRequiredDescription
latdoubleNoLatitude coordinate
longdoubleNoLongitude coordinate
zipCodestringNoZIP code for location lookup

Response

Returns a DeliveryDriverEmployeeResult object.

FieldTypeRequiredDescription
idstringNoUnique identifier
companyIdstringNoCompany identifier
createdlongNoCreated timestamp (epoch ms)
modifiedlongNoLast modified timestamp (epoch ms)
deletedbooleanNoWhether the record is deleted
updatedbooleanNoWhether the record has been updated
authUserIdstringNoAuth User identifier
firstNamestringYesFirst name
lastNamestringYesLast name
pinstringNoPin
roleIdstringYesRole identifier
emailstringNoEmail address
passwordstringNoPassword
driversLicensestringNoDrivers License
occupationLicenseNumberstringNoOccupation License Number
dlExpirationDatestringNoDl Expiration timestamp (epoch ms)
vehicleMakestringNoVehicle Make
notesNote[]NoNotes
shopsstring[]NoShops
disabledbooleanNoDisabled (default: false)
phoneNumberstringNoPhone Number
assignedInventoryIdstringNoAssigned Inventory identifier
assignedTerminalIdstringNoAssigned Terminal identifier
addressAddressNoAddress
timecardIdstringNoTimecard identifier
timeCardTimeCardNoTime Card
roleRoleNoRole
canApplyCustomDiscountbooleanNoCan Apply Custom Discount (default: true)
insuranceExpireDatelongNoInsurance Expire timestamp (epoch ms)
insuranceCompanyNamestringNoInsurance Company Name
policyNumberstringNoPolicy Number
registrationExpireDatelongNoRegistration Expire timestamp (epoch ms)
vehiclePinstringNoVehicle Pin
vinNostringNoVin No
vehicleModelstringNoVehicle Model
vehicleLicensePlatestringNoVehicle License Plate
tripIdstringNoTrip identifier
recentLocationTerminalLocationNoRecent Location (default: null)
employeeOnFleetInfoListEmployeeOnFleetInfo[]NoEmployee On Fleet Info List
tookanInfoListEmployeeTookanInfo[]NoTookan Info List
lastLoggedInShopIdstringNoLast Logged In Shop identifier
lastLoginTimelongNoLast Login timestamp (epoch ms)
driverbooleanNoDriver (default: false)
externalIdstringNoExternal system identifier
organizationIdsstring[]NoOrganization Ids
yellowfinRoleCodeyellowfinrolecodeNoYellowfin Role Code
defaultVehicleIdstringNoDefault Vehicle identifier
biotrackbooleanNoBiotrack (default: false)
biotrackTransIdstringNoBiotrack Trans identifier
biotrackTransIdOriginalstringNoBiotrack Trans Id Original
birthDatelongNoBirth timestamp (epoch ms)
hireDatelongNoHire timestamp (epoch ms)
sessionTimelongNoSession timestamp (epoch ms)
lastPasswordChangedOnlongNoLast Password Changed On
packerbooleanNoPacker (default: false)
internalbooleanNoInternal (default: false)
isBlazeAdminbooleanNoBlaze Admin
importIdstringNoImport identifier
metrcRetailerDeliveryIdlongNoMetrc Retailer Delivery identifier
platformUserIdstringNoPlatform User identifier
platformCognitoIdstringNoPlatform Cognito identifier
isSuperAdminbooleanNoSuper Admin
routingbooleanNoRouting (default: false)
terminalNamestringNoTerminal Name
inventoryNamestringNoInventory Name
activeTransactionlongNoActive Transaction
assignedRegionIdstringNoAssigned Region identifier
assignedRegionBlazeRegionNoAssigned Region
assignedShopstringNoAssigned Shop
assignedShopIdstringNoAssigned Shop identifier
externalTripErrorstringNoExternal Trip Error
externalDeliveryLedgerIdlongNoExternal Delivery Ledger identifier
tripShopIdstringNoTrip Shop identifier
tripShopNamestringNoTrip Shop Name