Create Shipment
v1.0.0commandsCommand to create a shipment with a carrier for a packed order.
1{
2 "$schema": "http://json-schema.org/draft-07/schema#",
3 "title": "CreateShipment",
4 "description": "Command to create a shipment with a carrier for a packed order",
5 "type": "object",
6 "properties": {
7 "orderId": { "type": "string", "format": "uuid" },
8 "carrier": { "type": "string", "description": "The carrier to ship with" },
9 "service": {
10 "type": "string",
11 "enum": ["STANDARD", "EXPRESS", "NEXT_DAY"]
12 },
13 "parcelCount": { "type": "integer", "minimum": 1 },
14 "destination": {
15 "type": "object",
16 "properties": {
17 "line1": { "type": "string" },
18 "city": { "type": "string" },
19 "postcode": { "type": "string" },
20 "country": { "type": "string", "pattern": "^[A-Z]{2}$" }
21 },
22 "required": ["line1", "city", "postcode", "country"]
23 }
24 },
25 "required": ["orderId", "destination"]
26}
27Details
- Format
- JSON Schema
- Resource
- commands
- Filename
- schema.json