Generate a stop consolidation plan from order IDs

Creates a consolidation plan that groups multiple orders into optimized pickup and delivery stops. The consolidation strategy determines how time windows are handled when multiple orders share the same location.

SecurityAuthToken
Request
Request Body schema: application/json
required
consolidation_strategy
string or null

Consolidation strategy. Defaults to company preference if not provided.

Enum: "SEPARATE" "LATEST" "EARLIEST"
create_unique_stops_for_each_order
boolean
Default: false

If true, each order gets its own unique delivery stop

order_ids
required
Array of strings non-empty

List of order IDs to consolidate into stops

Responses
200

Successfully generated stop consolidation plan

Response Schema: application/json
Array
order_ids
required
Array of strings

List of order IDs associated with this consolidated stop

ordinal_index
required
integer

The position of this stop in the consolidation plan

required
object (ConsolidationPlanStopData)
400

Default error response

401

Default error response

default

Default error response

post/shipments/stop-consolidation-plan/
Request samples
application/json
{
  • "consolidation_strategy": "SEPARATE",
  • "create_unique_stops_for_each_order": false,
  • "order_ids": [
    ]
}
Response samples
application/json
[
  • {
    }
]
Copyright © Shipwell 2025. All right reserved.