Streamed Statuses tilbyr en måte å raskt finne ut om statusendringer på dine forsendelser. Du trenger ikke å hente med et getStatus-kall; vi leverer dataene til deg via en streaming push-mekanisme. Du kan abonnere på hendelser, og når en oppdatering skjer vil vi poste statusdata til URL-en du angir i MyTranssmart i menyen Manage account > Streamed Statuses.
Første steg er å kontakte vår supportavdeling for å aktivere dette for deg. Vi vil først aktivere det i vårt Accept-miljø slik at du kan konfigurere og teste integrasjonen. Når dette er vellykket, vil vi aktivere det i Production.
Oppsett
Sørg først for at du har et autentisert endpoint som kan motta statusoppdateringer.
Neste steg er å aktivere og fullføre konfigureringen på oppsettsiden.
- URL = ditt endpoint
- Authentication = velg mellom None, Header eller Basic avhengig av ditt eget konfigurasjonsvalg.
- Status push method = velg mellom Package level (standard) eller Shipment level. Se forklaring nedenfor
Viktig merknad: (les også oppdateringen fra desember 2024 nedenfor)
I din mapping må du sørge for å lese statusverdien fra feltet genericStatusCode i shipmentLines og ikke fra shipmentStatus i shipment header. Årsaken er at for noen carriers mottar vi ikke statusoppdatering på shipment header-nivå, og ved hjelp av en algoritme endrer vi status på shipment header-nivå etter å ha sjekket status per shipment line.
Eksempel:
En shipment har 3 linjer:
Line 1: package med status DONE
Line 2: package med status TRNS
Line 3: package med status TRNS
Shipment header-statusen er TRNS
Vi mottar statusoppdateringen for pakkelinje 2, som endres til DONE. Fordi det fortsatt er en pakke med status TRNS på linje 3, endrer ikke algoritmen statusen på forsendelsesheaderen, så den forblir TRNS.
Vi mottar statusoppdateringen for pakkelinje 3, som endres til DONE. Fordi det ikke er flere pakker med status TRNS, endrer algoritmen statusen på forsendelsesheaderen til DONE. Men, på det tidspunktet vi mottok statusoppdateringen, hadde vi allerede sendt statusmeldingen til ditt endpoint. På dette tidspunktet var feltet shipmentStatus i headeren fortsatt TRNS, mens genericStatusCode i shipmentLine hadde status DONE. Hvis du mapper til forsendelsesheaderstatusen, vil forsendelsen forbli TRNS i systemet ditt i stedet for å endres til DONE. Derfor er det viktig å mappe til statusverdien fra feltet genericStatusCode i shipmentLines.
Oppdatering: I desember 2024 la vi til en innstilling for å bestemme om meldingen vi sender skal trigges av kollilinjer eller av forsendelseshode.
Standardinnstillingen er fortsatt per kollilinje. Hvis du ønsker å endre dette til forsendelseshode, må du endre innstillingen. Du må gjøre dette dersom du ikke kan mappe til feltet genericStatusCode i shipmentLines.
Den nye innstillingen er tilgjengelig på konfigurasjonssiden under Manage account > Streamed Statuses
Meldingsformat
Payloaden som sendes i statusvarslingen er den samme som responsen på forespørsler om statusuthenting, kapittel 5.1 i våre DevDocs: https://devdocs.transsmart.com/#_5_2_status_stream
isIncremental
Parameteren isIncremental som brukes i Status Retrieval API-endepunktene påvirkes ikke av meldingene som pushes fra systemet vårt. Hvis du fortsatt ønsker å hente statusforespørsler til ditt eget system, eller kanskje til et annet system i tillegg, er det fortsatt mulig.
Underkontoer
Hvis du har en konfigurasjon med én hovedkonto og én eller flere underkontoer, avhenger det av endepunktskonfigurasjonen hvordan dette skal settes opp. Hvis du har ett endepunkt der du vil motta alle statusmeldinger for alle kontoer, er det tilstrekkelig å kun konfigurere det på hovedkontoen. Innstillingen vil automatisk bli arvet av alle underkontoer.
Hvis du har et eget endepunkt per underkonto, kan du konfigurere det per underkonto.