json icon

Order Ready For Shipping

v1.0.0events

Published when a packed order is ready to be handed to a carrier for shipping.

1{
2  "$schema": "http://json-schema.org/draft-07/schema#",
3  "title": "OrderReadyForShipping",
4  "description": "Published when a packed order is ready to be handed to a carrier",
5  "type": "object",
6  "properties": {
7    "orderId": { "type": "string", "format": "uuid" },
8    "customerId": { "type": "string", "format": "uuid" },
9    "parcelCount": { "type": "integer", "minimum": 1 },
10    "shippingAddress": {
11      "type": "object",
12      "properties": {
13        "line1": { "type": "string" },
14        "city": { "type": "string" },
15        "postcode": { "type": "string" },
16        "country": { "type": "string", "pattern": "^[A-Z]{2}$" }
17      },
18      "required": ["line1", "city", "postcode", "country"]
19    },
20    "readyAt": { "type": "string", "format": "date-time" }
21  },
22  "required": ["orderId", "shippingAddress", "readyAt"]
23}
24

Details

Format
JSON Schema
Resource
events
Filename
schema.json

Versions