json icon

Shipment Failed

v1.0.0events

Published by the carrier when a shipment could not be delivered.

1{
2  "$schema": "http://json-schema.org/draft-07/schema#",
3  "title": "ShipmentFailed",
4  "description": "Published when a shipment could not be delivered",
5  "type": "object",
6  "properties": {
7    "shipmentId": { "type": "string", "format": "uuid" },
8    "orderId": { "type": "string", "format": "uuid" },
9    "reason": {
10      "type": "string",
11      "enum": ["FAILED_DELIVERY", "LOST", "DAMAGED", "RETURNED_TO_SENDER"]
12    },
13    "failedAt": { "type": "string", "format": "date-time" }
14  },
15  "required": ["shipmentId", "orderId", "reason", "failedAt"]
16}
17

Details

Format
JSON Schema
Resource
events
Filename
schema.json

Versions