Schema Changes - 2026-01-19
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 28f26af..7731e80 100644
--- a/schema/Api/CustomerBroker/CreateCustomerRequest.json
+++ b/schema/Api/CustomerBroker/CreateCustomerRequest.json
@@ -154,10 +154,8 @@
"description": "Optional. Parent customer reference.",
"type": ["object", "null"],
"additionalProperties": false,
- "properties": {
- "id" : { "description": "Optional. Parent customer ID." , "type": ["string", "null"] },
- "name": { "description": "Optional. Parent customer name.", "type": ["string", "null"] }
- }
+ "properties": { "id": { "description": "Required. Parent customer ID.", "type": ["string"] } },
+ "required": ["id"]
},
"paymentEmailAddress": {
"description": "Optional. Payment email address. Must be a valid email if provided.",
@@ -183,6 +181,10 @@
"description": "Required. Source system ship method identifier.",
"type": "string"
},
+ "carrier": {
+ "description": "Optional. Carrier name for third-party shipping.",
+ "type": ["string", "null"]
+ },
"fulfillmentSystemShipMethods": {
"description": "Required. Fulfillment system ship methods.",
"type": "array",
@@ -199,6 +201,10 @@
"required": ["fulfillmentSystemId", "fulfillmentSystemShipMethodId"]
}
},
+ "thirdPartyAccountNumber": {
+ "description": "Optional. Third-party carrier account number.",
+ "type": ["string", "null"]
+ },
"trackingUrl": { "description": "Optional. Tracking URL.", "type": ["string", "null"] }
},
"required": [
@@ -218,6 +224,15 @@
"sourceSystemCustomerId": {
"description": "Required. Source system customer identifier.",
"type": "string"
+ },
+ "defaultPaymentMethod": {
+ "description": "Optional. Default payment method identifier for the source system. Must be provided if paymentMethodRequired is false.",
+ "type": ["string", "null"]
+ },
+ "paymentMethodRequired": {
+ "description": "Optional. Indicates if payment method is required on an order. Defaults to true.",
+ "type": "boolean",
+ "default": true
}
},
"required": ["id", "sourceSystemCustomerId"]
diff --git a/schema/Api/CustomerBroker/GetCustomerResponse.json b/schema/Api/CustomerBroker/GetCustomerResponse.json
index e3cf66e..d8e2e2f 100644
--- a/schema/Api/CustomerBroker/GetCustomerResponse.json
+++ b/schema/Api/CustomerBroker/GetCustomerResponse.json
@@ -136,6 +136,10 @@
"description": "Source system ship method identifier.",
"type": ["string", "null"]
},
+ "carrier": {
+ "description": "Carrier name for third-party shipping.",
+ "type": ["string", "null"]
+ },
"fulfillmentSystemShipMethods": {
"description": "Fulfillment system ship methods.",
"type": ["array", "null"],
@@ -152,6 +156,10 @@
}
}
},
+ "thirdPartyAccountNumber": {
+ "description": "Third-party carrier account number.",
+ "type": ["string", "null"]
+ },
"trackingUrl": { "description": "Tracking URL.", "type": ["string", "null"] }
}
}
diff --git a/schema/Api/CustomerBroker/GetShippingRatesParameters.json b/schema/Api/CustomerBroker/GetShippingRatesParameters.json
new file mode 100644
index 0000000..6b5e6cb
--- /dev/null
+++ b/schema/Api/CustomerBroker/GetShippingRatesParameters.json
@@ -0,0 +1,10 @@
+{
+ "$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
new file mode 100644
index 0000000..5df062a
--- /dev/null
+++ b/schema/Api/CustomerBroker/GetShippingRatesRequest.json
@@ -0,0 +1,57 @@
+{
+ "$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
new file mode 100644
index 0000000..1edb76d
--- /dev/null
+++ b/schema/Api/CustomerBroker/GetShippingRatesResponse.json
@@ -0,0 +1,38 @@
+{
+ "$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/CustomerBroker/UpdateCustomerRequest.json b/schema/Api/CustomerBroker/UpdateCustomerRequest.json
index 33acaec..aa2ac66 100644
--- a/schema/Api/CustomerBroker/UpdateCustomerRequest.json
+++ b/schema/Api/CustomerBroker/UpdateCustomerRequest.json
@@ -149,10 +149,8 @@
"description": "Optional. Parent customer reference.",
"type": ["object", "null"],
"additionalProperties": false,
- "properties": {
- "id" : { "description": "Optional. Parent customer ID." , "type": ["string", "null"] },
- "name": { "description": "Optional. Parent customer name.", "type": ["string", "null"] }
- }
+ "properties": { "id": { "description": "Required. Parent customer ID.", "type": ["string"] } },
+ "required": ["id"]
},
"paymentEmailAddress": {
"description": "Optional. Payment email address. Must be a valid email if provided.",
@@ -178,6 +176,10 @@
"description": "Required. Source system ship method identifier.",
"type": "string"
},
+ "carrier": {
+ "description": "Optional. Carrier name for third-party shipping.",
+ "type": ["string", "null"]
+ },
"fulfillmentSystemShipMethods": {
"description": "Required. Fulfillment system ship methods.",
"type": "array",
@@ -194,6 +196,10 @@
"required": ["fulfillmentSystemId", "fulfillmentSystemShipMethodId"]
}
},
+ "thirdPartyAccountNumber": {
+ "description": "Optional. Third-party carrier account number.",
+ "type": ["string", "null"]
+ },
"trackingUrl": { "description": "Optional. Tracking URL.", "type": ["string", "null"] }
},
"required": [
@@ -213,6 +219,15 @@
"sourceSystemCustomerId": {
"description": "Required. Source system customer identifier.",
"type": "string"
+ },
+ "defaultPaymentMethod": {
+ "description": "Optional. Default payment method identifier for the source system. Must be provided if paymentMethodRequired is false.",
+ "type": ["string", "null"]
+ },
+ "paymentMethodRequired": {
+ "description": "Optional. Indicates if payment method is required on an order. Defaults to true.",
+ "type": "boolean",
+ "default": true
}
},
"required": ["id", "sourceSystemCustomerId"]
diff --git a/schema/Api/OfferBroker/CreateOfferRequest.json b/schema/Api/OfferBroker/CreateOfferRequest.json
index 7712be2..8728959 100644
--- a/schema/Api/OfferBroker/CreateOfferRequest.json
+++ b/schema/Api/OfferBroker/CreateOfferRequest.json
@@ -51,7 +51,7 @@
"defaultPrice": { "type": ["number", "null"], "format": "double" },
"deliveryScheduleCron": { "type": ["string", "null"] },
"doSuppressShippingAndHandling": { "type": ["boolean", "null"] },
- "fixedOrderQuantities": { "type": ["array", "null"], "items": {"type": "number", "format": "double"} },
+ "fixedOrderQuantities": { "type": ["array", "null"], "items": {"type": "integer", "format": "int32"} },
"fullImageUrl": { "type": ["string", "null"] },
"isActive": { "type": ["boolean", "null"] },
"isAvailableViaCoopFunds": { "type": ["boolean", "null"] },
diff --git a/schema/Api/OfferBroker/GetOfferResponse.json b/schema/Api/OfferBroker/GetOfferResponse.json
index ac13534..cde8bdb 100644
--- a/schema/Api/OfferBroker/GetOfferResponse.json
+++ b/schema/Api/OfferBroker/GetOfferResponse.json
@@ -179,7 +179,7 @@
"surcharge": {"type": "number", "format": "double"},
"thumbnailUrl": { "type": ["string", "null"] },
"unitOfMeasure": { "type": ["string", "null"] },
- "weightInPounds": {"type": "number", "format": "float"}
+ "weightInPounds": {"type": "number", "format": "double"}
},
"required": ["id", "omsOfferId", "number", "offerType", "schemaVersion"]
},
diff --git a/schema/Api/OfferBroker/GetOffersResponse.json b/schema/Api/OfferBroker/GetOffersResponse.json
index 30474b9..fcb877f 100644
--- a/schema/Api/OfferBroker/GetOffersResponse.json
+++ b/schema/Api/OfferBroker/GetOffersResponse.json
@@ -182,7 +182,7 @@
"surcharge": {"type": "number", "format": "double"},
"thumbnailUrl": { "type": ["string", "null"] },
"unitOfMeasure": { "type": ["string", "null"] },
- "weightInPounds": {"type": "number", "format": "float"}
+ "weightInPounds": {"type": "number", "format": "double"}
},
"required": ["id", "omsOfferId", "number", "offerType", "schemaVersion"]
}
diff --git a/schema/Api/OfferBroker/InternalGetOffersResponse.json b/schema/Api/OfferBroker/InternalGetOffersResponse.json
index 8c00cdf..4908faa 100644
--- a/schema/Api/OfferBroker/InternalGetOffersResponse.json
+++ b/schema/Api/OfferBroker/InternalGetOffersResponse.json
@@ -182,7 +182,7 @@
"surcharge": {"type": "number", "format": "double"},
"thumbnailUrl": { "type": ["string", "null"] },
"unitOfMeasure": { "type": ["string", "null"] },
- "weightInPounds": {"type": "number", "format": "float"}
+ "weightInPounds": {"type": "number", "format": "double"}
},
"required": ["id", "omsOfferId", "number", "offerType", "productClusters", "schemaVersion"]
}
diff --git a/schema/Api/OfferBroker/UpdateOfferRequest.json b/schema/Api/OfferBroker/UpdateOfferRequest.json
index ad6b763..23b1206 100644
--- a/schema/Api/OfferBroker/UpdateOfferRequest.json
+++ b/schema/Api/OfferBroker/UpdateOfferRequest.json
@@ -181,7 +181,7 @@
"surcharge": { "type": ["number", "null"], "format": "double" },
"thumbnailUrl": { "type": ["string", "null"] },
"unitOfMeasure": { "type": ["string", "null"] },
- "weightInPounds": { "type": ["number", "null"], "format": "float" }
+ "weightInPounds": { "type": ["number", "null"], "format": "double" }
},
"required": ["number", "offerType"]
}
diff --git a/schema/Api/OrderBroker/GetOrderResponse.json b/schema/Api/OrderBroker/GetOrderResponse.json
index ca2f114..8ddd37d 100644
--- a/schema/Api/OrderBroker/GetOrderResponse.json
+++ b/schema/Api/OrderBroker/GetOrderResponse.json
@@ -9,6 +9,16 @@
"type": ["object", "null"],
"additionalProperties": false,
"properties": {
+ "billingEntityId": {
+ "description": "Billing entity ID tied to order.",
+ "type": ["string", "null"],
+ "maxLength": 100
+ },
+ "customerId": {
+ "description": "Unique customer ID tied to order",
+ "type": ["string", "null"],
+ "maxLength": 100
+ },
"omsCustomerId": {
"description": "Unique customer ID in the order management system (system where order lifecycle will be managed)",
"type": ["string", "null"],
@@ -58,6 +68,10 @@
"type": ["string", "null"],
"maxLength": 255
},
+ "allowPartialShipments": {
+ "description": "Flag indicating whether partial shipments are allowed for this order",
+ "type": ["boolean", "null"]
+ },
"billTos": {
"description": "Bill to addresses array for Order. Required, must not be empty. Each item must have required address fields and a non-null key.",
"oneOf": [
@@ -303,8 +317,7 @@
"productDescription": { "type": ["string", "null"] },
"productLineNumber": {
"description": "Line number reference to the parent offer line item",
- "type": ["string", "null"],
- "pattern": "^[0-9]+$"
+ "type": ["string", "null"]
},
"productNumber": { "type": ["string", "null"] },
"productOwner": { "type": ["string", "null"] },
@@ -405,6 +418,11 @@
}
]
},
+ "packListNotes": {
+ "description": "Notes related to the pack list for the order",
+ "type": ["string", "null"],
+ "maxLength": 1000
+ },
"paymentMethods": {
"description": "Order.ShipTos level payment method details",
"type": ["array", "null"],
@@ -431,6 +449,11 @@
"format": "double",
"minimum": 0
},
+ "picklistNotes": {
+ "description": "Notes related to the picklist for the order",
+ "type": ["string", "null"],
+ "maxLength": 1000
+ },
"poNumber": {
"description": "Purchase order number for Order. Maximum length 20 characters.",
"type": ["string", "null"],
@@ -459,6 +482,11 @@
"comment": { "type": ["string", "null"] },
"costCenter": { "type": ["string", "null"] },
"creditCardFee": { "type": ["number", "null"], "format": "double" },
+ "deliveryNotes": {
+ "description": "Notes related to delivery for this ship to location",
+ "type": ["string", "null"],
+ "maxLength": 1024
+ },
"dueDate": { "type": ["string", "null"] },
"key": {
"description": "Unique ID for individual ship to address",
@@ -526,6 +554,11 @@
"description": "Current status of the ship to location",
"type": ["string", "null"]
},
+ "thirdPartyAccountNumber": {
+ "description": "Third party account number to use for ship method carrier",
+ "type": ["string", "null"],
+ "maxLength": 100
+ },
"totalOrderFee": { "type": ["number", "null"], "format": "double" }
},
"required": ["key"]
@@ -577,7 +610,8 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "productLineId": { "description": "Product line identifier", "type": ["string", "null"] },
+ "offerLineNumber": { "description": "Offer line identifier", "type": ["string", "null"] },
+ "productLineNumber": { "description": "Product line identifier", "type": ["string", "null"] },
"shipQuantity": {
"description": "Quantity shipped",
"type": ["number", "null"],
diff --git a/schema/Api/OrderBroker/InternalGetOrderResponse.json b/schema/Api/OrderBroker/InternalGetOrderResponse.json
index c152cb9..769cec8 100644
--- a/schema/Api/OrderBroker/InternalGetOrderResponse.json
+++ b/schema/Api/OrderBroker/InternalGetOrderResponse.json
@@ -9,6 +9,16 @@
"type": ["object", "null"],
"additionalProperties": false,
"properties": {
+ "billingEntityId": {
+ "description": "Billing entity ID tied to order.",
+ "type": ["string", "null"],
+ "maxLength": 100
+ },
+ "customerId": {
+ "description": "Unique customer ID tied to order",
+ "type": ["string", "null"],
+ "maxLength": 100
+ },
"omsCustomerId": {
"description": "Unique customer ID in the order management system (system where order lifecycle will be managed)",
"type": ["string", "null"],
@@ -58,6 +68,10 @@
"type": ["string", "null"],
"maxLength": 255
},
+ "allowPartialShipments": {
+ "description": "Flag indicating whether partial shipments are allowed for this order",
+ "type": ["boolean", "null"]
+ },
"billTos": {
"description": "Bill to addresses array for Order. Required, must not be empty. Each item must have required address fields and a non-null key.",
"oneOf": [
@@ -303,8 +317,7 @@
"productDescription": { "type": ["string", "null"] },
"productLineNumber": {
"description": "Line number reference to the parent offer line item",
- "type": ["string", "null"],
- "pattern": "^[0-9]+$"
+ "type": ["string", "null"]
},
"productNumber": { "type": ["string", "null"] },
"productOwner": { "type": ["string", "null"] },
@@ -405,6 +418,11 @@
}
]
},
+ "packListNotes": {
+ "description": "Notes related to the pack list for the order",
+ "type": ["string", "null"],
+ "maxLength": 1000
+ },
"paymentMethods": {
"description": "Order.ShipTos level payment method details",
"type": ["array", "null"],
@@ -431,6 +449,11 @@
"format": "double",
"minimum": 0
},
+ "picklistNotes": {
+ "description": "Notes related to the picklist for the order",
+ "type": ["string", "null"],
+ "maxLength": 1000
+ },
"poNumber": {
"description": "Purchase order number for Order. Maximum length 20 characters.",
"type": ["string", "null"],
@@ -459,6 +482,11 @@
"comment": { "type": ["string", "null"] },
"costCenter": { "type": ["string", "null"] },
"creditCardFee": { "type": ["number", "null"], "format": "double" },
+ "deliveryNotes": {
+ "description": "Notes related to delivery for this ship to location",
+ "type": ["string", "null"],
+ "maxLength": 1024
+ },
"dueDate": { "type": ["string", "null"] },
"key": {
"description": "Unique ID for individual ship to address",
@@ -526,6 +554,11 @@
"description": "Current status of the ship to location",
"type": ["string", "null"]
},
+ "thirdPartyAccountNumber": {
+ "description": "Third party account number to use for ship method carrier",
+ "type": ["string", "null"],
+ "maxLength": 100
+ },
"totalOrderFee": { "type": ["number", "null"], "format": "double" }
},
"required": ["key"]
diff --git a/schema/Api/OrderBroker/InternalNewOrderRequest.json b/schema/Api/OrderBroker/InternalNewOrderRequest.json
index f8ff1ce..419ca63 100644
--- a/schema/Api/OrderBroker/InternalNewOrderRequest.json
+++ b/schema/Api/OrderBroker/InternalNewOrderRequest.json
@@ -5,6 +5,11 @@
"type": "object",
"additionalProperties": false,
"properties": {
+ "billingEntityId": {
+ "description": "Billing entity ID tied to order. Billing entity must be tied to customer used for placing order.",
+ "type": ["string", "null"],
+ "maxLength": 100
+ },
"orderId": {
"description": "Unique ID for order within order management system (system where order lifecycle will be managed). Required, must not be null or empty.",
"type": "string",
@@ -35,6 +40,10 @@
"type": ["string", "null"],
"maxLength": 255
},
+ "allowPartialShipments": {
+ "description": "Flag indicating whether partial shipments are allowed for this order.",
+ "type": ["boolean", "null"]
+ },
"billTos": {
"description": "Bill to addresses array for Order. Required, must not be empty. Each item must have required address fields and a non-null key.",
"oneOf": [
@@ -223,8 +232,7 @@
},
"componentLineNumber": {
"description": "Unique ID for component product within parent product",
- "type": ["string", "null"],
- "pattern": "^[0-9]+$"
+ "type": ["string", "null"]
},
"productDescription": {
"description": "Description for component product within product management system (system where ordered line item products will be managed)",
@@ -254,8 +262,7 @@
"productDescription": { "type": ["string", "null"] },
"productLineNumber": {
"description": "Line number reference to the parent offer line item",
- "type": ["string", "null"],
- "pattern": "^[0-9]+$"
+ "type": ["string", "null"]
},
"productNumber": { "type": ["string", "null"] },
"productOwner": { "type": ["string", "null"] },
@@ -339,6 +346,11 @@
}
]
},
+ "packListNotes": {
+ "description": "Notes related to the pack list for the order",
+ "type": ["string", "null"],
+ "maxLength": 1000
+ },
"paymentMethods": {
"description": "Order.ShipTos level payment method details",
"type": ["array", "null"],
@@ -365,6 +377,11 @@
"format": "double",
"minimum": 0
},
+ "picklistNotes": {
+ "description": "Notes related to the picklist for the order",
+ "type": ["string", "null"],
+ "maxLength": 1000
+ },
"poNumber": {
"description": "Purchase order number for Order. Maximum length 20 characters.",
"type": ["string", "null"],
@@ -388,6 +405,11 @@
"comment": { "type": ["string", "null"] },
"costCenter": { "type": ["string", "null"] },
"creditCardFee": { "type": ["number", "null"], "format": "double" },
+ "deliveryNotes": {
+ "description": "Notes related to delivery for this ship to location",
+ "type": ["string", "null"],
+ "maxLength": 1024
+ },
"dueDate": { "type": ["string", "null"] },
"key": {
"description": "Unique ID for individual ship to address",
@@ -443,6 +465,11 @@
},
"shippingCost": { "type": ["number", "null"], "format": "double" },
"shippingHandlingTax": { "type": ["number", "null"], "format": "double" },
+ "thirdPartyAccountNumber": {
+ "description": "Third party account number to use for ship method carrier",
+ "type": ["string", "null"],
+ "maxLength": 100
+ },
"totalOrderFee": { "type": ["number", "null"], "format": "double" }
},
"required": ["key"]
diff --git a/schema/Api/OrderBroker/InternalUpdateOrderRequest.json b/schema/Api/OrderBroker/InternalUpdateOrderRequest.json
index c112044..4c7df5b 100644
--- a/schema/Api/OrderBroker/InternalUpdateOrderRequest.json
+++ b/schema/Api/OrderBroker/InternalUpdateOrderRequest.json
@@ -2,6 +2,7 @@
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "InternalUpdateOrderRequest.json",
"type": "object",
+ "additionalProperties": false,
"properties": {
"billingEntityId": { "description": "Billing entity ID", "type": ["string", "null"] },
"orderId": { "description": "Order ID", "type": ["string", "null"] },
@@ -15,6 +16,10 @@
},
"affiliateIdentifier": { "description": "Affiliate identifier", "type": ["string", "null"] },
"affiliateName": { "description": "Affiliate name", "type": ["string", "null"] },
+ "allowPartialShipments": {
+ "description": "Flag indicating whether partial shipments are allowed for this order",
+ "type": ["boolean", "null"]
+ },
"billTos": {
"description": "Bill to addresses",
"type": ["array", "null"],
@@ -96,11 +101,7 @@
"format": "decimal"
},
"offerDescription": { "description": "Offer description", "type": ["string", "null"] },
- "offerLineNumber": {
- "description": "Offer line number",
- "type": ["string", "null"],
- "pattern": "^[0-9]+$"
- },
+ "offerLineNumber": { "description": "Offer line number", "type": ["string", "null"] },
"offerNumber": { "description": "Offer number", "type": ["string", "null"] },
"orderedByKey": {
"description": "Ordered by key",
@@ -129,11 +130,7 @@
"associatedFileName": { "description": "Associated file name", "type": ["string", "null"] },
"color": { "description": "Color", "type": ["string", "null"] },
"comment": { "description": "Comment", "type": ["string", "null"] },
- "componentLineNumber": {
- "description": "Component line number",
- "type": ["string", "null"],
- "pattern": "^[0-9]+$"
- },
+ "componentLineNumber": { "description": "Component line number", "type": ["string", "null"] },
"productDescription": { "description": "Product description", "type": ["string", "null"] },
"productNumber": { "description": "Product number", "type": ["string", "null"] },
"productOwner": { "description": "Product owner", "type": ["string", "null"] },
@@ -153,11 +150,7 @@
},
"pageCount": { "description": "Page count", "type": ["integer", "null"], "format": "int32" },
"productDescription": { "description": "Product description", "type": ["string", "null"] },
- "productLineNumber": {
- "description": "Product line number",
- "type": ["string", "null"],
- "pattern": "^[0-9]+$"
- },
+ "productLineNumber": { "description": "Product line number", "type": ["string", "null"] },
"productNumber": { "description": "Product number", "type": ["string", "null"] },
"productOwner": { "description": "Product owner", "type": ["string", "null"] },
"quantityOrdered": {
@@ -219,6 +212,11 @@
"type": ["string", "null"],
"maxLength": 20
},
+ "packListNotes": {
+ "description": "Notes related to the pack list for the order",
+ "type": ["string", "null"],
+ "maxLength": 1000
+ },
"paymentMethods": {
"description": "Payment methods",
"type": ["array", "null"],
@@ -239,6 +237,11 @@
"type": ["number", "null"],
"format": "decimal"
},
+ "picklistNotes": {
+ "description": "Notes related to the picklist for the order",
+ "type": ["string", "null"],
+ "maxLength": 1000
+ },
"rushOrder": {"description": "Rush order flag", "type": "boolean"},
"shipTos": {
"description": "Ship to addresses",
@@ -260,6 +263,11 @@
"type": ["number", "null"],
"format": "decimal"
},
+ "deliveryNotes": {
+ "description": "Notes related to delivery for this ship to location",
+ "type": ["string", "null"],
+ "maxLength": 1024
+ },
"dueDate": { "description": "Due date", "type": ["string", "null"] },
"key": {"description": "Ship to key", "type": "string", "pattern": "^[0-9]+$"},
"orderFee": { "description": "Order fee", "type": ["number", "null"], "format": "decimal" },
@@ -316,6 +324,11 @@
"type": ["number", "null"],
"format": "decimal"
},
+ "thirdPartyAccountNumber": {
+ "description": "Third party account number to use for ship method carrier",
+ "type": ["string", "null"],
+ "maxLength": 100
+ },
"totalOrderFee": {
"description": "Total order fee",
"type": ["number", "null"],
diff --git a/schema/Api/OrderBroker/NewOrderRequest.json b/schema/Api/OrderBroker/NewOrderRequest.json
index d8a2580..6a63db3 100644
--- a/schema/Api/OrderBroker/NewOrderRequest.json
+++ b/schema/Api/OrderBroker/NewOrderRequest.json
@@ -34,6 +34,11 @@
],
"additionalProperties": false,
"properties": {
+ "billingEntityId": {
+ "description": "Billing entity ID tied to order. Billing entity must be tied to customer used for placing order.",
+ "type": ["string", "null"],
+ "maxLength": 100
+ },
"orderId": {
"description": "Unique ID for order within order management system (system where order lifecycle will be managed). Required, must not be null or empty.",
"type": "string",
@@ -52,6 +57,10 @@
"type": ["string", "null"],
"maxLength": 255
},
+ "allowPartialShipments": {
+ "description": "Flag indicating whether partial shipments are allowed for this order",
+ "type": ["boolean", "null"]
+ },
"billTos": {
"description": "Bill to addresses array for Order. Required, must not be empty. Each item must have required address fields and a non-null key.",
"oneOf": [
@@ -240,8 +249,7 @@
},
"componentLineNumber": {
"description": "Unique ID for component product within parent product",
- "type": ["string", "null"],
- "pattern": "^[0-9]+$"
+ "type": ["string", "null"]
},
"productDescription": {
"description": "Description for component product within product management system (system where ordered line item products will be managed)",
@@ -271,8 +279,7 @@
"productDescription": { "type": ["string", "null"] },
"productLineNumber": {
"description": "Line number reference to the parent offer line item",
- "type": ["string", "null"],
- "pattern": "^[0-9]+$"
+ "type": ["string", "null"]
},
"productNumber": { "type": ["string", "null"] },
"productOwner": { "type": ["string", "null"] },
@@ -356,6 +363,11 @@
}
]
},
+ "packListNotes": {
+ "description": "Notes related to the pack list for the order",
+ "type": ["string", "null"],
+ "maxLength": 1000
+ },
"paymentMethods": {
"description": "Order.ShipTos level payment method details",
"type": ["array", "null"],
@@ -382,6 +394,11 @@
"format": "double",
"minimum": 0
},
+ "picklistNotes": {
+ "description": "Notes related to the picklist for the order",
+ "type": ["string", "null"],
+ "maxLength": 1000
+ },
"poNumber": {
"description": "Purchase order number for Order. Maximum length 20 characters.",
"type": ["string", "null"],
@@ -405,6 +422,11 @@
"comment": { "type": ["string", "null"] },
"costCenter": { "type": ["string", "null"] },
"creditCardFee": { "type": ["number", "null"], "format": "double" },
+ "deliveryNotes": {
+ "description": "Notes related to delivery for this ship to location",
+ "type": ["string", "null"],
+ "maxLength": 1024
+ },
"dueDate": { "type": ["string", "null"] },
"key": {
"description": "Unique ID for individual ship to address",
@@ -460,6 +482,11 @@
},
"shippingCost": { "type": ["number", "null"], "format": "double" },
"shippingHandlingTax": { "type": ["number", "null"], "format": "double" },
+ "thirdPartyAccountNumber": {
+ "description": "Third party account number to use for ship method carrier",
+ "type": ["string", "null"],
+ "maxLength": 100
+ },
"totalOrderFee": { "type": ["number", "null"], "format": "double" }
},
"required": ["key"]
diff --git a/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json b/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json
index e8d89f4..6642d99 100644
--- a/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json
+++ b/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json
@@ -2,6 +2,7 @@
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "UpdateFulfillmentOrderRequest.json",
"type": "object",
+ "additionalProperties": false,
"properties": {
"customerId": { "type": ["string", "null"] },
"fulfillmentOrderId": {"type": "string"},
@@ -10,6 +11,10 @@
"fulfillmentSystemLocationId": { "type": ["string", "null"] },
"fulfillmentSystemOrderId": { "type": ["string", "null"] },
"referenceId": { "type": ["string", "null"] },
+ "allowPartialShipments": {
+ "description": "Flag indicating whether partial shipments are allowed for this fulfillment order",
+ "type": ["boolean", "null"]
+ },
"billTo": {
"description": "Bill to addresses array for Order",
"oneOf": [
@@ -48,6 +53,10 @@
"dueDate": { "type": ["string", "null"] },
"orderIds": { "type": ["array", "null"], "items": {"type": "string"} },
"orderVariables": { "type": ["string", "null"] },
+ "packListNotes": {
+ "description": "Notes related to the pack list for the order",
+ "type": ["string", "null"]
+ },
"paymentMethods": {
"type": ["array", "null"],
"items": {
@@ -66,6 +75,10 @@
"required": ["amount", "methodName"]
}
},
+ "picklistNotes": {
+ "description": "Notes related to the picklist for the order",
+ "type": ["string", "null"]
+ },
"poNumber": { "type": ["string", "null"] },
"products": {
"type": ["array", "null"],
@@ -100,6 +113,10 @@
"fulfillmentSystemShippingMethodId": { "type": ["string", "null"] },
"referenceId": { "type": ["string", "null"] },
"comment": { "type": ["string", "null"] },
+ "deliveryNotes": {
+ "description": "Notes related to delivery for this ship to location",
+ "type": ["string", "null"]
+ },
"dueDate": { "type": ["string", "null"] },
"key": {
"description": "Unique identifier for the ship to address",
@@ -152,7 +169,11 @@
"shippingCarrier": { "type": ["string", "null"] },
"shippingCost": { "type": ["number", "null"], "format": "double" },
"shippingService": { "type": ["string", "null"] },
- "status": { "type": ["string", "null"] }
+ "status": { "type": ["string", "null"] },
+ "thirdPartyAccountNumber": {
+ "description": "Third party account number to use for ship method carrier",
+ "type": ["string", "null"]
+ }
},
"required": ["key", "fulfillmentSystemShippingMethodId", "shipToAddress"]
}
diff --git a/schema/Api/OrderBroker/UpdateOrderRequest.json b/schema/Api/OrderBroker/UpdateOrderRequest.json
index 7a0971d..528de31 100644
--- a/schema/Api/OrderBroker/UpdateOrderRequest.json
+++ b/schema/Api/OrderBroker/UpdateOrderRequest.json
@@ -2,6 +2,7 @@
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "UpdateOrderRequest.json",
"type": "object",
+ "additionalProperties": false,
"properties": {
"billingEntityId": { "description": "Billing entity ID", "type": ["string", "null"] },
"orderId": { "description": "Order ID", "type": ["string", "null"] },
@@ -15,6 +16,10 @@
},
"affiliateIdentifier": { "description": "Affiliate identifier", "type": ["string", "null"] },
"affiliateName": { "description": "Affiliate name", "type": ["string", "null"] },
+ "allowPartialShipments": {
+ "description": "Flag indicating whether partial shipments are allowed for this order",
+ "type": ["boolean", "null"]
+ },
"billTos": {
"description": "Bill to addresses",
"type": ["array", "null"],
@@ -96,11 +101,7 @@
"format": "decimal"
},
"offerDescription": { "description": "Offer description", "type": ["string", "null"] },
- "offerLineNumber": {
- "description": "Offer line number",
- "type": ["string", "null"],
- "pattern": "^[0-9]+$"
- },
+ "offerLineNumber": { "description": "Offer line number", "type": ["string", "null"] },
"offerNumber": { "description": "Offer number", "type": ["string", "null"] },
"orderedByKey": {
"description": "Ordered by key",
@@ -129,11 +130,7 @@
"associatedFileName": { "description": "Component associated file name", "type": ["string", "null"] },
"color": { "description": "Component color", "type": ["string", "null"] },
"comment": { "description": "Component comment", "type": ["string", "null"] },
- "componentLineNumber": {
- "description": "Component line number",
- "type": ["string", "null"],
- "pattern": "^[0-9]+$"
- },
+ "componentLineNumber": { "description": "Component line number", "type": ["string", "null"] },
"productDescription": { "description": "Component product description", "type": ["string", "null"] },
"productNumber": { "description": "Component product number", "type": ["string", "null"] },
"productOwner": { "description": "Component product owner", "type": ["string", "null"] },
@@ -153,11 +150,7 @@
},
"pageCount": { "description": "Page count", "type": ["integer", "null"], "format": "int32" },
"productDescription": { "description": "Product description", "type": ["string", "null"] },
- "productLineNumber": {
- "description": "Product line number",
- "type": ["string", "null"],
- "pattern": "^[0-9]+$"
- },
+ "productLineNumber": { "description": "Product line number", "type": ["string", "null"] },
"productNumber": { "description": "Product number", "type": ["string", "null"] },
"productOwner": { "description": "Product owner", "type": ["string", "null"] },
"quantityOrdered": {
@@ -211,10 +204,10 @@
"required": ["key"]
}
},
- "pONumber": {
- "description": "Purchase order number",
+ "packListNotes": {
+ "description": "Notes related to the pack list for the order",
"type": ["string", "null"],
- "maxLength": 20
+ "maxLength": 1000
},
"paymentMethods": {
"description": "Payment methods",
@@ -236,6 +229,16 @@
"type": ["number", "null"],
"format": "decimal"
},
+ "picklistNotes": {
+ "description": "Notes related to the picklist for the order",
+ "type": ["string", "null"],
+ "maxLength": 1000
+ },
+ "poNumber": {
+ "description": "Purchase order number",
+ "type": ["string", "null"],
+ "maxLength": 20
+ },
"rushOrder": {"description": "Rush order flag", "type": "boolean"},
"shipTos": {
"description": "Ship to addresses",
@@ -257,10 +260,14 @@
"type": ["number", "null"],
"format": "decimal"
},
+ "deliveryNotes": {
+ "description": "Notes related to delivery for this ship to location",
+ "type": ["string", "null"],
+ "maxLength": 1024
+ },
"dueDate": { "description": "Due date", "type": ["string", "null"] },
"key": {"description": "Ship to key", "type": "string", "pattern": "^[0-9]+$"},
"orderFee": { "description": "Order fee", "type": ["number", "null"], "format": "decimal" },
- "pONumber": { "description": "Purchase order number", "type": ["string", "null"] },
"paymentMethods": {
"description": "Payment methods",
"type": ["array", "null"],
@@ -281,6 +288,7 @@
"type": ["number", "null"],
"format": "decimal"
},
+ "poNumber": { "description": "Purchase order number", "type": ["string", "null"] },
"rushFee": { "description": "Rush fee", "type": ["number", "null"], "format": "decimal" },
"rushOrder": { "description": "Rush order flag", "type": ["boolean", "null"] },
"shipToAddress": {
@@ -312,6 +320,11 @@
"type": ["number", "null"],
"format": "decimal"
},
+ "thirdPartyAccountNumber": {
+ "description": "Third party account number to use for ship method carrier",
+ "type": ["string", "null"],
+ "maxLength": 100
+ },
"totalOrderFee": {
"description": "Total order fee",
"type": ["number", "null"],
diff --git a/schema/Api/ProductBroker/GetProductInventoryParameters.json b/schema/Api/ProductBroker/GetProductInventoryParameters.json
index ea7249f..00b7c44 100644
--- a/schema/Api/ProductBroker/GetProductInventoryParameters.json
+++ b/schema/Api/ProductBroker/GetProductInventoryParameters.json
@@ -7,10 +7,5 @@
"schema": {"type": "string"},
"required": false
},
- "productId": {
- "in": "path",
- "name": "productId",
- "schema": {"type": "string"},
- "required": true
- }
+ "productIds": { "in": "query", "name": "productIds", "schema": {"type": "string"} }
}
diff --git a/schema/Api/ProductBroker/GetProductInventoryResponse.json b/schema/Api/ProductBroker/GetProductInventoryResponse.json
index 3aefd47..bd3a686 100644
--- a/schema/Api/ProductBroker/GetProductInventoryResponse.json
+++ b/schema/Api/ProductBroker/GetProductInventoryResponse.json
@@ -5,47 +5,50 @@
"additionalProperties": false,
"properties": {
"data": {
- "type": ["object", "null"],
- "additionalProperties": false,
- "properties": {
- "billingEntityId": {
- "description": "Billing entity ID associated with the product inventory",
- "type": "string"
+ "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"
+ }
},
- "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"
- ]
+ "required": [
+ "productId", "currentOnHandQty", "currentAvailableQty", "reserved",
+ "billingEntityId"
+ ]
+ }
},
"failureMessages": { "type": "array", "items": {"type": "string"} },
"informationalMessages": { "type": "array", "items": {"type": "string"} },
diff --git a/schema/Event/FulfillmentOrder/FulfillmentOrder.json b/schema/Event/FulfillmentOrder/FulfillmentOrder.json
index ec7e68a..0885d83 100644
--- a/schema/Event/FulfillmentOrder/FulfillmentOrder.json
+++ b/schema/Event/FulfillmentOrder/FulfillmentOrder.json
@@ -3,6 +3,7 @@
"$id": "FulfillmentOrder.json",
"description": "Details for Fulfillment Order JSON schema",
"type": "object",
+ "additionalProperties": false,
"title": "FulfillmentOrder",
"properties": {
"CustomerId": {
@@ -35,7 +36,7 @@
"type": ["string", "null"]
},
"AllowPartialShipments": {
- "description": "Whether partial shipments are allowed",
+ "description": "Flag indicating whether partial shipments are allowed for this fulfillment order",
"type": ["boolean", "null"]
},
"BillTo": {
@@ -85,6 +86,10 @@
"description": "PO number tied to the fulfillment order",
"type": ["string", "null"]
},
+ "PackListNotes": {
+ "description": "Notes related to the pack list for the order",
+ "type": ["string", "null"]
+ },
"PaymentMethods": {
"description": "PaymentMethod details",
"type": ["array", "null"],
@@ -96,6 +101,10 @@
}
}
},
+ "PicklistNotes": {
+ "description": "Notes related to the picklist for the order",
+ "type": ["string", "null"]
+ },
"Products": {
"description": "Fulfillment order level product details",
"type": ["array", "null"],
@@ -133,6 +142,10 @@
},
"ReferenceId": { "description": "Reference ID", "type": ["string", "null"] },
"Comment": { "description": "Comment", "type": ["string", "null"] },
+ "DeliveryNotes": {
+ "description": "Notes related to delivery for this ship to location",
+ "type": ["string", "null"]
+ },
"DueDate": { "description": "Due date", "type": ["string", "null"] },
"IsDeleted": { "description": "Whether the ship to is deleted", "type": ["boolean", "null"] },
"Key": {"description": "Key for the ship to", "type": "string"},
@@ -178,7 +191,11 @@
"ShippingCarrier": { "description": "Shipping carrier", "type": ["string", "null"] },
"ShippingCost": { "description": "Shipping cost", "type": ["number", "null"] },
"ShippingService": { "description": "Shipping service", "type": ["string", "null"] },
- "Status": { "description": "Status", "type": ["string", "null"] }
+ "Status": { "description": "Status", "type": ["string", "null"] },
+ "ThirdPartyAccountNumber": {
+ "description": "Third party account number to use for ship method carrier",
+ "type": ["string", "null"]
+ }
},
"required": ["Key"]
}
diff --git a/schema/Event/FulfillmentOrder/FulfillmentOrderEvent.json b/schema/Event/FulfillmentOrder/FulfillmentOrderEvent.json
index b80f318..466a807 100644
--- a/schema/Event/FulfillmentOrder/FulfillmentOrderEvent.json
+++ b/schema/Event/FulfillmentOrder/FulfillmentOrderEvent.json
@@ -4,15 +4,10 @@
"description": "FulfillmentOrderEvent schema",
"type": "object",
"allOf": [
- {"$ref": "../../Common/EventBase.json"},
{
"type": "object",
"properties": {
- "EventSchemaVersion": {
- "description": "Version of event schema being used",
- "type": "string",
- "enum": ["0.1", "0.2"]
- },
+ "EventSchemaVersion": {"description": "Version of event schema being used", "type": "string"},
"FulfillmentOrder": {"$ref": "FulfillmentOrder.json"}
},
"required": ["FulfillmentOrder"]
@@ -20,16 +15,67 @@
{
"type": "object",
"properties": {
+ "AggregateId": {
+ "description": "Unique ID for aggregate type within Suite of Brokers",
+ "type": "string"
+ },
+ "CorrelationId": {"description": "Unique ID for SOB-external event trigger", "type": "string"},
+ "AggregateType": {"description": "Type of event schema", "type": "string"},
+ "EventActionUser": {
+ "description": "Username of user who triggered event",
+ "type": ["string", "null"]
+ },
+ "EventDateTimeUtc": {
+ "description": "UTC based datetime of when event was triggered",
+ "type": "string"
+ },
"EventName": {
"description": "Name of triggered event for FulfillmentOrder",
"type": "string",
"enum": [
- "FulfillmentOrder Created", "FulfillmentOrder Updated",
- "FulfillmentOrder Status Changed", "FulfillmentOrder View Updated",
- "FulfillmentOrder View Refreshed"
+ "Fulfillment Order Created", "Fulfillment Order Updated",
+ "Fulfillment Order Submitted to Fulfillment System",
+ "Fulfillment Order Submission Failed",
+ "Fulfillment Order Update Validation Failed",
+ "Fulfillment Order Update Request Validated",
+ "Update Failed to Submit to Fulfillment System"
]
+ },
+ "EventNameValuePairs": {
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "Name" : { "description": "Name of the name-value pair" , "type": ["string", "null"] },
+ "Value": { "description": "Value of the name-value pair", "type": ["string", "null"] }
+ }
+ }
+ },
+ "EventPublisherApp": {
+ "description": "Name of source application that published event",
+ "type": "string"
+ },
+ "EventSchemaVersion": {"description": "Version of event schema being used", "type": "string"},
+ "EventSource": {"description": "Name of system where event was triggered", "type": "string"}
+ },
+ "required": [
+ "AggregateId", "AggregateType", "CorrelationId", "EventDateTimeUtc", "EventName",
+ "EventPublisherApp", "EventSchemaVersion", "EventSource"
+ ],
+ "examples": [
+ {
+ "AggregateId": "6-mzvanhki-4-C-5606-0046-03",
+ "CorrelationId": "282so37c-sac5-77s3-1ow7-74u10g0386cq",
+ "AggregateType": "Order",
+ "EventActionUser": null,
+ "EventDateTimeUtc": "2024-11-22T22:16:00.263",
+ "EventName": "Fulfillment Order Updated",
+ "EventNameValuePairs": null,
+ "EventPublisherApp": "VeraCore Order Event Publisher",
+ "EventSchemaVersion": "1.6.1",
+ "EventSource": "VeraCore"
}
- }
+ ]
}
]
}
diff --git a/schema/Event/Order/Order.json b/schema/Event/Order/Order.json
index 1b40c70..42aadee 100644
--- a/schema/Event/Order/Order.json
+++ b/schema/Event/Order/Order.json
@@ -3,6 +3,7 @@
"$id": "Order.json",
"description": "Order level line item details",
"type": "object",
+ "additionalProperties": false,
"properties": {
"BillingEntityId": { "description": "Billing entity ID", "type": ["string", "null"] },
"CustomerId": {
@@ -28,7 +29,7 @@
"AffiliateIdentifier": { "description": "Affiliate identifier", "type": ["string", "null"] },
"AffiliateName": { "description": "Affiliate name", "type": ["string", "null"] },
"AllowPartialShipments": {
- "description": "Whether partial shipments are allowed for this order",
+ "description": "Flag indicating whether partial shipments are allowed for this order",
"type": ["boolean", "null"]
},
"BillTos": {
@@ -286,6 +287,10 @@
}
},
"PONumber": { "description": "PO number", "type": ["string", "null"] },
+ "PackListNotes": {
+ "description": "Notes related to the pack list for the order",
+ "type": ["string", "null"]
+ },
"PaymentMethods": {
"description": "Payment methods",
"type": ["array", "null"],
@@ -302,6 +307,10 @@
}
},
"PickPackHandlingFee": { "description": "Pick pack handling fee", "type": ["number", "null"] },
+ "PicklistNotes": {
+ "description": "Notes related to the picklist for the order",
+ "type": ["string", "null"]
+ },
"PriceClasses": {
"description": "Price classes",
"type": ["array", "null"],
@@ -325,6 +334,10 @@
"Comment": { "description": "Comment", "type": ["string", "null"] },
"CostCenter": { "description": "Cost center", "type": ["string", "null"] },
"CreditCardFee": { "description": "Credit card fee", "type": ["number", "null"] },
+ "DeliveryNotes": {
+ "description": "Notes related to delivery for this ship to location",
+ "type": ["string", "null"]
+ },
"DueDate": { "description": "Due date", "type": ["string", "null"] },
"Key": { "description": "Key for the ship to", "type": ["string", "null"] },
"OrderFee": { "description": "Order fee", "type": ["number", "null"] },
@@ -380,6 +393,10 @@
"ShippingHandlingTax": { "description": "Shipping handling tax", "type": ["number", "null"] },
"ShippingService": { "description": "Shipping service", "type": ["string", "null"] },
"Status": { "description": "Ship to status", "type": ["string", "null"] },
+ "ThirdPartyAccountNumber": {
+ "description": "Third party account number to use for ship method carrier",
+ "type": ["string", "null"]
+ },
"TotalOrderFee": { "description": "Total order fee", "type": ["number", "null"] }
}
}
@@ -414,8 +431,10 @@
"items": {
"type": "object",
"properties": {
- "ProductLineId": { "description": "Product line ID", "type": ["string", "null"] },
- "ShipQuantity" : { "description": "Ship quantity" , "type": ["number", "null"] }
+ "ProductLineId" : { "description": "Product line ID" , "type": ["string", "null"] },
+ "OfferLineNumber" : { "description": "Offer Line Number" , "type": ["string", "null"] },
+ "ProductLineNumber": { "description": "Product Line Number", "type": ["string", "null"] },
+ "ShipQuantity" : { "description": "Ship quantity" , "type": ["number", "null"] }
}
}
},
diff --git a/schema/Event/Order/OrderEvent.json b/schema/Event/Order/OrderEvent.json
index ac72cf0..7870622 100644
--- a/schema/Event/Order/OrderEvent.json
+++ b/schema/Event/Order/OrderEvent.json
@@ -4,7 +4,6 @@
"description": "OrderEvent schema",
"type": "object",
"allOf": [
- {"$ref": "../../Common/EventBase.json"},
{
"type": "object",
"properties": { "Order": {"$ref": "Order.json"} },
@@ -13,6 +12,20 @@
{
"type": "object",
"properties": {
+ "AggregateId": {
+ "description": "Unique ID for aggregate type within Suite of Brokers",
+ "type": "string"
+ },
+ "CorrelationId": {"description": "Unique ID for SOB-external event trigger", "type": "string"},
+ "AggregateType": {"description": "Type of event schema", "type": "string"},
+ "EventActionUser": {
+ "description": "Username of user who triggered event",
+ "type": ["string", "null"]
+ },
+ "EventDateTimeUtc": {
+ "description": "UTC based datetime of when event was triggered",
+ "type": "string"
+ },
"EventName": {
"description": "Name of triggered event for Order",
"type": "string",
@@ -22,12 +35,47 @@
"Order Validated", "Order Validation Failed", "Fulfillment Order Created",
"Order Submitted to Fulfillment System",
"Order Failed to Submit to Fulfillment System", "Order Update Requested",
- "Order Update Request Validated", "Order Update Request Validation Failed",
+ "Update Request Validated", "Update Request Validation Failed",
"Fulfillment Order Creation Failed",
- "Update Failed Fulfillment System Validation"
+ "Update Failed Fulfillment System Validation",
+ "Update Failed to Submit to Fulfillment System"
]
+ },
+ "EventNameValuePairs": {
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "Name" : { "description": "Name of the name-value pair" , "type": ["string", "null"] },
+ "Value": { "description": "Value of the name-value pair", "type": ["string", "null"] }
+ }
+ }
+ },
+ "EventPublisherApp": {
+ "description": "Name of source application that published event",
+ "type": "string"
+ },
+ "EventSchemaVersion": {"description": "Version of event schema being used", "type": "string"},
+ "EventSource": {"description": "Name of system where event was triggered", "type": "string"}
+ },
+ "required": [
+ "AggregateId", "AggregateType", "CorrelationId", "EventDateTimeUtc", "EventName",
+ "EventPublisherApp", "EventSchemaVersion", "EventSource"
+ ],
+ "examples": [
+ {
+ "AggregateId": "6-mzvanhki-4-C-5606-0046-03",
+ "CorrelationId": "282so37c-sac5-77s3-1ow7-74u10g0386cq",
+ "AggregateType": "Order",
+ "EventActionUser": null,
+ "EventDateTimeUtc": "2024-11-22T22:16:00.263",
+ "EventName": "Order Updated",
+ "EventNameValuePairs": null,
+ "EventPublisherApp": "VeraCore Order Event Publisher",
+ "EventSchemaVersion": "1.6.1",
+ "EventSource": "VeraCore"
}
- }
+ ]
}
],
"examples": [
diff --git a/schema/Event/OrderView/OrderViewEvent.json b/schema/Event/OrderView/OrderViewEvent.json
index 7137ba1..4f84332 100644
--- a/schema/Event/OrderView/OrderViewEvent.json
+++ b/schema/Event/OrderView/OrderViewEvent.json
@@ -25,7 +25,7 @@
"AffiliateIdentifier": { "description": "Affiliate identifier", "type": ["string", "null"] },
"AffiliateName": { "description": "Affiliate name", "type": ["string", "null"] },
"AllowPartialShipments": {
- "description": "Whether partial shipments are allowed",
+ "description": "Flag indicating whether partial shipments are allowed for this order",
"type": ["boolean", "null"]
},
"BillTos": {
@@ -352,6 +352,10 @@
"ShippingHandlingTax": { "description": "Shipping handling tax", "type": ["number", "null"] },
"ShippingService": { "description": "Shipping service", "type": ["string", "null"] },
"Status": { "description": "Status", "type": ["string", "null"] },
+ "ThirdPartyAccountNumber": {
+ "description": "Third party account number to use for ship method carrier",
+ "type": ["string", "null"]
+ },
"TotalOrderFee": { "description": "Total order fee", "type": ["number", "null"] }
}
}
@@ -386,8 +390,10 @@
"items": {
"type": "object",
"properties": {
- "ProductLineId": { "description": "Product line ID", "type": ["string", "null"] },
- "ShipQuantity" : { "description": "Ship quantity" , "type": ["number", "null"] }
+ "ProductLineId" : { "description": "Product line ID" , "type": ["string", "null"] },
+ "OfferLineNumber" : { "description": "Offer line number" , "type": ["string", "null"] },
+ "ProductLineNumber": { "description": "Product line number", "type": ["string", "null"] },
+ "ShipQuantity" : { "description": "Ship quantity" , "type": ["number", "null"] }
}
}
},