Schema Changes - 2026-01-21
This document contains the changes to the schema files compared to the main branch.
Changes
diff --git a/schema/Api/CustomerBroker/GetShippingRatesParameters.json b/schema/Api/CustomerBroker/GetShippingRatesParameters.json
deleted file mode 100644
index 6b5e6cb..0000000
--- a/schema/Api/CustomerBroker/GetShippingRatesParameters.json
+++ /dev/null
@@ -1,10 +0,0 @@
-{
- "$schema": "http://json-schema.org/draft-07/schema#",
- "CorrelationId": {
- "description": "Correlation ID. This is added by the API Management service if not present. Once added, it should be propagated to any downstream services.",
- "in": "header",
- "name": "x-correlation-id",
- "schema": {"type": "string"},
- "required": false
- }
-}
diff --git a/schema/Api/CustomerBroker/GetShippingRatesRequest.json b/schema/Api/CustomerBroker/GetShippingRatesRequest.json
deleted file mode 100644
index 5df062a..0000000
--- a/schema/Api/CustomerBroker/GetShippingRatesRequest.json
+++ /dev/null
@@ -1,57 +0,0 @@
-{
- "$schema": "http://json-schema.org/draft-07/schema#",
- "$id": "GetShippingRatesRequest.json",
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "SourceSystemCustomerId": {"description": "Source system customer identifier", "type": "string"},
- "SourceSystemId": {
- "description": "Source system identifier",
- "type": "integer",
- "format": "int32"
- },
- "OfferIds": {
- "description": "List of offer identifiers",
- "type": "array",
- "items": {"type": "string"}
- },
- "PackageWeight": {"description": "Package weight", "type": "number", "format": "float"},
- "ShipToAddress": {
- "description": "Destination address for shipping",
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "Address1": {"description": "Address line 1", "type": "string"},
- "Address2": {"description": "Address line 2", "type": "string"},
- "Address3": {"description": "Address line 3", "type": "string"},
- "City": {"description": "City", "type": "string"},
- "Company": {"description": "Company name", "type": "string"},
- "Country": {
- "description": "3-letter ISO country code",
- "type": "string",
- "pattern": "^[A-Z]{3}$"
- },
- "EmailAddress": {"description": "Email address", "type": "string", "format": "email"},
- "FaxNumber": {"description": "Fax number", "type": "string"},
- "IsResidential": {"description": "Whether the address is residential", "type": "boolean"},
- "Name": {"description": "Recipient name", "type": "string"},
- "PhoneNumber": {"description": "Phone number", "type": "string"},
- "PostalCode": {"description": "Postal code", "type": "string"},
- "StateProvince": {"description": "State or province", "type": "string"}
- },
- "required": [
- "Name", "Address1", "City", "StateProvince", "PostalCode", "EmailAddress",
- "Country", "IsResidential"
- ]
- },
- "SourceSystemShippingMethods": {
- "description": "List of source system shipping methods",
- "type": "array",
- "items": {"type": "string"}
- }
- },
- "required": [
- "SourceSystemId", "SourceSystemCustomerId", "SourceSystemShippingMethods",
- "ShipToAddress", "PackageWeight", "OfferIds"
- ]
-}
diff --git a/schema/Api/CustomerBroker/GetShippingRatesResponse.json b/schema/Api/CustomerBroker/GetShippingRatesResponse.json
deleted file mode 100644
index 1edb76d..0000000
--- a/schema/Api/CustomerBroker/GetShippingRatesResponse.json
+++ /dev/null
@@ -1,38 +0,0 @@
-{
- "$schema": "http://json-schema.org/draft-07/schema#",
- "$id": "GetShippingRatesResponse.json",
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "data": {
- "type": ["object", "null"],
- "additionalProperties": false,
- "properties": {
- "SourceSystemCustomerId": {"description": "Source system customer identifier", "type": "string"},
- "SourceSystemShippingMethodsWithRates": {
- "description": "List of shipping methods with their rates",
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "DeliveryDate": {"description": "Estimated delivery date", "type": "string"},
- "RetailRateForServiceMethod": {
- "description": "Retail rate for the shipping method",
- "type": "number",
- "format": "double"
- },
- "SourceSystemShippingMethod": {"description": "Source system shipping method name", "type": "string"}
- },
- "required": ["SourceSystemShippingMethod", "RetailRateForServiceMethod", "DeliveryDate"]
- }
- }
- },
- "required": ["SourceSystemCustomerId", "SourceSystemShippingMethodsWithRates"]
- },
- "failureMessages": { "type": "array", "items": {"type": "string"} },
- "informationalMessages": { "type": "array", "items": {"type": "string"} },
- "operationWasSuccessful": {"type": "boolean"}
- },
- "required": ["failureMessages", "informationalMessages", "operationWasSuccessful", "data"]
-}
diff --git a/schema/Api/ProductBroker/GetProductsInventoryParameters.json b/schema/Api/ProductBroker/GetProductsInventoryParameters.json
deleted file mode 100644
index 00b7c44..0000000
--- a/schema/Api/ProductBroker/GetProductsInventoryParameters.json
+++ /dev/null
@@ -1,11 +0,0 @@
-{
- "$schema": "http://json-schema.org/draft-07/schema#",
- "correlationId": {
- "description": "Correlation ID. This is added by the API Management service if not present. Once added, it should be propagated to any downstream services.",
- "in": "header",
- "name": "x-correlation-id",
- "schema": {"type": "string"},
- "required": false
- },
- "productIds": { "in": "query", "name": "productIds", "schema": {"type": "string"} }
-}
diff --git a/schema/Api/ProductBroker/GetProductsInventoryResponse.json b/schema/Api/ProductBroker/GetProductsInventoryResponse.json
deleted file mode 100644
index e10beeb..0000000
--- a/schema/Api/ProductBroker/GetProductsInventoryResponse.json
+++ /dev/null
@@ -1,58 +0,0 @@
-{
- "$schema": "http://json-schema.org/draft-07/schema#",
- "$id": "GetProductsInventoryResponse.json",
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "data": {
- "type": ["array", "null"],
- "items": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "billingEntityId": {
- "description": "Billing entity ID associated with the product inventory",
- "type": "string"
- },
- "productId": {
- "description": "Unique ID for component product within Integration Broker",
- "type": "string"
- },
- "currentAvailableQty": {
- "description": "Current available quantity for the product",
- "type": "integer",
- "format": "int32"
- },
- "currentOnHandQty": {
- "description": "Current quantity on hand for the product",
- "type": "integer",
- "format": "int32"
- },
- "expected": {
- "description": "Expected quantity for the product",
- "type": ["integer", "null"],
- "format": "int32"
- },
- "onBackorder": {
- "description": "Quantity on backorder for the product",
- "type": ["integer", "null"],
- "format": "int32"
- },
- "reserved": {
- "description": "Quantity reserved for the product",
- "type": "integer",
- "format": "int32"
- }
- },
- "required": [
- "productId", "currentOnHandQty", "currentAvailableQty", "reserved",
- "billingEntityId"
- ]
- }
- },
- "failureMessages": { "type": "array", "items": {"type": "string"} },
- "informationalMessages": { "type": "array", "items": {"type": "string"} },
- "operationWasSuccessful": {"type": "boolean"}
- },
- "required": ["failureMessages", "informationalMessages", "operationWasSuccessful", "data"]
-}
diff --git a/schema/Api/ShippingBroker/GetShippingratesRequest.json b/schema/Api/ShippingBroker/GetShippingratesRequest.json
index 4358f9a..5df062a 100644
--- a/schema/Api/ShippingBroker/GetShippingratesRequest.json
+++ b/schema/Api/ShippingBroker/GetShippingratesRequest.json
@@ -1,6 +1,6 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
- "$id": "GetShippingratesRequest.json",
+ "$id": "GetShippingRatesRequest.json",
"type": "object",
"additionalProperties": false,
"properties": {
diff --git a/schema/Api/ShippingBroker/GetShippingratesResponse.json b/schema/Api/ShippingBroker/GetShippingratesResponse.json
index 7b810d1..1edb76d 100644
--- a/schema/Api/ShippingBroker/GetShippingratesResponse.json
+++ b/schema/Api/ShippingBroker/GetShippingratesResponse.json
@@ -1,6 +1,6 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
- "$id": "GetShippingratesResponse.json",
+ "$id": "GetShippingRatesResponse.json",
"type": "object",
"additionalProperties": false,
"properties": {