Schema Changes - 2026-04-06
This document contains the changes to the schema files compared to the main branch.
Changes
diff --git a/schema/Api/OfferBroker/CreateOfferRequest.json b/schema/Api/OfferBroker/CreateOfferRequest.json
index 8728959..bfa84d1 100644
--- a/schema/Api/OfferBroker/CreateOfferRequest.json
+++ b/schema/Api/OfferBroker/CreateOfferRequest.json
@@ -124,9 +124,8 @@
}
}
},
- "price": {"type": "number", "format": "double"}
- },
- "required": ["price"]
+ "price": { "type": ["number", "null"], "format": "double" }
+ }
}
}
}
diff --git a/schema/Api/OfferBroker/DeleteOfferRequest.json b/schema/Api/OfferBroker/DeleteOfferRequest.json
index bbe08f2..44610c0 100644
--- a/schema/Api/OfferBroker/DeleteOfferRequest.json
+++ b/schema/Api/OfferBroker/DeleteOfferRequest.json
@@ -3,6 +3,6 @@
"$id": "DeleteOfferRequest.json",
"type": "object",
"additionalProperties": false,
- "properties": { "omsOfferId": {"type": "string"} },
- "required": ["omsOfferId"]
+ "properties": { "offerId": {"type": "string"} },
+ "required": ["offerId"]
}
diff --git a/schema/Api/OfferBroker/GetOfferResponse.json b/schema/Api/OfferBroker/GetOfferResponse.json
index d191b0a..7e826c7 100644
--- a/schema/Api/OfferBroker/GetOfferResponse.json
+++ b/schema/Api/OfferBroker/GetOfferResponse.json
@@ -134,7 +134,7 @@
}
}
},
- "price": {"type": "number", "format": "double"}
+ "price": { "type": ["number", "null"], "format": "double" }
}
}
}
diff --git a/schema/Api/OfferBroker/GetOffersResponse.json b/schema/Api/OfferBroker/GetOffersResponse.json
index eb5eca6..d156df3 100644
--- a/schema/Api/OfferBroker/GetOffersResponse.json
+++ b/schema/Api/OfferBroker/GetOffersResponse.json
@@ -136,7 +136,7 @@
}
}
},
- "price": {"type": "number", "format": "double"}
+ "price": { "type": ["number", "null"], "format": "double" }
}
}
}
diff --git a/schema/Api/OfferBroker/InternalGetOffersResponse.json b/schema/Api/OfferBroker/InternalGetOffersResponse.json
index 60f6f9e..1a279b9 100644
--- a/schema/Api/OfferBroker/InternalGetOffersResponse.json
+++ b/schema/Api/OfferBroker/InternalGetOffersResponse.json
@@ -136,7 +136,7 @@
}
}
},
- "price": {"type": "number", "format": "double"}
+ "price": { "type": ["number", "null"], "format": "double" }
}
}
}
diff --git a/schema/Api/OfferBroker/UpdateOfferRequest.json b/schema/Api/OfferBroker/UpdateOfferRequest.json
index 23b1206..65dbfc7 100644
--- a/schema/Api/OfferBroker/UpdateOfferRequest.json
+++ b/schema/Api/OfferBroker/UpdateOfferRequest.json
@@ -138,9 +138,8 @@
}
}
},
- "price": {"type": "number", "format": "double"}
- },
- "required": ["price"]
+ "price": { "type": ["number", "null"], "format": "double" }
+ }
}
}
}
diff --git a/schema/Api/OrderBroker/GetOrderResponse.json b/schema/Api/OrderBroker/GetOrderResponse.json
index b475e90..665da2b 100644
--- a/schema/Api/OrderBroker/GetOrderResponse.json
+++ b/schema/Api/OrderBroker/GetOrderResponse.json
@@ -642,6 +642,10 @@
"description": "Packing slip number for the shipment",
"type": ["string", "null"]
},
+ "scac": {
+ "description": "Standard Carrier Alpha Code for the shipment carrier",
+ "type": ["string", "null"]
+ },
"service": { "description": "Shipping service level", "type": ["string", "null"] },
"shipDateUtc": {
"description": "Date and time when the shipment was shipped (UTC)",
@@ -667,6 +671,11 @@
"stateProvince": { "description": "State or province name", "type": ["string", "null"] }
}
},
+ "sourceSystemShipMethodIds": {
+ "description": "Source system ship method identifiers mapped from customer ship method configuration",
+ "type": ["array", "null"],
+ "items": {"type": "string"}
+ },
"totalNumberOfPackages": {
"description": "Total number of packages in the shipment",
"type": ["integer", "null"],
diff --git a/schema/Api/OrderBroker/InternalGetOrderResponse.json b/schema/Api/OrderBroker/InternalGetOrderResponse.json
index 792b482..48dc8cd 100644
--- a/schema/Api/OrderBroker/InternalGetOrderResponse.json
+++ b/schema/Api/OrderBroker/InternalGetOrderResponse.json
@@ -641,6 +641,10 @@
"description": "Packing slip number for the shipment",
"type": ["string", "null"]
},
+ "scac": {
+ "description": "Standard Carrier Alpha Code for the shipment carrier",
+ "type": ["string", "null"]
+ },
"service": { "description": "Shipping service level", "type": ["string", "null"] },
"shipDateUtc": {
"description": "Date and time when the shipment was shipped (UTC)",
@@ -666,6 +670,11 @@
"stateProvince": { "description": "State or province name", "type": ["string", "null"] }
}
},
+ "sourceSystemShipMethodIds": {
+ "description": "Source system ship method identifiers mapped from customer ship method configuration",
+ "type": ["array", "null"],
+ "items": {"type": "string"}
+ },
"totalNumberOfPackages": {
"description": "Total number of packages in the shipment",
"type": ["integer", "null"],
diff --git a/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json b/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json
index 0035289..4183fc2 100644
--- a/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json
+++ b/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json
@@ -190,6 +190,10 @@
"shipmentId": {"type": "string"},
"carrier": { "type": ["string", "null"] },
"freight": {"type": "number", "format": "double"},
+ "fulfillmentSystemShipMethodDescription": {
+ "description": "Ship method description from the fulfillment system, used for SCAC and SourceSystemShipMethodId mapping",
+ "type": ["string", "null"]
+ },
"masterTrackingNumber": { "type": ["string", "null"] },
"packages": {
"type": ["array", "null"],
@@ -209,7 +213,10 @@
"required": ["productLineId", "shipQuantity"]
}
},
- "trackingNumber": {"type": "string"}
+ "reference1": { "type": ["string", "null"] },
+ "reference2": { "type": ["string", "null"] },
+ "trackingNumber": {"type": "string"},
+ "weight": { "type": ["number", "null"] }
},
"required": ["packageNumber", "trackingNumber"]
}
diff --git a/schema/Event/FulfillmentOrder/FulfillmentOrder.json b/schema/Event/FulfillmentOrder/FulfillmentOrder.json
index 5edf4ed..a01450e 100644
--- a/schema/Event/FulfillmentOrder/FulfillmentOrder.json
+++ b/schema/Event/FulfillmentOrder/FulfillmentOrder.json
@@ -215,6 +215,10 @@
"ShipmentId": { "description": "Shipment ID", "type": ["string", "null"] },
"Carrier": { "description": "Carrier", "type": ["string", "null"] },
"Freight": { "description": "Freight cost", "type": ["number", "null"] },
+ "FulfillmentSystemShipMethodDescription": {
+ "description": "Ship method description from the fulfillment system, used for SCAC and SourceSystemShipMethodId mapping",
+ "type": ["string", "null"]
+ },
"IsDeleted": {
"description": "Whether the shipment is deleted",
"type": ["boolean", "null"]
@@ -239,10 +243,6 @@
}
}
},
- "QuantityInPackage": {
- "description": "Quantity of items in the package",
- "type": ["integer", "null"]
- },
"Reference1": {
"description": "First reference field for the package",
"type": ["string", "null"]
diff --git a/schema/Event/Order/Order.json b/schema/Event/Order/Order.json
index afed2cd..7d0b60c 100644
--- a/schema/Event/Order/Order.json
+++ b/schema/Event/Order/Order.json
@@ -439,7 +439,6 @@
}
}
},
- "QuantityInPackage": { "description": "Quantity in package", "type": ["integer", "null"] },
"Reference1": { "description": "Reference 1", "type": ["string", "null"] },
"Reference2": { "description": "Reference 2", "type": ["string", "null"] },
"TrackingNumber": { "description": "Tracking number", "type": ["string", "null"] },
@@ -452,6 +451,10 @@
}
},
"PackingSlipNumber": { "description": "Packing slip number", "type": ["string", "null"] },
+ "SCAC": {
+ "description": "Standard Carrier Alpha Code for the shipment carrier",
+ "type": ["string", "null"]
+ },
"Service": { "description": "Shipping service", "type": ["string", "null"] },
"ShipDateUtc": { "description": "Ship date in UTC", "type": ["string", "null"] },
"ShipToAddress": {
@@ -473,6 +476,11 @@
"StateProvince": { "description": "State or province", "type": ["string", "null"] }
}
},
+ "SourceSystemShipMethodIds": {
+ "description": "Source system ship method identifiers mapped from customer ship method configuration",
+ "type": ["array", "null"],
+ "items": {"type": "string"}
+ },
"TotalNumberOfPackages": { "description": "Total number of packages", "type": ["integer", "null"] }
}
}
diff --git a/schema/Event/OrderView/OrderViewEvent.json b/schema/Event/OrderView/OrderViewEvent.json
index a07baf8..5f9081d 100644
--- a/schema/Event/OrderView/OrderViewEvent.json
+++ b/schema/Event/OrderView/OrderViewEvent.json
@@ -411,6 +411,10 @@
}
},
"PackingSlipNumber": { "description": "Packing slip number", "type": ["string", "null"] },
+ "SCAC": {
+ "description": "Standard Carrier Alpha Code for the shipment carrier",
+ "type": ["string", "null"]
+ },
"Service": { "description": "Shipping service", "type": ["string", "null"] },
"ShipDateUtc": { "description": "Ship date in UTC", "type": ["string", "null"] },
"ShipToAddress": {
@@ -432,6 +436,11 @@
"StateProvince": { "description": "State or province", "type": ["string", "null"] }
}
},
+ "SourceSystemShipMethodIds": {
+ "description": "Source system ship method identifiers mapped from customer ship method configuration",
+ "type": ["array", "null"],
+ "items": {"type": "string"}
+ },
"TotalNumberOfPackages": { "description": "Total number of packages", "type": ["integer", "null"] }
}
}