Shipment Notification Namespace

Used to receive real-time updates and notifications related to shipment events, such as creation, updates, and deletions.

Example Connection with Namespace

const shipmentNotificationSocket = io('https://ws.one-record.fr/shipment-notification', {
  auth: {
    access_token: '<access_token_here>',
  },
});

Available Events in Namespace

After establishing a connection to the shipment-notification namespace, the client can subscribe to specific events to receive real-time data related to shipment creations, updates, and deletions. Below is a list of all available events that clients can listen to in this namespace

Message

This event provides general notifications related to shipments, including details about shipment changes. It is a catch-all event for receiving shipment-related updates

shipmentNotificationSocket.on('message', (data) => {
  // Handle the data received from the message event
  console.log('Shipment Notification Received:', data);
});

For detailed information about the payload structure and content for each event, you can refer to the shipment payload available at here

Shipment payload

This documentation provides comprehensive insights into the data format, fields, and possible values for each type of event, helping you to effectively process and utilize the shipment notifications received through the WebSocket connection.