JUMP TOGetting startedAPI Reference GuideAuthenticationDate / TimeWebhooks & SubscriptionsIntegration APISummaryAccountGet Account WorkflowsgetGet Account Order UserFieldsgetSubscriptions and Order WebhooksOrder StatusesImportCreate a batch order import request from a file for order imports.postGet the import mappings for the account.getOrdersCreate a new orderpostCreate a return orderpostCreate a new order from a templatepostGet a quote for an orderpostUpdate an orderpatchGet an ordergetCancel an orderdeleteSearch for an order. Note: the POST /search endpoint should be favored over this one.getSearch for orders.postGet an order statusgetPut an order on holdpostAdd extra fees to an orderpostUpdate order extra feesputGet the items from multiple ordersgetGet the items from an ordergetAdd items to orderpostUpdate items of an orderputDelete items from an orderdeleteGet the tracked items log from an ordergetUpdate items barcodesputDownload the labels for all items of an ordergetOrderTemplatesSearch for order templates.postRoutesGet containersgetGet routesgetCreate a routepostUpdate a routepatchDelete a routedeleteGet routegetChange the stops sequence of the routeputConvert to on-demandpostMove all orders of the route to the next scheduled routepostMove orders from a route to anotherpostSubscriptionsGet the subscriptionsgetSubscribe to order updatespostGet a subscriptiongetModify an existing subscriptionpatchUnsubscribe from order updatesdeleteUserFieldsGet the Order UserfieldsgetUpdate order UserfieldsputGet the Order Item Userfields.getTenants Integration APIAccountsGet all contacts for an accountgetCreate a new address contact for an accountpostGet an account's contactgetUpdate a contact for the provided accountpatchDelete an account's contactdeleteGet an account contacts nearby the specified positiongetGet a user's contactsgetCreate a new address contact for a userpostGet a user's contactgetUpdate a contact for the provided userpatchDelete a user's contactdeleteGet default contact for an accountgetGet all accounts.getCreate a new accountpostGet an account by idgetUpdate an existing accountpatch/api/v1/accounts/{accountId}/blockpost/api/v1/accounts/{accountId}/unblockpostGet Account WorkflowsgetGet Account Order UserFieldsgetGet the available exception codes for the accountgetGet all users for an accountgetCreate a new user for the provided accountpostGet an account's usergetUpdate user for the given accountpatchGet all available rolesgetCalendarsGet all calendarsgetGet a specific calendargetCheckpointsGet all checkpointsgetUpdate a checkpointpatchCompaniesGet all companies.getDriversGet all driversgetCreate a new driverpostGet a specific drivergetUpdate a driverpatchUpdate the driver employee informationspatch/api/v1/drivers/{id}/stopsgetGet the latest known position of a drivergetGet the driver track historypostUnlock a Driver.putArchive a Driver.postUnarchive a Driver.postGet a driver's employee documentsgetUpdate a driver's employee documentputGet a driver's additional informationget/api/v1/drivers/{id}/additional-information/{fieldId}putDriverSettlementDeductionsGet available deductionsgetGet deductions applied to the provided drivergetAdd a deduction to the provided driverpostUpdate a deduction on the provided driverputRemove a deduction on the provided driverdeleteFuelSurchargeGet all fuel surcharge schedules.getGet a fuel surcharge schedule by idgetGet all fuel surcharge tables.getGet a fuel surcharge table by idgetGet all fuel prices.getGet all fuel surcharge calculators.getUpdate an existing fuel surchargeputAdd fuel price to fuel price tablepostInvoice StatusesImportCreate an import job request for orders from a provided csv file.postGet the import mappings.getInvoicesGet unprocessed invoicesgetGet a specific invoicegetUpdate the status of one or multiple invoicespostOrder StatusesLogsCreate a new logpostGet logs for a specific contextgetGet logs for a specific contextpostGet all logs related to the attachment, grouped by context keygetGet all logging applications for tenantgetOrdersCreate a new orderpostGet multiple ordersgetCreate a duplicate orderpostCreate a return orderpostCreate a new order from a templatepostGet a quote for an orderpostAdd one or many hubs to an existing order, converting that order to a multi-segment order.postGet the pickup and delivery stops durations in minutes for a given order.getUpdate the orders with pickup and delivery stops durations.postUpdate an orderpatchGet an ordergetUpdate the order with with the order profile Id.postSearch for an order. Note: the POST /search endpoint should be favored over this one.getSearch for orders.postGet the URL and Sas needed to upload an attachment to cloud storage.getAdd uploaded attachment to an order.postUpdate an attachment from an order.postRemove an attachment from an order.deleteMark the order as verify before invoicing.postMark the order as ready for invoicing.postMark the order as verify before driver settlement.postMark the order as ready for driver settlement.postGet driver payouts for an ordergetUpdate driver payouts for an orderputGet the items from multiple ordersgetGet the items from an ordergetAdd items to orderpostUpdate items of an orderputDelete items from an orderdeleteUpdate exception codes of itempostMove items from one order to the otherpostUpdate items barcodesputGet the tracked items log from an ordergetReport a pickuppostReport a deliverypost/api/v1/orders/{orderId}/cancelpost/api/v1/orders/{orderId}/reactivatepost/api/v1/orders/{orderId}/dispatch/{driverId}post/api/v1/orders/{orderId}/unassignpostOverride the delivery charge.postAdd charges to an orderpostUpdate order chargesputRemove charges from an orderdelete/api/v1/orders/{orderId}/convert-to-ondemandpostGet the driver pickup position and delivery position for an ordergetAdd the exception codes for an orderpostDelete exception codes from orderdeleteSet the order as scanned at the checkpoint. If items are provided and the checkpoint supports "Package Tracking", the items will be tracked.postRelease the orderpostDownload the labels for all items from an ordergetMove a non-delivered order to a route.postRetrieve an order delivery ETA by OrderId of an ordergetPut an order on holdpostOrderTemplatesGet all order templatesgetCreate an order templatepostSearch for order templates.postGet a specific order templategetUpdate an order templatepatchDelete an order templatedeleteUpdate the order with with the order profile Id.postAdd one or many hubs to an existing order template, converting that order template to a multi-segment order template.postAdd charges to an order templatepostUpdate charges from an order templateputRemove charges from an order templatedeleteGet the order template itemsgetAdd items to order templatepostUpdate itemsputDelete itemsdeleteUpdate the order template account and userpostRecurringOrdersGet all recurring ordersgetCreate a recurring orderpostGet a specific recurring ordergetUpdate a recurring orderpatchDelete a recurring orderdeleteGet the available repeat option for the selected start date and a 'monthly' frequence.getAdd multiple order templates configurationspostConvert a recurring order to a recurring routepostUpdate a recurring order template configurationpatchDelete a recurring order template configurationdeleteStart a recurring orderpostStop a recurring orderpostTrigger a recurring orderpostGet recurring orders that will be executed at the provided date.getRecurringRoutesGet all recurring routesgetCreate a recurring routepostGet a specific recurring routegetUpdate a recurring routepatchDelete a recurring routedeleteAdd multiple order templates configurationspostUpdate a recurring route template configurationpatchDelete a recurring route template configurationdeleteGet recurring routes that will be executed at the provided date.getRoutePlansGet all route plansgetCreate a new route planpostGet a specific route plangetDelete the route plandeleteEdit route planputEnable or disable the route planputAdd account service level.postDelete an account service level.deleteAdd schedule.postDelete a schedule for the route plan.deleteImport a schedules file. This will replace all existing schedules of the route plan.postDownload schedules or template filegetImport zones to plan.postExport route plan's zonesgetCreates a new zone in the route planpostUpdates a zone in the route planputDelete a zone for the route plan.deleteRoutesGet containersgetCreate a container manuallypostGet routesgetCreate a routepostUpdate a routepatchDelete a routedeleteGet routegetChange the route warehouse options.postChange the stops sequence of the routeputAllocate a driverpostDeallocate a driverpostConvert all orders of the route to on-demandpostMove all orders of the route to the next scheduled routepostMove order of the route to the next scheduled routepostDispatch the orders from a single routepostDispatch the orders from a containerpostClose a route containerpostMove orders from a route to anotherpostGet routes allocated to a specific drivergetSettlementsGet settlementsgetGet a specific settlementgetUpdate the status of one or multiple settlementspostCancel a settlementpostAdd the additions/deductions to a settlementpostUpdate additions/deductions from a settlementputDelete additions/deductions from a settlementdeleteSubscriptionsGets the subscriptions for an account. The "GET /subscriptions/{entityType}/{entityId}" endpoint should be favored over this one, it will eventually be removed.postGets the subscriptionsgetSubscribe to system updatespostGets the subscriptions for a given entitygetGet a subscriptiongetModify an existing subscriptionpatchUnsubscribe from system updatesdeleteSubscribe multiple entities to system updatespostTransactionsGet all open batchesgetCreate a batchpostGet a specific batchgetUpdate a batchpatchDelete a batchdeleteSubmit the batch and create paymentspostGet a specific batch entry details with Invoices availablegetUpdate a batch entryputDelete a batch entrydeleteCreate a batch entrypostGet the URL and Sas needed to upload an attachment to cloud storage.getAdd a uploaded attachment to a transaction.postUserFieldsGet the order User FieldsgetUpdate the order User FieldsputGet the item User FieldsgetUpdate item User FieldsputPowered by Get the import mappings.get https://example.com/integration-tenants/api/v1/import/mappings
