Streamed Statuses giver en måde hurtigt at finde ud af statusændringer på dine forsendelser. Du behøver ikke at hente data med et getStatus-kald; vi leverer dataene til dig via en streaming push-mekanisme. Du kan abonnere på hændelser, og når en opdatering sker, vil vi sende statusdata til den URL, du angiver i MyTranssmart i menuen Manage account > Streamed Statuses.
Første skridt er at kontakte vores supportafdeling for at få det aktiveret for dig. Vi aktiverer det først på vores Accept-miljø, så du kan konfigurere og teste integrationen. Når det er lykkedes, aktiverer vi det på Production.
Opsætning
Sørg først for, at du har et autentificeret endpoint, der kan modtage statusopdateringer.
Dernæst skal du aktivere og færdiggøre konfigurationen på opsætningssiden.
- URL = dit endpoint
- Authentication = vælg mellem None, Header eller Basic afhængigt af dit eget valg af konfiguration.
- Status push method = vælg mellem Package level (standard) eller Shipment level. Se forklaring nedenfor
Vigtig bemærkning: (læs også venligst opdateringen fra december 2024 nedenfor)
I din mapping skal du sikre dig, at du læser statusværdien fra feltet genericStatusCode i shipmentLines og ikke fra shipmentStatus i shipment header. Årsagen er, at vi for nogle carriers ikke modtager statusopdateringen på shipment header-niveau, og at vi via en algoritme ændrer status på shipment header-niveau efter at have kontrolleret status pr. shipment line.
Eksempel:
En shipment har 3 lines:
Line 1: package med status DONE
Line 2: package med status TRNS
Line 3: package med status TRNS
Shipment header-status er TRNS
Vi modtager statusopdateringen for pakkelinje 2, som ændres til DONE. Da der stadig er en pakke med status TRNS på linje 3, ændrer algoritmen ikke forsendelsens header-status, så den forbliver TRNS.
Vi modtager statusopdateringen for pakkelinje 3, som ændres til DONE. Da der ikke er flere pakker med status TRNS, ændrer algoritmen forsendelsens header-status til DONE. Men på det tidspunkt, hvor vi modtog statusopdateringen, havde vi allerede sendt statusmeddelelsen til dit endpoint. På dette tidspunkt var feltet shipmentStatus i headeren stadig TRNS, mens genericStatusCode i shipmentLine havde status DONE. Hvis du mapper til forsendelsens header-status, vil forsendelsen derfor forblive på TRNS i dit system i stedet for at blive ændret til DONE. Derfor er det vigtigt at mappe til statusværdien fra feltet genericStatusCode i shipmentLines.
Opdatering: I december 2024 har vi tilføjet en indstilling, der afgør, om den besked, vi sender, skal udløses af pakkelinjerne eller forsendelseshovedet.
Standardindstillingen er stadig pr. pakkelinje. Hvis du ønsker at ændre det til forsendelseshoved, skal du ændre indstillingen. Du skal gøre dette, hvis du ikke er i stand til at mappe til feltet genericStatusCode i shipmentLines.
Den nye indstilling er tilgængelig på konfigurationssiden under Manage account > Streamed Statuses
Beskedformat
Payloaden, der sendes i statusnotifikationen, er den samme som svaret på forespørgsler til statusopslag, kapitel 5.1 i vores DevDocs: https://devdocs.transsmart.com/#_5_2_status_stream
isIncremental
Parameteren isIncremental, som bruges i Status Retrieval API endpoints, påvirkes ikke af de beskeder, der pushes fra vores system. Hvis du stadig ønsker at hente statusforespørgsler til dit eget system, eller måske et andet system, er det stadig muligt.
Underkonti
Hvis du har en konfiguration med én hovedkonto og en eller flere underkonti, afhænger det af endpoint-konfigurationen, hvordan det skal sættes op. Hvis du har ét endpoint, hvor du vil modtage alle statusbeskeder for alle konti, er det tilstrækkeligt kun at konfigurere det på hovedkontoen. Indstillingen vil automatisk blive nedarvet til alle underkonti.
Hvis du har et andet endpoint pr. underkonto, kan du konfigurere det pr. underkonto.