Schema Changes - 2026-05-20
This document contains the changes to the schema files compared to the main branch.
Changes
diff --git a/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json b/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json
index 4183fc2..daad074 100644
--- a/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json
+++ b/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json
@@ -51,6 +51,7 @@
"pattern": "^[0-9]+$"
},
"dueDate": { "type": ["string", "null"] },
+ "fulfillmentSystemOrderDescription": { "type": ["string", "null"] },
"orderIds": { "type": ["array", "null"], "items": {"type": "string"} },
"orderVariables": { "type": ["string", "null"] },
"packListNotes": {
@@ -215,10 +216,10 @@
},
"reference1": { "type": ["string", "null"] },
"reference2": { "type": ["string", "null"] },
- "trackingNumber": {"type": "string"},
+ "trackingNumber": { "type": ["string", "null"] },
"weight": { "type": ["number", "null"] }
},
- "required": ["packageNumber", "trackingNumber"]
+ "required": ["packageNumber"]
}
},
"packingSlipNumber": { "type": ["string", "null"] },
@@ -250,6 +251,17 @@
},
"required": ["shipmentId", "service", "shipDateUtc", "freight"]
}
+ },
+ "sourceSystemsToSourceSystemOrderIds": {
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "name" : { "type": ["string", "null"] },
+ "value": { "type": ["string", "null"] }
+ },
+ "required": ["name", "value"]
+ }
}
},
"required": ["fulfillmentOrderId"]
diff --git a/schema/Event/FulfillmentOrder/FulfillmentOrder.json b/schema/Event/FulfillmentOrder/FulfillmentOrder.json
index a01450e..283195f 100644
--- a/schema/Event/FulfillmentOrder/FulfillmentOrder.json
+++ b/schema/Event/FulfillmentOrder/FulfillmentOrder.json
@@ -73,6 +73,10 @@
"description": "Due date of the fulfillment order",
"type": ["string", "null"]
},
+ "FulfillmentSystemOrderDescription": {
+ "description": "Description of the fulfillment system order",
+ "type": ["string", "null"]
+ },
"OrderIds": {
"description": "Order IDs tied to the fulfillment order",
"type": ["array", "null"],
@@ -291,6 +295,18 @@
}
}
},
+ "SourceSystemsToSourceSystemOrderIds": {
+ "description": "Source system to source system order ID mappings",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "Name" : { "type": ["string", "null"] },
+ "Value": { "type": ["string", "null"] }
+ },
+ "required": ["Name", "Value"]
+ }
+ },
"Statuses": {
"description": "Statuses tied to the fulfillment order",
"type": ["array", "null"],
diff --git a/schema/Event/FulfillmentOrder/FulfillmentOrderEvent.json b/schema/Event/FulfillmentOrder/FulfillmentOrderEvent.json
index 466a807..0ea30c9 100644
--- a/schema/Event/FulfillmentOrder/FulfillmentOrderEvent.json
+++ b/schema/Event/FulfillmentOrder/FulfillmentOrderEvent.json
@@ -38,7 +38,7 @@
"Fulfillment Order Submission Failed",
"Fulfillment Order Update Validation Failed",
"Fulfillment Order Update Request Validated",
- "Update Failed to Submit to Fulfillment System"
+ "Update Failed to Submit to Fulfillment System", "Slingshot Submission Guard"
]
},
"EventNameValuePairs": {
diff --git a/schema/Event/Order/OrderEvent.json b/schema/Event/Order/OrderEvent.json
index 7870622..1dd141d 100644
--- a/schema/Event/Order/OrderEvent.json
+++ b/schema/Event/Order/OrderEvent.json
@@ -38,7 +38,8 @@
"Update Request Validated", "Update Request Validation Failed",
"Fulfillment Order Creation Failed",
"Update Failed Fulfillment System Validation",
- "Update Failed to Submit to Fulfillment System"
+ "Update Failed to Submit to Fulfillment System",
+ "Order Updated by Fulfillment System", "Order Partially Shipped"
]
},
"EventNameValuePairs": {
diff --git a/schema/Event/OrderView/OrderViewEvent.json b/schema/Event/OrderView/OrderViewEvent.json
index 5f9081d..bbdd90c 100644
--- a/schema/Event/OrderView/OrderViewEvent.json
+++ b/schema/Event/OrderView/OrderViewEvent.json
@@ -68,10 +68,20 @@
"DefaultOrderedByKey": { "description": "Default ordered by key", "type": ["string", "null"] },
"DefaultShipToKey": { "description": "Default ship to key", "type": ["string", "null"] },
"DueDate": { "description": "Due date", "type": ["string", "null"] },
+ "LastEventDateTimeUtc": {
+ "description": "UTC datetime of the last event processed for this order",
+ "type": ["string", "null"]
+ },
"LastEventName": {
"description": "Name of the last event processed for this order",
"type": ["string", "null"]
},
+ "LastEventNameValuePairs": {
+ "description": "Key/value pairs associated with the last event",
+ "type": ["object", "null"],
+ "additionalProperties": {"type": "string"}
+ },
+ "LastEventType": { "description": "Type of the last event", "type": ["string", "null"] },
"LineItems": {
"description": "Order line items",
"type": ["array", "null"],
@@ -452,7 +462,21 @@
"items": {"type": "string"}
},
"TotalOrderFee": { "description": "Total order fee", "type": ["number", "null"] },
- "TotalShippingCost": { "description": "Total shipping cost", "type": ["number", "null"] }
+ "TotalShippingCost": { "description": "Total shipping cost", "type": ["number", "null"] },
+ "TriggerEventDateTimeUtc": {
+ "description": "UTC datetime of the triggering event",
+ "type": ["string", "null"]
+ },
+ "TriggerEventName": {
+ "description": "Name of the event that triggered the current update",
+ "type": ["string", "null"]
+ },
+ "TriggerEventNameValuePairs": {
+ "description": "Key/value pairs associated with the triggering event",
+ "type": ["object", "null"],
+ "additionalProperties": {"type": "string"}
+ },
+ "TriggerEventType": { "description": "Type of the triggering event", "type": ["string", "null"] }
},
"required": ["OrderId", "LineItems", "BillTos", "ShipTos"]
}