Skip to content

Schema Changes - 2026-06-09

This document contains the changes to the schema files compared to the main branch.

Changes

diff --git a/schema/Api/OrderBroker/GetOrderResponse.json b/schema/Api/OrderBroker/GetOrderResponse.json
index 665da2b..436359d 100644
--- a/schema/Api/OrderBroker/GetOrderResponse.json
+++ b/schema/Api/OrderBroker/GetOrderResponse.json
@@ -459,7 +459,6 @@
           "type": ["string", "null"],
           "maxLength": 20
         },
-        "referenceId2": { "type": ["string", "null"], "maxLength": 255 },
         "rushOrder": {
           "description": "True/false indicator if Order is expedited",
           "type": ["boolean", "null"]
diff --git a/schema/Api/OrderBroker/InternalGetOrderResponse.json b/schema/Api/OrderBroker/InternalGetOrderResponse.json
index 48dc8cd..d5fa365 100644
--- a/schema/Api/OrderBroker/InternalGetOrderResponse.json
+++ b/schema/Api/OrderBroker/InternalGetOrderResponse.json
@@ -459,7 +459,6 @@
           "type": ["string", "null"],
           "maxLength": 20
         },
-        "referenceId2": { "type": ["string", "null"], "maxLength": 255 },
         "rushOrder": {
           "description": "True/false indicator if Order is expedited",
           "type": ["boolean", "null"]
diff --git a/schema/Api/OrderBroker/InternalNewOrderRequest.json b/schema/Api/OrderBroker/InternalNewOrderRequest.json
index e7d608a..2be88aa 100644
--- a/schema/Api/OrderBroker/InternalNewOrderRequest.json
+++ b/schema/Api/OrderBroker/InternalNewOrderRequest.json
@@ -387,7 +387,12 @@
       "type": ["string", "null"],
       "maxLength": 20
     },
-    "referenceId2": { "type": ["string", "null"], "maxLength": 255 },
+    "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/NewOrderRequest.json b/schema/Api/OrderBroker/NewOrderRequest.json
index 2a1b800..5fb4d71 100644
--- a/schema/Api/OrderBroker/NewOrderRequest.json
+++ b/schema/Api/OrderBroker/NewOrderRequest.json
@@ -404,7 +404,12 @@
       "type": ["string", "null"],
       "maxLength": 20
     },
-    "referenceId2": { "type": ["string", "null"], "maxLength": 255 },
+    "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/UpdateFulfillmentOrderRequest.json b/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json
index daad074..029a5bd 100644
--- a/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json
+++ b/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json
@@ -104,7 +104,6 @@
         "required": ["productLineId", "fulfillmentSystemProductId"]
       }
     },
-    "referenceId2": { "type": ["string", "null"] },
     "rushOrder": { "type": ["boolean", "null"] },
     "shipTos": {
       "type": ["array", "null"],
diff --git a/schema/Api/OrderBroker/UpdateOrderRequest.json b/schema/Api/OrderBroker/UpdateOrderRequest.json
index 1df489b..b809c28 100644
--- a/schema/Api/OrderBroker/UpdateOrderRequest.json
+++ b/schema/Api/OrderBroker/UpdateOrderRequest.json
@@ -239,7 +239,11 @@
       "type": ["string", "null"],
       "maxLength": 20
     },
-    "referenceId2": { "description": "Reference ID2", "type": ["string", "null"] },
+    "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/FulfillmentOrder/FulfillmentOrder.json b/schema/Event/FulfillmentOrder/FulfillmentOrder.json
index 283195f..15a7eba 100644
--- a/schema/Event/FulfillmentOrder/FulfillmentOrder.json
+++ b/schema/Event/FulfillmentOrder/FulfillmentOrder.json
@@ -130,10 +130,6 @@
         }
       }
     },
-    "ReferenceId2": {
-      "description": "Reference ID2 for the fulfillment order",
-      "type": ["string", "null"]
-    },
     "RushOrder": {
       "description": "Indicator if the order is a rush order",
       "type": ["boolean", "null"]
diff --git a/schema/Event/Order/Order.json b/schema/Event/Order/Order.json
index 0398a33..101fa82 100644
--- a/schema/Event/Order/Order.json
+++ b/schema/Event/Order/Order.json
@@ -316,7 +316,6 @@
       "type": ["array", "null"],
       "items": {"type": "string"}
     },
-    "ReferenceId2": { "description": "Reference ID2", "type": ["string", "null"] },
     "RushOrder": { "description": "Rush order flag", "type": ["boolean", "null"] },
     "ShipTos": {
       "description": "Ship to addresses",
diff --git a/schema/Event/OrderView/OrderViewEvent.json b/schema/Event/OrderView/OrderViewEvent.json
index bbdd90c..d4eef9a 100644
--- a/schema/Event/OrderView/OrderViewEvent.json
+++ b/schema/Event/OrderView/OrderViewEvent.json
@@ -291,7 +291,6 @@
       "type": ["array", "null"],
       "items": {"type": "string"}
     },
-    "ReferenceId2": { "description": "Reference ID2", "type": ["string", "null"] },
     "RushOrder": { "description": "Rush order flag", "type": ["boolean", "null"] },
     "ShipTos": {
       "description": "Ship to addresses",