Schema Changes - 2025-05-02
This document contains the changes to the schema files compared to the main branch.
Changes
diff --git a/schema/Api/CustomerBroker/GetCustomerIdParameters.json b/schema/Api/CustomerBroker/GetCustomerIdParameters.json
index 714aab1..011b51c 100644
--- a/schema/Api/CustomerBroker/GetCustomerIdParameters.json
+++ b/schema/Api/CustomerBroker/GetCustomerIdParameters.json
@@ -3,9 +3,7 @@
"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"
- },
+ "schema": {"type": "string"},
"required": false
}
-}
\ No newline at end of file
+}
diff --git a/schema/Api/CustomerBroker/GetCustomerIdResponse.json b/schema/Api/CustomerBroker/GetCustomerIdResponse.json
index aa16557..c37d3b6 100644
--- a/schema/Api/CustomerBroker/GetCustomerIdResponse.json
+++ b/schema/Api/CustomerBroker/GetCustomerIdResponse.json
@@ -2,16 +2,10 @@
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "GetCustomerIdResponse.json",
"allOf": [
- {
- "$ref": "../../Common/ApiResponseBase.json"
- },
+ {"$ref": "../../Common/ApiResponseBase.json"},
{
"type": "object",
- "properties": {
- "data": {
- "$ref": "parts/CustomerId.json"
- }
- }
+ "properties": { "data": { "oneOf": [ {"type": "null"}, {"$ref": "parts/CustomerId.json"} ] } }
}
]
}
diff --git a/schema/Api/CustomerBroker/GetCustomerParameters.json b/schema/Api/CustomerBroker/GetCustomerParameters.json
index 7e825ce..fb5e710 100644
--- a/schema/Api/CustomerBroker/GetCustomerParameters.json
+++ b/schema/Api/CustomerBroker/GetCustomerParameters.json
@@ -3,17 +3,13 @@
"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"
- },
+ "schema": {"type": "string"},
"required": false
},
"CustomerId": {
"in": "path",
"name": "customerId",
- "schema": {
- "type": "string"
- },
+ "schema": {"type": "string"},
"required": true
}
-}
\ No newline at end of file
+}
diff --git a/schema/Api/CustomerBroker/GetCustomerResponse.json b/schema/Api/CustomerBroker/GetCustomerResponse.json
index 05b9c57..539ea54 100644
--- a/schema/Api/CustomerBroker/GetCustomerResponse.json
+++ b/schema/Api/CustomerBroker/GetCustomerResponse.json
@@ -2,16 +2,10 @@
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "GetCustomerResponse.json",
"allOf": [
- {
- "$ref": "../../Common/ApiResponseBase.json"
- },
+ {"$ref": "../../Common/ApiResponseBase.json"},
{
"type": "object",
- "properties": {
- "data": {
- "$ref": "parts/Customer.json"
- }
- }
+ "properties": { "data": { "oneOf": [ {"type": "null"}, {"$ref": "parts/Customer.json"} ] } }
}
]
}
diff --git a/schema/Api/CustomerBroker/GetCustomersParameters.json b/schema/Api/CustomerBroker/GetCustomersParameters.json
index 714aab1..011b51c 100644
--- a/schema/Api/CustomerBroker/GetCustomersParameters.json
+++ b/schema/Api/CustomerBroker/GetCustomersParameters.json
@@ -3,9 +3,7 @@
"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"
- },
+ "schema": {"type": "string"},
"required": false
}
-}
\ No newline at end of file
+}
diff --git a/schema/Api/CustomerBroker/GetCustomersResponse.json b/schema/Api/CustomerBroker/GetCustomersResponse.json
index 0f66d84..facf2dc 100644
--- a/schema/Api/CustomerBroker/GetCustomersResponse.json
+++ b/schema/Api/CustomerBroker/GetCustomersResponse.json
@@ -2,42 +2,20 @@
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "GetCustomersResponse.json",
"allOf": [
- {
- "$ref": "../../Common/ApiResponseBase.json"
- },
+ {"$ref": "../../Common/ApiResponseBase.json"},
{
"type": "object",
"properties": {
- "data": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "parts/CustomersList.json"
- }
- }
+ "data": { "type": ["array", "null"], "items": {"$ref": "parts/CustomersList.json"} }
}
}
],
"examples": [
{
"data": [
- {
- "Id": "CUST-002",
- "ParentId": null,
- "Name": "Customer 2"
- },
- {
- "Id": "CUST-007",
- "ParentId": "CUST-023",
- "Name": "Customer 7"
- },
- {
- "Id": "CUST-008",
- "ParentId": "CUST-019",
- "Name": "Customer 8"
- }
+ { "id": "CUST-002", "parentId": null , "name": "Customer 2" },
+ { "id": "CUST-007", "parentId": "CUST-023", "name": "Customer 7" },
+ { "id": "CUST-008", "parentId": "CUST-019", "name": "Customer 8" }
],
"failureMessages": [],
"informationalMessages": [],
@@ -45,9 +23,7 @@
},
{
"data": null,
- "failureMessages": [
- "No Customers found."
- ],
+ "failureMessages": ["No Customers found."],
"informationalMessages": [],
"operationWasSuccessful": false
}
diff --git a/schema/Api/CustomerBroker/parts/ContactAddress.json b/schema/Api/CustomerBroker/parts/ContactAddress.json
index 4ddd9bc..8b53eba 100644
--- a/schema/Api/CustomerBroker/parts/ContactAddress.json
+++ b/schema/Api/CustomerBroker/parts/ContactAddress.json
@@ -4,81 +4,18 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "Address1": {
- "type": [
- "string",
- "null"
- ]
- },
- "Address2": {
- "type": [
- "string",
- "null"
- ]
- },
- "Address3": {
- "type": [
- "string",
- "null"
- ]
- },
- "AddressType": {
- "type": [
- "string",
- "null"
- ]
- },
- "City": {
- "type": [
- "string",
- "null"
- ]
- },
- "Company": {
- "type": [
- "string",
- "null"
- ]
- },
- "Country": {
- "type": [
- "string",
- "null"
- ]
- },
- "FaxNumber": {
- "type": [
- "string",
- "null"
- ]
- },
- "Name": {
- "type": [
- "string",
- "null"
- ]
- },
- "PhoneNumber": {
- "type": [
- "string",
- "null"
- ]
- },
- "PostalCode": {
- "type": [
- "string",
- "null"
- ]
- },
- "StateProvince": {
- "type": [
- "string",
- "null"
- ]
- }
+ "address1" : { "type": ["string", "null"] },
+ "address2" : { "type": ["string", "null"] },
+ "address3" : { "type": ["string", "null"] },
+ "addressType" : { "type": ["string", "null"] },
+ "city" : { "type": ["string", "null"] },
+ "company" : { "type": ["string", "null"] },
+ "country" : { "type": ["string", "null"] },
+ "faxNumber" : { "type": ["string", "null"] },
+ "name" : { "type": ["string", "null"] },
+ "phoneNumber" : { "type": ["string", "null"] },
+ "postalCode" : { "type": ["string", "null"] },
+ "stateProvince": { "type": ["string", "null"] }
},
- "required": [
- "Address1",
- "AddressType"
- ]
+ "required": ["address1", "addressType"]
}
diff --git a/schema/Api/CustomerBroker/parts/Customer.json b/schema/Api/CustomerBroker/parts/Customer.json
index 6aebcce..42d6919 100644
--- a/schema/Api/CustomerBroker/parts/Customer.json
+++ b/schema/Api/CustomerBroker/parts/Customer.json
@@ -4,114 +4,28 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "DefaultWarehouseId": {
- "type": [
- "string",
- "null"
- ]
- },
- "Id": {
- "type": "string"
- },
- "BrokerScopes": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
- },
- "ClientSecret": {
- "type": [
- "string",
- "null"
- ]
- },
- "ContactAddress": {
- "$ref": "ContactAddress.json"
- },
- "ContactEmailAddress": {
- "type": [
- "string",
- "null"
- ]
- },
- "EmailNotificationSubscriptions": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "EmailNotificationSubscription.json"
- }
- },
- "InvoiceEmailAddress": {
- "type": [
- "string",
- "null"
- ]
- },
- "Name": {
- "type": "string"
- },
- "ParentCustomer": {
- "$ref": "ParentCustomer.json"
- },
- "Partner": {
- "type": [
- "string",
- "null"
- ]
- },
- "PaymentEmailAddress": {
- "type": [
- "string",
- "null"
- ]
- },
- "PhoneNumber": {
- "type": [
- "string",
- "null"
- ]
- },
- "ProductionFileLocation": {
- "type": [
- "string",
- "null"
- ]
- },
- "SalesRep": {
- "type": [
- "string",
- "null"
- ]
- },
- "ShipMethodMappings": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "ShipMethodMapping.json"
- }
- },
- "Subsidiary": {
- "type": [
- "string",
- "null"
- ]
- },
- "Website": {
- "type": [
- "string",
- "null"
- ]
- }
+ "defaultWarehouseId": { "type": ["string", "null"] },
+ "id": {"type": "string"},
+ "brokerScopes": { "type": ["array", "null"], "items": {"type": "string"} },
+ "clientSecret": { "type": ["string", "null"] },
+ "contactAddress": {"$ref": "ContactAddress.json"},
+ "contactEmailAddress": { "type": ["string", "null"] },
+ "emailNotificationSubscriptions": {
+ "type": ["array", "null"],
+ "items": {"$ref": "EmailNotificationSubscription.json"}
+ },
+ "invoiceEmailAddress": { "type": ["string", "null"] },
+ "name": {"type": "string"},
+ "parentCustomer": {"$ref": "ParentCustomer.json"},
+ "partner": { "type": ["string", "null"] },
+ "paymentEmailAddress": { "type": ["string", "null"] },
+ "phoneNumber": { "type": ["string", "null"] },
+ "productionFileLocation": { "type": ["string", "null"] },
+ "salesRep": { "type": ["string", "null"] },
+ "shipMethodMappings": { "type": ["array", "null"], "items": {"$ref": "ShipMethodMapping.json"} },
+ "sourceSystems": { "type": ["array", "null"], "items": {"$ref": "SourceSystem.json"} },
+ "subsidiary": { "type": ["string", "null"] },
+ "website": { "type": ["string", "null"] }
},
- "required": [
- "Id",
- "Name"
- ]
+ "required": ["id", "name"]
}
diff --git a/schema/Api/CustomerBroker/parts/CustomerId.json b/schema/Api/CustomerBroker/parts/CustomerId.json
index 9ede500..a658dd5 100644
--- a/schema/Api/CustomerBroker/parts/CustomerId.json
+++ b/schema/Api/CustomerBroker/parts/CustomerId.json
@@ -3,12 +3,5 @@
"$id": "CustomerId.json",
"type": "object",
"additionalProperties": false,
- "properties": {
- "CustomerId": {
- "type": [
- "string",
- "null"
- ]
- }
- }
+ "properties": { "customerId": { "type": ["string", "null"] } }
}
diff --git a/schema/Api/CustomerBroker/parts/CustomersList.json b/schema/Api/CustomerBroker/parts/CustomersList.json
index b9221b5..c878ea7 100644
--- a/schema/Api/CustomerBroker/parts/CustomersList.json
+++ b/schema/Api/CustomerBroker/parts/CustomersList.json
@@ -4,23 +4,8 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "Id": {
- "type": [
- "string",
- "null"
- ]
- },
- "ParentId": {
- "type": [
- "string",
- "null"
- ]
- },
- "Name": {
- "type": [
- "string",
- "null"
- ]
- }
+ "id" : { "type": ["string", "null"] },
+ "parentId": { "type": ["string", "null"] },
+ "name" : { "type": ["string", "null"] }
}
}
diff --git a/schema/Api/CustomerBroker/parts/EmailNotificationSubscription.json b/schema/Api/CustomerBroker/parts/EmailNotificationSubscription.json
index c43de73..e109a77 100644
--- a/schema/Api/CustomerBroker/parts/EmailNotificationSubscription.json
+++ b/schema/Api/CustomerBroker/parts/EmailNotificationSubscription.json
@@ -4,20 +4,8 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "EmailNotificationTemplateId": {
- "type": "string"
- },
- "EmailAddresses": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
- }
+ "emailNotificationTemplateId": { "type": "string" },
+ "emailAddresses" : { "type": ["array", "null"], "items": {"type": "string"} }
},
- "required": [
- "EmailNotificationTemplateId"
- ]
+ "required": ["emailNotificationTemplateId"]
}
diff --git a/schema/Api/CustomerBroker/parts/FulfillmentSystemShipMethod.json b/schema/Api/CustomerBroker/parts/FulfillmentSystemShipMethod.json
index 3998f9b..ce356a6 100644
--- a/schema/Api/CustomerBroker/parts/FulfillmentSystemShipMethod.json
+++ b/schema/Api/CustomerBroker/parts/FulfillmentSystemShipMethod.json
@@ -4,22 +4,9 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "FulfillmentSystemId": {
- "type": "integer",
- "format": "int32"
- },
- "FulfillmentSystemShipMethodId": {
- "type": "string"
- },
- "FulfillmentSystemName": {
- "type": [
- "string",
- "null"
- ]
- }
+ "fulfillmentSystemId": {"type": "integer", "format": "int32"},
+ "fulfillmentSystemShipMethodId": {"type": "string"},
+ "fulfillmentSystemName": { "type": ["string", "null"] }
},
- "required": [
- "FulfillmentSystemId",
- "FulfillmentSystemShipMethodId"
- ]
+ "required": ["fulfillmentSystemId", "fulfillmentSystemShipMethodId"]
}
diff --git a/schema/Api/CustomerBroker/parts/ParentCustomer.json b/schema/Api/CustomerBroker/parts/ParentCustomer.json
index 0463a70..cf6f5f5 100644
--- a/schema/Api/CustomerBroker/parts/ParentCustomer.json
+++ b/schema/Api/CustomerBroker/parts/ParentCustomer.json
@@ -3,18 +3,6 @@
"$id": "ParentCustomer.json",
"type": "object",
"additionalProperties": false,
- "properties": {
- "Id": {
- "type": "string"
- },
- "Name": {
- "type": [
- "string",
- "null"
- ]
- }
- },
- "required": [
- "Id"
- ]
+ "properties": { "id": {"type": "string"}, "name": { "type": ["string", "null"] } },
+ "required": ["id"]
}
diff --git a/schema/Api/CustomerBroker/parts/ShipMethodMapping.json b/schema/Api/CustomerBroker/parts/ShipMethodMapping.json
index 949a7a5..8257c8b 100644
--- a/schema/Api/CustomerBroker/parts/ShipMethodMapping.json
+++ b/schema/Api/CustomerBroker/parts/ShipMethodMapping.json
@@ -4,26 +4,12 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "RatesProviderShipMethodId": {
- "type": [
- "string",
- "null"
- ]
- },
- "SourceSystemShipMethodId": {
- "type": "string"
- },
- "FulfillmentSystemShipMethods": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "FulfillmentSystemShipMethod.json"
- }
+ "ratesProviderShipMethodId": { "type": ["string", "null"] },
+ "sourceSystemShipMethodId": {"type": "string"},
+ "fulfillmentSystemShipMethods": {
+ "type": ["array", "null"],
+ "items": {"$ref": "FulfillmentSystemShipMethod.json"}
}
},
- "required": [
- "SourceSystemShipMethodId"
- ]
+ "required": ["sourceSystemShipMethodId"]
}
diff --git a/schema/Api/CustomerBroker/parts/SourceSystem.json b/schema/Api/CustomerBroker/parts/SourceSystem.json
new file mode 100644
index 0000000..0f9b0c1
--- /dev/null
+++ b/schema/Api/CustomerBroker/parts/SourceSystem.json
@@ -0,0 +1,8 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "SourceSystem.json",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": { "id": {"type": "integer", "format": "int32"}, "name": {"type": "string"} },
+ "required": ["id", "name"]
+}
diff --git a/schema/Api/IdentityBroker/GetClientSecretParameters.json b/schema/Api/IdentityBroker/GetClientSecretParameters.json
new file mode 100644
index 0000000..1b8e7ff
--- /dev/null
+++ b/schema/Api/IdentityBroker/GetClientSecretParameters.json
@@ -0,0 +1,15 @@
+{
+ "ClientId": {
+ "in": "path",
+ "name": "clientId",
+ "schema": {"type": "string"},
+ "required": true
+ },
+ "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/IdentityBroker/GetClientSecretResponse.json b/schema/Api/IdentityBroker/GetClientSecretResponse.json
new file mode 100644
index 0000000..7db3c61
--- /dev/null
+++ b/schema/Api/IdentityBroker/GetClientSecretResponse.json
@@ -0,0 +1,13 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "GetClientSecretResponse.json",
+ "allOf": [
+ {"$ref": "../../Common/ApiResponseBase.json"},
+ {
+ "type": "object",
+ "properties": {
+ "data": { "oneOf": [ {"type": "null"}, {"$ref": "parts/ClientSecret.json"} ] }
+ }
+ }
+ ]
+}
diff --git a/schema/Api/IdentityBroker/GetCustomerTokenParameters.json b/schema/Api/IdentityBroker/GetCustomerTokenParameters.json
index 714aab1..011b51c 100644
--- a/schema/Api/IdentityBroker/GetCustomerTokenParameters.json
+++ b/schema/Api/IdentityBroker/GetCustomerTokenParameters.json
@@ -3,9 +3,7 @@
"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"
- },
+ "schema": {"type": "string"},
"required": false
}
-}
\ No newline at end of file
+}
diff --git a/schema/Api/IdentityBroker/GetCustomerTokenRequest.json b/schema/Api/IdentityBroker/GetCustomerTokenRequest.json
index 6aea7ab..41ec911 100644
--- a/schema/Api/IdentityBroker/GetCustomerTokenRequest.json
+++ b/schema/Api/IdentityBroker/GetCustomerTokenRequest.json
@@ -4,21 +4,16 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "SourceSystemId": {
- "type": "integer",
- "format": "int32"
- },
- "ClientName": {
- "type": [
- "string",
- "null"
- ]
- },
- "Password": {
- "type": [
- "string",
- "null"
- ]
+ "sourceSystemId": {"type": "integer", "format": "int32"},
+ "clientName": { "type": ["string", "null"] },
+ "password": { "type": ["string", "null"] }
+ },
+ "required": ["sourceSystemId", "clientName", "password"],
+ "examples": [
+ {
+ "sourceSystemId": 2,
+ "clientName": "Tliw1cu7ad6qbrpBncV1aCoFhQUqVMYn",
+ "password": "l0RHIXhw50egq65DkO3YpawB999UOw1VRgsIlaw8LZQKdS3h5gW-LoJ7wmQTSJLZ"
}
- }
+ ]
}
diff --git a/schema/Api/IdentityBroker/GetCustomerTokenResponse.json b/schema/Api/IdentityBroker/GetCustomerTokenResponse.json
index 7c1fa15..965c3db 100644
--- a/schema/Api/IdentityBroker/GetCustomerTokenResponse.json
+++ b/schema/Api/IdentityBroker/GetCustomerTokenResponse.json
@@ -2,16 +2,21 @@
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "GetCustomerTokenResponse.json",
"allOf": [
- {
- "$ref": "../../Common/ApiResponseBase.json"
- },
+ {"$ref": "../../Common/ApiResponseBase.json"},
{
"type": "object",
- "properties": {
- "data": {
- "$ref": "parts/CustomerToken.json"
- }
- }
+ "properties": { "data": { "oneOf": [ {"type": "null"}, {"$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/GetTokenParameters.json b/schema/Api/IdentityBroker/GetTokenParameters.json
index 714aab1..011b51c 100644
--- a/schema/Api/IdentityBroker/GetTokenParameters.json
+++ b/schema/Api/IdentityBroker/GetTokenParameters.json
@@ -3,9 +3,7 @@
"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"
- },
+ "schema": {"type": "string"},
"required": false
}
-}
\ No newline at end of file
+}
diff --git a/schema/Api/IdentityBroker/GetTokenRequest.json b/schema/Api/IdentityBroker/GetTokenRequest.json
index 14904e0..f4e0179 100644
--- a/schema/Api/IdentityBroker/GetTokenRequest.json
+++ b/schema/Api/IdentityBroker/GetTokenRequest.json
@@ -3,22 +3,12 @@
"$id": "GetTokenRequest.json",
"type": "object",
"additionalProperties": false,
- "properties": {
- "ClientName": {
- "type": "string"
- },
- "Password": {
- "type": "string"
- }
- },
- "required": [
- "ClientName",
- "Password"
- ],
+ "properties": { "clientName": {"type": "string"}, "password": {"type": "string"} },
+ "required": ["clientName", "password"],
"examples": [
- {
- "ClientName": "<client name - sensitive data>",
- "Password": "<client pw - sensitive data>"
+ {
+ "clientName": "Tliw1cu7ad6qbrpBncV1aCoFhQUqVMYn",
+ "password": "l0RHIXhw50egq65DkO3YpawB999UOw1VRgsIlaw8LZQKdS3h5gW-LoJ7wmQTSJLZ"
}
]
}
diff --git a/schema/Api/IdentityBroker/GetTokenResponse.json b/schema/Api/IdentityBroker/GetTokenResponse.json
index a3312a6..7fa2c42 100644
--- a/schema/Api/IdentityBroker/GetTokenResponse.json
+++ b/schema/Api/IdentityBroker/GetTokenResponse.json
@@ -2,27 +2,10 @@
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "GetTokenResponse.json",
"allOf": [
- {
- "$ref": "../../Common/ApiResponseBase.json"
- },
+ {"$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
- }
- ]
- }
- }
+ "properties": { "data": { "oneOf": [ {"type": "null"}, {"$ref": "parts/Token.json"} ] } }
}
],
"examples": [
diff --git a/schema/Api/IdentityBroker/LegacyGetTokenRequest.json b/schema/Api/IdentityBroker/LegacyGetTokenRequest.json
deleted file mode 100644
index 96b4fdb..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": "<client name - sensitive data>",
- "Password": "<client pw - sensitive data>"
- }
- ]
-}
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/ClientSecret.json b/schema/Api/IdentityBroker/parts/ClientSecret.json
new file mode 100644
index 0000000..70748bf
--- /dev/null
+++ b/schema/Api/IdentityBroker/parts/ClientSecret.json
@@ -0,0 +1,13 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "ClientSecret.json",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "client_id" : { "type": ["string", "null"] },
+ "description" : { "type": ["string", "null"] },
+ "client_secret": { "type": ["string", "null"] },
+ "name" : { "type": ["string", "null"] },
+ "tenant" : { "type": ["string", "null"] }
+ }
+}
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/IdentityBroker/parts/Token.json b/schema/Api/IdentityBroker/parts/Token.json
index b9a0842..7cb2255 100644
--- a/schema/Api/IdentityBroker/parts/Token.json
+++ b/schema/Api/IdentityBroker/parts/Token.json
@@ -3,16 +3,6 @@
"$id": "Token.json",
"type": "object",
"additionalProperties": false,
- "properties": {
- "authToken": {
- "type": "string"
- },
- "expiresOn": {
- "type": "string"
- }
- },
- "required": [
- "authToken",
- "expiresOn"
- ]
+ "properties": { "authToken": {"type": "string"}, "expiresOn": {"type": "string"} },
+ "required": ["authToken", "expiresOn"]
}
diff --git a/schema/Api/OfferBroker/CreateCategoryRequest.json b/schema/Api/OfferBroker/CreateCategoryRequest.json
deleted file mode 100644
index 2ffbdd9..0000000
--- a/schema/Api/OfferBroker/CreateCategoryRequest.json
+++ /dev/null
@@ -1,41 +0,0 @@
-{
- "$schema": "http://json-schema.org/draft-07/schema#",
- "$id": "CreateCategoryRequest.json",
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "ParentId": {
- "type": [
- "string",
- "null"
- ]
- },
- "SourceSystemCustomerId": {
- "type": [
- "string",
- "null"
- ]
- },
- "SourceSystemId": {
- "type": "integer",
- "format": "int32"
- },
- "CreateDateTimeUtc": {
- "type": [
- "string",
- "null"
- ]
- },
- "Name": {
- "type": [
- "string",
- "null"
- ]
- }
- },
- "required": [
- "Name",
- "SourceSystemCustomerId",
- "SourceSystemId"
- ]
-}
diff --git a/schema/Api/IdentityBroker/LegacyGetTokenParameters.json b/schema/Api/OfferBroker/CreateOfferCategoryParameters.json
similarity index 84%
rename from schema/Api/IdentityBroker/LegacyGetTokenParameters.json
rename to schema/Api/OfferBroker/CreateOfferCategoryParameters.json
index 714aab1..011b51c 100644
--- a/schema/Api/IdentityBroker/LegacyGetTokenParameters.json
+++ b/schema/Api/OfferBroker/CreateOfferCategoryParameters.json
@@ -3,9 +3,7 @@
"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"
- },
+ "schema": {"type": "string"},
"required": false
}
-}
\ No newline at end of file
+}
diff --git a/schema/Api/OfferBroker/CreateOfferCategoryRequest.json b/schema/Api/OfferBroker/CreateOfferCategoryRequest.json
new file mode 100644
index 0000000..b6654a0
--- /dev/null
+++ b/schema/Api/OfferBroker/CreateOfferCategoryRequest.json
@@ -0,0 +1,7 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "CreateOfferCategoryRequest.json",
+ "$ref": "parts/OfferCategoryFromCreateOfferCategoryRequest.json",
+ "type": "object",
+ "additionalProperties": false
+}
diff --git a/schema/Api/OfferBroker/CreateOfferParameters.json b/schema/Api/OfferBroker/CreateOfferParameters.json
index 714aab1..011b51c 100644
--- a/schema/Api/OfferBroker/CreateOfferParameters.json
+++ b/schema/Api/OfferBroker/CreateOfferParameters.json
@@ -3,9 +3,7 @@
"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"
- },
+ "schema": {"type": "string"},
"required": false
}
-}
\ No newline at end of file
+}
diff --git a/schema/Api/OfferBroker/CreateOfferRequest.json b/schema/Api/OfferBroker/CreateOfferRequest.json
index 7c28336..e9996dc 100644
--- a/schema/Api/OfferBroker/CreateOfferRequest.json
+++ b/schema/Api/OfferBroker/CreateOfferRequest.json
@@ -1,255 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "CreateOfferRequest.json",
+ "$ref": "parts/OfferFromCreateOfferRequest.json",
"type": "object",
- "oneOf": [
- {
- "required": [
- "Id"
- ]
- },
- {
- "required": [
- "Number"
- ]
- }
- ],
- "additionalProperties": false,
- "properties": {
- "CorrelationId": {
- "type": [
- "string",
- "null"
- ],
- "format": "uuid"
- },
- "CustomerId": {
- "type": [
- "string",
- "null"
- ],
- "readOnly": true
- },
- "Id": {
- "type": [
- "string",
- "null"
- ]
- },
- "SourceSystemCustomerId": {
- "type": [
- "string",
- "null"
- ]
- },
- "SourceSystemId": {
- "type": "integer",
- "format": "int32"
- },
- "XmPieTemplateId": {
- "type": [
- "string",
- "null"
- ]
- },
- "XmPieUStoreId": {
- "type": [
- "string",
- "null"
- ]
- },
- "AccessGroups": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
- },
- "AdditionalPropertiesRequiredOnOrder": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "parts/AdditionalPropertiesRequiredOnOrder.json"
- }
- },
- "AvailableEndDate": {
- "type": [
- "string",
- "null"
- ]
- },
- "AvailableStartDate": {
- "type": [
- "string",
- "null"
- ]
- },
- "CategoryIds": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
- },
- "Comments": {
- "type": [
- "string",
- "null"
- ]
- },
- "CreateDateTimeUtc": {
- "type": [
- "string",
- "null"
- ]
- },
- "DefaultPrice": {
- "type": [
- "number",
- "null"
- ],
- "format": "double"
- },
- "Description": {
- "type": [
- "string",
- "null"
- ]
- },
- "DoSuppressShippingAndHandling": {
- "type": [
- "boolean",
- "null"
- ]
- },
- "FixedOrderQuantities": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "number",
- "format": "double"
- }
- },
- "FullImageUrl": {
- "type": [
- "string",
- "null"
- ]
- },
- "IsActive": {
- "type": [
- "boolean",
- "null"
- ]
- },
- "IsTaxable": {
- "type": [
- "boolean",
- "null"
- ]
- },
- "Number": {
- "type": [
- "string",
- "null"
- ]
- },
- "OfferType": {
- "type": [
- "string",
- "null"
- ]
- },
- "OnlyShipMethodsAvailable": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
- },
- "OrderMaximum": {
- "type": [
- "number",
- "null"
- ],
- "format": "double"
- },
- "OrderMinimum": {
- "type": [
- "number",
- "null"
- ],
- "format": "double"
- },
- "PdfUrl": {
- "type": [
- "string",
- "null"
- ]
- },
- "PriceClasses": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "parts/PriceClass.json"
- }
- },
- "ProductClusters": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "parts/ProductCluster.json"
- }
- },
- "SecureEmailBody": {
- "type": [
- "string",
- "null"
- ]
- },
- "SecureEmailSubject": {
- "type": [
- "string",
- "null"
- ]
- },
- "ThumbnailUrl": {
- "type": [
- "string",
- "null"
- ]
- },
- "UnitOfMeasure": {
- "type": [
- "string",
- "null"
- ]
- },
- "WeightInPounds": {
- "type": [
- "number",
- "null"
- ],
- "format": "double"
- }
- },
- "required": [
- "OfferType",
- "SourceSystemCustomerId",
- "SourceSystemId"
- ]
+ "additionalProperties": false
}
diff --git a/schema/Api/OfferBroker/DeleteCategoryRequest.json b/schema/Api/OfferBroker/DeleteCategoryRequest.json
deleted file mode 100644
index 9f77dd4..0000000
--- a/schema/Api/OfferBroker/DeleteCategoryRequest.json
+++ /dev/null
@@ -1,29 +0,0 @@
-{
- "$schema": "http://json-schema.org/draft-07/schema#",
- "$id": "DeleteCategoryRequest.json",
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "CategoryId": {
- "type": [
- "string",
- "null"
- ]
- },
- "SourceSystemCustomerId": {
- "type": [
- "string",
- "null"
- ]
- },
- "SourceSystemId": {
- "type": "integer",
- "format": "int32"
- }
- },
- "required": [
- "CategoryId",
- "SourceSystemCustomerId",
- "SourceSystemId"
- ]
-}
diff --git a/schema/Api/OfferBroker/CreateCategoryParameters.json b/schema/Api/OfferBroker/DeleteOfferCategoryParameters.json
similarity index 84%
rename from schema/Api/OfferBroker/CreateCategoryParameters.json
rename to schema/Api/OfferBroker/DeleteOfferCategoryParameters.json
index 714aab1..011b51c 100644
--- a/schema/Api/OfferBroker/CreateCategoryParameters.json
+++ b/schema/Api/OfferBroker/DeleteOfferCategoryParameters.json
@@ -3,9 +3,7 @@
"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"
- },
+ "schema": {"type": "string"},
"required": false
}
-}
\ No newline at end of file
+}
diff --git a/schema/Api/OfferBroker/DeleteOfferCategoryRequest.json b/schema/Api/OfferBroker/DeleteOfferCategoryRequest.json
new file mode 100644
index 0000000..068c220
--- /dev/null
+++ b/schema/Api/OfferBroker/DeleteOfferCategoryRequest.json
@@ -0,0 +1,8 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "DeleteOfferCategoryRequest.json",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": { "categoryId": { "type": ["string", "null"] } },
+ "required": ["categoryId"]
+}
diff --git a/schema/Api/OfferBroker/DeleteOfferParameters.json b/schema/Api/OfferBroker/DeleteOfferParameters.json
index 714aab1..011b51c 100644
--- a/schema/Api/OfferBroker/DeleteOfferParameters.json
+++ b/schema/Api/OfferBroker/DeleteOfferParameters.json
@@ -3,9 +3,7 @@
"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"
- },
+ "schema": {"type": "string"},
"required": false
}
-}
\ No newline at end of file
+}
diff --git a/schema/Api/OfferBroker/DeleteOfferRequest.json b/schema/Api/OfferBroker/DeleteOfferRequest.json
index c17e819..d653008 100644
--- a/schema/Api/OfferBroker/DeleteOfferRequest.json
+++ b/schema/Api/OfferBroker/DeleteOfferRequest.json
@@ -4,33 +4,8 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "CustomerId": {
- "type": [
- "string",
- "null"
- ],
- "readOnly": true
- },
- "Id": {
- "type": [
- "string",
- "null"
- ]
- },
- "SourceSystemCustomerId": {
- "type": [
- "string",
- "null"
- ]
- },
- "SourceSystemId": {
- "type": "integer",
- "format": "int32"
- }
+ "customerId": { "type": ["string", "null"] },
+ "id" : { "type": ["string", "null"] }
},
- "required": [
- "Id",
- "SourceSystemCustomerId",
- "SourceSystemId"
- ]
+ "required": ["id"]
}
diff --git a/schema/Api/OfferBroker/GetAllOffersRequest.json b/schema/Api/OfferBroker/GetAllOffersRequest.json
deleted file mode 100644
index 87c3a1a..0000000
--- a/schema/Api/OfferBroker/GetAllOffersRequest.json
+++ /dev/null
@@ -1,30 +0,0 @@
-{
- "$schema": "http://json-schema.org/draft-07/schema#",
- "$id": "GetAllOffersRequest.json",
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "SourceSystemCustomerId": {
- "type": [
- "string",
- "null"
- ]
- },
- "SourceSystemId": {
- "type": "integer",
- "format": "int32"
- },
- "DoIncludeDeletedItems": {
- "type": [
- "boolean",
- "null"
- ]
- },
- "UpdatedSinceDateTime": {
- "type": [
- "string",
- "null"
- ]
- }
- }
-}
diff --git a/schema/Api/OfferBroker/GetOfferCategoriesParameters.json b/schema/Api/OfferBroker/GetOfferCategoriesParameters.json
index 714aab1..011b51c 100644
--- a/schema/Api/OfferBroker/GetOfferCategoriesParameters.json
+++ b/schema/Api/OfferBroker/GetOfferCategoriesParameters.json
@@ -3,9 +3,7 @@
"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"
- },
+ "schema": {"type": "string"},
"required": false
}
-}
\ No newline at end of file
+}
diff --git a/schema/Api/OfferBroker/GetOfferCategoriesResponse.json b/schema/Api/OfferBroker/GetOfferCategoriesResponse.json
index cf678ba..fbf3057 100644
--- a/schema/Api/OfferBroker/GetOfferCategoriesResponse.json
+++ b/schema/Api/OfferBroker/GetOfferCategoriesResponse.json
@@ -2,20 +2,13 @@
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "GetOfferCategoriesResponse.json",
"allOf": [
- {
- "$ref": "../../Common/ApiResponseBase.json"
- },
+ {"$ref": "../../Common/ApiResponseBase.json"},
{
"type": "object",
"properties": {
"data": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "parts/OfferCategory.json"
- }
+ "type": ["array", "null"],
+ "items": {"$ref": "parts/OfferCategoryFromGetOfferCategoriesResponse.json"}
}
}
}
diff --git a/schema/Api/OfferBroker/GetOfferInventoryParameters.json b/schema/Api/OfferBroker/GetOfferInventoryParameters.json
index 828d019..ccb4931 100644
--- a/schema/Api/OfferBroker/GetOfferInventoryParameters.json
+++ b/schema/Api/OfferBroker/GetOfferInventoryParameters.json
@@ -3,19 +3,12 @@
"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"
- },
+ "schema": {"type": "string"},
"required": false
},
"OfferIds": {
"in": "query",
"name": "offerIds",
- "schema": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
+ "schema": { "type": "array", "items": {"type": "string"} }
}
-}
\ No newline at end of file
+}
diff --git a/schema/Api/OfferBroker/GetOfferInventoryResponse.json b/schema/Api/OfferBroker/GetOfferInventoryResponse.json
new file mode 100644
index 0000000..c0b2c39
--- /dev/null
+++ b/schema/Api/OfferBroker/GetOfferInventoryResponse.json
@@ -0,0 +1,14 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "GetOfferInventoryResponse.json",
+ "allOf": [
+ {"$ref": "../../Common/ApiResponseBase.json"},
+ {
+ "type": "object",
+ "properties": {
+ "data": { "type": ["array", "null"], "items": {"$ref": "parts/OfferInventory.json"} }
+ }
+ }
+ ],
+ "required": ["data"]
+}
diff --git a/schema/Api/OfferBroker/GetOfferParameters.json b/schema/Api/OfferBroker/GetOfferParameters.json
index 7314e5c..5412af9 100644
--- a/schema/Api/OfferBroker/GetOfferParameters.json
+++ b/schema/Api/OfferBroker/GetOfferParameters.json
@@ -3,17 +3,13 @@
"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"
- },
+ "schema": {"type": "string"},
"required": false
},
"OfferId": {
"in": "path",
"name": "offerId",
- "schema": {
- "type": "string"
- },
+ "schema": {"type": "string"},
"required": true
}
-}
\ No newline at end of file
+}
diff --git a/schema/Api/OfferBroker/GetOfferResponse.json b/schema/Api/OfferBroker/GetOfferResponse.json
index 7e3afad..3cc8571 100644
--- a/schema/Api/OfferBroker/GetOfferResponse.json
+++ b/schema/Api/OfferBroker/GetOfferResponse.json
@@ -2,14 +2,12 @@
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "GetOfferResponse.json",
"allOf": [
- {
- "$ref": "../../Common/ApiResponseBase.json"
- },
+ {"$ref": "../../Common/ApiResponseBase.json"},
{
"type": "object",
"properties": {
"data": {
- "$ref": "parts/Offer.json"
+ "oneOf": [ {"type": "null"}, {"$ref": "parts/OfferFromGetOfferResponse.json"} ]
}
}
}
diff --git a/schema/Api/OfferBroker/GetOffersParameters.json b/schema/Api/OfferBroker/GetOffersParameters.json
index 714aab1..011b51c 100644
--- a/schema/Api/OfferBroker/GetOffersParameters.json
+++ b/schema/Api/OfferBroker/GetOffersParameters.json
@@ -3,9 +3,7 @@
"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"
- },
+ "schema": {"type": "string"},
"required": false
}
-}
\ No newline at end of file
+}
diff --git a/schema/Api/OfferBroker/GetOffersResponse.json b/schema/Api/OfferBroker/GetOffersResponse.json
index 8405b41..11d660e 100644
--- a/schema/Api/OfferBroker/GetOffersResponse.json
+++ b/schema/Api/OfferBroker/GetOffersResponse.json
@@ -2,20 +2,13 @@
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "GetOffersResponse.json",
"allOf": [
- {
- "$ref": "../../Common/ApiResponseBase.json"
- },
+ {"$ref": "../../Common/ApiResponseBase.json"},
{
"type": "object",
"properties": {
"data": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "parts/Offer.json"
- }
+ "type": ["array", "null"],
+ "items": {"$ref": "parts/OfferFromGetOffersResponse.json"}
}
}
}
diff --git a/schema/Api/OfferBroker/UpdateCategoryParameters.json b/schema/Api/OfferBroker/UpdateCategoryParameters.json
deleted file mode 100644
index 714aab1..0000000
--- a/schema/Api/OfferBroker/UpdateCategoryParameters.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/OfferBroker/UpdateCategoryRequest.json b/schema/Api/OfferBroker/UpdateCategoryRequest.json
deleted file mode 100644
index 394f627..0000000
--- a/schema/Api/OfferBroker/UpdateCategoryRequest.json
+++ /dev/null
@@ -1,48 +0,0 @@
-{
- "$schema": "http://json-schema.org/draft-07/schema#",
- "$id": "UpdateCategoryRequest.json",
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "Id": {
- "type": [
- "string",
- "null"
- ]
- },
- "ParentId": {
- "type": [
- "string",
- "null"
- ]
- },
- "SourceSystemCustomerId": {
- "type": [
- "string",
- "null"
- ]
- },
- "SourceSystemId": {
- "type": "integer",
- "format": "int32"
- },
- "Name": {
- "type": [
- "string",
- "null"
- ]
- },
- "UpdateDateTimeUtc": {
- "type": [
- "string",
- "null"
- ]
- }
- },
- "required": [
- "Id",
- "Name",
- "SourceSystemCustomerId",
- "SourceSystemId"
- ]
-}
diff --git a/schema/Api/OfferBroker/DeleteCategoryParameters.json b/schema/Api/OfferBroker/UpdateOfferCategoryParameters.json
similarity index 84%
rename from schema/Api/OfferBroker/DeleteCategoryParameters.json
rename to schema/Api/OfferBroker/UpdateOfferCategoryParameters.json
index 714aab1..011b51c 100644
--- a/schema/Api/OfferBroker/DeleteCategoryParameters.json
+++ b/schema/Api/OfferBroker/UpdateOfferCategoryParameters.json
@@ -3,9 +3,7 @@
"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"
- },
+ "schema": {"type": "string"},
"required": false
}
-}
\ No newline at end of file
+}
diff --git a/schema/Api/OfferBroker/UpdateOfferCategoryRequest.json b/schema/Api/OfferBroker/UpdateOfferCategoryRequest.json
new file mode 100644
index 0000000..f8a4829
--- /dev/null
+++ b/schema/Api/OfferBroker/UpdateOfferCategoryRequest.json
@@ -0,0 +1,7 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "UpdateOfferCategoryRequest.json",
+ "$ref": "parts/OfferCategoryFromUpdateOfferCategoryRequest.json",
+ "type": "object",
+ "additionalProperties": false
+}
diff --git a/schema/Api/OfferBroker/UpdateOfferParameters.json b/schema/Api/OfferBroker/UpdateOfferParameters.json
index 714aab1..011b51c 100644
--- a/schema/Api/OfferBroker/UpdateOfferParameters.json
+++ b/schema/Api/OfferBroker/UpdateOfferParameters.json
@@ -3,9 +3,7 @@
"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"
- },
+ "schema": {"type": "string"},
"required": false
}
-}
\ No newline at end of file
+}
diff --git a/schema/Api/OfferBroker/UpdateOfferRequest.json b/schema/Api/OfferBroker/UpdateOfferRequest.json
index ce186ca..ceb1f66 100644
--- a/schema/Api/OfferBroker/UpdateOfferRequest.json
+++ b/schema/Api/OfferBroker/UpdateOfferRequest.json
@@ -1,268 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "UpdateOfferRequest.json",
+ "$ref": "parts/OfferFromUpdateOfferRequest.json",
"type": "object",
- "oneOf": [
- {
- "required": [
- "Id"
- ]
- },
- {
- "required": [
- "Number"
- ]
- }
- ],
- "additionalProperties": false,
- "properties": {
- "CorrelationId": {
- "type": [
- "string",
- "null"
- ],
- "format": "uuid"
- },
- "CustomerId": {
- "type": [
- "string",
- "null"
- ],
- "readOnly": true
- },
- "Id": {
- "type": "string"
- },
- "SourceSystemCustomerId": {
- "type": [
- "string",
- "null"
- ]
- },
- "SourceSystemId": {
- "type": "integer",
- "format": "int32"
- },
- "XmPieTemplateId": {
- "type": [
- "string",
- "null"
- ]
- },
- "XmPieUStoreId": {
- "type": [
- "string",
- "null"
- ]
- },
- "AccessGroups": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
- },
- "AdditionalPropertiesRequiredOnOrder": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "parts/AdditionalPropertiesRequiredOnOrder.json"
- }
- },
- "AvailableEndDate": {
- "type": [
- "string",
- "null"
- ]
- },
- "AvailableStartDate": {
- "type": [
- "string",
- "null"
- ]
- },
- "CategoryIds": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
- },
- "Comments": {
- "type": [
- "string",
- "null"
- ]
- },
- "CreateDateTimeUtc": {
- "type": [
- "string",
- "null"
- ]
- },
- "DefaultPrice": {
- "type": [
- "number",
- "null"
- ],
- "format": "double"
- },
- "Description": {
- "type": [
- "string",
- "null"
- ]
- },
- "DoSuppressShippingAndHandling": {
- "type": [
- "boolean",
- "null"
- ]
- },
- "FixedOrderQuantities": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "number",
- "format": "double"
- }
- },
- "FullImageUrl": {
- "type": [
- "string",
- "null"
- ]
- },
- "IsActive": {
- "type": [
- "boolean",
- "null"
- ]
- },
- "IsTaxable": {
- "type": [
- "boolean",
- "null"
- ]
- },
- "Number": {
- "type": [
- "string",
- "null"
- ]
- },
- "OfferType": {
- "type": [
- "string",
- "null"
- ]
- },
- "OnlyShipMethodsAvailable": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
- },
- "OrderMaximum": {
- "type": [
- "number",
- "null"
- ],
- "format": "double"
- },
- "OrderMinimum": {
- "type": [
- "number",
- "null"
- ],
- "format": "double"
- },
- "PdfUrl": {
- "type": [
- "string",
- "null"
- ]
- },
- "PriceClasses": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "parts/PriceClass.json"
- }
- },
- "ProductClusters": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "parts/ProductCluster.json"
- }
- },
- "Products": {
- "description": "Offer level product details",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "parts/Product.json"
- },
- "examples": [
- {
- "ProductId": "JGI-BTU-BFUI-5022-9773",
- "ProductQuantityInOffer": 2
- }
- ]
- },
- "SecureEmailBody": {
- "type": [
- "string",
- "null"
- ]
- },
- "SecureEmailSubject": {
- "type": [
- "string",
- "null"
- ]
- },
- "ThumbnailUrl": {
- "type": [
- "string",
- "null"
- ]
- },
- "UnitOfMeasure": {
- "type": [
- "string",
- "null"
- ]
- },
- "WeightInPounds": {
- "type": [
- "number",
- "null"
- ],
- "format": "double"
- }
- },
- "required": [
- "OfferType",
- "SourceSystemCustomerId",
- "SourceSystemId"
- ]
+ "additionalProperties": false
}
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
deleted file mode 100644
index 8e86d63..0000000
--- a/schema/Api/OfferBroker/parts/AdditionalPropsRequiredOnOrder.json
+++ /dev/null
@@ -1,38 +0,0 @@
-{
- "$schema": "http://json-schema.org/draft-07/schema#",
- "$id": "AdditionalPropsRequiredOnOrder.json",
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "Hint": {
- "type": [
- "string",
- "null"
- ]
- },
- "Label": {
- "type": [
- "string",
- "null"
- ]
- },
- "Name": {
- "type": [
- "string",
- "null"
- ]
- },
- "Type": {
- "type": [
- "string",
- "null"
- ]
- },
- "Value": {
- "type": [
- "string",
- "null"
- ]
- }
- }
-}
diff --git a/schema/Api/OfferBroker/parts/AdditionalPropsRequiredOnOrderInput.json b/schema/Api/OfferBroker/parts/AdditionalPropsRequiredOnOrderInput.json
new file mode 100644
index 0000000..38dc74f
--- /dev/null
+++ b/schema/Api/OfferBroker/parts/AdditionalPropsRequiredOnOrderInput.json
@@ -0,0 +1,9 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "AdditionalPropsRequiredOnOrderInput.json",
+ "type": "object",
+ "properties": {
+ "type": { "type": ["string", "null"] },
+ "name": { "type": ["string", "null"] }
+ }
+}
diff --git a/schema/Api/OfferBroker/parts/AdditionalPropsRequiredOnOrderOutput.json b/schema/Api/OfferBroker/parts/AdditionalPropsRequiredOnOrderOutput.json
new file mode 100644
index 0000000..350d7d8
--- /dev/null
+++ b/schema/Api/OfferBroker/parts/AdditionalPropsRequiredOnOrderOutput.json
@@ -0,0 +1,12 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "AdditionalPropsRequiredOnOrderOutput.json",
+ "type": "object",
+ "properties": {
+ "type" : { "type": ["string", "null"] },
+ "hint" : { "type": ["string", "null"] },
+ "label": { "type": ["string", "null"] },
+ "name" : { "type": ["string", "null"] },
+ "value": { "type": ["string", "null"] }
+ }
+}
diff --git a/schema/Api/OfferBroker/parts/Category.json b/schema/Api/OfferBroker/parts/Category.json
deleted file mode 100644
index 8378834..0000000
--- a/schema/Api/OfferBroker/parts/Category.json
+++ /dev/null
@@ -1,20 +0,0 @@
-{
- "$schema": "http://json-schema.org/draft-07/schema#",
- "$id": "Category.json",
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "CategoryKey": {
- "type": [
- "string",
- "null"
- ]
- },
- "Name": {
- "type": [
- "string",
- "null"
- ]
- }
- }
-}
diff --git a/schema/Api/OfferBroker/parts/Offer.json b/schema/Api/OfferBroker/parts/Offer.json
index 5721170..57f063c 100644
--- a/schema/Api/OfferBroker/parts/Offer.json
+++ b/schema/Api/OfferBroker/parts/Offer.json
@@ -2,228 +2,35 @@
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "Offer.json",
"type": "object",
- "additionalProperties": false,
"properties": {
- "Id": {
- "type": [
- "string",
- "null"
- ]
- },
- "OmsOfferId": {
- "type": [
- "string",
- "null"
- ]
- },
- "XmPieTemplateId": {
- "type": [
- "string",
- "null"
- ]
- },
- "XmPieUStoreId": {
- "type": [
- "string",
- "null"
- ]
- },
- "AccessGroups": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
- },
- "AdditionalPropsRequiredOnOrder": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "AdditionalPropsRequiredOnOrder.json"
- }
- },
- "AvailableEndDate": {
- "type": [
- "string",
- "null"
- ]
- },
- "AvailableStartDate": {
- "type": [
- "string",
- "null"
- ]
- },
- "Categories": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "Category.json"
- }
- },
- "CategoryIds": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
- },
- "Comments": {
- "type": [
- "string",
- "null"
- ]
- },
- "DefaultPrice": {
- "type": [
- "number",
- "null"
- ],
- "format": "double"
- },
- "Description": {
- "type": [
- "string",
- "null"
- ]
- },
- "DoSuppressShippingAndHandling": {
- "type": "boolean"
- },
- "FixedOrderQuantities": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "FullImageUrl": {
- "type": [
- "string",
- "null"
- ]
- },
- "IntegrationBrokerLastUpdatedDateTimeUtc": {
- "type": "string"
- },
- "IsActive": {
- "type": "boolean"
- },
- "IsDeleted": {
- "type": "boolean"
- },
- "IsInventoried": {
- "type": "boolean"
- },
- "IsTaxable": {
- "type": "boolean"
- },
- "LastUpdatedDateTimeUTC": {
- "type": "string"
- },
- "Number": {
- "type": [
- "string",
- "null"
- ]
- },
- "OfferType": {
- "type": [
- "string",
- "null"
- ]
- },
- "OmsIdentifier": {
- "type": [
- "string",
- "null"
- ]
- },
- "OmsRootSystemName": {
- "type": [
- "string",
- "null"
- ]
- },
- "OnlyShipMethodsAvailable": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
- },
- "OrderMaximum": {
- "type": [
- "integer",
- "null"
- ],
- "format": "int32"
- },
- "OrderMinimum": {
- "type": [
- "integer",
- "null"
- ],
- "format": "int32"
- },
- "PdfUrl": {
- "type": [
- "string",
- "null"
- ]
- },
- "PriceClasses": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "PriceClass.json"
- }
- },
- "ProductClusters": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "ProductCluster.json"
- }
- },
- "SchemaVersion": {
- "type": [
- "string",
- "null"
- ]
- },
- "ThumbnailUrl": {
- "type": [
- "string",
- "null"
- ]
- },
- "UnitOfMeasure": {
- "type": [
- "string",
- "null"
- ]
- },
- "WeightInPounds": {
- "type": "number",
- "format": "float"
- }
+ "omsOfferId": { "type": ["string", "null"] },
+ "xmPieTemplateId": { "type": ["string", "null"] },
+ "xmPieUStoreId": { "type": ["string", "null"] },
+ "accessGroups": { "type": ["array", "null"], "items": {"type": "string"} },
+ "availableEndDate": { "type": ["string", "null"] },
+ "availableStartDate": { "type": ["string", "null"] },
+ "categoryIds": { "type": ["array", "null"], "items": {"type": "string"} },
+ "comments": { "type": ["string", "null"] },
+ "defaultPrice": { "type": ["number", "null"], "format": "double" },
+ "doSuppressShippingAndHandling": {"type": "boolean"},
+ "fixedOrderQuantities": { "type": ["array", "null"], "items": {"type": "integer", "format": "int32"} },
+ "fullImageUrl": { "type": ["string", "null"] },
+ "isActive": {"type": "boolean"},
+ "isAvailableViaCoopFunds": { "type": ["boolean", "null"] },
+ "isInventoried": { "type": ["boolean", "null"] },
+ "isTaxable": {"type": "boolean"},
+ "number": { "type": ["string", "null"] },
+ "offerType": { "type": ["string", "null"] },
+ "onlyShipMethodsAvailable": { "type": ["array", "null"], "items": {"type": "string"} },
+ "orderMaximum": { "type": ["integer", "null"], "format": "int32" },
+ "orderMinimum": { "type": ["integer", "null"], "format": "int32" },
+ "pdfUrl": { "type": ["string", "null"] },
+ "requiresApproval": { "type": ["boolean", "null"] },
+ "secureEmailBody": { "type": ["string", "null"] },
+ "secureEmailSubject": { "type": ["string", "null"] },
+ "surcharge": {"type": "number", "format": "double"},
+ "thumbnailUrl": { "type": ["string", "null"] },
+ "unitOfMeasure": { "type": ["string", "null"] },
+ "weightInPounds": {"type": "number", "format": "float"}
}
}
diff --git a/schema/Api/OfferBroker/parts/OfferCategory.json b/schema/Api/OfferBroker/parts/OfferCategory.json
deleted file mode 100644
index d9c6126..0000000
--- a/schema/Api/OfferBroker/parts/OfferCategory.json
+++ /dev/null
@@ -1,42 +0,0 @@
-{
- "$schema": "http://json-schema.org/draft-07/schema#",
- "$id": "OfferCategory.json",
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "Id": {
- "type": [
- "string",
- "null"
- ]
- },
- "CategoryKey": {
- "type": [
- "string",
- "null"
- ]
- },
- "CategoryLevel": {
- "type": [
- "integer",
- "null"
- ],
- "format": "int32"
- },
- "CategoryName": {
- "type": [
- "string",
- "null"
- ]
- },
- "SubCategories": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "SubCategory.json"
- }
- }
- }
-}
diff --git a/schema/Api/OfferBroker/parts/OfferCategoryFromCreateOfferCategoryRequest.json b/schema/Api/OfferBroker/parts/OfferCategoryFromCreateOfferCategoryRequest.json
new file mode 100644
index 0000000..014e118
--- /dev/null
+++ b/schema/Api/OfferBroker/parts/OfferCategoryFromCreateOfferCategoryRequest.json
@@ -0,0 +1,11 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "OfferCategoryFromCreateOfferCategoryRequest.json",
+ "type": "object",
+ "properties": {
+ "parentId" : { "type": ["string", "null"] },
+ "lastUpdatedDateTimeUtc": { "type": ["string", "null"] },
+ "name" : { "type": ["string", "null"] }
+ },
+ "required": ["name"]
+}
diff --git a/schema/Api/OfferBroker/parts/OfferCategoryFromGetOfferCategoriesResponse.json b/schema/Api/OfferBroker/parts/OfferCategoryFromGetOfferCategoriesResponse.json
new file mode 100644
index 0000000..afe6b13
--- /dev/null
+++ b/schema/Api/OfferBroker/parts/OfferCategoryFromGetOfferCategoriesResponse.json
@@ -0,0 +1,13 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "OfferCategoryFromGetOfferCategoriesResponse.json",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "id": { "type": ["string", "null"] },
+ "categoryKey": { "type": ["string", "null"] },
+ "categoryLevel": { "type": ["integer", "null"], "format": "int32" },
+ "categoryName": { "type": ["string", "null"] },
+ "subCategories": { "type": ["array", "null"], "items": {"$ref": "SubCategory.json"} }
+ }
+}
diff --git a/schema/Api/OfferBroker/parts/OfferCategoryFromGetOfferResponse.json b/schema/Api/OfferBroker/parts/OfferCategoryFromGetOfferResponse.json
new file mode 100644
index 0000000..81892a1
--- /dev/null
+++ b/schema/Api/OfferBroker/parts/OfferCategoryFromGetOfferResponse.json
@@ -0,0 +1,10 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "OfferCategoryFromGetOfferResponse.json",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "categoryKey": { "type": ["string", "null"] },
+ "name" : { "type": ["string", "null"] }
+ }
+}
diff --git a/schema/Api/OfferBroker/parts/OfferCategoryFromGetOffersResponse.json b/schema/Api/OfferBroker/parts/OfferCategoryFromGetOffersResponse.json
new file mode 100644
index 0000000..2c32309
--- /dev/null
+++ b/schema/Api/OfferBroker/parts/OfferCategoryFromGetOffersResponse.json
@@ -0,0 +1,10 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "OfferCategoryFromGetOffersResponse.json",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "categoryKey": { "type": ["string", "null"] },
+ "name" : { "type": ["string", "null"] }
+ }
+}
diff --git a/schema/Api/OfferBroker/parts/OfferCategoryFromUpdateOfferCategoryRequest.json b/schema/Api/OfferBroker/parts/OfferCategoryFromUpdateOfferCategoryRequest.json
new file mode 100644
index 0000000..bb7528d
--- /dev/null
+++ b/schema/Api/OfferBroker/parts/OfferCategoryFromUpdateOfferCategoryRequest.json
@@ -0,0 +1,12 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "OfferCategoryFromUpdateOfferCategoryRequest.json",
+ "type": "object",
+ "properties": {
+ "id" : { "type": ["string", "null"] },
+ "parentId" : { "type": ["string", "null"] },
+ "lastUpdatedDateTimeUtc": { "type": ["string", "null"] },
+ "name" : { "type": ["string", "null"] }
+ },
+ "required": ["id", "name"]
+}
diff --git a/schema/Api/OfferBroker/parts/OfferFromCreateOfferRequest.json b/schema/Api/OfferBroker/parts/OfferFromCreateOfferRequest.json
new file mode 100644
index 0000000..2929bab
--- /dev/null
+++ b/schema/Api/OfferBroker/parts/OfferFromCreateOfferRequest.json
@@ -0,0 +1,17 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "OfferFromCreateOfferRequest.json",
+ "type": "object",
+ "allOf": [
+ {"$ref": "Offer.json"},
+ {
+ "type": "object",
+ "properties": {
+ "correlationId": { "type": ["string", "null"], "format": "uuid" },
+ "customerId": { "type": ["string", "null"] },
+ "lastUpdatedDateTimeUtc": { "type": ["string", "null"] }
+ }
+ }
+ ],
+ "additionalProperties": false
+}
diff --git a/schema/Api/OfferBroker/parts/OfferFromGetOfferResponse.json b/schema/Api/OfferBroker/parts/OfferFromGetOfferResponse.json
new file mode 100644
index 0000000..19fb2e5
--- /dev/null
+++ b/schema/Api/OfferBroker/parts/OfferFromGetOfferResponse.json
@@ -0,0 +1,21 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "OfferFromGetOfferResponse.json",
+ "type": "object",
+ "allOf": [
+ {"$ref": "Offer.json"},
+ {
+ "type": "object",
+ "properties": {
+ "id" : { "type": ["string", "null"] },
+ "integrationBrokerLastUpdatedDateTimeUtc": { "type": "string" },
+ "isDeleted" : { "type": "boolean" },
+ "lastUpdatedDateTimeUTC" : { "type": "string" },
+ "omsIdentifier" : { "type": ["string", "null"] },
+ "omsRootSystemName" : { "type": ["string", "null"] },
+ "schemaVersion" : { "type": ["string", "null"] }
+ }
+ }
+ ],
+ "additionalProperties": false
+}
diff --git a/schema/Api/OfferBroker/parts/OfferFromGetOffersResponse.json b/schema/Api/OfferBroker/parts/OfferFromGetOffersResponse.json
new file mode 100644
index 0000000..8649140
--- /dev/null
+++ b/schema/Api/OfferBroker/parts/OfferFromGetOffersResponse.json
@@ -0,0 +1,21 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "OfferFromGetOffersResponse.json",
+ "type": "object",
+ "allOf": [
+ {"$ref": "Offer.json"},
+ {
+ "type": "object",
+ "properties": {
+ "id" : { "type": ["string", "null"] },
+ "integrationBrokerLastUpdatedDateTimeUtc": { "type": "string" },
+ "isDeleted" : { "type": "boolean" },
+ "lastUpdatedDateTimeUTC" : { "type": "string" },
+ "omsIdentifier" : { "type": ["string", "null"] },
+ "omsRootSystemName" : { "type": ["string", "null"] },
+ "schemaVersion" : { "type": ["string", "null"] }
+ }
+ }
+ ],
+ "additionalProperties": false
+}
diff --git a/schema/Api/OfferBroker/parts/OfferFromUpdateOfferRequest.json b/schema/Api/OfferBroker/parts/OfferFromUpdateOfferRequest.json
new file mode 100644
index 0000000..4a5d624
--- /dev/null
+++ b/schema/Api/OfferBroker/parts/OfferFromUpdateOfferRequest.json
@@ -0,0 +1,17 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "OfferFromUpdateOfferRequest.json",
+ "type": "object",
+ "allOf": [
+ {"$ref": "Offer.json"},
+ {
+ "type": "object",
+ "properties": {
+ "correlationId": { "type": ["string", "null"], "format": "uuid" },
+ "customerId": { "type": ["string", "null"] },
+ "lastUpdatedDateTimeUtc": { "type": ["string", "null"] }
+ }
+ }
+ ],
+ "additionalProperties": false
+}
diff --git a/schema/Api/OfferBroker/parts/OfferInventory.json b/schema/Api/OfferBroker/parts/OfferInventory.json
new file mode 100644
index 0000000..663574f
--- /dev/null
+++ b/schema/Api/OfferBroker/parts/OfferInventory.json
@@ -0,0 +1,15 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "OfferInventory.json",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "offerId" : { "type": ["string", "null"] },
+ "currentAvailableQty": { "type": "integer" , "format": "int32" },
+ "currentOnHandQty" : { "type": "integer" , "format": "int32" },
+ "expected" : { "type": ["integer", "null"], "format": "int32" },
+ "onBackorder" : { "type": ["integer", "null"], "format": "int32" },
+ "reserved" : { "type": "integer" , "format": "int32" }
+ },
+ "required": ["currentAvailableQty", "offerId", "reserved"]
+}
diff --git a/schema/Api/OfferBroker/parts/PriceClass.json b/schema/Api/OfferBroker/parts/PriceClass.json
index befffec..8778881 100644
--- a/schema/Api/OfferBroker/parts/PriceClass.json
+++ b/schema/Api/OfferBroker/parts/PriceClass.json
@@ -2,30 +2,9 @@
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "PriceClass.json",
"type": "object",
- "additionalProperties": false,
"properties": {
- "Name": {
- "type": [
- "string",
- "null"
- ]
- },
- "Price": {
- "description": "Total offer price of individual line item",
- "type": [
- "number",
- "null"
- ],
- "format": "double"
- },
- "PriceTiers": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "PriceTier.json"
- }
- }
+ "name": { "type": ["string", "null"] },
+ "price": { "type": ["number", "null"], "format": "double" },
+ "priceTiers": { "type": ["array", "null"], "items": {"$ref": "PriceTier.json"} }
}
}
diff --git a/schema/Api/OfferBroker/parts/PriceTier.json b/schema/Api/OfferBroker/parts/PriceTier.json
index ca01c93..612bb87 100644
--- a/schema/Api/OfferBroker/parts/PriceTier.json
+++ b/schema/Api/OfferBroker/parts/PriceTier.json
@@ -2,29 +2,9 @@
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "PriceTier.json",
"type": "object",
- "additionalProperties": false,
"properties": {
- "MaximumQuantity": {
- "type": [
- "number",
- "null"
- ],
- "format": "double"
- },
- "MinimumQuantity": {
- "type": [
- "number",
- "null"
- ],
- "format": "double"
- },
- "Price": {
- "description": "Total offer price of individual line item",
- "type": "number",
- "format": "double"
- }
- },
- "required": [
- "Price"
- ]
+ "maximumQuantity": { "type": ["integer", "null"], "format": "int32" },
+ "minimumQuantity": { "type": ["integer", "null"], "format": "int32" },
+ "price" : { "type": "number" , "format": "double" }
+ }
}
diff --git a/schema/Api/OfferBroker/parts/Product.json b/schema/Api/OfferBroker/parts/Product.json
deleted file mode 100644
index b75b4b2..0000000
--- a/schema/Api/OfferBroker/parts/Product.json
+++ /dev/null
@@ -1,23 +0,0 @@
-{
- "$schema": "http://json-schema.org/draft-07/schema#",
- "$id": "Product.json",
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "ProductId": {
- "description": "Unique ID for component product within Integration Broker",
- "type": [
- "string",
- "null"
- ]
- },
- "ProductQuantityInOffer": {
- "type": "integer",
- "format": "int32"
- }
- },
- "required": [
- "ProductId",
- "ProductQuantityInOffer"
- ]
-}
diff --git a/schema/Api/OfferBroker/parts/ProductCluster.json b/schema/Api/OfferBroker/parts/ProductCluster.json
deleted file mode 100644
index 369655c..0000000
--- a/schema/Api/OfferBroker/parts/ProductCluster.json
+++ /dev/null
@@ -1,26 +0,0 @@
-{
- "$schema": "http://json-schema.org/draft-07/schema#",
- "$id": "ProductCluster.json",
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "ClusterId": {
- "type": [
- "string",
- "null"
- ]
- },
- "Products": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "Product.json"
- }
- }
- },
- "required": [
- "ClusterId"
- ]
-}
diff --git a/schema/Api/OfferBroker/parts/ProductClusterInput.json b/schema/Api/OfferBroker/parts/ProductClusterInput.json
new file mode 100644
index 0000000..4f2e443
--- /dev/null
+++ b/schema/Api/OfferBroker/parts/ProductClusterInput.json
@@ -0,0 +1,9 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "ProductClusterInput.json",
+ "type": "object",
+ "properties": {
+ "clusterId": { "type": ["string", "null"] },
+ "products" : { "type": ["array", "null"] , "items": {"$ref": "ProductInput.json"} }
+ }
+}
diff --git a/schema/Api/OfferBroker/parts/ProductClusterOutput.json b/schema/Api/OfferBroker/parts/ProductClusterOutput.json
new file mode 100644
index 0000000..616e9f6
--- /dev/null
+++ b/schema/Api/OfferBroker/parts/ProductClusterOutput.json
@@ -0,0 +1,9 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "ProductClusterOutput.json",
+ "type": "object",
+ "properties": {
+ "id" : { "type": ["string", "null"] },
+ "products": { "type": ["array", "null"] , "items": {"$ref": "ProductOutput.json"} }
+ }
+}
diff --git a/schema/Api/OfferBroker/parts/ProductInput.json b/schema/Api/OfferBroker/parts/ProductInput.json
new file mode 100644
index 0000000..61f078e
--- /dev/null
+++ b/schema/Api/OfferBroker/parts/ProductInput.json
@@ -0,0 +1,9 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "ProductInput.json",
+ "type": "object",
+ "properties": {
+ "productId" : { "type": ["string", "null"] },
+ "productQuantityInOffer": { "type": "integer" , "format": "int32" }
+ }
+}
diff --git a/schema/Api/OfferBroker/parts/ProductOutput.json b/schema/Api/OfferBroker/parts/ProductOutput.json
new file mode 100644
index 0000000..6a6fe43
--- /dev/null
+++ b/schema/Api/OfferBroker/parts/ProductOutput.json
@@ -0,0 +1,17 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "ProductOutput.json",
+ "type": "object",
+ "properties": {
+ "omsProductId": { "type": ["string", "null"] },
+ "productId": { "type": ["string", "null"] },
+ "associatedFileName": { "type": ["string", "null"] },
+ "buildType": { "type": "integer", "enum": [0, 1, 2, 3, 4, 5], "format": "int32" },
+ "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" }
+ }
+}
diff --git a/schema/Api/OfferBroker/GetAllOffersParameters.json b/schema/Api/OrderBroker/InternalNewOrderParameters.json
similarity index 84%
rename from schema/Api/OfferBroker/GetAllOffersParameters.json
rename to schema/Api/OrderBroker/InternalNewOrderParameters.json
index 714aab1..011b51c 100644
--- a/schema/Api/OfferBroker/GetAllOffersParameters.json
+++ b/schema/Api/OrderBroker/InternalNewOrderParameters.json
@@ -3,9 +3,7 @@
"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"
- },
+ "schema": {"type": "string"},
"required": false
}
-}
\ No newline at end of file
+}
diff --git a/schema/Api/OrderBroker/InternalNewOrderRequest.json b/schema/Api/OrderBroker/InternalNewOrderRequest.json
new file mode 100644
index 0000000..58937f0
--- /dev/null
+++ b/schema/Api/OrderBroker/InternalNewOrderRequest.json
@@ -0,0 +1,546 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "InternalNewOrderRequest.json",
+ "description": "Details for Order JSON schema",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "OrderId": {
+ "description": "Unique ID for order within order management system (system where order lifecycle will be managed)",
+ "type": ["string", "null"]
+ },
+ "ReferenceId": { "type": ["string", "null"] },
+ "SourceSystemCustomerId": { "type": ["string", "null"] },
+ "SourceSystemId": {"type": "integer", "format": "int32"},
+ "AccessGroups": { "type": ["array", "null"], "items": {"type": "string"} },
+ "AffiliateIdentifier": {
+ "description": "Unique ID for affiliate within source system (system where order was originally placed)",
+ "type": ["string", "null"]
+ },
+ "AffiliateName": {
+ "description": "Name for affiliate within source system (system where order was originally placed)",
+ "type": ["string", "null"]
+ },
+ "BillTos": {
+ "description": "Bill to addresses array for Order",
+ "type": ["array", "null"],
+ "oneOf": [
+ {"type": "null"},
+ {
+ "type": "array",
+ "items": {"$ref": "parts/BillToFromNewOrderRequest.json"},
+ "minItems": 1
+ }
+ ],
+ "examples": [
+ {
+ "Address1": "106 Tyler Street Suite 175",
+ "Address2": "3181 George Vista",
+ "Address3": "",
+ "City": "West Savannahside",
+ "Company": "Matthews, Mclean and Huynh",
+ "Country": "USA",
+ "EmailAddress": "ghunt@example.com",
+ "FaxNumber": "",
+ "Key": 0,
+ "Name": "Kristin Tyler",
+ "PhoneNumber": "001-990-377-8647x21426",
+ "PostalCode": "69532",
+ "StateProvince": "Idaho"
+ }
+ ]
+ },
+ "CostCenter": { "type": ["string", "null"] },
+ "CreateDateTime": {
+ "description": "Datetime of when order was created",
+ "type": ["string", "null"]
+ },
+ "CreditCardFee": {
+ "description": "Credit card transaction fee applied to Order",
+ "type": ["number", "null"],
+ "format": "double"
+ },
+ "DefaultBillToKey": {
+ "description": "Unique ID for default billing contact details pulled from Order.BillTos.Key property (Only if applicable. Otherwise DefaultBillToKey will be null/empty value) (NOTE: If this value is not set, BillToKey must be set on all line items.)",
+ "type": ["integer", "null"],
+ "format": "int32"
+ },
+ "DefaultOrderedByKey": {
+ "description": "Unique ID for default ordered by contact details pulled from Order.OrderedBy.Key property (Only if applicable. Otherwise DefaultOrderedByKey will be null/empty value)",
+ "type": ["integer", "null"],
+ "format": "int32"
+ },
+ "DefaultShipToKey": {
+ "description": "Unique ID for default ship to contact pulled from Order.ShipTos.Key property (Only if applicable. Otherwise DefaultShipToKey will be null/empty value) (NOTE: If this value is not set, ShipToKey must be set on all line items.)",
+ "type": ["integer", "null"],
+ "format": "int32"
+ },
+ "DueDate": {
+ "description": "Datetime of expected due date for Order",
+ "type": ["string", "null"]
+ },
+ "LineItems": {
+ "description": "Order level line item details",
+ "type": ["array", "null"],
+ "items": {"$ref": "parts/LineItem.json"},
+ "examples": [
+ {
+ "OfferId": "8-998608-269",
+ "ReferenceId": null,
+ "VariableTemplatePrintId": null,
+ "BillToKey": null,
+ "Comment": "HPD-PNP-DRS-TEACONT-0322:",
+ "CostCenter": null,
+ "DueDate": null,
+ "LineItemFee": 1,
+ "OfferDescription": "Tea Container Sticker",
+ "OfferLineNumber": "1",
+ "OfferNumber": "HPD-PNP-DRS-TEACONT-0322",
+ "OrderedByKey": null,
+ "PONumber": null,
+ "Price": 4.57,
+ "Products": [ {"ProductId": "JGI-BTU-BFUI-5022-9773"} ],
+ "QuantityOrdered": 1,
+ "RushOrder": null,
+ "ShipToKey": 0,
+ "TaxAmount": 2.92
+ }
+ ]
+ },
+ "OrderFee": {
+ "description": "Fee applied to Order",
+ "type": ["number", "null"],
+ "format": "double"
+ },
+ "OrderVariables": {
+ "$ref": "parts/OrderVariable.json",
+ "description": "Manually entered variables for order within order management system (system where order lifecycle will be managed in)"
+ },
+ "OrderedBys": {
+ "description": "Order level ordered by contact and address details",
+ "type": ["array", "null"],
+ "oneOf": [
+ {"type": "null"},
+ { "type": "array", "items": {"$ref": "parts/OrderedBy.json"}, "minItems": 1 }
+ ],
+ "examples": [
+ {
+ "Address1": "106 Tyler Street Suite 175",
+ "Address2": "3181 George Vista",
+ "Address3": "",
+ "City": "West Savannahside",
+ "Company": "Matthews, Mclean and Huynh",
+ "Country": "USA",
+ "EmailAddress": "ghunt@example.com",
+ "FaxNumber": "",
+ "Key": 0,
+ "PhoneNumber": "001-990-377-8647x21426",
+ "PostalCode": "02019",
+ "StateProvince": "Idaho"
+ }
+ ]
+ },
+ "PONumber": { "description": "Purchase order number for Order", "type": ["string", "null"] },
+ "PaymentMethods": {
+ "description": "Order.ShipTos level payment method details",
+ "type": ["array", "null"],
+ "items": {"$ref": "parts/PaymentMethod.json"}
+ },
+ "PickPackHandlingFee": {
+ "description": "Sum of pick & pack handling fees for all Order.ShipTos",
+ "type": ["number", "null"],
+ "format": "double"
+ },
+ "RushOrder": {"description": "True/false indicator if Order is expedited", "type": "boolean"},
+ "ShipTos": {
+ "description": "Order level ship to details",
+ "type": ["array", "null"],
+ "oneOf": [
+ {"type": "null"},
+ {
+ "type": "array",
+ "items": {"$ref": "parts/ShipToFromNewOrderRequest.json"},
+ "minItems": 1
+ }
+ ],
+ "examples": [
+ {
+ "AffiliateId": null,
+ "ReferenceId": "BQJ efg Deebjplybqjtgr ",
+ "SourceSystemShippingMethodId": "vos_vrzuqz",
+ "AffiliateName": null,
+ "Comment": "",
+ "CostCenter": "6342091000- IN Medicaid Case Mgmt",
+ "CreditCardFee": null,
+ "DueDate": null,
+ "Key": 0,
+ "OrderFee": 5,
+ "PONumber": null,
+ "PaymentMethods": null,
+ "PickPackHandlingFee": 21,
+ "RushOrder": false,
+ "ShipToAddress": {
+ "Address1": "65677 Laura Village Suite 322",
+ "City": "Catherineshire",
+ "Company": "Nunez-Cardenas",
+ "Country": "USA",
+ "Name": "Julie Lester",
+ "PostalCode": "11460",
+ "StateProvince": "Arizona"
+ },
+ "ShippingCost": 20.22,
+ "ShippingHandlingTax": 2.15,
+ "TotalOrderFee": 5
+ }
+ ]
+ },
+ "ShippingHandlingTax": {
+ "description": "Sum of shipping & handling taxes for all Order.ShipTos",
+ "type": ["number", "null"],
+ "format": "double"
+ },
+ "TotalOrderFee": {
+ "description": "Sum of OrderFee",
+ "type": ["number", "null"],
+ "format": "double"
+ },
+ "TotalShippingCost": {
+ "description": "Sum of shipping cost for all Order.ShipTos.Shipments",
+ "type": ["number", "null"],
+ "format": "double"
+ }
+ },
+ "required": ["SourceSystemId", "OrderId", "LineItems", "ShippingHandlingTax", "BillTos"],
+ "allOf": [
+ {
+ "oneOf": [
+ {
+ "properties": { "DefaultBillToKey": {"type": "integer"} },
+ "required": ["DefaultBillToKey"]
+ },
+ {
+ "not": {
+ "properties": { "DefaultBillToKey": {"type": "integer"} },
+ "required": ["DefaultBillToKey"]
+ },
+ "properties": {
+ "BillTos" : { "type": "array" , "minItems": 1 },
+ "DefaultBillToKey": { "type": ["null", "integer"] }
+ },
+ "required": ["BillTos"]
+ }
+ ]
+ },
+ {
+ "oneOf": [
+ {
+ "properties": { "DefaultShipToKey": {"type": "integer"} },
+ "required": ["DefaultShipToKey"]
+ },
+ {
+ "not": {
+ "properties": { "DefaultShipToKey": {"type": "integer"} },
+ "required": ["DefaultShipToKey"]
+ },
+ "properties": {
+ "DefaultShipToKey": { "type": ["null", "integer"] },
+ "ShipTos" : { "type": "array" , "minItems": 1 }
+ },
+ "required": ["ShipTos"]
+ }
+ ]
+ }
+ ],
+ "examples": [
+ {
+ "OrderId": "7-mkkutsde-3-K-5649-4005-64",
+ "ReferenceId": "OWMR WSKFA - LNSSZT XBUUJ & MS XXQ QCHX",
+ "SourceSystemCustomerId": "1234567890",
+ "SourceSystemId": 3,
+ "AccessGroups": ["TS-Retail", "CDM Tuff Shed", "Tuff shed Act on behalf and see all orders"],
+ "AffiliateIdentifier": "QJ-987",
+ "AffiliateName": "UJ-143-ABWJINHFVL, QD",
+ "BillTos": [
+ {
+ "Address1": "16013 Valenzuela Turnpike",
+ "Address2": null,
+ "Address3": null,
+ "City": "Rosaleshaven",
+ "Company": "Rosales-Shea",
+ "Country": "USA",
+ "EmailAddress": "chelseamiller@example.org",
+ "FaxNumber": "",
+ "Key": 0,
+ "Name": "Gail Stewart",
+ "PhoneNumber": "411-770-8380",
+ "PostalCode": "12507",
+ "StateProvince": "Washington"
+ }
+ ],
+ "CostCenter": "020 - Denver",
+ "CreateDateTime": "2025-02-28T20:37:42.018+00:00",
+ "CreditCardFee": 0.0,
+ "DefaultBillToKey": null,
+ "DefaultOrderedByKey": null,
+ "DefaultShipToKey": null,
+ "DueDate": null,
+ "LineItems": [
+ {
+ "OfferId": "t87grb75-e9pe-5405-y8yv-25n5q70bu93i",
+ "ReferenceId": "BEHZ QUJNS - TPGJXT MMGVN & UX ZDN HHQS",
+ "VariableTemplatePrintId": null,
+ "AdditionalProperties": [],
+ "BillToKey": 0,
+ "Comment": null,
+ "CostCenter": "020 - Denver",
+ "DueDate": null,
+ "LineItemFee": 0.75,
+ "OfferDescription": "<p>$17.00 Each \u2013 S - XL<br>\n$20.00 Each \u2013 2XL - XLarge/Tall Sizes<br>\n$21.50 Each \u2013 3XL - 2XLarge/Tall sizes<br>$25.00 Each - 4XL Sizes - 3XL tall <br>$35.00 Each - 5XL Sizes<br><br></p>",
+ "OfferLineNumber": "0",
+ "OfferNumber": "TS_A-A0050",
+ "OrderedByKey": 0,
+ "PONumber": null,
+ "Price": 17.0,
+ "Products": [
+ {
+ "ProductId": "3j8hu98q-s0t6-409v-029r-321r0uo02k30",
+ "AssociatedFileName": "",
+ "Color": null,
+ "Comment": null,
+ "Components": [],
+ "ProductDescription": "8\"x8\" square paint swatch.",
+ "ProductLineNumber": "1",
+ "ProductNumber": "R_962_24008_TSO",
+ "ProductOwner": null,
+ "QuantityOrdered": null,
+ "Size": null
+ },
+ {
+ "ProductId": "7jv34sz5-m4q8-8q8f-187d-jt7791j02958",
+ "AssociatedFileName": "",
+ "Color": null,
+ "Comment": null,
+ "Components": [],
+ "ProductDescription": "Tuff Shed Men's Polo",
+ "ProductLineNumber": "2",
+ "ProductNumber": "TS_A-A0050",
+ "ProductOwner": null,
+ "QuantityOrdered": null,
+ "Size": null
+ }
+ ],
+ "QuantityOrdered": 1,
+ "RushOrder": false,
+ "ShipToKey": 0,
+ "TaxAmount": 0.0
+ }
+ ],
+ "OrderFee": 4.0,
+ "OrderVariables": {},
+ "OrderedBys": [
+ {
+ "Address1": "42801 Pamela Run",
+ "Address2": null,
+ "Address3": null,
+ "City": "Port Rickside",
+ "Company": "Trujillo-Sims",
+ "Country": "USA",
+ "EmailAddress": "jonesjeff@example.net",
+ "FaxNumber": "",
+ "Key": 0,
+ "Name": "Benjamin Smith",
+ "PhoneNumber": "+1-310-761-3615x7115",
+ "PostalCode": "10330",
+ "StateProvince": "California"
+ }
+ ],
+ "PONumber": null,
+ "PaymentMethods": [ {"Amount": 35.8, "MethodName": "invoice"} ],
+ "PickPackHandlingFee": 0.75,
+ "RushOrder": false,
+ "ShipTos": [
+ {
+ "AffiliateId": "EK-023",
+ "ReferenceId": "QGSN VNSAH - PWJRVG OCYIA & PG GAE RZTN",
+ "SourceSystemShippingMethodId": "qnigy_cxdcmo",
+ "AffiliateName": "JK-467-WLTQIEOCCZ, PA",
+ "Comment": null,
+ "CostCenter": "020 - Denver",
+ "CreditCardFee": 0.0,
+ "DueDate": null,
+ "Key": 0,
+ "OrderFee": 4.0,
+ "PONumber": null,
+ "PaymentMethods": [],
+ "PickPackHandlingFee": 0.75,
+ "RushOrder": false,
+ "ShipToAddress": {
+ "Address1": "130 Owen Gateway",
+ "Address2": null,
+ "Address3": null,
+ "City": "Arthurborough",
+ "Company": "Bryant-Compton",
+ "Country": "USA",
+ "EmailAddress": "yduran@example.com",
+ "FaxNumber": "",
+ "Name": "Patricia Parker",
+ "PhoneNumber": "317.410.1217",
+ "PostalCode": "96718",
+ "StateProvince": "Georgia"
+ },
+ "ShippingCost": 13.66,
+ "ShippingHandlingTax": 0.39,
+ "TotalOrderFee": 4.0
+ }
+ ],
+ "ShippingHandlingTax": 0.39,
+ "TotalOrderFee": 4.0,
+ "TotalShippingCost": 13.66
+ },
+ {
+ "OrderId": "1-qrhjtpek-8-Q-0286-8859-25",
+ "ReferenceId": "WUQD HWKPE - XIWHAC BTVOM & BH WAK DXRI",
+ "SourceSystemCustomerId": "1234567890",
+ "SourceSystemId": 3,
+ "AccessGroups": ["TS-Retail", "CDM Tuff Shed", "Tuff shed Act on behalf and see all orders"],
+ "AffiliateIdentifier": "VJ-268",
+ "AffiliateName": "GZ-589-WUOFETGVLG, RM",
+ "BillTos": [
+ {
+ "Address1": "547 James Ports",
+ "Address2": null,
+ "Address3": null,
+ "City": "Angelastad",
+ "Company": "Jones-Hurst",
+ "Country": "USA",
+ "EmailAddress": "rjohnson@example.net",
+ "FaxNumber": "",
+ "Key": 0,
+ "Name": "Joseph Hayes",
+ "PhoneNumber": "001-226-553-1291x1555",
+ "PostalCode": "68236",
+ "StateProvince": "Missouri"
+ }
+ ],
+ "CostCenter": "020 - Denver",
+ "CreateDateTime": "2025-02-28T20:37:42.018+00:00",
+ "CreditCardFee": 0.0,
+ "DefaultBillToKey": null,
+ "DefaultOrderedByKey": null,
+ "DefaultShipToKey": null,
+ "DueDate": null,
+ "LineItems": [
+ {
+ "OfferId": "s59otw94-k6go-1114-c6ja-17q7i68pu06t",
+ "ReferenceId": "VNMV APSLE - GMGDGG ELXCC & VS FUP NCHR",
+ "VariableTemplatePrintId": null,
+ "AdditionalProperties": [],
+ "BillToKey": 0,
+ "Comment": null,
+ "CostCenter": "020 - Denver",
+ "DueDate": null,
+ "LineItemFee": 0.75,
+ "OfferDescription": "<p>$17.00 Each \u2013 S - XL<br>\n$20.00 Each \u2013 2XL - XLarge/Tall Sizes<br>\n$21.50 Each \u2013 3XL - 2XLarge/Tall sizes<br>$25.00 Each - 4XL Sizes - 3XL tall <br>$35.00 Each - 5XL Sizes<br><br></p>",
+ "OfferLineNumber": "0",
+ "OfferNumber": "TS_A-A0050",
+ "OrderedByKey": 0,
+ "PONumber": null,
+ "Price": 17.0,
+ "Products": [
+ {
+ "ProductId": "1t6xb26e-g4n3-882j-217s-200f1fp92e83",
+ "AssociatedFileName": "",
+ "Color": null,
+ "Comment": null,
+ "Components": [],
+ "ProductDescription": "8\"x8\" square paint swatch.",
+ "ProductLineNumber": "1",
+ "ProductNumber": "R_962_24008_TSO",
+ "ProductOwner": null,
+ "QuantityOrdered": null,
+ "Size": null
+ },
+ {
+ "ProductId": "3sn29wd7-z0g3-5z6f-133y-yt7327a65247",
+ "AssociatedFileName": "",
+ "Color": null,
+ "Comment": null,
+ "Components": [],
+ "ProductDescription": "Tuff Shed Men's Polo",
+ "ProductLineNumber": "2",
+ "ProductNumber": "TS_A-A0050",
+ "ProductOwner": null,
+ "QuantityOrdered": null,
+ "Size": null
+ }
+ ],
+ "QuantityOrdered": 1,
+ "RushOrder": false,
+ "ShipToKey": 0,
+ "TaxAmount": 0.0
+ }
+ ],
+ "OrderFee": 4.0,
+ "OrderVariables": {},
+ "OrderedBys": [
+ {
+ "Address1": "6084 Stephanie Lodge",
+ "Address2": null,
+ "Address3": null,
+ "City": "South Donald",
+ "Company": "Mccullough Group",
+ "Country": "USA",
+ "EmailAddress": "murphytracy@example.net",
+ "FaxNumber": "",
+ "Key": 0,
+ "Name": "Joshua Pena",
+ "PhoneNumber": "898-997-8385x11658",
+ "PostalCode": "44793",
+ "StateProvince": "Alaska"
+ }
+ ],
+ "PONumber": null,
+ "PaymentMethods": [ {"Amount": 35.8, "MethodName": "invoice"} ],
+ "PickPackHandlingFee": 0.75,
+ "RushOrder": false,
+ "ShipTos": [
+ {
+ "AffiliateId": "XU-170",
+ "ReferenceId": "ZVZT XMPKV - IZQTEP WTIUT & UL QCX WPSI",
+ "SourceSystemShippingMethodId": "bzman_ehfsxc",
+ "AffiliateName": "EH-565-JEYFOGBQJW, UU",
+ "Comment": null,
+ "CostCenter": "020 - Denver",
+ "CreditCardFee": 0.0,
+ "DueDate": null,
+ "Key": 0,
+ "OrderFee": 4.0,
+ "PONumber": null,
+ "PaymentMethods": [],
+ "PickPackHandlingFee": 0.75,
+ "RushOrder": false,
+ "ShipToAddress": {
+ "Address1": "9947 Rich Estate",
+ "Address2": null,
+ "Address3": null,
+ "City": "North Megan",
+ "Company": "Lewis, Pierce and Alvarez",
+ "Country": "USA",
+ "EmailAddress": "freemanrobert@example.com",
+ "FaxNumber": "",
+ "Name": "Zachary Gilbert",
+ "PhoneNumber": "001-937-677-3517x2443",
+ "PostalCode": "49875",
+ "StateProvince": "Ohio"
+ },
+ "ShippingCost": 13.66,
+ "ShippingHandlingTax": 0.39,
+ "TotalOrderFee": 4.0
+ }
+ ],
+ "ShippingHandlingTax": 0.39,
+ "TotalOrderFee": 4.0,
+ "TotalShippingCost": 13.66
+ }
+ ]
+}
diff --git a/schema/Api/OrderBroker/NewOrderParameters.json b/schema/Api/OrderBroker/NewOrderParameters.json
index 714aab1..011b51c 100644
--- a/schema/Api/OrderBroker/NewOrderParameters.json
+++ b/schema/Api/OrderBroker/NewOrderParameters.json
@@ -3,9 +3,7 @@
"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"
- },
+ "schema": {"type": "string"},
"required": false
}
-}
\ No newline at end of file
+}
diff --git a/schema/Api/OrderBroker/NewOrderRequest.json b/schema/Api/OrderBroker/NewOrderRequest.json
index 17d357b..60cf541 100644
--- a/schema/Api/OrderBroker/NewOrderRequest.json
+++ b/schema/Api/OrderBroker/NewOrderRequest.json
@@ -7,55 +7,25 @@
"properties": {
"OrderId": {
"description": "Unique ID for order within order management system (system where order lifecycle will be managed)",
- "type": [
- "string",
- "null"
- ]
- },
- "ReferenceId": {
- "type": [
- "string",
- "null"
- ]
- },
- "AccessGroups": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
+ "type": ["string", "null"]
},
+ "ReferenceId": { "type": ["string", "null"] },
+ "AccessGroups": { "type": ["array", "null"], "items": {"type": "string"} },
"AffiliateIdentifier": {
"description": "Unique ID for affiliate within source system (system where order was originally placed)",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"AffiliateName": {
"description": "Name for affiliate within source system (system where order was originally placed)",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"BillTos": {
"description": "Bill to addresses array for Order",
- "type": [
- "array",
- "null"
- ],
"oneOf": [
- {
- "type": "null"
- },
+ {"type": "null"},
{
"type": "array",
- "items": {
- "$ref": "parts/BillTo.json"
- },
+ "items": {"$ref": "parts/BillToFromNewOrderRequest.json"},
"minItems": 1
}
],
@@ -77,67 +47,39 @@
}
]
},
- "CostCenter": {
- "type": [
- "string",
- "null"
- ]
- },
+ "CostCenter": { "type": ["string", "null"] },
"CreateDateTime": {
"description": "Datetime of when order was created",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"CreditCardFee": {
"description": "Credit card transaction fee applied to Order",
- "type": [
- "number",
- "null"
- ],
+ "type": ["number", "null"],
"format": "double"
},
"DefaultBillToKey": {
"description": "Unique ID for default billing contact details pulled from Order.BillTos.Key property (Only if applicable. Otherwise DefaultBillToKey will be null/empty value) (NOTE: If this value is not set, BillToKey must be set on all line items.)",
- "type": [
- "integer",
- "null"
- ],
+ "type": ["integer", "null"],
"format": "int32"
},
"DefaultOrderedByKey": {
"description": "Unique ID for default ordered by contact details pulled from Order.OrderedBy.Key property (Only if applicable. Otherwise DefaultOrderedByKey will be null/empty value)",
- "type": [
- "integer",
- "null"
- ],
+ "type": ["integer", "null"],
"format": "int32"
},
"DefaultShipToKey": {
"description": "Unique ID for default ship to contact pulled from Order.ShipTos.Key property (Only if applicable. Otherwise DefaultShipToKey will be null/empty value) (NOTE: If this value is not set, ShipToKey must be set on all line items.)",
- "type": [
- "integer",
- "null"
- ],
+ "type": ["integer", "null"],
"format": "int32"
},
"DueDate": {
"description": "Datetime of expected due date for Order",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"LineItems": {
"description": "Order level line item details",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "parts/LineItem.json"
- },
+ "type": ["array", "null"],
+ "items": {"$ref": "parts/LineItem.json"},
"examples": [
{
"OfferId": "8-998608-269",
@@ -154,11 +96,7 @@
"OrderedByKey": null,
"PONumber": null,
"Price": 4.57,
- "Products": [
- {
- "ProductId": "JGI-BTU-BFUI-5022-9773"
- }
- ],
+ "Products": [ {"ProductId": "JGI-BTU-BFUI-5022-9773"} ],
"QuantityOrdered": 1,
"RushOrder": null,
"ShipToKey": 0,
@@ -168,10 +106,7 @@
},
"OrderFee": {
"description": "Fee applied to Order",
- "type": [
- "number",
- "null"
- ],
+ "type": ["number", "null"],
"format": "double"
},
"OrderVariables": {
@@ -180,21 +115,10 @@
},
"OrderedBys": {
"description": "Order level ordered by contact and address details",
- "type": [
- "array",
- "null"
- ],
+ "type": ["array", "null"],
"oneOf": [
- {
- "type": "null"
- },
- {
- "type": "array",
- "items": {
- "$ref": "parts/OrderedBy.json"
- },
- "minItems": 1
- }
+ {"type": "null"},
+ { "type": "array", "items": {"$ref": "parts/OrderedBy.json"}, "minItems": 1 }
],
"examples": [
{
@@ -213,50 +137,26 @@
}
]
},
- "PONumber": {
- "description": "Purchase order number for Order",
- "type": [
- "string",
- "null"
- ]
- },
+ "PONumber": { "description": "Purchase order number for Order", "type": ["string", "null"] },
"PaymentMethods": {
"description": "Order.ShipTos level payment method details",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "parts/PaymentMethod.json"
- }
+ "type": ["array", "null"],
+ "items": {"$ref": "parts/PaymentMethod.json"}
},
"PickPackHandlingFee": {
"description": "Sum of pick & pack handling fees for all Order.ShipTos",
- "type": [
- "number",
- "null"
- ],
+ "type": ["number", "null"],
"format": "double"
},
- "RushOrder": {
- "description": "True/false indicator if Order is expedited",
- "type": "boolean"
- },
+ "RushOrder": {"description": "True/false indicator if Order is expedited", "type": "boolean"},
"ShipTos": {
"description": "Order level ship to details",
- "type": [
- "array",
- "null"
- ],
+ "type": ["array", "null"],
"oneOf": [
- {
- "type": "null"
- },
+ {"type": "null"},
{
"type": "array",
- "items": {
- "$ref": "parts/ShipTo.json"
- },
+ "items": {"$ref": "parts/ShipToFromNewOrderRequest.json"},
"minItems": 1
}
],
@@ -293,115 +193,57 @@
},
"ShippingHandlingTax": {
"description": "Sum of shipping & handling taxes for all Order.ShipTos",
- "type": [
- "number",
- "null"
- ],
+ "type": ["number", "null"],
"format": "double"
},
"TotalOrderFee": {
"description": "Sum of OrderFee",
- "type": [
- "number",
- "null"
- ],
+ "type": ["number", "null"],
"format": "double"
},
"TotalShippingCost": {
"description": "Sum of shipping cost for all Order.ShipTos.Shipments",
- "type": [
- "number",
- "null"
- ],
+ "type": ["number", "null"],
"format": "double"
}
},
- "required": [
- "OrderId",
- "LineItems",
- "ShippingHandlingTax",
- "BillTos"
- ],
+ "required": ["OrderId", "LineItems", "ShippingHandlingTax", "BillTos"],
"allOf": [
{
"oneOf": [
{
- "properties": {
- "DefaultBillToKey": {
- "type": "integer"
- }
- },
- "required": [
- "DefaultBillToKey"
- ]
+ "properties": { "DefaultBillToKey": {"type": "integer"} },
+ "required": ["DefaultBillToKey"]
},
{
"not": {
- "properties": {
- "DefaultBillToKey": {
- "type": "integer"
- }
- },
- "required": [
- "DefaultBillToKey"
- ]
+ "properties": { "DefaultBillToKey": {"type": "integer"} },
+ "required": ["DefaultBillToKey"]
},
"properties": {
- "BillTos": {
- "type": "array",
- "minItems": 1
- },
- "DefaultBillToKey": {
- "type": [
- "null",
- "integer"
- ]
- }
+ "BillTos" : { "type": "array" , "minItems": 1 },
+ "DefaultBillToKey": { "type": ["null", "integer"] }
},
- "required": [
- "BillTos"
- ]
+ "required": ["BillTos"]
}
]
},
{
"oneOf": [
{
- "properties": {
- "DefaultShipToKey": {
- "type": "integer"
- }
- },
- "required": [
- "DefaultShipToKey"
- ]
+ "properties": { "DefaultShipToKey": {"type": "integer"} },
+ "required": ["DefaultShipToKey"]
},
{
"not": {
- "properties": {
- "DefaultShipToKey": {
- "type": "integer"
- }
- },
- "required": [
- "DefaultShipToKey"
- ]
+ "properties": { "DefaultShipToKey": {"type": "integer"} },
+ "required": ["DefaultShipToKey"]
},
"properties": {
- "DefaultShipToKey": {
- "type": [
- "null",
- "integer"
- ]
- },
- "ShipTos": {
- "type": "array",
- "minItems": 1
- }
+ "DefaultShipToKey": { "type": ["null", "integer"] },
+ "ShipTos" : { "type": "array" , "minItems": 1 }
},
- "required": [
- "ShipTos"
- ]
+ "required": ["ShipTos"]
}
]
}
@@ -410,11 +252,7 @@
{
"OrderId": "7-mkkutsde-3-K-5649-4005-64",
"ReferenceId": "OWMR WSKFA - LNSSZT XBUUJ & MS XXQ QCHX",
- "AccessGroups": [
- "TS-Retail",
- "CDM Tuff Shed",
- "Tuff shed Act on behalf and see all orders"
- ],
+ "AccessGroups": ["TS-Retail", "CDM Tuff Shed", "Tuff shed Act on behalf and see all orders"],
"AffiliateIdentifier": "QJ-987",
"AffiliateName": "UJ-143-ABWJINHFVL, QD",
"BillTos": [
@@ -512,12 +350,7 @@
}
],
"PONumber": null,
- "PaymentMethods": [
- {
- "Amount": 35.8,
- "MethodName": "invoice"
- }
- ],
+ "PaymentMethods": [ {"Amount": 35.8, "MethodName": "invoice"} ],
"PickPackHandlingFee": 0.75,
"RushOrder": false,
"ShipTos": [
@@ -562,11 +395,7 @@
{
"OrderId": "1-qrhjtpek-8-Q-0286-8859-25",
"ReferenceId": "WUQD HWKPE - XIWHAC BTVOM & BH WAK DXRI",
- "AccessGroups": [
- "TS-Retail",
- "CDM Tuff Shed",
- "Tuff shed Act on behalf and see all orders"
- ],
+ "AccessGroups": ["TS-Retail", "CDM Tuff Shed", "Tuff shed Act on behalf and see all orders"],
"AffiliateIdentifier": "VJ-268",
"AffiliateName": "GZ-589-WUOFETGVLG, RM",
"BillTos": [
@@ -664,12 +493,7 @@
}
],
"PONumber": null,
- "PaymentMethods": [
- {
- "Amount": 35.8,
- "MethodName": "invoice"
- }
- ],
+ "PaymentMethods": [ {"Amount": 35.8, "MethodName": "invoice"} ],
"PickPackHandlingFee": 0.75,
"RushOrder": false,
"ShipTos": [
diff --git a/schema/Api/OrderBroker/NewOrderResponse.json b/schema/Api/OrderBroker/NewOrderResponse.json
deleted file mode 100644
index 4577f49..0000000
--- a/schema/Api/OrderBroker/NewOrderResponse.json
+++ /dev/null
@@ -1,18 +0,0 @@
-{
- "$schema": "https://json-schema.org/draft-07/schema#",
- "$id": "NewOrderResponse.json",
- "type": "object",
- "allOf": [
- {
- "$ref": "../../Common/ApiResponseBase.json"
- },
- {
- "type": "object",
- "properties": {
- "data": {
- "type": "array"
- }
- }
- }
- ]
-}
diff --git a/schema/Api/OrderBroker/UpdateFulfillmentOrderParameters.json b/schema/Api/OrderBroker/UpdateFulfillmentOrderParameters.json
new file mode 100644
index 0000000..011b51c
--- /dev/null
+++ b/schema/Api/OrderBroker/UpdateFulfillmentOrderParameters.json
@@ -0,0 +1,9 @@
+{
+ "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/OrderBroker/UpdateFulfillmentOrderRequest.json b/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json
new file mode 100644
index 0000000..e145395
--- /dev/null
+++ b/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json
@@ -0,0 +1,7 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "UpdateFulfillmentOrderRequest.json",
+ "$ref": "parts/FulfillmentOrder.json",
+ "type": "object",
+ "additionalProperties": false
+}
diff --git a/schema/Api/OrderBroker/UpdateFulfillmentOrderResponse.json b/schema/Api/OrderBroker/UpdateFulfillmentOrderResponse.json
new file mode 100644
index 0000000..0e89914
--- /dev/null
+++ b/schema/Api/OrderBroker/UpdateFulfillmentOrderResponse.json
@@ -0,0 +1,21 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "UpdateFulfillmentOrderResponse.json",
+ "allOf": [
+ {"$ref": "../../Common/ApiResponseBase.json"},
+ {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "FailureMessages": { "type": ["array", "null"], "items": {"type": "string"} },
+ "InformationalMessages": { "type": ["array", "null"], "items": {"type": "string"} },
+ "OperationWasSuccessful": {"type": "boolean", "readOnly": true}
+ }
+ }
+ }
+ }
+ ]
+}
diff --git a/schema/Api/OrderBroker/parts/AdditionalProperty.json b/schema/Api/OrderBroker/parts/AdditionalProperty.json
index 32c7199..c9e9f39 100644
--- a/schema/Api/OrderBroker/parts/AdditionalProperty.json
+++ b/schema/Api/OrderBroker/parts/AdditionalProperty.json
@@ -5,27 +5,8 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "Key": {
- "type": [
- "string",
- "null"
- ]
- },
- "Value": {
- "type": [
- "string",
- "null"
- ]
- }
+ "Key" : { "type": ["string", "null"] },
+ "Value": { "type": ["string", "null"] }
},
- "required": [
- "Key",
- "Value"
- ],
- "examples": [
- {
- "Key": "SingleMailing_File",
- "Value": "https://example.onetouchpoint.com/some-file.pdf"
- }
- ]
+ "required": ["Key", "Value"]
}
diff --git a/schema/Api/OrderBroker/parts/BillTo.json b/schema/Api/OrderBroker/parts/BillTo.json
index 3cd4461..7ecce4e 100644
--- a/schema/Api/OrderBroker/parts/BillTo.json
+++ b/schema/Api/OrderBroker/parts/BillTo.json
@@ -3,121 +3,25 @@
"$id": "BillTo.json",
"description": "Bill to address object for Order",
"type": "object",
- "additionalProperties": false,
"properties": {
- "Address1": {
- "description": "Address line 1 for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Address2": {
- "description": "Address line 2 for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Address3": {
- "description": "Address line 3 for address",
- "type": [
- "string",
- "null"
- ]
- },
- "City": {
- "description": "City name for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Company": {
- "description": "Company name for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Country": {
- "description": "Country name for address",
- "type": [
- "string",
- "null"
- ]
- },
+ "Address1": { "description": "Address line 1 for address", "type": ["string", "null"] },
+ "Address2": { "description": "Address line 2 for address", "type": ["string", "null"] },
+ "Address3": { "description": "Address line 3 for address", "type": ["string", "null"] },
+ "City": { "description": "City name for address", "type": ["string", "null"] },
+ "Company": { "description": "Company name for address", "type": ["string", "null"] },
+ "Country": { "description": "Country name for address", "type": ["string", "null"] },
"EmailAddress": {
"description": "Contact email address for address",
- "type": [
- "string",
- "null"
- ]
- },
- "FaxNumber": {
- "description": "Fax number for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Key": {
- "description": "Unique ID for individual contact",
- "type": "integer",
- "format": "int32"
- },
- "Name": {
- "description": "Contact name for this address",
- "type": [
- "string",
- "null"
- ]
- },
- "PhoneNumber": {
- "description": "Phone number for address",
- "type": [
- "string",
- "null"
- ]
- },
- "PostalCode": {
- "description": "Postal code for address",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
+ "FaxNumber": { "description": "Fax number for address", "type": ["string", "null"] },
+ "Name": { "description": "Contact name for this address", "type": ["string", "null"] },
+ "PhoneNumber": { "description": "Phone number for address", "type": ["string", "null"] },
+ "PostalCode": { "description": "Postal code for address", "type": ["string", "null"] },
"StateProvince": {
"description": "State or province name for address",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
}
},
- "required": [
- "Address1",
- "City",
- "Country",
- "Name",
- "PostalCode",
- "StateProvince"
- ],
- "examples": [
- {
- "Address1": "106 Tyler Street Suite 175",
- "Address2": "3181 George Vista",
- "Address3": "",
- "City": "West Savannahside",
- "Company": "Matthews, Mclean and Huynh",
- "Country": "USA",
- "EmailAddress": "ghunt@example.com",
- "FaxNumber": "",
- "Key": 0,
- "Name": "Kristin Tyler",
- "PhoneNumber": "001-990-377-8647x21426",
- "PostalCode": "69532",
- "StateProvince": "Idaho"
- }
- ]
+ "required": ["Address1", "City", "Country", "Name", "PostalCode", "StateProvince"]
}
diff --git a/schema/Api/OrderBroker/parts/BillToFromNewOrderRequest.json b/schema/Api/OrderBroker/parts/BillToFromNewOrderRequest.json
new file mode 100644
index 0000000..3882f17
--- /dev/null
+++ b/schema/Api/OrderBroker/parts/BillToFromNewOrderRequest.json
@@ -0,0 +1,12 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "BillToFromNewOrderRequest.json",
+ "type": "object",
+ "allOf": [
+ {"$ref": "BillTo.json"},
+ {
+ "type": "object",
+ "properties": { "Key": {"type": "integer", "format": "int32"} }
+ }
+ ]
+}
diff --git a/schema/Api/OrderBroker/parts/BillToFromUpdateFulfillmentOrderRequest.json b/schema/Api/OrderBroker/parts/BillToFromUpdateFulfillmentOrderRequest.json
new file mode 100644
index 0000000..4f4f759
--- /dev/null
+++ b/schema/Api/OrderBroker/parts/BillToFromUpdateFulfillmentOrderRequest.json
@@ -0,0 +1,6 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "BillToFromUpdateFulfillmentOrderRequest.json",
+ "type": "object",
+ "allOf": [ {"$ref": "BillTo.json"} ]
+}
diff --git a/schema/Api/OrderBroker/parts/Component.json b/schema/Api/OrderBroker/parts/Component.json
index 5fe4d4a..cfa1e2f 100644
--- a/schema/Api/OrderBroker/parts/Component.json
+++ b/schema/Api/OrderBroker/parts/Component.json
@@ -7,82 +7,40 @@
"properties": {
"ProductId": {
"description": "Unique ID for component product within Integration Broker",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"AssociatedFileName": {
"description": "Name of file associated to component product (if applicable)",
- "type": [
- "string",
- "null"
- ]
- },
- "Color": {
- "description": "Color of component product",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
+ "Color": { "description": "Color of component product", "type": ["string", "null"] },
"Comment": {
"description": "Manually entered comment for component product",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"ComponentLineNumber": {
"description": "Unique ID for component product within parent product",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"ProductDescription": {
"description": "Description for component product within product management system (system where ordered line item products will be managed)",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"ProductNumber": {
"description": "Name for component product within product management system (system where ordered line item products will be managed)",
- "type": [
- "string",
- "null"
- ]
- },
- "ProductOwner": {
- "description": "Owner of component product",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
+ "ProductOwner": { "description": "Owner of component product", "type": ["string", "null"] },
"QuantityBackordered": {
"description": "Amount of component product back-ordered within parent product",
- "type": [
- "integer",
- "null"
- ],
+ "type": ["integer", "null"],
"format": "int32"
},
"QuantityOrdered": {
"description": "Amount of component product ordered within parent product",
- "type": [
- "integer",
- "null"
- ],
+ "type": ["integer", "null"],
"format": "int32"
},
- "Size": {
- "description": "Size of component product",
- "type": [
- "string",
- "null"
- ]
- }
+ "Size": { "description": "Size of component product", "type": ["string", "null"] }
}
}
diff --git a/schema/Api/OrderBroker/parts/FulfillmentOrder.json b/schema/Api/OrderBroker/parts/FulfillmentOrder.json
new file mode 100644
index 0000000..07def3e
--- /dev/null
+++ b/schema/Api/OrderBroker/parts/FulfillmentOrder.json
@@ -0,0 +1,32 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "FulfillmentOrder.json",
+ "type": "object",
+ "properties": {
+ "CustomerId": { "type": ["string", "null"] },
+ "FulfillmentOrderId": { "type": ["string", "null"] },
+ "FulfillmentSystemCustomerId": { "type": ["string", "null"] },
+ "FulfillmentSystemId": { "type": ["string", "null"] },
+ "FulfillmentSystemLocationId": { "type": ["string", "null"] },
+ "FulfillmentSystemOrderId": { "type": ["string", "null"] },
+ "ReferenceId": { "type": ["string", "null"] },
+ "BillTo": {"$ref": "BillToFromUpdateFulfillmentOrderRequest.json"},
+ "CreateDateTime": { "type": ["string", "null"] },
+ "DefaultShipToKey": {"type": "integer", "format": "int32"},
+ "DueDate": { "type": ["string", "null"] },
+ "OrderIds": { "type": ["array", "null"], "items": {"type": "string"} },
+ "OrderVariables": { "type": ["string", "null"] },
+ "PONumber": { "type": ["string", "null"] },
+ "PaymentMethods": { "type": ["array", "null"], "items": {"$ref": "PaymentMethod.json"} },
+ "Products": {
+ "type": ["array", "null"],
+ "items": {"$ref": "ProductFromUpdateFulfillmentOrderRequest.json"}
+ },
+ "RushOrder": { "type": ["string", "null"] },
+ "ShipTos": {
+ "type": ["array", "null"],
+ "items": {"$ref": "ShipToFromUpdateFulfillmentOrderRequest.json"}
+ },
+ "Shipments": { "type": ["array", "null"], "items": {"$ref": "Shipment.json"} }
+ }
+}
diff --git a/schema/Api/OrderBroker/parts/LineItem.json b/schema/Api/OrderBroker/parts/LineItem.json
index 630b6f4..a339008 100644
--- a/schema/Api/OrderBroker/parts/LineItem.json
+++ b/schema/Api/OrderBroker/parts/LineItem.json
@@ -3,211 +3,89 @@
"$id": "LineItem.json",
"description": "Order level line item details",
"type": "object",
- "oneOf": [
- {
- "required": [
- "OfferId"
- ]
- },
- {
- "not": {
- "required": [
- "OfferId"
- ]
- },
- "required": [
- "OfferNumber"
- ]
- }
- ],
- "additionalProperties": false,
"properties": {
"OfferId": {
"description": "Unique ID for offer within Integration Broker",
- "type": [
- "string",
- "null"
- ]
- },
- "ReferenceId": {
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
+ "ReferenceId": { "type": ["string", "null"] },
"VariableTemplatePrintId": {
"description": "Unique ID for variable template file associated to offer on individual line item",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"AdditionalProperties": {
"description": "Additional properties details for Order LineItems",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "AdditionalProperty.json"
- },
- "examples": [
- {
- "Key": "SingleMailing_File",
- "Value": "https://example.onetouchpoint.com/some-file.pdf"
- }
- ]
+ "type": ["array", "null"],
+ "items": {"$ref": "AdditionalProperty.json"}
},
"BillToKey": {
"description": "Unique ID for Order.BillTos.Key property associated to individual line item (NOTE: If top-level DefaultBillToKey is not set, this must be.)",
- "type": [
- "integer",
- "null"
- ],
+ "type": ["integer", "null"],
"format": "int32"
},
"Comment": {
"description": "Manually entered comment for individual line item",
- "type": [
- "string",
- "null"
- ]
- },
- "CostCenter": {
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
+ "CostCenter": { "type": ["string", "null"] },
"DueDate": {
"description": "Datetime of expected due date for individual line item",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"LineItemFee": {
"description": "Fee applied to individual line item",
- "type": [
- "number",
- "null"
- ],
+ "type": ["number", "null"],
"format": "double"
},
"OfferDescription": {
"description": "Description for offer within product management system (system where ordered line item products will be managed)",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"OfferLineNumber": {
"description": "Unique ID for individual line item",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"OfferNumber": {
"description": "Name for offer within product management system (system where ordered line item products will be managed)",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"OrderedByKey": {
"description": "Unique ID for Order.OrderedBy.Key property associated to individual line item",
- "type": [
- "integer",
- "null"
- ],
+ "type": ["integer", "null"],
"format": "int32"
},
"PONumber": {
"description": "Purchase order number for individual line item",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"Price": {
"description": "Total offer price of individual line item",
- "type": [
- "number",
- "null"
- ],
+ "type": ["number", "null"],
"format": "double"
},
"Products": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "Product.json"
- }
+ "type": ["array", "null"],
+ "items": {"$ref": "ProductFromNewOrderRequest.json"}
},
"QuantityOrdered": {
"description": "Amount of offer ordered for individual line item",
- "type": [
- "integer"
- ],
+ "type": "integer",
"format": "int32"
},
"RushOrder": {
"description": "True/false indicator if individual line item is expedited",
- "type": [
- "boolean",
- "null"
- ]
+ "type": ["boolean", "null"]
},
"ShipToKey": {
"description": "Unique ID for Order.ShipTos.Key property associated to individual line item (NOTE: If top-level DefaultShipToKey is not set, this must be.)",
- "type": [
- "integer",
- "null"
- ],
+ "type": ["integer", "null"],
"format": "int32"
},
"TaxAmount": {
"description": "Total tax amount applied to individual line item",
- "type": [
- "number",
- "null"
- ],
+ "type": ["number", "null"],
"format": "double"
}
},
- "required": [
- "LineItemFee",
- "Price",
- "QuantityOrdered"
- ],
- "examples": [
- {
- "OfferId": "8-998608-269",
- "ReferenceId": null,
- "VariableTemplatePrintId": null,
- "BillToKey": null,
- "Comment": "HPD-PNP-DRS-TEACONT-0322:",
- "CostCenter": null,
- "DueDate": null,
- "LineItemFee": 1,
- "OfferDescription": "Tea Container Sticker",
- "OfferLineNumber": "1",
- "OfferNumber": "HPD-PNP-DRS-TEACONT-0322",
- "OrderedByKey": null,
- "PONumber": null,
- "Price": 4.57,
- "Products": [
- {
- "ProductId": "JGI-BTU-BFUI-5022-9773"
- }
- ],
- "QuantityOrdered": 1,
- "RushOrder": null,
- "ShipToKey": 0,
- "TaxAmount": 2.92
- }
- ]
+ "required": ["LineItemFee", "Price", "QuantityOrdered"]
}
diff --git a/schema/Api/OrderBroker/parts/OrderVariable.json b/schema/Api/OrderBroker/parts/OrderVariable.json
index d7ffc98..4d25a2f 100644
--- a/schema/Api/OrderBroker/parts/OrderVariable.json
+++ b/schema/Api/OrderBroker/parts/OrderVariable.json
@@ -1,10 +1,6 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "OrderVariable.json",
- "description": "Manually entered variables for order within order management system (system where order lifecycle will be managed in)",
- "type": [
- "object",
- "null"
- ],
+ "type": ["object", "null"],
"additionalProperties": true
}
diff --git a/schema/Api/OrderBroker/parts/OrderedBy.json b/schema/Api/OrderBroker/parts/OrderedBy.json
index 5c52499..e59c83a 100644
--- a/schema/Api/OrderBroker/parts/OrderedBy.json
+++ b/schema/Api/OrderBroker/parts/OrderedBy.json
@@ -5,118 +5,29 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "Address1": {
- "description": "Address line 1 for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Address2": {
- "description": "Address line 2 for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Address3": {
- "description": "Address line 3 for address",
- "type": [
- "string",
- "null"
- ]
- },
- "City": {
- "description": "City name for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Company": {
- "description": "Company name for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Country": {
- "description": "Country name for address",
- "type": [
- "string",
- "null"
- ]
- },
+ "Address1": { "description": "Address line 1 for address", "type": ["string", "null"] },
+ "Address2": { "description": "Address line 2 for address", "type": ["string", "null"] },
+ "Address3": { "description": "Address line 3 for address", "type": ["string", "null"] },
+ "City": { "description": "City name for address", "type": ["string", "null"] },
+ "Company": { "description": "Company name for address", "type": ["string", "null"] },
+ "Country": { "description": "Country name for address", "type": ["string", "null"] },
"EmailAddress": {
"description": "Contact email address for address",
- "type": [
- "string",
- "null"
- ]
- },
- "FaxNumber": {
- "description": "Fax number for address",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
+ "FaxNumber": { "description": "Fax number for address", "type": ["string", "null"] },
"Key": {
"description": "Unique ID for individual contact",
"type": "integer",
"format": "int32"
},
- "Name": {
- "type": [
- "string",
- "null"
- ]
- },
- "PhoneNumber": {
- "description": "Phone number for address",
- "type": [
- "string",
- "null"
- ]
- },
- "PostalCode": {
- "description": "Postal code for address",
- "type": [
- "string",
- "null"
- ]
- },
+ "Name": { "type": ["string", "null"] },
+ "PhoneNumber": { "description": "Phone number for address", "type": ["string", "null"] },
+ "PostalCode": { "description": "Postal code for address", "type": ["string", "null"] },
"StateProvince": {
"description": "State or province name for address",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
}
},
- "required": [
- "Address1",
- "City",
- "Country",
- "Name",
- "PostalCode",
- "StateProvince"
- ],
- "examples": [
- {
- "Address1": "106 Tyler Street Suite 175",
- "Address2": "3181 George Vista",
- "Address3": "",
- "City": "West Savannahside",
- "Company": "Matthews, Mclean and Huynh",
- "Country": "USA",
- "EmailAddress": "ghunt@example.com",
- "FaxNumber": "",
- "Key": 0,
- "Name": "Kristin Tyler",
- "PhoneNumber": "001-990-377-8647x21426",
- "PostalCode": "02019",
- "StateProvince": "Idaho"
- }
- ]
+ "required": ["Address1", "City", "Country", "Name", "PostalCode", "StateProvince"]
}
diff --git a/schema/Api/OrderBroker/parts/Package.json b/schema/Api/OrderBroker/parts/Package.json
new file mode 100644
index 0000000..b07adde
--- /dev/null
+++ b/schema/Api/OrderBroker/parts/Package.json
@@ -0,0 +1,10 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "Package.json",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "PackageNumber" : { "type": ["string", "null"] },
+ "TrackingNumber": { "type": ["string", "null"] }
+ }
+}
diff --git a/schema/Api/OrderBroker/parts/PaymentMethod.json b/schema/Api/OrderBroker/parts/PaymentMethod.json
index bdf8736..e9bd5be 100644
--- a/schema/Api/OrderBroker/parts/PaymentMethod.json
+++ b/schema/Api/OrderBroker/parts/PaymentMethod.json
@@ -6,18 +6,12 @@
"properties": {
"Amount": {
"description": "Total Amount. Required if MethodName specified",
- "type": [
- "number",
- "null"
- ],
+ "type": ["number", "null"],
"format": "double"
},
"MethodName": {
"description": "Name of payment method. Required if Payment Amount specified",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
}
}
}
diff --git a/schema/Api/OrderBroker/parts/Product.json b/schema/Api/OrderBroker/parts/Product.json
index ffdc410..e900103 100644
--- a/schema/Api/OrderBroker/parts/Product.json
+++ b/schema/Api/OrderBroker/parts/Product.json
@@ -1,108 +1,11 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "Product.json",
- "description": "Order.LineItems level product details",
"type": "object",
- "additionalProperties": false,
"properties": {
- "ProductId": {
- "description": "Unique ID for product within Integration Broker",
- "type": [
- "string",
- "null"
- ]
- },
- "AssociatedFileName": {
- "description": "Name of file associated to product (if applicable)",
- "type": [
- "string",
- "null"
- ]
- },
- "Color": {
- "description": "Color of product",
- "type": [
- "string",
- "null"
- ]
- },
- "Comment": {
- "description": "Manually entered comment for product",
- "type": [
- "string",
- "null"
- ]
- },
- "Components": {
- "description": "Components array for Order LineItems Products",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "Component.json"
- }
- },
- "ProductDescription": {
- "description": "Description for product within product management system (system where ordered line item products will be managed)",
- "type": [
- "string",
- "null"
- ]
- },
- "ProductLineNumber": {
- "description": "Unique ID for product within parent line item",
- "type": [
- "string",
- "null"
- ]
- },
- "ProductNumber": {
- "description": "Name for product within product management system (system where ordered line item products will be managed)",
- "type": [
- "string",
- "null"
- ]
- },
- "ProductOwner": {
- "description": "Owner of product",
- "type": [
- "string",
- "null"
- ]
- },
- "QuantityOrdered": {
- "description": "Amount of product ordered within parent line item",
- "type": [
- "integer",
- "null"
- ],
- "format": "int32"
- },
- "Size": {
- "description": "Size of product",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "required": [
- "ProductId"
- ],
- "examples": [
- {
- "ProductId": "JGI-BTU-BFUI-5022-9773",
- "AssociatedFileName": "https://example.onetouchpoint.com/some-file.pdf",
- "Color": "Black",
- "Comment": null,
- "Components": [],
- "ProductDescription": "ToGo Labels - Double Bacon Jam (Roll of 500)",
- "ProductLineNumber": "7807",
- "ProductNumber": "HPD-PNP-TOGO-2600-0322",
- "ProductOwner": "Davis-Avila",
- "QuantityOrdered": 1,
- "Size": "Medium"
- }
- ]
+ "ProductId": { "type": ["string", "null"] },
+ "AssociatedFileName": { "type": ["string", "null"] },
+ "Comment": { "type": ["string", "null"] },
+ "QuantityOrdered": { "type": ["integer", "null"], "format": "int32" }
+ }
}
diff --git a/schema/Api/OrderBroker/parts/ProductFromNewOrderRequest.json b/schema/Api/OrderBroker/parts/ProductFromNewOrderRequest.json
new file mode 100644
index 0000000..cdb9b30
--- /dev/null
+++ b/schema/Api/OrderBroker/parts/ProductFromNewOrderRequest.json
@@ -0,0 +1,19 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "ProductFromNewOrderRequest.json",
+ "type": "object",
+ "allOf": [
+ {"$ref": "Product.json"},
+ {
+ "type": "object",
+ "properties": {
+ "Color" : { "type": ["string", "null"] },
+ "ProductDescription": { "type": ["string", "null"] },
+ "ProductLineNumber" : { "type": ["string", "null"] },
+ "ProductNumber" : { "type": ["string", "null"] },
+ "ProductOwner" : { "type": ["string", "null"] },
+ "Size" : { "type": ["string", "null"] }
+ }
+ }
+ ]
+}
diff --git a/schema/Api/OrderBroker/parts/ProductFromUpdateFulfillmentOrderRequest.json b/schema/Api/OrderBroker/parts/ProductFromUpdateFulfillmentOrderRequest.json
new file mode 100644
index 0000000..642def7
--- /dev/null
+++ b/schema/Api/OrderBroker/parts/ProductFromUpdateFulfillmentOrderRequest.json
@@ -0,0 +1,18 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "ProductFromUpdateFulfillmentOrderRequest.json",
+ "type": "object",
+ "allOf": [
+ {"$ref": "Product.json"},
+ {
+ "type": "object",
+ "properties": {
+ "FulfillmentSystemProductId": { "type": ["string", "null"] },
+ "ProductLineId": { "type": ["string", "null"] },
+ "Price": { "type": ["number", "null"], "format": "double" },
+ "ShipToKey": { "type": ["integer", "null"], "format": "int32" },
+ "Status": { "type": ["string", "null"] }
+ }
+ }
+ ]
+}
diff --git a/schema/Api/OrderBroker/parts/ShipTo.json b/schema/Api/OrderBroker/parts/ShipTo.json
index 93fafff..f12d238 100644
--- a/schema/Api/OrderBroker/parts/ShipTo.json
+++ b/schema/Api/OrderBroker/parts/ShipTo.json
@@ -1,189 +1,14 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "ShipTo.json",
- "description": "Order level ship to details",
"type": "object",
- "additionalProperties": false,
"properties": {
- "AffiliateId": {
- "description": "Unique ID for affiliate within source system (system where order was originally placed)",
- "type": [
- "string",
- "null"
- ]
- },
- "ReferenceId": {
- "type": [
- "string",
- "null"
- ]
- },
- "SourceSystemShippingMethodId": {
- "description": "Unique ID for shipping method within source system (system where order was originally placed)",
- "type": [
- "string",
- "null"
- ]
- },
- "AffiliateName": {
- "description": "Name for affiliate within source system (system where order was originally placed)",
- "type": [
- "string",
- "null"
- ]
- },
- "Comment": {
- "description": "Manually entered comment for individual Order.ShipTos",
- "type": [
- "string",
- "null"
- ]
- },
- "CostCenter": {
- "type": [
- "string",
- "null"
- ]
- },
- "CreditCardFee": {
- "description": "Credit card transaction fee applied for individual Order.ShipTos",
- "type": [
- "number",
- "null"
- ],
- "format": "double"
- },
- "DueDate": {
- "description": "Datetime of expected due date for individual Order.ShipTos",
- "type": [
- "string",
- "null"
- ]
- },
- "Key": {
- "description": "Unique ID for individual ship to",
- "type": "integer",
- "format": "int32"
- },
- "OrderFee": {
- "description": "Fee applied to Order",
- "type": [
- "number",
- "null"
- ],
- "format": "double"
- },
- "PONumber": {
- "description": "Purchase order number for individual Order.ShipTos",
- "type": [
- "string",
- "null"
- ]
- },
- "PaymentMethods": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "PaymentMethod.json"
- }
- },
- "PickPackHandlingFee": {
- "description": "Pick & pack handling fees for individual Order.ShipTos",
- "type": [
- "number",
- "null"
- ],
- "format": "double"
- },
- "RushOrder": {
- "description": "True/false indicator if individual Order.ShipTos is expedited",
- "type": [
- "boolean",
- "null"
- ]
- },
- "ShipToAddress": {
- "$ref": "ShipToAddress.json",
- "description": "Ship to addresses array for Order",
- "examples": [
- {
- "Address1": "106 Tyler Street Suite 175",
- "Address2": "3181 George Vista",
- "Address3": "",
- "City": "West Savannahside",
- "Company": "Matthews, Mclean and Huynh",
- "Country": "USA",
- "EmailAddress": "ghunt@example.com",
- "FaxNumber": "",
- "Key": 0,
- "PhoneNumber": "001-990-377-8647x21426",
- "PostalCode": "02019",
- "StateProvince": "Idaho"
- }
- ]
- },
- "ShippingCost": {
- "description": "Shipping cost for individual Order.ShipTos",
- "type": [
- "number",
- "null"
- ],
- "format": "double"
- },
- "ShippingHandlingTax": {
- "description": "Shipping & handling taxes for individual Order.ShipTos",
- "type": [
- "number",
- "null"
- ],
- "format": "double"
- },
- "TotalOrderFee": {
- "description": "Sum of OrderFee",
- "type": [
- "number",
- "null"
- ],
- "format": "double"
- }
- },
- "required": [
- "Key",
- "SourceSystemShippingMethodId",
- "ShippingCost",
- "ShippingHandlingTax",
- "ShipToAddress"
- ],
- "examples": [
- {
- "AffiliateId": null,
- "ReferenceId": "BQJ efg Deebjplybqjtgr ",
- "SourceSystemShippingMethodId": "vos_vrzuqz",
- "AffiliateName": null,
- "Comment": "",
- "CostCenter": "6342091000- IN Medicaid Case Mgmt",
- "CreditCardFee": null,
- "DueDate": null,
- "Key": 0,
- "OrderFee": 5,
- "PONumber": null,
- "PaymentMethods": null,
- "PickPackHandlingFee": 21,
- "RushOrder": false,
- "ShipToAddress": {
- "Address1": "65677 Laura Village Suite 322",
- "City": "Catherineshire",
- "Company": "Nunez-Cardenas",
- "Country": "USA",
- "Name": "Julie Lester",
- "PostalCode": "11460",
- "StateProvince": "Arizona"
- },
- "ShippingCost": 20.22,
- "ShippingHandlingTax": 2.15,
- "TotalOrderFee": 5
- }
- ]
+ "ReferenceId": { "type": ["string", "null"] },
+ "Comment": { "type": ["string", "null"] },
+ "DueDate": { "type": ["string", "null"] },
+ "Key": {"type": "integer", "format": "int32"},
+ "PONumber": { "type": ["string", "null"] },
+ "RushOrder": { "type": ["boolean", "null"] },
+ "ShippingCost": { "type": ["number", "null"], "format": "double" }
+ }
}
diff --git a/schema/Api/OrderBroker/parts/ShipToAddress.json b/schema/Api/OrderBroker/parts/ShipToAddress.json
index 4a5b179..2328bf0 100644
--- a/schema/Api/OrderBroker/parts/ShipToAddress.json
+++ b/schema/Api/OrderBroker/parts/ShipToAddress.json
@@ -5,116 +5,24 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "Address1": {
- "description": "Address line 1 for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Address2": {
- "description": "Address line 2 for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Address3": {
- "description": "Address line 3 for address",
- "type": [
- "string",
- "null"
- ]
- },
- "City": {
- "description": "City name for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Company": {
- "description": "Company name for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Country": {
- "description": "Country name for address",
- "type": [
- "string",
- "null"
- ]
- },
+ "Address1": { "description": "Address line 1 for address", "type": ["string", "null"] },
+ "Address2": { "description": "Address line 2 for address", "type": ["string", "null"] },
+ "Address3": { "description": "Address line 3 for address", "type": ["string", "null"] },
+ "City": { "description": "City name for address", "type": ["string", "null"] },
+ "Company": { "description": "Company name for address", "type": ["string", "null"] },
+ "Country": { "description": "Country name for address", "type": ["string", "null"] },
"EmailAddress": {
"description": "Contact email address for address",
- "type": [
- "string",
- "null"
- ]
- },
- "FaxNumber": {
- "description": "Fax number for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Key": {
- "description": "Unique ID for individual contact"
- },
- "Name": {
- "type": [
- "string",
- "null"
- ]
- },
- "PhoneNumber": {
- "description": "Phone number for address",
- "type": [
- "string",
- "null"
- ]
- },
- "PostalCode": {
- "description": "Postal code for address",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
+ "FaxNumber": { "description": "Fax number for address", "type": ["string", "null"] },
+ "Name": { "type": ["string", "null"] },
+ "PhoneNumber": { "description": "Phone number for address", "type": ["string", "null"] },
+ "PostalCode": { "description": "Postal code for address", "type": ["string", "null"] },
"StateProvince": {
"description": "State or province name for address",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
}
},
- "required": [
- "Address1",
- "City",
- "Country",
- "Name",
- "PostalCode",
- "StateProvince"
- ],
- "examples": [
- {
- "Address1": "106 Tyler Street Suite 175",
- "Address2": "3181 George Vista",
- "Address3": "",
- "City": "West Savannahside",
- "Company": "Matthews, Mclean and Huynh",
- "Country": "USA",
- "EmailAddress": "ghunt@example.com",
- "FaxNumber": "",
- "Key": 0,
- "Name": "Kristin Tyler",
- "PhoneNumber": "001-990-377-8647x21426",
- "PostalCode": "02019",
- "StateProvince": "Idaho"
- }
- ]
+ "required": ["Address1", "City", "Country", "Name", "PostalCode", "StateProvince"]
}
diff --git a/schema/Api/OrderBroker/parts/ShipToFromNewOrderRequest.json b/schema/Api/OrderBroker/parts/ShipToFromNewOrderRequest.json
new file mode 100644
index 0000000..dd5096d
--- /dev/null
+++ b/schema/Api/OrderBroker/parts/ShipToFromNewOrderRequest.json
@@ -0,0 +1,22 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "ShipToFromNewOrderRequest.json",
+ "type": "object",
+ "allOf": [
+ {"$ref": "ShipTo.json"},
+ {
+ "type": "object",
+ "properties": {
+ "AffiliateId" : { "type": ["string", "null"] },
+ "SourceSystemShippingMethodId": { "type": ["string", "null"] },
+ "AffiliateName" : { "type": ["string", "null"] },
+ "CostCenter" : { "type": ["string", "null"] },
+ "CreditCardFee" : { "type": ["number", "null"], "format": "double" },
+ "OrderFee" : { "type": ["number", "null"], "format": "double" },
+ "PickPackHandlingFee" : { "type": ["number", "null"], "format": "double" },
+ "ShippingHandlingTax" : { "type": ["number", "null"], "format": "double" },
+ "TotalOrderFee" : { "type": ["number", "null"], "format": "double" }
+ }
+ }
+ ]
+}
diff --git a/schema/Api/OrderBroker/parts/ShipToFromUpdateFulfillmentOrderRequest.json b/schema/Api/OrderBroker/parts/ShipToFromUpdateFulfillmentOrderRequest.json
new file mode 100644
index 0000000..c35ea89
--- /dev/null
+++ b/schema/Api/OrderBroker/parts/ShipToFromUpdateFulfillmentOrderRequest.json
@@ -0,0 +1,17 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "ShipToFromUpdateFulfillmentOrderRequest.json",
+ "type": "object",
+ "allOf": [
+ {"$ref": "ShipTo.json"},
+ {
+ "type": "object",
+ "properties": {
+ "FulfillmentSystemShippingMethodId": { "type": ["string", "null"] },
+ "ShippingCarrier" : { "type": ["string", "null"] },
+ "ShippingService" : { "type": ["string", "null"] },
+ "Status" : { "type": ["string", "null"] }
+ }
+ }
+ ]
+}
diff --git a/schema/Api/OrderBroker/parts/Shipment.json b/schema/Api/OrderBroker/parts/Shipment.json
new file mode 100644
index 0000000..eaccc55
--- /dev/null
+++ b/schema/Api/OrderBroker/parts/Shipment.json
@@ -0,0 +1,17 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "Shipment.json",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "ShipmentId": { "type": ["string", "null"] },
+ "Carrier": { "type": ["string", "null"] },
+ "Freight": { "type": ["number", "null"], "format": "double" },
+ "MasterTrackingNumber": { "type": ["string", "null"] },
+ "Packages": { "type": ["array", "null"], "items": {"$ref": "Package.json"} },
+ "PackingSlipNumber": { "type": ["string", "null"] },
+ "Service": { "type": ["string", "null"] },
+ "ShipDateUtc": { "type": ["string", "null"] },
+ "ShipToAddress": {"$ref": "ShipToAddress.json"}
+ }
+}
diff --git a/schema/Api/OrderBroker/parts/ShipmentPackage.json b/schema/Api/OrderBroker/parts/ShipmentPackage.json
new file mode 100644
index 0000000..603442a
--- /dev/null
+++ b/schema/Api/OrderBroker/parts/ShipmentPackage.json
@@ -0,0 +1,11 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "ShipmentPackage.json",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "ShipmentId": { "type": ["string", "null"] },
+ "PackageNumber": { "type": ["string", "null"] },
+ "ShipQuantity": { "type": ["number", "null"], "format": "double" }
+ }
+}
diff --git a/schema/Api/ProductBroker/GetAllProductsParameters.json b/schema/Api/ProductBroker/GetAllProductsParameters.json
index 714aab1..011b51c 100644
--- a/schema/Api/ProductBroker/GetAllProductsParameters.json
+++ b/schema/Api/ProductBroker/GetAllProductsParameters.json
@@ -3,9 +3,7 @@
"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"
- },
+ "schema": {"type": "string"},
"required": false
}
-}
\ No newline at end of file
+}
diff --git a/schema/Api/ProductBroker/GetAllProductsResponse.json b/schema/Api/ProductBroker/GetAllProductsResponse.json
index 48ec375..bc83237 100644
--- a/schema/Api/ProductBroker/GetAllProductsResponse.json
+++ b/schema/Api/ProductBroker/GetAllProductsResponse.json
@@ -2,21 +2,11 @@
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "GetAllProductsResponse.json",
"allOf": [
- {
- "$ref": "../../Common/ApiResponseBase.json"
- },
+ {"$ref": "../../Common/ApiResponseBase.json"},
{
"type": "object",
"properties": {
- "data": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "parts/Product.json"
- }
- }
+ "data": { "type": ["array", "null"], "items": {"$ref": "parts/Product.json"} }
}
}
]
diff --git a/schema/Api/ProductBroker/GetProductInventoryParameters.json b/schema/Api/ProductBroker/GetProductInventoryParameters.json
index 6685b51..3ed2a56 100644
--- a/schema/Api/ProductBroker/GetProductInventoryParameters.json
+++ b/schema/Api/ProductBroker/GetProductInventoryParameters.json
@@ -3,17 +3,13 @@
"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"
- },
+ "schema": {"type": "string"},
"required": false
},
"ProductId": {
"in": "path",
"name": "productId",
- "schema": {
- "type": "string"
- },
+ "schema": {"type": "string"},
"required": true
}
-}
\ No newline at end of file
+}
diff --git a/schema/Api/ProductBroker/GetProductInventoryResponse.json b/schema/Api/ProductBroker/GetProductInventoryResponse.json
index f41bc7a..1fe2645 100644
--- a/schema/Api/ProductBroker/GetProductInventoryResponse.json
+++ b/schema/Api/ProductBroker/GetProductInventoryResponse.json
@@ -1,16 +1,12 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
- "$id": "GetProductinventoryResponse.json",
+ "$id": "GetProductInventoryResponse.json",
"allOf": [
- {
- "$ref": "../../Common/ApiResponseBase.json"
- },
+ {"$ref": "../../Common/ApiResponseBase.json"},
{
"type": "object",
"properties": {
- "data": {
- "$ref": "parts/ProductInventory.json"
- }
+ "data": { "oneOf": [ {"type": "null"}, {"$ref": "parts/ProductInventory.json"} ] }
}
}
]
diff --git a/schema/Api/ProductBroker/GetProductStatisticsRequest.json b/schema/Api/ProductBroker/GetProductStatisticsRequest.json
deleted file mode 100644
index 9973820..0000000
--- a/schema/Api/ProductBroker/GetProductStatisticsRequest.json
+++ /dev/null
@@ -1,30 +0,0 @@
-{
- "$schema": "https://json-schema.org/draft-07/schema#",
- "$id": "GetProductStatisticsRequest.json",
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "productID": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
- },
- "sourceSystemCustomerID": {
- "type": [
- "string",
- "null"
- ]
- },
- "sourceSystemID": {
- "type": "integer",
- "format": "int32"
- }
- },
- "required": [
- "productID"
- ]
-}
diff --git a/schema/Api/ProductBroker/GetProductStatisticsResponse.json b/schema/Api/ProductBroker/GetProductStatisticsResponse.json
deleted file mode 100644
index 2ca7e4c..0000000
--- a/schema/Api/ProductBroker/GetProductStatisticsResponse.json
+++ /dev/null
@@ -1,80 +0,0 @@
-{
- "$schema": "https://json-schema.org/draft-07/schema#",
- "$id": "GetProductStatisticsResponse.json",
- "allOf": [
- {
- "$ref": "../../Common/ApiResponseBase.json"
- },
- {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "description": {
- "type": "string"
- },
- "currentAvailableQty": {
- "type": "integer"
- },
- "currentOnHandQty": {
- "type": "integer"
- },
- "expected": {
- "type": "integer"
- },
- "informationalMessages": {
- "type": "array"
- },
- "onBackorder": {
- "type": "integer"
- },
- "productID": {
- "type": "string"
- },
- "reserved": {
- "type": "null"
- },
- "totalUsageOverall": {
- "type": "integer"
- },
- "usage30Day": {
- "type": "integer"
- },
- "usage365Day": {
- "type": "integer"
- },
- "usage60Day": {
- "type": "integer"
- },
- "usage90Day": {
- "type": "integer"
- },
- "version": {
- "type": "null"
- }
- },
- "required": [
- "currentAvailableQty",
- "currentOnHandQty",
- "description",
- "expected",
- "informationalMessages",
- "onBackorder",
- "productID",
- "reserved",
- "totalUsageOverall",
- "usage30Day",
- "usage365Day",
- "usage60Day",
- "usage90Day",
- "version"
- ]
- }
- }
- }
- }
- ]
-}
diff --git a/schema/Api/ProductBroker/parts/Product.json b/schema/Api/ProductBroker/parts/Product.json
index 0105e1e..eae06ec 100644
--- a/schema/Api/ProductBroker/parts/Product.json
+++ b/schema/Api/ProductBroker/parts/Product.json
@@ -6,74 +6,26 @@
"properties": {
"ProductId": {
"description": "Unique ID for component product within Integration Broker",
- "type": [
- "string",
- "null"
- ]
- },
- "Color": {
- "description": "Color of product",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
+ "Color": { "description": "Color of product", "type": ["string", "null"] },
"LastUpdateDateTimeUtc": {
"description": "Date and time product was last updated in product management system (system where ordered line item products will be managed)",
"type": "string"
},
"ProductDescription": {
"description": "Description for component product within product management system (system where ordered line item products will be managed)",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"ProductNumber": {
"description": "Name for component product within product management system (system where ordered line item products will be managed)",
- "type": [
- "string",
- "null"
- ]
- },
- "ProductOwner": {
- "description": "Owner of component product",
- "type": [
- "string",
- "null"
- ]
- },
- "ProductType": {
- "type": [
- "string",
- "null"
- ]
- },
- "Size": {
- "description": "Size of component product",
- "type": [
- "string",
- "null"
- ]
- },
- "Status": {
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
- "UnitOfMeasure": {
- "type": [
- "string",
- "null"
- ]
- }
+ "ProductOwner": { "description": "Owner of component product", "type": ["string", "null"] },
+ "ProductType": { "type": ["string", "null"] },
+ "Size": { "description": "Size of component product", "type": ["string", "null"] },
+ "Status": { "type": ["string", "null"] },
+ "UnitOfMeasure": { "type": ["string", "null"] }
},
- "required": [
- "LastUpdateDateTimeUtc",
- "ProductId",
- "ProductNumber",
- "ProductType",
- "Status"
- ]
+ "required": ["LastUpdateDateTimeUtc", "ProductId", "ProductNumber", "ProductType", "Status"]
}
diff --git a/schema/Api/ProductBroker/parts/ProductInventory.json b/schema/Api/ProductBroker/parts/ProductInventory.json
index d933598..56b3e09 100644
--- a/schema/Api/ProductBroker/parts/ProductInventory.json
+++ b/schema/Api/ProductBroker/parts/ProductInventory.json
@@ -4,43 +4,12 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "ProductId": {
- "type": [
- "string",
- "null"
- ]
- },
- "CurrentAvailableQty": {
- "type": "integer",
- "format": "int32"
- },
- "CurrentOnHandQty": {
- "type": "integer",
- "format": "int32"
- },
- "Expected": {
- "type": [
- "integer",
- "null"
- ],
- "format": "int32"
- },
- "OnBackorder": {
- "type": [
- "integer",
- "null"
- ],
- "format": "int32"
- },
- "Reserved": {
- "type": "integer",
- "format": "int32"
- }
+ "ProductId" : { "type": ["string", "null"] },
+ "CurrentAvailableQty": { "type": "integer" , "format": "int32" },
+ "CurrentOnHandQty" : { "type": "integer" , "format": "int32" },
+ "Expected" : { "type": ["integer", "null"], "format": "int32" },
+ "OnBackorder" : { "type": ["integer", "null"], "format": "int32" },
+ "Reserved" : { "type": "integer" , "format": "int32" }
},
- "required": [
- "CurrentAvailableQty",
- "CurrentOnHandQty",
- "ProductId",
- "Reserved"
- ]
+ "required": ["CurrentAvailableQty", "CurrentOnHandQty", "ProductId", "Reserved"]
}
diff --git a/schema/Common/ApiResponseBase.json b/schema/Common/ApiResponseBase.json
index 5f0dd4a..e229bfb 100644
--- a/schema/Common/ApiResponseBase.json
+++ b/schema/Common/ApiResponseBase.json
@@ -3,20 +3,8 @@
"$id": "ApiResponseBase.json",
"type": "object",
"properties": {
- "failureMessages": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "informationalMessages": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "operationWasSuccessful": {
- "type": "boolean"
- }
+ "failureMessages" : { "type": "array" , "items": {"type": "string"} },
+ "informationalMessages" : { "type": "array" , "items": {"type": "string"} },
+ "operationWasSuccessful": { "type": "boolean" }
}
}
diff --git a/schema/Common/EventBase.json b/schema/Common/EventBase.json
index f281d50..82b7e60 100644
--- a/schema/Common/EventBase.json
+++ b/schema/Common/EventBase.json
@@ -9,57 +9,28 @@
"type": "string",
"format": "{FulfillmentSystemId}-{FulfillmentSystemCustomerId}-{ShippingOrderId}"
},
- "CorrelationId": {
- "description": "Unique ID for SOB-external event trigger",
- "type": "string"
- },
- "AggregateType": {
- "description": "Type of event schema",
- "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"
- ],
+ "type": ["string", "null"],
"veraCoreSource": "SHPACK_UserName in warehouse DB. SHPACK in the OMS contains a SeqId for the warehouse table."
},
"EventDateTimeUtc": {
"description": "UTC based datetime of when event was triggered",
"type": "string"
},
- "EventNameValuePairs": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "object"
- }
- },
+ "EventNameValuePairs": { "type": ["array", "null"], "items": {"type": "object"} },
"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"
- }
+ "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"
+ "AggregateId", "AggregateType", "CorrelationId", "EventDateTimeUtc", "EventName",
+ "EventPublisherApp", "EventSchemaVersion", "EventSource"
],
"examples": [
{
diff --git a/schema/Event/CustomerFile/CustomerFile.json b/schema/Event/CustomerFile/CustomerFile.json
index 77b099e..273e664 100644
--- a/schema/Event/CustomerFile/CustomerFile.json
+++ b/schema/Event/CustomerFile/CustomerFile.json
@@ -4,24 +4,14 @@
"description": "CustomerFile properties",
"type": "object",
"properties": {
- "CustomerId": {
- "description": "SOB unique ID of customer owner of the file",
- "type": "string"
- },
+ "CustomerId": {"description": "SOB unique ID of customer owner of the file", "type": "string"},
"Id": {
"description": "SOB unique ID for the file",
"type": "string",
"format": "uuid"
},
- "ContentLength": {
- "description": "Length in bytes of the file",
- "type": "integer",
- "minimum": 0
- },
- "ContentType": {
- "description": "MIME type of the file contents",
- "type": "string"
- },
+ "ContentLength": {"description": "Length in bytes of the file", "type": "integer", "minimum": 0},
+ "ContentType": {"description": "MIME type of the file contents", "type": "string"},
"FullPathName": {
"description": "Full path of file, containing directories and full file name",
"type": "string"
@@ -29,23 +19,14 @@
"StorageSystem": {
"description": "Name of storage provider",
"type": "string",
- "enum": [
- "Azure Blob"
- ]
- },
- "StorageSystemAccount": {
- "description": "Account name or ID at the storage provider",
- "type": "string"
+ "enum": ["Azure Blob"]
},
+ "StorageSystemAccount": {"description": "Account name or ID at the storage provider", "type": "string"},
"Url": {
"description": "Full URL to access the file",
"type": "string",
"format": "uri"
}
},
- "required": [
- "Id",
- "FullPathName",
- "StorageSystem"
- ]
+ "required": ["Id", "FullPathName", "StorageSystem"]
}
diff --git a/schema/Event/CustomerFile/CustomerFileEvent.json b/schema/Event/CustomerFile/CustomerFileEvent.json
index b55aa9b..bd5e522 100644
--- a/schema/Event/CustomerFile/CustomerFileEvent.json
+++ b/schema/Event/CustomerFile/CustomerFileEvent.json
@@ -4,16 +4,10 @@
"description": "Details for Shipping Order JSON schema",
"type": "object",
"allOf": [
- {
- "$ref": "../../Common/EventBase.json"
- },
+ {"$ref": "../../Common/EventBase.json"},
{
"type": "object",
- "properties": {
- "CustomFile": {
- "$ref": "CustomerFile.json"
- }
- }
+ "properties": { "CustomFile": {"$ref": "CustomerFile.json"} }
},
{
"type": "object",
@@ -21,10 +15,7 @@
"EventName": {
"description": "Name of triggered event",
"type": "string",
- "enum": [
- "File Received",
- "File Decrypted"
- ]
+ "enum": ["File Received", "File Decrypted"]
}
}
}
diff --git a/schema/Event/FulfillmentOrder/FulfillmentOrder.json b/schema/Event/FulfillmentOrder/FulfillmentOrder.json
index 90c7e2d..199eb2f 100644
--- a/schema/Event/FulfillmentOrder/FulfillmentOrder.json
+++ b/schema/Event/FulfillmentOrder/FulfillmentOrder.json
@@ -7,55 +7,29 @@
"properties": {
"CustomerId": {
"description": "Customer ID tied to the fulfillment order",
- "type": [
- "string",
- "null"
- ]
- },
- "FulfillmentOrderId": {
- "description": "Unique ID for fulfillment order",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
+ "FulfillmentOrderId": { "description": "Unique ID for fulfillment order", "type": ["string", "null"] },
"FulfillmentSystemCustomerId": {
"description": "ID of customer within the fulfillment system",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"FulfillmentSystemId": {
"description": "System used to fulfill the order",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"FulfillmentSystemLocationId": {
"description": "ID of location within the fulfillment system",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"FulfillmentSystemOrderId": {
"description": "Fulfillment order ID within the fulfillment system",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"BillTo": {
"description": "Fulfillment order level bill to contact and address details",
- "type": [
- "object",
- "null"
- ],
- "items": {
- "$ref": "parts/BillTo.json"
- },
+ "type": ["object", "null"],
+ "items": {"$ref": "parts/BillTo.json"},
"examples": [
{
"Address1": "106 Tyler Street Suite 175",
@@ -76,82 +50,44 @@
},
"CreateDateTime": {
"description": "Created date time of the fulfillment order",
- "type": [
- "string",
- "null"
- ]
- },
- "DefaultShipToKey": {
- "description": "Default key for ShipTo",
- "type": "integer"
+ "type": ["string", "null"]
},
+ "DefaultShipToKey": {"description": "Default key for ShipTo", "type": "integer"},
"DueDate": {
"description": "Due date of the fulfillment order",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"OrderIds": {
"description": "Order IDs tied to the fulfillment order",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
+ "type": ["array", "null"],
+ "items": {"type": "string"}
},
"OrderVariables": {
"description": "Order variables tied to the fulfillment order in JSON format",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"PONumber": {
"description": "PO number tied to the fulfillment order",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"PaymentMethods": {
"description": "PaymentMethod details",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "parts/PaymentMethod.json"
- }
+ "type": ["array", "null"],
+ "items": {"$ref": "parts/PaymentMethod.json"}
},
"Products": {
"description": "Fulfillment order level product details",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "parts/FOProduct.json"
- }
+ "type": ["array", "null"],
+ "items": {"$ref": "parts/FOProduct.json"}
},
"RushOrder": {
"description": "Indicator if the order is a rush order",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"ShipTos": {
"description": "Fulfillment order level ship to details",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "parts/FOShipTo.json"
- },
+ "type": ["array", "null"],
+ "items": {"$ref": "parts/FOShipTo.json"},
"examples": [
{
"FulfillmentSystemShippingMethodId": "FedEx Ground",
@@ -184,57 +120,28 @@
}
},
"required": [
- "FulfillmentOrderId",
- "OrderIds",
- "CustomerId",
- "FulfillmentSystemOrderId",
- "FulfillmentSystemId",
- "FulfillmentSystemCustomerId",
- "FulfillmentSystemLocationId",
- "Products",
- "ShipTos",
- "BillTo",
+ "FulfillmentOrderId", "OrderIds", "CustomerId", "FulfillmentSystemOrderId",
+ "FulfillmentSystemId", "FulfillmentSystemCustomerId",
+ "FulfillmentSystemLocationId", "Products", "ShipTos", "BillTo",
"DefaultShipToKey"
],
"allOf": [
{
"oneOf": [
{
- "properties": {
- "DefaultShipToKey": {
- "type": "integer"
- }
- },
- "required": [
- "DefaultShipToKey"
- ]
+ "properties": { "DefaultShipToKey": {"type": "integer"} },
+ "required": ["DefaultShipToKey"]
},
{
"not": {
- "properties": {
- "DefaultShipToKey": {
- "type": "integer"
- }
- },
- "required": [
- "DefaultShipToKey"
- ]
+ "properties": { "DefaultShipToKey": {"type": "integer"} },
+ "required": ["DefaultShipToKey"]
},
"properties": {
- "DefaultShipToKey": {
- "type": [
- "null",
- "integer"
- ]
- },
- "ShipTos": {
- "type": "array",
- "minItems": 1
- }
+ "DefaultShipToKey": { "type": ["null", "integer"] },
+ "ShipTos" : { "type": "array" , "minItems": 1 }
},
- "required": [
- "ShipTos"
- ]
+ "required": ["ShipTos"]
}
]
}
@@ -264,17 +171,10 @@
"CreateDateTime": "2025-03-13T22:26:59.3895106Z",
"DefaultShipToKey": 0,
"DueDate": "2025-03-14T22:26:59.3895111Z",
- "OrderIds": [
- "88236a77-813d-a65a-3311-e1facde69736"
- ],
+ "OrderIds": ["88236a77-813d-a65a-3311-e1facde69736"],
"OrderVariables": "{}",
"PONumber": "n94ualw05x",
- "PaymentMethods": [
- {
- "Amount": 131.25,
- "MethodName": "Credit Card"
- }
- ],
+ "PaymentMethods": [ {"Amount": 131.25, "MethodName": "Credit Card"} ],
"Products": [
{
"FulfillmentSystemProductId": "123456",
diff --git a/schema/Event/FulfillmentOrder/FulfillmentOrderEvent.json b/schema/Event/FulfillmentOrder/FulfillmentOrderEvent.json
index b509438..ac29479 100644
--- a/schema/Event/FulfillmentOrder/FulfillmentOrderEvent.json
+++ b/schema/Event/FulfillmentOrder/FulfillmentOrderEvent.json
@@ -4,16 +4,10 @@
"description": "Details for Shipping Order JSON schema",
"type": "object",
"allOf": [
- {
- "$ref": "../../Common/EventBase.json"
- },
+ {"$ref": "../../Common/EventBase.json"},
{
"type": "object",
- "properties": {
- "FulfillmentOrder": {
- "$ref": "FulfillmentOrder.json"
- }
- }
+ "properties": { "FulfillmentOrder": {"$ref": "FulfillmentOrder.json"} }
},
{
"type": "object",
@@ -22,10 +16,8 @@
"description": "Name of triggered event",
"type": "string",
"enum": [
- "FulfillmentOrder Created",
- "FulfillmentOrder Submitted to FulfillmentSystem",
- "FulfillmentOrder Submission Failed",
- "FulfillmentOrder Updated",
+ "FulfillmentOrder Created", "FulfillmentOrder Submitted to FulfillmentSystem",
+ "FulfillmentOrder Submission Failed", "FulfillmentOrder Updated",
"FulfillmentOrder Validation Failed"
]
}
diff --git a/schema/Event/FulfillmentOrder/parts/BillTo.json b/schema/Event/FulfillmentOrder/parts/BillTo.json
index 3cd4461..b5eedf7 100644
--- a/schema/Event/FulfillmentOrder/parts/BillTo.json
+++ b/schema/Event/FulfillmentOrder/parts/BillTo.json
@@ -5,104 +5,31 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "Address1": {
- "description": "Address line 1 for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Address2": {
- "description": "Address line 2 for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Address3": {
- "description": "Address line 3 for address",
- "type": [
- "string",
- "null"
- ]
- },
- "City": {
- "description": "City name for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Company": {
- "description": "Company name for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Country": {
- "description": "Country name for address",
- "type": [
- "string",
- "null"
- ]
- },
+ "Address1": { "description": "Address line 1 for address", "type": ["string", "null"] },
+ "Address2": { "description": "Address line 2 for address", "type": ["string", "null"] },
+ "Address3": { "description": "Address line 3 for address", "type": ["string", "null"] },
+ "City": { "description": "City name for address", "type": ["string", "null"] },
+ "Company": { "description": "Company name for address", "type": ["string", "null"] },
+ "Country": { "description": "Country name for address", "type": ["string", "null"] },
"EmailAddress": {
"description": "Contact email address for address",
- "type": [
- "string",
- "null"
- ]
- },
- "FaxNumber": {
- "description": "Fax number for address",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
+ "FaxNumber": { "description": "Fax number for address", "type": ["string", "null"] },
"Key": {
"description": "Unique ID for individual contact",
"type": "integer",
"format": "int32"
},
- "Name": {
- "description": "Contact name for this address",
- "type": [
- "string",
- "null"
- ]
- },
- "PhoneNumber": {
- "description": "Phone number for address",
- "type": [
- "string",
- "null"
- ]
- },
- "PostalCode": {
- "description": "Postal code for address",
- "type": [
- "string",
- "null"
- ]
- },
+ "Name": { "description": "Contact name for this address", "type": ["string", "null"] },
+ "PhoneNumber": { "description": "Phone number for address", "type": ["string", "null"] },
+ "PostalCode": { "description": "Postal code for address", "type": ["string", "null"] },
"StateProvince": {
"description": "State or province name for address",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
}
},
- "required": [
- "Address1",
- "City",
- "Country",
- "Name",
- "PostalCode",
- "StateProvince"
- ],
+ "required": ["Address1", "City", "Country", "Name", "PostalCode", "StateProvince"],
"examples": [
{
"Address1": "106 Tyler Street Suite 175",
diff --git a/schema/Event/FulfillmentOrder/parts/FOProduct.json b/schema/Event/FulfillmentOrder/parts/FOProduct.json
index bc14d7a..637eee1 100644
--- a/schema/Event/FulfillmentOrder/parts/FOProduct.json
+++ b/schema/Event/FulfillmentOrder/parts/FOProduct.json
@@ -7,68 +7,27 @@
"properties": {
"FulfillmentSystemProductId": {
"description": "Product ID in fulfillment system",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"ProductId": {
"description": "Unique ID for product within Integration Broker",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"ProductLineId": {
"description": "Identifier for product line within fulfillment order. Format: {fulfillmentSystemId}-{customerId}-{fulfillmentSystemProductId}",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"AssociatedFileName": {
"description": "Name of file associated to product (if applicable)",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
- "Comment": {
- "description": "Comment for product",
- "type": [
- "string",
- "null"
- ]
- },
- "Price": {
- "description": "Price of product line item",
- "type": [
- "number",
- "null"
- ]
- },
- "QuantityOrdered": {
- "description": "Amount of product ordered",
- "type": "integer"
- },
- "ShipToKey": {
- "description": "ShipTo key for shipping this product",
- "type": "integer"
- },
- "Status": {
- "description": "Status of product line item",
- "type": [
- "string",
- "null"
- ]
- }
+ "Comment": { "description": "Comment for product", "type": ["string", "null"] },
+ "Price": { "description": "Price of product line item", "type": ["number", "null"] },
+ "QuantityOrdered": {"description": "Amount of product ordered", "type": "integer"},
+ "ShipToKey": {"description": "ShipTo key for shipping this product", "type": "integer"},
+ "Status": { "description": "Status of product line item", "type": ["string", "null"] }
},
- "required": [
- "ProductLineId",
- "QuantityOrdered",
- "FulfillmentSystemProductId",
- "Price"
- ],
+ "required": ["ProductLineId", "QuantityOrdered", "FulfillmentSystemProductId", "Price"],
"examples": [
{
"FulfillmentSystemProductId": "123456",
diff --git a/schema/Event/FulfillmentOrder/parts/FOShipTo.json b/schema/Event/FulfillmentOrder/parts/FOShipTo.json
index ef9168f..6159594 100644
--- a/schema/Event/FulfillmentOrder/parts/FOShipTo.json
+++ b/schema/Event/FulfillmentOrder/parts/FOShipTo.json
@@ -7,57 +7,26 @@
"properties": {
"FulfillmentSystemShippingMethodId": {
"description": "Shipping method ID in fulfillment system",
- "type": [
- "string",
- "null"
- ]
- },
- "ReferenceId": {
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
+ "ReferenceId": { "type": ["string", "null"] },
"Comment": {
"description": "Manually entered comment for individual Order.ShipTos",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"DueDate": {
"description": "Datetime of expected due date for individual Order.ShipTos",
- "type": [
- "string",
- "null"
- ]
- },
- "Key": {
- "description": "Unique ID for individual ship to",
- "type": "integer"
+ "type": ["string", "null"]
},
+ "Key": {"description": "Unique ID for individual ship to", "type": "integer"},
"PONumber": {
"description": "Purchase order number for individual Order.ShipTos",
- "type": [
- "string",
- "null"
- ]
- },
- "PaymentMethods": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "PaymentMethod.json"
- }
+ "type": ["string", "null"]
},
+ "PaymentMethods": { "type": ["array", "null"], "items": {"$ref": "PaymentMethod.json"} },
"RushOrder": {
"description": "True/false indicator if individual Order.ShipTos is expedited",
- "type": [
- "boolean",
- "null"
- ]
+ "type": ["boolean", "null"]
},
"ShipToAddress": {
"$ref": "ShipToAddress.json",
@@ -79,38 +48,15 @@
}
]
},
- "ShippingCarrier": {
- "description": "Shipping carrier",
- "type": [
- "string",
- "null"
- ]
- },
+ "ShippingCarrier": { "description": "Shipping carrier", "type": ["string", "null"] },
"ShippingCost": {
"description": "Shipping cost for individual Order.ShipTos",
- "type": [
- "number",
- "null"
- ]
+ "type": ["number", "null"]
},
- "ShippingService": {
- "description": "Shipping service",
- "type": [
- "string",
- "null"
- ]
- },
- "Status": {
- "description": "status",
- "type": [
- "string",
- "null"
- ]
- }
+ "ShippingService": { "description": "Shipping service", "type": ["string", "null"] },
+ "Status": { "description": "status", "type": ["string", "null"] }
},
- "required": [
- "FulfillmentSystemShippingMethodId"
- ],
+ "required": ["FulfillmentSystemShippingMethodId"],
"examples": [
{
"FulfillmentSystemShippingMethodId": "FedEx Ground",
diff --git a/schema/Event/FulfillmentOrder/parts/PaymentMethod.json b/schema/Event/FulfillmentOrder/parts/PaymentMethod.json
index 3faac32..0c509ef 100644
--- a/schema/Event/FulfillmentOrder/parts/PaymentMethod.json
+++ b/schema/Event/FulfillmentOrder/parts/PaymentMethod.json
@@ -2,16 +2,6 @@
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "PaymentMethod.json",
"type": "object",
- "properties": {
- "Amount": {
- "type": "number"
- },
- "MethodName": {
- "type": "string"
- }
- },
- "required": [
- "MethodName",
- "Amount"
- ]
+ "properties": { "Amount": {"type": "number"}, "MethodName": {"type": "string"} },
+ "required": ["MethodName", "Amount"]
}
diff --git a/schema/Event/FulfillmentOrder/parts/ShipToAddress.json b/schema/Event/FulfillmentOrder/parts/ShipToAddress.json
index 4a5b179..133ab9c 100644
--- a/schema/Event/FulfillmentOrder/parts/ShipToAddress.json
+++ b/schema/Event/FulfillmentOrder/parts/ShipToAddress.json
@@ -5,101 +5,27 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "Address1": {
- "description": "Address line 1 for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Address2": {
- "description": "Address line 2 for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Address3": {
- "description": "Address line 3 for address",
- "type": [
- "string",
- "null"
- ]
- },
- "City": {
- "description": "City name for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Company": {
- "description": "Company name for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Country": {
- "description": "Country name for address",
- "type": [
- "string",
- "null"
- ]
- },
+ "Address1": { "description": "Address line 1 for address", "type": ["string", "null"] },
+ "Address2": { "description": "Address line 2 for address", "type": ["string", "null"] },
+ "Address3": { "description": "Address line 3 for address", "type": ["string", "null"] },
+ "City": { "description": "City name for address", "type": ["string", "null"] },
+ "Company": { "description": "Company name for address", "type": ["string", "null"] },
+ "Country": { "description": "Country name for address", "type": ["string", "null"] },
"EmailAddress": {
"description": "Contact email address for address",
- "type": [
- "string",
- "null"
- ]
- },
- "FaxNumber": {
- "description": "Fax number for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Key": {
- "description": "Unique ID for individual contact"
- },
- "Name": {
- "type": [
- "string",
- "null"
- ]
- },
- "PhoneNumber": {
- "description": "Phone number for address",
- "type": [
- "string",
- "null"
- ]
- },
- "PostalCode": {
- "description": "Postal code for address",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
+ "FaxNumber": { "description": "Fax number for address", "type": ["string", "null"] },
+ "Key": {"description": "Unique ID for individual contact"},
+ "Name": { "type": ["string", "null"] },
+ "PhoneNumber": { "description": "Phone number for address", "type": ["string", "null"] },
+ "PostalCode": { "description": "Postal code for address", "type": ["string", "null"] },
"StateProvince": {
"description": "State or province name for address",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
}
},
- "required": [
- "Address1",
- "City",
- "Country",
- "Name",
- "PostalCode",
- "StateProvince"
- ],
+ "required": ["Address1", "City", "Country", "Name", "PostalCode", "StateProvince"],
"examples": [
{
"Address1": "106 Tyler Street Suite 175",
diff --git a/schema/Event/Offer/Offer.json b/schema/Event/Offer/Offer.json
index 2cde38b..ebfe750 100644
--- a/schema/Event/Offer/Offer.json
+++ b/schema/Event/Offer/Offer.json
@@ -4,16 +4,14 @@
"description": "Offer properties",
"type": "object",
"properties": {
- "Id": {
- "description": "Unique ID assigned to the offer by SOB",
- "type": "string"
+ "CustomerId": {
+ "description": "Customer that the offer belongs to",
+ "type": ["string", "null"]
},
+ "Id": {"description": "Unique ID assigned to the offer by SOB", "type": "string"},
"OmsOfferId": {
"description": "Unique ID assigned to the offer by the OMS",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"XMPieTemplateId": {
"description": "Id of XMPie template to be used in production",
@@ -25,225 +23,111 @@
},
"AccessGroups": {
"description": "An array of access groups assigned to have access to the offer",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
+ "type": ["array", "null"],
+ "items": {"type": "string"}
},
"AdditionalPropertiesRequiredOnOrder": {
"description": "Any properties that are required for this offer that wouldn't otherwise be required for an offer order",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "./parts/AdditionalPropertiesRequiredOnOrder.json"
- }
+ "type": ["array", "null"],
+ "items": {"$ref": "./parts/AdditionalPropertiesRequiredOnOrder.json"}
},
"AvailableEndDate": {
"description": "Date that offer is no longer available for sale",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"AvailableStartDate": {
"description": "Date that offer is available for sale",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"CategoryIds": {
"description": "An array of category IDs identifying the categories an offer is assigned",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
+ "type": ["array", "null"],
+ "items": {"type": "string"}
},
"Comments": {
"description": "Additional information about the offer",
- "type": [
- "string",
- "null"
- ]
- },
- "CustomerId": {
- "description": "Customer that the offer belongs to",
- "type": "string",
- "nullable": true
+ "type": ["string", "null"]
},
"DefaultPrice": {
"description": "Default price of the offer if no price classes are applied",
- "type": [
- "number",
- "null"
- ]
+ "type": ["number", "null"]
},
"Description": {
"description": "More detailed description of the offer",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"DoSuppressShippingAndHandling": {
"description": "Disable shipping and handling fees being applied to the offer",
- "type": [
- "boolean",
- "null"
- ]
+ "type": ["boolean", "null"]
},
"FixedOrderQuantities": {
"description": "Indicates the offer should only be orderable in the defined quantities",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "number"
- }
+ "type": ["array", "null"],
+ "items": {"type": "number"}
},
"FullImageUrl": {
"description": "URL of full product image for the offer",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"IsActive": {
"description": "Flag indicating whether offer is available for sale, if within the availability dates",
- "type": [
- "boolean",
- "null"
- ]
- },
- "IsDeleted": {
- "description": "Flag indicating a soft delete of the offer",
- "type": "boolean"
+ "type": ["boolean", "null"]
},
+ "IsDeleted": {"description": "Flag indicating a soft delete of the offer", "type": "boolean"},
"IsTaxable": {
"description": "Indicates whether the offer can be taxed",
- "type": [
- "boolean",
- "null"
- ]
- },
- "Number": {
- "description": "Number to identify offer",
- "type": [
- "string",
- "null"
- ]
+ "type": ["boolean", "null"]
},
+ "Number": { "description": "Number to identify offer", "type": ["string", "null"] },
"OfferType": {
"description": "Indicates whether the offer is a product list, drop ship, etc",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"OmsLastUpdateDateTimeUtc": {
"description": "UTC DateTime that the offer was last updated by the system that manages it. This value is set by the OMS",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"OnlyShipMethodsAvailable": {
"description": "If an offer is only available via a defined set of ship methods, they are declared in this array",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
+ "type": ["array", "null"],
+ "items": {"type": "string"}
},
"OrderMaximum": {
"description": "The maximum quantity of the offer that can be ordered",
- "type": [
- "number",
- "null"
- ]
+ "type": ["number", "null"]
},
"OrderMinimum": {
"description": "The minimum quantity of the offer that can be ordered",
- "type": [
- "number",
- "null"
- ]
+ "type": ["number", "null"]
},
"PdfUrl": {
"description": "URL of a PDF that may be associated with the offer",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"PriceClasses": {
"description": "Array of price classes",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "./parts/PriceClass.json"
- }
+ "type": ["array", "null"],
+ "items": {"$ref": "./parts/PriceClass.json"}
},
"ProductClusters": {
"description": "Array of product clusters",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "./parts/ProductCluster.json"
- }
+ "type": ["array", "null"],
+ "items": {"$ref": "./parts/ProductCluster.json"}
},
"SecureEmailBody": {
"description": "If this offer is a secure email type, this is the body that should be used",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"SecureEmailSubject": {
"description": "If this offer is a secure email type, this is the subject that should be used",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"ThumbnailUrl": {
"description": "URL of thumbnail image for the offer",
- "type": [
- "string",
- "null"
- ]
- },
- "UnitOfMeasure": {
- "description": "Orderable units of the offer",
- "type": [
- "string",
- "null"
- ]
- },
- "WeightInPounds": {
- "description": "Weight of offer",
- "type": [
- "number",
- "null"
- ]
- }
+ "type": ["string", "null"]
+ },
+ "UnitOfMeasure": { "description": "Orderable units of the offer", "type": ["string", "null"] },
+ "WeightInPounds": { "description": "Weight of offer", "type": ["number", "null"] }
},
- "required": [
- "Id"
- ]
+ "required": ["Id"]
}
diff --git a/schema/Event/Offer/OfferEvent.json b/schema/Event/Offer/OfferEvent.json
index ab95783..4e610fa 100644
--- a/schema/Event/Offer/OfferEvent.json
+++ b/schema/Event/Offer/OfferEvent.json
@@ -4,28 +4,15 @@
"description": "Details for Shipping Order JSON schema",
"type": "object",
"allOf": [
- {
- "$ref": "../../Common/EventBase.json"
- },
- {
- "type": "object",
- "properties": {
- "Offer": {
- "$ref": "Offer.json"
- }
- }
- },
+ {"$ref": "../../Common/EventBase.json"},
+ { "type": "object", "properties": { "Offer": {"$ref": "Offer.json"} } },
{
"type": "object",
"properties": {
"EventName": {
"description": "Name of triggered event",
"type": "string",
- "enum": [
- "Offer Created",
- "Offer Updated",
- "Offer Deleted"
- ]
+ "enum": ["Offer Created", "Offer Updated", "Offer Deleted"]
}
}
}
diff --git a/schema/Event/Offer/parts/AdditionalPropertiesRequiredOnOrder.json b/schema/Event/Offer/parts/AdditionalPropertiesRequiredOnOrder.json
index ffdbdb2..6b076df 100644
--- a/schema/Event/Offer/parts/AdditionalPropertiesRequiredOnOrder.json
+++ b/schema/Event/Offer/parts/AdditionalPropertiesRequiredOnOrder.json
@@ -5,21 +5,10 @@
"properties": {
"IsDeleted": {
"description": "Flag to indicate the property has been removed from the line item.",
- "type": [
- "boolean",
- "null"
- ]
+ "type": ["boolean", "null"]
},
- "Name": {
- "description": "Name of required property",
- "type": "string"
- },
- "Type": {
- "description": "Type of property",
- "type": "string"
- }
+ "Name": {"description": "Name of required property", "type": "string"},
+ "Type": {"description": "Type of property", "type": "string"}
},
- "required": [
- "Name"
- ]
+ "required": ["Name"]
}
diff --git a/schema/Event/Offer/parts/PriceClass.json b/schema/Event/Offer/parts/PriceClass.json
index 60152b5..f1b3a85 100644
--- a/schema/Event/Offer/parts/PriceClass.json
+++ b/schema/Event/Offer/parts/PriceClass.json
@@ -9,10 +9,7 @@
},
"IsDeleted": {
"description": "Flag to indicate the property has been removed from the line item.",
- "type": [
- "boolean",
- "null"
- ]
+ "type": ["boolean", "null"]
},
"Price": {
"description": "Default price for the access group if not covered by price tiers",
@@ -21,9 +18,7 @@
"PriceTiers": {
"description": "Pricing tiered by quantity being ordered",
"type": "array",
- "items": {
- "$ref": "PriceTier.json"
- }
+ "items": {"$ref": "PriceTier.json"}
}
}
}
diff --git a/schema/Event/Offer/parts/PriceTier.json b/schema/Event/Offer/parts/PriceTier.json
index 4198fab..f17c3aa 100644
--- a/schema/Event/Offer/parts/PriceTier.json
+++ b/schema/Event/Offer/parts/PriceTier.json
@@ -3,10 +3,7 @@
"$id": "PriceTier.json",
"type": "object",
"properties": {
- "MaximumQuantity": {
- "description": "Ending quantity of the range for this price",
- "type": "number"
- },
+ "MaximumQuantity": {"description": "Ending quantity of the range for this price", "type": "number"},
"MinimumQuantity": {
"description": "Starting quantity of the range for this price",
"type": "number"
diff --git a/schema/Event/Offer/parts/ProductCluster.json b/schema/Event/Offer/parts/ProductCluster.json
index b52da34..b298f9c 100644
--- a/schema/Event/Offer/parts/ProductCluster.json
+++ b/schema/Event/Offer/parts/ProductCluster.json
@@ -3,24 +3,15 @@
"$id": "ProductCluster.json",
"type": "object",
"properties": {
- "ClusterId": {
- "description": "SOB unique ID for the cluster",
- "type": "string"
- },
+ "ClusterId": {"description": "SOB unique ID for the cluster", "type": "string"},
"IsDeleted": {
"description": "Flag to indicate the property has been removed from the line item.",
- "type": [
- "boolean",
- "null"
- ]
+ "type": ["boolean", "null"]
},
"ProductQuantityInOffer": {
"description": "Indicates the quantity of the selected cluster item included in the offer",
"type": "integer"
}
},
- "required": [
- "ClusterId",
- "ProductQuantityInOffer"
- ]
+ "required": ["ClusterId", "ProductQuantityInOffer"]
}
diff --git a/schema/Event/OfferCategory/OfferCategory.json b/schema/Event/OfferCategory/OfferCategory.json
index 2258b1a..1075bc5 100644
--- a/schema/Event/OfferCategory/OfferCategory.json
+++ b/schema/Event/OfferCategory/OfferCategory.json
@@ -4,34 +4,17 @@
"description": "OfferCategory properties",
"type": "object",
"properties": {
- "CustomerId": {
- "description": "SOB unique ID of customer",
- "type": "string"
- },
- "OfferCategoryId": {
- "description": "SOB globally-unique ID of category",
- "type": "string"
- },
+ "CustomerId": {"description": "SOB unique ID of customer", "type": "string"},
+ "OfferCategoryId": {"description": "SOB globally-unique ID of category", "type": "string"},
"ParentId": {
"description": "SOB unique ID of the parent category, if there is one",
- "type": [
- "string",
- "null"
- ]
- },
- "Name": {
- "description": "Name to identify category",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
+ "Name": { "description": "Name to identify category", "type": ["string", "null"] },
"OmsLastUpdateDateTimeUtc": {
"description": "UTC date/time of last update to this category",
"type": "string"
}
},
- "required": [
- "OfferCategoryId"
- ]
+ "required": ["OfferCategoryId"]
}
diff --git a/schema/Event/OfferCategory/OfferCategoryEvent.json b/schema/Event/OfferCategory/OfferCategoryEvent.json
index 320b725..6b46b75 100644
--- a/schema/Event/OfferCategory/OfferCategoryEvent.json
+++ b/schema/Event/OfferCategory/OfferCategoryEvent.json
@@ -4,16 +4,10 @@
"description": "Details for Shipping Order JSON schema",
"type": "object",
"allOf": [
- {
- "$ref": "../../Common/EventBase.json"
- },
+ {"$ref": "../../Common/EventBase.json"},
{
"type": "object",
- "properties": {
- "OfferCategory": {
- "$ref": "OfferCategory.json"
- }
- }
+ "properties": { "OfferCategory": {"$ref": "OfferCategory.json"} }
},
{
"type": "object",
@@ -21,11 +15,7 @@
"EventName": {
"description": "Name of triggered event",
"type": "string",
- "enum": [
- "Offer Category Created",
- "Offer Category Updated",
- "Offer Category Deleted"
- ]
+ "enum": ["Offer Category Created", "Offer Category Updated", "Offer Category Deleted"]
}
}
}
diff --git a/schema/Event/Order/Order.json b/schema/Event/Order/Order.json
index 55c3081..5322ca8 100644
--- a/schema/Event/Order/Order.json
+++ b/schema/Event/Order/Order.json
@@ -4,207 +4,87 @@
"description": "Order level line item details",
"type": "object",
"properties": {
- "OmsCustomerId": {
- "type": [
- "string",
- "null"
- ]
- },
- "OmsId": {
- "type": [
- "string",
- "null"
- ]
- },
- "OmsOrderId": {
- "type": [
- "string",
- "null"
- ]
- },
+ "OmsCustomerId": { "type": ["string", "null"] },
+ "OmsId": { "type": ["string", "null"] },
+ "OmsOrderId": { "type": ["string", "null"] },
"OrderId": {
"description": "Unique ID for order within order management system (system where order lifecycle will be managed)",
- "type": [
- "string",
- "null"
- ]
- },
- "ReferenceId": {
- "type": [
- "string",
- "null"
- ]
- },
- "SourceSystemCustomerId": {
- "type": [
- "string",
- "null"
- ]
- },
- "SourceSystemId": {
- "type": [
- "integer",
- "null"
- ]
- },
- "SourceSystemOrderId": {
- "type": [
- "string",
- "null"
- ]
- },
- "AccessGroups": {
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
+ "type": ["string", "null"]
},
+ "ReferenceId": { "type": ["string", "null"] },
+ "SourceSystemCustomerId": { "type": ["string", "null"] },
+ "SourceSystemId": { "type": ["integer", "null"] },
+ "SourceSystemOrderId": { "type": ["string", "null"] },
+ "AccessGroups": { "type": ["array", "null"], "items": {"type": "string"} },
"AffiliateIdentifier": {
"description": "Unique ID for affiliate within source system (system where order was originally placed)",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"AffiliateName": {
"description": "Name for affiliate within source system (system where order was originally placed)",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"BillTos": {
"description": "Array of bill to addresses",
"type": "array",
- "items": {
- "$ref": "./parts/BillTo.json"
- }
- },
- "CostCenter": {
- "type": [
- "string",
- "null"
- ]
+ "items": {"$ref": "./parts/BillTo.json"}
},
+ "CostCenter": { "type": ["string", "null"] },
"DueDate": {
"description": "Datetime of expected due date for Order",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"LineItems": {
"description": "Order level line item details",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "./parts/LineItem.json"
- }
- },
- "ModifiedDateTime": {
- "type": [
- "string",
- "null"
- ]
- },
- "OmsCustomerName": {
- "type": [
- "string",
- "null"
- ]
+ "type": ["array", "null"],
+ "items": {"$ref": "./parts/LineItem.json"}
},
+ "ModifiedDateTime": { "type": ["string", "null"] },
+ "OmsCustomerName": { "type": ["string", "null"] },
"OrderFee": {
"description": "Fee applied to Order",
- "type": [
- "number",
- "null"
- ],
+ "type": ["number", "null"],
"format": "double"
},
- "OrderVariables": {
- "$ref": "./parts/OrderVariable.json"
- },
+ "OrderVariables": {"$ref": "./parts/OrderVariable.json"},
"OrderedBys": {
"description": "Array of ordered by addresses",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "./parts/OrderedBy.json"
- }
+ "type": ["array", "null"],
+ "items": {"$ref": "./parts/OrderedBy.json"}
},
"PaymentMethods": {
"description": "Order.ShipTos level payment method details",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "./parts/PaymentMethod.json"
- }
+ "type": ["array", "null"],
+ "items": {"$ref": "./parts/PaymentMethod.json"}
},
"PickPackHandlingFee": {
"description": "Sum of pick & pack handling fees for all Order.ShipTos",
- "type": [
- "number",
- "null"
- ],
+ "type": ["number", "null"],
"format": "double"
},
"ShipTos": {
"description": "Order level ship to details",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "./parts/ShipTo.json"
- }
+ "type": ["array", "null"],
+ "items": {"$ref": "./parts/ShipTo.json"}
},
"ShippingHandlingTax": {
"description": "Sum of shipping & handling taxes for all Order.ShipTos",
- "type": [
- "number",
- "null"
- ],
+ "type": ["number", "null"],
"format": "double"
},
- "Statuses": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
+ "Statuses": { "type": "array", "items": {"type": "string"} },
"TotalOrderFee": {
"description": "Sum of OrderFee",
- "type": [
- "number",
- "null"
- ],
+ "type": ["number", "null"],
"format": "double"
},
"TotalShippingCost": {
"description": "Sum of shipping cost for all Order.ShipTos.Shipments",
- "type": [
- "number",
- "null"
- ],
+ "type": ["number", "null"],
"format": "double"
}
},
- "required": [
- "BillTos",
- "LineItems",
- "OrderId",
- "ShipTos",
- "ShippingHandlingTax"
- ],
+ "required": ["BillTos", "LineItems", "OrderId", "ShipTos", "ShippingHandlingTax"],
"examples": [
{
"OmsCustomerId": "001146",
@@ -215,9 +95,7 @@
"SourceSystemCustomerId": null,
"SourceSystemId": null,
"SourceSystemOrderId": null,
- "AccessGroups": [
- "IN"
- ],
+ "AccessGroups": ["IN"],
"AffiliateIdentifier": 9,
"AffiliateName": "ZT - iHPqWad",
"BillTos": [
@@ -302,9 +180,7 @@
"RushOrder": false,
"ShipTos": null,
"ShippingHandlingTax": null,
- "Statuses": [
- "Order In Process"
- ],
+ "Statuses": ["Order In Process"],
"TotalOrderFee": null,
"TotalShippingCost": null
}
diff --git a/schema/Event/Order/OrderEvent.json b/schema/Event/Order/OrderEvent.json
index 996555c..1a383b1 100644
--- a/schema/Event/Order/OrderEvent.json
+++ b/schema/Event/Order/OrderEvent.json
@@ -4,17 +4,8 @@
"description": "Details for Order JSON schema",
"type": "object",
"allOf": [
- {
- "$ref": "../../Common/EventBase.json"
- },
- {
- "type": "object",
- "properties": {
- "Order": {
- "$ref": "Order.json"
- }
- }
- },
+ {"$ref": "../../Common/EventBase.json"},
+ { "type": "object", "properties": { "Order": {"$ref": "Order.json"} } },
{
"type": "object",
"properties": {
@@ -22,20 +13,11 @@
"description": "Name of triggered event",
"type": "string",
"enum": [
- "Order Accepted By OMS",
- "Order Complete",
- "Order File Copy Complete",
- "Order Item(s) Backordered",
- "Order Item(s) Canceled",
- "Order Item(s) Shipped",
- "Order Received",
- "Order Rejected by OMS",
- "Order Secure Email Sent",
- "Order Submitted to OMS",
- "Order Updated",
- "Order Validated",
- "Order Validation Failed",
- "Partially Shipped"
+ "Order Accepted By OMS", "Order Complete", "Order File Copy Complete",
+ "Order Item(s) Backordered", "Order Item(s) Canceled", "Order Item(s) Shipped",
+ "Order Received", "Order Rejected by OMS", "Order Secure Email Sent",
+ "Order Submitted to OMS", "Order Updated", "Order Validated",
+ "Order Validation Failed", "Partially Shipped"
]
}
}
@@ -45,6 +27,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",
@@ -62,9 +46,7 @@
"SourceSystemCustomerId": null,
"SourceSystemId": null,
"SourceSystemOrderId": null,
- "AccessGroups": [
- "IN"
- ],
+ "AccessGroups": ["IN"],
"AffiliateIdentifier": 9,
"AffiliateName": "ZT - iHPqWad",
"BillTos": [
@@ -149,18 +131,14 @@
"RushOrder": false,
"ShipTos": null,
"ShippingHandlingTax": null,
- "Statuses": [
- "Order In Process"
- ],
+ "Statuses": ["Order In Process"],
"TotalOrderFee": null,
"TotalShippingCost": null
},
"_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
}
]
}
diff --git a/schema/Event/Order/parts/AdditionalProperty.json b/schema/Event/Order/parts/AdditionalProperty.json
index 1ef0dbf..a33efb2 100644
--- a/schema/Event/Order/parts/AdditionalProperty.json
+++ b/schema/Event/Order/parts/AdditionalProperty.json
@@ -6,28 +6,12 @@
"properties": {
"IsDeleted": {
"description": "Flag to indicate the property has been removed from the line item.",
- "type": [
- "boolean",
- "null"
- ]
+ "type": ["boolean", "null"]
},
- "Key": {
- "type": [
- "string",
- "null"
- ]
- },
- "Value": {
- "type": [
- "string",
- "null"
- ]
- }
+ "Key": { "type": ["string", "null"] },
+ "Value": { "type": ["string", "null"] }
},
- "required": [
- "Key",
- "Value"
- ],
+ "required": ["Key", "Value"],
"examples": [
{
"Key": "SingleMailing_File",
diff --git a/schema/Event/Order/parts/BillTo.json b/schema/Event/Order/parts/BillTo.json
index 0a370a7..24056e0 100644
--- a/schema/Event/Order/parts/BillTo.json
+++ b/schema/Event/Order/parts/BillTo.json
@@ -4,104 +4,31 @@
"description": "Bill to address object for Order",
"type": "object",
"properties": {
- "Address1": {
- "description": "Address line 1 for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Address2": {
- "description": "Address line 2 for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Address3": {
- "description": "Address line 3 for address",
- "type": [
- "string",
- "null"
- ]
- },
- "City": {
- "description": "City name for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Company": {
- "description": "Company name for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Country": {
- "description": "Country name for address",
- "type": [
- "string",
- "null"
- ]
- },
+ "Address1": { "description": "Address line 1 for address", "type": ["string", "null"] },
+ "Address2": { "description": "Address line 2 for address", "type": ["string", "null"] },
+ "Address3": { "description": "Address line 3 for address", "type": ["string", "null"] },
+ "City": { "description": "City name for address", "type": ["string", "null"] },
+ "Company": { "description": "Company name for address", "type": ["string", "null"] },
+ "Country": { "description": "Country name for address", "type": ["string", "null"] },
"EmailAddress": {
"description": "Contact email address for address",
- "type": [
- "string",
- "null"
- ]
- },
- "FaxNumber": {
- "description": "Fax number for address",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
+ "FaxNumber": { "description": "Fax number for address", "type": ["string", "null"] },
"Key": {
"description": "Unique ID for individual contact",
"type": "integer",
"format": "int32"
},
- "Name": {
- "description": "Contact name for this address",
- "type": [
- "string",
- "null"
- ]
- },
- "PhoneNumber": {
- "description": "Phone number for address",
- "type": [
- "string",
- "null"
- ]
- },
- "PostalCode": {
- "description": "Postal code for address",
- "type": [
- "string",
- "null"
- ]
- },
+ "Name": { "description": "Contact name for this address", "type": ["string", "null"] },
+ "PhoneNumber": { "description": "Phone number for address", "type": ["string", "null"] },
+ "PostalCode": { "description": "Postal code for address", "type": ["string", "null"] },
"StateProvince": {
"description": "State or province name for address",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
}
},
- "required": [
- "Address1",
- "City",
- "Country",
- "Name",
- "PostalCode",
- "StateProvince"
- ],
+ "required": ["Address1", "City", "Country", "Name", "PostalCode", "StateProvince"],
"examples": [
{
"Address1": "106 Tyler Street Suite 175",
diff --git a/schema/Event/Order/parts/Component.json b/schema/Event/Order/parts/Component.json
index 7c2edd7..7095f1b 100644
--- a/schema/Event/Order/parts/Component.json
+++ b/schema/Event/Order/parts/Component.json
@@ -6,99 +6,46 @@
"properties": {
"ProductId": {
"description": "Unique ID for component product within Integration Broker",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"AssociatedFileName": {
"description": "Name of file associated to component product (if applicable)",
- "type": [
- "string",
- "null"
- ]
- },
- "Color": {
- "description": "Color of component product",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
+ "Color": { "description": "Color of component product", "type": ["string", "null"] },
"Comment": {
"description": "Manually entered comment for component product",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"ComponentLineNumber": {
"description": "Unique ID for component product within parent product",
- "type": [
- "string",
- "null"
- ]
- },
- "OfferLineNumber": {
- "description": "Unique ID for parent line item",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
+ "OfferLineNumber": { "description": "Unique ID for parent line item", "type": ["string", "null"] },
"ProductDescription": {
"description": "Description for component product within product management system (system where ordered line item products will be managed)",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"ProductLineNumber": {
"description": "Unique ID for parent product within parent line item",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"ProductNumber": {
"description": "Name for component product within product management system (system where ordered line item products will be managed)",
- "type": [
- "string",
- "null"
- ]
- },
- "ProductOwner": {
- "description": "Owner of component product",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
+ "ProductOwner": { "description": "Owner of component product", "type": ["string", "null"] },
"QuantityBackordered": {
"description": "Amount of component product back-ordered within parent product",
- "type": [
- "integer",
- "null"
- ],
+ "type": ["integer", "null"],
"format": "int32"
},
"QuantityOrdered": {
"description": "Amount of component product ordered within parent product",
- "type": [
- "integer",
- "null"
- ],
+ "type": ["integer", "null"],
"format": "int32"
},
- "Size": {
- "description": "Size of component product",
- "type": [
- "string",
- "null"
- ]
- }
+ "Size": { "description": "Size of component product", "type": ["string", "null"] }
},
- "required": [
- "ProductId"
- ]
+ "required": ["ProductId"]
}
diff --git a/schema/Event/Order/parts/LineItem.json b/schema/Event/Order/parts/LineItem.json
index ed3f575..642d222 100644
--- a/schema/Event/Order/parts/LineItem.json
+++ b/schema/Event/Order/parts/LineItem.json
@@ -6,188 +6,98 @@
"properties": {
"OfferId": {
"description": "Unique ID for offer within Integration Broker",
- "type": [
- "string",
- "null"
- ]
- },
- "ProductManagementSystemCustomerId": {
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
+ "ProductManagementSystemCustomerId": { "type": ["string", "null"] },
"ProductManagementSystemId": {
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "ProductManagementSystemId.json",
"description": "Identifier for a product management system that can be an integer, string, or null",
- "type": [
- "integer",
- "string",
- "null"
- ]
- },
- "ReferenceId": {
- "type": [
- "string",
- "null"
- ]
+ "type": ["integer", "string", "null"]
},
+ "ReferenceId": { "type": ["string", "null"] },
"VariableTemplatePrintId": {
"description": "Unique ID for variable template file associated to offer on individual line item",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"AdditionalProperties": {
"description": "Additional properties details for Order LineItems",
"type": "array",
- "items": {
- "$ref": "AdditionalProperty.json"
- }
+ "items": {"$ref": "AdditionalProperty.json"}
},
"BillToKey": {
"description": "Unique ID for Order.BillTos.Key property associated to individual line item (NOTE: If top-level DefaultBillToKey is not set, this must be.)",
- "type": [
- "integer",
- "null"
- ],
+ "type": ["integer", "null"],
"format": "int32"
},
"Comment": {
"description": "Manually entered comment for individual line item",
- "type": [
- "string",
- "null"
- ]
- },
- "CostCenter": {
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
+ "CostCenter": { "type": ["string", "null"] },
"DueDate": {
"description": "Datetime of expected due date for individual line item",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"LineItemFee": {
"description": "Fee applied to individual line item",
- "type": [
- "number",
- "null"
- ],
+ "type": ["number", "null"],
"format": "double"
},
"OfferDescription": {
"description": "Description for offer within product management system (system where ordered line item products will be managed)",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"OfferLineNumber": {
"description": "Unique ID for individual line item",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"OfferNumber": {
"description": "Name for offer within product management system (system where ordered line item products will be managed)",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"OrderedByKey": {
"description": "Unique ID for Order.OrderedBy.Key property associated to individual line item",
- "type": [
- "integer",
- "null"
- ],
+ "type": ["integer", "null"],
"format": "int32"
},
"PONumber": {
"description": "Purchase order number for individual line item",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"Price": {
"description": "Total offer price of individual line item",
- "type": [
- "number",
- "null"
- ],
+ "type": ["number", "null"],
"format": "double"
},
"Products": {
"description": "Order.LineItems level product details",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "Product.json"
- }
- },
- "QuantityCanceled": {
- "type": [
- "integer",
- "null"
- ]
+ "type": ["array", "null"],
+ "items": {"$ref": "Product.json"}
},
+ "QuantityCanceled": { "type": ["integer", "null"] },
"QuantityOrdered": {
"description": "Amount of offer ordered for individual line item",
- "type": [
- "integer",
- "null"
- ],
+ "type": ["integer", "null"],
"format": "int32"
},
"RushOrder": {
"description": "True/false indicator if individual line item is expedited",
- "type": [
- "boolean",
- "null"
- ]
+ "type": ["boolean", "null"]
},
"ShipToKey": {
"description": "Unique ID for Order.ShipTos.Key property associated to individual line item (NOTE: If top-level DefaultShipToKey is not set, this must be.)",
- "type": [
- "integer",
- "null"
- ],
+ "type": ["integer", "null"],
"format": "int32"
},
- "Status": {
- "type": [
- "string",
- "null"
- ]
- },
+ "Status": { "type": ["string", "null"] },
"TaxAmount": {
"description": "Total tax amount applied to individual line item",
- "type": [
- "number",
- "null"
- ],
+ "type": ["number", "null"],
"format": "double"
}
},
- "required": [
- "LineItemFee",
- "OfferId",
- "Price",
- "QuantityOrdered",
- "TaxAmount"
- ],
+ "required": ["LineItemFee", "OfferId", "Price", "QuantityOrdered", "TaxAmount"],
"examples": [
{
"OfferId": "8-998608-269",
diff --git a/schema/Event/Order/parts/OrderVariable.json b/schema/Event/Order/parts/OrderVariable.json
index d7ffc98..034800b 100644
--- a/schema/Event/Order/parts/OrderVariable.json
+++ b/schema/Event/Order/parts/OrderVariable.json
@@ -2,9 +2,6 @@
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "OrderVariable.json",
"description": "Manually entered variables for order within order management system (system where order lifecycle will be managed in)",
- "type": [
- "object",
- "null"
- ],
+ "type": ["object", "null"],
"additionalProperties": true
}
diff --git a/schema/Event/Order/parts/OrderedBy.json b/schema/Event/Order/parts/OrderedBy.json
index 4de17c5..8800822 100644
--- a/schema/Event/Order/parts/OrderedBy.json
+++ b/schema/Event/Order/parts/OrderedBy.json
@@ -4,96 +4,30 @@
"description": "Bill to address object for Order",
"type": "object",
"properties": {
- "Address1": {
- "description": "Address line 1 for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Address2": {
- "description": "Address line 2 for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Address3": {
- "description": "Address line 3 for address",
- "type": [
- "string",
- "null"
- ]
- },
- "City": {
- "description": "City name for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Company": {
- "description": "Company name for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Country": {
- "description": "Country name for address",
- "type": [
- "string",
- "null"
- ]
- },
+ "Address1": { "description": "Address line 1 for address", "type": ["string", "null"] },
+ "Address2": { "description": "Address line 2 for address", "type": ["string", "null"] },
+ "Address3": { "description": "Address line 3 for address", "type": ["string", "null"] },
+ "City": { "description": "City name for address", "type": ["string", "null"] },
+ "Company": { "description": "Company name for address", "type": ["string", "null"] },
+ "Country": { "description": "Country name for address", "type": ["string", "null"] },
"EmailAddress": {
"description": "Contact email address for address",
- "type": [
- "string",
- "null"
- ]
- },
- "FaxNumber": {
- "description": "Fax number for address",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
+ "FaxNumber": { "description": "Fax number for address", "type": ["string", "null"] },
"Key": {
"description": "Unique ID for individual contact",
"type": "integer",
"format": "int32"
},
- "PhoneNumber": {
- "description": "Phone number for address",
- "type": [
- "string",
- "null"
- ]
- },
- "PostalCode": {
- "description": "Postal code for address",
- "type": [
- "string",
- "null"
- ]
- },
+ "PhoneNumber": { "description": "Phone number for address", "type": ["string", "null"] },
+ "PostalCode": { "description": "Postal code for address", "type": ["string", "null"] },
"StateProvince": {
"description": "State or province name for address",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
}
},
- "required": [
- "Address1",
- "City",
- "Country",
- "PostalCode",
- "StateProvince"
- ],
+ "required": ["Address1", "City", "Country", "PostalCode", "StateProvince"],
"examples": [
{
"Address1": "106 Tyler Street Suite 175",
diff --git a/schema/Event/Order/parts/PaymentMethod.json b/schema/Event/Order/parts/PaymentMethod.json
index 2ee7f62..df203a1 100644
--- a/schema/Event/Order/parts/PaymentMethod.json
+++ b/schema/Event/Order/parts/PaymentMethod.json
@@ -5,22 +5,10 @@
"properties": {
"Amount": {
"description": "Total amount applied to payment method",
- "type": [
- "number",
- "null"
- ],
+ "type": ["number", "null"],
"format": "double"
},
- "MethodName": {
- "description": "Name of payment method",
- "type": [
- "string",
- "null"
- ]
- }
+ "MethodName": { "description": "Name of payment method", "type": ["string", "null"] }
},
- "required": [
- "Amount",
- "MethodName"
- ]
+ "required": ["Amount", "MethodName"]
}
diff --git a/schema/Event/Order/parts/Product.json b/schema/Event/Order/parts/Product.json
index 16a8f8b..9f5a692 100644
--- a/schema/Event/Order/parts/Product.json
+++ b/schema/Event/Order/parts/Product.json
@@ -4,116 +4,49 @@
"description": "Order.LineItems level product details",
"type": "object",
"properties": {
- "FulfillmentSystemCustomerId": {
- "type": [
- "string",
- "null"
- ]
- },
- "FulfillmentSystemId": {
- "type": [
- "integer",
- "null"
- ]
- },
+ "FulfillmentSystemCustomerId": { "type": ["string", "null"] },
+ "FulfillmentSystemId": { "type": ["integer", "null"] },
"ProductId": {
"description": "Unique ID for product within Integration Broker",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"AssociatedFileName": {
"description": "Name of file associated to product (if applicable)",
- "type": [
- "string",
- "null"
- ]
- },
- "Color": {
- "description": "Color of product",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
+ "Color": { "description": "Color of product", "type": ["string", "null"] },
"Comment": {
"description": "Manually entered comment for product",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"Components": {
"description": "Components array for Order LineItems Products",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "Component.json"
- }
- },
- "OfferLineNumber": {
- "description": "Unique ID for parent line item",
- "type": [
- "string",
- "null"
- ]
+ "type": ["array", "null"],
+ "items": {"$ref": "Component.json"}
},
+ "OfferLineNumber": { "description": "Unique ID for parent line item", "type": ["string", "null"] },
"ProductDescription": {
"description": "Description for product within product management system (system where ordered line item products will be managed)",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"ProductLineNumber": {
"description": "Unique ID for product within parent line item",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"ProductNumber": {
"description": "Name for product within product management system (system where ordered line item products will be managed)",
- "type": [
- "string",
- "null"
- ]
- },
- "ProductOwner": {
- "description": "Owner of product",
- "type": [
- "string",
- "null"
- ]
- },
- "QuantityBackordered": {
- "type": [
- "integer",
- "null"
- ]
+ "type": ["string", "null"]
},
+ "ProductOwner": { "description": "Owner of product", "type": ["string", "null"] },
+ "QuantityBackordered": { "type": ["integer", "null"] },
"QuantityOrdered": {
"description": "Amount of product ordered within parent line item",
- "type": [
- "integer",
- "null"
- ],
+ "type": ["integer", "null"],
"format": "int32"
},
- "Size": {
- "description": "Size of product",
- "type": [
- "string",
- "null"
- ]
- }
+ "Size": { "description": "Size of product", "type": ["string", "null"] }
},
- "required": [
- "ProductId"
- ],
+ "required": ["ProductId"],
"examples": [
{
"FulfillmentSystemCustomerId": 16936,
diff --git a/schema/Event/Order/parts/ShipTo.json b/schema/Event/Order/parts/ShipTo.json
index af804cc..30b47f9 100644
--- a/schema/Event/Order/parts/ShipTo.json
+++ b/schema/Event/Order/parts/ShipTo.json
@@ -6,71 +6,35 @@
"properties": {
"AffiliateId": {
"description": "Unique ID for affiliate within source system (system where order was originally placed)",
- "type": [
- "string",
- "null"
- ]
- },
- "OmsShippingMethodId": {
- "type": [
- "string",
- "null"
- ]
- },
- "ReferenceId": {
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
+ "OmsShippingMethodId": { "type": ["string", "null"] },
+ "ReferenceId": { "type": ["string", "null"] },
"SourceSystemShippingMethodId": {
"description": "Unique ID for shipping method within source system (system where order was originally placed)",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"AffiliateName": {
"description": "Name for affiliate within source system (system where order was originally placed)",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"Comment": {
"description": "Manually entered comment for individual Order.ShipTos",
- "type": [
- "string",
- "null"
- ]
- },
- "CostCenter": {
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
+ "CostCenter": { "type": ["string", "null"] },
"CreditCardFee": {
"description": "Credit card transaction fee applied for individual Order.ShipTos",
- "type": [
- "number",
- "null"
- ],
+ "type": ["number", "null"],
"format": "double"
},
"DueDate": {
"description": "Datetime of expected due date for individual Order.ShipTos",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"IsDeleted": {
"description": "Flag to indicate the property has been removed from the line item.",
- "type": [
- "boolean",
- "null"
- ]
+ "type": ["boolean", "null"]
},
"Key": {
"description": "Unique ID for individual ship to",
@@ -79,95 +43,49 @@
},
"OrderFee": {
"description": "Fee applied to Order",
- "type": [
- "number",
- "null"
- ],
+ "type": ["number", "null"],
"format": "double"
},
"PONumber": {
"description": "Purchase order number for individual Order.ShipTos",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
"PaymentMethods": {
"description": "Order.ShipTos level payment method details",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "PaymentMethod.json"
- }
+ "type": ["array", "null"],
+ "items": {"$ref": "PaymentMethod.json"}
},
"PickPackHandlingFee": {
"description": "Pick & pack handling fees for individual Order.ShipTos",
- "type": [
- "number",
- "null"
- ],
+ "type": ["number", "null"],
"format": "double"
},
"RushOrder": {
"description": "True/false indicator if individual Order.ShipTos is expedited",
- "type": [
- "boolean",
- "null"
- ]
- },
- "ShipToAddress": {
- "$ref": "ShipToAddress.json"
- },
- "ShippingCarrier": {
- "type": [
- "string",
- "null"
- ]
+ "type": ["boolean", "null"]
},
+ "ShipToAddress": {"$ref": "ShipToAddress.json"},
+ "ShippingCarrier": { "type": ["string", "null"] },
"ShippingCost": {
"description": "Shipping cost for individual Order.ShipTos",
- "type": [
- "number",
- "null"
- ],
+ "type": ["number", "null"],
"format": "double"
},
"ShippingHandlingTax": {
"description": "Shipping & handling taxes for individual Order.ShipTos",
- "type": [
- "number",
- "null"
- ],
+ "type": ["number", "null"],
"format": "double"
},
- "ShippingService": {
- "type": [
- "string",
- "null"
- ]
- },
- "Status": {
- "type": [
- "string",
- "null"
- ]
- },
+ "ShippingService": { "type": ["string", "null"] },
+ "Status": { "type": ["string", "null"] },
"TotalOrderFee": {
"description": "Sum of OrderFee",
- "type": [
- "number",
- "null"
- ],
+ "type": ["number", "null"],
"format": "double"
}
},
"required": [
- "Key",
- "ShipToAddress",
- "ShippingCost",
- "ShippingHandlingTax",
+ "Key", "ShipToAddress", "ShippingCost", "ShippingHandlingTax",
"SourceSystemShippingMethodId"
],
"examples": [
diff --git a/schema/Event/Order/parts/ShipToAddress.json b/schema/Event/Order/parts/ShipToAddress.json
index 269b0ca..f7be28b 100644
--- a/schema/Event/Order/parts/ShipToAddress.json
+++ b/schema/Event/Order/parts/ShipToAddress.json
@@ -4,96 +4,30 @@
"description": "Ship to addresses array for Order",
"type": "object",
"properties": {
- "Address1": {
- "description": "Address line 1 for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Address2": {
- "description": "Address line 2 for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Address3": {
- "description": "Address line 3 for address",
- "type": [
- "string",
- "null"
- ]
- },
- "City": {
- "description": "City name for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Company": {
- "description": "Company name for address",
- "type": [
- "string",
- "null"
- ]
- },
- "Country": {
- "description": "Country name for address",
- "type": [
- "string",
- "null"
- ]
- },
+ "Address1": { "description": "Address line 1 for address", "type": ["string", "null"] },
+ "Address2": { "description": "Address line 2 for address", "type": ["string", "null"] },
+ "Address3": { "description": "Address line 3 for address", "type": ["string", "null"] },
+ "City": { "description": "City name for address", "type": ["string", "null"] },
+ "Company": { "description": "Company name for address", "type": ["string", "null"] },
+ "Country": { "description": "Country name for address", "type": ["string", "null"] },
"EmailAddress": {
"description": "Contact email address for address",
- "type": [
- "string",
- "null"
- ]
- },
- "FaxNumber": {
- "description": "Fax number for address",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
},
+ "FaxNumber": { "description": "Fax number for address", "type": ["string", "null"] },
"Key": {
"description": "Unique ID for individual contact",
"type": "integer",
"format": "int32"
},
- "PhoneNumber": {
- "description": "Phone number for address",
- "type": [
- "string",
- "null"
- ]
- },
- "PostalCode": {
- "description": "Postal code for address",
- "type": [
- "string",
- "null"
- ]
- },
+ "PhoneNumber": { "description": "Phone number for address", "type": ["string", "null"] },
+ "PostalCode": { "description": "Postal code for address", "type": ["string", "null"] },
"StateProvince": {
"description": "State or province name for address",
- "type": [
- "string",
- "null"
- ]
+ "type": ["string", "null"]
}
},
- "required": [
- "Address1",
- "City",
- "Country",
- "PostalCode",
- "StateProvince"
- ],
+ "required": ["Address1", "City", "Country", "PostalCode", "StateProvince"],
"examples": [
{
"Address1": "106 Tyler Street Suite 175",