Schema Changes - 2026-02-26
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 7731e80..0bc150a 100644
--- a/schema/Api/CustomerBroker/CreateCustomerRequest.json
+++ b/schema/Api/CustomerBroker/CreateCustomerRequest.json
@@ -196,9 +196,20 @@
"fulfillmentSystemShipMethodId": {
"description": "Required. Fulfillment system ship method identifier.",
"type": "string"
+ },
+ "fulfillmentSystemShipMethodDescription": {
+ "description": "Required. Fulfillment system ship method description.",
+ "type": "string"
+ },
+ "scac": {
+ "description": "Optional. Standard Carrier Alpha Code (SCAC).",
+ "type": ["string", "null"]
}
},
- "required": ["fulfillmentSystemId", "fulfillmentSystemShipMethodId"]
+ "required": [
+ "fulfillmentSystemId", "fulfillmentSystemShipMethodId",
+ "fulfillmentSystemShipMethodDescription"
+ ]
}
},
"thirdPartyAccountNumber": {
diff --git a/schema/Api/CustomerBroker/GetCustomerResponse.json b/schema/Api/CustomerBroker/GetCustomerResponse.json
index d8e2e2f..3f98cef 100644
--- a/schema/Api/CustomerBroker/GetCustomerResponse.json
+++ b/schema/Api/CustomerBroker/GetCustomerResponse.json
@@ -152,7 +152,12 @@
"description": "Fulfillment system ship method identifier.",
"type": ["string", "null"]
},
- "fulfillmentSystemName": { "description": "Fulfillment system name.", "type": ["string", "null"] }
+ "fulfillmentSystemName": { "description": "Fulfillment system name.", "type": ["string", "null"] },
+ "fulfillmentSystemShipMethodDescription": {"description": "Fulfillment system ship method description.", "type": "string"},
+ "scac": {
+ "description": "Standard Carrier Alpha Code (SCAC).",
+ "type": ["string", "null"]
+ }
}
}
},
diff --git a/schema/Api/CustomerBroker/UpdateCustomerRequest.json b/schema/Api/CustomerBroker/UpdateCustomerRequest.json
index aa2ac66..a4d5fcb 100644
--- a/schema/Api/CustomerBroker/UpdateCustomerRequest.json
+++ b/schema/Api/CustomerBroker/UpdateCustomerRequest.json
@@ -191,9 +191,20 @@
"fulfillmentSystemShipMethodId": {
"description": "Required. Fulfillment system ship method identifier.",
"type": "string"
+ },
+ "fulfillmentSystemShipMethodDescription": {
+ "description": "Required. Fulfillment system ship method description.",
+ "type": "string"
+ },
+ "scac": {
+ "description": "Optional. Standard Carrier Alpha Code (SCAC).",
+ "type": ["string", "null"]
}
},
- "required": ["fulfillmentSystemId", "fulfillmentSystemShipMethodId"]
+ "required": [
+ "fulfillmentSystemId", "fulfillmentSystemShipMethodId",
+ "fulfillmentSystemShipMethodDescription"
+ ]
}
},
"thirdPartyAccountNumber": {
diff --git a/schema/Api/OfferBroker/GetOfferResponse.json b/schema/Api/OfferBroker/GetOfferResponse.json
index cde8bdb..d191b0a 100644
--- a/schema/Api/OfferBroker/GetOfferResponse.json
+++ b/schema/Api/OfferBroker/GetOfferResponse.json
@@ -9,6 +9,7 @@
"additionalProperties": false,
"properties": {
"id": {"type": "string"},
+ "lastUpdateCorrelationId": { "type": ["string", "null"] },
"omsOfferId": {
"description": "Required. Unique offer identifier. Must not be empty.",
"type": "string",
@@ -176,6 +177,7 @@
"schemaVersion": {"type": "string"},
"secureEmailBody": { "type": ["string", "null"] },
"secureEmailSubject": { "type": ["string", "null"] },
+ "status": { "type": ["string", "null"] },
"surcharge": {"type": "number", "format": "double"},
"thumbnailUrl": { "type": ["string", "null"] },
"unitOfMeasure": { "type": ["string", "null"] },
diff --git a/schema/Api/OfferBroker/GetOffersResponse.json b/schema/Api/OfferBroker/GetOffersResponse.json
index fcb877f..eb5eca6 100644
--- a/schema/Api/OfferBroker/GetOffersResponse.json
+++ b/schema/Api/OfferBroker/GetOffersResponse.json
@@ -11,6 +11,7 @@
"additionalProperties": false,
"properties": {
"id": {"type": "string"},
+ "lastUpdateCorrelationId": { "type": ["string", "null"] },
"omsOfferId": {
"description": "Required. Unique offer identifier. Must not be empty.",
"type": "string",
@@ -179,6 +180,7 @@
"schemaVersion": {"type": "string"},
"secureEmailBody": { "type": ["string", "null"] },
"secureEmailSubject": { "type": ["string", "null"] },
+ "status": { "type": ["string", "null"] },
"surcharge": {"type": "number", "format": "double"},
"thumbnailUrl": { "type": ["string", "null"] },
"unitOfMeasure": { "type": ["string", "null"] },
diff --git a/schema/Api/OfferBroker/InternalGetOffersResponse.json b/schema/Api/OfferBroker/InternalGetOffersResponse.json
index 4908faa..60f6f9e 100644
--- a/schema/Api/OfferBroker/InternalGetOffersResponse.json
+++ b/schema/Api/OfferBroker/InternalGetOffersResponse.json
@@ -10,6 +10,7 @@
"type": "object",
"additionalProperties": false,
"properties": {
+ "customerId": { "type": ["string", "null"] },
"id": {"type": "string"},
"omsOfferId": {
"description": "Required. Unique offer identifier. Must not be empty.",
diff --git a/schema/Api/OrderBroker/GetOrderResponse.json b/schema/Api/OrderBroker/GetOrderResponse.json
index 8ddd37d..b475e90 100644
--- a/schema/Api/OrderBroker/GetOrderResponse.json
+++ b/schema/Api/OrderBroker/GetOrderResponse.json
@@ -459,6 +459,7 @@
"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 769cec8..792b482 100644
--- a/schema/Api/OrderBroker/InternalGetOrderResponse.json
+++ b/schema/Api/OrderBroker/InternalGetOrderResponse.json
@@ -459,6 +459,7 @@
"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 419ca63..e7d608a 100644
--- a/schema/Api/OrderBroker/InternalNewOrderRequest.json
+++ b/schema/Api/OrderBroker/InternalNewOrderRequest.json
@@ -387,6 +387,7 @@
"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/InternalUpdateOrderRequest.json b/schema/Api/OrderBroker/InternalUpdateOrderRequest.json
index 4c7df5b..abd24d3 100644
--- a/schema/Api/OrderBroker/InternalUpdateOrderRequest.json
+++ b/schema/Api/OrderBroker/InternalUpdateOrderRequest.json
@@ -242,6 +242,7 @@
"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 6a63db3..2a1b800 100644
--- a/schema/Api/OrderBroker/NewOrderRequest.json
+++ b/schema/Api/OrderBroker/NewOrderRequest.json
@@ -404,6 +404,7 @@
"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/UpdateFulfillmentOrderRequest.json b/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json
index 6642d99..0035289 100644
--- a/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json
+++ b/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json
@@ -103,6 +103,7 @@
"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 528de31..1df489b 100644
--- a/schema/Api/OrderBroker/UpdateOrderRequest.json
+++ b/schema/Api/OrderBroker/UpdateOrderRequest.json
@@ -239,6 +239,7 @@
"type": ["string", "null"],
"maxLength": 20
},
+ "referenceId2": { "description": "Reference ID2", "type": ["string", "null"] },
"rushOrder": {"description": "Rush order flag", "type": "boolean"},
"shipTos": {
"description": "Ship to addresses",
diff --git a/schema/Api/ProductBroker/GetAllProductsResponse.json b/schema/Api/ProductBroker/GetAllProductsResponse.json
index 04da531..cc4c337 100644
--- a/schema/Api/ProductBroker/GetAllProductsResponse.json
+++ b/schema/Api/ProductBroker/GetAllProductsResponse.json
@@ -33,7 +33,12 @@
"productOwner": { "description": "Owner of component product", "type": ["string", "null"] },
"productType": {"description": "Type of the product", "type": "string"},
"status": {"description": "Current status of the product", "type": "string"},
- "unitOfMeasure": { "description": "Unit of measure for the product", "type": ["string", "null"] }
+ "unitOfMeasure": { "description": "Unit of measure for the product", "type": ["string", "null"] },
+ "weight": {
+ "description": "Maximum weight of the product in pounds",
+ "type": ["number", "null"],
+ "format": "decimal"
+ }
},
"required": ["productId", "productNumber", "productType", "status", "lastUpdateDateTimeUtc"]
}
diff --git a/schema/Api/ProductBroker/GetProductsResponse.json b/schema/Api/ProductBroker/GetProductsResponse.json
index f512f87..2364c7b 100644
--- a/schema/Api/ProductBroker/GetProductsResponse.json
+++ b/schema/Api/ProductBroker/GetProductsResponse.json
@@ -33,7 +33,12 @@
"productOwner": { "description": "Owner of component product", "type": ["string", "null"] },
"productType": {"description": "Type of the product", "type": "string"},
"status": {"description": "Current status of the product", "type": "string"},
- "unitOfMeasure": { "description": "Unit of measure for the product", "type": ["string", "null"] }
+ "unitOfMeasure": { "description": "Unit of measure for the product", "type": ["string", "null"] },
+ "weight": {
+ "description": "Maximum weight of the product in pounds",
+ "type": ["number", "null"],
+ "format": "decimal"
+ }
},
"required": ["productId", "productNumber", "productType", "status", "lastUpdateDateTimeUtc"]
}
diff --git a/schema/Api/ShippingBroker/GetShippingratesRequest.json b/schema/Api/ShippingBroker/GetShippingratesRequest.json
index 5df062a..45ba2a3 100644
--- a/schema/Api/ShippingBroker/GetShippingratesRequest.json
+++ b/schema/Api/ShippingBroker/GetShippingratesRequest.json
@@ -22,8 +22,8 @@
"additionalProperties": false,
"properties": {
"Address1": {"description": "Address line 1", "type": "string"},
- "Address2": {"description": "Address line 2", "type": "string"},
- "Address3": {"description": "Address line 3", "type": "string"},
+ "Address2": { "description": "Address line 2", "type": ["string", "null"] },
+ "Address3": { "description": "Address line 3", "type": ["string", "null"] },
"City": {"description": "City", "type": "string"},
"Company": {"description": "Company name", "type": "string"},
"Country": {
@@ -32,10 +32,10 @@
"pattern": "^[A-Z]{3}$"
},
"EmailAddress": {"description": "Email address", "type": "string", "format": "email"},
- "FaxNumber": {"description": "Fax number", "type": "string"},
+ "FaxNumber": { "description": "Fax number", "type": ["string", "null"] },
"IsResidential": {"description": "Whether the address is residential", "type": "boolean"},
"Name": {"description": "Recipient name", "type": "string"},
- "PhoneNumber": {"description": "Phone number", "type": "string"},
+ "PhoneNumber": { "description": "Phone number", "type": ["string", "null"] },
"PostalCode": {"description": "Postal code", "type": "string"},
"StateProvince": {"description": "State or province", "type": "string"}
},
diff --git a/schema/Event/Customer/Customer.json b/schema/Event/Customer/Customer.json
index e42c4ee..71bfbca 100644
--- a/schema/Event/Customer/Customer.json
+++ b/schema/Event/Customer/Customer.json
@@ -134,10 +134,18 @@
"items": {
"type": "object",
"properties": {
- "FulfillmentSystemId" : { "description": "Fulfillment system ID" , "type": "integer" },
- "FulfillmentSystemShipMethodId": { "description": "Fulfillment system ship method ID", "type": "string" }
+ "FulfillmentSystemId": {"description": "Fulfillment system ID", "type": "integer"},
+ "FulfillmentSystemShipMethodId": {"description": "Fulfillment system ship method ID", "type": "string"},
+ "FulfillmentSystemShipMethodDescription": {"description": "Fulfillment system ship method description", "type": "string"},
+ "SCAC": {
+ "description": "Standard Carrier Alpha Code (SCAC)",
+ "type": ["string", "null"]
+ }
},
- "required": ["FulfillmentSystemId", "FulfillmentSystemShipMethodId"]
+ "required": [
+ "FulfillmentSystemId", "FulfillmentSystemShipMethodId",
+ "FulfillmentSystemShipMethodDescription"
+ ]
}
},
"TrackingUrl": { "description": "Tracking URL", "type": ["string", "null"] }
diff --git a/schema/Event/FulfillmentOrder/FulfillmentOrder.json b/schema/Event/FulfillmentOrder/FulfillmentOrder.json
index 0885d83..5edf4ed 100644
--- a/schema/Event/FulfillmentOrder/FulfillmentOrder.json
+++ b/schema/Event/FulfillmentOrder/FulfillmentOrder.json
@@ -126,6 +126,10 @@
}
}
},
+ "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 42aadee..afed2cd 100644
--- a/schema/Event/Order/Order.json
+++ b/schema/Event/Order/Order.json
@@ -316,6 +316,7 @@
"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 4f84332..a07baf8 100644
--- a/schema/Event/OrderView/OrderViewEvent.json
+++ b/schema/Event/OrderView/OrderViewEvent.json
@@ -281,6 +281,7 @@
"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",