Schema Changes - 2025-04-29
This document contains the changes to the schema files compared to the main branch.
Changes
diff --git a/schema/Api/CustomerBroker/GetCustomersResponse.json b/schema/Api/CustomerBroker/GetCustomersResponse.json
index 0f66d84..399632d 100644
--- a/schema/Api/CustomerBroker/GetCustomersResponse.json
+++ b/schema/Api/CustomerBroker/GetCustomersResponse.json
@@ -24,19 +24,19 @@
{
"data": [
{
- "Id": "CUST-002",
- "ParentId": null,
- "Name": "Customer 2"
+ "id": "CUST-002",
+ "parentId": null,
+ "name": "Customer 2"
},
{
- "Id": "CUST-007",
- "ParentId": "CUST-023",
- "Name": "Customer 7"
+ "id": "CUST-007",
+ "parentId": "CUST-023",
+ "name": "Customer 7"
},
{
- "Id": "CUST-008",
- "ParentId": "CUST-019",
- "Name": "Customer 8"
+ "id": "CUST-008",
+ "parentId": "CUST-019",
+ "name": "Customer 8"
}
],
"failureMessages": [],
diff --git a/schema/Api/CustomerBroker/parts/ContactAddress.json b/schema/Api/CustomerBroker/parts/ContactAddress.json
index 4ddd9bc..7e95518 100644
--- a/schema/Api/CustomerBroker/parts/ContactAddress.json
+++ b/schema/Api/CustomerBroker/parts/ContactAddress.json
@@ -4,73 +4,73 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "Address1": {
+ "address1": {
"type": [
"string",
"null"
]
},
- "Address2": {
+ "address2": {
"type": [
"string",
"null"
]
},
- "Address3": {
+ "address3": {
"type": [
"string",
"null"
]
},
- "AddressType": {
+ "addressType": {
"type": [
"string",
"null"
]
},
- "City": {
+ "city": {
"type": [
"string",
"null"
]
},
- "Company": {
+ "company": {
"type": [
"string",
"null"
]
},
- "Country": {
+ "country": {
"type": [
"string",
"null"
]
},
- "FaxNumber": {
+ "faxNumber": {
"type": [
"string",
"null"
]
},
- "Name": {
+ "name": {
"type": [
"string",
"null"
]
},
- "PhoneNumber": {
+ "phoneNumber": {
"type": [
"string",
"null"
]
},
- "PostalCode": {
+ "postalCode": {
"type": [
"string",
"null"
]
},
- "StateProvince": {
+ "stateProvince": {
"type": [
"string",
"null"
@@ -78,7 +78,7 @@
}
},
"required": [
- "Address1",
- "AddressType"
+ "address1",
+ "addressType"
]
}
diff --git a/schema/Api/CustomerBroker/parts/Customer.json b/schema/Api/CustomerBroker/parts/Customer.json
index 6aebcce..9db842e 100644
--- a/schema/Api/CustomerBroker/parts/Customer.json
+++ b/schema/Api/CustomerBroker/parts/Customer.json
@@ -4,16 +4,16 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "DefaultWarehouseId": {
+ "defaultWarehouseId": {
"type": [
"string",
"null"
]
},
- "Id": {
+ "id": {
"type": "string"
},
- "BrokerScopes": {
+ "brokerScopes": {
"type": [
"array",
"null"
@@ -22,22 +22,22 @@
"type": "string"
}
},
- "ClientSecret": {
+ "clientSecret": {
"type": [
"string",
"null"
]
},
- "ContactAddress": {
+ "contactAddress": {
"$ref": "ContactAddress.json"
},
- "ContactEmailAddress": {
+ "contactEmailAddress": {
"type": [
"string",
"null"
]
},
- "EmailNotificationSubscriptions": {
+ "emailNotificationSubscriptions": {
"type": [
"array",
"null"
@@ -46,49 +46,49 @@
"$ref": "EmailNotificationSubscription.json"
}
},
- "InvoiceEmailAddress": {
+ "invoiceEmailAddress": {
"type": [
"string",
"null"
]
},
- "Name": {
+ "name": {
"type": "string"
},
- "ParentCustomer": {
+ "parentCustomer": {
"$ref": "ParentCustomer.json"
},
- "Partner": {
+ "partner": {
"type": [
"string",
"null"
]
},
- "PaymentEmailAddress": {
+ "paymentEmailAddress": {
"type": [
"string",
"null"
]
},
- "PhoneNumber": {
+ "phoneNumber": {
"type": [
"string",
"null"
]
},
- "ProductionFileLocation": {
+ "productionFileLocation": {
"type": [
"string",
"null"
]
},
- "SalesRep": {
+ "salesRep": {
"type": [
"string",
"null"
]
},
- "ShipMethodMappings": {
+ "shipMethodMappings": {
"type": [
"array",
"null"
@@ -97,13 +97,22 @@
"$ref": "ShipMethodMapping.json"
}
},
- "Subsidiary": {
+ "sourceSystems": {
+ "type": [
+ "array",
+ "null"
+ ],
+ "items": {
+ "$ref": "SourceSystem.json"
+ }
+ },
+ "subsidiary": {
"type": [
"string",
"null"
]
},
- "Website": {
+ "website": {
"type": [
"string",
"null"
@@ -111,7 +120,7 @@
}
},
"required": [
- "Id",
- "Name"
+ "id",
+ "name"
]
}
diff --git a/schema/Api/CustomerBroker/parts/CustomerId.json b/schema/Api/CustomerBroker/parts/CustomerId.json
index 9ede500..9f81582 100644
--- a/schema/Api/CustomerBroker/parts/CustomerId.json
+++ b/schema/Api/CustomerBroker/parts/CustomerId.json
@@ -4,7 +4,7 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "CustomerId": {
+ "customerId": {
"type": [
"string",
"null"
diff --git a/schema/Api/CustomerBroker/parts/CustomersList.json b/schema/Api/CustomerBroker/parts/CustomersList.json
index b9221b5..4b81e3e 100644
--- a/schema/Api/CustomerBroker/parts/CustomersList.json
+++ b/schema/Api/CustomerBroker/parts/CustomersList.json
@@ -4,19 +4,19 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "Id": {
+ "id": {
"type": [
"string",
"null"
]
},
- "ParentId": {
+ "parentId": {
"type": [
"string",
"null"
]
},
- "Name": {
+ "name": {
"type": [
"string",
"null"
diff --git a/schema/Api/CustomerBroker/parts/EmailNotificationSubscription.json b/schema/Api/CustomerBroker/parts/EmailNotificationSubscription.json
index c43de73..d75fc8d 100644
--- a/schema/Api/CustomerBroker/parts/EmailNotificationSubscription.json
+++ b/schema/Api/CustomerBroker/parts/EmailNotificationSubscription.json
@@ -4,10 +4,10 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "EmailNotificationTemplateId": {
+ "emailNotificationTemplateId": {
"type": "string"
},
- "EmailAddresses": {
+ "emailAddresses": {
"type": [
"array",
"null"
@@ -18,6 +18,6 @@
}
},
"required": [
- "EmailNotificationTemplateId"
+ "emailNotificationTemplateId"
]
}
diff --git a/schema/Api/CustomerBroker/parts/FulfillmentSystemShipMethod.json b/schema/Api/CustomerBroker/parts/FulfillmentSystemShipMethod.json
index 3998f9b..f2ee70a 100644
--- a/schema/Api/CustomerBroker/parts/FulfillmentSystemShipMethod.json
+++ b/schema/Api/CustomerBroker/parts/FulfillmentSystemShipMethod.json
@@ -4,14 +4,14 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "FulfillmentSystemId": {
+ "fulfillmentSystemId": {
"type": "integer",
"format": "int32"
},
- "FulfillmentSystemShipMethodId": {
+ "fulfillmentSystemShipMethodId": {
"type": "string"
},
- "FulfillmentSystemName": {
+ "fulfillmentSystemName": {
"type": [
"string",
"null"
@@ -19,7 +19,7 @@
}
},
"required": [
- "FulfillmentSystemId",
- "FulfillmentSystemShipMethodId"
+ "fulfillmentSystemId",
+ "fulfillmentSystemShipMethodId"
]
}
diff --git a/schema/Api/CustomerBroker/parts/ParentCustomer.json b/schema/Api/CustomerBroker/parts/ParentCustomer.json
index 0463a70..04ce03b 100644
--- a/schema/Api/CustomerBroker/parts/ParentCustomer.json
+++ b/schema/Api/CustomerBroker/parts/ParentCustomer.json
@@ -4,10 +4,10 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "Id": {
+ "id": {
"type": "string"
},
- "Name": {
+ "name": {
"type": [
"string",
"null"
@@ -15,6 +15,6 @@
}
},
"required": [
- "Id"
+ "id"
]
}
diff --git a/schema/Api/CustomerBroker/parts/ShipMethodMapping.json b/schema/Api/CustomerBroker/parts/ShipMethodMapping.json
index 949a7a5..064e9c6 100644
--- a/schema/Api/CustomerBroker/parts/ShipMethodMapping.json
+++ b/schema/Api/CustomerBroker/parts/ShipMethodMapping.json
@@ -4,16 +4,16 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "RatesProviderShipMethodId": {
+ "ratesProviderShipMethodId": {
"type": [
"string",
"null"
]
},
- "SourceSystemShipMethodId": {
+ "sourceSystemShipMethodId": {
"type": "string"
},
- "FulfillmentSystemShipMethods": {
+ "fulfillmentSystemShipMethods": {
"type": [
"array",
"null"
@@ -24,6 +24,6 @@
}
},
"required": [
- "SourceSystemShipMethodId"
+ "sourceSystemShipMethodId"
]
}
diff --git a/schema/Api/IdentityBroker/GetCustomerTokenRequest.json b/schema/Api/IdentityBroker/GetCustomerTokenRequest.json
index 6aea7ab..413086b 100644
--- a/schema/Api/IdentityBroker/GetCustomerTokenRequest.json
+++ b/schema/Api/IdentityBroker/GetCustomerTokenRequest.json
@@ -4,21 +4,21 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "SourceSystemId": {
- "type": "integer",
- "format": "int32"
+ "clientName": {
+ "type": "string"
},
- "ClientName": {
- "type": [
- "string",
- "null"
- ]
- },
- "Password": {
- "type": [
- "string",
- "null"
- ]
+ "password": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "clientName",
+ "password"
+ ],
+ "examples": [
+ {
+ "clientName": "Tliw1cu7ad6qbrpBncV1aCoFhQUqVMYn",
+ "password": "l0RHIXhw50egq65DkO3YpawB999UOw1VRgsIlaw8LZQKdS3h5gW-LoJ7wmQTSJLZ"
}
- }
+ ]
}
diff --git a/schema/Api/IdentityBroker/GetCustomerTokenResponse.json b/schema/Api/IdentityBroker/GetCustomerTokenResponse.json
index 7c1fa15..7917f43 100644
--- a/schema/Api/IdentityBroker/GetCustomerTokenResponse.json
+++ b/schema/Api/IdentityBroker/GetCustomerTokenResponse.json
@@ -9,9 +9,20 @@
"type": "object",
"properties": {
"data": {
- "$ref": "parts/CustomerToken.json"
+ "$ref": "parts/Token.json"
}
}
}
+ ],
+ "examples": [
+ {
+ "data": {
+ "authToken": "k9AJphtSgE1wrJDND9lTuYwwrL03T9jhAw6E4bBn6YU4pWC3Ek4HkMXWTYYes3YFCd53aRv0gTD16Z7XrCs2J6jg1Stj1q8PSsYnEALr43X0iUBCy53kOmgNUi6owcJf81jlTSfMsEY1WRzpf6GqMYcS1L5J0WTf6hEBz43ychVSVwWximMKVJj9jEToBgz1rIBPf36GYMlSQHiYmL3LzSLrAPpCXuXTJghPPmPBwYlchmlPSSsoalHif9Yy9bbpsBSc1xRfDnu50ukSmFABYJIpsJzn4SxTbBGb11qCP0z2nOUpbXM9aJWHRsDFfRxNbJordulASEZSU6UAqF7Rgo1dGFJg8Miyw8xnjS7yIajUSaZrOXj2qbXDiSOi5fEVD3j4Y5mTQZMRH0BjG76xNjZ6L6FCE4LxqCXw55tgBrGeN4WGXrn1KdfHN8WWk8dVjgVV0i1CjXFzxBj0ZIpYGQco3QyDW3pSjM6f3VbaYNZ53WVVXK6OhkCQl8P4lvBxmBWV1rM3ECbkgegyzw64vNOilWqbdzFDh75v4Ko7NMekmHpb1s0iy7VYLysJC6uyPTlaPsoLZcB8KmadPZAnylhoxPXG2O0qpcbmW4bbeQi1yytz9rCI0iXyLM7cn014Np99eABYogdGT0MaJBADnauq4n7xrT6RTjTL2cp4xqjmpTkokGfwPR0kNtPD61Mmbc5wV3f3Vw63akdZT92xkSLdIQC7zy6UXDS3mWkj3q5ezEAYWCuRYQRtY7MY6ufuyH2r0TXhgwyQLSZp5V0n0uedyXTgAlpkz9aLKKrq7YIOC2oNuAPuOmbeVE6SkNK5deDD2NyRsmNNk0f4GEgRRs51PTRAO9ThzzupCm4Rr3fJz9tTYdP63mCPUvmmgVbMPlkE8YUiHNAaJE7SL20oV6DpvYyP8gde5lEBcnTj0rJnzC7HxS0X3n3FssmdZzBIa248DzYD2tdLes7n0FVt2qEbkLBlwNFIJCMKfCxO9VVGUjcptrE9RUOUDekflEu4av8m2aRSeugKkfYbMO7",
+ "expiresOn": "2024-11-21T19:48:53.7527531Z"
+ },
+ "failureMessages": [],
+ "informationalMessages": [],
+ "operationWasSuccessful": true
+ }
]
}
diff --git a/schema/Api/IdentityBroker/GetTokenRequest.json b/schema/Api/IdentityBroker/GetTokenRequest.json
index f4ed714..0d906bb 100644
--- a/schema/Api/IdentityBroker/GetTokenRequest.json
+++ b/schema/Api/IdentityBroker/GetTokenRequest.json
@@ -4,26 +4,27 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "SourceSystemId": {
+ "sourceSystemId": {
"type": "integer",
"format": "int32"
},
- "ClientName": {
+ "clientName": {
"type": "string"
},
- "Password": {
+ "password": {
"type": "string"
}
},
"required": [
- "ClientName",
- "Password"
+ "clientName",
+ "password",
+ "sourceSystemId"
],
"examples": [
{
- "SourceSystemId": 2,
- "ClientName": "Tliw1cu7ad6qbrpBncV1aCoFhQUqVMYn",
- "Password": "l0RHIXhw50egq65DkO3YpawB999UOw1VRgsIlaw8LZQKdS3h5gW-LoJ7wmQTSJLZ"
+ "sourceSystemId": 2,
+ "clientName": "Tliw1cu7ad6qbrpBncV1aCoFhQUqVMYn",
+ "password": "l0RHIXhw50egq65DkO3YpawB999UOw1VRgsIlaw8LZQKdS3h5gW-LoJ7wmQTSJLZ"
}
]
}
diff --git a/schema/Api/IdentityBroker/GetTokenResponse.json b/schema/Api/IdentityBroker/GetTokenResponse.json
index a3312a6..2ca8a51 100644
--- a/schema/Api/IdentityBroker/GetTokenResponse.json
+++ b/schema/Api/IdentityBroker/GetTokenResponse.json
@@ -9,18 +9,7 @@
"type": "object",
"properties": {
"data": {
- "$ref": "parts/Token.json",
- "examples": [
- {
- "data": {
- "authToken": "k9AJphtSgE1wrJDND9lTuYwwrL03T9jhAw6E4bBn6YU4pWC3Ek4HkMXWTYYes3YFCd53aRv0gTD16Z7XrCs2J6jg1Stj1q8PSsYnEALr43X0iUBCy53kOmgNUi6owcJf81jlTSfMsEY1WRzpf6GqMYcS1L5J0WTf6hEBz43ychVSVwWximMKVJj9jEToBgz1rIBPf36GYMlSQHiYmL3LzSLrAPpCXuXTJghPPmPBwYlchmlPSSsoalHif9Yy9bbpsBSc1xRfDnu50ukSmFABYJIpsJzn4SxTbBGb11qCP0z2nOUpbXM9aJWHRsDFfRxNbJordulASEZSU6UAqF7Rgo1dGFJg8Miyw8xnjS7yIajUSaZrOXj2qbXDiSOi5fEVD3j4Y5mTQZMRH0BjG76xNjZ6L6FCE4LxqCXw55tgBrGeN4WGXrn1KdfHN8WWk8dVjgVV0i1CjXFzxBj0ZIpYGQco3QyDW3pSjM6f3VbaYNZ53WVVXK6OhkCQl8P4lvBxmBWV1rM3ECbkgegyzw64vNOilWqbdzFDh75v4Ko7NMekmHpb1s0iy7VYLysJC6uyPTlaPsoLZcB8KmadPZAnylhoxPXG2O0qpcbmW4bbeQi1yytz9rCI0iXyLM7cn014Np99eABYogdGT0MaJBADnauq4n7xrT6RTjTL2cp4xqjmpTkokGfwPR0kNtPD61Mmbc5wV3f3Vw63akdZT92xkSLdIQC7zy6UXDS3mWkj3q5ezEAYWCuRYQRtY7MY6ufuyH2r0TXhgwyQLSZp5V0n0uedyXTgAlpkz9aLKKrq7YIOC2oNuAPuOmbeVE6SkNK5deDD2NyRsmNNk0f4GEgRRs51PTRAO9ThzzupCm4Rr3fJz9tTYdP63mCPUvmmgVbMPlkE8YUiHNAaJE7SL20oV6DpvYyP8gde5lEBcnTj0rJnzC7HxS0X3n3FssmdZzBIa248DzYD2tdLes7n0FVt2qEbkLBlwNFIJCMKfCxO9VVGUjcptrE9RUOUDekflEu4av8m2aRSeugKkfYbMO7",
- "expiresOn": "2024-11-21T19:48:53.7527531Z"
- },
- "failureMessages": [],
- "informationalMessages": [],
- "operationWasSuccessful": true
- }
- ]
+ "$ref": "parts/Token.json"
}
}
}
diff --git a/schema/Api/IdentityBroker/LegacyGetTokenParameters.json b/schema/Api/IdentityBroker/LegacyGetTokenParameters.json
deleted file mode 100644
index 714aab1..0000000
--- a/schema/Api/IdentityBroker/LegacyGetTokenParameters.json
+++ /dev/null
@@ -1,11 +0,0 @@
-{
- "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
- }
-}
\ No newline at end of file
diff --git a/schema/Api/IdentityBroker/LegacyGetTokenRequest.json b/schema/Api/IdentityBroker/LegacyGetTokenRequest.json
deleted file mode 100644
index 68fad7e..0000000
--- a/schema/Api/IdentityBroker/LegacyGetTokenRequest.json
+++ /dev/null
@@ -1,35 +0,0 @@
-{
- "$schema": "http://json-schema.org/draft-07/schema#",
- "$id": "LegacyGetTokenRequest.json",
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "SourceSystemId": {
- "type": "integer",
- "format": "int32"
- },
- "ClientName": {
- "type": [
- "string",
- "null"
- ]
- },
- "Password": {
- "type": [
- "string",
- "null"
- ]
- }
- },
- "required": [
- "ClientName",
- "Password"
- ],
- "examples": [
- {
- "SourceSystemId": 2,
- "ClientName": "Tliw1cu7ad6qbrpBncV1aCoFhQUqVMYn",
- "Password": "l0RHIXhw50egq65DkO3YpawB999UOw1VRgsIlaw8LZQKdS3h5gW-LoJ7wmQTSJLZ"
- }
- ]
-}
diff --git a/schema/Api/IdentityBroker/LegacyGetTokenResponse.json b/schema/Api/IdentityBroker/LegacyGetTokenResponse.json
deleted file mode 100644
index 164f9a3..0000000
--- a/schema/Api/IdentityBroker/LegacyGetTokenResponse.json
+++ /dev/null
@@ -1,39 +0,0 @@
-{
- "$schema": "http://json-schema.org/draft-07/schema#",
- "$id": "LegacyGetTokenResponse.json",
- "allOf": [
- {
- "$ref": "../../Common/ApiResponseBase.json"
- },
- {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "parts/Token.json",
- "examples": [
- {
- "data": {
- "authToken": "k9AJphtSgE1wrJDND9lTuYwwrL03T9jhAw6E4bBn6YU4pWC3Ek4HkMXWTYYes3YFCd53aRv0gTD16Z7XrCs2J6jg1Stj1q8PSsYnEALr43X0iUBCy53kOmgNUi6owcJf81jlTSfMsEY1WRzpf6GqMYcS1L5J0WTf6hEBz43ychVSVwWximMKVJj9jEToBgz1rIBPf36GYMlSQHiYmL3LzSLrAPpCXuXTJghPPmPBwYlchmlPSSsoalHif9Yy9bbpsBSc1xRfDnu50ukSmFABYJIpsJzn4SxTbBGb11qCP0z2nOUpbXM9aJWHRsDFfRxNbJordulASEZSU6UAqF7Rgo1dGFJg8Miyw8xnjS7yIajUSaZrOXj2qbXDiSOi5fEVD3j4Y5mTQZMRH0BjG76xNjZ6L6FCE4LxqCXw55tgBrGeN4WGXrn1KdfHN8WWk8dVjgVV0i1CjXFzxBj0ZIpYGQco3QyDW3pSjM6f3VbaYNZ53WVVXK6OhkCQl8P4lvBxmBWV1rM3ECbkgegyzw64vNOilWqbdzFDh75v4Ko7NMekmHpb1s0iy7VYLysJC6uyPTlaPsoLZcB8KmadPZAnylhoxPXG2O0qpcbmW4bbeQi1yytz9rCI0iXyLM7cn014Np99eABYogdGT0MaJBADnauq4n7xrT6RTjTL2cp4xqjmpTkokGfwPR0kNtPD61Mmbc5wV3f3Vw63akdZT92xkSLdIQC7zy6UXDS3mWkj3q5ezEAYWCuRYQRtY7MY6ufuyH2r0TXhgwyQLSZp5V0n0uedyXTgAlpkz9aLKKrq7YIOC2oNuAPuOmbeVE6SkNK5deDD2NyRsmNNk0f4GEgRRs51PTRAO9ThzzupCm4Rr3fJz9tTYdP63mCPUvmmgVbMPlkE8YUiHNAaJE7SL20oV6DpvYyP8gde5lEBcnTj0rJnzC7HxS0X3n3FssmdZzBIa248DzYD2tdLes7n0FVt2qEbkLBlwNFIJCMKfCxO9VVGUjcptrE9RUOUDekflEu4av8m2aRSeugKkfYbMO7",
- "expiresOn": "2024-11-21T19:48:53.7527531Z"
- },
- "failureMessages": [],
- "informationalMessages": [],
- "operationWasSuccessful": true
- }
- ]
- }
- }
- }
- ],
- "examples": [
- {
- "data": {
- "authToken": "k9AJphtSgE1wrJDND9lTuYwwrL03T9jhAw6E4bBn6YU4pWC3Ek4HkMXWTYYes3YFCd53aRv0gTD16Z7XrCs2J6jg1Stj1q8PSsYnEALr43X0iUBCy53kOmgNUi6owcJf81jlTSfMsEY1WRzpf6GqMYcS1L5J0WTf6hEBz43ychVSVwWximMKVJj9jEToBgz1rIBPf36GYMlSQHiYmL3LzSLrAPpCXuXTJghPPmPBwYlchmlPSSsoalHif9Yy9bbpsBSc1xRfDnu50ukSmFABYJIpsJzn4SxTbBGb11qCP0z2nOUpbXM9aJWHRsDFfRxNbJordulASEZSU6UAqF7Rgo1dGFJg8Miyw8xnjS7yIajUSaZrOXj2qbXDiSOi5fEVD3j4Y5mTQZMRH0BjG76xNjZ6L6FCE4LxqCXw55tgBrGeN4WGXrn1KdfHN8WWk8dVjgVV0i1CjXFzxBj0ZIpYGQco3QyDW3pSjM6f3VbaYNZ53WVVXK6OhkCQl8P4lvBxmBWV1rM3ECbkgegyzw64vNOilWqbdzFDh75v4Ko7NMekmHpb1s0iy7VYLysJC6uyPTlaPsoLZcB8KmadPZAnylhoxPXG2O0qpcbmW4bbeQi1yytz9rCI0iXyLM7cn014Np99eABYogdGT0MaJBADnauq4n7xrT6RTjTL2cp4xqjmpTkokGfwPR0kNtPD61Mmbc5wV3f3Vw63akdZT92xkSLdIQC7zy6UXDS3mWkj3q5ezEAYWCuRYQRtY7MY6ufuyH2r0TXhgwyQLSZp5V0n0uedyXTgAlpkz9aLKKrq7YIOC2oNuAPuOmbeVE6SkNK5deDD2NyRsmNNk0f4GEgRRs51PTRAO9ThzzupCm4Rr3fJz9tTYdP63mCPUvmmgVbMPlkE8YUiHNAaJE7SL20oV6DpvYyP8gde5lEBcnTj0rJnzC7HxS0X3n3FssmdZzBIa248DzYD2tdLes7n0FVt2qEbkLBlwNFIJCMKfCxO9VVGUjcptrE9RUOUDekflEu4av8m2aRSeugKkfYbMO7",
- "expiresOn": "2024-11-21T19:48:53.7527531Z"
- },
- "failureMessages": [],
- "informationalMessages": [],
- "operationWasSuccessful": true
- }
- ]
-}
diff --git a/schema/Api/IdentityBroker/parts/CustomerToken.json b/schema/Api/IdentityBroker/parts/CustomerToken.json
deleted file mode 100644
index db5d8cf..0000000
--- a/schema/Api/IdentityBroker/parts/CustomerToken.json
+++ /dev/null
@@ -1,17 +0,0 @@
-{
- "$schema": "http://json-schema.org/draft-07/schema#",
- "$id": "CustomerToken.json",
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "authToken": {
- "type": [
- "string",
- "null"
- ]
- },
- "expiresOn": {
- "type": "string"
- }
- }
-}
diff --git a/schema/Api/OfferBroker/CreateCategoryRequest.json b/schema/Api/OfferBroker/CreateCategoryRequest.json
index 2ffbdd9..b38d652 100644
--- a/schema/Api/OfferBroker/CreateCategoryRequest.json
+++ b/schema/Api/OfferBroker/CreateCategoryRequest.json
@@ -4,29 +4,19 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "ParentId": {
+ "parentId": {
"type": [
"string",
"null"
]
},
- "SourceSystemCustomerId": {
+ "createDateTimeUtc": {
"type": [
"string",
"null"
]
},
- "SourceSystemId": {
- "type": "integer",
- "format": "int32"
- },
- "CreateDateTimeUtc": {
- "type": [
- "string",
- "null"
- ]
- },
- "Name": {
+ "name": {
"type": [
"string",
"null"
@@ -34,8 +24,6 @@
}
},
"required": [
- "Name",
- "SourceSystemCustomerId",
- "SourceSystemId"
+ "name"
]
}
diff --git a/schema/Api/OfferBroker/CreateOfferRequest.json b/schema/Api/OfferBroker/CreateOfferRequest.json
index 35b242c..cbc2662 100644
--- a/schema/Api/OfferBroker/CreateOfferRequest.json
+++ b/schema/Api/OfferBroker/CreateOfferRequest.json
@@ -2,63 +2,46 @@
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "CreateOfferRequest.json",
"type": "object",
- "oneOf": [
- {
- "required": [
- "Id"
- ]
- },
- {
- "required": [
- "Number"
- ]
- }
- ],
"additionalProperties": false,
"properties": {
- "CorrelationId": {
+ "correlationId": {
"type": [
"string",
"null"
],
"format": "uuid"
},
- "CustomerId": {
+ "customerId": {
"type": [
"string",
"null"
- ],
- "readOnly": true
+ ]
},
- "Id": {
+ "id": {
"type": [
"string",
"null"
]
},
- "SourceSystemCustomerId": {
+ "xmPieTemplateId": {
"type": [
"string",
"null"
]
},
- "SourceSystemId": {
- "type": "integer",
- "format": "int32"
- },
- "XmPieTemplateId": {
+ "xmPieUStoreId": {
"type": [
"string",
"null"
]
},
- "XmPieUStoreId": {
+ "description": {
"type": [
"string",
"null"
]
},
- "AccessGroups": {
+ "accessGroups": {
"type": [
"array",
"null"
@@ -67,28 +50,28 @@
"type": "string"
}
},
- "AdditionalPropertiesRequiredOnOrder": {
+ "additionalPropsRequiredOnOrder": {
"type": [
"array",
"null"
],
"items": {
- "$ref": "parts/AdditionalPropertiesRequiredOnOrder.json"
+ "$ref": "parts/AdditionalPropsRequiredOnOrder.json"
}
},
- "AvailableEndDate": {
+ "availableEndDate": {
"type": [
"string",
"null"
]
},
- "AvailableStartDate": {
+ "availableStartDate": {
"type": [
"string",
"null"
]
},
- "CategoryIds": {
+ "categoryIds": {
"type": [
"array",
"null"
@@ -97,38 +80,32 @@
"type": "string"
}
},
- "Comments": {
+ "comments": {
"type": [
"string",
"null"
]
},
- "CreateDateTimeUtc": {
+ "createDateTimeUtc": {
"type": [
"string",
"null"
]
},
- "DefaultPrice": {
+ "defaultPrice": {
"type": [
"number",
"null"
],
"format": "double"
},
- "Description": {
- "type": [
- "string",
- "null"
- ]
- },
- "DoSuppressShippingAndHandling": {
+ "doSuppressShippingAndHandling": {
"type": [
"boolean",
"null"
]
},
- "FixedOrderQuantities": {
+ "fixedOrderQuantities": {
"type": [
"array",
"null"
@@ -138,37 +115,37 @@
"format": "double"
}
},
- "FullImageUrl": {
+ "fullImageUrl": {
"type": [
"string",
"null"
]
},
- "IsActive": {
+ "isActive": {
"type": [
"boolean",
"null"
]
},
- "IsTaxable": {
+ "isTaxable": {
"type": [
"boolean",
"null"
]
},
- "Number": {
+ "number": {
"type": [
"string",
"null"
]
},
- "OfferType": {
+ "offerType": {
"type": [
"string",
"null"
]
},
- "OnlyShipMethodsAvailable": {
+ "onlyShipMethodsAvailable": {
"type": [
"array",
"null"
@@ -177,27 +154,27 @@
"type": "string"
}
},
- "OrderMaximum": {
+ "orderMaximum": {
"type": [
"number",
"null"
],
"format": "double"
},
- "OrderMinimum": {
+ "orderMinimum": {
"type": [
"number",
"null"
],
"format": "double"
},
- "PdfUrl": {
+ "pdfUrl": {
"type": [
"string",
"null"
]
},
- "PriceClasses": {
+ "priceClasses": {
"type": [
"array",
"null"
@@ -206,7 +183,7 @@
"$ref": "parts/PriceClass.json"
}
},
- "ProductClusters": {
+ "productClusters": {
"type": [
"array",
"null"
@@ -215,15 +192,8 @@
"$ref": "parts/ProductCluster.json"
}
},
- "Products": {
+ "products": {
"description": "Offer level product details",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "parts/Product.json"
- },
"examples": [
{
"ProductId": "JGI-BTU-BFUI-5022-9773",
@@ -231,31 +201,31 @@
}
]
},
- "SecureEmailBody": {
+ "secureEmailBody": {
"type": [
"string",
"null"
]
},
- "SecureEmailSubject": {
+ "secureEmailSubject": {
"type": [
"string",
"null"
]
},
- "ThumbnailUrl": {
+ "thumbnailUrl": {
"type": [
"string",
"null"
]
},
- "UnitOfMeasure": {
+ "unitOfMeasure": {
"type": [
"string",
"null"
]
},
- "WeightInPounds": {
+ "weightInPounds": {
"type": [
"number",
"null"
@@ -264,8 +234,7 @@
}
},
"required": [
- "OfferType",
- "SourceSystemCustomerId",
- "SourceSystemId"
+ "number",
+ "offerType"
]
}
diff --git a/schema/Api/OfferBroker/DeleteCategoryRequest.json b/schema/Api/OfferBroker/DeleteCategoryRequest.json
index 9f77dd4..796b144 100644
--- a/schema/Api/OfferBroker/DeleteCategoryRequest.json
+++ b/schema/Api/OfferBroker/DeleteCategoryRequest.json
@@ -4,26 +4,14 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "CategoryId": {
+ "categoryId": {
"type": [
"string",
"null"
]
- },
- "SourceSystemCustomerId": {
- "type": [
- "string",
- "null"
- ]
- },
- "SourceSystemId": {
- "type": "integer",
- "format": "int32"
}
},
"required": [
- "CategoryId",
- "SourceSystemCustomerId",
- "SourceSystemId"
+ "categoryId"
]
}
diff --git a/schema/Api/OfferBroker/DeleteOfferRequest.json b/schema/Api/OfferBroker/DeleteOfferRequest.json
index c17e819..7a35f3a 100644
--- a/schema/Api/OfferBroker/DeleteOfferRequest.json
+++ b/schema/Api/OfferBroker/DeleteOfferRequest.json
@@ -4,33 +4,20 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "CustomerId": {
- "type": [
- "string",
- "null"
- ],
- "readOnly": true
- },
- "Id": {
+ "customerId": {
"type": [
"string",
"null"
]
},
- "SourceSystemCustomerId": {
+ "id": {
"type": [
"string",
"null"
]
- },
- "SourceSystemId": {
- "type": "integer",
- "format": "int32"
}
},
"required": [
- "Id",
- "SourceSystemCustomerId",
- "SourceSystemId"
+ "id"
]
}
diff --git a/schema/Api/OfferBroker/GetAllOffersRequest.json b/schema/Api/OfferBroker/GetAllOffersRequest.json
index 87c3a1a..8d4909e 100644
--- a/schema/Api/OfferBroker/GetAllOffersRequest.json
+++ b/schema/Api/OfferBroker/GetAllOffersRequest.json
@@ -4,23 +4,13 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "SourceSystemCustomerId": {
- "type": [
- "string",
- "null"
- ]
- },
- "SourceSystemId": {
- "type": "integer",
- "format": "int32"
- },
- "DoIncludeDeletedItems": {
+ "doIncludeDeletedItems": {
"type": [
"boolean",
"null"
]
},
- "UpdatedSinceDateTime": {
+ "updatedSinceDateTime": {
"type": [
"string",
"null"
diff --git a/schema/Api/OfferBroker/GetOfferResponse.json b/schema/Api/OfferBroker/GetOfferResponse.json
index 7e3afad..9db766f 100644
--- a/schema/Api/OfferBroker/GetOfferResponse.json
+++ b/schema/Api/OfferBroker/GetOfferResponse.json
@@ -9,7 +9,14 @@
"type": "object",
"properties": {
"data": {
- "$ref": "parts/Offer.json"
+ "oneOf": [
+ {
+ "type": "null"
+ },
+ {
+ "$ref": "parts/Offer.json"
+ }
+ ]
}
}
}
diff --git a/schema/Api/OfferBroker/UpdateCategoryRequest.json b/schema/Api/OfferBroker/UpdateCategoryRequest.json
index 394f627..4f316ef 100644
--- a/schema/Api/OfferBroker/UpdateCategoryRequest.json
+++ b/schema/Api/OfferBroker/UpdateCategoryRequest.json
@@ -4,35 +4,25 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "Id": {
+ "id": {
"type": [
"string",
"null"
]
},
- "ParentId": {
+ "parentId": {
"type": [
"string",
"null"
]
},
- "SourceSystemCustomerId": {
+ "name": {
"type": [
"string",
"null"
]
},
- "SourceSystemId": {
- "type": "integer",
- "format": "int32"
- },
- "Name": {
- "type": [
- "string",
- "null"
- ]
- },
- "UpdateDateTimeUtc": {
+ "updateDateTimeUtc": {
"type": [
"string",
"null"
@@ -40,9 +30,7 @@
}
},
"required": [
- "Id",
- "Name",
- "SourceSystemCustomerId",
- "SourceSystemId"
+ "id",
+ "name"
]
}
diff --git a/schema/Api/OfferBroker/UpdateOfferRequest.json b/schema/Api/OfferBroker/UpdateOfferRequest.json
index ce186ca..ad87aa8 100644
--- a/schema/Api/OfferBroker/UpdateOfferRequest.json
+++ b/schema/Api/OfferBroker/UpdateOfferRequest.json
@@ -2,60 +2,39 @@
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "UpdateOfferRequest.json",
"type": "object",
- "oneOf": [
- {
- "required": [
- "Id"
- ]
- },
- {
- "required": [
- "Number"
- ]
- }
- ],
"additionalProperties": false,
"properties": {
- "CorrelationId": {
+ "customerId": {
"type": [
"string",
"null"
- ],
- "format": "uuid"
+ ]
},
- "CustomerId": {
+ "id": {
"type": [
"string",
"null"
- ],
- "readOnly": true
- },
- "Id": {
- "type": "string"
+ ]
},
- "SourceSystemCustomerId": {
+ "xmPieTemplateId": {
"type": [
"string",
"null"
]
},
- "SourceSystemId": {
- "type": "integer",
- "format": "int32"
- },
- "XmPieTemplateId": {
+ "xmPieUStoreId": {
"type": [
"string",
"null"
]
},
- "XmPieUStoreId": {
+ "description": {
"type": [
"string",
"null"
]
},
- "AccessGroups": {
+ "accessGroups": {
"type": [
"array",
"null"
@@ -64,28 +43,28 @@
"type": "string"
}
},
- "AdditionalPropertiesRequiredOnOrder": {
+ "additionalPropsRequiredOnOrder": {
"type": [
"array",
"null"
],
"items": {
- "$ref": "parts/AdditionalPropertiesRequiredOnOrder.json"
+ "$ref": "parts/AdditionalPropsRequiredOnOrder.json"
}
},
- "AvailableEndDate": {
+ "availableEndDate": {
"type": [
"string",
"null"
]
},
- "AvailableStartDate": {
+ "availableStartDate": {
"type": [
"string",
"null"
]
},
- "CategoryIds": {
+ "categoryIds": {
"type": [
"array",
"null"
@@ -94,38 +73,32 @@
"type": "string"
}
},
- "Comments": {
+ "comments": {
"type": [
"string",
"null"
]
},
- "CreateDateTimeUtc": {
+ "createDateTimeUtc": {
"type": [
"string",
"null"
]
},
- "DefaultPrice": {
+ "defaultPrice": {
"type": [
"number",
"null"
],
"format": "double"
},
- "Description": {
- "type": [
- "string",
- "null"
- ]
- },
- "DoSuppressShippingAndHandling": {
+ "doSuppressShippingAndHandling": {
"type": [
"boolean",
"null"
]
},
- "FixedOrderQuantities": {
+ "fixedOrderQuantities": {
"type": [
"array",
"null"
@@ -135,37 +108,37 @@
"format": "double"
}
},
- "FullImageUrl": {
+ "fullImageUrl": {
"type": [
"string",
"null"
]
},
- "IsActive": {
+ "isActive": {
"type": [
"boolean",
"null"
]
},
- "IsTaxable": {
+ "isTaxable": {
"type": [
"boolean",
"null"
]
},
- "Number": {
+ "number": {
"type": [
"string",
"null"
]
},
- "OfferType": {
+ "offerType": {
"type": [
"string",
"null"
]
},
- "OnlyShipMethodsAvailable": {
+ "onlyShipMethodsAvailable": {
"type": [
"array",
"null"
@@ -174,27 +147,27 @@
"type": "string"
}
},
- "OrderMaximum": {
+ "orderMaximum": {
"type": [
"number",
"null"
],
"format": "double"
},
- "OrderMinimum": {
+ "orderMinimum": {
"type": [
"number",
"null"
],
"format": "double"
},
- "PdfUrl": {
+ "pdfUrl": {
"type": [
"string",
"null"
]
},
- "PriceClasses": {
+ "priceClasses": {
"type": [
"array",
"null"
@@ -203,24 +176,17 @@
"$ref": "parts/PriceClass.json"
}
},
- "ProductClusters": {
+ "productClusters": {
"type": [
"array",
"null"
],
"items": {
- "$ref": "parts/ProductCluster.json"
+ "$ref": "parts/ProductClusterUpdate.json"
}
},
- "Products": {
+ "products": {
"description": "Offer level product details",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "parts/Product.json"
- },
"examples": [
{
"ProductId": "JGI-BTU-BFUI-5022-9773",
@@ -228,31 +194,31 @@
}
]
},
- "SecureEmailBody": {
+ "secureEmailBody": {
"type": [
"string",
"null"
]
},
- "SecureEmailSubject": {
+ "secureEmailSubject": {
"type": [
"string",
"null"
]
},
- "ThumbnailUrl": {
+ "thumbnailUrl": {
"type": [
"string",
"null"
]
},
- "UnitOfMeasure": {
+ "unitOfMeasure": {
"type": [
"string",
"null"
]
},
- "WeightInPounds": {
+ "weightInPounds": {
"type": [
"number",
"null"
@@ -261,8 +227,7 @@
}
},
"required": [
- "OfferType",
- "SourceSystemCustomerId",
- "SourceSystemId"
+ "number",
+ "offerType"
]
}
diff --git a/schema/Api/OfferBroker/parts/AdditionalPropertiesRequiredOnOrder.json b/schema/Api/OfferBroker/parts/AdditionalPropertiesRequiredOnOrder.json
deleted file mode 100644
index e13c6cd..0000000
--- a/schema/Api/OfferBroker/parts/AdditionalPropertiesRequiredOnOrder.json
+++ /dev/null
@@ -1,23 +0,0 @@
-{
- "$schema": "http://json-schema.org/draft-07/schema#",
- "$id": "AdditionalPropertiesRequiredOnOrder.json",
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "Name": {
- "type": [
- "string",
- "null"
- ]
- },
- "Type": {
- "type": [
- "string",
- "null"
- ]
- }
- },
- "required": [
- "Name"
- ]
-}
diff --git a/schema/Api/OfferBroker/parts/AdditionalPropsRequiredOnOrder.json b/schema/Api/OfferBroker/parts/AdditionalPropsRequiredOnOrder.json
index 8e86d63..fb8654a 100644
--- a/schema/Api/OfferBroker/parts/AdditionalPropsRequiredOnOrder.json
+++ b/schema/Api/OfferBroker/parts/AdditionalPropsRequiredOnOrder.json
@@ -4,31 +4,31 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "Hint": {
+ "type": {
"type": [
"string",
"null"
]
},
- "Label": {
+ "hint": {
"type": [
"string",
"null"
]
},
- "Name": {
+ "label": {
"type": [
"string",
"null"
]
},
- "Type": {
+ "name": {
"type": [
"string",
"null"
]
},
- "Value": {
+ "value": {
"type": [
"string",
"null"
diff --git a/schema/Api/OfferBroker/parts/Category.json b/schema/Api/OfferBroker/parts/Category.json
index 8378834..1b97bac 100644
--- a/schema/Api/OfferBroker/parts/Category.json
+++ b/schema/Api/OfferBroker/parts/Category.json
@@ -4,13 +4,13 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "CategoryKey": {
+ "categoryKey": {
"type": [
"string",
"null"
]
},
- "Name": {
+ "name": {
"type": [
"string",
"null"
diff --git a/schema/Api/OfferBroker/parts/Offer.json b/schema/Api/OfferBroker/parts/Offer.json
index 5721170..ca01d1a 100644
--- a/schema/Api/OfferBroker/parts/Offer.json
+++ b/schema/Api/OfferBroker/parts/Offer.json
@@ -4,31 +4,34 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "Id": {
+ "id": {
"type": [
"string",
"null"
]
},
- "OmsOfferId": {
+ "omsOfferId": {
+ "type": "string"
+ },
+ "xmPieTemplateId": {
"type": [
"string",
"null"
]
},
- "XmPieTemplateId": {
+ "xmPieUStoreId": {
"type": [
"string",
"null"
]
},
- "XmPieUStoreId": {
+ "description": {
"type": [
"string",
"null"
]
},
- "AccessGroups": {
+ "accessGroups": {
"type": [
"array",
"null"
@@ -37,7 +40,7 @@
"type": "string"
}
},
- "AdditionalPropsRequiredOnOrder": {
+ "additionalPropsRequiredOnOrder": {
"type": [
"array",
"null"
@@ -46,28 +49,19 @@
"$ref": "AdditionalPropsRequiredOnOrder.json"
}
},
- "AvailableEndDate": {
+ "availableEndDate": {
"type": [
"string",
"null"
]
},
- "AvailableStartDate": {
+ "availableStartDate": {
"type": [
"string",
"null"
]
},
- "Categories": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "Category.json"
- }
- },
- "CategoryIds": {
+ "categoryIds": {
"type": [
"array",
"null"
@@ -76,29 +70,23 @@
"type": "string"
}
},
- "Comments": {
+ "comments": {
"type": [
"string",
"null"
]
},
- "DefaultPrice": {
+ "defaultPrice": {
"type": [
"number",
"null"
],
"format": "double"
},
- "Description": {
- "type": [
- "string",
- "null"
- ]
- },
- "DoSuppressShippingAndHandling": {
+ "doSuppressShippingAndHandling": {
"type": "boolean"
},
- "FixedOrderQuantities": {
+ "fixedOrderQuantities": {
"type": [
"array",
"null"
@@ -108,55 +96,55 @@
"format": "int32"
}
},
- "FullImageUrl": {
+ "fullImageUrl": {
"type": [
"string",
"null"
]
},
- "IntegrationBrokerLastUpdatedDateTimeUtc": {
+ "integrationBrokerLastUpdatedDateTimeUtc": {
"type": "string"
},
- "IsActive": {
+ "isActive": {
"type": "boolean"
},
- "IsDeleted": {
+ "isDeleted": {
"type": "boolean"
},
- "IsInventoried": {
+ "isInventoried": {
"type": "boolean"
},
- "IsTaxable": {
+ "isTaxable": {
"type": "boolean"
},
- "LastUpdatedDateTimeUTC": {
+ "lastUpdatedDateTimeUTC": {
"type": "string"
},
- "Number": {
+ "number": {
"type": [
"string",
"null"
]
},
- "OfferType": {
+ "offerType": {
"type": [
"string",
"null"
]
},
- "OmsIdentifier": {
+ "omsIdentifier": {
"type": [
"string",
"null"
]
},
- "OmsRootSystemName": {
+ "omsRootSystemName": {
"type": [
"string",
"null"
]
},
- "OnlyShipMethodsAvailable": {
+ "onlyShipMethodsAvailable": {
"type": [
"array",
"null"
@@ -165,27 +153,27 @@
"type": "string"
}
},
- "OrderMaximum": {
+ "orderMaximum": {
"type": [
"integer",
"null"
],
"format": "int32"
},
- "OrderMinimum": {
+ "orderMinimum": {
"type": [
"integer",
"null"
],
"format": "int32"
},
- "PdfUrl": {
+ "pdfUrl": {
"type": [
"string",
"null"
]
},
- "PriceClasses": {
+ "priceClasses": {
"type": [
"array",
"null"
@@ -194,7 +182,7 @@
"$ref": "PriceClass.json"
}
},
- "ProductClusters": {
+ "productClusters": {
"type": [
"array",
"null"
@@ -203,27 +191,32 @@
"$ref": "ProductCluster.json"
}
},
- "SchemaVersion": {
+ "schemaVersion": {
"type": [
"string",
"null"
]
},
- "ThumbnailUrl": {
+ "thumbnailUrl": {
"type": [
"string",
"null"
]
},
- "UnitOfMeasure": {
+ "unitOfMeasure": {
"type": [
"string",
"null"
]
},
- "WeightInPounds": {
+ "weightInPounds": {
"type": "number",
"format": "float"
}
- }
+ },
+ "required": [
+ "omsOfferId",
+ "name",
+ "offerType"
+ ]
}
diff --git a/schema/Api/OfferBroker/parts/OfferCategory.json b/schema/Api/OfferBroker/parts/OfferCategory.json
index d9c6126..04ce47a 100644
--- a/schema/Api/OfferBroker/parts/OfferCategory.json
+++ b/schema/Api/OfferBroker/parts/OfferCategory.json
@@ -4,32 +4,32 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "Id": {
+ "id": {
"type": [
"string",
"null"
]
},
- "CategoryKey": {
+ "categoryKey": {
"type": [
"string",
"null"
]
},
- "CategoryLevel": {
+ "categoryLevel": {
"type": [
"integer",
"null"
],
"format": "int32"
},
- "CategoryName": {
+ "categoryName": {
"type": [
"string",
"null"
]
},
- "SubCategories": {
+ "subCategories": {
"type": [
"array",
"null"
diff --git a/schema/Api/OfferBroker/parts/PriceClass.json b/schema/Api/OfferBroker/parts/PriceClass.json
index a5784d5..25b33bf 100644
--- a/schema/Api/OfferBroker/parts/PriceClass.json
+++ b/schema/Api/OfferBroker/parts/PriceClass.json
@@ -4,13 +4,13 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "AccessGroup": {
+ "name": {
"type": [
"string",
"null"
]
},
- "Price": {
+ "price": {
"description": "Total offer price of individual line item",
"type": [
"number",
@@ -18,7 +18,7 @@
],
"format": "double"
},
- "PriceTiers": {
+ "priceTiers": {
"type": [
"array",
"null"
diff --git a/schema/Api/OfferBroker/parts/PriceTier.json b/schema/Api/OfferBroker/parts/PriceTier.json
index ca01c93..f2ca2db 100644
--- a/schema/Api/OfferBroker/parts/PriceTier.json
+++ b/schema/Api/OfferBroker/parts/PriceTier.json
@@ -4,27 +4,27 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "MaximumQuantity": {
+ "maximumQuantity": {
"type": [
"number",
"null"
],
"format": "double"
},
- "MinimumQuantity": {
+ "minimumQuantity": {
"type": [
"number",
"null"
],
"format": "double"
},
- "Price": {
+ "price": {
"description": "Total offer price of individual line item",
"type": "number",
"format": "double"
}
},
"required": [
- "Price"
+ "price"
]
}
diff --git a/schema/Api/OfferBroker/parts/Product.json b/schema/Api/OfferBroker/parts/Product.json
index b75b4b2..ae5c787 100644
--- a/schema/Api/OfferBroker/parts/Product.json
+++ b/schema/Api/OfferBroker/parts/Product.json
@@ -4,20 +4,74 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "ProductId": {
- "description": "Unique ID for component product within Integration Broker",
+ "omsProductId": {
"type": [
"string",
"null"
]
},
- "ProductQuantityInOffer": {
+ "productId": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "associatedFileName": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "buildType": {
+ "type": "integer",
+ "enum": [
+ 0,
+ 1,
+ 2,
+ 3,
+ 4,
+ 5
+ ],
+ "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"
}
},
"required": [
- "ProductId",
- "ProductQuantityInOffer"
+ "productId",
+ "productQuantityInOffer"
]
}
diff --git a/schema/Api/OfferBroker/parts/ProductCluster.json b/schema/Api/OfferBroker/parts/ProductCluster.json
index c40a53d..005e8ce 100644
--- a/schema/Api/OfferBroker/parts/ProductCluster.json
+++ b/schema/Api/OfferBroker/parts/ProductCluster.json
@@ -4,19 +4,24 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "ClusterId": {
+ "clusterId": {
"type": [
"string",
"null"
]
},
- "ProductQuantityInOffer": {
- "type": "integer",
- "format": "int32"
+ "products": {
+ "type": [
+ "array",
+ "null"
+ ],
+ "items": {
+ "$ref": "Product.json"
+ }
}
},
"required": [
- "ClusterId",
- "ProductQuantityInOffer"
+ "clusterId",
+ "productQuantityInOffer"
]
}
diff --git a/schema/Api/OrderBroker/parts/LineItem.json b/schema/Api/OrderBroker/parts/LineItem.json
index 630b6f4..30aa163 100644
--- a/schema/Api/OrderBroker/parts/LineItem.json
+++ b/schema/Api/OrderBroker/parts/LineItem.json
@@ -149,9 +149,7 @@
},
"QuantityOrdered": {
"description": "Amount of offer ordered for individual line item",
- "type": [
- "integer"
- ],
+ "type": "integer",
"format": "int32"
},
"RushOrder": {
diff --git a/schema/Api/ProductBroker/parts/Product.json b/schema/Api/ProductBroker/parts/Product.json
index 0105e1e..6955686 100644
--- a/schema/Api/ProductBroker/parts/Product.json
+++ b/schema/Api/ProductBroker/parts/Product.json
@@ -4,65 +4,65 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "ProductId": {
+ "productId": {
"description": "Unique ID for component product within Integration Broker",
"type": [
"string",
"null"
]
},
- "Color": {
+ "color": {
"description": "Color of product",
"type": [
"string",
"null"
]
},
- "LastUpdateDateTimeUtc": {
+ "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": {
+ "productDescription": {
"description": "Description for component product within product management system (system where ordered line item products will be managed)",
"type": [
"string",
"null"
]
},
- "ProductNumber": {
+ "productNumber": {
"description": "Name for component product within product management system (system where ordered line item products will be managed)",
"type": [
"string",
"null"
]
},
- "ProductOwner": {
+ "productOwner": {
"description": "Owner of component product",
"type": [
"string",
"null"
]
},
- "ProductType": {
+ "productType": {
"type": [
"string",
"null"
]
},
- "Size": {
+ "size": {
"description": "Size of component product",
"type": [
"string",
"null"
]
},
- "Status": {
+ "status": {
"type": [
"string",
"null"
]
},
- "UnitOfMeasure": {
+ "unitOfMeasure": {
"type": [
"string",
"null"
@@ -70,10 +70,10 @@
}
},
"required": [
- "LastUpdateDateTimeUtc",
- "ProductId",
- "ProductNumber",
- "ProductType",
- "Status"
+ "lastUpdateDateTimeUtc",
+ "productId",
+ "productNumber",
+ "productType",
+ "status"
]
}
diff --git a/schema/Api/ProductBroker/parts/ProductInventory.json b/schema/Api/ProductBroker/parts/ProductInventory.json
index d933598..e283498 100644
--- a/schema/Api/ProductBroker/parts/ProductInventory.json
+++ b/schema/Api/ProductBroker/parts/ProductInventory.json
@@ -4,43 +4,43 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "ProductId": {
+ "productId": {
"type": [
"string",
"null"
]
},
- "CurrentAvailableQty": {
+ "currentAvailableQty": {
"type": "integer",
"format": "int32"
},
- "CurrentOnHandQty": {
+ "currentOnHandQty": {
"type": "integer",
"format": "int32"
},
- "Expected": {
+ "expected": {
"type": [
"integer",
"null"
],
"format": "int32"
},
- "OnBackorder": {
+ "onBackorder": {
"type": [
"integer",
"null"
],
"format": "int32"
},
- "Reserved": {
+ "reserved": {
"type": "integer",
"format": "int32"
}
},
"required": [
- "CurrentAvailableQty",
- "CurrentOnHandQty",
- "ProductId",
- "Reserved"
+ "currentAvailableQty",
+ "currentOnHandQty",
+ "productId",
+ "reserved"
]
}
diff --git a/schema/Event/Offer/Offer.json b/schema/Event/Offer/Offer.json
index 2cde38b..72512c6 100644
--- a/schema/Event/Offer/Offer.json
+++ b/schema/Event/Offer/Offer.json
@@ -4,6 +4,13 @@
"description": "Offer properties",
"type": "object",
"properties": {
+ "CustomerId": {
+ "description": "Customer that the offer belongs to",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
"Id": {
"description": "Unique ID assigned to the offer by SOB",
"type": "string"
@@ -74,11 +81,6 @@
"null"
]
},
- "CustomerId": {
- "description": "Customer that the offer belongs to",
- "type": "string",
- "nullable": true
- },
"DefaultPrice": {
"description": "Default price of the offer if no price classes are applied",
"type": [
diff --git a/schema/Event/Order/OrderEvent.json b/schema/Event/Order/OrderEvent.json
index 996555c..242bdd5 100644
--- a/schema/Event/Order/OrderEvent.json
+++ b/schema/Event/Order/OrderEvent.json
@@ -45,6 +45,8 @@
{
"AggregateId": "2-gbdstorefrontcust-2-P-4692-3606-50",
"CorrelationId": "ae7f8b49-f36a-4b6e-9444-8f22f11a6fe3",
+ "_rid": "s7l1AJVVwJcLwwIAAAAAAA==",
+ "id": "aa2ec6a5-baf9-43ff-9002-3d25892fbb2a",
"AggregateType": "Order",
"EventActionUser": null,
"EventDateTimeUtc": "2024-11-20T20:26:38.55",
@@ -157,10 +159,8 @@
},
"_attachments": "attachments/",
"_etag": "\"080066e6-0000-0300-0000-673e47300000\"",
- "_rid": "s7l1AJVVwJcLwwIAAAAAAA==",
"_self": "dbs/s7l1AA==/colls/s7l1AJVVwJc=/docs/s7l1AJVVwJcLwwIAAAAAAA==/",
- "_ts": 1732134704,
- "id": "aa2ec6a5-baf9-43ff-9002-3d25892fbb2a"
+ "_ts": 1732134704
}
]
}