API Docs

Erscheinungsbild

Trucking-Raten suchen — Vor- und Nachlauf per LKW zwischen Postleitzahlengebiet und Flughafen.

Orte werden als "<typ>:<wert>" angegeben: airport:FRA oder city:D-63000. Passende Werte liefert der Autocomplete-Endpunkt GET /pricing/search/location/{query}/{type}.json.

Von der Suche zur Fracht

Jede Suche wird gespeichert. Die ID aus data.searchEntity.id lässt sich als pricing_search_id an POST /freights/add.json übergeben — Strecke, Gewicht und Packstücke werden daraus vorbefüllt.

Namensfalle

/pricing/search/rate-search.json ist nicht die Suche, sondern die Bewertung eines Suchergebnisses (Daumen hoch/runter). Die Suche ist POST /pricing/search/results.json.

Gespeicherte Suche erneut ausführen​

GET
/pricing/search/results.json

Führt eine Suche aus der Historie erneut mit aktuellen Raten aus.

Authorizations​

authTokenHeader

Empfohlen. Dein API-Token als Header. Das Schema heißt ApplePass —
historisch bedingt, aber so muss es lauten:

Authorization: ApplePass DEIN_TOKEN

Den Token holst du über
POST /users/login.json.

Type
API Key (header: Authorization)
or
authTokenQuery

Derselbe Token als Query-Parameter: ?auth_token=DEIN_TOKEN.

Praktisch für curl und schnelle Tests.

Nicht für produktive Integrationen verwenden: Query-Parameter landen in
Server-Logs, Proxy-Logs und Browser-Referrern. Nutze dort authTokenHeader.

Type
API Key (query: auth_token)

Parameters​

Query Parameters

search_id*

ID einer gespeicherten Suche (data.searchEntity.id einer früheren Suche).

Type
integer
Required

Responses​

Suchergebnis.

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Trucking-Raten suchen​

POST
/pricing/search/results.json

Sucht Trucking-Raten über alle Ratenblätter, die für deine Firma sichtbar sind.
Dein Benutzer muss dafür einer Firma zugeordnet sein.

Es werden bis zu 200 direkte Raten geliefert. combinations enthält
zusätzlich gefundene Multi-Leg-Kombinationen.

Jede Suche wird gespeichert. Ihre ID steht in data.searchEntity.id und lässt sich
später als pricing_search_id an
POST /freights/add.json übergeben, um
eine Fracht daraus vorzubefüllen.

Authorizations​

authTokenHeader

Empfohlen. Dein API-Token als Header. Das Schema heißt ApplePass —
historisch bedingt, aber so muss es lauten:

Authorization: ApplePass DEIN_TOKEN

Den Token holst du über
POST /users/login.json.

Type
API Key (header: Authorization)
or
authTokenQuery

Derselbe Token als Query-Parameter: ?auth_token=DEIN_TOKEN.

Praktisch für curl und schnelle Tests.

Nicht für produktive Integrationen verwenden: Query-Parameter landen in
Server-Logs, Proxy-Logs und Browser-Referrern. Nutze dort authTokenHeader.

Type
API Key (query: auth_token)

Request Body​

JSON
{
  
"origin": "city:D-63000",
  
"destination": "airport:FRA",
  
"weight": 250,
  
"direction": "auto",
  
"allow_combinations": 1
}

Responses​

Suchergebnis.

application/json
JSON
{
  
"data": {
  
  
"rates": [
  
  
],
  
  
"combinations": {
  
  
  
"results": [
  
  
  
  
{
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
}
  
  
  
],
  
  
  
"debug": {
  
  
  
  
"additionalProperties": "string"
  
  
  
}
  
  
},
  
  
"weight": 0,
  
  
"search_type": "string",
  
  
"uld_count": 0,
  
  
"selected_direction": "string",
  
  
"effective_direction": "string",
  
  
"weight_actual": 0,
  
  
"weight_volumen166": 0,
  
  
"searchEntity": {
  
  
  
"id": 0
  
  
}
  
},
  
"status": "string",
  
"auth": "string"
}

Playground​

Server
Authorization
Body

Samples​

Öffentliche Ratensuche (ohne Login)​

POST
/pricing/public-search/{companyId}/results.json

Sucht ausschließlich in Rate-Sheets der angegebenen Company, die die Sichtbarkeit
public_search haben. Kein Token nötig — der einzige unauthentifizierte
Pricing-Endpunkt.

Gleiche Body-Felder wie die authentifizierte Suche.

Parameters​

Path Parameters

companyId*

ID der Company, deren öffentliche Sheets durchsucht werden.

Type
integer
Required

Request Body​

application/json
JSON
"string"

Responses​

Suchergebnis (nur öffentliche Sheets der Company).

application/json
JSON
"string"

Playground​

Server
Variables
Key
Value
Body

Samples​

Suchhistorie​

GET
/pricing/search/history.json

Liefert die gespeicherten Suchen der eigenen Company.

Authorizations​

authTokenHeader

Empfohlen. Dein API-Token als Header. Das Schema heißt ApplePass —
historisch bedingt, aber so muss es lauten:

Authorization: ApplePass DEIN_TOKEN

Den Token holst du über
POST /users/login.json.

Type
API Key (header: Authorization)
or
authTokenQuery

Derselbe Token als Query-Parameter: ?auth_token=DEIN_TOKEN.

Praktisch für curl und schnelle Tests.

Nicht für produktive Integrationen verwenden: Query-Parameter landen in
Server-Logs, Proxy-Logs und Browser-Referrern. Nutze dort authTokenHeader.

Type
API Key (query: auth_token)

Responses​

Liste vergangener Suchen.

application/json
JSON
"string"

Playground​

Server
Authorization

Samples​

Ort-Autocomplete​

GET
/pricing/search/location/{query}/{type}.json

Löst eine Sucheingabe zu Airports oder Städten/PLZ auf. Die zurückgegebenen Werte
sind direkt als origin / destination verwendbar (Format airport:FRA bzw.
city:D-63000).

Authorizations​

authTokenHeader

Empfohlen. Dein API-Token als Header. Das Schema heißt ApplePass —
historisch bedingt, aber so muss es lauten:

Authorization: ApplePass DEIN_TOKEN

Den Token holst du über
POST /users/login.json.

Type
API Key (header: Authorization)
or
authTokenQuery

Derselbe Token als Query-Parameter: ?auth_token=DEIN_TOKEN.

Praktisch für curl und schnelle Tests.

Nicht für produktive Integrationen verwenden: Query-Parameter landen in
Server-Logs, Proxy-Logs und Browser-Referrern. Nutze dort authTokenHeader.

Type
API Key (query: auth_token)

Parameters​

Path Parameters

query*

Suchbegriff (min. 2 Zeichen), URL-encoded.

Type
string
Required
Example"frank"
type*
Type
string
Required
Valid values
"airport""city"

Responses​

Treffer.

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Suchergebnis bewerten (Daumen hoch/runter)​

POST
/pricing/search/rate-search.json

⚠️ Namensfalle: Dieser Endpunkt ist nicht die Ratensuche, sondern das
Feedback zu einem Suchergebnis. Die Suche ist
POST /pricing/search/results.json.

Authorizations​

authTokenHeader

Empfohlen. Dein API-Token als Header. Das Schema heißt ApplePass —
historisch bedingt, aber so muss es lauten:

Authorization: ApplePass DEIN_TOKEN

Den Token holst du über
POST /users/login.json.

Type
API Key (header: Authorization)
or
authTokenQuery

Derselbe Token als Query-Parameter: ?auth_token=DEIN_TOKEN.

Praktisch für curl und schnelle Tests.

Nicht für produktive Integrationen verwenden: Query-Parameter landen in
Server-Logs, Proxy-Logs und Browser-Referrern. Nutze dort authTokenHeader.

Type
API Key (query: auth_token)

Request Body​

application/json
JSON
{
  
"search_id": 0,
  
"rating": 0,
  
"rate_id": 0
}

Responses​

Bewertung gespeichert.

application/json
JSON
"string"

Playground​

Server
Authorization
Body

Samples​