Quotes and orders

Create and update quotes, approve them into orders, work with order stops, holds and invoices created from orders, and read order history.

Paths are relative to https://api.rushhourapp.com/api/v1. See the API reference overview for how to read each entry.

Quotes and order stops

Method	Path	Summary
`GET`	`/Quotes`	Searches for quotes based on provided criteria.
`POST`	`/Quotes`	Creates a new quote.
`DELETE`	`/Quotes`	Deletes multiple quotes in a single request.
`GET`	`/Quotes/{id}`	Retrieves detailed information for a specific quote.
`DELETE`	`/Quotes/{id}`	Deletes a specific quote.
`PUT`	`/Quotes/{id}/{quoteUpdateType}`	Updates an existing quote with new details.
`PUT`	`/Quotes/{id}/{quoteUpdateType}/edit`	Update a quote or order. The record and the kind of update are read from the request body.
`PUT`	`/Quotes/{id}/BuyingPrice`	Update buying price.
`GET`	`/Quotes/{id}/copyOrderToDriver`	Retrieves an order prepared for copying to a driver.
`GET`	`/Quotes/{id}/Items/{itemId}/Events`	Retrieves the shipment timeline of a single item on an order/quote.
`PUT`	`/Quotes/{id}/MoveOrderStopOnRouteToUnassigned`	Moves an assigned order stop back to the unassigned pool.
`PUT`	`/Quotes/{id}/repeat`	Creates a new order by repeating an existing quote.
`GET`	`/Quotes/{id}/Routes`	Retrieves all routes associated with a specific order.
`PUT`	`/Quotes/{id}/Swap`	Swaps pickup and delivery stops for a specific order or quote.
`GET`	`/Quotes/{id}/Trips`	Retrieves trip information for a specific quote.
`PUT`	`/Quotes/{id}/UndoOrder`	Undoes an entire order by reverting all active order stops.
`POST`	`/Quotes/{orderId}/OrderStop`	Adds a new stop (pickup, delivery, or transfer) to an existing order.
`PUT`	`/Quotes/{orderStopId}/appointmentStatus/{status}`	Updates the appointment status for a specific order stop.
`PUT`	`/Quotes/{orderStopId}/callOutcome/{callOutcome}`	Updates the call outcome for a specific order stop.
`PUT`	`/Quotes/{orderStopId}/driverInstructions`	Updates the driver instructions for a specific order stop.
`PUT`	`/Quotes/{orderStopId}/priority/{priority}`	Updates the priority of a specific order stop.
`PUT`	`/Quotes/{orderStopId}/UndoOrderStop`	Undoes a single order stop assignment.
`GET`	`/Quotes/{orderStopId}/UndoOrderStopsInfo`	Retrieves information needed to undo an order stop assignment.
`PUT`	`/Quotes/ApproveQuote`	Approves a quote and converts it into an order.
`PUT`	`/Quotes/ApproveQuotesBulk`	Approves multiple quotes in bulk and converts them into orders.
`POST`	`/Quotes/AssignHub`	Assigns the two hubs a pickup/delivery pair has been waiting on.
`GET`	`/Quotes/export`	Exports one or more quotes to an Excel file.
`POST`	`/Quotes/ImportOrderStops`	Imports order stops (pickups and deliveries) from a CSV file.
`GET`	`/Quotes/ImportOrderStopsExample`	Provides a sample CSV file for importing order stops.
`GET`	`/Quotes/QuoteCheck/{orderNumber}`	Validates whether a quote or order number already exists.
`GET`	`/Quotes/RecentUsedAddresses`	Retrieves the most recently used addresses for a specific customer.
`GET`	`/Quotes/RecentUsedCustomerContact`	Retrieves the most recently used customer contact for a given customer.
`PUT`	`/Quotes/UndoOrderStops`	Undoes one or more order stop assignments.
`POST`	`/Quotes/ValidateQuoteWarehouses`	Validates the pickup and delivery warehouses for a quote.

`GET /Quotes`

Searches for quotes based on provided criteria.

Also accepts the shared list parameters.

Response: envelope; data is OrderPagedList.

`POST /Quotes`

Creates a new quote.

Request body: Order (JSON).

Response: envelope; data is Order.

`DELETE /Quotes`

Deletes multiple quotes in a single request.

Request body: array of integer (int32) (JSON).

Response: envelope; data has no documented shape.

`GET /Quotes/{id}`

Retrieves detailed information for a specific quote.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the quote (order ID).
`moveCompletedToTheEnd`	query	boolean	No	If true, completed items are moved to the end of the response. Default: `false`.

Also accepts the shared list parameters.

Response: envelope; data is OrderDto.

`DELETE /Quotes/{id}`

Deletes a specific quote.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the quote (order ID) to delete.

Response: envelope; data has no documented shape.

`PUT /Quotes/{id}/{quoteUpdateType}`

Updates an existing quote with new details.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the quote/order being updated.
`quoteUpdateType`	path	integer (int32)	Yes	One of: `0` (PickupDraft), `1` (PickupDone), `2` (DeliveryDraft), `3` (DeliveryDone), `4` (Pricing), `5` (Recurrence), `6` (OrderRouteBehavior).
`completeQuoteRouteItems`	query	boolean	No	Flag indicating whether to complete route items as part of the update. Default: `false`.
`createCustomerFromQuote`	query	boolean	No	Flag indicating whether to create a customer record from the quote when transitioning to an order. Default: `false`.
`createInvoice`	query	boolean	No	Flag indicating whether to create an invoice as part of the update. Default: `true`.
`returnQuote`	query	boolean	No	Indicates whether the updated quote should be returned in the response. Default: `true`.

Request body: Order (JSON).

Response: envelope; data is Order.

`PUT /Quotes/{id}/{quoteUpdateType}/edit`

Update a quote or order. The record and the kind of update are read from the request body.

The id and quoteUpdateType values in the path are not used. The API updates the order given by orderId in the body, using the quoteUpdateType from the body, so make sure the body carries the values you mean.

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Not used. The order is taken from `orderId` in the request body.
`quoteUpdateType`	path	string	Yes	Not used. The kind of update is taken from `quoteUpdateType` in the request body.

Request body: UpdateQuoteDto (JSON).

Response: envelope; data is Order.

`PUT /Quotes/{id}/BuyingPrice`

Update buying price.

Required access: the Company Admin role.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes

Request body: UpdateBuyingPriceDto (JSON).

Response: envelope; data has no documented shape.

`GET /Quotes/{id}/copyOrderToDriver`

Retrieves an order prepared for copying to a driver.

Required access: the Copy Order for Driver permission.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the order to prepare for driver copy.
`orderStopId`	query	integer (int32)	No	Optional order stop ID. If provided, filters to only the specified stop.
`routeId`	query	integer (int32)	No	Optional route ID. If provided, filters stops and route items to only those belonging to the specified route.

Response: envelope; data is OrderDto.

`GET /Quotes/{id}/Items/{itemId}/Events`

Retrieves the shipment timeline of a single item on an order/quote.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the order/quote the item belongs to.
`itemId`	path	integer (int32)	Yes	Unique identifier of the order item whose timeline is being retrieved.

Response: envelope; data is array of OrderItemEventDto.

`PUT /Quotes/{id}/MoveOrderStopOnRouteToUnassigned`

Moves an assigned order stop back to the unassigned pool.

Required access: the Assign/Unassign Order permission.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the order stop to be moved to unassigned.

Request body: AttemptRequest (JSON).

Response: envelope; data has no documented shape.

`PUT /Quotes/{id}/repeat`

Creates a new order by repeating an existing quote.

Required access: the Repeat Order permission.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the quote to be repeated.

Response: envelope; data is OrderDto.

`GET /Quotes/{id}/Routes`

Retrieves all routes associated with a specific order.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the order whose routes are being retrieved.
`includeInactiveRoutes`	query	boolean	No	Flag indicating whether inactive routes should be included in the response. Default: `true`.

Response: envelope; data is RoutePagedList.

`PUT /Quotes/{id}/Swap`

Swaps pickup and delivery stops for a specific order or quote.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the order or quote whose stops are being swapped.

Response: envelope; data has no documented shape.

`GET /Quotes/{id}/Trips`

Retrieves trip information for a specific quote.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the quote whose trips are being retrieved.

Response: envelope; data is array of OrderTrip.

`PUT /Quotes/{id}/UndoOrder`

Undoes an entire order by reverting all active order stops.

Required access: the Undo Order permission.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the order to be undone.

Response: envelope; data has no documented shape.

`POST /Quotes/{orderId}/OrderStop`

Adds a new stop (pickup, delivery, or transfer) to an existing order.

Parameters

Name	In	Type	Required	Description
`orderId`	path	integer (int32)	Yes	Unique identifier of the order to which the stop will be added.

Request body: OrderStop (JSON).

Response: envelope; data is OrderStop.

`PUT /Quotes/{orderStopId}/appointmentStatus/{status}`

Updates the appointment status for a specific order stop.

Parameters

Name	In	Type	Required	Description
`orderStopId`	path	integer (int32)	Yes	Unique identifier of the order stop whose appointment status is being updated.
`status`	path	string	Yes	The new appointment status to assign to the order stop. One of: `Nothing`, `Request`, `Requested`, `Approve`, `Accepted`, `Review`, `NewAppointment`.
`appointmentCode`	query	string	No	Optional confirmation code.
`appointmentEmail`	query	string	No
`sendRequest`	query	boolean	No	Opt in to sending the appointment request email. Default: `false`.

Response: envelope; data is OrderStop.

`PUT /Quotes/{orderStopId}/callOutcome/{callOutcome}`

Updates the call outcome for a specific order stop.

Parameters

Name	In	Type	Required	Description
`callOutcome`	path	integer (int32)	Yes	The new call outcome value to assign to the order stop. One of: `1` (CallNotMade), `2` (Possible), `3` (NotPossible).
`orderStopId`	path	integer (int32)	Yes	Unique identifier of the order stop whose call outcome is being updated.

Response: envelope; data is OrderStop.

`PUT /Quotes/{orderStopId}/driverInstructions`

Updates the driver instructions for a specific order stop.

Required access: the Edit Orders permission.

Parameters

Name	In	Type	Required	Description
`orderStopId`	path	integer (int32)	Yes	Unique identifier of the order stop whose driver instructions are being updated.

Request body: OrderStopDriverInstructionsDto (JSON).

Response: envelope; data has no documented shape.

`PUT /Quotes/{orderStopId}/priority/{priority}`

Updates the priority of a specific order stop.

Required access: the Update stop priority permission.

Parameters

Name	In	Type	Required	Description
`orderStopId`	path	integer (int32)	Yes	Unique identifier of the order stop whose priority is being updated.
`priority`	path	string	Yes	The new priority value to assign to the order stop. One of: `Low`, `Regular`, `High`.

Response: envelope; data has no documented shape.

`PUT /Quotes/{orderStopId}/UndoOrderStop`

Undoes a single order stop assignment.

Required access: the Undo Order permission.

Parameters

Name	In	Type	Required	Description
`orderStopId`	path	integer (int32)	Yes	Unique identifier of the order stop to be undone.

Response: envelope; data has no documented shape.

`GET /Quotes/{orderStopId}/UndoOrderStopsInfo`

Retrieves information needed to undo an order stop assignment.

Required access: the Undo Order permission.

Parameters

Name	In	Type	Required	Description
`orderStopId`	path	integer (int32)	Yes	Unique identifier of the order stop for which undo information is requested.

Response: envelope; data is array of OrderStop.

`PUT /Quotes/ApproveQuote`

Approves a quote and converts it into an order.

Required access: the Approve Quote permission.

Parameters

Name	In	Type	Required	Description
`quoteId`	query	integer (int32)	No	Unique identifier of the quote to be approved.

Response: envelope; data has no documented shape.

`PUT /Quotes/ApproveQuotesBulk`

Approves multiple quotes in bulk and converts them into orders.

Required access: the Approve Quote permission.

Request body: array of integer (int32) (JSON).

Response: envelope; data has no documented shape.

`POST /Quotes/AssignHub`

Assigns the two hubs a pickup/delivery pair has been waiting on.

Request body: AssignHubRequest (JSON).

Response: envelope; data has no documented shape.

`GET /Quotes/export`

Exports one or more quotes to an Excel file.

Parameters

Name	In	Type	Required	Description
`ids`	query	array of integer (int32)	No	List of quote IDs (order IDs) to export.
`sample`	query	boolean	No	If true, generates a sample Excel file instead of actual quote data.

Response: a file download, not JSON.

`POST /Quotes/ImportOrderStops`

Imports order stops (pickups and deliveries) from a CSV file.

Required access: the Edit Orders permission.

Parameters

Name	In	Type	Required	Description
`orderId`	query	integer (int32)	No	Optional existing order ID. If provided, stops are imported into this order. Default: `0`.

Request body: form data (multipart/form-data).

Field	Type
`csvFile`	file
`orderJson`	string

Response: envelope; data has no documented shape.

`GET /Quotes/ImportOrderStopsExample`

Provides a sample CSV file for importing order stops.

Response: a file download, not JSON.

`GET /Quotes/QuoteCheck/{orderNumber}`

Validates whether a quote or order number already exists.

Parameters

Name	In	Type	Required	Description
`orderNumber`	path	string	Yes	The order number to validate against existing orders.

Response: envelope; data has no documented shape.

`GET /Quotes/RecentUsedAddresses`

Retrieves the most recently used addresses for a specific customer.

Parameters

Name	In	Type	Required	Description
`count`	query	integer (int32)	No	Maximum number of addresses to return. Default: `10`.
`customerId`	query	integer (int32)	No	Unique identifier of the customer whose recent addresses are being retrieved.

Response: envelope; data is array of Address.

`GET /Quotes/RecentUsedCustomerContact`

Retrieves the most recently used customer contact for a given customer.

Parameters

Name	In	Type	Required	Description
`customerId`	query	integer (int32)	No	Unique identifier of the customer whose recent contact is being retrieved.

Response: envelope; data is integer (int32).

`PUT /Quotes/UndoOrderStops`

Undoes one or more order stop assignments.

Required access: the Undo Order permission.

Request body: array of integer (int32) (JSON).

Response: envelope; data has no documented shape.

`POST /Quotes/ValidateQuoteWarehouses`

Validates the pickup and delivery warehouses for a quote.

Request body: QuoteWarehousesRequest (JSON).

Response: envelope; data has no documented shape.

Orders

Method	Path	Summary
`GET`	`/Orders`	Searches for orders based on the provided criteria.
`GET`	`/Orders/{id}/Activities`	Retrieves all stop activities for a specific order.
`PUT`	`/Orders/{id}/Activities/{activityId}/Note`	Adds or updates a note on a specific activity log event.
`DELETE`	`/Orders/{id}/Activities/{activityId}/Note`	Deletes a note from a specific activity log event.
`GET`	`/Orders/{id}/ActivityLog`	Retrieves the activity log for a specific order.
`GET`	`/Orders/{id}/AuditLog`	Get order audit log.
`GET`	`/Orders/{id}/Barcodes`	Get order barcodes.
`PUT`	`/Orders/{id}/close`	Closes an existing order.
`PUT`	`/Orders/{id}/close-and-create-invoice`	Closes an order and creates a new invoice.
`GET`	`/Orders/{id}/contacts`	Retrieves the list of customer contact details associated with a specific order.
`POST`	`/Orders/{id}/Hold`	Places a hold on an entire order (covers every delivery / drop-off stop).
`GET`	`/Orders/{id}/Holds`	Lists the holds on an order (active + resolved history).
`PUT`	`/Orders/{id}/invoice`	Creates or replaces an invoice associated with a specific order.
`DELETE`	`/Orders/{id}/invoice`	Deletes the invoice(s) associated with a specific order.
`GET`	`/Orders/{id}/JobSiteEmails`	Retrieves job site email addresses associated with a specific order.
`GET`	`/Orders/{id}/OrderStopsWarnings`	Retrieves warnings and validation issues for order stops.
`DELETE`	`/Orders/{id}/Permanent`	Permanently deletes an existing order and all related data.
`PUT`	`/Orders/{id}/priority/{priority}`	Updates the priority of an existing order.
`PUT`	`/Orders/{id}/Restore`	Restores a previously deleted order.
`PUT`	`/Orders/{id}/revert`	Revert order to quote.
`GET`	`/Orders/{id}/RouteCards`	Retrieves route card details for a specific order.
`GET`	`/Orders/{id}/SentEmails`	Retrieves sent emails associated with a specific order.
`GET`	`/Orders/{id}/Stops`	Get active order stops.
`POST`	`/Orders/{id}/Stops/{orderStopId}/Hold`	Places a hold on a single delivery (drop-off) stop of an order.
`PUT`	`/Orders/{id}/Stops/{orderStopId}/WaitingTime`	Records waiting time (arrival, departure, waiting and free time) for one stop of the order.
`GET`	`/Orders/{id}/StopsInfo`	Retrieves detailed stop and item information for an order.
`GET`	`/Orders/{id}/trips`	Retrieves the calculated trips associated with a specific order.
`PUT`	`/Orders/{id}/UpdateOrderStopsDateAndTime`	Updates the date and time information for one or more order stops.
`GET`	`/Orders/Address`	Searches and returns a list of addresses based on filters and search criteria.
`POST`	`/Orders/CalculatePrice`	Calculates pricing information for a given order.
`POST`	`/Orders/Holds/{holdId}/Resolve`	Resolves (removes) a hold manually ("mark resolved").
`GET`	`/Orders/MapView`	Get orders with the locations needed to show them on a map.
`GET`	`/Orders/OrderListBasicDetails`	Retrieves a paginated list of orders with basic details.
`GET`	`/Orders/OrderQuoteList`	Retrieves a paginated list of orders and quotes based on search criteria.
`GET`	`/Orders/Stats`	Get order statistics.

`GET /Orders`

Searches for orders based on the provided criteria.

Also accepts the shared list parameters.

Response: envelope; data is OrderPagedList.

`GET /Orders/{id}/Activities`

Retrieves all stop activities for a specific order.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the order whose stop activities are being retrieved.
`orderStopId`	query	integer (int32)	No	Optional identifier of a specific order stop.

Response: envelope; data is array of OrderStopActivityDto.

`PUT /Orders/{id}/Activities/{activityId}/Note`

Adds or updates a note on a specific activity log event.

Required access: the Edit Orders permission.

Parameters

Name	In	Type	Required	Description
`activityId`	path	integer (int32)	Yes	Unique identifier of the activity event to add the note to.
`id`	path	integer (int32)	Yes	Unique identifier of the order.

Request body: ActivityNoteDto (JSON).

Response: envelope; data is OrderStopActivityDto.

`DELETE /Orders/{id}/Activities/{activityId}/Note`

Deletes a note from a specific activity log event.

Required access: the Edit Orders permission.

Parameters

Name	In	Type	Required	Description
`activityId`	path	integer (int32)	Yes	Unique identifier of the activity event whose note should be deleted.
`id`	path	integer (int32)	Yes	Unique identifier of the order.

Response: envelope; data has no documented shape.

`GET /Orders/{id}/ActivityLog`

Retrieves the activity log for a specific order.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the order whose activity log is being retrieved.

Response: envelope; data is array of OrderStopActivityDto.

`GET /Orders/{id}/AuditLog`

Get order audit log.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the order or quote.
`ActorType`	query	string	No	One of: `Staff`, `Driver`, `CustomerPortal`, `ExternalAnonymous`, `AiAgent`, `System`.
`Category`	query	string	No	One of: `Lifecycle`, `Details`, `Stops`, `Items`, `Pricing`, `Charges`, `Dispatch`, `Accounting`, `Other`.
`FromUtc`	query	string (date-time)	No
`Page`	query	integer (int32)	No
`PageSize`	query	integer (int32)	No
`Search`	query	string	No
`ToUtc`	query	string (date-time)	No

Response: envelope; data is OrderAuditLogDto.

`GET /Orders/{id}/Barcodes`

Get order barcodes.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes

Response: envelope; data is array of OrderBarcodeStopDto.

`PUT /Orders/{id}/close`

Closes an existing order.

Required access: the Close and Create Invoice permission.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the order to be closed.

Response: envelope; data is Invoice.

`PUT /Orders/{id}/close-and-create-invoice`

Closes an order and creates a new invoice.

Required access: the Close and Create Invoice permission.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the order to be closed and invoiced.

Request body: ReplaceOrCreateNewInvoiceRequest (JSON).

Response: envelope; data has no documented shape.

`GET /Orders/{id}/contacts`

Retrieves the list of customer contact details associated with a specific order.

Required access: the Send and download BOL permission.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the order whose customer contacts are being retrieved.
`requestCustomerId`	query	integer (int32)	No	Optional customer ID. If provided, retrieves contacts for this customer in addition to the order’s primary customer.

Response: envelope; data is array of CustomerContactDetailsResponse.

`POST /Orders/{id}/Hold`

Places a hold on an entire order (covers every delivery / drop-off stop).

Required access: the Place hold on order/delivery permission.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes

Request body: PlaceHoldDto (JSON).

Response: envelope; data is OrderHoldDto.

`GET /Orders/{id}/Holds`

Lists the holds on an order (active + resolved history).

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes
`activeOnly`	query	boolean	No	Default: `false`.

Response: envelope; data is array of OrderHoldDto.

`PUT /Orders/{id}/invoice`

Creates or replaces an invoice associated with a specific order.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the order for which the invoice is being created.

Request body: ReplaceOrCreateNewInvoiceRequest (JSON).

Response: envelope; data is Invoice.

`DELETE /Orders/{id}/invoice`

Deletes the invoice(s) associated with a specific order.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the order whose associated invoice(s) should be deleted.

Response: envelope; data has no documented shape.

`GET /Orders/{id}/JobSiteEmails`

Retrieves job site email addresses associated with a specific order.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the order whose job site emails are being retrieved.
`requestCustomerId`	query	integer (int32)	No	Optional customer ID. If provided, filters job site emails to those associated with this customer.

Response: envelope; data is array of JobSiteEmailDto.

`GET /Orders/{id}/OrderStopsWarnings`

Retrieves warnings and validation issues for order stops.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the order whose stop warnings are being retrieved.

Response: envelope; data is array of OrderStopWarningDto.

`DELETE /Orders/{id}/Permanent`

Permanently deletes an existing order and all related data.

Required access: the Company Admin role.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the order to be permanently deleted.

Response: envelope; data has no documented shape.

`PUT /Orders/{id}/priority/{priority}`

Updates the priority of an existing order.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the order.
`priority`	path	string	Yes	New priority value to assign to the order. One of: `Low`, `Regular`, `High`.

Response: envelope; data is Order.

`PUT /Orders/{id}/Restore`

Restores a previously deleted order.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the order to restore.

Response: envelope; data has no documented shape.

`PUT /Orders/{id}/revert`

Revert order to quote.

Required access: the Revert to Quote permission.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the order to revert.

Response: envelope; data is Order.

`GET /Orders/{id}/RouteCards`

Retrieves route card details for a specific order.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the order whose route cards are being retrieved.

Response: envelope; data is RouteCardListDto.

`GET /Orders/{id}/SentEmails`

Retrieves sent emails associated with a specific order.

Required access: the Send and download BOL permission.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the order whose sent emails are being retrieved.
`requestCustomerId`	query	integer (int32)	No	Optional filter.
`suggestCustomerPastSentEmails`	query	boolean	No	Optional flag. Default: `false`.

Response: envelope; data is array of SentEmail.

`GET /Orders/{id}/Stops`

Get active order stops.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Order identifier.

Response: envelope; data is array of OrderStop.

`POST /Orders/{id}/Stops/{orderStopId}/Hold`

Places a hold on a single delivery (drop-off) stop of an order.

Required access: the Place hold on order/delivery permission.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes
`orderStopId`	path	integer (int32)	Yes

Request body: PlaceHoldDto (JSON).

Response: envelope; data is OrderHoldDto.

`PUT /Orders/{id}/Stops/{orderStopId}/WaitingTime`

Records waiting time (arrival, departure, waiting and free time) for one stop of the order.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Order id.
`orderStopId`	path	integer (int32)	Yes	Order stop id.

Request body: OrderStopWaitingTimeDto (JSON).

Response: envelope; data has no documented shape.

`GET /Orders/{id}/StopsInfo`

Retrieves detailed stop and item information for an order.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the order.

Response: envelope; data is OrderInfoDto.

`GET /Orders/{id}/trips`

Retrieves the calculated trips associated with a specific order.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the order whose trips are being retrieved.

Response: envelope; data is array of OrderTrip.

`PUT /Orders/{id}/UpdateOrderStopsDateAndTime`

Updates the date and time information for one or more order stops.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes	Unique identifier of the order whose stop dates and times are being updated.

Request body: OrderStopDateAndTimeDto (JSON).

Response: envelope; data is OrderDto.

`GET /Orders/Address`

Searches and returns a list of addresses based on filters and search criteria.

Parameters

Name	In	Type	Required	Description
`DeliveryAddresses`	query	boolean	No
`PickUpAddresses`	query	boolean	No

Also accepts the shared list parameters.

Response: envelope; data is AddressPagedList.

`POST /Orders/CalculatePrice`

Calculates pricing information for a given order.

Request body: Order (JSON).

Response: envelope; data is Order.

`POST /Orders/Holds/{holdId}/Resolve`

Resolves (removes) a hold manually ("mark resolved").

Required access: the Resolve/remove hold permission.

Parameters

Name	In	Type	Required	Description
`holdId`	path	integer (int32)	Yes

Request body: ResolveHoldDto (JSON).

Response: envelope; data is OrderHoldDto.

`GET /Orders/MapView`

Get orders with the locations needed to show them on a map.

Parameters

Name	In	Type	Required	Description
`maxOrders`	query	integer (int32)	No	Optional cap override. Default: `1000`.
`Sources`	query	array of integer (int32)	No	One of: `0` (Default), `1` (Web), `2` (CustomerPortal).

Also accepts the shared list parameters.

Response: envelope; data is OrdersMapViewResDto.

`GET /Orders/OrderListBasicDetails`

Retrieves a paginated list of orders with basic details.

Parameters

Name	In	Type	Required	Description
`includeInvoiceInfo`	query	boolean	No	If true, invoice information is included in the results. Default: `false`.
`includeQuotes`	query	boolean	No	If true, quotes are included in the results along with orders. Default: `false`.
`moveCompletedToTheEnd`	query	boolean	No	If true, completed orders are moved to the end of the result set. Default: `false`.
`Sources`	query	array of integer (int32)	No	One of: `0` (Default), `1` (Web), `2` (CustomerPortal).

Also accepts the shared list parameters.

Response: envelope; data is OrderListDtoPagedList.

`GET /Orders/OrderQuoteList`

Retrieves a paginated list of orders and quotes based on search criteria.

Also accepts the shared list parameters.

Response: envelope; data is OrderPagedList.

`GET /Orders/Stats`

Get order statistics.

Also accepts the shared list parameters.

Response: envelope; data is OrderStats.

Load units

Method	Path	Summary
`POST`	`/LoadUnits`	Add load unit.
`PUT`	`/LoadUnits/{id}`	Update load unit.
`DELETE`	`/LoadUnits/{id}`	Delete load unit.
`DELETE`	`/LoadUnits/{id}/Content`	Delete load unit content.
`GET`	`/LoadUnits/{id}/OrderItemStop`	Get load unit.

`POST /LoadUnits`

Add load unit.

Request body: LoadUnit (JSON).

Response: envelope; data is LoadUnit.

`PUT /LoadUnits/{id}`

Update load unit.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes

Request body: LoadUnit (JSON).

Response: envelope; data is LoadUnit.

`DELETE /LoadUnits/{id}`

Delete load unit.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes

Response: envelope; data is LoadUnit.

`DELETE /LoadUnits/{id}/Content`

Delete load unit content.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes

Response: envelope; data is LoadUnitContent.

`GET /LoadUnits/{id}/OrderItemStop`

Get load unit.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes

Response: envelope; data is array of LoadUnit.

Freight payments

Method	Path	Summary
`POST`	`/FreightPayments`	Add freight payment.
`PUT`	`/FreightPayments/{id}`	Update freight payment.
`GET`	`/FreightPayments/{id}/Order`	Get freight payments.

`POST /FreightPayments`

Add freight payment.

Required access: the Company Admin role.

Request body: FreightPayment (JSON).

Response: envelope; data has no documented shape.

`PUT /FreightPayments/{id}`

Update freight payment.

Required access: the Company Admin role.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes

Request body: FreightPayment (JSON).

Response: envelope; data has no documented shape.

`GET /FreightPayments/{id}/Order`

Get freight payments.

Required access: the Company Admin role.

Parameters

Name	In	Type	Required	Description
`id`	path	integer (int32)	Yes

Response: envelope; data has no documented shape.

Order tags

Method	Path	Summary
`GET`	`/OrderTags/{orderId}`	Get order tags.
`POST`	`/OrderTags/{orderId}/{tagId}`	Add order tag.
`DELETE`	`/OrderTags/{orderId}/{tagId}`	Delete order tag.

`GET /OrderTags/{orderId}`

Get order tags.

Parameters

Name	In	Type	Required	Description
`orderId`	path	integer (int32)	Yes

Response: envelope; data is array of OrderTag.

`POST /OrderTags/{orderId}/{tagId}`

Add order tag.

Parameters

Name	In	Type	Required	Description
`orderId`	path	integer (int32)	Yes
`tagId`	path	integer (int32)	Yes

Response: envelope; data is OrderTag.

`DELETE /OrderTags/{orderId}/{tagId}`

Delete order tag.

Parameters

Name	In	Type	Required	Description
`orderId`	path	integer (int32)	Yes
`tagId`	path	integer (int32)	Yes

Response: envelope; data has no documented shape.

Method	Path	Summary
`GET`	`/Tags`	Get tags.
`POST`	`/Tags`	Add tag.
`PUT`	`/Tags/{id}`	Update tag.
`DELETE`	`/Tags/{id}`	Delete tag.