1. Overview

This is the reference guide for the integration with WanaTruck via API.

1.1. Version information

Version : 1.0.1

1.2. Contact information

Contact : Support
Contact Email : soporte@wanatruck.com

1.3. URI scheme

Protocol : https
Host : api.wanatruck.com
BasePath : /service/freight

1.4. Other formats

PDF : Click here
Swagger: Click here

2. Security

2.1. oauth2

Type : oauth2
Flow : Client Credentials
Token URL : https://api.wanatruck.com/oauth/client

2.2. Authorization

Type : Bearer Token
Name : AUTHORIZATION
In : HEADER
Scope :

Name Description

integration

access all

2.3. Example HTTP request

POST /auth/client HTTP/1.1
Content-Type: application/json; charset=UTF-8
Host: api.wanatruck.com
Content-Length: 113

{"grant_type":"client_credentials","scope":"integration","client_secret":"CLIENT_SECRET","client_id":"CLIENT_ID"}

2.4. Example HTTP response

HTTP/1.1 200 OK
Pragma: no-cache
Set-Cookie: access_token=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJpbnRlZ3JhdGlvbiJdLCJleHAiOjE2MzYwMjEwNzcsImlhdCI6MTYzNjAxOTI3NywiYXV0aG9yaXRpZXMiOlsiUk9MRV9BRE1JTiJdLCJqdGkiOiIzOWU3NGUwMi1lYzg2LTQ4MTQtYTBkZC01ZmZhMTM5Y2E4NGQiLCJjbGllbnRfaWQiOiJDTElFTlRfSUQifQ.Xvz1QT5R2a4buXmfamf05IPlzYzGGI4MWM0vI0Q0SHscgnUhi11VNFM4MexdgEOSqVc8U6CxytDyBs5rJ9Uhkxfr8gwOtU-iMSSE3rsDur1hdhfa0vH_5D88fMkFCuIxI3UOvToh87lcVvrX8C5l5A6yTF7YFskAX8bIadiYaBROBCpSIW1aIq6s2UTAeMRegRF1x5ZVc0JMw4mzLqoVggcQHqceLzJwOWb4-CFXPJXCmqznF88FlU7uBB0HxUOfp2el5SWJcUv21ApZaENfEk7R0Zl_SRJPZtOpWhqmCFGrpK8rFxF-NSIkPW2C1YfEvAFAILjjhaH3KHtp41oTWg; path=/; HttpOnly
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Date: Thu, 04 Nov 2021 09:47:57 GMT
Connection: keep-alive
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 771
Transfer-Encoding: chunked

{
  "access_token" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJpbnRlZ3JhdGlvbiJdLCJleHAiOjE2MzYwMjEwNzcsImlhdCI6MTYzNjAxOTI3NywiYXV0aG9yaXRpZXMiOlsiUk9MRV9BRE1JTiJdLCJqdGkiOiIzOWU3NGUwMi1lYzg2LTQ4MTQtYTBkZC01ZmZhMTM5Y2E4NGQiLCJjbGllbnRfaWQiOiJDTElFTlRfSUQifQ.Xvz1QT5R2a4buXmfamf05IPlzYzGGI4MWM0vI0Q0SHscgnUhi11VNFM4MexdgEOSqVc8U6CxytDyBs5rJ9Uhkxfr8gwOtU-iMSSE3rsDur1hdhfa0vH_5D88fMkFCuIxI3UOvToh87lcVvrX8C5l5A6yTF7YFskAX8bIadiYaBROBCpSIW1aIq6s2UTAeMRegRF1x5ZVc0JMw4mzLqoVggcQHqceLzJwOWb4-CFXPJXCmqznF88FlU7uBB0HxUOfp2el5SWJcUv21ApZaENfEk7R0Zl_SRJPZtOpWhqmCFGrpK8rFxF-NSIkPW2C1YfEvAFAILjjhaH3KHtp41oTWg",
  "token_type" : "bearer",
  "expires_in" : 1798,
  "scope" : "integration",
  "iat" : 1636019277,
  "jti" : "39e74e02-ec86-4814-a0dd-5ffa139ca84d"
}

2.5. Example Curl request

$ curl 'https://api.wanatruck.com/auth/client' -i -X POST \
    -H 'Content-Type: application/json; charset=UTF-8' \
    -d '{"grant_type":"client_credentials","scope":"integration","client_secret":"CLIENT_SECRET","client_id":"CLIENT_ID"}'

3. Paths

3.1. Create or update freight

POST /service/freight/api/shippers/v1/freights

3.1.1. Description

This method creates or updates a freight and set it in a specific state.

3.1.2. Parameters

Type Name Description Schema

Body

freightDTO
required

freightDTO

Freight

3.1.3. Responses

HTTP Code Description Schema

200

OK

Freight

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

3.1.4. Consumes

  • application/json

3.1.5. Produces

  • application/json

3.1.6. Tags

  • freight-external-resource

3.1.7. Security

Type Name Scopes

oauth2

oauth2

read,trust,write

Unknown

integration

3.1.8. Example HTTP request

POST /api/shippers/v1/freights HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJpbnRlZ3JhdGlvbiJdLCJleHAiOjE2MzYwMjEwNzUsImlhdCI6MTYzNjAxOTI3NSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9BRE1JTiJdLCJqdGkiOiJlZjc4Y2M2Mi03OWViLTQzYjYtOTk4NS0zZTg4YjliMzViNDEiLCJjbGllbnRfaWQiOiJDTElFTlRfSUQifQ.SeDFoKoezsN8gr7SPN6-tBEA_b952DTcHpHQuCsvDHkP1ryTjwPBp7A1CpmoioIi8vmCSMwPuTdFsTGBIvUW94xzQq0wP4KukCNzkm80Vd4gCfzEDRXTYu4DXpMWh5PrNNP_qwv38XlZB_yRfAqgXV3Yjv7rEy_9VR4uQoiK-oVa508LMKBL243ZFIDq6fTkWtoGhz-pRrCr4mF9H0B9gGuXvI6p-V3-nEg81fXe2aJUHP0teAG8q5OPx8-q93ENJpaWJSByLE_GXRJ3EgzDMGJyjpAjZeBU39y1I9BAyNgiukCgVdhzZD3tif91qkLscQLJGW02kLRuV9zisDBmFw
Content-Length: 3715
Host: api.wanatruck.com
Content-Type: application/json

{
  "shipper" : {
    "reference" : "1234567-15",
    "name" : "SHIPPER12",
    "taxIdentifier" : "IDSHIPPER12",
    "taxAddress" : {
      "streetName" : "STREET NAME AND NUMBER",
      "postalCode" : "POSTAL CODE",
      "city" : "CITY",
      "stateProvince" : "STATE PROVINCE",
      "country" : "COUNTRY",
      "countryISOCode" : "ES"
    },
    "phone" : "PHONESHIPPER12",
    "m2mId" : "148",
    "costCenterName" : "NORT"
  },
  "contractualCarrier" : {
    "reference" : "1454588-18",
    "name" : "CARRIER10",
    "taxIdentifier" : "IDCARRIER10",
    "taxAddress" : {
      "streetName" : "STREET NAME AND NUMBER",
      "postalCode" : "POSTAL CODE",
      "city" : "CITY",
      "stateProvince" : "STATE PROVINCE",
      "country" : "COUNTRY",
      "countryISOCode" : "ES"
    },
    "phone" : "PHONECARRIER10",
    "m2mId" : "332",
    "costCenterName" : "MADRID"
  },
  "effectiveCarrier" : {
    "reference" : "1454632-21",
    "name" : "CARRIER11",
    "taxIdentifier" : "IDCARRIER11",
    "taxAddress" : {
      "streetName" : "STREET NAME AND NUMBER",
      "postalCode" : "POSTAL CODE",
      "city" : "CITY",
      "stateProvince" : "STATE PROVINCE",
      "country" : "COUNTRY",
      "countryISOCode" : "ES"
    },
    "phone" : "PHONECARRIER11",
    "m2mId" : "286",
    "costCenterName" : "CENTER"
  },
  "assignationStatus" : "ACCEPTED",
  "reference" : "13456",
  "instructions" : "Prepare some straps",
  "agreements" : "Toll paid",
  "carrierObservations" : null,
  "type" : "FULL",
  "stops" : [ {
    "freightReference" : "REF-000456",
    "type" : "LOAD",
    "position" : 1,
    "address" : {
      "streetName" : "STREET NAME AND NUMBER",
      "postalCode" : "POSTAL CODE",
      "city" : "CITY",
      "stateProvince" : "STATE PROVINCE",
      "country" : "COUNTRY",
      "countryISOCode" : "ES"
    },
    "company" : {
      "reference" : null,
      "name" : "EXPEDITEUR12",
      "taxIdentifier" : "IDEXPEDITEUR12",
      "taxAddress" : null,
      "phone" : "PHONEEXPEDITEUR12",
      "m2mId" : null,
      "costCenterName" : null
    },
    "contactUserFirstName" : "FIRST NAME",
    "contactUserLastName" : "LAST NAME",
    "contactUserEmail" : "a_valid@email.com",
    "tare" : 5000,
    "grossWeight" : 18000,
    "netWeight" : 15000,
    "packages" : 30,
    "price" : null,
    "identification" : null,
    "reservations" : "RESERVATIONS",
    "nature" : "DESCRIPTION OF PRODUCTS",
    "packaging" : "PALETS",
    "sealNumber" : "SEAL NUMBER",
    "since" : "2021-03-21T14:30:00+01:00",
    "until" : "2021-03-21T15:00:00+01:00",
    "driverName" : "DRIVER NAME",
    "driverTaxIdentifier" : "DRIVER TAX IDENTIFIER",
    "arrivalDate" : "2021-03-21T14:35:22+01:00",
    "loadingStartDate" : "2021-03-21T15:45:22+01:00",
    "loadingEndDate" : "2021-03-21T17:17:19+01:00",
    "departureDate" : "2021-03-21T17:30:15+01:00",
    "point" : {
      "lat" : "40.4167",
      "lng" : "-3.70325"
    }
  } ],
  "transportType" : "BOX",
  "adr" : false,
  "waste" : false,
  "documentType" : "ECMR",
  "status" : "WORKING_END",
  "m2mId" : "2367",
  "price" : 360.5,
  "payer" : "LOADER",
  "nextStopPosition" : 1,
  "minTemp1" : null,
  "maxTemp1" : null,
  "minTemp2" : null,
  "maxTemp2" : null,
  "minTemp3" : null,
  "maxTemp3" : null,
  "routeName" : null,
  "routeM2mId" : null,
  "attachments" : null,
  "drivers" : [ ],
  "vehicles" : [ ],
  "links" : null,
  "events" : null,
  "assignations" : null,
  "startDate" : "2021-03-21T14:35:22+01:00",
  "incidentStart" : null,
  "incidentEnd" : null,
  "incident" : null,
  "point" : null
}

3.1.9. Example HTTP response

HTTP/1.1 200 OK
Content-Length: 3789
Content-Type: application/json;charset=UTF-8

{
  "shipper" : {
    "reference" : "1234567-15",
    "name" : "SHIPPER12",
    "taxIdentifier" : "IDSHIPPER12",
    "taxAddress" : {
      "streetName" : "STREET NAME AND NUMBER",
      "postalCode" : "POSTAL CODE",
      "city" : "CITY",
      "stateProvince" : "STATE PROVINCE",
      "country" : "COUNTRY",
      "countryISOCode" : "ES"
    },
    "phone" : "PHONESHIPPER12",
    "m2mId" : "148",
    "costCenterName" : "NORT"
  },
  "contractualCarrier" : {
    "reference" : "1454588-18",
    "name" : "CARRIER10",
    "taxIdentifier" : "IDCARRIER10",
    "taxAddress" : {
      "streetName" : "STREET NAME AND NUMBER",
      "postalCode" : "POSTAL CODE",
      "city" : "CITY",
      "stateProvince" : "STATE PROVINCE",
      "country" : "COUNTRY",
      "countryISOCode" : "ES"
    },
    "phone" : "PHONECARRIER10",
    "m2mId" : "332",
    "costCenterName" : "MADRID"
  },
  "effectiveCarrier" : {
    "reference" : "1454632-21",
    "name" : "CARRIER11",
    "taxIdentifier" : "IDCARRIER11",
    "taxAddress" : {
      "streetName" : "STREET NAME AND NUMBER",
      "postalCode" : "POSTAL CODE",
      "city" : "CITY",
      "stateProvince" : "STATE PROVINCE",
      "country" : "COUNTRY",
      "countryISOCode" : "ES"
    },
    "phone" : "PHONECARRIER11",
    "m2mId" : "286",
    "costCenterName" : "CENTER"
  },
  "assignationStatus" : "ACCEPTED",
  "reference" : "13456",
  "instructions" : "Prepare some straps",
  "agreements" : "Toll paid",
  "carrierObservations" : null,
  "type" : "FULL",
  "stops" : [ {
    "freightReference" : "REF-000456",
    "type" : "LOAD",
    "position" : 1,
    "address" : {
      "streetName" : "STREET NAME AND NUMBER",
      "postalCode" : "POSTAL CODE",
      "city" : "CITY",
      "stateProvince" : "STATE PROVINCE",
      "country" : "COUNTRY",
      "countryISOCode" : "ES"
    },
    "company" : {
      "reference" : null,
      "name" : "EXPEDITEUR12",
      "taxIdentifier" : "IDEXPEDITEUR12",
      "taxAddress" : null,
      "phone" : "PHONEEXPEDITEUR12",
      "m2mId" : null,
      "costCenterName" : null
    },
    "contactUserFirstName" : "FIRST NAME",
    "contactUserLastName" : "LAST NAME",
    "contactUserEmail" : "a_valid@email.com",
    "tare" : 5000,
    "grossWeight" : 18000,
    "netWeight" : 15000,
    "packages" : 30,
    "price" : null,
    "identification" : null,
    "reservations" : "RESERVATIONS",
    "nature" : "DESCRIPTION OF PRODUCTS",
    "packaging" : "PALETS",
    "sealNumber" : "SEAL NUMBER",
    "since" : "2021-03-21T13:30:00Z",
    "until" : "2021-03-21T14:00:00Z",
    "driverName" : "DRIVER NAME",
    "driverTaxIdentifier" : "DRIVER TAX IDENTIFIER",
    "arrivalDate" : "2021-03-21T13:35:22Z",
    "loadingStartDate" : "2021-03-21T14:45:22Z",
    "loadingEndDate" : "2021-03-21T16:17:19Z",
    "departureDate" : "2021-03-21T16:30:15Z",
    "point" : {
      "lat" : "40.4167",
      "lng" : "-3.70325"
    }
  } ],
  "transportType" : "BOX",
  "adr" : false,
  "waste" : false,
  "documentType" : "ECMR",
  "status" : "WORKING_END",
  "m2mId" : "2367",
  "price" : 360.5,
  "payer" : "LOADER",
  "nextStopPosition" : 1,
  "minTemp1" : null,
  "maxTemp1" : null,
  "minTemp2" : null,
  "maxTemp2" : null,
  "minTemp3" : null,
  "maxTemp3" : null,
  "routeName" : null,
  "routeM2mId" : null,
  "attachments" : null,
  "drivers" : [ ],
  "vehicles" : [ ],
  "links" : {
    "cargo" : "https://cargo.wanatruck.com/freights/15"
  },
  "events" : null,
  "assignations" : null,
  "startDate" : "2021-03-21T13:35:22Z",
  "incidentStart" : null,
  "incidentEnd" : null,
  "incident" : null,
  "point" : {
    "lat" : "40.4167",
    "lng" : "-3.70325"
  }
}

3.1.10. Example Curl request

$ curl 'https://api.wanatruck.com/api/shippers/v1/freights' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJpbnRlZ3JhdGlvbiJdLCJleHAiOjE2MzYwMjEwNzUsImlhdCI6MTYzNjAxOTI3NSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9BRE1JTiJdLCJqdGkiOiJlZjc4Y2M2Mi03OWViLTQzYjYtOTk4NS0zZTg4YjliMzViNDEiLCJjbGllbnRfaWQiOiJDTElFTlRfSUQifQ.SeDFoKoezsN8gr7SPN6-tBEA_b952DTcHpHQuCsvDHkP1ryTjwPBp7A1CpmoioIi8vmCSMwPuTdFsTGBIvUW94xzQq0wP4KukCNzkm80Vd4gCfzEDRXTYu4DXpMWh5PrNNP_qwv38XlZB_yRfAqgXV3Yjv7rEy_9VR4uQoiK-oVa508LMKBL243ZFIDq6fTkWtoGhz-pRrCr4mF9H0B9gGuXvI6p-V3-nEg81fXe2aJUHP0teAG8q5OPx8-q93ENJpaWJSByLE_GXRJ3EgzDMGJyjpAjZeBU39y1I9BAyNgiukCgVdhzZD3tif91qkLscQLJGW02kLRuV9zisDBmFw' \
    -H 'Content-Type: application/json' \
    -d '{
  "shipper" : {
    "reference" : "1234567-15",
    "name" : "SHIPPER12",
    "taxIdentifier" : "IDSHIPPER12",
    "taxAddress" : {
      "streetName" : "STREET NAME AND NUMBER",
      "postalCode" : "POSTAL CODE",
      "city" : "CITY",
      "stateProvince" : "STATE PROVINCE",
      "country" : "COUNTRY",
      "countryISOCode" : "ES"
    },
    "phone" : "PHONESHIPPER12",
    "m2mId" : "148",
    "costCenterName" : "NORT"
  },
  "contractualCarrier" : {
    "reference" : "1454588-18",
    "name" : "CARRIER10",
    "taxIdentifier" : "IDCARRIER10",
    "taxAddress" : {
      "streetName" : "STREET NAME AND NUMBER",
      "postalCode" : "POSTAL CODE",
      "city" : "CITY",
      "stateProvince" : "STATE PROVINCE",
      "country" : "COUNTRY",
      "countryISOCode" : "ES"
    },
    "phone" : "PHONECARRIER10",
    "m2mId" : "332",
    "costCenterName" : "MADRID"
  },
  "effectiveCarrier" : {
    "reference" : "1454632-21",
    "name" : "CARRIER11",
    "taxIdentifier" : "IDCARRIER11",
    "taxAddress" : {
      "streetName" : "STREET NAME AND NUMBER",
      "postalCode" : "POSTAL CODE",
      "city" : "CITY",
      "stateProvince" : "STATE PROVINCE",
      "country" : "COUNTRY",
      "countryISOCode" : "ES"
    },
    "phone" : "PHONECARRIER11",
    "m2mId" : "286",
    "costCenterName" : "CENTER"
  },
  "assignationStatus" : "ACCEPTED",
  "reference" : "13456",
  "instructions" : "Prepare some straps",
  "agreements" : "Toll paid",
  "carrierObservations" : null,
  "type" : "FULL",
  "stops" : [ {
    "freightReference" : "REF-000456",
    "type" : "LOAD",
    "position" : 1,
    "address" : {
      "streetName" : "STREET NAME AND NUMBER",
      "postalCode" : "POSTAL CODE",
      "city" : "CITY",
      "stateProvince" : "STATE PROVINCE",
      "country" : "COUNTRY",
      "countryISOCode" : "ES"
    },
    "company" : {
      "reference" : null,
      "name" : "EXPEDITEUR12",
      "taxIdentifier" : "IDEXPEDITEUR12",
      "taxAddress" : null,
      "phone" : "PHONEEXPEDITEUR12",
      "m2mId" : null,
      "costCenterName" : null
    },
    "contactUserFirstName" : "FIRST NAME",
    "contactUserLastName" : "LAST NAME",
    "contactUserEmail" : "a_valid@email.com",
    "tare" : 5000,
    "grossWeight" : 18000,
    "netWeight" : 15000,
    "packages" : 30,
    "price" : null,
    "identification" : null,
    "reservations" : "RESERVATIONS",
    "nature" : "DESCRIPTION OF PRODUCTS",
    "packaging" : "PALETS",
    "sealNumber" : "SEAL NUMBER",
    "since" : "2021-03-21T14:30:00+01:00",
    "until" : "2021-03-21T15:00:00+01:00",
    "driverName" : "DRIVER NAME",
    "driverTaxIdentifier" : "DRIVER TAX IDENTIFIER",
    "arrivalDate" : "2021-03-21T14:35:22+01:00",
    "loadingStartDate" : "2021-03-21T15:45:22+01:00",
    "loadingEndDate" : "2021-03-21T17:17:19+01:00",
    "departureDate" : "2021-03-21T17:30:15+01:00",
    "point" : {
      "lat" : "40.4167",
      "lng" : "-3.70325"
    }
  } ],
  "transportType" : "BOX",
  "adr" : false,
  "waste" : false,
  "documentType" : "ECMR",
  "status" : "WORKING_END",
  "m2mId" : "2367",
  "price" : 360.5,
  "payer" : "LOADER",
  "nextStopPosition" : 1,
  "minTemp1" : null,
  "maxTemp1" : null,
  "minTemp2" : null,
  "maxTemp2" : null,
  "minTemp3" : null,
  "maxTemp3" : null,
  "routeName" : null,
  "routeM2mId" : null,
  "attachments" : null,
  "drivers" : [ ],
  "vehicles" : [ ],
  "links" : null,
  "events" : null,
  "assignations" : null,
  "startDate" : "2021-03-21T14:35:22+01:00",
  "incidentStart" : null,
  "incidentEnd" : null,
  "incident" : null,
  "point" : null
}'

3.2. Create or update delivery notes

POST /service/freight/api/shippers/v1/freights/delivery-notes

3.2.1. Description

This method creates or updates delivery notes associated to a specific freight. These delivery notes can be signed by the destinatary.

3.2.2. Parameters

Type Name Description Schema

Body

freightDeliveryNotesDTO
required

freightDeliveryNotesDTO

< Delivery Note > array

3.2.3. Responses

HTTP Code Description Schema

200

OK

< Delivery Note > array

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

3.2.4. Consumes

  • application/json

3.2.5. Produces

  • application/json

3.2.6. Tags

  • freight-external-resource

3.2.7. Security

Type Name Scopes

oauth2

oauth2

read,trust,write

3.2.8. Example HTTP request

POST /api/shippers/v1/freights/delivery-notes HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJpbnRlZ3JhdGlvbiJdLCJleHAiOjE2MzYwMjEwNzYsImlhdCI6MTYzNjAxOTI3NiwiYXV0aG9yaXRpZXMiOlsiUk9MRV9BRE1JTiJdLCJqdGkiOiIyMTU2YmE1My1iMDk4LTQ3YjgtOWVlNS0wNGIwZmE2NWM1YzUiLCJjbGllbnRfaWQiOiJDTElFTlRfSUQifQ.gPu5OktiIIkjgzSwBRbuU1ly65DkhLOEGC9EcEwVK9xSfLhMN6jFwRPZH39Xk2FNdxlIzGMYaQ1k9a_mDzFfQQpBDUC6GROjBMoyOV2OnwL5hxZMgqgdwpePac_9K7g9KkC1G7hZbOWaghG5roasvXwhRhfT-GbYY1bs_TSNq-ktNT3xLwxQsUwNC-OvCM5KgB1fTUa3CMcCW1vLFu3vewGZi2SN3ZKniepO57T4ngm3XXlhUbIqQSbbV8HdpD6BOvtqeePiHQ7yPUMFhiFjUm8W86oJgtTFd5JCc2fC07h8EH9TnzVZJNxAN528kj9cpz62FAHcVOz3-syMoIx_Og
Host: api.wanatruck.com
Content-Type: application/json
Content-Length: 425

[ {
  "freightReference" : "13456",
  "deliveryNoteNumber" : "INTERNAL-REF-0001",
  "customerName" : "CUSTOMER10",
  "customerReference" : "REF-0001",
  "adr" : true,
  "loadStopPosition" : 1,
  "unloadStopPosition" : 2,
  "type" : "DATA",
  "deliveryNoteLines" : [ ],
  "file" : null,
  "fileContentType" : null,
  "templateName" : "DEFAULT",
  "weight" : 1000,
  "packages" : 20,
  "observations" : null
} ]

3.2.9. Example HTTP response

HTTP/1.1 200 OK
Content-Length: 449
Content-Type: application/json;charset=UTF-8

[ {
  "freightReference" : "13456",
  "deliveryNoteNumber" : "INTERNAL-REF-0001",
  "customerName" : "CUSTOMER10",
  "customerReference" : "REF-0001",
  "adr" : true,
  "loadStopPosition" : 1,
  "unloadStopPosition" : 2,
  "type" : "DATA",
  "deliveryNoteLines" : [ ],
  "file" : null,
  "fileContentType" : null,
  "templateName" : "DEFAULT",
  "weight" : 1000,
  "packages" : 20,
  "observations" : "Observations from customer"
} ]

3.2.10. Example Curl request

$ curl 'https://api.wanatruck.com/api/shippers/v1/freights/delivery-notes' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJpbnRlZ3JhdGlvbiJdLCJleHAiOjE2MzYwMjEwNzYsImlhdCI6MTYzNjAxOTI3NiwiYXV0aG9yaXRpZXMiOlsiUk9MRV9BRE1JTiJdLCJqdGkiOiIyMTU2YmE1My1iMDk4LTQ3YjgtOWVlNS0wNGIwZmE2NWM1YzUiLCJjbGllbnRfaWQiOiJDTElFTlRfSUQifQ.gPu5OktiIIkjgzSwBRbuU1ly65DkhLOEGC9EcEwVK9xSfLhMN6jFwRPZH39Xk2FNdxlIzGMYaQ1k9a_mDzFfQQpBDUC6GROjBMoyOV2OnwL5hxZMgqgdwpePac_9K7g9KkC1G7hZbOWaghG5roasvXwhRhfT-GbYY1bs_TSNq-ktNT3xLwxQsUwNC-OvCM5KgB1fTUa3CMcCW1vLFu3vewGZi2SN3ZKniepO57T4ngm3XXlhUbIqQSbbV8HdpD6BOvtqeePiHQ7yPUMFhiFjUm8W86oJgtTFd5JCc2fC07h8EH9TnzVZJNxAN528kj9cpz62FAHcVOz3-syMoIx_Og' \
    -H 'Content-Type: application/json' \
    -d '[ {
  "freightReference" : "13456",
  "deliveryNoteNumber" : "INTERNAL-REF-0001",
  "customerName" : "CUSTOMER10",
  "customerReference" : "REF-0001",
  "adr" : true,
  "loadStopPosition" : 1,
  "unloadStopPosition" : 2,
  "type" : "DATA",
  "deliveryNoteLines" : [ ],
  "file" : null,
  "fileContentType" : null,
  "templateName" : "DEFAULT",
  "weight" : 1000,
  "packages" : 20,
  "observations" : null
} ]'

4. Webhooks

4.1. Overview

WanaTruck uses webhooks to have a bidirectional communication with Shippers, Carriers and Receivers.

We have different webhook types: Full Freight Data (FFD), Freigh Assignation Data (FAD), Freight Stop Data (FSD), Freight Driver Data (FDD), Freight Vehicle Data (FVD) and Freight Communication Data (FCD). But you don’t need to implement all webhooks endpoints, you can configure which ones you are interested in and implement only those.

Each webhook is invoked when the event is generated in the platform, in the next table you will see which data is sent for each event:

Type Events

Full Freight Data

Freight Created, Freight Assigned, Freight Started, Freight Finished, Freight Cancelled by Shipper, Freight Cancelled by Carrier

Freight Assignation Data

Freight Assignation Accepted,Freight Assignation Rejected,Freight Assignation Cancelled

Freight Stop Data

Arrival, Load/Unload Starts, Load/Unload Ends, Departure

Freight Driver Data

Driver Assigned, Driver Deassigned

Freight Vehicle Data

Vehicle Changed

Freight Communication Data

Incident, Message

The data is sent in JSON format (see the examples below). If you need any other format, please contact with our Support Team

4.2. Full Freight Data (FFD) Webhooks

4.2.1. Parameters

Type Name Description Schema

Body

freight
required

Freight data

Freight

4.2.2. Responses

HTTP Code Description Schema

200

OK

Freight

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

4.2.3. Example HTTP request

POST /webhooks/v1/freights HTTP/1.1
Content-Length: 3824
Host: api.wanatruck.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJpbnRlZ3JhdGlvbiJdLCJleHAiOjE2MzYwMjEwNzQsImlhdCI6MTYzNjAxOTI3NCwiYXV0aG9yaXRpZXMiOlsiUk9MRV9BRE1JTiJdLCJqdGkiOiI0MjBkZDRiMC1lYTViLTQ5OTEtOGQ2NC04NzBhZTcwNDEyN2YiLCJjbGllbnRfaWQiOiJDTElFTlRfSUQifQ.Jy-J_72pDqiH8YWg80UhdPhY_DqD0_8hOQt3vv2vaF4phF-MazMjyiRgHEXgi2jc4PdjaiNX2eD-XTJ_mmQYJOPzJ_O6U4d65FAaDNXYOG3NrPpnEyiSjZusdiPQHGOcSOmr-bFny9fTPZ-bqUVzXxxzRgJ_mmaWNVZzDPB7XB5_n8EjzNevzYRCiDbGwR5XREJUm12AtlfMEk2ndM8VzW95LFN4uRnTCT1pLuWRu1eaghNNVYpwLIAaYod0qFbBtSIj_WwzaEcpvRwYRSZhRJy_GIfHDCuU0dowigH2Cd4zu8uhJ92e1-HaWD2f8zmuyziUOIPLab_laXqHs6wKNA

{
  "shipper" : {
    "reference" : "1234567-15",
    "name" : "SHIPPER12",
    "taxIdentifier" : "IDSHIPPER12",
    "taxAddress" : {
      "streetName" : "STREET NAME AND NUMBER",
      "postalCode" : "POSTAL CODE",
      "city" : "CITY",
      "stateProvince" : "STATE PROVINCE",
      "country" : "COUNTRY",
      "countryISOCode" : "ES"
    },
    "phone" : "PHONESHIPPER12",
    "m2mId" : "148",
    "costCenterName" : "NORT"
  },
  "contractualCarrier" : {
    "reference" : "1454588-18",
    "name" : "CARRIER10",
    "taxIdentifier" : "IDCARRIER10",
    "taxAddress" : {
      "streetName" : "STREET NAME AND NUMBER",
      "postalCode" : "POSTAL CODE",
      "city" : "CITY",
      "stateProvince" : "STATE PROVINCE",
      "country" : "COUNTRY",
      "countryISOCode" : "ES"
    },
    "phone" : "PHONECARRIER10",
    "m2mId" : "332",
    "costCenterName" : "MADRID"
  },
  "effectiveCarrier" : {
    "reference" : "1454632-21",
    "name" : "CARRIER11",
    "taxIdentifier" : "IDCARRIER11",
    "taxAddress" : {
      "streetName" : "STREET NAME AND NUMBER",
      "postalCode" : "POSTAL CODE",
      "city" : "CITY",
      "stateProvince" : "STATE PROVINCE",
      "country" : "COUNTRY",
      "countryISOCode" : "ES"
    },
    "phone" : "PHONECARRIER11",
    "m2mId" : "286",
    "costCenterName" : "CENTER"
  },
  "assignationStatus" : "ACCEPTED",
  "reference" : "13456",
  "instructions" : "Prepare some straps",
  "agreements" : "Toll paid",
  "carrierObservations" : null,
  "type" : "FULL",
  "stops" : [ {
    "freightReference" : "REF-000456",
    "type" : "LOAD",
    "position" : 1,
    "address" : {
      "streetName" : "STREET NAME AND NUMBER",
      "postalCode" : "POSTAL CODE",
      "city" : "CITY",
      "stateProvince" : "STATE PROVINCE",
      "country" : "COUNTRY",
      "countryISOCode" : "ES"
    },
    "company" : {
      "reference" : null,
      "name" : "EXPEDITEUR12",
      "taxIdentifier" : "IDEXPEDITEUR12",
      "taxAddress" : null,
      "phone" : "PHONEEXPEDITEUR12",
      "m2mId" : null,
      "costCenterName" : null
    },
    "contactUserFirstName" : "FIRST NAME",
    "contactUserLastName" : "LAST NAME",
    "contactUserEmail" : "a_valid@email.com",
    "tare" : 5000,
    "grossWeight" : 18000,
    "netWeight" : 15000,
    "packages" : 30,
    "price" : null,
    "identification" : null,
    "reservations" : "RESERVATIONS",
    "nature" : "DESCRIPTION OF PRODUCTS",
    "packaging" : "PALETS",
    "sealNumber" : "SEAL NUMBER",
    "since" : "2021-03-21T14:30:00+01:00",
    "until" : "2021-03-21T15:00:00+01:00",
    "driverName" : "DRIVER NAME",
    "driverTaxIdentifier" : "DRIVER TAX IDENTIFIER",
    "arrivalDate" : "2021-03-21T14:35:22+01:00",
    "loadingStartDate" : "2021-03-21T15:45:22+01:00",
    "loadingEndDate" : "2021-03-21T17:17:19+01:00",
    "departureDate" : "2021-03-21T17:30:15+01:00",
    "point" : {
      "lat" : "40.4167",
      "lng" : "-3.70325"
    }
  } ],
  "transportType" : "BOX",
  "adr" : false,
  "waste" : false,
  "documentType" : "ECMR",
  "status" : "WORKING_END",
  "m2mId" : "2367",
  "price" : 360.5,
  "payer" : "LOADER",
  "nextStopPosition" : 1,
  "minTemp1" : null,
  "maxTemp1" : null,
  "minTemp2" : null,
  "maxTemp2" : null,
  "minTemp3" : null,
  "maxTemp3" : null,
  "routeName" : null,
  "routeM2mId" : null,
  "attachments" : null,
  "drivers" : [ ],
  "vehicles" : [ ],
  "links" : {
    "cargo" : "https://cargo.wanatruck.com/freights/15"
  },
  "events" : null,
  "assignations" : null,
  "startDate" : "2021-03-21T14:35:22+01:00",
  "incidentStart" : null,
  "incidentEnd" : null,
  "incident" : null,
  "point" : {
    "lat" : "40.4167",
    "lng" : "-3.70325"
  }
}

4.2.4. Example HTTP response

HTTP/1.1 200 OK
Content-Length: 3789
Content-Type: application/json;charset=UTF-8

{
  "shipper" : {
    "reference" : "1234567-15",
    "name" : "SHIPPER12",
    "taxIdentifier" : "IDSHIPPER12",
    "taxAddress" : {
      "streetName" : "STREET NAME AND NUMBER",
      "postalCode" : "POSTAL CODE",
      "city" : "CITY",
      "stateProvince" : "STATE PROVINCE",
      "country" : "COUNTRY",
      "countryISOCode" : "ES"
    },
    "phone" : "PHONESHIPPER12",
    "m2mId" : "148",
    "costCenterName" : "NORT"
  },
  "contractualCarrier" : {
    "reference" : "1454588-18",
    "name" : "CARRIER10",
    "taxIdentifier" : "IDCARRIER10",
    "taxAddress" : {
      "streetName" : "STREET NAME AND NUMBER",
      "postalCode" : "POSTAL CODE",
      "city" : "CITY",
      "stateProvince" : "STATE PROVINCE",
      "country" : "COUNTRY",
      "countryISOCode" : "ES"
    },
    "phone" : "PHONECARRIER10",
    "m2mId" : "332",
    "costCenterName" : "MADRID"
  },
  "effectiveCarrier" : {
    "reference" : "1454632-21",
    "name" : "CARRIER11",
    "taxIdentifier" : "IDCARRIER11",
    "taxAddress" : {
      "streetName" : "STREET NAME AND NUMBER",
      "postalCode" : "POSTAL CODE",
      "city" : "CITY",
      "stateProvince" : "STATE PROVINCE",
      "country" : "COUNTRY",
      "countryISOCode" : "ES"
    },
    "phone" : "PHONECARRIER11",
    "m2mId" : "286",
    "costCenterName" : "CENTER"
  },
  "assignationStatus" : "ACCEPTED",
  "reference" : "13456",
  "instructions" : "Prepare some straps",
  "agreements" : "Toll paid",
  "carrierObservations" : null,
  "type" : "FULL",
  "stops" : [ {
    "freightReference" : "REF-000456",
    "type" : "LOAD",
    "position" : 1,
    "address" : {
      "streetName" : "STREET NAME AND NUMBER",
      "postalCode" : "POSTAL CODE",
      "city" : "CITY",
      "stateProvince" : "STATE PROVINCE",
      "country" : "COUNTRY",
      "countryISOCode" : "ES"
    },
    "company" : {
      "reference" : null,
      "name" : "EXPEDITEUR12",
      "taxIdentifier" : "IDEXPEDITEUR12",
      "taxAddress" : null,
      "phone" : "PHONEEXPEDITEUR12",
      "m2mId" : null,
      "costCenterName" : null
    },
    "contactUserFirstName" : "FIRST NAME",
    "contactUserLastName" : "LAST NAME",
    "contactUserEmail" : "a_valid@email.com",
    "tare" : 5000,
    "grossWeight" : 18000,
    "netWeight" : 15000,
    "packages" : 30,
    "price" : null,
    "identification" : null,
    "reservations" : "RESERVATIONS",
    "nature" : "DESCRIPTION OF PRODUCTS",
    "packaging" : "PALETS",
    "sealNumber" : "SEAL NUMBER",
    "since" : "2021-03-21T13:30:00Z",
    "until" : "2021-03-21T14:00:00Z",
    "driverName" : "DRIVER NAME",
    "driverTaxIdentifier" : "DRIVER TAX IDENTIFIER",
    "arrivalDate" : "2021-03-21T13:35:22Z",
    "loadingStartDate" : "2021-03-21T14:45:22Z",
    "loadingEndDate" : "2021-03-21T16:17:19Z",
    "departureDate" : "2021-03-21T16:30:15Z",
    "point" : {
      "lat" : "40.4167",
      "lng" : "-3.70325"
    }
  } ],
  "transportType" : "BOX",
  "adr" : false,
  "waste" : false,
  "documentType" : "ECMR",
  "status" : "WORKING_END",
  "m2mId" : "2367",
  "price" : 360.5,
  "payer" : "LOADER",
  "nextStopPosition" : 1,
  "minTemp1" : null,
  "maxTemp1" : null,
  "minTemp2" : null,
  "maxTemp2" : null,
  "minTemp3" : null,
  "maxTemp3" : null,
  "routeName" : null,
  "routeM2mId" : null,
  "attachments" : null,
  "drivers" : [ ],
  "vehicles" : [ ],
  "links" : {
    "cargo" : "https://cargo.wanatruck.com/freights/15"
  },
  "events" : null,
  "assignations" : null,
  "startDate" : "2021-03-21T13:35:22Z",
  "incidentStart" : null,
  "incidentEnd" : null,
  "incident" : null,
  "point" : {
    "lat" : "40.4167",
    "lng" : "-3.70325"
  }
}

4.2.5. Example Curl request

$ curl 'https://api.wanatruck.com/webhooks/v1/freights' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJpbnRlZ3JhdGlvbiJdLCJleHAiOjE2MzYwMjEwNzQsImlhdCI6MTYzNjAxOTI3NCwiYXV0aG9yaXRpZXMiOlsiUk9MRV9BRE1JTiJdLCJqdGkiOiI0MjBkZDRiMC1lYTViLTQ5OTEtOGQ2NC04NzBhZTcwNDEyN2YiLCJjbGllbnRfaWQiOiJDTElFTlRfSUQifQ.Jy-J_72pDqiH8YWg80UhdPhY_DqD0_8hOQt3vv2vaF4phF-MazMjyiRgHEXgi2jc4PdjaiNX2eD-XTJ_mmQYJOPzJ_O6U4d65FAaDNXYOG3NrPpnEyiSjZusdiPQHGOcSOmr-bFny9fTPZ-bqUVzXxxzRgJ_mmaWNVZzDPB7XB5_n8EjzNevzYRCiDbGwR5XREJUm12AtlfMEk2ndM8VzW95LFN4uRnTCT1pLuWRu1eaghNNVYpwLIAaYod0qFbBtSIj_WwzaEcpvRwYRSZhRJy_GIfHDCuU0dowigH2Cd4zu8uhJ92e1-HaWD2f8zmuyziUOIPLab_laXqHs6wKNA' \
    -d '{
  "shipper" : {
    "reference" : "1234567-15",
    "name" : "SHIPPER12",
    "taxIdentifier" : "IDSHIPPER12",
    "taxAddress" : {
      "streetName" : "STREET NAME AND NUMBER",
      "postalCode" : "POSTAL CODE",
      "city" : "CITY",
      "stateProvince" : "STATE PROVINCE",
      "country" : "COUNTRY",
      "countryISOCode" : "ES"
    },
    "phone" : "PHONESHIPPER12",
    "m2mId" : "148",
    "costCenterName" : "NORT"
  },
  "contractualCarrier" : {
    "reference" : "1454588-18",
    "name" : "CARRIER10",
    "taxIdentifier" : "IDCARRIER10",
    "taxAddress" : {
      "streetName" : "STREET NAME AND NUMBER",
      "postalCode" : "POSTAL CODE",
      "city" : "CITY",
      "stateProvince" : "STATE PROVINCE",
      "country" : "COUNTRY",
      "countryISOCode" : "ES"
    },
    "phone" : "PHONECARRIER10",
    "m2mId" : "332",
    "costCenterName" : "MADRID"
  },
  "effectiveCarrier" : {
    "reference" : "1454632-21",
    "name" : "CARRIER11",
    "taxIdentifier" : "IDCARRIER11",
    "taxAddress" : {
      "streetName" : "STREET NAME AND NUMBER",
      "postalCode" : "POSTAL CODE",
      "city" : "CITY",
      "stateProvince" : "STATE PROVINCE",
      "country" : "COUNTRY",
      "countryISOCode" : "ES"
    },
    "phone" : "PHONECARRIER11",
    "m2mId" : "286",
    "costCenterName" : "CENTER"
  },
  "assignationStatus" : "ACCEPTED",
  "reference" : "13456",
  "instructions" : "Prepare some straps",
  "agreements" : "Toll paid",
  "carrierObservations" : null,
  "type" : "FULL",
  "stops" : [ {
    "freightReference" : "REF-000456",
    "type" : "LOAD",
    "position" : 1,
    "address" : {
      "streetName" : "STREET NAME AND NUMBER",
      "postalCode" : "POSTAL CODE",
      "city" : "CITY",
      "stateProvince" : "STATE PROVINCE",
      "country" : "COUNTRY",
      "countryISOCode" : "ES"
    },
    "company" : {
      "reference" : null,
      "name" : "EXPEDITEUR12",
      "taxIdentifier" : "IDEXPEDITEUR12",
      "taxAddress" : null,
      "phone" : "PHONEEXPEDITEUR12",
      "m2mId" : null,
      "costCenterName" : null
    },
    "contactUserFirstName" : "FIRST NAME",
    "contactUserLastName" : "LAST NAME",
    "contactUserEmail" : "a_valid@email.com",
    "tare" : 5000,
    "grossWeight" : 18000,
    "netWeight" : 15000,
    "packages" : 30,
    "price" : null,
    "identification" : null,
    "reservations" : "RESERVATIONS",
    "nature" : "DESCRIPTION OF PRODUCTS",
    "packaging" : "PALETS",
    "sealNumber" : "SEAL NUMBER",
    "since" : "2021-03-21T14:30:00+01:00",
    "until" : "2021-03-21T15:00:00+01:00",
    "driverName" : "DRIVER NAME",
    "driverTaxIdentifier" : "DRIVER TAX IDENTIFIER",
    "arrivalDate" : "2021-03-21T14:35:22+01:00",
    "loadingStartDate" : "2021-03-21T15:45:22+01:00",
    "loadingEndDate" : "2021-03-21T17:17:19+01:00",
    "departureDate" : "2021-03-21T17:30:15+01:00",
    "point" : {
      "lat" : "40.4167",
      "lng" : "-3.70325"
    }
  } ],
  "transportType" : "BOX",
  "adr" : false,
  "waste" : false,
  "documentType" : "ECMR",
  "status" : "WORKING_END",
  "m2mId" : "2367",
  "price" : 360.5,
  "payer" : "LOADER",
  "nextStopPosition" : 1,
  "minTemp1" : null,
  "maxTemp1" : null,
  "minTemp2" : null,
  "maxTemp2" : null,
  "minTemp3" : null,
  "maxTemp3" : null,
  "routeName" : null,
  "routeM2mId" : null,
  "attachments" : null,
  "drivers" : [ ],
  "vehicles" : [ ],
  "links" : {
    "cargo" : "https://cargo.wanatruck.com/freights/15"
  },
  "events" : null,
  "assignations" : null,
  "startDate" : "2021-03-21T14:35:22+01:00",
  "incidentStart" : null,
  "incidentEnd" : null,
  "incident" : null,
  "point" : {
    "lat" : "40.4167",
    "lng" : "-3.70325"
  }
}'

4.3. Freight Assignation Data (FAD) Webhooks

4.3.1. Parameters

Type Name Description Schema

Body

freightAssignation
required

Freight Assignation data

Freight Assignation

4.3.2. Responses

HTTP Code Description Schema

200

OK

Freight Assignation

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

4.3.3. Example HTTP request

POST /webhooks/v1/freights/assignations HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJpbnRlZ3JhdGlvbiJdLCJleHAiOjE2MzYwMjEwNzIsImlhdCI6MTYzNjAxOTI3MiwiYXV0aG9yaXRpZXMiOlsiUk9MRV9BRE1JTiJdLCJqdGkiOiI3MWUzMTcyOC0wNDU1LTQ3ODEtYTIyYy0xOTFkZjU1YmM0MDMiLCJjbGllbnRfaWQiOiJDTElFTlRfSUQifQ.IGxbTARkquLwCezIDyE9E77m6I6n-JYlgduhTyBYsJzZ2qWf8n9bvFbhaSC25Z7xcwHAUIVc9CecUXSDnJTwR1J7Vu5lGTn8xYXRbRT0sHuvY_WkbW616nyVc75YYz-pA9mzytqfIpC31Qh-D-VzGysw2c00gfx3blgQROy5675oFsGM1YjZGg7MeadedHp1RHrRfGUCq0UWDH1_mLrWz37HkgJJDDTDJVjd6DuUMt4hEAGx4muaW4F7lvNl449AGmpo3vWgU6o79oADYvN-Ojtc2NAQ4ADzTVosN-I8ZG9w797ijAud53RwAMmEDI5Zd1NjF9bLzUOFFwrjiokaIA
Host: api.wanatruck.com
Content-Length: 588
Content-Type: application/json

{
  "freightReference" : "REF-000456",
  "assigned" : "2021-03-20T13:47:33+01:00",
  "cancelled" : null,
  "accepted" : "2021-03-20T14:02:54+01:00",
  "rejected" : null,
  "assignedToName" : "CARRIER NAME",
  "assignedToAddress" : "CARRIER ADDRESS",
  "assignedToTaxIdentifier" : "CARRIER TAX IDENTIFIER",
  "assignedToPhone" : "CARRIER PHONE",
  "assignedFromName" : "SHIPPER NAME",
  "assignedFromCostCenterName" : "MADRID",
  "assignationType" : "OWN",
  "contractualCarrier" : true,
  "carrierFreightReference" : "REF-005123",
  "price" : null,
  "routeName" : null
}

4.3.4. Example HTTP response

HTTP/1.1 200 OK
Content-Length: 578
Content-Type: application/json;charset=UTF-8

{
  "freightReference" : "REF-000456",
  "assigned" : "2021-03-20T12:47:33Z",
  "cancelled" : null,
  "accepted" : "2021-03-20T13:02:54Z",
  "rejected" : null,
  "assignedToName" : "CARRIER NAME",
  "assignedToAddress" : "CARRIER ADDRESS",
  "assignedToTaxIdentifier" : "CARRIER TAX IDENTIFIER",
  "assignedToPhone" : "CARRIER PHONE",
  "assignedFromName" : "SHIPPER NAME",
  "assignedFromCostCenterName" : "MADRID",
  "assignationType" : "OWN",
  "contractualCarrier" : true,
  "carrierFreightReference" : "REF-005123",
  "price" : null,
  "routeName" : null
}

4.3.5. Example Curl request

$ curl 'https://api.wanatruck.com/webhooks/v1/freights/assignations' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJpbnRlZ3JhdGlvbiJdLCJleHAiOjE2MzYwMjEwNzIsImlhdCI6MTYzNjAxOTI3MiwiYXV0aG9yaXRpZXMiOlsiUk9MRV9BRE1JTiJdLCJqdGkiOiI3MWUzMTcyOC0wNDU1LTQ3ODEtYTIyYy0xOTFkZjU1YmM0MDMiLCJjbGllbnRfaWQiOiJDTElFTlRfSUQifQ.IGxbTARkquLwCezIDyE9E77m6I6n-JYlgduhTyBYsJzZ2qWf8n9bvFbhaSC25Z7xcwHAUIVc9CecUXSDnJTwR1J7Vu5lGTn8xYXRbRT0sHuvY_WkbW616nyVc75YYz-pA9mzytqfIpC31Qh-D-VzGysw2c00gfx3blgQROy5675oFsGM1YjZGg7MeadedHp1RHrRfGUCq0UWDH1_mLrWz37HkgJJDDTDJVjd6DuUMt4hEAGx4muaW4F7lvNl449AGmpo3vWgU6o79oADYvN-Ojtc2NAQ4ADzTVosN-I8ZG9w797ijAud53RwAMmEDI5Zd1NjF9bLzUOFFwrjiokaIA' \
    -H 'Content-Type: application/json' \
    -d '{
  "freightReference" : "REF-000456",
  "assigned" : "2021-03-20T13:47:33+01:00",
  "cancelled" : null,
  "accepted" : "2021-03-20T14:02:54+01:00",
  "rejected" : null,
  "assignedToName" : "CARRIER NAME",
  "assignedToAddress" : "CARRIER ADDRESS",
  "assignedToTaxIdentifier" : "CARRIER TAX IDENTIFIER",
  "assignedToPhone" : "CARRIER PHONE",
  "assignedFromName" : "SHIPPER NAME",
  "assignedFromCostCenterName" : "MADRID",
  "assignationType" : "OWN",
  "contractualCarrier" : true,
  "carrierFreightReference" : "REF-005123",
  "price" : null,
  "routeName" : null
}'

4.4. Freight Stop Data (FSD) Webhooks

4.4.1. Parameters

Type Name Description Schema

Body

freightStop
required

Freight Stop Data

Freight Stop

4.4.2. Responses

HTTP Code Description Schema

200

OK

Freight Stop

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

4.4.3. Example HTTP request

POST /webhooks/v1/freights/stops HTTP/1.1
Host: api.wanatruck.com
Content-Type: application/json
Content-Length: 1376
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJpbnRlZ3JhdGlvbiJdLCJleHAiOjE2MzYwMjEwNzUsImlhdCI6MTYzNjAxOTI3NSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9BRE1JTiJdLCJqdGkiOiJjMjBjZjI2Yi03MjAzLTQyNTItOTUxOC1hNDcxYTI1NDI4NjIiLCJjbGllbnRfaWQiOiJDTElFTlRfSUQifQ.WP4NkMvdry55KWiiiOoWe4TOVaW7lOXbayv4Xxqhq4_fdwfb4sgp6eFynOZPALshlGH8ABd7sLyeXLEiiynds8q5ULgX6lxTjHjpKaLY-LJvHyMdqNhtChsjwITW8VCmisiXazymab6_nb0EAozQ0jJrsolAlYkkhHkJ2Yaau6jHL_D-x-yTXAIMF9BwbbN9fUI2L1J6Vfu6fHW4iRcPnkbY37z4kcKeihrTA-kdTRyUMZVzni2wojs4sHCqs12J_S-vX6CM4c2yGNYTumIiR_COnSBA7efZQJT-shToc6YchKYGvC7yeEAB-Z8OCS3seX77JCITcyp47Sbnj8hQcA

{
  "freightReference" : "REF-000456",
  "type" : "LOAD",
  "position" : 1,
  "address" : {
    "streetName" : "STREET NAME AND NUMBER",
    "postalCode" : "POSTAL CODE",
    "city" : "CITY",
    "stateProvince" : "STATE PROVINCE",
    "country" : "COUNTRY",
    "countryISOCode" : "ES"
  },
  "company" : {
    "reference" : "299",
    "name" : "EXPEDITEUR12",
    "taxIdentifier" : "IDEXPEDITEUR12",
    "taxAddress" : null,
    "phone" : "PHONEEXPEDITEUR12",
    "m2mId" : "301",
    "costCenterName" : null
  },
  "contactUserFirstName" : "FIRST NAME",
  "contactUserLastName" : "LAST NAME",
  "contactUserEmail" : "a_valid@email.com",
  "tare" : 5000,
  "grossWeight" : 18000,
  "netWeight" : 15000,
  "packages" : 30,
  "price" : null,
  "identification" : null,
  "reservations" : "RESERVATIONS",
  "nature" : "DESCRIPTION OF PRODUCTS",
  "packaging" : "PALETS",
  "sealNumber" : "SEAL NUMBER",
  "since" : "2021-03-21T14:30:00+01:00",
  "until" : "2021-03-21T15:00:00+01:00",
  "driverName" : "DRIVER NAME",
  "driverTaxIdentifier" : "DRIVER TAX IDENTIFIER",
  "arrivalDate" : "2021-03-21T14:35:22+01:00",
  "loadingStartDate" : "2021-03-21T15:45:22+01:00",
  "loadingEndDate" : "2021-03-21T17:17:19+01:00",
  "departureDate" : "2021-03-21T17:30:15+01:00",
  "point" : {
    "lat" : "40.4167",
    "lng" : "-3.70325"
  }
}

4.4.4. Example HTTP response

HTTP/1.1 200 OK
Content-Length: 1346
Content-Type: application/json;charset=UTF-8

{
  "freightReference" : "REF-000456",
  "type" : "LOAD",
  "position" : 1,
  "address" : {
    "streetName" : "STREET NAME AND NUMBER",
    "postalCode" : "POSTAL CODE",
    "city" : "CITY",
    "stateProvince" : "STATE PROVINCE",
    "country" : "COUNTRY",
    "countryISOCode" : "ES"
  },
  "company" : {
    "reference" : "299",
    "name" : "EXPEDITEUR12",
    "taxIdentifier" : "IDEXPEDITEUR12",
    "taxAddress" : null,
    "phone" : "PHONEEXPEDITEUR12",
    "m2mId" : "301",
    "costCenterName" : null
  },
  "contactUserFirstName" : "FIRST NAME",
  "contactUserLastName" : "LAST NAME",
  "contactUserEmail" : "a_valid@email.com",
  "tare" : 5000,
  "grossWeight" : 18000,
  "netWeight" : 15000,
  "packages" : 30,
  "price" : null,
  "identification" : null,
  "reservations" : "RESERVATIONS",
  "nature" : "DESCRIPTION OF PRODUCTS",
  "packaging" : "PALETS",
  "sealNumber" : "SEAL NUMBER",
  "since" : "2021-03-21T13:30:00Z",
  "until" : "2021-03-21T14:00:00Z",
  "driverName" : "DRIVER NAME",
  "driverTaxIdentifier" : "DRIVER TAX IDENTIFIER",
  "arrivalDate" : "2021-03-21T13:35:22Z",
  "loadingStartDate" : "2021-03-21T14:45:22Z",
  "loadingEndDate" : "2021-03-21T16:17:19Z",
  "departureDate" : "2021-03-21T16:30:15Z",
  "point" : {
    "lat" : "40.4167",
    "lng" : "-3.70325"
  }
}

4.4.5. Example Curl request

$ curl 'https://api.wanatruck.com/webhooks/v1/freights/stops' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJpbnRlZ3JhdGlvbiJdLCJleHAiOjE2MzYwMjEwNzUsImlhdCI6MTYzNjAxOTI3NSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9BRE1JTiJdLCJqdGkiOiJjMjBjZjI2Yi03MjAzLTQyNTItOTUxOC1hNDcxYTI1NDI4NjIiLCJjbGllbnRfaWQiOiJDTElFTlRfSUQifQ.WP4NkMvdry55KWiiiOoWe4TOVaW7lOXbayv4Xxqhq4_fdwfb4sgp6eFynOZPALshlGH8ABd7sLyeXLEiiynds8q5ULgX6lxTjHjpKaLY-LJvHyMdqNhtChsjwITW8VCmisiXazymab6_nb0EAozQ0jJrsolAlYkkhHkJ2Yaau6jHL_D-x-yTXAIMF9BwbbN9fUI2L1J6Vfu6fHW4iRcPnkbY37z4kcKeihrTA-kdTRyUMZVzni2wojs4sHCqs12J_S-vX6CM4c2yGNYTumIiR_COnSBA7efZQJT-shToc6YchKYGvC7yeEAB-Z8OCS3seX77JCITcyp47Sbnj8hQcA' \
    -d '{
  "freightReference" : "REF-000456",
  "type" : "LOAD",
  "position" : 1,
  "address" : {
    "streetName" : "STREET NAME AND NUMBER",
    "postalCode" : "POSTAL CODE",
    "city" : "CITY",
    "stateProvince" : "STATE PROVINCE",
    "country" : "COUNTRY",
    "countryISOCode" : "ES"
  },
  "company" : {
    "reference" : "299",
    "name" : "EXPEDITEUR12",
    "taxIdentifier" : "IDEXPEDITEUR12",
    "taxAddress" : null,
    "phone" : "PHONEEXPEDITEUR12",
    "m2mId" : "301",
    "costCenterName" : null
  },
  "contactUserFirstName" : "FIRST NAME",
  "contactUserLastName" : "LAST NAME",
  "contactUserEmail" : "a_valid@email.com",
  "tare" : 5000,
  "grossWeight" : 18000,
  "netWeight" : 15000,
  "packages" : 30,
  "price" : null,
  "identification" : null,
  "reservations" : "RESERVATIONS",
  "nature" : "DESCRIPTION OF PRODUCTS",
  "packaging" : "PALETS",
  "sealNumber" : "SEAL NUMBER",
  "since" : "2021-03-21T14:30:00+01:00",
  "until" : "2021-03-21T15:00:00+01:00",
  "driverName" : "DRIVER NAME",
  "driverTaxIdentifier" : "DRIVER TAX IDENTIFIER",
  "arrivalDate" : "2021-03-21T14:35:22+01:00",
  "loadingStartDate" : "2021-03-21T15:45:22+01:00",
  "loadingEndDate" : "2021-03-21T17:17:19+01:00",
  "departureDate" : "2021-03-21T17:30:15+01:00",
  "point" : {
    "lat" : "40.4167",
    "lng" : "-3.70325"
  }
}'

4.5. Freight Driver Data (FDD) Webhooks

Type Name Description Schema

Body

freightDriver
required

Freight Driver Data

Driver

4.5.1. Responses

HTTP Code Description Schema

200

OK

Driver

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

4.5.2. Example HTTP request

POST /webhooks/v1/freights/drivers HTTP/1.1
Host: api.wanatruck.com
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJpbnRlZ3JhdGlvbiJdLCJleHAiOjE2MzYwMjEwNzYsImlhdCI6MTYzNjAxOTI3NiwiYXV0aG9yaXRpZXMiOlsiUk9MRV9BRE1JTiJdLCJqdGkiOiJjNjcwM2RiOC1hODEyLTQ2OWEtOTNlYy0yMjY3MWQzNTc2NmMiLCJjbGllbnRfaWQiOiJDTElFTlRfSUQifQ.GJ8dZ7qwWguwoi_bdhq-lepGjDuwln54Ws-DsJZ6kUMj7gRT5MkVVo2-xNoUmI2jEhHfgSGseXIDi5KueGnwkuZdwpn-gSzy-OUM1j1kUPo7iJvyX3uNcgoN-USJjrFd755MF7nklbWstwObDBHJB8NUbeTnhTpcSL9lDapvPCjJtw1Bn9nBkFObbDhkVVHPa0xj62Ap5ELisq31m8S0W2T4-lqTGSynaBvXOxEsiVH1swFY4svL0wusaFvII9FVfoc9Qm0unhLAEjsSWmqE1dOpdQRnzaYq4tbzUoz9It6brUgFXhr3K-hVg2MeVFdOY4Ct-RDonk3VmSmVEhM2LA
Content-Type: application/json
Content-Length: 388

{
  "freightReference" : "REF-000456",
  "firstName" : "FIRST NAME",
  "lastName" : "LAST NAME",
  "email" : "a_valid_driver@email.com",
  "phone" : "PHONE",
  "carrierName" : "CARRIER NAME",
  "carrierTaxIdentifier" : "CARRIER TAX IDENTIFIER",
  "assigned" : "2021-03-20T13:47:33+01:00",
  "cancelled" : null,
  "accepted" : "2021-03-20T14:02:54+01:00",
  "rejected" : null
}

4.5.3. Example HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 378

{
  "freightReference" : "REF-000456",
  "firstName" : "FIRST NAME",
  "lastName" : "LAST NAME",
  "email" : "a_valid_driver@email.com",
  "phone" : "PHONE",
  "carrierName" : "CARRIER NAME",
  "carrierTaxIdentifier" : "CARRIER TAX IDENTIFIER",
  "assigned" : "2021-03-20T12:47:33Z",
  "cancelled" : null,
  "accepted" : "2021-03-20T13:02:54Z",
  "rejected" : null
}

4.5.4. Example Curl request

$ curl 'https://api.wanatruck.com/webhooks/v1/freights/drivers' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJpbnRlZ3JhdGlvbiJdLCJleHAiOjE2MzYwMjEwNzYsImlhdCI6MTYzNjAxOTI3NiwiYXV0aG9yaXRpZXMiOlsiUk9MRV9BRE1JTiJdLCJqdGkiOiJjNjcwM2RiOC1hODEyLTQ2OWEtOTNlYy0yMjY3MWQzNTc2NmMiLCJjbGllbnRfaWQiOiJDTElFTlRfSUQifQ.GJ8dZ7qwWguwoi_bdhq-lepGjDuwln54Ws-DsJZ6kUMj7gRT5MkVVo2-xNoUmI2jEhHfgSGseXIDi5KueGnwkuZdwpn-gSzy-OUM1j1kUPo7iJvyX3uNcgoN-USJjrFd755MF7nklbWstwObDBHJB8NUbeTnhTpcSL9lDapvPCjJtw1Bn9nBkFObbDhkVVHPa0xj62Ap5ELisq31m8S0W2T4-lqTGSynaBvXOxEsiVH1swFY4svL0wusaFvII9FVfoc9Qm0unhLAEjsSWmqE1dOpdQRnzaYq4tbzUoz9It6brUgFXhr3K-hVg2MeVFdOY4Ct-RDonk3VmSmVEhM2LA' \
    -H 'Content-Type: application/json' \
    -d '{
  "freightReference" : "REF-000456",
  "firstName" : "FIRST NAME",
  "lastName" : "LAST NAME",
  "email" : "a_valid_driver@email.com",
  "phone" : "PHONE",
  "carrierName" : "CARRIER NAME",
  "carrierTaxIdentifier" : "CARRIER TAX IDENTIFIER",
  "assigned" : "2021-03-20T13:47:33+01:00",
  "cancelled" : null,
  "accepted" : "2021-03-20T14:02:54+01:00",
  "rejected" : null
}'

4.6. Freight Vehicle Data (FVD) Webhooks

4.6.1. Parameters

Type Name Description Schema

Body

freightVehicle
required

Freight Vehicle Data

Vehicle

4.6.2. Responses

HTTP Code Description Schema

200

OK

Vehicle

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

4.6.3. Example HTTP request

POST /webhooks/v1/freights/vehicles HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJpbnRlZ3JhdGlvbiJdLCJleHAiOjE2MzYwMjEwNzQsImlhdCI6MTYzNjAxOTI3NCwiYXV0aG9yaXRpZXMiOlsiUk9MRV9BRE1JTiJdLCJqdGkiOiI2ZGE0ZGI0YS0yNzEwLTQwNGQtODEwOC0wMjYxNjdiMzNmMTkiLCJjbGllbnRfaWQiOiJDTElFTlRfSUQifQ.bEA6n0gQkg3OsUD7SimCpX0__vAWfHvK0tAX6JofKHguUexboInv-iwNXJbT9HhuRn1FmF13x8zppPJgyv9PdpELiR_npXbkLcRgNazLhf-VSaLocNRPVoTDeHVNu-CtFO0wKwDW8Ul--gvVYtzqMi6-9eXuR39Uh2mnmh0WDid_FTmk7FvuXtbd76mlzgYmVx4Yssy5NfO_45QJWnjwaF6sJ9ALk46zwhW2pd5AFKs4b2YjpAq-dV_N0JxnGSgfRDdrrrV3p5iD3x90j4oM5MthsDZwcKcfH77S7VGb0JvarSTfGhvaybaG6eQodQV0z5JzfzhdxszPBHRxvVgR2Q
Host: api.wanatruck.com
Content-Type: application/json
Content-Length: 158

{
  "freightReference" : "REF-000456",
  "plateNumber" : "PLATE NUMBER",
  "type" : "VEHICLE TYPE",
  "carrierTaxIdentifier" : "CARRIER TAX IDENTIFIER"
}

4.6.4. Example HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 158

{
  "freightReference" : "REF-000456",
  "plateNumber" : "PLATE NUMBER",
  "type" : "VEHICLE TYPE",
  "carrierTaxIdentifier" : "CARRIER TAX IDENTIFIER"
}

4.6.5. Example Curl request

$ curl 'https://api.wanatruck.com/webhooks/v1/freights/vehicles' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJpbnRlZ3JhdGlvbiJdLCJleHAiOjE2MzYwMjEwNzQsImlhdCI6MTYzNjAxOTI3NCwiYXV0aG9yaXRpZXMiOlsiUk9MRV9BRE1JTiJdLCJqdGkiOiI2ZGE0ZGI0YS0yNzEwLTQwNGQtODEwOC0wMjYxNjdiMzNmMTkiLCJjbGllbnRfaWQiOiJDTElFTlRfSUQifQ.bEA6n0gQkg3OsUD7SimCpX0__vAWfHvK0tAX6JofKHguUexboInv-iwNXJbT9HhuRn1FmF13x8zppPJgyv9PdpELiR_npXbkLcRgNazLhf-VSaLocNRPVoTDeHVNu-CtFO0wKwDW8Ul--gvVYtzqMi6-9eXuR39Uh2mnmh0WDid_FTmk7FvuXtbd76mlzgYmVx4Yssy5NfO_45QJWnjwaF6sJ9ALk46zwhW2pd5AFKs4b2YjpAq-dV_N0JxnGSgfRDdrrrV3p5iD3x90j4oM5MthsDZwcKcfH77S7VGb0JvarSTfGhvaybaG6eQodQV0z5JzfzhdxszPBHRxvVgR2Q' \
    -H 'Content-Type: application/json' \
    -d '{
  "freightReference" : "REF-000456",
  "plateNumber" : "PLATE NUMBER",
  "type" : "VEHICLE TYPE",
  "carrierTaxIdentifier" : "CARRIER TAX IDENTIFIER"
}'

4.7. Freight Communication Data (FCD) Webhooks

4.7.1. Parameters

Type Name Description Schema

Body

freightCommunication
required

Freight Communication Data

Freight Communication

4.7.2. Responses

HTTP Code Description Schema

200

OK

Freight Communication

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

4.7.3. Example HTTP request

POST /webhooks/v1/freights/communications HTTP/1.1
Content-Length: 264
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJpbnRlZ3JhdGlvbiJdLCJleHAiOjE2MzYwMjEwNzYsImlhdCI6MTYzNjAxOTI3NiwiYXV0aG9yaXRpZXMiOlsiUk9MRV9BRE1JTiJdLCJqdGkiOiIyNTk4ZDJkYS01MGQ5LTRkOTctYjc2OC00OTZmY2M4MzU2MmYiLCJjbGllbnRfaWQiOiJDTElFTlRfSUQifQ.OjM4q-xSXevhKAsaCcYM1np2ys3IHUAyc1eMNEme9I9ZR0wraMbPPPfV9a0hGQqfZhDybIfYvm2uydY0_SO7Fo1P9PRe9xM6k7gsrUTMXQil5gyLDd87A3DcqutFVZrD4b800zn4hGwrygXb7RqMX3ka79uyFOZPUa8bLiOyZjlJZEcAdV3bFYxFkL-UEXIQWXSqI9LH3oZzCyHAo9Otg7JNxAONj8xuUgE0TSBoA5v1kFqdrNsEM2rIpngbTZrm9GYlOuDVKka4WcyZV7uon8-9mPzEVxX7NafdQ71BCf07mo5deOOjl4-4JU3pQSdCdylIQZsp2ychECv0zCYTIA
Host: api.wanatruck.com
Content-Type: application/json

{
  "freightReference" : "REF-000456",
  "message" : "MESSAGE",
  "when" : "2021-03-20T13:47:33+01:00",
  "shipperName" : "SHIPPER NAME",
  "carrierName" : "CARRIER NAME",
  "driverName" : "DRIVER NAME",
  "type" : "COMMENT",
  "stopPositionRelated" : 1
}

4.7.4. Example HTTP response

HTTP/1.1 200 OK
Content-Length: 259
Content-Type: application/json;charset=UTF-8

{
  "freightReference" : "REF-000456",
  "message" : "MESSAGE",
  "when" : "2021-03-20T12:47:33Z",
  "shipperName" : "SHIPPER NAME",
  "carrierName" : "CARRIER NAME",
  "driverName" : "DRIVER NAME",
  "type" : "COMMENT",
  "stopPositionRelated" : 1
}

4.7.5. Example Curl request

$ curl 'https://api.wanatruck.com/webhooks/v1/freights/communications' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJpbnRlZ3JhdGlvbiJdLCJleHAiOjE2MzYwMjEwNzYsImlhdCI6MTYzNjAxOTI3NiwiYXV0aG9yaXRpZXMiOlsiUk9MRV9BRE1JTiJdLCJqdGkiOiIyNTk4ZDJkYS01MGQ5LTRkOTctYjc2OC00OTZmY2M4MzU2MmYiLCJjbGllbnRfaWQiOiJDTElFTlRfSUQifQ.OjM4q-xSXevhKAsaCcYM1np2ys3IHUAyc1eMNEme9I9ZR0wraMbPPPfV9a0hGQqfZhDybIfYvm2uydY0_SO7Fo1P9PRe9xM6k7gsrUTMXQil5gyLDd87A3DcqutFVZrD4b800zn4hGwrygXb7RqMX3ka79uyFOZPUa8bLiOyZjlJZEcAdV3bFYxFkL-UEXIQWXSqI9LH3oZzCyHAo9Otg7JNxAONj8xuUgE0TSBoA5v1kFqdrNsEM2rIpngbTZrm9GYlOuDVKka4WcyZV7uon8-9mPzEVxX7NafdQ71BCf07mo5deOOjl4-4JU3pQSdCdylIQZsp2ychECv0zCYTIA' \
    -H 'Content-Type: application/json' \
    -d '{
  "freightReference" : "REF-000456",
  "message" : "MESSAGE",
  "when" : "2021-03-20T13:47:33+01:00",
  "shipperName" : "SHIPPER NAME",
  "carrierName" : "CARRIER NAME",
  "driverName" : "DRIVER NAME",
  "type" : "COMMENT",
  "stopPositionRelated" : 1
}'

4.8. Authentication

Webhooks can authenticate in different ways: using OAuth2 flows or sending a preconfigured Authorization token.

If you need any other authentication mechanism, please contact with our Support Team

5. Definitions

5.1. Address

Address model with the address data of companies

Name Description Schema

city
optional

City, city area or district

string

country
optional

Country

string

countryISOCode
optional

ISO 3166-1 alpha 2 code

string

postalCode
optional

Postal or ZIP code

string

stateProvince
optional

State province or county

string

streetName
optional

Street name

string

5.2. Attachment

Attachment model with the file to associate to the freight

Name Description Schema

attachment
optional

Attachment binary encoded in Base64

string(byte)

attachmentContentType
optional

Attachment content type

string

freightReference
required

Freight reference for this attachment

string

m2mId
optional

Machine to machine identifier

string

name
optional

Attachment name

string

5.3. Company Data

Company Data model with the data needed to create or update companies related to the freight:
shipper, carriers and destinataries

Name Description Schema

costCenterName
optional

Cost center or venue name

string

m2mId
optional

Machine to Machine identifier

string

name
required

Company Name

string

phone
optional

Company phone

string

reference
required

Company Reference

string

taxAddress
required

Company Tax Address

Address

taxIdentifier
required

Company Tax Identifier

string

5.4. Coordinate

Coordinate model with latitude and longitude

Name Description Schema

lat
optional

Latitude

string

lng
optional

Longitude

string

5.5. Delivery Note

Delivery Note model with the data needed to create or update delivery notes and associate them to the freight

Name Description Schema

adr
optional

Is ADR?

boolean

customerName
required

Delivery note number

string

customerReference
optional

Customer reference for this delivery note

string

deliveryNoteLines
optional

Delivery note lines data

< Delivery Note Line > array

deliveryNoteNumber
required

Delivery note number

string

file
optional

Delivery note binary file encoded in Base64

string(byte)

fileContentType
optional

Delivery note binary file content type

string

freightReference
required

Freight reference for this delivery note

string

loadStopPosition
required

Stop position where the Delivery Note is loaded

integer(int32)

observations
optional

Observations once loaded or unloaded

string

packages
optional

Number of packages associated to the Delivery Note

integer(int32)

templateName
optional

Delivery note template name to get configuration

string

type
required

Delivery Note type to know if you are sending DATA or FILE

enum (DATA, FILE)

unloadStopPosition
required

Stop position where the Delivery Note is unloaded

integer(int32)

weight
optional

Merchandise weight associated to the Delivery Note

number

5.6. Delivery Note Line

Delivery Note Line model with the data needed delivery note lines

Name Description Schema

batch
optional

Product batch

string

code
optional

Product code

string

description
optional

Product description

string

eanCode
optional

EAN Code

string

orderNumber
optional

Order number

string

position
optional

Delivery note line position

integer(int32)

quantity
optional

Quantity of product

number

weight
optional

Product weight

number

5.7. Driver

Driver model with the driver data

Name Description Schema

accepted
optional

Set the date when the assignation was accepted, if it was

string(date-time)

assigned
required

When the driver was assigned

string(date-time)

cancelled
optional

Set the date when the assignation was cancelled, if it was

string(date-time)

carrierName
optional

Carrier name

string

carrierTaxIdentifier
required

Carrier tax identifier

string

email
optional

Driver email

string

firstName
required

Driver first name

string

freightReference
required

A reference for the trip

string

lastName
required

Driver last name

string

phone
optional

Driver phone

string

rejected
optional

Set the date when the assignation was rejected, if it was

string(date-time)

5.8. Freight

Freight model with the data needed to create or update freight data in platform and documents

Name Description Schema

adr
optional

Confirm if it is an ADR transport

boolean

agreements
optional

Agreements between shipper and carrier (if any)

string

assignationStatus
optional

Set the current carrier assignation status

enum (PENDING, ASSIGNED, CANCELLED, ACCEPTED, REJECTED)

assignations
optional

Assignations

< Freight Assignation > array

attachments
optional

Attachments

< Attachment > array

carrierObservations
optional

Carrier observations (if any)

string

contractualCarrier
required

Contractual carrier data for the platform and documents

Company Data

documentType
optional

Confirm the transport document to use

enum (ECMR, ECDP, EDELIVERYNOTE)

drivers
optional

Drivers

< Driver > array

effectiveCarrier
optional

Effective carrier data for the platform and documents.

If it is not set, platform and documents will use the contractual carrier data

Company Data

events
optional

Events

< Freight Communication > array

incident
optional

This field indicates if there is an unresolved incident

boolean

incidentEnd
optional

If there is an incident, this field contains when it ended

string(date-time)

incidentStart
optional

If there is an incident, this field contains when it started

string(date-time)

instructions
optional

Loading instructions for the carrier

string

links
optional

Links

< string, string > map

m2mId
optional

Machine to Machine identifier

string

maxTemp1
optional

Maximum temperature for first sensor

integer(int32)

maxTemp2
optional

Maximum temperature for second sensor

integer(int32)

maxTemp3
optional

Maximum temperature for third sensor

integer(int32)

minTemp1
optional

Minimum temperature for first sensor

integer(int32)

minTemp2
optional

Minimum temperature for second sensor

integer(int32)

minTemp3
optional

Minimum temperature for third sensor

integer(int32)

nextStopPosition
required

Price of the freight

integer(int32)

payer
optional

The freight payer

enum (LOADER, DESTINATARY)

point
optional

This field indicates the coordinates where the freight is

Coordinate

price
optional

Price of the freight

number

reference
required

A reference for the trip

string

routeM2mId
optional

Route machine to machine identifier

string

routeName
optional

Route name

string

shipper
required

Shipper data for the platform and documents

Company Data

startDate
optional

When the freight started

string(date-time)

status
required

Set the current status for the freight

enum (PENDING, ASSIGNED, CANCELLED_BY_CARRIER, CANCELLED_BY_SHIPPER, ACCEPTED, REJECTED, STARTED, ARRIVED, WORKING_START, WORKING_END, ON_ROUTE, FINISHED, FINISHED_BY_CARRIER, FINISHED_BY_SHIPPER, FINISHED_WITH_INCIDENT, NO_SHOW_BY_CARRIER, NO_SHOW_BY_SHIPPER)

stops
optional

Loading instructions for the carrier

< Freight Stop > array

transportType
required

Loading instructions for the carrier:

MULTI for delivery notes signature

enum (CANVAS, VAN, BOX, RIGID_TRUCK, REFRIGERATED, BIREFRIGERATED, TRIREFRIGERATED, BULK, DUMP, TANKER, REFRIGERATED_TANKER, CRANE, OTHER)

type
required

Loading instructions for the carrier:

MULTI for delivery notes signature

enum (FULL, MULTI, PALET, GROUPAGE)

vehicles
optional

Vehicles

< Vehicle > array

waste
optional

Confirm if it is a waste transport

boolean

5.9. Freight Assignation

Freight Assignation model with the data of freight assignations

Name Description Schema

accepted
optional

If the assignation was accepted, the moment when it was

string(date-time)

assignationType
optional

The assignation type

enum (OWN, COLLABORATOR, MIXED)

assigned
required

The moment when the freight was assigned

string(date-time)

assignedFromCostCenterName
optional

The Shipper cost center name

string

assignedFromName
optional

The Shipper company name

string

assignedToAddress
optional

The Carrier company address

string

assignedToName
optional

The Carrier company name

string

assignedToPhone
optional

The Carrier company phone

string

assignedToTaxIdentifier
optional

The Carrier company tax identifier

string

cancelled
optional

If the assignation was cancelled, the moment when it was

string(date-time)

carrierFreightReference
optional

The reference of the Carrier for this freight

string

contractualCarrier
optional

The assigned Carrier, is the contractual one?

boolean

freightReference
required

A reference for the trip

string

price
optional

The price of the transport service

number

rejected
optional

If the assignation was rejected, the moment when it was

string(date-time)

routeName
optional

The route name if there is one for the freight

string

5.10. Freight Communication

Freight Communication model with the data of comments or incidents in the transport

Name Description Schema

carrierName
optional

If the comment/incident is reported by Carrier, this field contains the user or company name

string

driverName
optional

If the comment/incident is reported by Driver, this field contains the driver name

string

freightReference
required

A reference for the trip

string

message
required

A message with the comment or the incident

string

shipperName
optional

If the comment/incident is reported by Shipper, this field contains the user or company name

string

stopPositionRelated
optional

If the comment/incident is reported from a stop, this field contains the stop number

integer(int32)

type
optional

The type of communication

enum (INCIDENT, COMMENT)

when
required

The moment when the communication is sent

string(date-time)

5.11. Freight Stop

Freight stop model with the freight stop data

Name Description Schema

address
required

Stop address

Address

arrivalDate
optional

Driver arrival date

string(date-time)

company
required

Company data

Company Data

contactUserEmail
required

Contact user email

string

contactUserFirstName
required

Contact user first name

string

contactUserLastName
required

Contact user last name

string

departureDate
optional

Driver departure date

string(date-time)

driverName
optional

Driver name who has arrived to this stop

string

driverTaxIdentifier
optional

Driver tax identifier who has arrived to this stop

string

freightReference
required

A reference for the trip

string

grossWeight
optional

Total weight

number

identification
optional

Freight identification

string

loadingEndDate
optional

Loading end date

string(date-time)

loadingStartDate
optional

Loading start date

string(date-time)

nature
optional

Freight nature

string

netWeight
optional

Net weight

number

packages
optional

Number of packages, palets or liters

integer(int32)

packaging
optional

Packaging description

string

point
optional

Coordinates for this stop

Coordinate

position
required

Stop position. Starting by 1

integer(int32)

price
optional

Freight price

number

reservations
optional

Freight reservations

string

sealNumber
optional

Seal number

string

since
optional

Earlier date expected to arrive to this stop

string(date-time)

tare
optional

Vehicle tare

number

type
required

Freight stop type

enum (LOAD, UNLOAD)

until
optional

Later date expected to arrive to this stop

string(date-time)

5.12. Vehicle

Vehicle model with the vehicle data

Name Description Schema

carrierTaxIdentifier
required

Carrier tax identifier

string

freightReference
required

A reference for the trip

string

plateNumber
required

Vehicle plate number

string

type
required

Vehicle type

string