logoEventCatalog

ShipmentDispatched
v0.0.1

Event represents when a shipment has been dispatched.
When firing this event make sure you set the `correlation-id` in the headers. Our schemas have standard metadata make sure you read and follow it.

Details

This event is triggered when a shipment has been dispatched from the warehouse.

Consumer/Producer Diagram

Open in Visualiser →
ShipmentDispatched Schema (json)
{
  "$id": "https://example.com/ShipmentDispatched.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ShipmentDispatched",
  "type": "object",
  "properties": {
    "metadata": {
      "type": "object",
      "properties": {
        "correlationId": {
          "type": "string",
          "description": "The ID of the user"
        },
        "domain": {
          "type": "string",
          "description": "The domain of the event"
        },
        "service": {
          "type": "string",
          "description": "The name of the service that triggered the event"
        }
      },
      "required": ["correlationId", "domain", "service"]
    },
    "data": {
      "type": "object",
      "properties": {
        "userId": {
          "type": "string",
          "description": "The ID of the user"
        },
        "shipmentId": {
          "type": "string",
          "description": "The ID of the shipment"
        },
        "orderId": {
          "type": "string",
          "description": "The order assigned to the shipment"
        }
      }
    }
  }
}
Edit this pageLast updated on 2024/1/16