Sets the whole route of a draft shipment: the new points replace the old ones, in your order. Give lat and lng for every point you have them for.
- Changes data: yes
- Who can use it: Your role’s “Update” right on “Shipment” in the “Entities” group. Without it, the assistant does not see the tool.
What it is for
- Rebuild the whole route of a draft shipment. See Freight Procurement.
Example prompts
- “Set the route of TFY000000001: pickup in Kyiv on Monday 09:00 to 17:00, delivery in Lviv on Tuesday 14:00 to 18:00.”
- “Add a customs clearance in Chop to the route.”
Good to know
- Only a draft shipment.
- Every call replaces all points: send the full route, not one point.
Reference
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
tender_public_id | string | yes | The shipment’s number, for example TFY000000001. |
waypoints | array | yes | The points in order. Each needs action_type: 1 pickup, 2 delivery, 3 customs clearance, 4 customs crossing, 5 detour point. Optional: date_from and date_to as YYYY-MM-DD HH:MM:SS (give both), country_id (two-letter country code), city, state, postal_code, address, lat, lng, company_name. |
Returns
public_id of the shipment and waypoints_created.
Errors
- “Tender not found.”
- “Tender is not in draft status.”
- “No waypoints provided.”