Skip to main content

Create a planning config

POST /v1/planning_configs

A named set of planning settings: objectives, sorting, whether to save routes automatically, traffic-aware times, and which constraints to relax. Schedules refer to one by planning_config_id.

Authentication​

Send a token issued in the Zoopit dashboard as Authorization: Bearer <token>.

Request body​

FieldTypeRequired
sort_type"delivery" | "pickup" or nullyes
sort_bynull or stringyes
objectivesarray of Objectiveyes
auto_save_routesbooleanyes
namestringyes
with_traffic_etabooleanyes
ignore_sortingnull or booleanyes
ignore_skillsnull or booleanyes
ignore_capacitynull or booleanyes
ignore_driver_shiftsnull or booleanyes
ignore_pickup_windownull or booleanyes
ignore_delivery_windownull or booleanyes
ownerstringyes
tagsarray of string
attributesobject

Responses​

201​

resource: PlanningConfig

FieldTypeRequired
sort_type"delivery" | "pickup" or nullyes
sort_bynull or stringyes
objectivesarray of Objectiveyes
auto_save_routesbooleanyes
namestringyes
with_traffic_etabooleanyes
ignore_sortingnull or booleanyes
ignore_skillsnull or booleanyes
ignore_capacitynull or booleanyes
ignore_driver_shiftsnull or booleanyes
ignore_pickup_windownull or booleanyes
ignore_delivery_windownull or booleanyes
idstringyes
created_atstringyes
modified_atnull or stringyes
deleted_atnull or stringyes
created_bystringyes
modified_bynull or stringyes
deleted_bynull or stringyes
ownersarray of stringyes
tagsarray of stringyes
attributesobjectyes

Example​

curl -X POST 'https://routes-api.cloud.zoopit.no/v1/planning_configs'
-H 'Authorization: Bearer <token>'
-H 'Content-Type: application/json'
-d '{ ... }'

Try it in the interactive Routes API reference.

Field descriptions, guides and worked examples are in the full reference, available to customers in the Zoopit dashboard under Accounts → Developer.