Skip to main content
POST

/addons/route-optimization/jobs

Submit an asynchronous route optimization job

Path

POST/api/v1/partners/addons/route-optimization/jobs
Authentication requiredapi-key

Parameters

NameInTypeRequiredDescription
Idempotency-KeyheaderstringYesClient-scoped key retained indefinitely; maximum 128 chars

Request body

FieldTypeRequiredDescription
external_referencestringNo
replaces_job_idstringNo
2 fieldsCreateRouteOptimizationJobDto

Responses

202Public job aggregate committed
400ROUTE_OPT_VALIDATION_ERROR or DUPLICATE_EXTERNAL_ID
409IDEMPOTENCY_CONFLICT, ACTIVE_EXTERNAL_ID_CONFLICT, or JOB_ALREADY_PROCESSING
413ROUTE_OPT_PAYLOAD_TOO_LARGE
429ROUTE_OPT_RATE_LIMITED

Back to group: Route optimisation