Comment on page
Upgrading API from v2 to v3
The
references field was removed from the /api/v3/transports/ payloads.There are now 4 reference fields :
Field | Description |
|---|---|
transport.carrier_reference | The reference linked to the carrier on this transport |
delivery.shipper_reference | The reference linked to the shipper on this delivery |
site.reference | The reference linked to the origin or destination site on this delivery / segment |
So if in v2 you were sending:
{
"segments": [...],
"deliveries": [...],
"references": [
{"company": 123, "reference": "carrier ref"},
{"company": 124, "reference": "shipper ref"},
{"company": 125, "reference": "origin ref"},
{"company": 126, "reference": "destination ref"},
],
...
}
Now you have to send:
{
"carrier_reference": "carrier ref",
"segments": [{
...
"origin": {
"reference": "origin ref",
...
},
"destination": {
"reference": "destination ref",
...
}
}],
"deliveries": [{
"shipper_reference": "shipper ref",
"origin": {
"reference": "origin ref",
...
},
"destination": {
"reference": "destination ref",
...
},
...
}],
...
}
In v3 we added new types of loads in the response of deliveries. Previously the
loads field was returning the whole array of loads, updated in real-time when a trucker would change something at loading or unloading.We now have 4 fields (3 new) on
delivery :Field | Description |
|---|---|
loads | Same as in v2 : loads updated with the latest value |
planned_loads | Loads as they were when the transport was ordered |
origin_loads | Loads as they were updated by the trucker at loading |
destination_loads | Loads as they were updated by the trucker at unloading |
If you don't want to use this feature, you can keep using
loads as before when getting a transport.When creating or updating a transport or delivery, you need to use the
planned_loads field (same format as loads before).The endpoint
/public-api/v2/truckers/ was replaced by the endpoint /api/v3/manager-truckers/.You can now list all of your companies' truckers by calling
GET /api/v3/manager-truckers/.You can also re-generate a trucker's invitation code by calling
POST /api/v3/manager-truckers/{trucker_id}/generate-invite-code/.