Jump to Content
Home
Support
API Reference
Home
Support
API Reference
API Reference
Subscriptions and Order Webhooks
All
Pages
Start typing to search…
JUMP TO
Getting started
API Reference Guide
Authentication
Date / Time
Webhooks & Subscriptions
Integration API
Summary
Account
Get Account Workflows
get
Get Account Order UserFields
get
Subscriptions and Order Webhooks
Order Statuses
Import
Create a batch order import request from a file for order imports.
post
Get the import mappings for the account.
get
Orders
Create a new order
post
Create a return order
post
Create a new order from a template
post
Get a quote for an order
post
Update an order
patch
Get an order
get
Cancel an order
del
Search for an order. Note: the POST /search endpoint should be favored over this one.
get
Search for orders.
post
Get an order status
get
Put an order on hold
post
Add extra fees to an order
post
Update order extra fees
put
Get the items from multiple orders
get
Get the items from an order
get
Add items to order
post
Update items of an order
put
Delete items from an order
del
Get the tracked items log from an order
get
Update items barcodes
put
Download the labels for all items of an order
get
Download the labels for all items of an order as a json
get
OrderTemplates
Search for order templates.
post
Routes
Get containers
get
Get routes
get
Create a route
post
Update a route
patch
Delete a route
del
Get route
get
Change the stops sequence of the route
put
Convert to on-demand
post
Move all orders of the route to the next scheduled route
post
Move orders from a route to another
post
Subscriptions
Get the subscriptions
get
Subscribe to order updates
post
Get a subscription
get
Modify an existing subscription
patch
Unsubscribe from order updates
del
UserFields
Get the Order Userfields
get
Update order Userfields
put
Get the Order Item Userfields.
get
Tenants Integration API
Accounts
Get all contacts for an account
get
Create a new address contact for an account
post
Get an account's contact
get
Update a contact for the provided account
patch
Delete an account's contact
del
Get an account contacts nearby the specified position
get
Get a user's contacts
get
Create a new address contact for a user
post
Get a user's contact
get
Update a contact for the provided user
patch
Delete a user's contact
del
Get default contact for an account
get
Get all accounts.
get
Create a new account
post
Get an account by id
get
Update an existing account
patch
/api/v1/accounts/{accountId}/block
post
/api/v1/accounts/{accountId}/unblock
post
Get Account Workflows
get
Get Account Workflows
get
Get Account Order UserFields
get
Get the available exception codes for the account
get
Get an account's additional information
get
Update an account's additional information field
put
Get all users for an account
get
Create a new user for the provided account
post
Get an account's user
get
Update user for the given account
patch
Get all available roles
get
Calendars
Get all calendars
get
Get a specific calendar
get
Checkpoints
Get all checkpoints
get
Update a checkpoint
patch
Starts a scan session and return the SessionId that must be used in subsequent calls.
post
Register a scan for a list of barcodes at the checkpoint.
post
Complete and close the scan session.
post
Abandon and close the scan session
post
Companies
Get all companies.
get
Drivers
Get all drivers
get
Create a new driver
post
Get a specific driver
get
Update a driver
patch
Update the driver employee informations
patch
/api/v1/drivers/{id}/stops
get
Get the latest known position of a driver
get
Get the driver track history
post
Export the driver history
post
Unlock a Driver.
put
Archive a Driver.
post
Unarchive a Driver.
post
Update the driver status.
put
Update the driver position.
put
Get a driver's employee documents
get
Update a driver's employee document
put
Get a driver's additional information
get
Update a driver's additional information field
put
DriverSettlementDeductions
Get available deductions
get
Get deductions applied to the provided driver
get
Add a deduction to the provided driver
post
Update a deduction on the provided driver
put
Remove a deduction on the provided driver
del
FuelSurcharge
Get all fuel surcharge schedules.
get
Get a fuel surcharge schedule by id
get
Get all fuel surcharge tables.
get
Get a fuel surcharge table by id
get
Get all fuel prices.
get
Get all fuel surcharge calculators.
get
Update an existing fuel surcharge
put
Add fuel price to fuel price table
post
Invoice Statuses
Import
Create an import job request for orders from a provided csv file.
post
Get the import mappings.
get
Invoices
Get unprocessed invoices
get
Get a specific invoice
get
Update the status of one or multiple invoices
post
Order Statuses
Logs
Create a new log
post
Get logs for a specific context
get
Get logs for a specific context
post
Get all logs related to the attachment, grouped by context key
get
Get all logging applications for tenant
get
Orders
Create a new order
post
Get multiple orders
get
Create a duplicate order
post
Create a return order
post
Create a new order from a template
post
Get a quote for an order
post
Add one or many hubs to an existing order, converting that order to a multi-segment order.
post
Get the pickup and delivery stops durations in minutes for a given order.
get
Update the orders with pickup and delivery stops durations.
post
Update an order
patch
Get an order
get
Update the order with with the order profile Id.
post
Search for an order.
get
Search for orders.
post
Get the URL and Sas needed to upload an attachment to cloud storage.
get
Add uploaded attachment to an order.
post
Update an attachment from an order.
post
Remove an attachment from an order.
del
Mark the order as verify before invoicing.
post
Mark the order as ready for invoicing.
post
Mark the order as verify before driver settlement.
post
Mark the order as ready for driver settlement.
post
Get driver payouts for an order
get
Update driver payouts for an order
put
Get the items from multiple orders
get
Get the items from an order
get
Add items to order
post
Update items of an order
put
Delete items from an order
del
Update exception codes of item
post
Move items from one order to the other
post
Update items barcodes
put
Get the tracked items log from an order
get
Report a pickup
post
Report a delivery
post
/api/v1/orders/{orderId}/cancel
post
/api/v1/orders/{orderId}/reactivate
post
/api/v1/orders/{orderId}/dispatch/{driverId}
post
/api/v1/orders/{orderId}/unassign
post
Override the delivery charge.
post
Add charges to an order
post
Update order charges
put
Remove charges from an order
del
/api/v1/orders/{orderId}/convert-to-ondemand
post
Get the driver pickup position and delivery position for an order
get
Add the exception codes for an order
post
Delete exception codes from order
del
Set the order as scanned at the checkpoint. If items are provided and the checkpoint supports "Package Tracking", the items will be tracked.
post
Release the order
post
Download the labels for all items from an order
get
Move a non-delivered order to a route.
post
Retrieve an order delivery ETA by OrderId of an order
get
Put an order on hold
post
Delete cancelled orders completely
post
OrderTemplates
Get all order templates
get
Create an order template
post
Search for order templates.
post
Get a specific order template
get
Update an order template
patch
Delete an order template
del
Update the order with with the order profile Id.
post
Add one or many hubs to an existing order template, converting that order template to a multi-segment order template.
post
Add charges to an order template
post
Update charges from an order template
put
Remove charges from an order template
del
Get the order template items
get
Add items to order template
post
Update items
put
Delete items
del
Update the order template account and user
post
RecurringOrders
Get all recurring orders
get
Create a recurring order
post
Get a specific recurring order
get
Update a recurring order
patch
Delete a recurring order
del
Get the available repeat option for the selected start date and a 'monthly' frequence.
get
Add multiple order templates configurations
post
Convert a recurring order to a recurring route
post
Update a recurring order template configuration
patch
Delete a recurring order template configuration
del
Start a recurring order
post
Stop a recurring order
post
Trigger a recurring order
post
Get recurring orders that will be executed at the provided date.
get
RecurringRoutes
Get all recurring routes
get
Create a recurring route
post
Get a specific recurring route
get
Update a recurring route
patch
Delete a recurring route
del
Add multiple order templates configurations
post
Update a recurring route template configuration
patch
Delete a recurring route template configuration
del
Get recurring routes that will be executed at the provided date.
get
RoutePlans
Get all route plans
get
Create a new route plan
post
Get a specific route plan
get
Delete the route plan
del
Edit route plan
put
Enable or disable the route plan
put
Add account service level.
post
Delete an account service level.
del
Add schedule.
post
Delete a schedule for the route plan.
del
Import a schedules file. This will replace all existing schedules of the route plan.
post
Download schedules or template file
get
Import zones to plan.
post
Export route plan's zones
get
Creates a new zone in the route plan
post
Updates a zone in the route plan
put
Delete a zone for the route plan.
del
Routes
Get containers
get
Create a container manually
post
Get routes
get
Create a route
post
Update a route
patch
Delete a route
del
Get route
get
Change the route warehouse options.
post
Change the stops sequence of the route
put
Allocate a driver
post
Deallocate a driver
post
Convert all orders of the route to on-demand
post
Move all orders of the route to the next scheduled route
post
Move order of the route to the next scheduled route
post
Dispatch the orders from a single route
post
Dispatch the orders from a container
post
Close a route container
post
Move orders to a route
post
Get routes allocated to a specific driver
get
Settlements
Get settlements
get
Get a specific settlement
get
Update the status of one or multiple settlements
post
Cancel a settlement
post
Add the additions/deductions to a settlement
post
Update additions/deductions from a settlement
put
Delete additions/deductions from a settlement
del
Subscriptions
Gets the subscriptions for an account. The "GET /subscriptions/{entityType}/{entityId}" endpoint should be favored over this one, it will eventually be removed.
post
Gets the subscriptions
get
Subscribe to system updates
post
Gets the subscriptions for a given entity
get
Get a subscription
get
Modify an existing subscription
patch
Unsubscribe from system updates
del
Subscribe multiple entities to system updates
post
Transactions
Get all open batches
get
Create a batch
post
Get a specific batch
get
Update a batch
patch
Delete a batch
del
Submit the batch and create payments
post
Get a specific batch entry details with Invoices available
get
Update a batch entry
put
Delete a batch entry
del
Create a batch entry
post
Get the URL and Sas needed to upload an attachment to cloud storage.
get
Add a uploaded attachment to a transaction.
post
Get the posting entries.
get
UserFields
Get the order User Fields
get
Update the order User Fields
put
Get the item User Fields
get
Update item User Fields
put
Accounting
/api/v1/accounting/accounting-codes
get
LicensePlates
Fetch or create a license plate
get
Break a license plate
del
Add items to a license plate
post
Add items to a license plate
post
Remove an item from a license plate
del
Metadata
Create a new metadata entry
post
Update a metadata entry by MetadataId
put
Delete a metadata entry by MetadataId
del
Get a metadata entry by MetadataId
get
Update a metadata entry by context information
put
Delete a metadata entry by context information
del
Get a metadata entry by context information
get
Get entity IDs that do not have associated metadata
get
Orders
Download the labels for all items of an order as a json
get
Mark given order(s) as not billable
post
Search
This API uses the new search engine to obtain orders.
post
Obtains a summary of values that one can filter on.
get
Powered by
Subscriptions and Order Webhooks
