Schema Changes - 2025-10-16
This document contains the changes to the schema files compared to the main branch.
Changes
diff --git a/schema/Api/CustomerBroker/CreateCustomerRequest.json b/schema/Api/CustomerBroker/CreateCustomerRequest.json
index 266ac8e..5e47bb5 100644
--- a/schema/Api/CustomerBroker/CreateCustomerRequest.json
+++ b/schema/Api/CustomerBroker/CreateCustomerRequest.json
@@ -10,17 +10,41 @@
"type": "string",
"minLength": 1
},
+ "xmlSenderId": {
+ "description": "Optional. XML sender identifier.",
+ "type": ["string", "null"]
+ },
+ "billToCodeRequiredOnOrder": {
+ "description": "Required. Indicates whether BillTo code is required on order placement.",
+ "type": "boolean"
+ },
"billingEntities": {
"type": ["array", "null"],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
- "id" : { "type": ["string", "null"] },
- "xmlSenderId" : { "type": ["string", "null"] },
- "isDefaultForCustomer": { "type": ["boolean", "null"] }
+ "id": {"description": "Required. Billing entity identifier.", "type": "string"},
+ "xmlSenderId": { "description": "Optional. XmlSenderId override.", "type": ["string", "null"] },
+ "addresses": {
+ "description": "Required. Child addresses.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "xmlSenderId": { "description": "Optional. XmlSenderId." , "type": ["string", "null"] },
+ "code" : { "description": "Required. Code for the address.", "type": "string" }
+ },
+ "required": ["code"]
+ }
+ },
+ "isDefaultForCustomer": {
+ "description": "Required. Indicates whether this is the default billing entity for the customer.",
+ "type": "boolean"
+ }
},
- "required": ["id", "xmlSenderId", "isDefaultForCustomer"]
+ "required": ["id", "isDefaultForCustomer", "addresses"]
}
},
"brokerScopes": { "type": "array", "items": {"type": "string"} },
@@ -30,27 +54,27 @@
"properties": {
"address1": {
"description": "Required if contactAddress is present. Address line 1. Must not be empty.",
- "type": ["string", "null"]
+ "type": "string"
},
"address2": { "description": "Optional. Address line 2.", "type": ["string", "null"] },
"address3": { "description": "Optional. Address line 3.", "type": ["string", "null"] },
"city": {
"description": "Required if contactAddress is present. City. Must not be empty.",
- "type": ["string", "null"]
+ "type": "string"
},
"company": { "description": "Optional. Company name.", "type": ["string", "null"] },
"country": {
"description": "Required if contactAddress is present. Country. Must not be empty.",
- "type": ["string", "null"]
+ "type": "string"
},
"faxNumber": { "description": "Optional. Fax number.", "type": ["string", "null"] },
"name": { "description": "Optional. Contact name.", "type": ["string", "null"] },
"phoneNumber": { "description": "Optional. Phone number.", "type": ["string", "null"] },
"postalCode": {
"description": "Required if contactAddress is present. Postal code. Must not be empty.",
- "type": ["string", "null"]
+ "type": "string"
},
- "stateProvince": { "description": "Required. State or province.", "type": ["string", "null"] }
+ "stateProvince": {"description": "Required. State or province.", "type": "string"}
},
"required": ["address1", "city", "country", "postalCode", "stateProvince"]
},
@@ -63,16 +87,28 @@
"description": "Optional. Creation date/time in UTC. Must not be in the future if provided.",
"type": ["string", "null"]
},
+ "doValidateOrderPrice": {
+ "description": "Required. Indicates whether order price validation is performed on order placement for the Sales Order.",
+ "type": "boolean"
+ },
"emailNotificationSubscriptions": {
"description": "Optional. List of email notification subscriptions.",
- "type": "array",
+ "type": ["array", "null"],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
- "emailNotificationTemplateId": { "type": "string" },
- "emailAddresses" : { "type": "array" , "items": {"type": "string"} }
- }
+ "emailNotificationTemplateId": {
+ "description": "Required. Email notification template identifier.",
+ "type": "string"
+ },
+ "emailAddresses": {
+ "description": "Required. Array of email addresses.",
+ "type": "array",
+ "items": {"type": "string"}
+ }
+ },
+ "required": ["emailNotificationTemplateId", "emailAddresses"]
}
},
"invoiceEmailAddress": {
@@ -108,25 +144,40 @@
"salesRep": { "description": "Optional. Sales representative.", "type": ["string", "null"] },
"shipMethodMappings": {
"description": "Optional. Ship method mappings for the customer.",
- "type": "array",
+ "type": ["array", "null"],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
- "ratesProviderShipMethodId": {"type": "string"},
- "sourceSystemShipMethodId": {"type": "string"},
+ "ratesProviderShipMethodId": {
+ "description": "Required. Rates provider ship method identifier.",
+ "type": "string"
+ },
+ "sourceSystemShipMethodId": {
+ "description": "Required. Source system ship method identifier.",
+ "type": "string"
+ },
"fulfillmentSystemShipMethods": {
+ "description": "Required. Fulfillment system ship methods.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
- "fulfillmentSystemId" : { "type": "integer", "format": "int64" },
- "fulfillmentSystemShipMethodId": { "type": "string" }
+ "fulfillmentSystemId": {
+ "description": "Required. Fulfillment system identifier.",
+ "type": "integer",
+ "format": "int64"
+ },
+ "fulfillmentSystemShipMethodId": {
+ "description": "Required. Fulfillment system ship method identifier.",
+ "type": "string"
+ }
},
"required": ["fulfillmentSystemId", "fulfillmentSystemShipMethodId"]
}
- }
+ },
+ "trackingUrl": { "description": "Optional. Tracking URL.", "type": ["string", "null"] }
},
"required": [
"fulfillmentSystemShipMethods", "ratesProviderShipMethodId",
@@ -135,7 +186,8 @@
}
},
"sourceSystems": {
- "type": "array",
+ "description": "Optional. Source systems for the customer.",
+ "type": ["array", "null"],
"items": {
"type": "object",
"additionalProperties": false,
@@ -156,5 +208,5 @@
"subsidiary": { "description": "Optional. Subsidiary name.", "type": ["string", "null"] },
"website": { "description": "Optional. Website URL.", "type": ["string", "null"] }
},
- "required": ["billingEntities", "id", "name"]
+ "required": ["id", "name", "doValidateOrderPrice", "billToCodeRequiredOnOrder"]
}
diff --git a/schema/Api/CustomerBroker/GetCustomerResponse.json b/schema/Api/CustomerBroker/GetCustomerResponse.json
index 889f6dd..8a9b595 100644
--- a/schema/Api/CustomerBroker/GetCustomerResponse.json
+++ b/schema/Api/CustomerBroker/GetCustomerResponse.json
@@ -14,17 +14,61 @@
"type": ["string", "null"],
"minLength": 1
},
+ "xmlSenderId": {
+ "description": "Optional. XML sender identifier.",
+ "type": ["string", "null"]
+ },
+ "billToCodeRequiredOnOrder": {
+ "description": "Required. Indicates whether BillTo code is required on order placement.",
+ "type": "boolean"
+ },
"billingEntities": {
"type": ["array", "null"],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
- "id" : { "type": ["string", "null"] },
- "xmlSenderId" : { "type": ["string", "null"] },
- "isDefaultForCustomer": { "type": ["boolean", "null"] }
+ "id": {"description": "Required. Billing entity identifier.", "type": "string"},
+ "xmlSenderId": { "description": "Optional. XmlSenderId override.", "type": ["string", "null"] },
+ "addresses": {
+ "description": "Required. Addresses linked to this billing entity.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "xmlSenderId": { "description": "Optional. XmlSenderId.", "type": ["string", "null"] },
+ "address1": { "description": "Optional. Address line 1.", "type": ["string", "null"] },
+ "address2": { "description": "Optional. Address line 2.", "type": ["string", "null"] },
+ "address3": { "description": "Optional. Address line 3.", "type": ["string", "null"] },
+ "city": { "description": "Optional. City.", "type": ["string", "null"] },
+ "code": {"description": "Required. Code for the address.", "type": "string"},
+ "company": { "description": "Optional. Company name.", "type": ["string", "null"] },
+ "country": { "description": "Optional. Country.", "type": ["string", "null"] },
+ "emailAddress": { "description": "Optional. Email address.", "type": ["string", "null"] },
+ "faxNumber": { "description": "Optional. Fax number.", "type": ["string", "null"] },
+ "isBillToDefault": {
+ "description": "Optional. Indicates whether this is the default bill-to address.",
+ "type": ["boolean", "null"]
+ },
+ "isShipToDefault": {
+ "description": "Optional. Indicates whether this is the default ship-to address.",
+ "type": ["boolean", "null"]
+ },
+ "name": { "description": "Optional. Address name.", "type": ["string", "null"] },
+ "phoneNumber": { "description": "Optional. Phone number.", "type": ["string", "null"] },
+ "postalCode": { "description": "Optional. Postal code.", "type": ["string", "null"] },
+ "stateProvince": { "description": "Optional. State or province.", "type": ["string", "null"] }
+ },
+ "required": ["code"]
+ }
+ },
+ "isDefaultForCustomer": {
+ "description": "Required. Indicates whether this is the default billing entity for the customer.",
+ "type": "boolean"
+ }
},
- "required": ["id", "xmlSenderId", "isDefaultForCustomer"]
+ "required": ["id", "isDefaultForCustomer", "addresses"]
}
},
"brokerScopes": { "type": "array", "items": {"type": "string"} },
@@ -34,27 +78,27 @@
"properties": {
"address1": {
"description": "Required if contactAddress is present. Address line 1. Must not be empty.",
- "type": ["string", "null"]
+ "type": "string"
},
"address2": { "description": "Optional. Address line 2.", "type": ["string", "null"] },
"address3": { "description": "Optional. Address line 3.", "type": ["string", "null"] },
"city": {
"description": "Required if contactAddress is present. City. Must not be empty.",
- "type": ["string", "null"]
+ "type": "string"
},
"company": { "description": "Optional. Company name.", "type": ["string", "null"] },
"country": {
"description": "Required if contactAddress is present. Country. Must not be empty.",
- "type": ["string", "null"]
+ "type": "string"
},
"faxNumber": { "description": "Optional. Fax number.", "type": ["string", "null"] },
"name": { "description": "Optional. Contact name.", "type": ["string", "null"] },
"phoneNumber": { "description": "Optional. Phone number.", "type": ["string", "null"] },
"postalCode": {
"description": "Required if contactAddress is present. Postal code. Must not be empty.",
- "type": ["string", "null"]
+ "type": "string"
},
- "stateProvince": { "description": "Required. State or province.", "type": ["string", "null"] }
+ "stateProvince": {"description": "Required. State or province.", "type": "string"}
},
"required": ["address1", "city", "country", "postalCode", "stateProvince"]
},
@@ -63,15 +107,28 @@
"type": ["string", "null"],
"format": "email"
},
+ "doValidateOrderPrice": {
+ "description": "Required. Indicates whether order price validation is performed on order placement for the Sales Order.",
+ "type": "boolean"
+ },
"emailNotificationSubscriptions": {
- "type": "array",
+ "description": "Optional. List of email notification subscriptions.",
+ "type": ["array", "null"],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
- "emailNotificationTemplateId": { "type": "string" },
- "emailAddresses" : { "type": "array" , "items": {"type": "string"} }
- }
+ "emailNotificationTemplateId": {
+ "description": "Required. Email notification template identifier.",
+ "type": "string"
+ },
+ "emailAddresses": {
+ "description": "Required. Array of email addresses.",
+ "type": "array",
+ "items": {"type": "string"}
+ }
+ },
+ "required": ["emailNotificationTemplateId", "emailAddresses"]
}
},
"invoiceEmailAddress": {
@@ -107,31 +164,43 @@
"salesRep": { "description": "Optional. Sales representative.", "type": ["string", "null"] },
"shipMethodMappings": {
"description": "Optional. Ship method mappings for the customer.",
- "type": "array",
+ "type": ["array", "null"],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
- "ratesProviderShipMethodId": {"description": "Rates provider ship method identifier.", "type": "string"},
- "sourceSystemShipMethodId": {"description": "Source system ship method identifier.", "type": "string"},
+ "ratesProviderShipMethodId": {
+ "description": "Required. Rates provider ship method identifier.",
+ "type": "string"
+ },
+ "sourceSystemShipMethodId": {
+ "description": "Required. Source system ship method identifier.",
+ "type": "string"
+ },
"fulfillmentSystemShipMethods": {
- "description": "Fulfillment system ship methods.",
+ "description": "Required. Fulfillment system ship methods.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"fulfillmentSystemId": {
- "description": "Fulfillment system identifier.",
+ "description": "Required. Fulfillment system identifier.",
"type": "integer",
"format": "int64"
},
- "fulfillmentSystemShipMethodId": {"description": "Fulfillment system ship method identifier.", "type": "string"},
- "fulfillmentSystemName": {"description": "Fulfillment system name.", "type": "string"}
+ "fulfillmentSystemShipMethodId": {
+ "description": "Required. Fulfillment system ship method identifier.",
+ "type": "string"
+ },
+ "fulfillmentSystemName": {"description": "Required. Fulfillment system name.", "type": "string"}
},
- "required": ["fulfillmentSystemId", "fulfillmentSystemShipMethodId"]
+ "required": [
+ "fulfillmentSystemId", "fulfillmentSystemShipMethodId", "fulfillmentSystemName"
+ ]
}
- }
+ },
+ "trackingUrl": { "description": "Optional. Tracking URL.", "type": ["string", "null"] }
},
"required": [
"fulfillmentSystemShipMethods", "ratesProviderShipMethodId",
@@ -140,29 +209,30 @@
}
},
"sourceSystems": {
- "type": "array",
+ "description": "Optional. Source systems for the customer.",
+ "type": ["array", "null"],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"authClientId": {
- "description": "Authentication client identifier.",
+ "description": "Optional. Authentication client identifier.",
"type": ["string", "null"]
},
"id": {
- "description": "Source system identifier.",
+ "description": "Required. Source system identifier.",
"type": "integer",
"format": "int64"
},
"sourceSystemCustomerId": {
- "description": "Source system customer identifier.",
+ "description": "Optional. Source system customer identifier.",
"type": ["string", "null"]
},
"clientSecret": {
- "description": "Client secret for authentication.",
+ "description": "Optional. Client secret for authentication.",
"type": ["string", "null"]
},
- "name": { "description": "Source system name.", "type": ["string", "null"] }
+ "name": { "description": "Optional. Source system name.", "type": ["string", "null"] }
},
"required": ["id"]
}
diff --git a/schema/Api/CustomerBroker/GetCustomersResponse.json b/schema/Api/CustomerBroker/GetCustomersResponse.json
index 78e5752..2b64538 100644
--- a/schema/Api/CustomerBroker/GetCustomersResponse.json
+++ b/schema/Api/CustomerBroker/GetCustomersResponse.json
@@ -5,14 +5,21 @@
"additionalProperties": false,
"properties": {
"data": {
+ "description": "Optional. Array of customer data objects.",
"type": ["array", "null"],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
- "id" : { "type": ["string", "null"] },
- "parentId": { "type": ["string", "null"] },
- "name" : { "type": ["string", "null"] }
+ "id": {
+ "description": "Optional. Unique customer identifier.",
+ "type": ["string", "null"]
+ },
+ "parentId": {
+ "description": "Optional. Parent customer identifier.",
+ "type": ["string", "null"]
+ },
+ "name": { "description": "Optional. Customer name.", "type": ["string", "null"] }
}
}
},
diff --git a/schema/Api/CustomerBroker/UpdateCustomerRequest.json b/schema/Api/CustomerBroker/UpdateCustomerRequest.json
index 57e6261..5c0da62 100644
--- a/schema/Api/CustomerBroker/UpdateCustomerRequest.json
+++ b/schema/Api/CustomerBroker/UpdateCustomerRequest.json
@@ -10,17 +10,41 @@
"type": "string",
"minLength": 1
},
+ "xmlSenderId": {
+ "description": "Optional. XML sender identifier.",
+ "type": ["string", "null"]
+ },
+ "billToCodeRequiredOnOrder": {
+ "description": "Required. Indicates whether BillTo code is required on order placement.",
+ "type": "boolean"
+ },
"billingEntities": {
"type": ["array", "null"],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
- "id" : { "type": ["string", "null"] },
- "xmlSenderId" : { "type": ["string", "null"] },
- "isDefaultForCustomer": { "type": ["boolean", "null"] }
+ "id": {"description": "Required. Billing entity identifier.", "type": "string"},
+ "xmlSenderId": { "description": "Optional. XmlSenderId override.", "type": ["string", "null"] },
+ "addresses": {
+ "description": "Required. Addresses linked to this billing entity.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "xmlSenderId": { "description": "Optional. XmlSenderId." , "type": ["string", "null"] },
+ "code" : { "description": "Required. Code for the address.", "type": "string" }
+ },
+ "required": ["code"]
+ }
+ },
+ "isDefaultForCustomer": {
+ "description": "Required. Indicates whether this is the default billing entity for the customer.",
+ "type": "boolean"
+ }
},
- "required": ["id", "xmlSenderId", "isDefaultForCustomer"]
+ "required": ["id", "isDefaultForCustomer", "addresses"]
}
},
"brokerScopes": { "type": "array", "items": {"type": "string"} },
@@ -30,27 +54,27 @@
"properties": {
"address1": {
"description": "Required if contactAddress is present. Address line 1. Must not be empty.",
- "type": ["string", "null"]
+ "type": "string"
},
"address2": { "description": "Optional. Address line 2.", "type": ["string", "null"] },
"address3": { "description": "Optional. Address line 3.", "type": ["string", "null"] },
"city": {
"description": "Required if contactAddress is present. City. Must not be empty.",
- "type": ["string", "null"]
+ "type": "string"
},
"company": { "description": "Optional. Company name.", "type": ["string", "null"] },
"country": {
"description": "Required if contactAddress is present. Country. Must not be empty.",
- "type": ["string", "null"]
+ "type": "string"
},
"faxNumber": { "description": "Optional. Fax number.", "type": ["string", "null"] },
"name": { "description": "Optional. Contact name.", "type": ["string", "null"] },
"phoneNumber": { "description": "Optional. Phone number.", "type": ["string", "null"] },
"postalCode": {
"description": "Required if contactAddress is present. Postal code. Must not be empty.",
- "type": ["string", "null"]
+ "type": "string"
},
- "stateProvince": { "description": "Required. State or province.", "type": ["string", "null"] }
+ "stateProvince": {"description": "Required. State or province.", "type": "string"}
},
"required": ["address1", "city", "country", "postalCode", "stateProvince"]
},
@@ -59,16 +83,28 @@
"type": ["string", "null"],
"format": "email"
},
+ "doValidateOrderPrice": {
+ "description": "Required. Indicates whether order price validation is performed on order placement for the Sales Order.",
+ "type": "boolean"
+ },
"emailNotificationSubscriptions": {
"description": "Optional. List of email notification subscriptions.",
- "type": "array",
+ "type": ["array", "null"],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
- "emailNotificationTemplateId": { "type": "string" },
- "emailAddresses" : { "type": "array" , "items": {"type": "string"} }
- }
+ "emailNotificationTemplateId": {
+ "description": "Required. Email notification template identifier.",
+ "type": "string"
+ },
+ "emailAddresses": {
+ "description": "Required. Array of email addresses.",
+ "type": "array",
+ "items": {"type": "string"}
+ }
+ },
+ "required": ["emailNotificationTemplateId", "emailAddresses"]
}
},
"invoiceEmailAddress": {
@@ -103,25 +139,44 @@
},
"salesRep": { "description": "Optional. Sales representative.", "type": ["string", "null"] },
"shipMethodMappings": {
- "type": "array",
+ "description": "Optional. Ship method mappings for the customer.",
+ "type": ["array", "null"],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
- "ratesProviderShipMethodId": {"type": "string"},
- "sourceSystemShipMethodId": {"type": "string"},
+ "ratesProviderShipMethodId": {
+ "description": "Required. Rates provider ship method identifier.",
+ "type": "string"
+ },
+ "sourceSystemShipMethodId": {
+ "description": "Required. Source system ship method identifier.",
+ "type": "string"
+ },
"fulfillmentSystemShipMethods": {
+ "description": "Required. Fulfillment system ship methods.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
- "fulfillmentSystemId" : { "type": "integer", "format": "int64" },
- "fulfillmentSystemShipMethodId": { "type": "string" }
+ "fulfillmentSystemId": {
+ "description": "Required. Fulfillment system identifier.",
+ "type": "integer",
+ "format": "int64"
+ },
+ "fulfillmentSystemShipMethodId": {
+ "description": "Required. Fulfillment system ship method identifier.",
+ "type": "string"
+ },
+ "fulfillmentSystemName": {"description": "Required. Fulfillment system name.", "type": "string"}
},
- "required": ["fulfillmentSystemId", "fulfillmentSystemShipMethodId"]
+ "required": [
+ "fulfillmentSystemId", "fulfillmentSystemShipMethodId", "fulfillmentSystemName"
+ ]
}
- }
+ },
+ "trackingUrl": { "description": "Optional. Tracking URL.", "type": ["string", "null"] }
},
"required": [
"fulfillmentSystemShipMethods", "ratesProviderShipMethodId",
@@ -130,7 +185,8 @@
}
},
"sourceSystems": {
- "type": "array",
+ "description": "Optional. Source systems for the customer.",
+ "type": ["array", "null"],
"items": {
"type": "object",
"additionalProperties": false,
@@ -155,5 +211,5 @@
},
"website": { "description": "Optional. Website URL.", "type": ["string", "null"] }
},
- "required": ["billingEntities", "id", "name"]
+ "required": ["id", "name", "doValidateOrderPrice", "billToCodeRequiredOnOrder"]
}
diff --git a/schema/Api/OfferBroker/CreateOfferRequest.json b/schema/Api/OfferBroker/CreateOfferRequest.json
index ce5e606..fad90e1 100644
--- a/schema/Api/OfferBroker/CreateOfferRequest.json
+++ b/schema/Api/OfferBroker/CreateOfferRequest.json
@@ -14,9 +14,8 @@
"additionalProperties": false,
"properties": {
"omsOfferId": {
- "description": "Required. Unique offer identifier. Must not be empty.",
- "type": "string",
- "minLength": 1
+ "description": "Unique offer identifier assigned by the OMS.",
+ "type": ["string", "null"]
},
"xmPieTemplateId": { "type": ["string", "null"] },
"xmPieUStoreId": { "type": ["string", "null"] },
@@ -166,5 +165,5 @@
"unitOfMeasure": { "type": ["string", "null"] },
"weightInPounds": { "type": ["number", "null"], "format": "double" }
},
- "required": ["number", "offerType", "omsOfferId"]
+ "required": ["number", "offerType"]
}
diff --git a/schema/Api/OfferBroker/DeleteCategoryResponse.json b/schema/Api/OfferBroker/DeleteCategoryResponse.json
index 0f01c9b..a6be93a 100644
--- a/schema/Api/OfferBroker/DeleteCategoryResponse.json
+++ b/schema/Api/OfferBroker/DeleteCategoryResponse.json
@@ -4,10 +4,10 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "id" : { "type": "string" },
- "failureMessages" : { "type": "array" , "items": {"type": "string"} },
- "informationalMessages" : { "type": "array" , "items": {"type": "string"} },
- "operationWasSuccessful": { "type": "boolean" }
+ "id" : { "type": ["string", "null"] },
+ "failureMessages" : { "type": "array" , "items": {"type": "string"} },
+ "informationalMessages" : { "type": "array" , "items": {"type": "string"} },
+ "operationWasSuccessful": { "type": "boolean" }
},
"required": ["failureMessages", "informationalMessages", "operationWasSuccessful", "id"]
}
diff --git a/schema/Api/OfferBroker/DeleteOfferResponse.json b/schema/Api/OfferBroker/DeleteOfferResponse.json
index dbf2078..9d3705b 100644
--- a/schema/Api/OfferBroker/DeleteOfferResponse.json
+++ b/schema/Api/OfferBroker/DeleteOfferResponse.json
@@ -4,10 +4,10 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "id" : { "type": "string" },
- "failureMessages" : { "type": "array" , "items": {"type": "string"} },
- "informationalMessages" : { "type": "array" , "items": {"type": "string"} },
- "operationWasSuccessful": { "type": "boolean" }
+ "id" : { "type": ["string", "null"] },
+ "failureMessages" : { "type": "array" , "items": {"type": "string"} },
+ "informationalMessages" : { "type": "array" , "items": {"type": "string"} },
+ "operationWasSuccessful": { "type": "boolean" }
},
"required": ["failureMessages", "informationalMessages", "operationWasSuccessful", "id"]
}
diff --git a/schema/Api/OfferBroker/GetOfferCategoriesResponse.json b/schema/Api/OfferBroker/GetOfferCategoriesResponse.json
index daa74cd..a9ef9fc 100644
--- a/schema/Api/OfferBroker/GetOfferCategoriesResponse.json
+++ b/schema/Api/OfferBroker/GetOfferCategoriesResponse.json
@@ -15,22 +15,22 @@
"categoryLevel": { "type": ["integer", "null"], "format": "int32" },
"categoryName": {"type": "string"},
"subCategories": {
- "type": "array",
+ "type": ["array", "null"],
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {"type": "string"},
"categoryKey": {"type": "string"},
- "categoryLevel": { "type": ["integer", "null"] },
+ "categoryLevel": { "type": ["integer", "null"], "format": "int32" },
"categoryName": {"type": "string"},
"subCategories": { "type": "array", "items": {"type": "object"} }
},
- "required": ["id", "categoryKey", "categoryName", "subCategories"]
+ "required": ["id", "categoryKey", "categoryName"]
}
}
},
- "required": ["id", "categoryKey", "categoryName", "subCategories"]
+ "required": ["id", "categoryKey", "categoryName"]
}
},
"failureMessages": { "type": "array", "items": {"type": "string"} },
diff --git a/schema/Api/OfferBroker/GetOfferInventoryResponse.json b/schema/Api/OfferBroker/GetOfferInventoryResponse.json
index 8a32bbf..5a4e31d 100644
--- a/schema/Api/OfferBroker/GetOfferInventoryResponse.json
+++ b/schema/Api/OfferBroker/GetOfferInventoryResponse.json
@@ -17,7 +17,7 @@
"onBackorder" : { "type": ["integer", "null"], "format": "int32" },
"reserved" : { "type": "integer" , "format": "int32" }
},
- "required": ["offerId", "currentAvailableQty", "reserved"]
+ "required": ["offerId", "currentOnHandQty", "currentAvailableQty", "reserved"]
}
},
"failureMessages": { "type": "array", "items": {"type": "string"} },
diff --git a/schema/Api/OfferBroker/GetOfferResponse.json b/schema/Api/OfferBroker/GetOfferResponse.json
index fea3510..5787a52 100644
--- a/schema/Api/OfferBroker/GetOfferResponse.json
+++ b/schema/Api/OfferBroker/GetOfferResponse.json
@@ -8,7 +8,7 @@
"type": ["object", "null"],
"additionalProperties": false,
"properties": {
- "id": { "type": ["string", "null"] },
+ "id": {"type": "string"},
"omsOfferId": {
"description": "Required. Unique offer identifier. Must not be empty.",
"type": "string",
@@ -56,7 +56,7 @@
"defaultPrice": { "type": ["number", "null"], "format": "double" },
"deliveryScheduleCron": { "type": ["string", "null"] },
"doSuppressShippingAndHandling": {"type": "boolean"},
- "fixedOrderQuantities": { "type": ["array", "null"], "items": {"type": "number", "format": "double"} },
+ "fixedOrderQuantities": { "type": ["array", "null"], "items": {"type": "integer", "format": "int32"} },
"fullImageUrl": { "type": ["string", "null"] },
"integrationBrokerLastUpdatedDateTimeUtc": { "type": ["string", "null"] },
"isActive": {"type": "boolean"},
@@ -176,9 +176,9 @@
"surcharge": {"type": "number", "format": "double"},
"thumbnailUrl": { "type": ["string", "null"] },
"unitOfMeasure": { "type": ["string", "null"] },
- "weightInPounds": {"type": "number", "format": "double"}
+ "weightInPounds": {"type": "number", "format": "float"}
},
- "required": ["omsOfferId", "number", "offerType", "schemaVersion"]
+ "required": ["id", "omsOfferId", "number", "offerType", "schemaVersion"]
},
"failureMessages": { "type": "array", "items": {"type": "string"} },
"informationalMessages": { "type": "array", "items": {"type": "string"} },
diff --git a/schema/Api/OfferBroker/GetOffersResponse.json b/schema/Api/OfferBroker/GetOffersResponse.json
index f9cf3be..5d52a32 100644
--- a/schema/Api/OfferBroker/GetOffersResponse.json
+++ b/schema/Api/OfferBroker/GetOffersResponse.json
@@ -10,7 +10,7 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "id": { "type": ["string", "null"] },
+ "id": {"type": "string"},
"omsOfferId": {
"description": "Required. Unique offer identifier. Must not be empty.",
"type": "string",
@@ -58,7 +58,7 @@
"defaultPrice": { "type": ["number", "null"], "format": "double" },
"deliveryScheduleCron": { "type": ["string", "null"] },
"doSuppressShippingAndHandling": {"type": "boolean"},
- "fixedOrderQuantities": { "type": ["array", "null"], "items": {"type": "number", "format": "double"} },
+ "fixedOrderQuantities": { "type": ["array", "null"], "items": {"type": "integer", "format": "int32"} },
"fullImageUrl": { "type": ["string", "null"] },
"integrationBrokerLastUpdatedDateTimeUtc": { "type": ["string", "null"] },
"isActive": {"type": "boolean"},
@@ -179,9 +179,9 @@
"surcharge": {"type": "number", "format": "double"},
"thumbnailUrl": { "type": ["string", "null"] },
"unitOfMeasure": { "type": ["string", "null"] },
- "weightInPounds": {"type": "number", "format": "double"}
+ "weightInPounds": {"type": "number", "format": "float"}
},
- "required": ["omsOfferId", "number", "offerType", "schemaVersion"]
+ "required": ["id", "omsOfferId", "number", "offerType", "schemaVersion"]
}
},
"failureMessages": { "type": "array", "items": {"type": "string"} },
diff --git a/schema/Api/OfferBroker/InternalGetOffersResponse.json b/schema/Api/OfferBroker/InternalGetOffersResponse.json
index 2671e2d..3fa7b43 100644
--- a/schema/Api/OfferBroker/InternalGetOffersResponse.json
+++ b/schema/Api/OfferBroker/InternalGetOffersResponse.json
@@ -10,7 +10,7 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "id": { "type": ["string", "null"] },
+ "id": {"type": "string"},
"omsOfferId": {
"description": "Required. Unique offer identifier. Must not be empty.",
"type": "string",
@@ -58,7 +58,7 @@
"defaultPrice": { "type": ["number", "null"], "format": "double" },
"deliveryScheduleCron": { "type": ["string", "null"] },
"doSuppressShippingAndHandling": {"type": "boolean"},
- "fixedOrderQuantities": { "type": ["array", "null"], "items": {"type": "number", "format": "double"} },
+ "fixedOrderQuantities": { "type": ["array", "null"], "items": {"type": "integer", "format": "int32"} },
"fullImageUrl": { "type": ["string", "null"] },
"integrationBrokerLastUpdatedDateTimeUtc": { "type": ["string", "null"] },
"isActive": {"type": "boolean"},
@@ -179,9 +179,9 @@
"surcharge": {"type": "number", "format": "double"},
"thumbnailUrl": { "type": ["string", "null"] },
"unitOfMeasure": { "type": ["string", "null"] },
- "weightInPounds": {"type": "number", "format": "double"}
+ "weightInPounds": {"type": "number", "format": "float"}
},
- "required": ["omsOfferId", "number", "offerType", "productClusters", "schemaVersion"]
+ "required": ["id", "omsOfferId", "number", "offerType", "productClusters", "schemaVersion"]
}
},
"failureMessages": { "type": "array", "items": {"type": "string"} },
diff --git a/schema/Api/OfferBroker/UpdateOfferRequest.json b/schema/Api/OfferBroker/UpdateOfferRequest.json
index 5241881..e5bf207 100644
--- a/schema/Api/OfferBroker/UpdateOfferRequest.json
+++ b/schema/Api/OfferBroker/UpdateOfferRequest.json
@@ -13,6 +13,7 @@
],
"additionalProperties": false,
"properties": {
+ "offerId": { "type": ["string", "null"] },
"omsOfferId": {
"description": "Unique offer identifier. Must not be empty.",
"type": ["string", "null"]
@@ -60,7 +61,7 @@
"defaultPrice": { "type": ["number", "null"], "format": "double" },
"deliveryScheduleCron": { "type": ["string", "null"] },
"doSuppressShippingAndHandling": { "type": ["boolean", "null"] },
- "fixedOrderQuantities": { "type": ["array", "null"], "items": {"type": "number", "format": "double"} },
+ "fixedOrderQuantities": { "type": ["array", "null"], "items": {"type": "integer", "format": "int32"} },
"fullImageUrl": { "type": ["string", "null"] },
"integrationBrokerLastUpdatedDateTimeUtc": { "type": ["string", "null"] },
"isActive": { "type": ["boolean", "null"] },
@@ -178,7 +179,7 @@
"surcharge": { "type": ["number", "null"], "format": "double" },
"thumbnailUrl": { "type": ["string", "null"] },
"unitOfMeasure": { "type": ["string", "null"] },
- "weightInPounds": { "type": ["number", "null"], "format": "double" }
+ "weightInPounds": { "type": ["number", "null"], "format": "float" }
},
"required": ["number", "offerType", "schemaVersion"]
}
diff --git a/schema/Api/OfferBroker/UpdateOfferResponse.json b/schema/Api/OfferBroker/UpdateOfferResponse.json
index 600c975..ff39435 100644
--- a/schema/Api/OfferBroker/UpdateOfferResponse.json
+++ b/schema/Api/OfferBroker/UpdateOfferResponse.json
@@ -4,10 +4,10 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "id" : { "type": "string" },
- "failureMessages" : { "type": "array" , "items": {"type": "string"} },
- "informationalMessages" : { "type": "array" , "items": {"type": "string"} },
- "operationWasSuccessful": { "type": "boolean" }
+ "id" : { "type": ["string", "null"] },
+ "failureMessages" : { "type": "array" , "items": {"type": "string"} },
+ "informationalMessages" : { "type": "array" , "items": {"type": "string"} },
+ "operationWasSuccessful": { "type": "boolean" }
},
"required": ["failureMessages", "informationalMessages", "operationWasSuccessful", "id"]
}
diff --git a/schema/Api/OrderBroker/GetOrderParameters.json b/schema/Api/OrderBroker/GetOrderParameters.json
new file mode 100644
index 0000000..e77939e
--- /dev/null
+++ b/schema/Api/OrderBroker/GetOrderParameters.json
@@ -0,0 +1,16 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "CorrelationId": {
+ "description": "Correlation ID. This is added by the API Management service if not present. Once added, it should be propagated to any downstream services.",
+ "in": "header",
+ "name": "x-correlation-id",
+ "schema": {"type": "string"},
+ "required": false
+ },
+ "OrderId": {
+ "in": "path",
+ "name": "orderId",
+ "schema": {"type": "string"},
+ "required": true
+ }
+}
diff --git a/schema/Api/OrderBroker/GetOrderResponse.json b/schema/Api/OrderBroker/GetOrderResponse.json
new file mode 100644
index 0000000..38b23d4
--- /dev/null
+++ b/schema/Api/OrderBroker/GetOrderResponse.json
@@ -0,0 +1,978 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "GetOrderResponse.json",
+ "description": "Response for Get Order API containing the Order schema",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "type": ["object", "null"],
+ "additionalProperties": false,
+ "properties": {
+ "omsCustomerId": {
+ "description": "Unique customer ID in the order management system (system where order lifecycle will be managed)",
+ "type": ["string", "null"],
+ "maxLength": 100
+ },
+ "omsId": {
+ "description": "Order management system ID",
+ "type": ["string", "null"],
+ "maxLength": 100
+ },
+ "omsOrderId": {
+ "description": "Unique order ID in the order management system (system where order lifecycle will be managed)",
+ "type": ["string", "null"],
+ "maxLength": 100
+ },
+ "orderId": {
+ "description": "Unique ID for order within order management system (system where order lifecycle will be managed). Required, must not be null or empty.",
+ "type": "string",
+ "maxLength": 100,
+ "minLength": 1
+ },
+ "referenceId": { "type": ["string", "null"], "maxLength": 255 },
+ "sourceSystemCustomerId": {
+ "description": "Unique customer ID in the source system. Required, must not be null or empty.",
+ "type": "string",
+ "maxLength": 100,
+ "minLength": 1
+ },
+ "sourceSystemId": {
+ "description": "Source system ID. Required, must not be null.",
+ "type": ["integer", "null"],
+ "format": "int32"
+ },
+ "sourceSystemOrderId": {
+ "description": "Unique order ID in the source system (system where order was originally placed)",
+ "type": ["string", "null"],
+ "maxLength": 100
+ },
+ "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"],
+ "maxLength": 100
+ },
+ "affiliateName": {
+ "description": "Name for affiliate within source system (system where order was originally placed)",
+ "type": ["string", "null"],
+ "maxLength": 255
+ },
+ "billTos": {
+ "description": "Bill to addresses array for Order. Required, must not be empty. Each item must have required address fields and a non-null key.",
+ "oneOf": [
+ {"type": "null"},
+ {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "address1": {"description": "Address line 1 for address", "type": "string"},
+ "address2": { "description": "Address line 2 for address", "type": ["string", "null"] },
+ "address3": { "description": "Address line 3 for address", "type": ["string", "null"] },
+ "addressCode": { "description": "Address code for address", "type": ["string", "null"] },
+ "city": {"description": "City name for address", "type": "string"},
+ "company": { "description": "Company name for address", "type": ["string", "null"] },
+ "country": {"description": "Country name for address", "type": "string"},
+ "emailAddress": {
+ "description": "Contact email address for address",
+ "type": ["string", "null"]
+ },
+ "faxNumber": { "description": "Fax number for address", "type": ["string", "null"] },
+ "isDeleted": {
+ "description": "Flag indicating if this bill to address has been deleted",
+ "type": ["boolean", "null"]
+ },
+ "key": {
+ "description": "Unique ID for individual contact",
+ "type": "string",
+ "pattern": "^[0-9]+$"
+ },
+ "name": {"description": "Contact name for this address", "type": "string"},
+ "phoneNumber": { "description": "Phone number for address", "type": ["string", "null"] },
+ "postalCode": {"description": "Postal code for address", "type": "string"},
+ "stateProvince": {"description": "State or province name for address", "type": "string"}
+ },
+ "required": ["address1", "city", "country", "key", "name", "postalCode", "stateProvince"]
+ },
+ "minItems": 1
+ }
+ ]
+ },
+ "costCenter": { "type": ["string", "null"], "maxLength": 255 },
+ "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",
+ "minimum": 0
+ },
+ "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": ["string", "null"],
+ "pattern": "^[0-9]+$"
+ },
+ "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": ["string", "null"],
+ "pattern": "^[0-9]+$"
+ },
+ "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": ["string", "null"],
+ "pattern": "^[0-9]+$"
+ },
+ "dueDate": {
+ "description": "Datetime of expected due date for Order. If present, must be a valid date and not in the past (enforced in backend).",
+ "type": ["string", "null"],
+ "pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}|\\d{8}|\\d{2}[-/]\\d{2}[-/]\\d{4}(\\s\\d{2}:\\d{2}:\\d{2})?)$",
+ "examples": ["2024-04-20T10:30:00", "20240420", "04/20/2024 10:30:00"]
+ },
+ "lineItems": {
+ "description": "Order level line item details. Required, must not be empty. Each item must have offerId, quantityOrdered > 0, price >= 0, taxAmount >= 0, lineItemFee >= 0. If defaultBillToKey, defaultOrderedByKey, or defaultShipToKey are null, corresponding keys must be set on each line item.",
+ "type": ["array"],
+ "items": {
+ "description": "Order level line item details",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "offerId": {
+ "description": "Unique ID for offer within Integration Broker",
+ "type": "string"
+ },
+ "productManagementSystemCustomerId": {
+ "description": "Unique customer ID in the product management system (system where ordered line item products will be managed)",
+ "type": ["string", "null"],
+ "maxLength": 100
+ },
+ "productManagementSystemId": {
+ "description": "Product management system ID",
+ "type": ["string", "null"],
+ "maxLength": 100
+ },
+ "referenceId": { "type": ["string", "null"] },
+ "variableTemplatePrintId": {
+ "description": "Unique ID for variable template file associated to offer on individual line item",
+ "type": ["string", "null"]
+ },
+ "additionalProperties": {
+ "description": "Additional properties details for Order LineItems",
+ "type": ["array", "null"],
+ "items": {
+ "description": "Order.LineItems level additional properties details",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "key" : { "type": ["string", "null"] },
+ "value": { "type": ["string", "null"] }
+ },
+ "required": ["key", "value"]
+ }
+ },
+ "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": ["string", "null"],
+ "pattern": "^[0-9]+$"
+ },
+ "comment": {
+ "description": "Manually entered comment for individual line item",
+ "type": ["string", "null"]
+ },
+ "costCenter": { "type": ["string", "null"] },
+ "dueDate": {
+ "description": "Datetime of expected due date for individual line item",
+ "type": ["string", "null"]
+ },
+ "isDeleted": {
+ "description": "Flag indicating if this line item has been deleted",
+ "type": ["boolean", "null"]
+ },
+ "lineItemFee": {
+ "description": "Fee applied to individual line item",
+ "type": "number",
+ "format": "double"
+ },
+ "offerDescription": {
+ "description": "Description for offer within product management system (system where ordered line item products will be managed)",
+ "type": ["string", "null"]
+ },
+ "offerLineNumber": {
+ "description": "Unique ID for individual line item",
+ "type": ["string", "null"]
+ },
+ "offerNumber": {
+ "description": "Name for offer within product management system (system where ordered line item products will be managed)",
+ "type": ["string", "null"]
+ },
+ "orderedByKey": {
+ "description": "Unique ID for Order.OrderedBy.Key property associated to individual line item",
+ "type": ["string", "null"],
+ "pattern": "^[0-9]+$"
+ },
+ "poNumber": {
+ "description": "Purchase order number for individual line item",
+ "type": ["string", "null"]
+ },
+ "price": {
+ "description": "Total offer price of individual line item",
+ "type": "number",
+ "format": "double"
+ },
+ "products": {
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "fulfillmentSystemCustomerId": {
+ "description": "Unique customer ID in the fulfillment system (system where products will be fulfilled)",
+ "type": ["string", "null"],
+ "maxLength": 100
+ },
+ "fulfillmentSystemId": {
+ "description": "Fulfillment system ID",
+ "type": ["string", "null"],
+ "maxLength": 100
+ },
+ "productId": {"type": "string"},
+ "associatedFileName": { "type": ["string", "null"] },
+ "color": { "type": ["string", "null"] },
+ "comment": { "type": ["string", "null"] },
+ "components": {
+ "type": ["array", "null"],
+ "items": {
+ "description": "Product component details",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "productId": {
+ "description": "Unique ID for component product within Integration Broker",
+ "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"] },
+ "comment": {
+ "description": "Manually entered comment for component product",
+ "type": ["string", "null"]
+ },
+ "componentLineNumber": {
+ "description": "Unique ID for component product within parent product",
+ "type": ["string", "null"],
+ "pattern": "^[0-9]+$"
+ },
+ "productDescription": {
+ "description": "Description for component product within product management system (system where ordered line item products will be managed)",
+ "type": ["string", "null"]
+ },
+ "productNumber": {
+ "description": "Name for component product within product management system (system where ordered line item products will be managed)",
+ "type": ["string", "null"]
+ },
+ "productOwner": { "description": "Owner of component product", "type": ["string", "null"] },
+ "quantityBackordered": {
+ "description": "Amount of component product back-ordered within parent product",
+ "type": ["integer", "null"],
+ "format": "int32"
+ },
+ "quantityOrdered": {
+ "description": "Amount of component product ordered within parent product",
+ "type": ["integer", "null"],
+ "format": "int32"
+ },
+ "size": { "description": "Size of component product", "type": ["string", "null"] }
+ },
+ "required": ["productId"]
+ }
+ },
+ "isDeleted": {
+ "description": "Flag indicating if this product has been deleted",
+ "type": ["boolean", "null"]
+ },
+ "offerLineNumber": {
+ "description": "Line number reference to the parent offer line item",
+ "type": ["string", "null"]
+ },
+ "pageCount": { "type": ["integer", "null"], "format": "int32" },
+ "productDescription": { "type": ["string", "null"] },
+ "productLineNumber": {
+ "description": "Line number reference to the parent offer line item",
+ "type": ["string", "null"],
+ "pattern": "^[0-9]+$"
+ },
+ "productNumber": { "type": ["string", "null"] },
+ "productOwner": { "type": ["string", "null"] },
+ "quantityBackordered": { "type": ["integer", "null"], "format": "int32" },
+ "quantityOrdered": { "type": ["integer", "null"], "format": "int32" },
+ "size": { "type": ["string", "null"] }
+ },
+ "required": ["productId"]
+ }
+ },
+ "quantityCanceled": {
+ "description": "Amount of offer canceled for individual line item",
+ "type": ["integer", "null"],
+ "format": "int32",
+ "minimum": 0
+ },
+ "quantityOrdered": {
+ "description": "Amount of offer ordered for individual line item",
+ "type": ["integer", "null"],
+ "format": "int32"
+ },
+ "rushOrder": {
+ "description": "True/false indicator if individual line item is expedited",
+ "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": ["string", "null"],
+ "pattern": "^[0-9]+$"
+ },
+ "status": { "description": "Current status of the line item", "type": ["string", "null"] },
+ "taxAmount": {
+ "description": "Total tax amount applied to individual line item",
+ "type": ["number", "null"],
+ "format": "double"
+ }
+ },
+ "required": ["offerId"]
+ },
+ "minItems": 1,
+ "uniqueItems": false
+ },
+ "modifiedDateTime": {
+ "description": "Datetime of when order was last modified",
+ "type": ["string", "null"]
+ },
+ "omsCustomerName": {
+ "description": "Customer name in the order management system (system where order lifecycle will be managed)",
+ "type": ["string", "null"],
+ "maxLength": 255
+ },
+ "orderFee": {
+ "description": "Fee applied to Order",
+ "type": ["number", "null"],
+ "format": "double",
+ "minimum": 0
+ },
+ "orderVariables": {
+ "description": "Manually entered variables for order within order management system (system where order lifecycle will be managed in)",
+ "oneOf": [ {"type": "null"}, {"type": "object"} ]
+ },
+ "orderedBys": {
+ "description": "Order level ordered by contact and address details. Not required, but if present, each item must have required address fields and a non-null key.",
+ "oneOf": [
+ {"type": "null"},
+ {
+ "type": "array",
+ "items": {
+ "description": "Bill to address object for Order",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "address1": {"description": "Address line 1 for address", "type": "string"},
+ "address2": { "description": "Address line 2 for address", "type": ["string", "null"] },
+ "address3": { "description": "Address line 3 for address", "type": ["string", "null"] },
+ "addressCode": { "description": "Address code for address", "type": ["string", "null"] },
+ "city": {"description": "City name for address", "type": "string"},
+ "company": { "description": "Company name for address", "type": ["string", "null"] },
+ "country": {"description": "Country name for address", "type": "string"},
+ "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": "string",
+ "pattern": "^[0-9]+$"
+ },
+ "name": {"type": "string"},
+ "phoneNumber": { "description": "Phone number for address", "type": ["string", "null"] },
+ "postalCode": {"description": "Postal code for address", "type": "string"},
+ "stateProvince": {"description": "State or province name for address", "type": "string"}
+ },
+ "required": ["address1", "city", "country", "name", "postalCode", "stateProvince"]
+ },
+ "minItems": 1
+ }
+ ]
+ },
+ "paymentMethods": {
+ "description": "Order.ShipTos level payment method details",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "description": "Total Amount. Required if MethodName specified",
+ "type": "number",
+ "format": "double"
+ },
+ "methodName": {
+ "description": "Name of payment method. Required if Payment Amount specified",
+ "type": "string"
+ }
+ },
+ "required": ["amount", "methodName"]
+ }
+ },
+ "pickPackHandlingFee": {
+ "description": "Sum of pick & pack handling fees for all Order.ShipTos",
+ "type": ["number", "null"],
+ "format": "double",
+ "minimum": 0
+ },
+ "poNumber": {
+ "description": "Purchase order number for Order. Maximum length 20 characters.",
+ "type": ["string", "null"],
+ "maxLength": 20
+ },
+ "rushOrder": {
+ "description": "True/false indicator if Order is expedited",
+ "type": ["boolean", "null"]
+ },
+ "shipTos": {
+ "description": "Order level ship to details. Required, must not be empty. Each item must have required address fields and a non-null key.",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "affiliateId": { "type": ["string", "null"] },
+ "omsShippingMethodId": {
+ "description": "Shipping method ID in the order management system",
+ "type": ["string", "null"],
+ "maxLength": 100
+ },
+ "referenceId": { "type": ["string", "null"] },
+ "sourceSystemShippingMethodId": { "type": ["string", "null"] },
+ "affiliateName": { "type": ["string", "null"] },
+ "comment": { "type": ["string", "null"] },
+ "costCenter": { "type": ["string", "null"] },
+ "creditCardFee": { "type": ["number", "null"], "format": "double" },
+ "dueDate": { "type": ["string", "null"] },
+ "key": {
+ "description": "Unique ID for individual ship to address",
+ "type": "string",
+ "pattern": "^[0-9]+$"
+ },
+ "orderFee": { "type": ["number", "null"], "format": "double" },
+ "paymentMethods": {
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "description": "Total Amount. Required if MethodName specified",
+ "type": "number",
+ "format": "double"
+ },
+ "methodName": {
+ "description": "Name of payment method. Required if Payment Amount specified",
+ "type": "string"
+ }
+ },
+ "required": ["amount", "methodName"]
+ }
+ },
+ "pickPackHandlingFee": { "type": ["number", "null"], "format": "double" },
+ "poNumber": { "type": ["string", "null"] },
+ "rushFee": {
+ "description": "Rush fee applied to this ship to location",
+ "type": ["number", "null"],
+ "format": "double",
+ "minimum": 0
+ },
+ "rushOrder": { "type": ["boolean", "null"] },
+ "shipToAddress": {
+ "description": "Ship to addresses array for Order",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "address1": {"description": "Address line 1 for address", "type": "string"},
+ "address2": { "description": "Address line 2 for address", "type": ["string", "null"] },
+ "address3": { "description": "Address line 3 for address", "type": ["string", "null"] },
+ "addressCode": { "description": "Address code for address", "type": ["string", "null"] },
+ "city": {"description": "City name for address", "type": "string"},
+ "company": { "description": "Company name for address", "type": ["string", "null"] },
+ "country": {"description": "Country name for address", "type": "string"},
+ "emailAddress": {
+ "description": "Contact email address for address",
+ "type": ["string", "null"]
+ },
+ "faxNumber": { "description": "Fax number for address", "type": ["string", "null"] },
+ "name": {"type": "string"},
+ "phoneNumber": { "description": "Phone number for address", "type": ["string", "null"] },
+ "postalCode": {"description": "Postal code for address", "type": "string"},
+ "stateProvince": {"description": "State or province name for address", "type": "string"}
+ },
+ "required": ["address1", "city", "country", "name", "postalCode", "stateProvince"]
+ },
+ "shippingCarrier": { "description": "Shipping carrier name", "type": ["string", "null"] },
+ "shippingCost": { "type": ["number", "null"], "format": "double" },
+ "shippingHandlingTax": { "type": ["number", "null"], "format": "double" },
+ "shippingService": { "description": "Shipping service level", "type": ["string", "null"] },
+ "status": {
+ "description": "Current status of the ship to location",
+ "type": ["string", "null"]
+ },
+ "totalOrderFee": { "type": ["number", "null"], "format": "double" }
+ },
+ "required": ["key"]
+ },
+ "minItems": 1,
+ "uniqueItems": false
+ },
+ "shippingHandlingTax": {
+ "description": "Sum of shipping & handling taxes for all Order.ShipTos. Required, must not be null.",
+ "type": "number",
+ "format": "double",
+ "minimum": 0
+ },
+ "statuses": {
+ "description": "Array of status values for the order",
+ "type": ["array", "null"],
+ "items": {"type": "string"}
+ },
+ "totalOrderFee": {
+ "description": "Sum of OrderFee",
+ "type": ["number", "null"],
+ "format": "double",
+ "minimum": 0
+ },
+ "totalShippingCost": {
+ "description": "Sum of shipping cost for all Order.ShipTos.Shipments",
+ "type": ["number", "null"],
+ "format": "double",
+ "minimum": 0
+ }
+ },
+ "required": [
+ "orderId", "sourceSystemCustomerId", "sourceSystemId", "createDateTime",
+ "lineItems", "billTos", "shipTos"
+ ],
+ "allOf": [
+ {
+ "description": "Either a defaultBillToKey must be provided, or the billTos array must be populated.",
+ "oneOf": [
+ {
+ "properties": { "defaultBillToKey": {"type": "string"} },
+ "required": ["defaultBillToKey"]
+ },
+ {
+ "properties": { "billTos": {"type": "array", "minItems": 1} },
+ "required": ["billTos"]
+ }
+ ]
+ },
+ {
+ "description": "Either a defaultShipToKey must be provided, or the shipTos array must be populated.",
+ "oneOf": [
+ {
+ "properties": { "defaultShipToKey": {"type": "string"} },
+ "required": ["defaultShipToKey"]
+ },
+ {
+ "properties": { "shipTos": {"type": "array", "minItems": 1} },
+ "required": ["shipTos"]
+ }
+ ]
+ },
+ {
+ "description": "If a defaultBillToKey is not provided at the root, each line item must specify a billToKey.",
+ "oneOf": [
+ {
+ "properties": { "defaultBillToKey": {"type": "string"} },
+ "required": ["defaultBillToKey"]
+ },
+ {
+ "properties": {
+ "lineItems": {
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": { "billToKey": {"type": "string"} },
+ "required": ["billToKey"]
+ }
+ }
+ }
+ }
+ ]
+ },
+ {
+ "description": "If a defaultShipToKey is not provided at the root, each line item must specify a shipToKey.",
+ "oneOf": [
+ {
+ "properties": { "defaultShipToKey": {"type": "string"} },
+ "required": ["defaultShipToKey"]
+ },
+ {
+ "properties": {
+ "lineItems": {
+ "type": ["array", "null"],
+ "items": { "properties": { "shipToKey": {"type": "string"} }, "required": ["shipToKey"] }
+ }
+ }
+ }
+ ]
+ },
+ {
+ "description": "If a defaultOrderedByKey is not provided at the root, each line item must specify an orderedByKey.",
+ "oneOf": [
+ {
+ "properties": { "defaultOrderedByKey": {"type": "string"} },
+ "required": ["defaultOrderedByKey"]
+ },
+ {
+ "properties": {
+ "lineItems": {
+ "type": ["array", "null"],
+ "items": {
+ "properties": { "orderedByKey": {"type": "string"} },
+ "required": ["orderedByKey"]
+ }
+ }
+ }
+ },
+ {
+ "properties": {
+ "defaultOrderedByKey": {"type": "null"},
+ "orderedBys": { "oneOf": [ {"type": "null"}, {"type": "array", "maxItems": 0} ] }
+ },
+ "required": ["defaultOrderedByKey", "orderedBys"]
+ }
+ ]
+ },
+ {
+ "properties": {
+ "lineItems": {
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": { "offerLineNumber": {"type": "string", "minLength": 1} },
+ "required": ["offerLineNumber"]
+ }
+ }
+ }
+ }
+ ],
+ "examples": []
+ },
+ "failureMessages": { "type": "array", "items": {"type": "string"} },
+ "informationalMessages": { "type": "array", "items": {"type": "string"} },
+ "operationWasSuccessful": {"type": "boolean"}
+ },
+ "required": ["failureMessages", "informationalMessages", "operationWasSuccessful", "data"],
+ "examples": [
+ {
+ "data": {
+ "orderId": "7-mkkutsde-3-K-5649-4005-64",
+ "referenceId": "OWMR WSKFA - LNSSZT XBUUJ & MS XXQ QCHX",
+ "sourceSystemCustomerId": "Big Chicken",
+ "sourceSystemId": 2,
+ "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"
+ }
+ ],
+ "paymentMethods": [ {"amount": 35.8, "methodName": "invoice"} ],
+ "pickPackHandlingFee": 0.75,
+ "poNumber": null,
+ "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,
+ "paymentMethods": [],
+ "pickPackHandlingFee": 0.75,
+ "poNumber": null,
+ "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
+ },
+ "failureMessages": [],
+ "informationalMessages": [],
+ "operationWasSuccessful": true
+ },
+ {
+ "data": {
+ "orderId": "1-qrhjtpek-8-Q-0286-8859-25",
+ "referenceId": "WUQD HWKPE - XIWHAC BTVOM & BH WAK DXRI",
+ "sourceSystemCustomerId": "Big Chicken",
+ "sourceSystemId": 2,
+ "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"
+ }
+ ],
+ "paymentMethods": [ {"amount": 35.8, "methodName": "invoice"} ],
+ "pickPackHandlingFee": 0.75,
+ "poNumber": null,
+ "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,
+ "paymentMethods": [],
+ "pickPackHandlingFee": 0.75,
+ "poNumber": null,
+ "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
+ },
+ "failureMessages": [],
+ "informationalMessages": [],
+ "operationWasSuccessful": true
+ }
+ ]
+}
diff --git a/schema/Api/OrderBroker/InternalGetOrderResponse.json b/schema/Api/OrderBroker/InternalGetOrderResponse.json
index c39d3ca..e6a9afd 100644
--- a/schema/Api/OrderBroker/InternalGetOrderResponse.json
+++ b/schema/Api/OrderBroker/InternalGetOrderResponse.json
@@ -71,6 +71,7 @@
"address1": {"description": "Address line 1 for address", "type": "string"},
"address2": { "description": "Address line 2 for address", "type": ["string", "null"] },
"address3": { "description": "Address line 3 for address", "type": ["string", "null"] },
+ "addressCode": { "description": "Address code for address", "type": ["string", "null"] },
"city": {"description": "City name for address", "type": "string"},
"company": { "description": "Company name for address", "type": ["string", "null"] },
"country": {"description": "Country name for address", "type": "string"},
@@ -379,6 +380,7 @@
"address1": {"description": "Address line 1 for address", "type": "string"},
"address2": { "description": "Address line 2 for address", "type": ["string", "null"] },
"address3": { "description": "Address line 3 for address", "type": ["string", "null"] },
+ "addressCode": { "description": "Address code for address", "type": ["string", "null"] },
"city": {"description": "City name for address", "type": "string"},
"company": { "description": "Company name for address", "type": ["string", "null"] },
"country": {"description": "Country name for address", "type": "string"},
@@ -500,6 +502,7 @@
"address1": {"description": "Address line 1 for address", "type": "string"},
"address2": { "description": "Address line 2 for address", "type": ["string", "null"] },
"address3": { "description": "Address line 3 for address", "type": ["string", "null"] },
+ "addressCode": { "description": "Address code for address", "type": ["string", "null"] },
"city": {"description": "City name for address", "type": "string"},
"company": { "description": "Company name for address", "type": ["string", "null"] },
"country": {"description": "Country name for address", "type": "string"},
diff --git a/schema/Api/OrderBroker/InternalNewOrderRequest.json b/schema/Api/OrderBroker/InternalNewOrderRequest.json
index 9246e91..68c3a41 100644
--- a/schema/Api/OrderBroker/InternalNewOrderRequest.json
+++ b/schema/Api/OrderBroker/InternalNewOrderRequest.json
@@ -48,6 +48,7 @@
"address1": {"description": "Address line 1 for address", "type": "string"},
"address2": { "description": "Address line 2 for address", "type": ["string", "null"] },
"address3": { "description": "Address line 3 for address", "type": ["string", "null"] },
+ "addressCode": { "description": "Address code for address", "type": ["string", "null"] },
"city": {"description": "City name for address", "type": "string"},
"company": { "description": "Company name for address", "type": ["string", "null"] },
"country": {"description": "Country name for address", "type": "string"},
@@ -313,6 +314,7 @@
"address1": {"description": "Address line 1 for address", "type": "string"},
"address2": { "description": "Address line 2 for address", "type": ["string", "null"] },
"address3": { "description": "Address line 3 for address", "type": ["string", "null"] },
+ "addressCode": { "description": "Address code for address", "type": ["string", "null"] },
"city": {"description": "City name for address", "type": "string"},
"company": { "description": "Company name for address", "type": ["string", "null"] },
"country": {"description": "Country name for address", "type": "string"},
@@ -423,6 +425,7 @@
"address1": {"description": "Address line 1 for address", "type": "string"},
"address2": { "description": "Address line 2 for address", "type": ["string", "null"] },
"address3": { "description": "Address line 3 for address", "type": ["string", "null"] },
+ "addressCode": { "description": "Address code for address", "type": ["string", "null"] },
"city": {"description": "City name for address", "type": "string"},
"company": { "description": "Company name for address", "type": ["string", "null"] },
"country": {"description": "Country name for address", "type": "string"},
diff --git a/schema/Api/OrderBroker/InternalUpdateOrderRequest.json b/schema/Api/OrderBroker/InternalUpdateOrderRequest.json
new file mode 100644
index 0000000..5a90d8f
--- /dev/null
+++ b/schema/Api/OrderBroker/InternalUpdateOrderRequest.json
@@ -0,0 +1,345 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "InternalUpdateOrderRequest.json",
+ "type": "object",
+ "properties": {
+ "billingEntityId": { "description": "Billing entity ID", "type": ["string", "null"] },
+ "orderId": { "description": "Order ID", "type": ["string", "null"] },
+ "referenceId": { "description": "Reference ID", "type": ["string", "null"] },
+ "sourceSystemCustomerId": { "description": "Source system customer ID", "type": ["string", "null"] },
+ "sourceSystemId": {"description": "Source system ID", "type": "integer", "format": "int32"},
+ "accessGroups": {
+ "description": "Access groups",
+ "type": ["array", "null"],
+ "items": {"type": "string"}
+ },
+ "affiliateIdentifier": { "description": "Affiliate identifier", "type": ["string", "null"] },
+ "affiliateName": { "description": "Affiliate name", "type": ["string", "null"] },
+ "billTos": {
+ "description": "Bill to addresses",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "address1": { "description": "Address line 1", "type": ["string", "null"] },
+ "address2": { "description": "Address line 2", "type": ["string", "null"] },
+ "address3": { "description": "Address line 3", "type": ["string", "null"] },
+ "addressCode": { "description": "Address code", "type": ["string", "null"] },
+ "city": { "description": "City", "type": ["string", "null"] },
+ "company": { "description": "Company name", "type": ["string", "null"] },
+ "country": { "description": "Country", "type": ["string", "null"] },
+ "emailAddress": { "description": "Email address", "type": ["string", "null"] },
+ "faxNumber": { "description": "Fax number", "type": ["string", "null"] },
+ "isDeleted": { "description": "Is deleted flag", "type": ["boolean", "null"] },
+ "key": {"description": "Bill to key", "type": "string", "pattern": "^[0-9]+$"},
+ "name": { "description": "Contact name", "type": ["string", "null"] },
+ "phoneNumber": { "description": "Phone number", "type": ["string", "null"] },
+ "postalCode": { "description": "Postal code", "type": ["string", "null"] },
+ "stateProvince": { "description": "State or province", "type": ["string", "null"] }
+ },
+ "required": ["key"]
+ }
+ },
+ "costCenter": { "description": "Cost center", "type": ["string", "null"] },
+ "creditCardFee": {
+ "description": "Credit card fee",
+ "type": ["number", "null"],
+ "format": "decimal"
+ },
+ "defaultBillToKey": {
+ "description": "Default bill to key",
+ "type": ["string", "null"],
+ "pattern": "^[0-9]+$"
+ },
+ "defaultOrderedByKey": {
+ "description": "Default ordered by key",
+ "type": ["string", "null"],
+ "pattern": "^[0-9]+$"
+ },
+ "defaultShipToKey": {
+ "description": "Default ship to key",
+ "type": ["string", "null"],
+ "pattern": "^[0-9]+$"
+ },
+ "dueDate": { "description": "Due date", "type": ["string", "null"] },
+ "lineItems": {
+ "description": "Line items",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "offerId": { "description": "Offer ID", "type": ["string", "null"] },
+ "referenceId": { "description": "Reference ID", "type": ["string", "null"] },
+ "variableTemplatePrintId": { "description": "Variable template print ID", "type": ["string", "null"] },
+ "additionalProperties": {
+ "description": "Additional properties",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "key" : { "description": "Property key" , "type": ["string", "null"] },
+ "value": { "description": "Property value", "type": ["string", "null"] }
+ }
+ }
+ },
+ "billToKey": {
+ "description": "Bill to key",
+ "type": ["string", "null"],
+ "pattern": "^[0-9]+$"
+ },
+ "comment": { "description": "Comment", "type": ["string", "null"] },
+ "costCenter": { "description": "Cost center", "type": ["string", "null"] },
+ "dueDate": { "description": "Due date", "type": ["string", "null"] },
+ "lineItemFee": {
+ "description": "Line item fee",
+ "type": ["number", "null"],
+ "format": "decimal"
+ },
+ "offerDescription": { "description": "Offer description", "type": ["string", "null"] },
+ "offerLineNumber": {
+ "description": "Offer line number",
+ "type": ["string", "null"],
+ "pattern": "^[0-9]+$"
+ },
+ "offerNumber": { "description": "Offer number", "type": ["string", "null"] },
+ "orderedByKey": {
+ "description": "Ordered by key",
+ "type": ["string", "null"],
+ "pattern": "^[0-9]+$"
+ },
+ "pONumber": { "description": "Purchase order number", "type": ["string", "null"] },
+ "price": { "description": "Price", "type": ["number", "null"], "format": "decimal" },
+ "products": {
+ "description": "Products",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "productId": { "description": "Product ID", "type": ["string", "null"] },
+ "associatedFileName": { "description": "Associated file name", "type": ["string", "null"] },
+ "color": { "description": "Color", "type": ["string", "null"] },
+ "comment": { "description": "Comment", "type": ["string", "null"] },
+ "components": {
+ "description": "Product components",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "productId": { "description": "Product ID", "type": ["string", "null"] },
+ "associatedFileName": { "description": "Associated file name", "type": ["string", "null"] },
+ "color": { "description": "Color", "type": ["string", "null"] },
+ "comment": { "description": "Comment", "type": ["string", "null"] },
+ "componentLineNumber": {
+ "description": "Component line number",
+ "type": ["string", "null"],
+ "pattern": "^[0-9]+$"
+ },
+ "productDescription": { "description": "Product description", "type": ["string", "null"] },
+ "productNumber": { "description": "Product number", "type": ["string", "null"] },
+ "productOwner": { "description": "Product owner", "type": ["string", "null"] },
+ "quantityBackordered": {
+ "description": "Quantity backordered",
+ "type": ["integer", "null"],
+ "format": "int32"
+ },
+ "quantityOrdered": {
+ "description": "Quantity ordered",
+ "type": ["integer", "null"],
+ "format": "int32"
+ },
+ "size": { "description": "Size", "type": ["string", "null"] }
+ }
+ }
+ },
+ "pageCount": { "description": "Page count", "type": ["integer", "null"], "format": "int32" },
+ "productDescription": { "description": "Product description", "type": ["string", "null"] },
+ "productLineNumber": {
+ "description": "Product line number",
+ "type": ["string", "null"],
+ "pattern": "^[0-9]+$"
+ },
+ "productNumber": { "description": "Product number", "type": ["string", "null"] },
+ "productOwner": { "description": "Product owner", "type": ["string", "null"] },
+ "quantityOrdered": {
+ "description": "Quantity ordered",
+ "type": ["integer", "null"],
+ "format": "int32"
+ },
+ "size": { "description": "Size", "type": ["string", "null"] }
+ }
+ }
+ },
+ "quantityOrdered": {
+ "description": "Quantity ordered",
+ "type": ["integer", "null"],
+ "format": "int32"
+ },
+ "rushOrder": { "description": "Rush order flag", "type": ["boolean", "null"] },
+ "shipToKey": {
+ "description": "Ship to key",
+ "type": ["string", "null"],
+ "pattern": "^[0-9]+$"
+ },
+ "taxAmount": { "description": "Tax amount", "type": ["number", "null"], "format": "decimal" }
+ }
+ }
+ },
+ "orderFee": { "description": "Order fee", "type": ["number", "null"], "format": "decimal" },
+ "orderVariables": { "description": "Order variables", "type": ["object", "null"] },
+ "orderedBys": {
+ "description": "Ordered by addresses",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "address1": { "description": "Address line 1", "type": ["string", "null"] },
+ "address2": { "description": "Address line 2", "type": ["string", "null"] },
+ "address3": { "description": "Address line 3", "type": ["string", "null"] },
+ "addressCode": { "description": "Address code", "type": ["string", "null"] },
+ "city": { "description": "City", "type": ["string", "null"] },
+ "company": { "description": "Company name", "type": ["string", "null"] },
+ "country": { "description": "Country", "type": ["string", "null"] },
+ "emailAddress": { "description": "Email address", "type": ["string", "null"] },
+ "faxNumber": { "description": "Fax number", "type": ["string", "null"] },
+ "isDeleted": { "description": "Is deleted flag", "type": ["boolean", "null"] },
+ "key": {"description": "Ordered by key", "type": "string", "pattern": "^[0-9]+$"},
+ "name": { "description": "Contact name", "type": ["string", "null"] },
+ "phoneNumber": { "description": "Phone number", "type": ["string", "null"] },
+ "postalCode": { "description": "Postal code", "type": ["string", "null"] },
+ "stateProvince": { "description": "State or province", "type": ["string", "null"] }
+ },
+ "required": ["key"]
+ }
+ },
+ "pONumber": {
+ "description": "Purchase order number",
+ "type": ["string", "null"],
+ "maxLength": 20
+ },
+ "paymentMethods": {
+ "description": "Payment methods",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "amount": {
+ "description": "Payment amount",
+ "type": ["number", "null"],
+ "format": "decimal"
+ },
+ "methodName": { "description": "Payment method name", "type": ["string", "null"] }
+ }
+ }
+ },
+ "pickPackHandlingFee": {
+ "description": "Pick pack handling fee",
+ "type": ["number", "null"],
+ "format": "decimal"
+ },
+ "rushOrder": {"description": "Rush order flag", "type": "boolean"},
+ "shipTos": {
+ "description": "Ship to addresses",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "affiliateId": { "description": "Affiliate ID", "type": ["string", "null"] },
+ "referenceId": { "description": "Reference ID", "type": ["string", "null"] },
+ "sourceSystemShippingMethodId": {
+ "description": "Source system shipping method ID",
+ "type": ["string", "null"]
+ },
+ "affiliateName": { "description": "Affiliate name", "type": ["string", "null"] },
+ "comment": { "description": "Comment", "type": ["string", "null"] },
+ "costCenter": { "description": "Cost center", "type": ["string", "null"] },
+ "creditCardFee": {
+ "description": "Credit card fee",
+ "type": ["number", "null"],
+ "format": "decimal"
+ },
+ "dueDate": { "description": "Due date", "type": ["string", "null"] },
+ "key": {"description": "Ship to key", "type": "string", "pattern": "^[0-9]+$"},
+ "orderFee": { "description": "Order fee", "type": ["number", "null"], "format": "decimal" },
+ "pONumber": { "description": "Purchase order number", "type": ["string", "null"] },
+ "paymentMethods": {
+ "description": "Payment methods",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "amount": {
+ "description": "Payment amount",
+ "type": ["number", "null"],
+ "format": "decimal"
+ },
+ "methodName": { "description": "Payment method name", "type": ["string", "null"] }
+ }
+ }
+ },
+ "pickPackHandlingFee": {
+ "description": "Pick pack handling fee",
+ "type": ["number", "null"],
+ "format": "decimal"
+ },
+ "rushFee": { "description": "Rush fee", "type": ["number", "null"], "format": "decimal" },
+ "rushOrder": { "description": "Rush order flag", "type": ["boolean", "null"] },
+ "shipToAddress": {
+ "description": "Ship to address",
+ "type": ["object", "null"],
+ "properties": {
+ "address1" : { "description": "Address line 1" , "type": ["string", "null"] },
+ "address2" : { "description": "Address line 2" , "type": ["string", "null"] },
+ "address3" : { "description": "Address line 3" , "type": ["string", "null"] },
+ "addressCode" : { "description": "Address code" , "type": ["string", "null"] },
+ "city" : { "description": "City" , "type": ["string", "null"] },
+ "company" : { "description": "Company name" , "type": ["string", "null"] },
+ "country" : { "description": "Country" , "type": ["string", "null"] },
+ "emailAddress" : { "description": "Email address" , "type": ["string", "null"] },
+ "faxNumber" : { "description": "Fax number" , "type": ["string", "null"] },
+ "name" : { "description": "Contact name" , "type": ["string", "null"] },
+ "phoneNumber" : { "description": "Phone number" , "type": ["string", "null"] },
+ "postalCode" : { "description": "Postal code" , "type": ["string", "null"] },
+ "stateProvince": { "description": "State or province", "type": ["string", "null"] }
+ }
+ },
+ "shippingCost": {
+ "description": "Shipping cost",
+ "type": ["number", "null"],
+ "format": "decimal"
+ },
+ "shippingHandlingTax": {
+ "description": "Shipping handling tax",
+ "type": ["number", "null"],
+ "format": "decimal"
+ },
+ "totalOrderFee": {
+ "description": "Total order fee",
+ "type": ["number", "null"],
+ "format": "decimal"
+ }
+ },
+ "required": ["key"]
+ }
+ },
+ "shippingHandlingTax": {
+ "description": "Shipping handling tax",
+ "type": ["number", "null"],
+ "format": "decimal"
+ },
+ "totalOrderFee": {
+ "description": "Total order fee",
+ "type": ["number", "null"],
+ "format": "decimal"
+ },
+ "totalShippingCost": {
+ "description": "Total shipping cost",
+ "type": ["number", "null"],
+ "format": "decimal"
+ },
+ "updateDateTime": { "description": "Update date time", "type": ["string", "null"] }
+ },
+ "required": [
+ "sourceSystemCustomerId", "sourceSystemId", "orderId", "shippingHandlingTax",
+ "billTos", "shipTos"
+ ]
+}
diff --git a/schema/Api/OrderBroker/InternalUpdateOrderResponse.json b/schema/Api/OrderBroker/InternalUpdateOrderResponse.json
new file mode 100644
index 0000000..6d3e878
--- /dev/null
+++ b/schema/Api/OrderBroker/InternalUpdateOrderResponse.json
@@ -0,0 +1,21 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "InternalUpdateOrderResponse.json",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "type": ["object", "null"],
+ "additionalProperties": false,
+ "properties": {
+ "omsOrderId" : { "description": "OMS order ID" , "type": ["string", "null"] },
+ "omsIdentifier" : { "description": "OMS identifier" , "type": ["string", "null"] },
+ "omsRootSystemName": { "description": "OMS root system name", "type": ["string", "null"] }
+ }
+ },
+ "failureMessages": { "type": "array", "items": {"type": "string"} },
+ "informationalMessages": { "type": "array", "items": {"type": "string"} },
+ "operationWasSuccessful": {"type": "boolean"}
+ },
+ "required": ["failureMessages", "informationalMessages", "operationWasSuccessful", "data"]
+}
diff --git a/schema/Api/OrderBroker/NewOrderRequest.json b/schema/Api/OrderBroker/NewOrderRequest.json
index 9ec0868..7cca018 100644
--- a/schema/Api/OrderBroker/NewOrderRequest.json
+++ b/schema/Api/OrderBroker/NewOrderRequest.json
@@ -36,6 +36,7 @@
"address1": {"description": "Address line 1 for address", "type": "string"},
"address2": { "description": "Address line 2 for address", "type": ["string", "null"] },
"address3": { "description": "Address line 3 for address", "type": ["string", "null"] },
+ "addressCode": { "description": "Address code for address", "type": ["string", "null"] },
"city": {"description": "City name for address", "type": "string"},
"company": { "description": "Company name for address", "type": ["string", "null"] },
"country": {"description": "Country name for address", "type": "string"},
@@ -301,6 +302,7 @@
"address1": {"description": "Address line 1 for address", "type": "string"},
"address2": { "description": "Address line 2 for address", "type": ["string", "null"] },
"address3": { "description": "Address line 3 for address", "type": ["string", "null"] },
+ "addressCode": { "description": "Address code for address", "type": ["string", "null"] },
"city": {"description": "City name for address", "type": "string"},
"company": { "description": "Company name for address", "type": ["string", "null"] },
"country": {"description": "Country name for address", "type": "string"},
@@ -411,6 +413,7 @@
"address1": {"description": "Address line 1 for address", "type": "string"},
"address2": { "description": "Address line 2 for address", "type": ["string", "null"] },
"address3": { "description": "Address line 3 for address", "type": ["string", "null"] },
+ "addressCode": { "description": "Address code for address", "type": ["string", "null"] },
"city": {"description": "City name for address", "type": "string"},
"company": { "description": "Company name for address", "type": ["string", "null"] },
"country": {"description": "Country name for address", "type": "string"},
diff --git a/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json b/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json
index 9ac1071..3a0290d 100644
--- a/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json
+++ b/schema/Api/OrderBroker/UpdateFulfillmentOrderRequest.json
@@ -21,6 +21,7 @@
"address1": {"description": "Address line 1 for address", "type": "string"},
"address2": { "description": "Address line 2 for address", "type": ["string", "null"] },
"address3": { "description": "Address line 3 for address", "type": ["string", "null"] },
+ "addressCode": { "description": "Address code for address", "type": ["string", "null"] },
"city": {"description": "City name for address", "type": "string"},
"company": { "description": "Company name for address", "type": ["string", "null"] },
"country": {"description": "Country name for address", "type": "string"},
@@ -84,25 +85,12 @@
"type": ["string", "null"],
"pattern": "^[0-9]+$"
},
- "shipmentPackages": {
- "type": ["array", "null"],
- "items": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "shipmentId": {"type": "string"},
- "packageNumber": {"type": "string"},
- "shipQuantity": {"type": "number", "format": "double"}
- },
- "required": ["shipmentId", "packageNumber", "shipQuantity"]
- }
- },
"status": { "type": ["string", "null"] }
},
- "required": ["productId"]
+ "required": ["productId", "productLineId", "fulfillmentSystemProductId"]
}
},
- "rushOrder": { "type": ["string", "null"] },
+ "rushOrder": { "type": ["boolean", "null"] },
"shipTos": {
"type": ["array", "null"],
"items": {
@@ -145,6 +133,7 @@
"address1": {"description": "Address line 1 for address", "type": "string"},
"address2": { "description": "Address line 2 for address", "type": ["string", "null"] },
"address3": { "description": "Address line 3 for address", "type": ["string", "null"] },
+ "addressCode": { "description": "Address code for address", "type": ["string", "null"] },
"city": {"description": "City name for address", "type": "string"},
"company": { "description": "Company name for address", "type": ["string", "null"] },
"country": {"description": "Country name for address", "type": "string"},
@@ -165,7 +154,7 @@
"shippingService": { "type": ["string", "null"] },
"status": { "type": ["string", "null"] }
},
- "required": ["key"]
+ "required": ["key", "fulfillmentSystemShippingMethodId"]
}
},
"shipments": {
@@ -197,6 +186,7 @@
"address1": {"description": "Address line 1 for address", "type": "string"},
"address2": { "description": "Address line 2 for address", "type": ["string", "null"] },
"address3": { "description": "Address line 3 for address", "type": ["string", "null"] },
+ "addressCode": { "description": "Address code for address", "type": ["string", "null"] },
"city": {"description": "City name for address", "type": "string"},
"company": { "description": "Company name for address", "type": ["string", "null"] },
"country": {"description": "Country name for address", "type": "string"},
diff --git a/schema/Api/OrderBroker/UpdateFulfillmentOrderResponse.json b/schema/Api/OrderBroker/UpdateFulfillmentOrderResponse.json
index d29475e..14b0a3c 100644
--- a/schema/Api/OrderBroker/UpdateFulfillmentOrderResponse.json
+++ b/schema/Api/OrderBroker/UpdateFulfillmentOrderResponse.json
@@ -1,14 +1,15 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "UpdateFulfillmentOrderResponse.json",
+ "type": "object",
+ "additionalProperties": false,
"properties": {
"data": {
- "type": "object",
+ "type": ["object", "null"],
"additionalProperties": false,
"properties": {
- "failureMessages": { "type": ["array", "null"], "items": {"type": "string"} },
- "informationalMessages": { "type": ["array", "null"], "items": {"type": "string"} },
- "operationWasSuccessful": {"type": "boolean", "readOnly": true}
+ "fulfillmentOrderId": { "type": ["string", "null"] },
+ "status" : { "type": ["string", "null"] }
}
},
"failureMessages": { "type": "array", "items": {"type": "string"} },
diff --git a/schema/Api/OrderBroker/UpdateOrderRequest.json b/schema/Api/OrderBroker/UpdateOrderRequest.json
new file mode 100644
index 0000000..2bfa717
--- /dev/null
+++ b/schema/Api/OrderBroker/UpdateOrderRequest.json
@@ -0,0 +1,345 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "UpdateOrderRequest.json",
+ "type": "object",
+ "properties": {
+ "billingEntityId": { "description": "Billing entity ID", "type": ["string", "null"] },
+ "orderId": { "description": "Order ID", "type": ["string", "null"] },
+ "referenceId": { "description": "Reference ID", "type": ["string", "null"] },
+ "sourceSystemCustomerId": { "description": "Source system customer ID", "type": ["string", "null"] },
+ "sourceSystemId": {"description": "Source system ID", "type": "integer", "format": "int32"},
+ "accessGroups": {
+ "description": "Access groups",
+ "type": ["array", "null"],
+ "items": {"type": "string"}
+ },
+ "affiliateIdentifier": { "description": "Affiliate identifier", "type": ["string", "null"] },
+ "affiliateName": { "description": "Affiliate name", "type": ["string", "null"] },
+ "billTos": {
+ "description": "Bill to addresses",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "address1": { "description": "Address line 1", "type": ["string", "null"] },
+ "address2": { "description": "Address line 2", "type": ["string", "null"] },
+ "address3": { "description": "Address line 3", "type": ["string", "null"] },
+ "addressCode": { "description": "Address code", "type": ["string", "null"] },
+ "city": { "description": "City", "type": ["string", "null"] },
+ "company": { "description": "Company name", "type": ["string", "null"] },
+ "country": { "description": "Country", "type": ["string", "null"] },
+ "emailAddress": { "description": "Email address", "type": ["string", "null"] },
+ "faxNumber": { "description": "Fax number", "type": ["string", "null"] },
+ "isDeleted": { "description": "Is deleted flag", "type": ["boolean", "null"] },
+ "key": {"description": "Bill to key", "type": "string", "pattern": "^[0-9]+$"},
+ "name": { "description": "Contact name", "type": ["string", "null"] },
+ "phoneNumber": { "description": "Phone number", "type": ["string", "null"] },
+ "postalCode": { "description": "Postal code", "type": ["string", "null"] },
+ "stateProvince": { "description": "State or province", "type": ["string", "null"] }
+ },
+ "required": ["key"]
+ }
+ },
+ "costCenter": { "description": "Cost center", "type": ["string", "null"] },
+ "creditCardFee": {
+ "description": "Credit card fee",
+ "type": ["number", "null"],
+ "format": "decimal"
+ },
+ "defaultBillToKey": {
+ "description": "Default bill to key",
+ "type": ["string", "null"],
+ "pattern": "^[0-9]+$"
+ },
+ "defaultOrderedByKey": {
+ "description": "Default ordered by key",
+ "type": ["string", "null"],
+ "pattern": "^[0-9]+$"
+ },
+ "defaultShipToKey": {
+ "description": "Default ship to key",
+ "type": ["string", "null"],
+ "pattern": "^[0-9]+$"
+ },
+ "dueDate": { "description": "Due date", "type": ["string", "null"] },
+ "lineItems": {
+ "description": "Line items",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "offerId": { "description": "Offer ID", "type": ["string", "null"] },
+ "referenceId": { "description": "Reference ID", "type": ["string", "null"] },
+ "variableTemplatePrintId": { "description": "Variable template print ID", "type": ["string", "null"] },
+ "additionalProperties": {
+ "description": "Additional properties",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "key" : { "description": "Property key" , "type": ["string", "null"] },
+ "value": { "description": "Property value", "type": ["string", "null"] }
+ }
+ }
+ },
+ "billToKey": {
+ "description": "Bill to key",
+ "type": ["string", "null"],
+ "pattern": "^[0-9]+$"
+ },
+ "comment": { "description": "Comment", "type": ["string", "null"] },
+ "costCenter": { "description": "Cost center", "type": ["string", "null"] },
+ "dueDate": { "description": "Due date", "type": ["string", "null"] },
+ "lineItemFee": {
+ "description": "Line item fee",
+ "type": ["number", "null"],
+ "format": "decimal"
+ },
+ "offerDescription": { "description": "Offer description", "type": ["string", "null"] },
+ "offerLineNumber": {
+ "description": "Offer line number",
+ "type": ["string", "null"],
+ "pattern": "^[0-9]+$"
+ },
+ "offerNumber": { "description": "Offer number", "type": ["string", "null"] },
+ "orderedByKey": {
+ "description": "Ordered by key",
+ "type": ["string", "null"],
+ "pattern": "^[0-9]+$"
+ },
+ "pONumber": { "description": "Purchase order number", "type": ["string", "null"] },
+ "price": { "description": "Price", "type": ["number", "null"], "format": "decimal" },
+ "products": {
+ "description": "Products",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "productId": { "description": "Product ID", "type": ["string", "null"] },
+ "associatedFileName": { "description": "Associated file name", "type": ["string", "null"] },
+ "color": { "description": "Product color", "type": ["string", "null"] },
+ "comment": { "description": "Comment", "type": ["string", "null"] },
+ "components": {
+ "description": "Product components",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "productId": { "description": "Component product ID", "type": ["string", "null"] },
+ "associatedFileName": { "description": "Component associated file name", "type": ["string", "null"] },
+ "color": { "description": "Component color", "type": ["string", "null"] },
+ "comment": { "description": "Component comment", "type": ["string", "null"] },
+ "componentLineNumber": {
+ "description": "Component line number",
+ "type": ["string", "null"],
+ "pattern": "^[0-9]+$"
+ },
+ "productDescription": { "description": "Component product description", "type": ["string", "null"] },
+ "productNumber": { "description": "Component product number", "type": ["string", "null"] },
+ "productOwner": { "description": "Component product owner", "type": ["string", "null"] },
+ "quantityBackordered": {
+ "description": "Component quantity backordered",
+ "type": ["integer", "null"],
+ "format": "int32"
+ },
+ "quantityOrdered": {
+ "description": "Component quantity ordered",
+ "type": ["integer", "null"],
+ "format": "int32"
+ },
+ "size": { "description": "Component size", "type": ["string", "null"] }
+ }
+ }
+ },
+ "pageCount": { "description": "Page count", "type": ["integer", "null"], "format": "int32" },
+ "productDescription": { "description": "Product description", "type": ["string", "null"] },
+ "productLineNumber": {
+ "description": "Product line number",
+ "type": ["string", "null"],
+ "pattern": "^[0-9]+$"
+ },
+ "productNumber": { "description": "Product number", "type": ["string", "null"] },
+ "productOwner": { "description": "Product owner", "type": ["string", "null"] },
+ "quantityOrdered": {
+ "description": "Quantity ordered",
+ "type": ["integer", "null"],
+ "format": "int32"
+ },
+ "size": { "description": "Product size", "type": ["string", "null"] }
+ }
+ }
+ },
+ "quantityOrdered": {
+ "description": "Quantity ordered",
+ "type": ["integer", "null"],
+ "format": "int32"
+ },
+ "rushOrder": { "description": "Rush order flag", "type": ["boolean", "null"] },
+ "shipToKey": {
+ "description": "Ship to key",
+ "type": ["string", "null"],
+ "pattern": "^[0-9]+$"
+ },
+ "taxAmount": { "description": "Tax amount", "type": ["number", "null"], "format": "decimal" }
+ }
+ }
+ },
+ "orderFee": { "description": "Order fee", "type": ["number", "null"], "format": "decimal" },
+ "orderVariables": { "description": "Order variables", "type": ["object", "null"] },
+ "orderedBys": {
+ "description": "Ordered by addresses",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "address1": { "description": "Address line 1", "type": ["string", "null"] },
+ "address2": { "description": "Address line 2", "type": ["string", "null"] },
+ "address3": { "description": "Address line 3", "type": ["string", "null"] },
+ "addressCode": { "description": "Address code", "type": ["string", "null"] },
+ "city": { "description": "City", "type": ["string", "null"] },
+ "company": { "description": "Company name", "type": ["string", "null"] },
+ "country": { "description": "Country", "type": ["string", "null"] },
+ "emailAddress": { "description": "Email address", "type": ["string", "null"] },
+ "faxNumber": { "description": "Fax number", "type": ["string", "null"] },
+ "isDeleted": { "description": "Is deleted flag", "type": ["boolean", "null"] },
+ "key": {"description": "Ordered by key", "type": "string", "pattern": "^[0-9]+$"},
+ "name": { "description": "Contact name", "type": ["string", "null"] },
+ "phoneNumber": { "description": "Phone number", "type": ["string", "null"] },
+ "postalCode": { "description": "Postal code", "type": ["string", "null"] },
+ "stateProvince": { "description": "State or province", "type": ["string", "null"] }
+ },
+ "required": ["key"]
+ }
+ },
+ "pONumber": {
+ "description": "Purchase order number",
+ "type": ["string", "null"],
+ "maxLength": 20
+ },
+ "paymentMethods": {
+ "description": "Payment methods",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "amount": {
+ "description": "Payment amount",
+ "type": ["number", "null"],
+ "format": "decimal"
+ },
+ "methodName": { "description": "Payment method name", "type": ["string", "null"] }
+ }
+ }
+ },
+ "pickPackHandlingFee": {
+ "description": "Pick pack handling fee",
+ "type": ["number", "null"],
+ "format": "decimal"
+ },
+ "rushOrder": {"description": "Rush order flag", "type": "boolean"},
+ "shipTos": {
+ "description": "Ship to addresses",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "affiliateId": { "description": "Affiliate ID", "type": ["string", "null"] },
+ "referenceId": { "description": "Reference ID", "type": ["string", "null"] },
+ "sourceSystemShippingMethodId": {
+ "description": "Source system shipping method ID",
+ "type": ["string", "null"]
+ },
+ "affiliateName": { "description": "Affiliate name", "type": ["string", "null"] },
+ "comment": { "description": "Comment", "type": ["string", "null"] },
+ "costCenter": { "description": "Cost center", "type": ["string", "null"] },
+ "creditCardFee": {
+ "description": "Credit card fee",
+ "type": ["number", "null"],
+ "format": "decimal"
+ },
+ "dueDate": { "description": "Due date", "type": ["string", "null"] },
+ "key": {"description": "Ship to key", "type": "string", "pattern": "^[0-9]+$"},
+ "orderFee": { "description": "Order fee", "type": ["number", "null"], "format": "decimal" },
+ "pONumber": { "description": "Purchase order number", "type": ["string", "null"] },
+ "paymentMethods": {
+ "description": "Payment methods",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "amount": {
+ "description": "Payment amount",
+ "type": ["number", "null"],
+ "format": "decimal"
+ },
+ "methodName": { "description": "Payment method name", "type": ["string", "null"] }
+ }
+ }
+ },
+ "pickPackHandlingFee": {
+ "description": "Pick pack handling fee",
+ "type": ["number", "null"],
+ "format": "decimal"
+ },
+ "rushFee": { "description": "Rush fee", "type": ["number", "null"], "format": "decimal" },
+ "rushOrder": { "description": "Rush order flag", "type": ["boolean", "null"] },
+ "shipToAddress": {
+ "description": "Ship to address",
+ "type": ["object", "null"],
+ "properties": {
+ "address1" : { "description": "Address line 1" , "type": ["string", "null"] },
+ "address2" : { "description": "Address line 2" , "type": ["string", "null"] },
+ "address3" : { "description": "Address line 3" , "type": ["string", "null"] },
+ "addressCode" : { "description": "Address code" , "type": ["string", "null"] },
+ "city" : { "description": "City" , "type": ["string", "null"] },
+ "company" : { "description": "Company name" , "type": ["string", "null"] },
+ "country" : { "description": "Country" , "type": ["string", "null"] },
+ "emailAddress" : { "description": "Email address" , "type": ["string", "null"] },
+ "faxNumber" : { "description": "Fax number" , "type": ["string", "null"] },
+ "name" : { "description": "Contact name" , "type": ["string", "null"] },
+ "phoneNumber" : { "description": "Phone number" , "type": ["string", "null"] },
+ "postalCode" : { "description": "Postal code" , "type": ["string", "null"] },
+ "stateProvince": { "description": "State or province", "type": ["string", "null"] }
+ }
+ },
+ "shippingCost": {
+ "description": "Shipping cost",
+ "type": ["number", "null"],
+ "format": "decimal"
+ },
+ "shippingHandlingTax": {
+ "description": "Shipping handling tax",
+ "type": ["number", "null"],
+ "format": "decimal"
+ },
+ "totalOrderFee": {
+ "description": "Total order fee",
+ "type": ["number", "null"],
+ "format": "decimal"
+ }
+ },
+ "required": ["key"]
+ }
+ },
+ "shippingHandlingTax": {
+ "description": "Shipping handling tax",
+ "type": ["number", "null"],
+ "format": "decimal"
+ },
+ "totalOrderFee": {
+ "description": "Total order fee",
+ "type": ["number", "null"],
+ "format": "decimal"
+ },
+ "totalShippingCost": {
+ "description": "Total shipping cost",
+ "type": ["number", "null"],
+ "format": "decimal"
+ },
+ "updateDateTime": { "description": "Update date time", "type": ["string", "null"] }
+ },
+ "required": [
+ "sourceSystemCustomerId", "sourceSystemId", "orderId", "shippingHandlingTax",
+ "billTos", "shipTos"
+ ]
+}
diff --git a/schema/Api/OrderBroker/UpdateOrderResponse.json b/schema/Api/OrderBroker/UpdateOrderResponse.json
new file mode 100644
index 0000000..f3ad4ef
--- /dev/null
+++ b/schema/Api/OrderBroker/UpdateOrderResponse.json
@@ -0,0 +1,21 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "UpdateOrderResponse.json",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "type": ["object", "null"],
+ "additionalProperties": false,
+ "properties": {
+ "omsOrderId" : { "description": "OMS order ID" , "type": ["string", "null"] },
+ "omsIdentifier" : { "description": "OMS identifier" , "type": ["string", "null"] },
+ "omsRootSystemName": { "description": "OMS root system name", "type": ["string", "null"] }
+ }
+ },
+ "failureMessages": { "type": "array", "items": {"type": "string"} },
+ "informationalMessages": { "type": "array", "items": {"type": "string"} },
+ "operationWasSuccessful": {"type": "boolean"}
+ },
+ "required": ["failureMessages", "informationalMessages", "operationWasSuccessful", "data"]
+}
diff --git a/schema/Api/ShippingBroker/GetShippingratesRequest.json b/schema/Api/ShippingBroker/GetShippingratesRequest.json
index f90d7c0..4358f9a 100644
--- a/schema/Api/ShippingBroker/GetShippingratesRequest.json
+++ b/schema/Api/ShippingBroker/GetShippingratesRequest.json
@@ -40,8 +40,8 @@
"StateProvince": {"description": "State or province", "type": "string"}
},
"required": [
- "Name", "Address1", "City", "StateProvince", "PostalCode", "Country",
- "EmailAddress", "IsResidential"
+ "Name", "Address1", "City", "StateProvince", "PostalCode", "EmailAddress",
+ "Country", "IsResidential"
]
},
"SourceSystemShippingMethods": {
diff --git a/schema/Common/EventBase.json b/schema/Common/EventBase.json
index 82b7e60..7c762e3 100644
--- a/schema/Common/EventBase.json
+++ b/schema/Common/EventBase.json
@@ -20,6 +20,7 @@
"description": "UTC based datetime of when event was triggered",
"type": "string"
},
+ "EventName": {"description": "Name of triggered event", "type": "string"},
"EventNameValuePairs": { "type": ["array", "null"], "items": {"type": "object"} },
"EventPublisherApp": {
"description": "Name of source application that published event",
diff --git a/schema/Event/Customer/Customer.json b/schema/Event/Customer/Customer.json
index cf26a32..8029b01 100644
--- a/schema/Event/Customer/Customer.json
+++ b/schema/Event/Customer/Customer.json
@@ -6,6 +6,8 @@
"properties": {
"DefaultWarehouseId": { "description": "Default warehouse ID", "type": ["string", "null"] },
"Id": {"description": "Customer ID", "type": "string"},
+ "XmlSenderId": { "description": "XML sender ID", "type": ["string", "null"] },
+ "BillToCodeRequiredOnOrder": {"description": "Whether bill-to code is required on order", "type": "boolean"},
"BillingEntities": {
"description": "Billing entities",
"type": ["array", "null"],
@@ -13,13 +15,45 @@
"type": "object",
"properties": {
"Id": {"description": "Billing entity ID", "type": "string"},
- "XmlSenderId": {"description": "XML sender ID", "type": "string"},
+ "XmlSenderId": { "description": "XML sender ID", "type": ["string", "null"] },
+ "Addresses": {
+ "description": "Billing entity addresses",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "XmlSenderId": { "description": "XML sender ID", "type": ["string", "null"] },
+ "Address1": {"description": "Address line 1", "type": "string"},
+ "Address2": { "description": "Address line 2", "type": ["string", "null"] },
+ "Address3": { "description": "Address line 3", "type": ["string", "null"] },
+ "City": {"description": "City", "type": "string"},
+ "Code": {"description": "Address code", "type": "string"},
+ "Company": { "description": "Company name", "type": ["string", "null"] },
+ "Country": {"description": "Country", "type": "string"},
+ "EmailAddress": { "description": "Email address", "type": ["string", "null"] },
+ "FaxNumber": { "description": "Fax number", "type": ["string", "null"] },
+ "IsBillToDefault": {
+ "description": "Whether this is the default bill-to address",
+ "type": "boolean"
+ },
+ "IsShipToDefault": {
+ "description": "Whether this is the default ship-to address",
+ "type": "boolean"
+ },
+ "Name": {"description": "Address name", "type": "string"},
+ "PhoneNumber": { "description": "Phone number", "type": ["string", "null"] },
+ "PostalCode": {"description": "Postal code", "type": "string"},
+ "StateProvince": {"description": "State or province", "type": "string"}
+ },
+ "required": ["Name", "Address1", "City", "Country", "StateProvince", "PostalCode", "Code"]
+ }
+ },
"IsDefaultForCustomer": {
"description": "Whether this is the default billing entity for the customer",
"type": "boolean"
}
},
- "required": ["Id", "IsDefaultForCustomer", "XmlSenderId"]
+ "required": ["Id", "IsDefaultForCustomer"]
}
},
"BrokerScopes": {
@@ -46,6 +80,7 @@
"required": ["Address1", "City", "Country", "PostalCode", "StateProvince"]
},
"ContactEmailAddress": { "description": "Contact email address", "type": ["string", "null"] },
+ "DoValidateOrderPrice": {"description": "Whether to validate order price", "type": "boolean"},
"EmailNotificationSubscriptions": {
"description": "Email notification subscriptions",
"type": ["array", "null"],
@@ -97,7 +132,8 @@
},
"required": ["FulfillmentSystemId", "FulfillmentSystemShipMethodId"]
}
- }
+ },
+ "TrackingUrl": { "description": "Tracking URL", "type": ["string", "null"] }
},
"required": [
"SourceSystemShipMethodId", "RatesProviderShipMethodId",
@@ -115,11 +151,11 @@
"SourceSystemCustomerId": { "description": "Source system customer ID", "type": "string" },
"Name" : { "description": "Source system name" , "type": "string" }
},
- "required": ["Id", "Name", "SourceSystemCustomerId"]
+ "required": ["Id", "SourceSystemCustomerId"]
}
},
"Subsidiary": { "description": "Subsidiary", "type": ["string", "null"] },
"Website": { "description": "Website", "type": ["string", "null"] }
},
- "required": ["Id", "Name"]
+ "required": ["Id", "Name", "BillToCodeRequiredOnOrder", "DoValidateOrderPrice"]
}
diff --git a/schema/Event/FulfillmentOrder/FulfillmentOrder.json b/schema/Event/FulfillmentOrder/FulfillmentOrder.json
index 435d3f9..a177d39 100644
--- a/schema/Event/FulfillmentOrder/FulfillmentOrder.json
+++ b/schema/Event/FulfillmentOrder/FulfillmentOrder.json
@@ -37,6 +37,7 @@
"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"] },
+ "AddressCode": { "description": "Address code 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"] },
@@ -84,8 +85,7 @@
"properties": {
"Amount" : { "description": "Amount for the payment method", "type": ["number", "null"] },
"MethodName": { "description": "Name of the payment method" , "type": ["string", "null"] }
- },
- "required": ["MethodName", "Amount"]
+ }
}
},
"Products": {
@@ -94,34 +94,18 @@
"items": {
"type": "object",
"properties": {
- "FulfillmentSystemId": { "description": "Fulfillment system ID", "type": ["string", "null"] },
- "FulfillmentSystemProductId": { "description": "Fulfillment system product ID", "type": ["string", "null"] },
- "ProductId": { "description": "Product ID", "type": ["string", "null"] },
- "ProductLineId": { "description": "Product line ID", "type": ["string", "null"] },
- "AssociatedFileName": { "description": "Associated file name", "type": ["string", "null"] },
- "Comment": { "description": "Comment for the product", "type": ["string", "null"] },
- "IsDeleted": { "description": "Whether the product is deleted", "type": ["boolean", "null"] },
- "PageCount": { "description": "Page count for the product", "type": ["integer", "null"] },
- "Price": { "description": "Price of the product", "type": ["number", "null"] },
- "QuantityOrdered": { "description": "Quantity ordered", "type": ["integer", "null"] },
- "ShipToKey": { "description": "Ship to key for the product", "type": ["string", "null"] },
- "ShipmentPackages": {
- "description": "Shipment packages for the product",
- "type": ["array", "null"],
- "items": {
- "type": "object",
- "properties": {
- "ShipmentId": { "description": "Shipment ID", "type": ["string", "null"] },
- "IsDeleted": {
- "description": "Whether the shipment package is deleted",
- "type": ["boolean", "null"]
- },
- "PackageNumber": { "description": "Package number", "type": ["string", "null"] },
- "ShipQuantity": { "description": "Ship quantity", "type": ["number", "null"] }
- }
- }
- },
- "Status": { "description": "Status of the product", "type": ["string", "null"] }
+ "FulfillmentSystemId" : { "description": "Fulfillment system ID" , "type": ["string", "null"] },
+ "FulfillmentSystemProductId": { "description": "Fulfillment system product ID" , "type": ["string", "null"] },
+ "ProductId" : { "description": "Product ID" , "type": ["string", "null"] },
+ "ProductLineId" : { "description": "Product line ID" , "type": ["string", "null"] },
+ "AssociatedFileName" : { "description": "Associated file name" , "type": ["string", "null"] },
+ "Comment" : { "description": "Comment for the product" , "type": ["string", "null"] },
+ "IsDeleted" : { "description": "Whether the product is deleted", "type": ["boolean", "null"] },
+ "PageCount" : { "description": "Page count for the product" , "type": ["integer", "null"] },
+ "Price" : { "description": "Price of the product" , "type": ["number", "null"] },
+ "QuantityOrdered" : { "description": "Quantity ordered" , "type": ["integer", "null"] },
+ "ShipToKey" : { "description": "Ship to key for the product" , "type": ["string", "null"] },
+ "Status" : { "description": "Status of the product" , "type": ["string", "null"] }
}
}
},
@@ -153,8 +137,7 @@
"properties": {
"Amount" : { "description": "Amount for the payment method", "type": ["number", "null"] },
"MethodName": { "description": "Name of the payment method" , "type": ["string", "null"] }
- },
- "required": ["MethodName", "Amount"]
+ }
}
},
"RushFee": { "description": "Rush fee", "type": ["number", "null"] },
@@ -166,6 +149,7 @@
"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"] },
+ "AddressCode": { "description": "Address code 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"] },
@@ -188,7 +172,7 @@
"ShippingService": { "description": "Shipping service", "type": ["string", "null"] },
"Status": { "description": "Status", "type": ["string", "null"] }
},
- "required": ["Key", "ShipToAddress", "FulfillmentSystemShippingMethodId"]
+ "required": ["Key"]
}
},
"Shipments": {
@@ -197,6 +181,8 @@
"items": {
"type": "object",
"properties": {
+ "FulfillmentSystemId": { "description": "Fulfillment system ID", "type": ["string", "null"] },
+ "FulfillmentSystemLocationId": { "description": "Fulfillment system location ID", "type": ["string", "null"] },
"ShipmentId": { "description": "Shipment ID", "type": ["string", "null"] },
"Carrier": { "description": "Carrier", "type": ["string", "null"] },
"Freight": { "description": "Freight cost", "type": ["number", "null"] },
@@ -206,21 +192,27 @@
},
"MasterTrackingNumber": { "description": "Master tracking number", "type": ["string", "null"] },
"Packages": {
- "oneOf": [
- {"type": "null"},
- {
- "description": "Packages in the shipment",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "IsDeleted" : { "description": "Whether the package is deleted", "type": ["boolean", "null"] },
- "PackageNumber" : { "description": "Package number" , "type": ["string", "null"] },
- "TrackingNumber": { "description": "Tracking number" , "type": ["string", "null"] }
+ "description": "Packages in the shipment",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "IsDeleted": { "description": "Whether the package is deleted", "type": ["boolean", "null"] },
+ "PackageNumber": { "description": "Package number", "type": ["string", "null"] },
+ "Products": {
+ "description": "Products in the package",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "ProductLineId": { "description": "Product line ID", "type": ["string", "null"] },
+ "ShipQuantity" : { "description": "Ship quantity" , "type": ["number", "null"] }
+ }
}
- }
+ },
+ "TrackingNumber": { "description": "Tracking number", "type": ["string", "null"] }
}
- ]
+ }
},
"PackingSlipNumber": { "description": "Packing slip number", "type": ["string", "null"] },
"Service": { "description": "Service", "type": ["string", "null"] },
@@ -232,6 +224,7 @@
"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"] },
+ "AddressCode": { "description": "Address code 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"] },
diff --git a/schema/Event/FulfillmentOrder/FulfillmentOrderEvent.json b/schema/Event/FulfillmentOrder/FulfillmentOrderEvent.json
index 0609fd1..8188143 100644
--- a/schema/Event/FulfillmentOrder/FulfillmentOrderEvent.json
+++ b/schema/Event/FulfillmentOrder/FulfillmentOrderEvent.json
@@ -11,7 +11,7 @@
"EventSchemaVersion": {
"description": "Version of event schema being used",
"type": "string",
- "enum": ["0.2"]
+ "enum": ["0.1"]
},
"FulfillmentOrder": {"$ref": "FulfillmentOrder.json"}
},
diff --git a/schema/Event/OfferCategory/OfferCategory.json b/schema/Event/OfferCategory/OfferCategory.json
index 929457a..3b5d5dc 100644
--- a/schema/Event/OfferCategory/OfferCategory.json
+++ b/schema/Event/OfferCategory/OfferCategory.json
@@ -10,20 +10,7 @@
"description": "SOB unique ID of the parent category, if there is one",
"type": ["string", "null"]
},
- "CategoryKey": {
- "description": "Internal database key for the category",
- "type": ["string", "null"]
- },
- "CategoryLevel": {
- "description": "Hierarchy level of the category",
- "type": ["integer", "null"]
- },
- "Name": {"description": "Name to identify category", "type": "string"},
- "SubCategories": {
- "description": "Sub-categories under this category for hierarchical structure",
- "type": ["array", "null"],
- "items": {"type": "object"}
- }
+ "Name": {"description": "Name to identify category", "type": "string"}
},
"required": ["OfferCategoryId", "CustomerId", "Name"]
}
diff --git a/schema/Event/OfferCategory/OfferCategoryEvent.json b/schema/Event/OfferCategory/OfferCategoryEvent.json
index 3201790..b6bd0d9 100644
--- a/schema/Event/OfferCategory/OfferCategoryEvent.json
+++ b/schema/Event/OfferCategory/OfferCategoryEvent.json
@@ -37,10 +37,7 @@
"CustomerId": "customer-123",
"OfferCategoryId": "category-456",
"ParentId": null,
- "CategoryKey": 12345,
- "CategoryLevel": 1,
- "Name": "Electronics",
- "SubCategories": []
+ "Name": "Electronics"
}
}
]
diff --git a/schema/Event/Order/OrderEvent.json b/schema/Event/Order/OrderEvent.json
index eb18630..3d51ce5 100644
--- a/schema/Event/Order/OrderEvent.json
+++ b/schema/Event/Order/OrderEvent.json
@@ -17,11 +17,13 @@
"description": "Name of triggered event",
"type": "string",
"enum": [
- "Order Received", "Order Validated", "Order Validation Failed",
- "Order Submitted to OMS", "Order Rejected by OMS", "Fulfillment Order Created",
- "Order Updated", "Order Update Requested", "Order Update Request Validated",
- "Order Update Request Validation Failed", "Fulfillment Order Creation Failed",
- "Order Complete", "Partially Shipped"
+ "Order Complete", "Order Received", "Order Validated", "Order Validation Failed",
+ "Order Submitted to OMS", "Order Accepted By OMS", "Order Rejected by OMS",
+ "Fulfillment Order Created", "Order Updated",
+ "Order Submitted to Fulfillment System",
+ "Order Failed to Submit to Fulfillment System", "Order Update Requested",
+ "Order Update Request Validated", "Order Update Request Validation Failed",
+ "Fulfillment Order Creation Failed"
]
}
}
diff --git a/schema/Event/OrderView/OrderView.json b/schema/Event/OrderView/OrderView.json
new file mode 100644
index 0000000..c82fbcc
--- /dev/null
+++ b/schema/Event/OrderView/OrderView.json
@@ -0,0 +1,348 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "OrderView.json",
+ "description": "OrderView level details for Cosmos DB Views database",
+ "type": "object",
+ "properties": {
+ "BillingEntityId": { "description": "Billing entity ID", "type": ["string", "null"] },
+ "OmsCustomerId": { "description": "OMS customer ID", "type": ["string", "null"] },
+ "OmsId": { "description": "OMS ID", "type": ["string", "null"] },
+ "OmsOrderId": { "description": "OMS order ID", "type": ["string", "null"] },
+ "OrderId": {
+ "description": "Unique ID for order within order management system",
+ "type": ["string", "null"]
+ },
+ "ReferenceId": { "description": "Reference ID", "type": ["string", "null"] },
+ "SourceSystemCustomerId": { "description": "Source system customer ID", "type": ["string", "null"] },
+ "SourceSystemId": { "description": "Source system ID", "type": ["integer", "null"] },
+ "SourceSystemOrderId": { "description": "Source system order ID", "type": ["string", "null"] },
+ "AccessGroups": {
+ "description": "Access groups",
+ "type": ["array", "null"],
+ "items": {"type": "string"}
+ },
+ "AffiliateIdentifier": { "description": "Affiliate identifier", "type": ["string", "null"] },
+ "AffiliateName": { "description": "Affiliate name", "type": ["string", "null"] },
+ "BillTos": {
+ "description": "Bill to addresses",
+ "type": ["array", "null"],
+ "items": {
+ "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"] },
+ "EmailAddress": {
+ "description": "Contact email address for address",
+ "type": ["string", "null"]
+ },
+ "FaxNumber": { "description": "Fax number for address", "type": ["string", "null"] },
+ "IsDeleted": {
+ "description": "Whether the bill to address is deleted",
+ "type": ["boolean", "null"]
+ },
+ "Key": { "description": "Key for the bill to 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"]
+ }
+ }
+ }
+ },
+ "CostCenter": { "description": "Cost center", "type": ["string", "null"] },
+ "CreateDateTime": { "description": "Create date time", "type": ["string", "null"] },
+ "CreditCardFee": { "description": "Credit card fee", "type": ["number", "null"] },
+ "DefaultBillToKey": { "description": "Default bill to key", "type": ["string", "null"] },
+ "DefaultOrderedByKey": { "description": "Default ordered by key", "type": ["string", "null"] },
+ "DefaultShipToKey": { "description": "Default ship to key", "type": ["string", "null"] },
+ "DueDate": { "description": "Due date", "type": ["string", "null"] },
+ "LineItems": {
+ "description": "Order line items",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "OfferId": {
+ "description": "Unique ID for offer within Integration Broker",
+ "type": ["string", "null"]
+ },
+ "ProductManagementSystemCustomerId": { "type": ["string", "null"] },
+ "ProductManagementSystemId": {
+ "description": "Identifier for a product management system that can be an integer, string, or 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"]
+ },
+ "AdditionalProperties": {
+ "description": "Additional properties details for Order LineItems",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "IsDeleted": {
+ "description": "Whether the additional property is deleted",
+ "type": ["boolean", "null"]
+ },
+ "Key": { "description": "Key of the additional property", "type": ["string", "null"] },
+ "Value": {
+ "description": "Value of the additional property",
+ "type": ["string", "null"]
+ }
+ }
+ }
+ },
+ "BillToKey": {
+ "description": "Unique ID for Order.BillTos.Key property associated to individual line item",
+ "type": ["string", "null"]
+ },
+ "Comment": {
+ "description": "Manually entered comment for individual line item",
+ "type": ["string", "null"]
+ },
+ "CostCenter": { "type": ["string", "null"] },
+ "DueDate": {
+ "description": "Datetime of expected due date for individual line item",
+ "type": ["string", "null"]
+ },
+ "LineItemFee": {
+ "description": "Fee applied to individual line item",
+ "type": ["number", "null"]
+ },
+ "OfferDescription": {
+ "description": "Description for offer within product management system",
+ "type": ["string", "null"]
+ },
+ "OfferLineNumber": {
+ "description": "Unique ID for individual line item",
+ "type": ["string", "null"]
+ },
+ "OfferNumber": {
+ "description": "Name for offer within product management system",
+ "type": ["string", "null"]
+ },
+ "OrderedByKey": {
+ "description": "Unique ID for Order.OrderedBy.Key property associated to individual line item",
+ "type": ["string", "null"]
+ },
+ "PONumber": {
+ "description": "Purchase order number for individual line item",
+ "type": ["string", "null"]
+ },
+ "Price": {
+ "description": "Total offer price of individual line item",
+ "type": ["number", "null"]
+ },
+ "Products": {
+ "description": "Order.LineItems level product details",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "FulfillmentSystemCustomerId": { "description": "Fulfillment system customer ID", "type": ["string", "null"] },
+ "FulfillmentSystemId": { "description": "Fulfillment system ID", "type": ["string", "null"] },
+ "FulfillmentSystemProductId": { "description": "Fulfillment system product ID", "type": ["string", "null"] },
+ "ProductId": { "description": "Product ID", "type": ["string", "null"] },
+ "AssociatedFileName": { "description": "Associated file name", "type": ["string", "null"] },
+ "Color": { "description": "Product color", "type": ["string", "null"] },
+ "Comment": { "description": "Comment for the product", "type": ["string", "null"] },
+ "Components": {
+ "description": "Product components",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "ProductId": { "description": "Component product ID", "type": ["string", "null"] },
+ "AssociatedFileName": { "description": "Component associated file name", "type": ["string", "null"] },
+ "Comment": { "description": "Component comment", "type": ["string", "null"] },
+ "ComponentLineNumber": { "description": "Component line number", "type": ["string", "null"] },
+ "IsDeleted": {
+ "description": "Whether the component is deleted",
+ "type": ["boolean", "null"]
+ },
+ "OfferLineNumber": { "description": "Component offer line number", "type": ["string", "null"] },
+ "ProductLineNumber": { "description": "Component product line number", "type": ["string", "null"] },
+ "QuantityBackordered": { "description": "Component quantity backordered", "type": ["integer", "null"] },
+ "QuantityOrdered": { "description": "Component quantity ordered", "type": ["integer", "null"] }
+ }
+ }
+ },
+ "IsDeleted": { "description": "Whether the product is deleted", "type": ["boolean", "null"] },
+ "OfferLineNumber": { "description": "Offer line number", "type": ["string", "null"] },
+ "PageCount": { "description": "Page count", "type": ["integer", "null"] },
+ "ProductDescription": { "description": "Product description", "type": ["string", "null"] },
+ "ProductLineNumber": { "description": "Product line number", "type": ["string", "null"] },
+ "ProductNumber": { "description": "Product number", "type": ["string", "null"] },
+ "ProductOwner": { "description": "Product owner", "type": ["string", "null"] },
+ "QuantityBackordered": { "description": "Quantity backordered", "type": ["integer", "null"] },
+ "QuantityOrdered": { "description": "Quantity ordered", "type": ["integer", "null"] },
+ "Size": { "description": "Product size", "type": ["string", "null"] }
+ }
+ }
+ },
+ "QuantityCanceled": { "type": ["integer", "null"] },
+ "QuantityOrdered": {
+ "description": "Amount of offer ordered for individual line item",
+ "type": ["integer", "null"]
+ },
+ "RushOrder": {
+ "description": "True/false indicator if individual line item is expedited",
+ "type": ["boolean", "null"]
+ },
+ "ShipToKey": {
+ "description": "Unique ID for Order.ShipTos.Key property associated to individual line item",
+ "type": ["string", "null"]
+ },
+ "Status": { "type": ["string", "null"] },
+ "TaxAmount": {
+ "description": "Total tax amount applied to individual line item",
+ "type": ["number", "null"]
+ }
+ }
+ }
+ },
+ "ModifiedDateTime": { "description": "Modified date time", "type": ["string", "null"] },
+ "OmsCustomerName": { "description": "OMS customer name", "type": ["string", "null"] },
+ "OrderFee": { "description": "Order fee", "type": ["number", "null"] },
+ "OrderVariables": { "description": "Order variables", "type": ["object", "null"] },
+ "OrderedBys": {
+ "description": "Ordered by addresses",
+ "type": ["array", "null"],
+ "items": {
+ "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"] },
+ "EmailAddress": {
+ "description": "Contact email address for address",
+ "type": ["string", "null"]
+ },
+ "FaxNumber": { "description": "Fax number for address", "type": ["string", "null"] },
+ "IsDeleted": {
+ "description": "Whether the ordered by address is deleted",
+ "type": ["boolean", "null"]
+ },
+ "Key": { "description": "Key for the ordered by 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"]
+ }
+ }
+ }
+ },
+ "PONumber": { "description": "PO number", "type": ["string", "null"] },
+ "PaymentMethods": {
+ "description": "Payment methods",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "Amount": {
+ "description": "Total amount applied to payment method",
+ "type": ["number", "null"]
+ },
+ "MethodName": { "description": "Name of payment method", "type": ["string", "null"] }
+ },
+ "required": ["Amount", "MethodName"]
+ }
+ },
+ "PickPackHandlingFee": { "description": "Pick pack handling fee", "type": ["number", "null"] },
+ "RushOrder": { "description": "Rush order flag", "type": ["boolean", "null"] },
+ "ShipTos": {
+ "description": "Ship to addresses",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "AffiliateId": { "description": "Affiliate ID", "type": ["string", "null"] },
+ "OmsShippingMethodId": { "description": "OMS shipping method ID", "type": ["string", "null"] },
+ "ReferenceId": { "description": "Reference ID", "type": ["string", "null"] },
+ "SourceSystemShippingMethodId": {
+ "description": "Source system shipping method ID",
+ "type": ["string", "null"]
+ },
+ "AffiliateName": { "description": "Affiliate name", "type": ["string", "null"] },
+ "Comment": { "description": "Comment", "type": ["string", "null"] },
+ "CostCenter": { "description": "Cost center", "type": ["string", "null"] },
+ "CreditCardFee": { "description": "Credit card fee", "type": ["number", "null"] },
+ "DueDate": { "description": "Due date", "type": ["string", "null"] },
+ "Key": { "description": "Key for the ship to", "type": ["string", "null"] },
+ "OrderFee": { "description": "Order fee", "type": ["number", "null"] },
+ "PONumber": { "description": "PO number", "type": ["string", "null"] },
+ "PaymentMethods": {
+ "description": "Payment methods",
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": {
+ "Amount": {
+ "description": "Total amount applied to payment method",
+ "type": ["number", "null"]
+ },
+ "MethodName": { "description": "Name of payment method", "type": ["string", "null"] }
+ },
+ "required": ["Amount", "MethodName"]
+ }
+ },
+ "PickPackHandlingFee": { "description": "Pick pack handling fee", "type": ["number", "null"] },
+ "RushFee": { "description": "Rush fee", "type": ["number", "null"] },
+ "RushOrder": { "description": "Whether this is a rush order", "type": ["boolean", "null"] },
+ "ShipToAddress": {
+ "description": "Ship to address",
+ "type": ["object", "null"],
+ "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"] },
+ "EmailAddress": {
+ "description": "Contact email address for address",
+ "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"]
+ }
+ }
+ },
+ "ShippingCarrier": { "description": "Shipping carrier", "type": ["string", "null"] },
+ "ShippingCost": { "description": "Shipping cost", "type": ["number", "null"] },
+ "ShippingHandlingTax": { "description": "Shipping handling tax", "type": ["number", "null"] },
+ "ShippingService": { "description": "Shipping service", "type": ["string", "null"] },
+ "Status": { "description": "Status", "type": ["string", "null"] },
+ "TotalOrderFee": { "description": "Total order fee", "type": ["number", "null"] }
+ }
+ }
+ },
+ "ShippingHandlingTax": { "description": "Shipping handling tax", "type": ["number", "null"] },
+ "Statuses": {
+ "description": "Order statuses - critical for OrderView as it's used for OrderStatus property in Service Bus messages",
+ "type": ["array", "null"],
+ "items": {"type": "string"}
+ },
+ "TotalOrderFee": { "description": "Total order fee", "type": ["number", "null"] },
+ "TotalShippingCost": { "description": "Total shipping cost", "type": ["number", "null"] }
+ },
+ "required": ["OrderId", "LineItems", "BillTos", "ShipTos"]
+}
diff --git a/schema/Event/OrderView/OrderViewEvent.json b/schema/Event/OrderView/OrderViewEvent.json
new file mode 100644
index 0000000..8355656
--- /dev/null
+++ b/schema/Event/OrderView/OrderViewEvent.json
@@ -0,0 +1,145 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "OrderViewEvent.json",
+ "description": "OrderViewEvent schema",
+ "type": "object",
+ "allOf": [
+ {"$ref": "../../Common/EventBase.json"},
+ {
+ "type": "object",
+ "properties": { "OrderView": {"$ref": "OrderView.json"} },
+ "required": ["OrderView"]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "EventName": {
+ "description": "Name of triggered event for OrderView",
+ "type": "string",
+ "enum": [
+ "OrderView Created", "OrderView Updated", "OrderView Status Changed",
+ "OrderView View Updated", "OrderView View Refreshed"
+ ]
+ }
+ }
+ }
+ ],
+ "examples": [
+ {
+ "AggregateId": "2-gbdstorefrontcust-2-P-4692-3606-50",
+ "CorrelationId": "ae7f8b49-f36a-4b6e-9444-8f22f11a6fe3",
+ "_rid": "s7l1AJVVwJcLwwIAAAAAAA==",
+ "id": "aa2ec6a5-baf9-43ff-9002-3d25892fbb2a",
+ "AggregateType": "OrderView",
+ "EventActionUser": null,
+ "EventDateTimeUtc": "2024-11-20T20:26:38.55",
+ "EventName": "OrderView Updated",
+ "EventNameValuePairs": null,
+ "EventPublisherApp": "OrderBroker ViewOrder Event Publisher",
+ "EventSchemaVersion": "1.6.1",
+ "EventSource": "OrderBroker",
+ "OrderView": {
+ "OmsCustomerId": "001146",
+ "OmsId": "1",
+ "OmsOrderId": "2-gbdstorefrontcust-2-P-4692-3606-50",
+ "OrderId": "2-gbdstorefrontcust-2-P-4692-3606-50",
+ "ReferenceId": "2-P-4692-3606-50",
+ "SourceSystemCustomerId": null,
+ "SourceSystemId": null,
+ "SourceSystemOrderId": null,
+ "AccessGroups": ["IN"],
+ "AffiliateIdentifier": 9,
+ "AffiliateName": "ZT - iHPqWad",
+ "BillTos": [
+ {
+ "Address1": "77185 Juan Ford Apt. 265",
+ "Address2": "",
+ "Address3": "",
+ "City": "Lovechester",
+ "Company": "",
+ "Country": "USA",
+ "EmailAddress": "cody09@example.com",
+ "FaxNumber": "",
+ "IsDeleted": null,
+ "Key": 0,
+ "Name": "Leslie Harmon",
+ "PhoneNumber": "377.454.4845",
+ "PostalCode": "52209",
+ "StateProvince": "Georgia"
+ }
+ ],
+ "CostCenter": "6342091000- IN Medicaid Case Mgmt",
+ "CreateDateTime": null,
+ "CreditCardFee": null,
+ "DefaultBillToKey": 0,
+ "DefaultOrderedByKey": 0,
+ "DefaultShipToKey": null,
+ "DueDate": null,
+ "LineItems": [
+ {
+ "OfferId": "1-001146-23788",
+ "ProductManagementSystemCustomerId": "001146",
+ "ProductManagementSystemId": 1,
+ "ReferenceId": null,
+ "VariableTemplatePrintId": null,
+ "AdditionalProperties": [],
+ "BillToKey": null,
+ "Comment": "1022385INMENABS Rev. 11/22 PM:https://xxxxx.cloudfront.net/temporary/example.pdf,e47de917-5db4-45dc-9079-203690246f0a.pdf",
+ "CostCenter": null,
+ "DueDate": null,
+ "IsDeleted": false,
+ "LineItemFee": 0,
+ "OfferDescription": "Important Phone Numbers Update SH MKT (IN)",
+ "OfferLineNumber": "15602",
+ "OfferNumber": "1022385INMENABS Rev. 11/22 PM",
+ "OrderedByKey": null,
+ "PONumber": null,
+ "Price": 35,
+ "Products": [],
+ "QuantityCanceled": null,
+ "QuantityOrdered": 1,
+ "RushOrder": null,
+ "ShipToKey": 0,
+ "Status": null,
+ "TaxAmount": 0
+ }
+ ],
+ "ModifiedDateTime": "2024-11-20T14:26:38",
+ "OmsCustomerName": "Ryan Griffin",
+ "OrderFee": null,
+ "OrderVariables": {},
+ "OrderedBys": [
+ {
+ "Address1": "28133 Derrick Rapids",
+ "Address2": "",
+ "Address3": "",
+ "City": "New Emilyside",
+ "Company": "",
+ "Country": "USA",
+ "EmailAddress": "sarah01@example.com",
+ "FaxNumber": "",
+ "IsDeleted": null,
+ "Key": 0,
+ "Name": "Dawn Conway",
+ "PhoneNumber": "+1-963-434-5913x919",
+ "PostalCode": 9945,
+ "StateProvince": "Montana"
+ }
+ ],
+ "PONumber": "",
+ "PaymentMethods": null,
+ "PickPackHandlingFee": null,
+ "RushOrder": false,
+ "ShipTos": null,
+ "ShippingHandlingTax": null,
+ "Statuses": ["Order In Process"],
+ "TotalOrderFee": null,
+ "TotalShippingCost": null
+ },
+ "_attachments": "attachments/",
+ "_etag": "\"080066e6-0000-0300-0000-673e47300000\"",
+ "_self": "dbs/s7l1AA==/colls/s7l1AJVVwJc=/docs/s7l1AJVVwJcLwwIAAAAAAA==/",
+ "_ts": 1732134704
+ }
+ ]
+}