Routes
Update Route by ID
Update a route based on ID. This is a partial update: send only the fields to change, and omitted fields are left as they are. is_locked is currently the only editable field.
is_locked is a stored flag only. This API does not enforce it: a locked route can still be reversed, dispatched and have orders added or removed.
Returns the updated route in the same shape as GET /routes/{id}.
put/routes/{id}
Request
- Base URL: https://api.smartroutes.io/v2
- URL: https://api.smartroutes.io/v2/routes/{id}
- Auth: none declared
Path parameters
idinteger required
Example:12345
ID of the route to update.
Request body
Response
The route was updated. Setting a field to the value it already has is still a 200.
Changes
No recorded changes to this operation across all 1 revision of this API.