Customer
Segmentet Customer är uppgifter om den kunden som ska vara ansvarig för lastbärarna i transaktionen. Fältet ”number” är oftast det som ni använder som kundnummer, det behöver vara unikt för er. Org.nummer och GLN-nummer är frivilliga fält.
Fält | Obligatorisk |
|---|---|
name | Yes |
number | Yes |
organizationNumber | No |
globalLocationNumber | No |
Location-form
Location from är varifrån lastbärarna skickas, detta är en adress, men behöver identifieras med ett id av något slag, (fältet Number). Finns GLN-nummer så noär det jättebra att använda det.
Om ni skickar ut från er, så är detta adressen till er plats, om det är en retur som ni skall skicka in, så är detta kundens adress.
Om ni skickar med en e-postadress kommer den att sparas på ”kundnivå” och kommer användas på alla transaktioner till denna kund / adress. Kommer även att användas för att skicka tex. ett månatlig saldorapport eller liknande som inte direkt är styrda av en order, utan styrda av inställningar på platsen.
Fält | Obligatorisk |
|---|---|
name | Yes |
number | Yes |
globalLocationNumber | No |
emailNotificationRecipients | No |
Adress
Här är adressen till platsen.
Viktigt att tänka på är att country är obligatoriskt. Vi behöver en tvåsiffrig ISO-kod för att kunna göra bokning till transportörer, alltså SE för Sverige, NO Norge, DE Tyskland osv – inte S, N eller D.
Postnummer ska vara ett rent fält med enbart siffor. Därav får ej landskod eller mellanslag finnas. Ex. Rätt: 55317 Fel: SE-553 17.
Fält | Obligatorisk |
|---|---|
street | Yes |
street2 | No |
city | Yes |
state | No |
country | Yes |
postalCode | Yes |
LocationTo
Location to, det är vart leveransen av lastbärare har gått. Behöver identifieras med ett id, på samma sätt som beskrevs för location from. Även epost-fältet har samma funktion som beskrevs på location from
Fält | Obligatorisk |
|---|---|
name | Yes |
number | Yes |
globalLocationNumber | No |
emailNotificationRecipients | No |
Adress
Här är adressen till leveransplatsen
Fält | Obligatorisk |
|---|---|
street | Yes |
street2 | No |
city | Yes |
state | No |
country | Yes |
postalCode | Yes |
Order
Fält | Beskrivning |
|---|---|
emailNotificationRecipients | Här är ett fält där man kan skriva e post, denna epost används bara på denna order, om man jämför med den epost man kan ange på platsen. Om det är olika adresser kommer epost att skickas till båda. |
estimatedTimeDeparture | Detta är ett datum då ni har eller planerar att leverera lastbäraren från er. Om ni inte skriver något, så kommer vi anta att det är gjort samma dag som transaktionen skapas. |
estimatedTimeArrival | Detta är ett fält där man kan ange när lastbäraren beräknas anlända till mottagaren. Om man inte anger något, så kommer vi anta att det är dagen efter utleveransens datum |
salesOrderNumber | Ett fält där ni kan ange ert eget ordernr. Används för att ni skall kunna söka/hitta |
purchaseOrderNumber | Ett fält där ni kan ange er kunds nr på transaktionen. Används för att i vissa lägen kommunicera till kunden, så att de förstår till vilken order leveransen av lastbärare tillhör |
deliveryNumber | Ett fält där man kan ange ett leveransnummer om sådant finns. |
reference | Ett fritextfält där man kan ange referens eller liknande. |
notes | Ytterligare ett fält med fritextfält för tex. egna noteringar |
externalSystemId | Ett fält där man kan ange ett systemid från sitt eget system. Används om ni vill kunna spåra transaktionen digitalt mot ert eget system |
orderRows
Fält | Beskrivning |
|---|---|
assetType | Här är ett ID som identifierar själva lastbäraren. Ett artikelnummer eller liknande som är unikt för lastbärartypen. |
quantity | Här anges hur många lastbärare |
serialNumbers | Om ni använder unika serienummer på lastbärarna så kan ni här ange ett sådant. |
Vilken data behövs?
Det finns en swagger dokumentation: Swagger UI (trackmate.se) (öppnas i nytt fönster)
Nedan finns en beskrivning över den datan som måste och kan skickas till Trackmate.
Integrationsguide
1.
Trackmate har ett REST API att integrera mot.
API-dokumentation (Swagger) finns här:
Swagger UI (trackmate.se) (öppnas i nytt fönster)
End point som skall användas är https://api.trackmate.se/API/
3.
Nästa verifiering som behövs är att i de flesta anrop behöver ni skicka med ett Owner ID. Vi använder detta ID för att identifiera vilken konto som transaktionen skall läggas på, här är ett exempel
Ni hittar detta ID inne i applikationen. Klicka på "Integration" som finns under namnet på ert konto längst upp på sidan.
Klart!
Behöver du hjälp?
Om ni inte har kapacitet eller möjlighet att göra en API-integration, kontakta oss för diskussion hur vi löser det på bästa sätt.
2.
Autentisering till vårt API sker med hjälp av två faktorer.
Dels måste ni ha en API Key för att identifiera er mot vårt API, sedan behöver ni även ha med en identitet på varje anrop som görs för att identifiera vilket konto som transaktionen skall göras mot.
API Key
Ni skall lägga till en Auth Type som skall vara en API Key. Den skall heta X-API-Key och ni skall lägga en token som ni hittar i Trackmate applikationen som value
Den Token som ni skall använda hittar ni inne i applikationen.
Klicka på ert konto upp i högra hörnet, klicka sedan på "Account" så hittan ni er access token
Hur ska informationen skickas till Trackmate?
Det finns två alternativ för hur datan ska skickas till Trackmate: via API eller via fil till FTP-server.
API-integration
Endpoint som skall användas är: https://api.trackmate.se/api/Order/Batch
(Json-format rekommenderas och strukturen framgår i Swagger-dokumentationen)
Autentisering
Det behövs två olika autentiseringar, dels behöver ni identifiera er mot vårt API. Det gör ni genom att lägga till en Auth Type som skall vara en ”API Key”, och som value skall ni ange en token som ni hittar inne i Trackmate appen. Se längst ner bilder på var ni hittar den token.
Sedan behövs även ett ”owner id” i varje anrop. Det använder Trackmate för att identifiera vilket konto i Trackmate som skall ”äga” transaktionen ni skickar in. Här är ett exempel på hur Owner id skall placeras på ett anrop. Detta framgår även i Swagger dokumentationen.
Ni hittar även detta ID inne i Trackmate appen. Se bild längst ner var ni hittar den.
FTP-server
Om ni inte vill eller kan skicka över data via vårt API kan ni skapa en fil och lägga på en FTP-server. Vi kommer att hämta filen på denna FTP och läsa in den i Trackmate.
Formatet på filen kan variera, men det behöver vara en fil som är lämplig för just filintegration, exempelvis en TXT-fil, XML-fil eller motsvarande. PDF-filer, mail och liknande kommer inte fungera.
För att använda FTP behöver ni kontakta Trackmates support för att fastställa detaljer och planera för uppsättning av ett FTP flöde.
Ni behöver ha tillgång till en FTP server, Trackmate kommer hämta filen på den FTP server som ni hänvisar till. Ni kan inte lägga filen direkt på en FTP server hos Trackmate.
API Key
Ni hittar token som skall användas om API Key inne i Trackmate appen. När ni skapade Trackmate kontot så angavs minst en person som super user. Den personen skall logga in. Uppe i högra hörnet finns en rund icon med den inloggades initialer, (se #1 i bilden). Klicka på den runda iconen, och sedan på ”Account”, då kommer ni till en sida som heter User account.
Där finns personal access tokens, finns det ingen så klicka på knappen för att generera en. Kopiera den token och använd som value i API Key i ert API anrop.
Owner ID
För att hitta det Owner id som behövs i varje anrop så behöver ni logga in i Trackmate appen som super user. I överkant till höger så finns ert företagsnamn, (se #1 i bilden). Klicka på namnet så kommer en meny fram. I denna meny finns ett var som heter Integration.
På de sidan så finns det ett API integration ID, kopiera det och använd som Owner id i anropen.
