Streamed Statuses bieden een manier om snel inzicht te krijgen in statuswijzigingen van je zendingen. Je hoeft geen getStatus-call meer uit te voeren; wij leveren de gegevens aan jou via een streaming pushmechanisme. Je kunt je abonneren op events en zodra er een update plaatsvindt, versturen wij statusgegevens naar de URL die je opgeeft in MyTranssmart in het menu Manage account > Streamed Statuses.

De eerste stap is om contact op te nemen met onze supportafdeling om dit voor jou te laten activeren. We activeren het eerst op onze Accept-omgeving zodat je de integratie kunt configureren en testen. Wanneer dit succesvol is, activeren we het op Production.

Setup
Zorg er eerst voor dat je een geauthenticeerd endpoint hebt dat statusupdates kan ontvangen.
Vervolgens schakel je de functionaliteit in en voltooi je de configuratie op de setup-pagina.

• URL = jouw endpoint
• Authentication = kies tussen None, Header of Basic, afhankelijk van je eigen configuratiekeuze.
• Status push method = kies tussen Package level (standaard) of Shipment level. Zie de uitleg hieronder

Belangrijke opmerking: (lees ook de update van december 2024 hieronder)
Zorg er in je veldkoppeling voor dat je de statuswaarde leest uit het veld genericStatusCode in de shipmentLines en niet uit de shipmentStatus in de shipment header. De reden hiervoor is dat we voor sommige vervoerders de statusupdate niet ontvangen op shipment-headerniveau en dat we met een algoritme de status op shipment-headerniveau wijzigen nadat we de status per shipment line hebben gecontroleerd.

Voorbeeld:
Een zending heeft 3 regels:
Regel 1: pakket met status DONE
Regel 2: pakket met status TRNS
Regel 3: pakket met status TRNS
De status van de shipment header is TRNS

We ontvangen de statusupdate van pakketregel 2, die wijzigt naar DONE. Omdat er in regel 3 nog een pakket met status TRNS is, wijzigt het algoritme de status van de zendingheader niet, waardoor deze TRNS blijft.

We ontvangen de statusupdate van pakketregel 3, die wijzigt naar DONE. Omdat er geen pakketten met status TRNS meer zijn, wijzigt het algoritme de status van de zendingheader naar DONE. Maar op het moment dat we de statusupdate ontvingen, hadden we het statusbericht al naar jouw endpoint gestuurd. Op dat moment stond het veld shipmentStatus in de header nog op TRNS, terwijl de genericStatusCode in de shipmentLine al de status DONE had. Als je naar de zendingheaderstatus zou koppelen, blijft de zending in jouw systeem op TRNS staan in plaats van te wijzigen naar DONE. Daarom is het belangrijk om te koppelen aan de statuswaarde van het veld genericStatusCode in de shipmentLines.

Update: in december 2024 hebben we een instelling toegevoegd waarmee je kunt bepalen of het bericht dat we pushen moet worden getriggerd door de pakketregels of door de shipment header. 
De standaardinstelling is nog steeds per pakketregel. Als je dit wilt wijzigen naar shipment header, pas dan de instelling aan. Je moet dit doen als je niet in staat bent om te koppelen aan het veld genericStatusCode in de shipmentLines.

De nieuwe instelling is beschikbaar op de configuratiepagina in Manage account > Streamed Statuses



Message format
De payload die wordt verzonden in de statusmelding is dezelfde als de response op status retrieval requests, hoofdstuk 5.1 van onze DevDocs: https://devdocs.transsmart.com/#_5_2_status_stream 

isIncremental
De parameter isIncremental die wordt gebruikt in de Status Retrieval API endpoints wordt niet beïnvloed door de berichten die door ons systeem worden gepusht. Als je nog steeds statusrequests naar je eigen systeem wilt pullen, of misschien naar een tweede systeem, dan is dat nog steeds mogelijk.

Sub accounts 
Als je een configuratie hebt met één hoofdaccount en één of meer sub accounts, dan hangt het van de endpointconfiguratie af hoe je dit moet instellen. Als je één endpoint hebt waar je alle statusberichten van alle accounts wilt ontvangen, is het voldoende om dit alleen op het hoofdaccount te configureren. De instelling wordt automatisch overgenomen door alle sub accounts. 

Als je een ander endpoint per sub account hebt, kun je het per sub account configureren.