Schema Changes - 2026-08-14
This document contains the changes to the schema files compared to the main branch.
Changes
diff --git a/schema/Api/CustomerBroker/CreateCustomerRequest.json b/schema/Api/CustomerBroker/CreateCustomerRequest.json
index 0bc150a..e4bb333 100644
--- a/schema/Api/CustomerBroker/CreateCustomerRequest.json
+++ b/schema/Api/CustomerBroker/CreateCustomerRequest.json
@@ -10,6 +10,10 @@
"type": "string",
"minLength": 1
},
+ "prepaidCcXmlSenderId": {
+ "description": "Optional. Prepaid credit-card XML sender identifier.",
+ "type": ["string", "null"]
+ },
"xmlSenderId": {
"description": "Optional. XML sender identifier.",
"type": ["string", "null"]
@@ -174,8 +178,8 @@
"additionalProperties": false,
"properties": {
"ratesProviderShipMethodId": {
- "description": "Required. Rates provider ship method identifier.",
- "type": "string"
+ "description": "Optional. Rates provider ship method identifier.",
+ "type": ["string", "null"]
},
"sourceSystemShipMethodId": {
"description": "Required. Source system ship method identifier.",
@@ -218,10 +222,7 @@
},
"trackingUrl": { "description": "Optional. Tracking URL.", "type": ["string", "null"] }
},
- "required": [
- "sourceSystemShipMethodId", "ratesProviderShipMethodId",
- "fulfillmentSystemShipMethods"
- ]
+ "required": ["sourceSystemShipMethodId", "fulfillmentSystemShipMethods"]
}
},
"sourceSystems": {
diff --git a/schema/Api/CustomerBroker/UpdateCustomerRequest.json b/schema/Api/CustomerBroker/UpdateCustomerRequest.json
index a4d5fcb..69c7d9e 100644
--- a/schema/Api/CustomerBroker/UpdateCustomerRequest.json
+++ b/schema/Api/CustomerBroker/UpdateCustomerRequest.json
@@ -10,6 +10,10 @@
"type": "string",
"minLength": 1
},
+ "prepaidCcXmlSenderId": {
+ "description": "Optional. Prepaid credit-card XML sender identifier.",
+ "type": ["string", "null"]
+ },
"xmlSenderId": {
"description": "Optional. XML sender identifier.",
"type": ["string", "null"]
@@ -169,8 +173,8 @@
"additionalProperties": false,
"properties": {
"ratesProviderShipMethodId": {
- "description": "Required. Rates provider ship method identifier.",
- "type": "string"
+ "description": "Optional. Rates provider ship method identifier.",
+ "type": ["string", "null"]
},
"sourceSystemShipMethodId": {
"description": "Required. Source system ship method identifier.",
@@ -213,10 +217,7 @@
},
"trackingUrl": { "description": "Optional. Tracking URL.", "type": ["string", "null"] }
},
- "required": [
- "sourceSystemShipMethodId", "ratesProviderShipMethodId",
- "fulfillmentSystemShipMethods"
- ]
+ "required": ["sourceSystemShipMethodId", "fulfillmentSystemShipMethods"]
}
},
"sourceSystems": {
diff --git a/schema/Api/OrderBroker/InternalNewOrderRequest.json b/schema/Api/OrderBroker/InternalNewOrderRequest.json
index 2be88aa..419ca63 100644
--- a/schema/Api/OrderBroker/InternalNewOrderRequest.json
+++ b/schema/Api/OrderBroker/InternalNewOrderRequest.json
@@ -387,12 +387,6 @@
"type": ["string", "null"],
"maxLength": 20
},
- "referenceId2": {
- "description": "Deprecated. This field is ignored and will not be persisted.",
- "type": ["string", "null"],
- "deprecated": true,
- "maxLength": 255
- },
"rushOrder": {
"description": "True/false indicator if Order is expedited",
"type": ["boolean", "null"]
diff --git a/schema/Api/OrderBroker/InternalUpdateOrderRequest.json b/schema/Api/OrderBroker/InternalUpdateOrderRequest.json
index abd24d3..4c7df5b 100644
--- a/schema/Api/OrderBroker/InternalUpdateOrderRequest.json
+++ b/schema/Api/OrderBroker/InternalUpdateOrderRequest.json
@@ -242,7 +242,6 @@
"type": ["string", "null"],
"maxLength": 1000
},
- "referenceId2": { "description": "Reference ID2", "type": ["string", "null"] },
"rushOrder": {"description": "Rush order flag", "type": "boolean"},
"shipTos": {
"description": "Ship to addresses",
diff --git a/schema/Api/OrderBroker/NewOrderRequest.json b/schema/Api/OrderBroker/NewOrderRequest.json
index 5fb4d71..6a63db3 100644
--- a/schema/Api/OrderBroker/NewOrderRequest.json
+++ b/schema/Api/OrderBroker/NewOrderRequest.json
@@ -404,12 +404,6 @@
"type": ["string", "null"],
"maxLength": 20
},
- "referenceId2": {
- "description": "Deprecated. This field is ignored and will not be persisted.",
- "type": ["string", "null"],
- "deprecated": true,
- "maxLength": 255
- },
"rushOrder": {
"description": "True/false indicator if Order is expedited",
"type": ["boolean", "null"]
diff --git a/schema/Api/OrderBroker/UpdateOrderRequest.json b/schema/Api/OrderBroker/UpdateOrderRequest.json
index b809c28..528de31 100644
--- a/schema/Api/OrderBroker/UpdateOrderRequest.json
+++ b/schema/Api/OrderBroker/UpdateOrderRequest.json
@@ -239,11 +239,6 @@
"type": ["string", "null"],
"maxLength": 20
},
- "referenceId2": {
- "description": "Reference ID2",
- "type": ["string", "null"],
- "deprecated": true
- },
"rushOrder": {"description": "Rush order flag", "type": "boolean"},
"shipTos": {
"description": "Ship to addresses",
diff --git a/schema/Event/Customer/Customer.json b/schema/Event/Customer/Customer.json
index 71bfbca..9961c38 100644
--- a/schema/Event/Customer/Customer.json
+++ b/schema/Event/Customer/Customer.json
@@ -6,6 +6,10 @@
"properties": {
"DefaultWarehouseId": { "description": "Default warehouse ID", "type": ["string", "null"] },
"Id": {"description": "Customer ID", "type": "string"},
+ "PrepaidCcXmlSenderId": {
+ "description": "Customer-level XML sender ID used for credit-card prepaid orders; when null, the order must not be a CC-prepaid order.",
+ "type": ["string", "null"]
+ },
"XmlSenderId": { "description": "XML sender ID", "type": ["string", "null"] },
"BillToCodeRequiredOnOrder": {
"description": "Whether a bill-to code is required when placing orders for this customer",
@@ -126,7 +130,7 @@
"items": {
"type": "object",
"properties": {
- "RatesProviderShipMethodId": {"description": "Rates provider ship method ID", "type": "string"},
+ "RatesProviderShipMethodId": { "description": "Rates provider ship method ID", "type": ["string", "null"] },
"SourceSystemShipMethodId": {"description": "Source system ship method ID", "type": "string"},
"FulfillmentSystemShipMethods": {
"description": "Fulfillment system ship methods",
@@ -150,10 +154,7 @@
},
"TrackingUrl": { "description": "Tracking URL", "type": ["string", "null"] }
},
- "required": [
- "SourceSystemShipMethodId", "RatesProviderShipMethodId",
- "FulfillmentSystemShipMethods"
- ]
+ "required": ["SourceSystemShipMethodId", "FulfillmentSystemShipMethods"]
}
},
"SourceSystems": {
diff --git a/schema/Event/Customer/CustomerEvent.json b/schema/Event/Customer/CustomerEvent.json
index 3e08530..782253e 100644
--- a/schema/Event/Customer/CustomerEvent.json
+++ b/schema/Event/Customer/CustomerEvent.json
@@ -43,7 +43,7 @@
"EventName": "Customer Created",
"EventNameValuePairs": null,
"EventPublisherApp": "Customer Event Publisher",
- "EventSchemaVersion": "1.0",
+ "EventSchemaVersion": "1.4",
"EventSource": "CustomerBroker"
}
]
diff --git a/schema/Event/FulfillmentOrder/FulfillmentOrder.json b/schema/Event/FulfillmentOrder/FulfillmentOrder.json
index 15a7eba..2525ec4 100644
--- a/schema/Event/FulfillmentOrder/FulfillmentOrder.json
+++ b/schema/Event/FulfillmentOrder/FulfillmentOrder.json
@@ -115,18 +115,31 @@
"items": {
"type": "object",
"properties": {
- "FulfillmentSystemId" : { "description": "Fulfillment system ID" , "type": ["string", "null"] },
- "FulfillmentSystemProductId": { "description": "Fulfillment system product ID" , "type": ["string", "null"] },
- "ProductId" : { "description": "Product ID" , "type": ["string", "null"] },
- "ProductLineId" : { "description": "Product line ID" , "type": ["string", "null"] },
- "AssociatedFileName" : { "description": "Associated file name" , "type": ["string", "null"] },
- "Comment" : { "description": "Comment for the product" , "type": ["string", "null"] },
- "IsDeleted" : { "description": "Whether the product is deleted", "type": ["boolean", "null"] },
- "PageCount" : { "description": "Page count for the product" , "type": ["integer", "null"] },
- "Price" : { "description": "Price of the product" , "type": ["number", "null"] },
- "QuantityOrdered" : { "description": "Quantity ordered" , "type": ["integer", "null"] },
- "ShipToKey" : { "description": "Ship to key for the product" , "type": ["string", "null"] },
- "Status" : { "description": "Status of the product" , "type": ["string", "null"] }
+ "FulfillmentSystemId": { "description": "Fulfillment system ID", "type": ["string", "null"] },
+ "FulfillmentSystemProductId": { "description": "Fulfillment system product ID", "type": ["string", "null"] },
+ "ProductId": { "description": "Product ID", "type": ["string", "null"] },
+ "ProductLineId": { "description": "Product line ID", "type": ["string", "null"] },
+ "AssociatedFileName": { "description": "Associated file name", "type": ["string", "null"] },
+ "Comment": { "description": "Comment for the product", "type": ["string", "null"] },
+ "IsDeleted": { "description": "Whether the product is deleted", "type": ["boolean", "null"] },
+ "PageCount": { "description": "Page count for the product", "type": ["integer", "null"] },
+ "Price": { "description": "Price of the product", "type": ["number", "null"] },
+ "ProductionFiles": {
+ "description": "Production files distributed onto this product line",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "DestinationFilePath": { "type": ["string", "null"] },
+ "FileRole" : { "type": ["string", "null"] },
+ "ProductLineNumber" : { "type": ["string", "null"] },
+ "SourceFile" : { "type": ["string", "null"] }
+ }
+ }
+ },
+ "QuantityOrdered": { "description": "Quantity ordered", "type": ["integer", "null"] },
+ "ShipToKey": { "description": "Ship to key for the product", "type": ["string", "null"] },
+ "Status": { "description": "Status of the product", "type": ["string", "null"] }
}
}
},
diff --git a/schema/Event/Order/Order.json b/schema/Event/Order/Order.json
index 101fa82..5ea4866 100644
--- a/schema/Event/Order/Order.json
+++ b/schema/Event/Order/Order.json
@@ -158,6 +158,30 @@
"description": "Total offer price of individual line item",
"type": ["number", "null"]
},
+ "ProductionFiles": {
+ "description": "Successfully copied production files associated with the order line item",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "CopiedDateTimeUtc": {
+ "description": "UTC date and time when the file was copied",
+ "type": ["string", "null"]
+ },
+ "DestinationFilePath": {
+ "description": "Resolved destination path of the copied file",
+ "type": ["string", "null"]
+ },
+ "FileRole": { "description": "Role of the copied file", "type": ["string", "null"] },
+ "ProductLineNumber": {
+ "description": "Product line number associated with the copied file",
+ "type": ["string", "null"]
+ },
+ "SourceFile": { "description": "Source path of the copied file", "type": ["string", "null"] }
+ }
+ }
+ },
"Products": {
"description": "Order.LineItems level product details",
"type": ["array", "null"],
diff --git a/schema/Event/OrderView/OrderViewEvent.json b/schema/Event/OrderView/OrderViewEvent.json
index d4eef9a..0ad5ec8 100644
--- a/schema/Event/OrderView/OrderViewEvent.json
+++ b/schema/Event/OrderView/OrderViewEvent.json
@@ -161,6 +161,20 @@
"description": "Total offer price of individual line item",
"type": ["number", "null"]
},
+ "ProductionFiles": {
+ "description": "Production files copied for this line item",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "CopiedDateTimeUtc" : { "type": ["string", "null"] },
+ "DestinationFilePath": { "type": ["string", "null"] },
+ "FileRole" : { "type": ["string", "null"] },
+ "ProductLineNumber" : { "type": ["string", "null"] },
+ "SourceFile" : { "type": ["string", "null"] }
+ }
+ }
+ },
"Products": {
"description": "Order.LineItems level product details",
"type": ["array", "null"],