Schema Changes - 2025-07-28
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 7663d4f..3f7bff2 100644
--- a/schema/Api/CustomerBroker/CreateCustomerRequest.json
+++ b/schema/Api/CustomerBroker/CreateCustomerRequest.json
@@ -116,14 +116,17 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "fulfillmentSystemId": {"type": "integer", "format": "int32"},
- "fulfillmentSystemShipMethodId": { "type": ["string", "null"] },
- "fulfillmentSystemName": { "type": ["string", "null"] }
- }
+ "fulfillmentSystemId" : { "type": "integer" , "format": "int32" },
+ "fulfillmentSystemShipMethodId": { "type": ["string", "null"] }
+ },
+ "required": ["fulfillmentSystemId", "fulfillmentSystemShipMethodId"]
}
}
},
- "required": ["sourceSystemShipMethodId"]
+ "required": [
+ "fulfillmentSystemShipMethods", "ratesProviderShipMethodId",
+ "sourceSystemShipMethodId"
+ ]
}
},
"sourceSystems": {
@@ -134,12 +137,11 @@
"properties": {
"id": {"type": "integer", "format": "int32"},
"sourceSystemCustomerId": {
- "description": "Source system ID. Required, must not be null.",
+ "description": "This is an automatically generated field added by middleware. It is considered read-only",
"type": ["string", "null"]
- },
- "name": {"type": "string"}
+ }
},
- "required": ["id", "name"]
+ "required": ["id", "sourceSystemCustomerId"]
}
},
"subsidiary": { "description": "Optional. Subsidiary name.", "type": ["string", "null"] },
diff --git a/schema/Api/CustomerBroker/GetCustomerResponse.json b/schema/Api/CustomerBroker/GetCustomerResponse.json
index f2aeae3..3768d60 100644
--- a/schema/Api/CustomerBroker/GetCustomerResponse.json
+++ b/schema/Api/CustomerBroker/GetCustomerResponse.json
@@ -16,7 +16,6 @@
"minLength": 1
},
"brokerScopes": { "type": "array", "items": {"type": "string"} },
- "clientSecret": {"type": "string"},
"contactAddress": {
"type": "object",
"additionalProperties": false,
@@ -120,7 +119,7 @@
}
}
},
- "required": ["sourceSystemShipMethodId"]
+ "required": ["sourceSystemShipMethodId", "ratesProviderShipMethodId"]
}
},
"sourceSystems": {
@@ -129,11 +128,14 @@
"type": "object",
"additionalProperties": false,
"properties": {
+ "authClientId": { "type": ["string", "null"] },
"id": {"type": "integer", "format": "int32"},
"sourceSystemCustomerId": {
- "description": "Source system ID. Required, must not be null.",
- "type": ["string", "null"]
+ "description": "This is an automatically generated field added by middleware. It is considered read-only",
+ "type": ["string", "null"],
+ "readonly": true
},
+ "clientSecret": { "type": ["string", "null"] },
"name": {"type": "string"}
},
"required": ["id", "name"]
diff --git a/schema/Api/CustomerBroker/GetCustomersResponse.json b/schema/Api/CustomerBroker/GetCustomersResponse.json
index 87400f1..85b53d0 100644
--- a/schema/Api/CustomerBroker/GetCustomersResponse.json
+++ b/schema/Api/CustomerBroker/GetCustomersResponse.json
@@ -3,16 +3,21 @@
"$id": "GetCustomersResponse.json",
"properties": {
"data": {
- "type": ["array", "null"],
- "items": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "id" : { "type": ["string", "null"] },
- "parentId": { "type": ["string", "null"] },
- "name" : { "type": ["string", "null"] }
+ "oneOf": [
+ {"type": "null"},
+ {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "id" : { "type": ["string", "null"] },
+ "parentId": { "type": ["string", "null"] },
+ "name" : { "type": ["string", "null"] }
+ }
+ }
}
- }
+ ]
},
"failureMessages": { "type": "array", "items": {"type": "string"} },
"informationalMessages": { "type": "array", "items": {"type": "string"} },
diff --git a/schema/Api/CustomerBroker/UpdateCustomerRequest.json b/schema/Api/CustomerBroker/UpdateCustomerRequest.json
index b3321fc..0dba052 100644
--- a/schema/Api/CustomerBroker/UpdateCustomerRequest.json
+++ b/schema/Api/CustomerBroker/UpdateCustomerRequest.json
@@ -111,13 +111,17 @@
"additionalProperties": false,
"properties": {
"fulfillmentSystemId": {"type": "integer", "format": "int32"},
- "fulfillmentSystemShipMethodId": { "type": ["string", "null"] },
+ "fulfillmentSystemShipMethodId": {"type": "string"},
"fulfillmentSystemName": { "type": ["string", "null"] }
- }
+ },
+ "required": ["fulfillmentSystemId", "fulfillmentSystemShipMethodId"]
}
}
},
- "required": ["sourceSystemShipMethodId"]
+ "required": [
+ "fulfillmentSystemShipMethods", "ratesProviderShipMethodId",
+ "sourceSystemShipMethodId"
+ ]
}
},
"sourceSystems": {
@@ -128,12 +132,11 @@
"properties": {
"id": {"type": "integer", "format": "int32"},
"sourceSystemCustomerId": {
- "description": "Source system ID. Required, must not be null.",
+ "description": "This is an automatically generated field added by middleware. It is considered read-only",
"type": ["string", "null"]
- },
- "name": {"type": "string"}
+ }
},
- "required": ["id", "name"]
+ "required": ["id", "sourceSystemCustomerId"]
}
},
"subsidiary": { "description": "Optional. Subsidiary name.", "type": ["string", "null"] },
diff --git a/schema/Api/OfferBroker/CreateCategoryResponse.json b/schema/Api/OfferBroker/CreateCategoryResponse.json
index dd89456..2856a2b 100644
--- a/schema/Api/OfferBroker/CreateCategoryResponse.json
+++ b/schema/Api/OfferBroker/CreateCategoryResponse.json
@@ -3,14 +3,19 @@
"$id": "CreateCategoryResponse.json",
"properties": {
"data": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "id": { "type": ["string", "null"] },
- "failureMessages": { "type": ["array", "null"], "items": {"type": "string"} },
- "informationalMessages": { "type": ["array", "null"], "items": {"type": "string"} },
- "operationWasSuccessful": {"type": "boolean", "readOnly": true}
- }
+ "oneOf": [
+ {"type": "null"},
+ {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "id": { "type": ["string", "null"] },
+ "failureMessages": { "type": ["array", "null"], "items": {"type": "string"} },
+ "informationalMessages": { "type": ["array", "null"], "items": {"type": "string"} },
+ "operationWasSuccessful": {"type": "boolean", "readOnly": true}
+ }
+ }
+ ]
},
"failureMessages": { "type": "array", "items": {"type": "string"} },
"informationalMessages": { "type": "array", "items": {"type": "string"} },
diff --git a/schema/Api/OfferBroker/CreateOfferRequest.json b/schema/Api/OfferBroker/CreateOfferRequest.json
index b6ea94b..4b69840 100644
--- a/schema/Api/OfferBroker/CreateOfferRequest.json
+++ b/schema/Api/OfferBroker/CreateOfferRequest.json
@@ -91,7 +91,7 @@
}
}
},
- "productCluster": {
+ "productClusters": {
"description": "Must contain at least one Product with a non-empty productId and pageCount >= 1 if provided.",
"type": "object",
"additionalProperties": false,
@@ -122,5 +122,5 @@
"unitOfMeasure": { "type": ["string", "null"] },
"weightInPounds": {"type": "number", "format": "float"}
},
- "required": ["number", "offerType", "omsOfferId", "productCluster"]
+ "required": ["number", "offerType", "omsOfferId", "productClusters"]
}
diff --git a/schema/Api/OfferBroker/CreateOfferResponse.json b/schema/Api/OfferBroker/CreateOfferResponse.json
index 9de938d..d37a36c 100644
--- a/schema/Api/OfferBroker/CreateOfferResponse.json
+++ b/schema/Api/OfferBroker/CreateOfferResponse.json
@@ -3,14 +3,19 @@
"$id": "CreateOfferResponse.json",
"properties": {
"data": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "id": { "type": ["string", "null"] },
- "failureMessages": { "type": ["array", "null"], "items": {"type": "string"} },
- "informationalMessages": { "type": ["array", "null"], "items": {"type": "string"} },
- "operationWasSuccessful": {"type": "boolean", "readOnly": true}
- }
+ "oneOf": [
+ {"type": "null"},
+ {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "id": { "type": ["string", "null"] },
+ "failureMessages": { "type": ["array", "null"], "items": {"type": "string"} },
+ "informationalMessages": { "type": ["array", "null"], "items": {"type": "string"} },
+ "operationWasSuccessful": {"type": "boolean", "readOnly": true}
+ }
+ }
+ ]
},
"failureMessages": { "type": "array", "items": {"type": "string"} },
"informationalMessages": { "type": "array", "items": {"type": "string"} },
diff --git a/schema/Api/OfferBroker/DeleteCategoryResponse.json b/schema/Api/OfferBroker/DeleteCategoryResponse.json
index 8e1b3eb..2993409 100644
--- a/schema/Api/OfferBroker/DeleteCategoryResponse.json
+++ b/schema/Api/OfferBroker/DeleteCategoryResponse.json
@@ -3,14 +3,19 @@
"$id": "DeleteCategoryResponse.json",
"properties": {
"data": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "id": { "type": ["string", "null"] },
- "failureMessages": { "type": ["array", "null"], "items": {"type": "string"} },
- "informationalMessages": { "type": ["array", "null"], "items": {"type": "string"} },
- "operationWasSuccessful": {"type": "boolean", "readOnly": true}
- }
+ "oneOf": [
+ {"type": "null"},
+ {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "id": { "type": ["string", "null"] },
+ "failureMessages": { "type": ["array", "null"], "items": {"type": "string"} },
+ "informationalMessages": { "type": ["array", "null"], "items": {"type": "string"} },
+ "operationWasSuccessful": {"type": "boolean", "readOnly": true}
+ }
+ }
+ ]
},
"failureMessages": { "type": "array", "items": {"type": "string"} },
"informationalMessages": { "type": "array", "items": {"type": "string"} },
diff --git a/schema/Api/OfferBroker/DeleteOfferResponse.json b/schema/Api/OfferBroker/DeleteOfferResponse.json
index fd15d74..e73414b 100644
--- a/schema/Api/OfferBroker/DeleteOfferResponse.json
+++ b/schema/Api/OfferBroker/DeleteOfferResponse.json
@@ -3,14 +3,19 @@
"$id": "DeleteOfferResponse.json",
"properties": {
"data": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "id": { "type": ["string", "null"] },
- "failureMessages": { "type": ["array", "null"], "items": {"type": "string"} },
- "informationalMessages": { "type": ["array", "null"], "items": {"type": "string"} },
- "operationWasSuccessful": {"type": "boolean", "readOnly": true}
- }
+ "oneOf": [
+ {"type": "null"},
+ {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "id": { "type": ["string", "null"] },
+ "failureMessages": { "type": ["array", "null"], "items": {"type": "string"} },
+ "informationalMessages": { "type": ["array", "null"], "items": {"type": "string"} },
+ "operationWasSuccessful": {"type": "boolean", "readOnly": true}
+ }
+ }
+ ]
},
"failureMessages": { "type": "array", "items": {"type": "string"} },
"informationalMessages": { "type": "array", "items": {"type": "string"} },
diff --git a/schema/Api/OfferBroker/GetOfferCategoriesResponse.json b/schema/Api/OfferBroker/GetOfferCategoriesResponse.json
index 70fbd49..0099a78 100644
--- a/schema/Api/OfferBroker/GetOfferCategoriesResponse.json
+++ b/schema/Api/OfferBroker/GetOfferCategoriesResponse.json
@@ -3,18 +3,23 @@
"$id": "GetOfferCategoriesResponse.json",
"properties": {
"data": {
- "type": ["array", "null"],
- "items": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "id": { "type": ["string", "null"] },
- "categoryKey": { "type": ["string", "null"] },
- "categoryLevel": { "type": ["integer", "null"], "format": "int32" },
- "categoryName": { "type": ["string", "null"] },
- "subCategories": { "type": ["array", "null"], "items": {"type": "object"} }
+ "oneOf": [
+ {"type": "null"},
+ {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "id": { "type": ["string", "null"] },
+ "categoryKey": { "type": ["string", "null"] },
+ "categoryLevel": { "type": ["integer", "null"], "format": "int32" },
+ "categoryName": { "type": ["string", "null"] },
+ "subCategories": { "type": ["array", "null"], "items": {"type": "object"} }
+ }
+ }
}
- }
+ ]
},
"failureMessages": { "type": "array", "items": {"type": "string"} },
"informationalMessages": { "type": "array", "items": {"type": "string"} },
diff --git a/schema/Api/OfferBroker/GetOfferInventoryResponse.json b/schema/Api/OfferBroker/GetOfferInventoryResponse.json
index 6bf07ae..ba8cabe 100644
--- a/schema/Api/OfferBroker/GetOfferInventoryResponse.json
+++ b/schema/Api/OfferBroker/GetOfferInventoryResponse.json
@@ -3,20 +3,25 @@
"$id": "GetOfferInventoryResponse.json",
"properties": {
"data": {
- "type": ["array", "null"],
- "items": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "offerId" : { "type": "string" },
- "currentAvailableQty": { "type": "integer" , "format": "int32" },
- "currentOnHandQty" : { "type": "integer" , "format": "int32" },
- "expected" : { "type": ["integer", "null"], "format": "int32" },
- "onBackorder" : { "type": ["integer", "null"], "format": "int32" },
- "reserved" : { "type": "integer" , "format": "int32" }
- },
- "required": ["currentAvailableQty", "offerId", "reserved"]
- }
+ "oneOf": [
+ {"type": "null"},
+ {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "offerId" : { "type": "string" },
+ "currentAvailableQty": { "type": "integer" , "format": "int32" },
+ "currentOnHandQty" : { "type": "integer" , "format": "int32" },
+ "expected" : { "type": ["integer", "null"], "format": "int32" },
+ "onBackorder" : { "type": ["integer", "null"], "format": "int32" },
+ "reserved" : { "type": "integer" , "format": "int32" }
+ },
+ "required": ["currentAvailableQty", "offerId", "reserved"]
+ }
+ }
+ ]
},
"failureMessages": { "type": "array", "items": {"type": "string"} },
"informationalMessages": { "type": "array", "items": {"type": "string"} },
diff --git a/schema/Api/OfferBroker/GetOffersResponse.json b/schema/Api/OfferBroker/GetOffersResponse.json
index 60ed8e2..f348738 100644
--- a/schema/Api/OfferBroker/GetOffersResponse.json
+++ b/schema/Api/OfferBroker/GetOffersResponse.json
@@ -3,151 +3,156 @@
"$id": "GetOffersResponse.json",
"properties": {
"data": {
- "type": ["array", "null"],
- "items": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "id": { "type": ["string", "null"] },
- "omsOfferId": {
- "description": "Required. Unique offer identifier. Must not be empty.",
- "type": "string",
- "minLength": 1
- },
- "xmPieTemplateId": { "type": ["string", "null"] },
- "xmPieUStoreId": { "type": ["string", "null"] },
- "description": { "type": ["string", "null"] },
- "accessGroups": { "type": ["array", "null"], "items": {"type": "string"} },
- "additionalPropsRequiredOnOrder": {
- "type": ["array", "null"],
- "items": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "type" : { "type": ["string", "null"] },
- "hint" : { "type": ["string", "null"] },
- "label": { "type": ["string", "null"] },
- "name" : { "type": ["string", "null"] },
- "value": { "type": ["string", "null"] }
- }
- }
- },
- "availableEndDate": {
- "description": "Timestamp of when offer is no longer available. This should be in UTC.",
- "type": ["string", "null"],
- "examples": ["2025-06-06T00:00:00Z"]
- },
- "availableStartDate": {
- "description": "Timestamp of when offer is available. This should be in UTC.",
- "type": ["string", "null"],
- "examples": ["2025-06-06T00:00:00Z"]
- },
- "categories": {
- "type": ["array", "null"],
- "items": {
- "type": "object",
- "additionalProperties": false,
- "properties": { "categoryKey": {"type": "string"}, "name": {"type": "string"} },
- "required": ["categoryKey", "name"]
- }
- },
- "categoryIds": { "type": ["array", "null"], "items": {"type": "string"} },
- "comments": { "type": ["string", "null"] },
- "defaultPrice": { "type": ["number", "null"], "format": "double" },
- "doSuppressShippingAndHandling": {"type": "boolean"},
- "fixedOrderQuantities": { "type": ["array", "null"], "items": {"type": "integer", "format": "int32"} },
- "fullImageUrl": { "type": ["string", "null"] },
- "integrationBrokerLastUpdatedDateTimeUtc": {"type": "string"},
- "isActive": {"type": "boolean"},
- "isAvailableViaCoopFunds": { "type": ["boolean", "null"] },
- "isDeleted": {"type": "boolean"},
- "isInventoried": { "type": ["boolean", "null"] },
- "isTaxable": {"type": "boolean"},
- "lastUpdatedDateTimeUTC": {"description": "If provided, must not be in the future.", "type": "string"},
- "number": {
- "description": "Required. Offer number. Must not be empty.",
- "type": "string",
- "minLength": 1
- },
- "offerType": {
- "description": "Required. Must be one of: Product List, Drop Ship, Download, VDM, Omnichannel.",
- "type": "string",
- "enum": ["Product List", "Drop Ship", "Download", "VDM", "Omnichannel"],
- "minLength": 1
- },
- "omsIdentifier": { "type": ["string", "null"] },
- "omsRootSystemName": { "type": ["string", "null"] },
- "onlyShipMethodsAvailable": { "type": ["array", "null"], "items": {"type": "string"} },
- "orderMaximum": { "type": ["integer", "null"], "format": "int32" },
- "orderMinimum": { "type": ["integer", "null"], "format": "int32" },
- "pdfUrl": { "type": ["string", "null"] },
- "priceClasses": {
- "type": ["array", "null"],
- "items": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "name": { "type": ["string", "null"] },
- "price": { "type": ["number", "null"], "format": "double" },
- "priceTiers": {
- "type": ["array", "null"],
- "items": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "maximumQuantity": { "type": ["integer", "null"], "format": "int32" },
- "minimumQuantity": { "type": ["integer", "null"], "format": "int32" },
- "price" : { "type": "number" , "format": "double" }
+ "oneOf": [
+ {"type": "null"},
+ {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "id": { "type": ["string", "null"] },
+ "omsOfferId": {
+ "description": "Required. Unique offer identifier. Must not be empty.",
+ "type": "string",
+ "minLength": 1
+ },
+ "xmPieTemplateId": { "type": ["string", "null"] },
+ "xmPieUStoreId": { "type": ["string", "null"] },
+ "description": { "type": ["string", "null"] },
+ "accessGroups": { "type": ["array", "null"], "items": {"type": "string"} },
+ "additionalPropsRequiredOnOrder": {
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "type" : { "type": ["string", "null"] },
+ "hint" : { "type": ["string", "null"] },
+ "label": { "type": ["string", "null"] },
+ "name" : { "type": ["string", "null"] },
+ "value": { "type": ["string", "null"] }
+ }
+ }
+ },
+ "availableEndDate": {
+ "description": "Timestamp of when offer is no longer available. This should be in UTC.",
+ "type": ["string", "null"],
+ "examples": ["2025-06-06T00:00:00Z"]
+ },
+ "availableStartDate": {
+ "description": "Timestamp of when offer is available. This should be in UTC.",
+ "type": ["string", "null"],
+ "examples": ["2025-06-06T00:00:00Z"]
+ },
+ "categories": {
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": { "categoryKey": {"type": "string"}, "name": {"type": "string"} },
+ "required": ["categoryKey", "name"]
+ }
+ },
+ "categoryIds": { "type": ["array", "null"], "items": {"type": "string"} },
+ "comments": { "type": ["string", "null"] },
+ "defaultPrice": { "type": ["number", "null"], "format": "double" },
+ "doSuppressShippingAndHandling": {"type": "boolean"},
+ "fixedOrderQuantities": { "type": ["array", "null"], "items": {"type": "integer", "format": "int32"} },
+ "fullImageUrl": { "type": ["string", "null"] },
+ "integrationBrokerLastUpdatedDateTimeUtc": {"type": "string"},
+ "isActive": {"type": "boolean"},
+ "isAvailableViaCoopFunds": { "type": ["boolean", "null"] },
+ "isDeleted": {"type": "boolean"},
+ "isInventoried": { "type": ["boolean", "null"] },
+ "isTaxable": {"type": "boolean"},
+ "lastUpdatedDateTimeUTC": {"description": "If provided, must not be in the future.", "type": "string"},
+ "number": {
+ "description": "Required. Offer number. Must not be empty.",
+ "type": "string",
+ "minLength": 1
+ },
+ "offerType": {
+ "description": "Required. Must be one of: Product List, Drop Ship, Download, VDM, Omnichannel.",
+ "type": "string",
+ "enum": ["Product List", "Drop Ship", "Download", "VDM", "Omnichannel"],
+ "minLength": 1
+ },
+ "omsIdentifier": { "type": ["string", "null"] },
+ "omsRootSystemName": { "type": ["string", "null"] },
+ "onlyShipMethodsAvailable": { "type": ["array", "null"], "items": {"type": "string"} },
+ "orderMaximum": { "type": ["integer", "null"], "format": "int32" },
+ "orderMinimum": { "type": ["integer", "null"], "format": "int32" },
+ "pdfUrl": { "type": ["string", "null"] },
+ "priceClasses": {
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "name": { "type": ["string", "null"] },
+ "price": { "type": ["number", "null"], "format": "double" },
+ "priceTiers": {
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "maximumQuantity": { "type": ["integer", "null"], "format": "int32" },
+ "minimumQuantity": { "type": ["integer", "null"], "format": "int32" },
+ "price" : { "type": "number" , "format": "double" }
+ }
+ }
}
}
}
- }
- }
- },
- "productClusters": {
- "description": "Required if offerType is 'Product List'. Must contain at least one ProductCluster with at least one Product, each with a non-empty productId and pageCount >= 1 if provided.",
- "type": ["array", "null"],
- "items": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "id": { "type": ["string", "null"] },
- "products": {
- "type": ["array", "null"],
- "items": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "omsProductId": { "type": ["string", "null"] },
- "productId": { "type": ["string", "null"] },
- "associatedFileName": { "type": ["string", "null"] },
- "buildType": { "type": "integer", "enum": [0, 1, 2, 3, 4, 5], "format": "int32" },
- "pageCount": { "type": ["integer", "null"], "format": "int32" },
- "productColor": { "type": ["string", "null"] },
- "productDescription": { "type": ["string", "null"] },
- "productNumber": { "type": ["string", "null"] },
- "productQuantityInOffer": {"type": "integer", "format": "int32"},
- "productSize": { "type": ["string", "null"] },
- "surcharge": { "type": ["number", "null"], "format": "double" }
+ },
+ "productClusters": {
+ "description": "Required if offerType is 'Product List'. Must contain at least one ProductCluster with at least one Product, each with a non-empty productId and pageCount >= 1 if provided.",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "id": { "type": ["string", "null"] },
+ "products": {
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "omsProductId": { "type": ["string", "null"] },
+ "productId": { "type": ["string", "null"] },
+ "associatedFileName": { "type": ["string", "null"] },
+ "buildType": { "type": "integer", "enum": [0, 1, 2, 3, 4, 5], "format": "int32" },
+ "pageCount": { "type": ["integer", "null"], "format": "int32" },
+ "productColor": { "type": ["string", "null"] },
+ "productDescription": { "type": ["string", "null"] },
+ "productNumber": { "type": ["string", "null"] },
+ "productQuantityInOffer": {"type": "integer", "format": "int32"},
+ "productSize": { "type": ["string", "null"] },
+ "surcharge": { "type": ["number", "null"], "format": "double" }
+ }
+ },
+ "minItems": 1
}
},
- "minItems": 1
+ "required": ["id"]
}
},
- "required": ["id"]
- }
- },
- "requiresApproval": { "type": ["boolean", "null"] },
- "schemaVersion": { "type": ["string", "null"] },
- "secureEmailBody": { "type": ["string", "null"] },
- "secureEmailSubject": { "type": ["string", "null"] },
- "surcharge": {"type": "number", "format": "double"},
- "thumbnailUrl": { "type": ["string", "null"] },
- "unitOfMeasure": { "type": ["string", "null"] },
- "weightInPounds": {"type": "number", "format": "float"}
- },
- "required": ["omsOfferId", "number", "offerType"]
- }
+ "requiresApproval": { "type": ["boolean", "null"] },
+ "schemaVersion": { "type": ["string", "null"] },
+ "secureEmailBody": { "type": ["string", "null"] },
+ "secureEmailSubject": { "type": ["string", "null"] },
+ "surcharge": {"type": "number", "format": "double"},
+ "thumbnailUrl": { "type": ["string", "null"] },
+ "unitOfMeasure": { "type": ["string", "null"] },
+ "weightInPounds": {"type": "number", "format": "float"}
+ },
+ "required": ["omsOfferId", "number", "offerType"]
+ }
+ }
+ ]
},
"failureMessages": { "type": "array", "items": {"type": "string"} },
"informationalMessages": { "type": "array", "items": {"type": "string"} },
diff --git a/schema/Api/OfferBroker/InternalGetOffersResponse.json b/schema/Api/OfferBroker/InternalGetOffersResponse.json
index 1bd9991..03097e4 100644
--- a/schema/Api/OfferBroker/InternalGetOffersResponse.json
+++ b/schema/Api/OfferBroker/InternalGetOffersResponse.json
@@ -3,147 +3,152 @@
"$id": "InternalGetOffersResponse.json",
"properties": {
"data": {
- "type": ["array", "null"],
- "items": {
- "type": "object",
- "properties": {
- "id": { "type": ["string", "null"] },
- "omsOfferId": {
- "description": "Required. Unique offer identifier. Must not be empty.",
- "type": "string",
- "minLength": 1
- },
- "xmPieTemplateId": { "type": ["string", "null"] },
- "xmPieUStoreId": { "type": ["string", "null"] },
- "description": { "type": ["string", "null"] },
- "accessGroups": { "type": ["array", "null"], "items": {"type": "string"} },
- "additionalPropsRequiredOnOrder": {
- "type": ["array", "null"],
- "items": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "type" : { "type": ["string", "null"] },
- "hint" : { "type": ["string", "null"] },
- "label": { "type": ["string", "null"] },
- "name" : { "type": ["string", "null"] },
- "value": { "type": ["string", "null"] }
- }
- }
- },
- "availableEndDate": {
- "description": "Timestamp of when offer is no longer available. This should be in UTC.",
- "type": ["string", "null"],
- "examples": ["2025-06-06T00:00:00Z"]
- },
- "availableStartDate": {
- "description": "Timestamp of when offer is available. This should be in UTC.",
- "type": ["string", "null"],
- "examples": ["2025-06-06T00:00:00Z"]
- },
- "categories": {
- "type": ["array", "null"],
- "items": {
- "type": "object",
- "additionalProperties": false,
- "properties": { "categoryKey": {"type": "string"}, "name": {"type": "string"} },
- "required": ["categoryKey", "name"]
- }
- },
- "categoryIds": { "type": ["array", "null"], "items": {"type": "string"} },
- "comments": { "type": ["string", "null"] },
- "defaultPrice": { "type": ["number", "null"], "format": "double" },
- "doSuppressShippingAndHandling": {"type": "boolean"},
- "fixedOrderQuantities": { "type": ["array", "null"], "items": {"type": "integer", "format": "int32"} },
- "fullImageUrl": { "type": ["string", "null"] },
- "integrationBrokerLastUpdatedDateTimeUtc": {"type": "string"},
- "isActive": {"type": "boolean"},
- "isAvailableViaCoopFunds": { "type": ["boolean", "null"] },
- "isDeleted": {"type": "boolean"},
- "isInventoried": { "type": ["boolean", "null"] },
- "isTaxable": {"type": "boolean"},
- "lastUpdatedDateTimeUTC": {"description": "If provided, must not be in the future.", "type": "string"},
- "number": {
- "description": "Required. Offer number. Must not be empty.",
- "type": "string",
- "minLength": 1
- },
- "offerType": {
- "description": "Required. Must be one of: Product List, Drop Ship, Download, VDM, Omnichannel.",
- "type": "string",
- "enum": ["Product List", "Drop Ship", "Download", "VDM", "Omnichannel"],
- "minLength": 1
- },
- "omsIdentifier": { "type": ["string", "null"] },
- "omsRootSystemName": { "type": ["string", "null"] },
- "onlyShipMethodsAvailable": { "type": ["array", "null"], "items": {"type": "string"} },
- "orderMaximum": { "type": ["integer", "null"], "format": "int32" },
- "orderMinimum": { "type": ["integer", "null"], "format": "int32" },
- "pdfUrl": { "type": ["string", "null"] },
- "priceClasses": {
- "type": ["array", "null"],
- "items": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "name": { "type": ["string", "null"] },
- "price": { "type": ["number", "null"], "format": "double" },
- "priceTiers": {
- "type": ["array", "null"],
- "items": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "maximumQuantity": { "type": ["integer", "null"], "format": "int32" },
- "minimumQuantity": { "type": ["integer", "null"], "format": "int32" },
- "price" : { "type": "number" , "format": "double" }
- }
- }
- }
- }
- }
- },
- "productCluster": {
- "description": "Must contain at least one Product with a non-empty productId and pageCount >= 1 if provided.",
+ "oneOf": [
+ {"type": "null"},
+ {
+ "type": "array",
+ "items": {
"type": "object",
- "additionalProperties": false,
"properties": {
"id": { "type": ["string", "null"] },
- "products": {
+ "omsOfferId": {
+ "description": "Required. Unique offer identifier. Must not be empty.",
+ "type": "string",
+ "minLength": 1
+ },
+ "xmPieTemplateId": { "type": ["string", "null"] },
+ "xmPieUStoreId": { "type": ["string", "null"] },
+ "description": { "type": ["string", "null"] },
+ "accessGroups": { "type": ["array", "null"], "items": {"type": "string"} },
+ "additionalPropsRequiredOnOrder": {
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "type" : { "type": ["string", "null"] },
+ "hint" : { "type": ["string", "null"] },
+ "label": { "type": ["string", "null"] },
+ "name" : { "type": ["string", "null"] },
+ "value": { "type": ["string", "null"] }
+ }
+ }
+ },
+ "availableEndDate": {
+ "description": "Timestamp of when offer is no longer available. This should be in UTC.",
+ "type": ["string", "null"],
+ "examples": ["2025-06-06T00:00:00Z"]
+ },
+ "availableStartDate": {
+ "description": "Timestamp of when offer is available. This should be in UTC.",
+ "type": ["string", "null"],
+ "examples": ["2025-06-06T00:00:00Z"]
+ },
+ "categories": {
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": { "categoryKey": {"type": "string"}, "name": {"type": "string"} },
+ "required": ["categoryKey", "name"]
+ }
+ },
+ "categoryIds": { "type": ["array", "null"], "items": {"type": "string"} },
+ "comments": { "type": ["string", "null"] },
+ "defaultPrice": { "type": ["number", "null"], "format": "double" },
+ "doSuppressShippingAndHandling": {"type": "boolean"},
+ "fixedOrderQuantities": { "type": ["array", "null"], "items": {"type": "integer", "format": "int32"} },
+ "fullImageUrl": { "type": ["string", "null"] },
+ "integrationBrokerLastUpdatedDateTimeUtc": {"type": "string"},
+ "isActive": {"type": "boolean"},
+ "isAvailableViaCoopFunds": { "type": ["boolean", "null"] },
+ "isDeleted": {"type": "boolean"},
+ "isInventoried": { "type": ["boolean", "null"] },
+ "isTaxable": {"type": "boolean"},
+ "lastUpdatedDateTimeUTC": {"description": "If provided, must not be in the future.", "type": "string"},
+ "number": {
+ "description": "Required. Offer number. Must not be empty.",
+ "type": "string",
+ "minLength": 1
+ },
+ "offerType": {
+ "description": "Required. Must be one of: Product List, Drop Ship, Download, VDM, Omnichannel.",
+ "type": "string",
+ "enum": ["Product List", "Drop Ship", "Download", "VDM", "Omnichannel"],
+ "minLength": 1
+ },
+ "omsIdentifier": { "type": ["string", "null"] },
+ "omsRootSystemName": { "type": ["string", "null"] },
+ "onlyShipMethodsAvailable": { "type": ["array", "null"], "items": {"type": "string"} },
+ "orderMaximum": { "type": ["integer", "null"], "format": "int32" },
+ "orderMinimum": { "type": ["integer", "null"], "format": "int32" },
+ "pdfUrl": { "type": ["string", "null"] },
+ "priceClasses": {
"type": ["array", "null"],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
- "omsProductId": { "type": ["string", "null"] },
- "productId": { "type": ["string", "null"] },
- "associatedFileName": { "type": ["string", "null"] },
- "buildType": { "type": "integer", "enum": [0, 1, 2, 3, 4, 5], "format": "int32" },
- "pageCount": { "type": ["integer", "null"], "format": "int32" },
- "productColor": { "type": ["string", "null"] },
- "productDescription": { "type": ["string", "null"] },
- "productNumber": { "type": ["string", "null"] },
- "productQuantityInOffer": {"type": "integer", "format": "int32"},
- "productSize": { "type": ["string", "null"] },
- "surcharge": { "type": ["number", "null"], "format": "double" }
+ "name": { "type": ["string", "null"] },
+ "price": { "type": ["number", "null"], "format": "double" },
+ "priceTiers": {
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "maximumQuantity": { "type": ["integer", "null"], "format": "int32" },
+ "minimumQuantity": { "type": ["integer", "null"], "format": "int32" },
+ "price" : { "type": "number" , "format": "double" }
+ }
+ }
+ }
+ }
+ }
+ },
+ "productClusters": {
+ "description": "Must contain at least one Product with a non-empty productId and pageCount >= 1 if provided.",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "id": { "type": ["string", "null"] },
+ "products": {
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "omsProductId": { "type": ["string", "null"] },
+ "productId": { "type": ["string", "null"] },
+ "associatedFileName": { "type": ["string", "null"] },
+ "buildType": { "type": "integer", "enum": [0, 1, 2, 3, 4, 5], "format": "int32" },
+ "pageCount": { "type": ["integer", "null"], "format": "int32" },
+ "productColor": { "type": ["string", "null"] },
+ "productDescription": { "type": ["string", "null"] },
+ "productNumber": { "type": ["string", "null"] },
+ "productQuantityInOffer": {"type": "integer", "format": "int32"},
+ "productSize": { "type": ["string", "null"] },
+ "surcharge": { "type": ["number", "null"], "format": "double" }
+ }
+ },
+ "minItems": 1
}
},
- "minItems": 1
- }
+ "required": ["id"]
+ },
+ "requiresApproval": { "type": ["boolean", "null"] },
+ "schemaVersion": { "type": ["string", "null"] },
+ "secureEmailBody": { "type": ["string", "null"] },
+ "secureEmailSubject": { "type": ["string", "null"] },
+ "surcharge": {"type": "number", "format": "double"},
+ "thumbnailUrl": { "type": ["string", "null"] },
+ "unitOfMeasure": { "type": ["string", "null"] },
+ "weightInPounds": {"type": "number", "format": "float"}
},
- "required": ["id"]
- },
- "requiresApproval": { "type": ["boolean", "null"] },
- "schemaVersion": { "type": ["string", "null"] },
- "secureEmailBody": { "type": ["string", "null"] },
- "secureEmailSubject": { "type": ["string", "null"] },
- "surcharge": {"type": "number", "format": "double"},
- "thumbnailUrl": { "type": ["string", "null"] },
- "unitOfMeasure": { "type": ["string", "null"] },
- "weightInPounds": {"type": "number", "format": "float"}
- },
- "required": ["omsOfferId", "number", "offerType", "productCluster"]
- }
+ "required": ["omsOfferId", "number", "offerType", "productClusters"]
+ }
+ }
+ ]
},
"failureMessages": { "type": "array", "items": {"type": "string"} },
"informationalMessages": { "type": "array", "items": {"type": "string"} },
diff --git a/schema/Api/OfferBroker/UpdateCategoryResponse.json b/schema/Api/OfferBroker/UpdateCategoryResponse.json
index d56ca22..afcbed0 100644
--- a/schema/Api/OfferBroker/UpdateCategoryResponse.json
+++ b/schema/Api/OfferBroker/UpdateCategoryResponse.json
@@ -3,14 +3,19 @@
"$id": "UpdateCategoryResponse.json",
"properties": {
"data": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "id": { "type": ["string", "null"] },
- "failureMessages": { "type": ["array", "null"], "items": {"type": "string"} },
- "informationalMessages": { "type": ["array", "null"], "items": {"type": "string"} },
- "operationWasSuccessful": {"type": "boolean", "readOnly": true}
- }
+ "oneOf": [
+ {"type": "null"},
+ {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "id": { "type": ["string", "null"] },
+ "failureMessages": { "type": ["array", "null"], "items": {"type": "string"} },
+ "informationalMessages": { "type": ["array", "null"], "items": {"type": "string"} },
+ "operationWasSuccessful": {"type": "boolean", "readOnly": true}
+ }
+ }
+ ]
},
"failureMessages": { "type": "array", "items": {"type": "string"} },
"informationalMessages": { "type": "array", "items": {"type": "string"} },
diff --git a/schema/Api/OfferBroker/UpdateOfferRequest.json b/schema/Api/OfferBroker/UpdateOfferRequest.json
index 169cfe6..5f2411e 100644
--- a/schema/Api/OfferBroker/UpdateOfferRequest.json
+++ b/schema/Api/OfferBroker/UpdateOfferRequest.json
@@ -92,7 +92,7 @@
}
}
},
- "productCluster": {
+ "productClusters": {
"description": "Must contain at least one Product with a non-empty productId and pageCount >= 1 if provided.",
"type": "object",
"additionalProperties": false,
@@ -123,5 +123,5 @@
"unitOfMeasure": { "type": ["string", "null"] },
"weightInPounds": {"type": "number", "format": "float"}
},
- "required": ["number", "offerType", "omsOfferId", "productCluster"]
+ "required": ["number", "offerType", "omsOfferId", "productClusters"]
}
diff --git a/schema/Api/OfferBroker/UpdateOfferResponse.json b/schema/Api/OfferBroker/UpdateOfferResponse.json
index ad3d274..d6366b6 100644
--- a/schema/Api/OfferBroker/UpdateOfferResponse.json
+++ b/schema/Api/OfferBroker/UpdateOfferResponse.json
@@ -3,14 +3,19 @@
"$id": "UpdateOfferResponse.json",
"properties": {
"data": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "id": { "type": ["string", "null"] },
- "failureMessages": { "type": ["array", "null"], "items": {"type": "string"} },
- "informationalMessages": { "type": ["array", "null"], "items": {"type": "string"} },
- "operationWasSuccessful": {"type": "boolean", "readOnly": true}
- }
+ "oneOf": [
+ {"type": "null"},
+ {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "id": { "type": ["string", "null"] },
+ "failureMessages": { "type": ["array", "null"], "items": {"type": "string"} },
+ "informationalMessages": { "type": ["array", "null"], "items": {"type": "string"} },
+ "operationWasSuccessful": {"type": "boolean", "readOnly": true}
+ }
+ }
+ ]
},
"failureMessages": { "type": "array", "items": {"type": "string"} },
"informationalMessages": { "type": "array", "items": {"type": "string"} },
diff --git a/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json b/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json
index cccff99..19e4a3e 100644
--- a/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json
+++ b/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json
@@ -15,8 +15,8 @@
"oneOf": [
{"type": "null"},
{
+ "description": "Bill to address object for Order",
"type": "object",
- "allOf": [ {"description": "Bill to address object for Order"} ],
"properties": {
"address1": {"description": "Address line 1 for address", "type": "string"},
"address2": { "description": "Address line 2 for address", "type": ["string", "null"] },
@@ -98,8 +98,8 @@
"shipTos": {
"type": ["array", "null"],
"items": {
+ "description": "Ship to addresses array for Order",
"type": "object",
- "allOf": [ {"description": "Ship to addresses array for Order"} ],
"properties": {
"fulfillmentSystemShippingMethodId": { "type": ["string", "null"] },
"referenceId": { "type": ["string", "null"] },
diff --git a/schema/Api/OrderBroker/UpdateFulfillmentOrderResponse.json b/schema/Api/OrderBroker/UpdateFulfillmentOrderResponse.json
index ae48ec1..3884a9e 100644
--- a/schema/Api/OrderBroker/UpdateFulfillmentOrderResponse.json
+++ b/schema/Api/OrderBroker/UpdateFulfillmentOrderResponse.json
@@ -3,13 +3,18 @@
"$id": "UpdateFulfillmentOrderResponse.json",
"properties": {
"data": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "failureMessages": { "type": ["array", "null"], "items": {"type": "string"} },
- "informationalMessages": { "type": ["array", "null"], "items": {"type": "string"} },
- "operationWasSuccessful": {"type": "boolean", "readOnly": true}
- }
+ "oneOf": [
+ {"type": "null"},
+ {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "failureMessages": { "type": ["array", "null"], "items": {"type": "string"} },
+ "informationalMessages": { "type": ["array", "null"], "items": {"type": "string"} },
+ "operationWasSuccessful": {"type": "boolean", "readOnly": true}
+ }
+ }
+ ]
},
"failureMessages": { "type": "array", "items": {"type": "string"} },
"informationalMessages": { "type": "array", "items": {"type": "string"} },
diff --git a/schema/Api/ProductBroker/GetAllProductsResponse.json b/schema/Api/ProductBroker/GetAllProductsResponse.json
index 586debf..18b5506 100644
--- a/schema/Api/ProductBroker/GetAllProductsResponse.json
+++ b/schema/Api/ProductBroker/GetAllProductsResponse.json
@@ -3,36 +3,41 @@
"$id": "GetAllProductsResponse.json",
"properties": {
"data": {
- "type": ["array", "null"],
- "items": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "ProductId": {
- "description": "Unique ID for component product within Integration Broker",
- "type": "string"
- },
- "Color": { "description": "Color of product", "type": ["string", "null"] },
- "LastUpdateDateTimeUtc": {
- "description": "Date and time product was last updated in product management system (system where ordered line item products will be managed)",
- "type": "string"
- },
- "ProductDescription": {
- "description": "Description for component product within product management system (system where ordered line item products will be managed)",
- "type": ["string", "null"]
- },
- "ProductNumber": {
- "description": "Name for component product within product management system (system where ordered line item products will be managed)",
- "type": "string"
- },
- "ProductOwner": { "description": "Owner of component product", "type": ["string", "null"] },
- "ProductType": {"type": "string"},
- "Size": { "description": "Size of component product", "type": ["string", "null"] },
- "Status": {"type": "string"},
- "UnitOfMeasure": { "type": ["string", "null"] }
- },
- "required": ["LastUpdateDateTimeUtc", "ProductId", "ProductNumber", "ProductType", "Status"]
- }
+ "oneOf": [
+ {"type": "null"},
+ {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "ProductId": {
+ "description": "Unique ID for component product within Integration Broker",
+ "type": "string"
+ },
+ "Color": { "description": "Color of product", "type": ["string", "null"] },
+ "LastUpdateDateTimeUtc": {
+ "description": "Date and time product was last updated in product management system (system where ordered line item products will be managed)",
+ "type": "string"
+ },
+ "ProductDescription": {
+ "description": "Description for component product within product management system (system where ordered line item products will be managed)",
+ "type": ["string", "null"]
+ },
+ "ProductNumber": {
+ "description": "Name for component product within product management system (system where ordered line item products will be managed)",
+ "type": "string"
+ },
+ "ProductOwner": { "description": "Owner of component product", "type": ["string", "null"] },
+ "ProductType": {"type": "string"},
+ "Size": { "description": "Size of component product", "type": ["string", "null"] },
+ "Status": {"type": "string"},
+ "UnitOfMeasure": { "type": ["string", "null"] }
+ },
+ "required": ["LastUpdateDateTimeUtc", "ProductId", "ProductNumber", "ProductType", "Status"]
+ }
+ }
+ ]
},
"failureMessages": { "type": "array", "items": {"type": "string"} },
"informationalMessages": { "type": "array", "items": {"type": "string"} },
diff --git a/schema/Api/ProductBroker/GetProductsInventoryResponse.json b/schema/Api/ProductBroker/GetProductsInventoryResponse.json
index 70242f4..27c65b0 100644
--- a/schema/Api/ProductBroker/GetProductsInventoryResponse.json
+++ b/schema/Api/ProductBroker/GetProductsInventoryResponse.json
@@ -3,20 +3,25 @@
"$id": "GetProductsInventoryResponse.json",
"properties": {
"data": {
- "type": ["array", "null"],
- "items": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "productId" : { "type": ["string", "null"] },
- "currentAvailableQty": { "type": "integer" , "format": "int32" },
- "currentOnHandQty" : { "type": "integer" , "format": "int32" },
- "expected" : { "type": ["integer", "null"], "format": "int32" },
- "onBackorder" : { "type": ["integer", "null"], "format": "int32" },
- "reserved" : { "type": "integer" , "format": "int32" }
- },
- "required": ["currentAvailableQty", "currentOnHandQty", "productId", "reserved"]
- }
+ "oneOf": [
+ {"type": "null"},
+ {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "ProductId" : { "type": ["string", "null"] },
+ "CurrentAvailableQty": { "type": "integer" , "format": "int32" },
+ "CurrentOnHandQty" : { "type": "integer" , "format": "int32" },
+ "Expected" : { "type": ["integer", "null"], "format": "int32" },
+ "OnBackorder" : { "type": ["integer", "null"], "format": "int32" },
+ "Reserved" : { "type": "integer" , "format": "int32" }
+ },
+ "required": ["CurrentAvailableQty", "CurrentOnHandQty", "ProductId", "Reserved"]
+ }
+ }
+ ]
},
"failureMessages": { "type": "array", "items": {"type": "string"} },
"informationalMessages": { "type": "array", "items": {"type": "string"} },