Jump to Content
Home
Guides
API Reference
Discussions
v0.1.0
v0.2.0
v0.3.0
Log In
API Reference
Log In
stable
Home
Guides
API Reference
Discussions
My Requests
All
Pages
Start typing to search…
JUMP TO
Getting Started
Authentication
My Requests
User Management
Users API
Get a user by id
get
Update a user
put
Toggle user active status
put
Update a user with profile picture
put
Find all users
get
Create new user
post
Create a new linked user
post
Create new user with profile picture
post
Get user authentication tokens from different linked user
post
Get any user by exact email
get
Get currently logged-in user
get
Get linked users' main company
get
Get user linked companies
get
Company API
Get a company details
get
Update a company details
put
Update a company details with logo picture
put
Get all companies based on a search
get
Payment Details API
Change subscriptions
put
Get subscriptions
get
Company Children API
Get specific company
get
Update a child company details
put
Deactivate a child company and all users.
del
Update a child company details with logo picture.
put
Get all children companies
get
Create a new child company
post
Activate a child company and all users.
post
Create a new child company with file
post
Company Children Users API
Get specific user
get
Update a user within a child company.
put
Deactivate a user.
del
Update a user within a child company details with profile picture.
put
Get all users
get
Add a new user to a child company.
post
Activate a user.
post
Create a child linked user
post
Add a new user to a child company.
post
Pre-Populated Data API
Get all company types
get
Get company sub types by company type
get
Banners API
Get all banners for a company
get
Inventory Management
Upload CSV API
Upload a CSV
post
Get import CSV job by ID
get
Batch Import API
Batch import inventory units
post
Get batch update job
get
Get batch import job
get
Get batch update job report
get
Get batch import job report
get
User Settings API
Get User Settings
get
Update User Settings
put
Inventory Units API
Get unit by ID
get
Update unit by ID
put
Delete unit
del
List Inventory Units
post
Upload a Gate Pass
post
Unlock Inventory Units
post
Mark units as removed from a load
post
Release units on hold
post
Put units on hold
post
Lock Inventory Units
post
Mark units added to load
post
Get unique pickup locations
get
Get unique delivery locations
get
Get unique customers
get
Get units by IDs
get
Batch Update API
Batch update inventory units
post
Load Builder
Orders Creation API
Create orders
post
Create orders
post
Get orders job result by job ID
get
Get orders job result by job ID
get
Suggest Loads API
Suggest Loads
post
Get suggested loads by job ID
get
Cancel suggested loads by job ID
del
Get suggest loads status by job ID
get
Get for current user an active suggested Load Job status
get
Rates API
Fetch rates for inventory item
post
Fetch rates for inventory item
post
Get status of rates job
get
Get status of rates job
get
Get rates job result by id
get
Get rates job result by id
get
Build Loads API
Build Loads
post
Get build loads data by job ID
get
Get build loads job status by ID
get
Get build loads status if there is active suggested load
get
Posting
Inventory Items API
Add vehicles to load leg by id.
put
Get loads eligible for merge.
get
Managed Orders API
Update managed order by load leg ID
put
Update managed order by load leg ID
put
Create loadleg from order.
post
Find managed order by refId
get
Update managed order by id and service account name
patch
Update managed order by id and service account name
patch
Find managed order by refId
get
Find managed order by LoadIds
get
Rate Engine API
Get RateEngine price suggestion
post
Get RateEngine price suggestion
post
Driveaway Load Operations API
Perform operation on a driveaway load
post
Dispatch a load to a driveaway driver
post
Dropdowns API
Get information for status dropdown field
get
Gets all available Load Types
get
Get information for customer dropdown field
get
Get information for carrier dropdown field
get
Get information for creator dropdown field
get
Get information for dropdown fields
get
Loads API
Get detailed information for load by id
get
Edit current information of a existing load leg by id
put
Get detailed information for load by id
get
Edit current information of a existing load leg by id
put
Edit current information of a existing driveaway load leg by id
put
Edit current information of a existing driveaway load leg by id
put
Create a load with direct dispatch
post
Create a load with direct dispatch
post
Create a load with direct dispatch
post
Create a load with direct dispatch
post
Create a load
post
Create a load
post
Do specific operations to load by id.
post
Do specific operations to load by id.
post
Check if a custom shipper load ID is not already used.
post
Check if a custom shipper load ID is not already used.
post
Get all load legs based on a search
get
Get all load legs based on a search
get
Get amount of all load legs based on their different statuses
get
Get amount of all load legs based on a specification
get
Contacts API
Get detailed information for contact by id
get
Update a contact
put
Deletes a contact by its Id
del
Get a list of contacts that match a specific name
get
Add a new contact
post
Get contact's from current user's contact book based on provided search query.
get
Get a list of all contacts for given company ID
get
Reports API
Get specific report template
get
Update a template
put
Remove a template
del
Get all report templates
get
Save a new report template
post
Generate and send to a given email a report based on the given filters and fields
post
Get all report logs
get
Company Settings API
Get information for current user's company settings and preferences
get
Attachments API
Upload a file by url
post
Upload a file by url
post
Upload a file
post
Upload a file
post
Dashboard API
Get the loads for KPI reports which are based on specific terms
get
Get the activity log for recent events
get
Get the amount of loads for KPI reports which are based on specific terms
get
Vehicle API
/shipperlite/posting/v3/vehicles/years
get
/shipperlite/posting/v3/vehicles
get
Location API
Get address from geocode
get
Quote Manager
Order Details
Add a new order
post
Cancel order
post
Quote Manager API
Search for quotes
get
Get quote by id
get
Search for quotes
get
Providers Details
Get all available providers
get
Fetch all quotes for the specific requirements
post
Retrieve transit time
post
Payments Operations
Get a payment link from a provider
post
Get a payment link status
get
Expire a payment link by sessionId
del
Montway Operations
Retrieve transit time
post
Fetch Quotes from Montway
post
Get the api key of the provider
get
Add api key for the provider
patch
Order with quote selected
Create order with booking details
post
Booking Details
Select specific quote
post
Get booking details
get
Quotes
Delete a quote by client id
del
Saved Search
Saved Search Controller
/api/v3/users/{userId}/saved-searches
get
/api/v3/users/{userId}/saved-searches
post
/api/v3/users/{userId}/saved-searches/count
get
/api/v3/users/{userId}/saved-searches/{id}
get
/api/v3/users/{userId}/saved-searches/{id}
put
/api/v3/users/{userId}/saved-searches/{id}
del
V 2 Saved Search Controller
/saved-search/v2/saved-searches
get
/saved-search/v2/saved-searches
post
/saved-search/v2/saved-searches/count
get
/saved-search/v2/saved-searches/{id}
get
/saved-search/v2/saved-searches/{id}
put
/saved-search/v2/saved-searches/{id}
del
Chat
Discussions API
Send update for specific discussion
post
Get specific discussion
get
Create a new discussion or add a new message to an existing one
patch
Rate Engine
Quotes
Create a new quote
post
Vehicles
Retrieve manufacture years
get
Retrieve vehicle makes
get
Retrieve vehicle models
get
CTMS
Authentication Check
/auth_check/
get
Trips
/trips/
get
/trips/
post
/trips/{id}/
get
/trips/{id}/
put
/trips/{id}/
del
/trips/{id}/archive/
post
/trips/{id}/assign/
post
/trips/{id}/reassign/
post
Loads
/loads/
get
/loads/
post
/loads/{id}/
get
/loads/{id}/
put
/loads/{id}/
patch
/loads/{id}/attachments/
get
/loads/{id}/download_attachments/
get
/loads/{id}/download_invoice/
get
/loads/{id}/delete_attachments/
post
/loads/{id}/post_to_loadboard/
post
/loads/{id}/dispatch_to_carrier/
post
/loads/{id}/shipper_cancel/
post
/loads/{id}/revisions/
get
/loads/{id}/accept/
post
/loads/{id}/decline/
post
/loads/{id}/cancel/
post
/loads/{id}/assign/
post
/loads/{id}/reassign/
post
/loads/{id}/set_driver_instructions/
post
/loads/{id}/send_bol/
post
/loads/{id}/mark_paid/
post
/loads/{id}/driver_seen/
post
/loads/shipper_emails/
get
/loads/${id}/manual_pickup/
post
/loads/${id}/manual_deliver/
post
Location Tracking
/location_tracking/start/
post
/location_tracking/start/{load_id}
post
/location_tracking/stop/
post
/location_tracking/stop/{load_id}
post
/location_tracking/off_duty
post
/location_tracking/history
post
Shipper Loads
/shipper_loads/
get
/shipper_loads/
post
/shipper_loads/{shipper_load_id}/
get
/shipper_loads/{shipper_load_id}/
put
/shipper_loads/{shipper_load_id}/
patch
Postings
/postings/
get
/postings/{id}/
get
/postings/{id}/
put
/postings/{id}/
patch
/postings/{id}/dispatch_to_carrier/
post
/postings/{id}/remove_from_loadboard/
post
/postings/{id}/shipper_cancel/
post
/postings/{id}/offer/
post
/postings/{id}/book/
post
/postings/{id}/can_instant_book/
post
Archived Postings
/archived_postings/
get
/archived_postings/{original_pk}/
get
Negotiations
/offers/
get
/offers/{id}/
get
/negotiations/
get
/negotiations/{id}/
get
/negotiations/{id}/accept/
post
/negotiations/{id}/cancel/
post
Vehicles
/vehicles/
get
/vehicles/
post
/vehicles/{id}/
get
/vehicles/{id}/
put
/vehicles/{id}/
del
/vehicles/{id}/
patch
/vehicles/{id}/download_attachments/
get
/vehicles/{id}/specifications/
get
/vehicles/{id}/set_vin/
post
/vehicles/{id}/pick_up/
post
/vehicles/{id}/pickup_odometer_reading/
post
/vehicles/{id}/deliver/
post
/vehicles/{id}/delivery_odometer_reading/
post
/vehicles/{id}/replace_m22_pickup_damages/
post
/vehicles/{id}/replace_m22_delivery_damages/
post
/vehicles/{id}/invalidate_pickup/
post
/vehicles/{id}/invalidate_delivery/
post
Vehicle Types
/vehicle_types/
get
/vehicle_types/{id}/
get
Attachments
/attachments/
get
/attachments/
post
/attachments/{id}/
get
/attachments/{id}/
put
/attachments/{id}/
del
/attachments/{id}/
patch
/attachments/{id}/download/
get
/attachments/{id}/replace_damages/
post
Revisions
/changes/
get
/changes/{id}/
get
/revisions/
get
/revisions/{id}/
get
/revisions/{id}/accept/
post
/revisions/{id}/decline/
post
/revisions/{id}/notify/
post
Notifications
/notifications/
get
/notifications/{id}/
get
/notifications/{id}/mark/
post
/notifications/mark_list/
post
Event Subscriptions
/event_subscriptions/
get
/event_subscriptions/
post
/event_subscriptions/{id}/
get
/event_subscriptions/{id}/
put
/event_subscriptions/{id}/
del
/event_subscriptions/{id}/
patch
Carriers
/carriers/{dot_number}/
get
/carriers/{dot_number}/labels/
get
/carriers/{dot_number}/set_labels/
post
/carriers/{dot_number}/set_label/
post
/carriers/{dot_number}/delete_label/
post
Companies
/companies/
get
/companies/{id}/
get
/companies/{id}/
put
/companies/{id}/
patch
/companies/{id}/labels/
get
/companies/{id}/set_labels/
post
/companies/{id}/set_label/
post
/companies/{id}/delete_label/
post
/companies/download_invoices/
get
/companies/{id}/set_invoice_generation/
post
/companies/{id}/set_terms_of_service/
post
/companies/{id}/set_email_notifications/
post
/companies/{id}/set_hide_user_list/
post
Users
/users/
get
/users/me/
get
/users/jwt/
get
/users/last_event/
get
/users/accept_terms/
post
/users/accept_loadboard_tc/
post
/users/change_email/
post
/users/change_password/
post
/users/change_phone_number/
post
/users/create_user/
post
/users/driver_activity/
get
/users/reset_password/
post
/users/{id}/
get
/users/{id}/
put
/users/{id}/
del
/users/{id}/
patch
/users/{id}/set_custom_permissions/
post
/users/{id}/set_roles/
post
/users/{id}/activate_user/
post
/users/{id}/deactivate_user/
post
/users/{id}/resend_activation/
post
/users/{id}/resend_email_verification/
post
/users/{id}/resend_sms_verification/
post
/users/{id}/activity/
get
/users/{id}/change_user_email/
post
/users/{id}/change_user_phone_number/
post
/users/{id}/reset_user_password/
post
/users/{id}/reset_user_signature/
post
User Roles
/roles/
get
/roles/{id}/
get
Orders Controller
/api/ctms/v1/orders/count
get
/api/ctms/v1/orders/{id}/details
get
Loadboard
Query Controller
/loadboard/v2/query
get
/loadboard/v2/query
post
V 3 Postings Controller
/loadboard/v3/postings
get
/loadboard/v3/postings/mycounters
get
/loadboard/v3/postings/{id}
get
Load recommender
Notification Settings Controller
Returns the notification settings for the user
get
Sets whether email notifications are enabled; returns the updated notification settings
put
Sets whether in-app notifications are enabled; returns the updated notification settings
put
Sets whether email notifications are snoozed for the current day; returns the updated notification settings
put
Recommendations Controller
/notification-manager/v1/recommendations
get
Deletes all recommendations, created before and including the specified timestamp
del
Marks as read all un-read recommendations, created before and including the specified timestamp
post
Marks as seen all un-seen recommendations, created before and including the specified timestamp
post
/notification-manager/v1/recommendations/{id}
get
/notification-manager/v1/recommendations/{id}
del
/notification-manager/v1/recommendations/{id}/mark-as-read
post
/notification-manager/v1/recommendations/{id}/mark-as-seen
post
trip planner
Trip Controller
/api/tripplanner/v1/trips
get
/api/tripplanner/v1/trips
post
/api/tripplanner/v1/trips/count
get
/api/tripplanner/v1/trips/{trip-id}
get
/api/tripplanner/v1/trips/{trip-id}
del
/api/tripplanner/v1/trips/{trip-id}/candidate
post
/api/tripplanner/v1/trips/{trip-id}/candidates/{trip-load-id}
put
/api/tripplanner/v1/trips/{trip-id}/candidates/{trip-load-id}/promote
post
/api/tripplanner/v1/trips/{trip-id}/change-capacity
post
/api/tripplanner/v1/trips/{trip-id}/email-notifications
get
/api/tripplanner/v1/trips/{trip-id}/email-notifications
put
/api/tripplanner/v1/trips/{trip-id}/loads/{load-id}
del
/api/tripplanner/v1/trips/{trip-id}/loads/{load-id}/transfer
post
/api/tripplanner/v1/trips/{trip-id}/orders
post
/api/tripplanner/v1/trips/{trip-id}/plan
get
/api/tripplanner/v1/trips/{trip-id}/postings
post
/api/tripplanner/v1/trips/{trip-id}/rearrange-stops
post
/api/tripplanner/v1/trips/{trip-id}/rename
post
/api/tripplanner/v1/trips/{trip-id}/trip-loads/{trip-load-id}
del
Powered by
••••••2590
Endpoint
Method
Status
User Agent
