Schema Changes - 2025-08-22
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 c330907..713e2c9 100644
--- a/schema/Api/CustomerBroker/CreateCustomerRequest.json
+++ b/schema/Api/CustomerBroker/CreateCustomerRequest.json
@@ -10,6 +10,18 @@
"type": "string",
"minLength": 1
},
+ "billingEntities": {
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "id" : { "type": ["string", "null"] },
+ "xmlSenderId" : { "type": ["string", "null"] },
+ "isDefaultForCustomer": { "type": ["boolean", "null"] }
+ }
+ }
+ },
"brokerScopes": { "type": ["array", "null"], "items": {"type": "string"} },
"contactAddress": {
"type": ["object", "null"],
@@ -139,7 +151,8 @@
"sourceSystemCustomerId": {
"description": "This is an automatically generated field added by middleware. It is considered read-only",
"type": "string"
- }
+ },
+ "name": { "type": ["string", "null"] }
},
"required": ["id", "sourceSystemCustomerId"]
}
diff --git a/schema/Api/CustomerBroker/GetCustomerResponse.json b/schema/Api/CustomerBroker/GetCustomerResponse.json
index bc1d34c..542fee3 100644
--- a/schema/Api/CustomerBroker/GetCustomerResponse.json
+++ b/schema/Api/CustomerBroker/GetCustomerResponse.json
@@ -14,6 +14,18 @@
"type": "string",
"minLength": 1
},
+ "billingEntities": {
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "id" : { "type": ["string", "null"] },
+ "xmlSenderId" : { "type": ["string", "null"] },
+ "isDefaultForCustomer": { "type": ["boolean", "null"] }
+ }
+ }
+ },
"brokerScopes": { "type": ["array", "null"], "items": {"type": "string"} },
"contactAddress": {
"type": ["object", "null"],
diff --git a/schema/Api/CustomerBroker/UpdateCustomerRequest.json b/schema/Api/CustomerBroker/UpdateCustomerRequest.json
index 61fa93d..584347c 100644
--- a/schema/Api/CustomerBroker/UpdateCustomerRequest.json
+++ b/schema/Api/CustomerBroker/UpdateCustomerRequest.json
@@ -10,6 +10,18 @@
"type": "string",
"minLength": 1
},
+ "billingEntities": {
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "id" : { "type": ["string", "null"] },
+ "xmlSenderId" : { "type": ["string", "null"] },
+ "isDefaultForCustomer": { "type": ["boolean", "null"] }
+ }
+ }
+ },
"brokerScopes": { "type": ["array", "null"], "items": {"type": "string"} },
"contactAddress": {
"type": ["object", "null"],
@@ -129,11 +141,13 @@
"type": "object",
"additionalProperties": false,
"properties": {
+ "authClientId": { "type": ["string", "null"] },
"id": {"type": "integer", "format": "int32"},
"sourceSystemCustomerId": {
"description": "This is an automatically generated field added by middleware. It is considered read-only",
"type": "string"
- }
+ },
+ "name": { "type": ["string", "null"] }
},
"required": ["id", "sourceSystemCustomerId"]
}
diff --git a/schema/Api/OfferBroker/InternalGetOffersResponse.json b/schema/Api/OfferBroker/InternalGetOffersResponse.json
index 4bd76f7..701a356 100644
--- a/schema/Api/OfferBroker/InternalGetOffersResponse.json
+++ b/schema/Api/OfferBroker/InternalGetOffersResponse.json
@@ -170,8 +170,7 @@
}
},
"required": ["id"]
- },
- "required": ["id"]
+ }
},
"requiresApproval": { "type": ["boolean", "null"] },
"schemaVersion": { "type": ["string", "null"] },
diff --git a/schema/Api/OfferBroker/UpdateOfferParameters.json b/schema/Api/OfferBroker/UpdateOfferParameters.json
index 6b5e6cb..b2c54d7 100644
--- a/schema/Api/OfferBroker/UpdateOfferParameters.json
+++ b/schema/Api/OfferBroker/UpdateOfferParameters.json
@@ -6,5 +6,11 @@
"name": "x-correlation-id",
"schema": {"type": "string"},
"required": false
+ },
+ "OfferId": {
+ "in": "path",
+ "name": "offerId",
+ "schema": {"type": "string"},
+ "required": true
}
}
diff --git a/schema/Api/OfferBroker/UpdateOfferRequest.json b/schema/Api/OfferBroker/UpdateOfferRequest.json
index 82682c2..c627311 100644
--- a/schema/Api/OfferBroker/UpdateOfferRequest.json
+++ b/schema/Api/OfferBroker/UpdateOfferRequest.json
@@ -13,9 +13,10 @@
],
"additionalProperties": false,
"properties": {
+ "offerId": { "type": ["string", "null"] },
"omsOfferId": {
"description": "Required. Unique offer identifier. Must not be empty.",
- "type": "string",
+ "type": ["string", "null"],
"minLength": 1
},
"xmPieTemplateId": { "type": ["string", "null"] },
@@ -165,5 +166,5 @@
"unitOfMeasure": { "type": ["string", "null"] },
"weightInPounds": { "type": ["number", "null"], "format": "float" }
},
- "required": ["number", "offerType", "omsOfferId"]
+ "required": ["number", "offerType"]
}
diff --git a/schema/Api/OrderBroker/InternalGetOrderParameters.json b/schema/Api/OrderBroker/InternalGetOrderParameters.json
new file mode 100644
index 0000000..e77939e
--- /dev/null
+++ b/schema/Api/OrderBroker/InternalGetOrderParameters.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/InternalGetOrderResponse.json b/schema/Api/OrderBroker/InternalGetOrderResponse.json
new file mode 100644
index 0000000..d89be67
--- /dev/null
+++ b/schema/Api/OrderBroker/InternalGetOrderResponse.json
@@ -0,0 +1,972 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "InternalGetOrderResponse.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",
+ "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"] },
+ "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": "integer",
+ "format": "int32"
+ },
+ "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": ["integer", "null"],
+ "format": "int32",
+ "minimum": 0
+ },
+ "defaultOrderedByKey": {
+ "description": "Unique ID for default ordered by contact details pulled from Order.OrderedBy.Key property (Only if applicable. Otherwise DefaultOrderedByKey will be null/empty value)",
+ "type": ["integer", "null"],
+ "format": "int32",
+ "minimum": 0
+ },
+ "defaultShipToKey": {
+ "description": "Unique ID for default ship to contact pulled from Order.ShipTos.Key property (Only if applicable. Otherwise DefaultShipToKey will be null/empty value) (NOTE: If this value is not set, ShipToKey must be set on all line items.)",
+ "type": ["integer", "null"],
+ "format": "int32",
+ "minimum": 0
+ },
+ "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": ["integer", "null"],
+ "format": "int32"
+ },
+ "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": ["integer", "null"],
+ "format": "int32"
+ },
+ "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": "Order.LineItems.Products level component details",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "productId": {
+ "description": "Unique ID for component product within Integration Broker",
+ "type": "string"
+ },
+ "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"]
+ },
+ "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": { "type": ["string", "null"] },
+ "productNumber": { "type": ["string", "null"] },
+ "productOwner": { "type": ["string", "null"] },
+ "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",
+ "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": ["integer", "null"],
+ "format": "int32"
+ },
+ "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": ["lineItemFee", "price", "quantityOrdered"]
+ },
+ "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.",
+ "type": ["array", "null"],
+ "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"] },
+ "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": "integer",
+ "format": "int32"
+ },
+ "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": {"type": "integer", "format": "int32"},
+ "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"] },
+ "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", "shippingHandlingTax", "billTos", "shipTos"
+ ],
+ "allOf": [
+ {
+ "description": "Either a defaultBillToKey must be provided, or the billTos array must be populated.",
+ "oneOf": [
+ {
+ "properties": { "defaultBillToKey": {"type": "integer"} },
+ "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": "integer"} },
+ "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": "integer"} },
+ "required": ["defaultBillToKey"]
+ },
+ {
+ "properties": {
+ "lineItems": {
+ "type": ["array", "null"],
+ "items": {
+ "type": "object",
+ "properties": { "billToKey": {"type": "integer", "minimum": 0} },
+ "required": ["billToKey"]
+ }
+ }
+ }
+ }
+ ]
+ },
+ {
+ "description": "If a defaultShipToKey is not provided at the root, each line item must specify a shipToKey.",
+ "oneOf": [
+ {
+ "properties": { "defaultShipToKey": {"type": "integer"} },
+ "required": ["defaultShipToKey"]
+ },
+ {
+ "properties": {
+ "lineItems": {
+ "type": ["array", "null"],
+ "items": {
+ "properties": { "shipToKey": {"type": "integer", "minimum": 0} },
+ "required": ["shipToKey"]
+ }
+ }
+ }
+ }
+ ]
+ },
+ {
+ "description": "If a defaultOrderedByKey is not provided at the root, each line item must specify an orderedByKey.",
+ "oneOf": [
+ {
+ "properties": { "defaultOrderedByKey": {"type": "integer"} },
+ "required": ["defaultOrderedByKey"]
+ },
+ {
+ "properties": {
+ "lineItems": {
+ "type": ["array", "null"],
+ "items": {
+ "properties": { "orderedByKey": {"type": "integer", "minimum": 0} },
+ "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/InternalNewOrderRequest.json b/schema/Api/OrderBroker/InternalNewOrderRequest.json
index 0114fa5..df20fe6 100644
--- a/schema/Api/OrderBroker/InternalNewOrderRequest.json
+++ b/schema/Api/OrderBroker/InternalNewOrderRequest.json
@@ -9,39 +9,30 @@
"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,
- "examples": ["123456789"]
+ "minLength": 1
},
- "referenceId": { "type": ["string", "null"], "maxLength": 255, "examples": ["REF123456"] },
+ "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,
- "examples": ["CUST123456"]
+ "minLength": 1
},
"sourceSystemId": {
"description": "Source system ID. Required, must not be null.",
"type": "integer",
- "format": "int32",
- "examples": [2, 12]
- },
- "accessGroups": {
- "type": ["array", "null"],
- "items": {"type": "string"},
- "examples": [ ["Group1", "Group2"] ]
+ "format": "int32"
},
+ "accessGroups": { "type": ["array", "null"], "items": {"type": "string"} },
"affiliateIdentifier": {
"description": "Unique ID for affiliate within source system (system where order was originally placed)",
"type": ["string", "null"],
- "maxLength": 100,
- "examples": ["AFF123456"]
+ "maxLength": 100
},
"affiliateName": {
"description": "Name for affiliate within source system (system where order was originally placed)",
"type": ["string", "null"],
- "maxLength": 255,
- "examples": ["Affiliate Name"]
+ "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.",
@@ -64,7 +55,11 @@
"type": ["string", "null"]
},
"faxNumber": { "description": "Fax number for address", "type": ["string", "null"] },
- "key": {"type": "integer", "format": "int32"},
+ "key": {
+ "description": "Unique ID for individual contact",
+ "type": "integer",
+ "format": "int32"
+ },
"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"},
@@ -74,58 +69,36 @@
},
"minItems": 1
}
- ],
- "examples": [
- {
- "address1": "106 Tyler Street Suite 175",
- "address2": "3181 George Vista",
- "address3": "",
- "city": "West Savannahside",
- "company": "Matthews, Mclean and Huynh",
- "country": "USA",
- "emailAddress": "ghunt@example.com",
- "faxNumber": "",
- "key": 0,
- "name": "Kristin Tyler",
- "phoneNumber": "001-990-377-8647x21426",
- "postalCode": "69532",
- "stateProvince": "Idaho"
- }
]
},
- "costCenter": { "type": ["string", "null"], "maxLength": 255, "examples": ["CC123456"] },
+ "costCenter": { "type": ["string", "null"], "maxLength": 255 },
"createDateTime": {
"description": "Datetime of when order was created",
- "type": ["string", "null"],
- "examples": ["2024-03-20T10:30:00Z"]
+ "type": ["string", "null"]
},
"creditCardFee": {
"description": "Credit card transaction fee applied to Order",
"type": ["number", "null"],
"format": "double",
- "minimum": 0,
- "examples": [2.5]
+ "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": ["integer", "null"],
"format": "int32",
- "minimum": 0,
- "examples": [1]
+ "minimum": 0
},
"defaultOrderedByKey": {
"description": "Unique ID for default ordered by contact details pulled from Order.OrderedBy.Key property (Only if applicable. Otherwise DefaultOrderedByKey will be null/empty value)",
"type": ["integer", "null"],
"format": "int32",
- "minimum": 0,
- "examples": [1]
+ "minimum": 0
},
"defaultShipToKey": {
"description": "Unique ID for default ship to contact pulled from Order.ShipTos.Key property (Only if applicable. Otherwise DefaultShipToKey will be null/empty value) (NOTE: If this value is not set, ShipToKey must be set on all line items.)",
"type": ["integer", "null"],
"format": "int32",
- "minimum": 0,
- "examples": [1]
+ "minimum": 0
},
"dueDate": {
"description": "Datetime of expected due date for Order. If present, must be a valid date and not in the past (enforced in backend).",
@@ -301,26 +274,13 @@
"required": ["lineItemFee", "price", "quantityOrdered"]
},
"minItems": 1,
- "uniqueItems": false,
- "examples": [
- [
- {
- "offerId": "OFFER123",
- "billToKey": 1,
- "offerLineNumber": "1",
- "quantity": 1,
- "shipToKey": 1,
- "unitPrice": 99.99
- }
- ]
- ]
+ "uniqueItems": false
},
"orderFee": {
"description": "Fee applied to Order",
"type": ["number", "null"],
"format": "double",
- "minimum": 0,
- "examples": [5.0]
+ "minimum": 0
},
"orderVariables": {
"description": "Manually entered variables for order within order management system (system where order lifecycle will be managed in)",
@@ -363,22 +323,6 @@
},
"minItems": 1
}
- ],
- "examples": [
- {
- "address1": "106 Tyler Street Suite 175",
- "address2": "3181 George Vista",
- "address3": "",
- "city": "West Savannahside",
- "company": "Matthews, Mclean and Huynh",
- "country": "USA",
- "emailAddress": "ghunt@example.com",
- "faxNumber": "",
- "key": 0,
- "phoneNumber": "001-990-377-8647x21426",
- "postalCode": "02019",
- "stateProvince": "Idaho"
- }
]
},
"paymentMethods": {
@@ -399,36 +343,22 @@
}
},
"required": ["amount", "methodName"]
- },
- "examples": [
- [
- {
- "type": "CREDIT_CARD",
- "amount": 99.99,
- "cardNumber": "4111111111111111",
- "cvv": "123",
- "expirationDate": "12/25"
- }
- ]
- ]
+ }
},
"pickPackHandlingFee": {
"description": "Sum of pick & pack handling fees for all Order.ShipTos",
"type": ["number", "null"],
"format": "double",
- "minimum": 0,
- "examples": [3.5]
+ "minimum": 0
},
"poNumber": {
"description": "Purchase order number for Order. Maximum length 20 characters.",
"type": ["string", "null"],
- "maxLength": 20,
- "examples": ["PO123456"]
+ "maxLength": 20
},
"rushOrder": {
"description": "True/false indicator if Order is expedited",
- "type": ["boolean", "null"],
- "examples": [true]
+ "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.",
@@ -499,45 +429,25 @@
"required": ["key"]
},
"minItems": 1,
- "uniqueItems": false,
- "examples": [
- [
- {
- "address": {
- "address1": "123 Main St",
- "city": "Anytown",
- "country": "US",
- "postalCode": "12345",
- "state": "CA"
- },
- "email": "john.doe@example.com",
- "key": 1,
- "name": "John Doe",
- "phone": "123-456-7890"
- }
- ]
- ]
+ "uniqueItems": false
},
"shippingHandlingTax": {
"description": "Sum of shipping & handling taxes for all Order.ShipTos. Required, must not be null.",
"type": "number",
"format": "double",
- "minimum": 0,
- "examples": [8.5]
+ "minimum": 0
},
"totalOrderFee": {
"description": "Sum of OrderFee",
"type": ["number", "null"],
"format": "double",
- "minimum": 0,
- "examples": [5.0]
+ "minimum": 0
},
"totalShippingCost": {
"description": "Sum of shipping cost for all Order.ShipTos.Shipments",
"type": ["number", "null"],
"format": "double",
- "minimum": 0,
- "examples": [10.0]
+ "minimum": 0
}
},
"required": [
diff --git a/schema/Api/OrderBroker/NewOrderRequest.json b/schema/Api/OrderBroker/NewOrderRequest.json
index aa3a24f..fdcea95 100644
--- a/schema/Api/OrderBroker/NewOrderRequest.json
+++ b/schema/Api/OrderBroker/NewOrderRequest.json
@@ -9,26 +9,19 @@
"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,
- "examples": ["123456789"]
- },
- "referenceId": { "type": ["string", "null"], "maxLength": 255, "examples": ["REF123456"] },
- "accessGroups": {
- "type": ["array", "null"],
- "items": {"type": "string"},
- "examples": [ ["Group1", "Group2"] ]
+ "minLength": 1
},
+ "referenceId": { "type": ["string", "null"], "maxLength": 255 },
+ "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,
- "examples": ["AFF123456"]
+ "maxLength": 100
},
"affiliateName": {
"description": "Name for affiliate within source system (system where order was originally placed)",
"type": ["string", "null"],
- "maxLength": 255,
- "examples": ["Affiliate Name"]
+ "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.",
@@ -61,58 +54,36 @@
},
"minItems": 1
}
- ],
- "examples": [
- {
- "address1": "106 Tyler Street Suite 175",
- "address2": "3181 George Vista",
- "address3": "",
- "city": "West Savannahside",
- "company": "Matthews, Mclean and Huynh",
- "country": "USA",
- "emailAddress": "ghunt@example.com",
- "faxNumber": "",
- "key": 0,
- "name": "Kristin Tyler",
- "phoneNumber": "001-990-377-8647x21426",
- "postalCode": "69532",
- "stateProvince": "Idaho"
- }
]
},
- "costCenter": { "type": ["string", "null"], "maxLength": 255, "examples": ["CC123456"] },
+ "costCenter": { "type": ["string", "null"], "maxLength": 255 },
"createDateTime": {
"description": "Datetime of when order was created",
- "type": ["string", "null"],
- "examples": ["2024-03-20T10:30:00Z"]
+ "type": ["string", "null"]
},
"creditCardFee": {
"description": "Credit card transaction fee applied to Order",
"type": ["number", "null"],
"format": "double",
- "minimum": 0,
- "examples": [2.5]
+ "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": ["integer", "null"],
"format": "int32",
- "minimum": 0,
- "examples": [1]
+ "minimum": 0
},
"defaultOrderedByKey": {
"description": "Unique ID for default ordered by contact details pulled from Order.OrderedBy.Key property (Only if applicable. Otherwise DefaultOrderedByKey will be null/empty value)",
"type": ["integer", "null"],
"format": "int32",
- "minimum": 0,
- "examples": [1]
+ "minimum": 0
},
"defaultShipToKey": {
"description": "Unique ID for default ship to contact pulled from Order.ShipTos.Key property (Only if applicable. Otherwise DefaultShipToKey will be null/empty value) (NOTE: If this value is not set, ShipToKey must be set on all line items.)",
"type": ["integer", "null"],
"format": "int32",
- "minimum": 0,
- "examples": [1]
+ "minimum": 0
},
"dueDate": {
"description": "Datetime of expected due date for Order. If present, must be a valid date and not in the past (enforced in backend).",
@@ -288,26 +259,13 @@
"required": ["lineItemFee", "price", "quantityOrdered"]
},
"minItems": 1,
- "uniqueItems": false,
- "examples": [
- [
- {
- "offerId": "OFFER123",
- "billToKey": 1,
- "offerLineNumber": "1",
- "quantity": 1,
- "shipToKey": 1,
- "unitPrice": 99.99
- }
- ]
- ]
+ "uniqueItems": false
},
"orderFee": {
"description": "Fee applied to Order",
"type": ["number", "null"],
"format": "double",
- "minimum": 0,
- "examples": [5.0]
+ "minimum": 0
},
"orderVariables": {
"description": "Manually entered variables for order within order management system (system where order lifecycle will be managed in)",
@@ -350,22 +308,6 @@
},
"minItems": 1
}
- ],
- "examples": [
- {
- "address1": "106 Tyler Street Suite 175",
- "address2": "3181 George Vista",
- "address3": "",
- "city": "West Savannahside",
- "company": "Matthews, Mclean and Huynh",
- "country": "USA",
- "emailAddress": "ghunt@example.com",
- "faxNumber": "",
- "key": 0,
- "phoneNumber": "001-990-377-8647x21426",
- "postalCode": "02019",
- "stateProvince": "Idaho"
- }
]
},
"paymentMethods": {
@@ -386,36 +328,22 @@
}
},
"required": ["amount", "methodName"]
- },
- "examples": [
- [
- {
- "type": "CREDIT_CARD",
- "amount": 99.99,
- "cardNumber": "4111111111111111",
- "cvv": "123",
- "expirationDate": "12/25"
- }
- ]
- ]
+ }
},
"pickPackHandlingFee": {
"description": "Sum of pick & pack handling fees for all Order.ShipTos",
"type": ["number", "null"],
"format": "double",
- "minimum": 0,
- "examples": [3.5]
+ "minimum": 0
},
"poNumber": {
"description": "Purchase order number for Order. Maximum length 20 characters.",
"type": ["string", "null"],
- "maxLength": 20,
- "examples": ["PO123456"]
+ "maxLength": 20
},
"rushOrder": {
"description": "True/false indicator if Order is expedited",
- "type": ["boolean", "null"],
- "examples": [true]
+ "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.",
@@ -486,45 +414,25 @@
"required": ["key"]
},
"minItems": 1,
- "uniqueItems": false,
- "examples": [
- [
- {
- "address": {
- "address1": "123 Main St",
- "city": "Anytown",
- "country": "US",
- "postalCode": "12345",
- "state": "CA"
- },
- "email": "john.doe@example.com",
- "key": 1,
- "name": "John Doe",
- "phone": "123-456-7890"
- }
- ]
- ]
+ "uniqueItems": false
},
"shippingHandlingTax": {
"description": "Sum of shipping & handling taxes for all Order.ShipTos. Required, must not be null.",
"type": "number",
"format": "double",
- "minimum": 0,
- "examples": [8.5]
+ "minimum": 0
},
"totalOrderFee": {
"description": "Sum of OrderFee",
"type": ["number", "null"],
"format": "double",
- "minimum": 0,
- "examples": [5.0]
+ "minimum": 0
},
"totalShippingCost": {
"description": "Sum of shipping cost for all Order.ShipTos.Shipments",
"type": ["number", "null"],
"format": "double",
- "minimum": 0,
- "examples": [10.0]
+ "minimum": 0
}
},
"required": [
diff --git a/schema/Event/FulfillmentOrder/FulfillmentOrder.json b/schema/Event/FulfillmentOrder/FulfillmentOrder.json
index 3e75b52..e2e00ef 100644
--- a/schema/Event/FulfillmentOrder/FulfillmentOrder.json
+++ b/schema/Event/FulfillmentOrder/FulfillmentOrder.json
@@ -29,24 +29,7 @@
"BillTo": {
"description": "Fulfillment order level bill to contact and address details",
"type": ["object", "null"],
- "items": {"$ref": "parts/BillTo.json"},
- "examples": [
- {
- "Address1": "106 Tyler Street Suite 175",
- "Address2": "3181 George Vista",
- "Address3": "",
- "City": "West Savannahside",
- "Company": "Matthews, Mclean and Huynh",
- "Country": "USA",
- "EmailAddress": "ghunt@example.com",
- "FaxNumber": "",
- "Key": 0,
- "Name": "Kristin Tyler",
- "PhoneNumber": "001-990-377-8647x21426",
- "PostalCode": "69532",
- "StateProvince": "Idaho"
- }
- ]
+ "items": {"$ref": "parts/BillTo.json"}
},
"CreateDateTime": {
"description": "Created date time of the fulfillment order",
@@ -87,74 +70,12 @@
"ShipTos": {
"description": "Fulfillment order level ship to details",
"type": ["array", "null"],
- "items": {"$ref": "parts/FOShipTo.json"},
- "examples": [
- {
- "FulfillmentSystemShippingMethodId": "FedEx Ground",
- "Comment": null,
- "DueDate": null,
- "Key": 0,
- "PONumber": null,
- "PaymentMethods": null,
- "RushOrder": null,
- "ShipToAddress": {
- "Address1": "21133 Mraz Estate",
- "Address2": null,
- "Address3": null,
- "City": "Port Novella",
- "Company": null,
- "Country": "United States",
- "EmailAddress": "Leda.Hudson@yahoo.com",
- "FaxNumber": "(389) 855-1980 x01354",
- "Name": "Gerard Hamill",
- "PhoneNumber": "778-483-8935",
- "PostalCode": "16141-8021",
- "StateProvince": "TX"
- },
- "ShippingCarrier": null,
- "ShippingCost": 10.0,
- "ShippingService": null,
- "Status": null
- }
- ]
+ "items": {"$ref": "parts/FOShipTo.json"}
},
"Shipments": {
"description": "Shipments tied to the fulfillment order",
"type": ["array", "null"],
- "items": {"$ref": "parts/Shipment.json"},
- "examples": [
- {
- "ShipmentId": "000000116",
- "Carrier": "Customer Pickup",
- "Freight": 0,
- "IsDeleted": null,
- "MasterTrackingNumber": null,
- "Packages": [
- {
- "IsDeleted": null,
- "PackageNumber": "1",
- "TrackingNumber": "TrackingNumber123123"
- }
- ],
- "PackingSlipNumber": "000000116",
- "Service": "Customer Pickup (H)",
- "ShipDateUtc": "2025-05-09T00:00:00",
- "ShipToAddress": {
- "Address1": "377 Mireille Causeway",
- "Address2": "Suite 048",
- "Address3": "",
- "City": "North Fridamouth",
- "Company": "Kidde Residential/Commercial Division",
- "Country": "United States",
- "EmailAddress": null,
- "FaxNumber": null,
- "Name": "Amya Kreiger",
- "PhoneNumber": "(984) 633-1221 x3373",
- "PostalCode": "76996",
- "StateProvince": "WA"
- }
- }
- ]
+ "items": {"$ref": "parts/Shipment.json"}
}
},
"required": [
diff --git a/schema/Event/FulfillmentOrder/parts/FOProduct.json b/schema/Event/FulfillmentOrder/parts/FOProduct.json
index f71f404..3372918 100644
--- a/schema/Event/FulfillmentOrder/parts/FOProduct.json
+++ b/schema/Event/FulfillmentOrder/parts/FOProduct.json
@@ -41,8 +41,7 @@
"ShipmentPackages": {
"description": "Shipment packages associated with this product line item",
"type": ["array", "null"],
- "items": {"$ref": "ShipmentPackage.json"},
- "examples": [ {"ShipmentId": "ShipmentId123", "PackageNumber": "1", "ShipQuantity": 2} ]
+ "items": {"$ref": "ShipmentPackage.json"}
},
"Status": { "description": "Status of product line item", "type": ["string", "null"] }
},
diff --git a/schema/Event/FulfillmentOrder/parts/FOShipTo.json b/schema/Event/FulfillmentOrder/parts/FOShipTo.json
index 075f34b..7eed87e 100644
--- a/schema/Event/FulfillmentOrder/parts/FOShipTo.json
+++ b/schema/Event/FulfillmentOrder/parts/FOShipTo.json
@@ -34,23 +34,7 @@
},
"ShipToAddress": {
"$ref": "ShipToAddress.json",
- "description": "Ship to addresses array for Order",
- "examples": [
- {
- "Address1": "106 Tyler Street Suite 175",
- "Address2": "3181 George Vista",
- "Address3": "",
- "City": "West Savannahside",
- "Company": "Matthews, Mclean and Huynh",
- "Country": "USA",
- "EmailAddress": "ghunt@example.com",
- "FaxNumber": "",
- "Key": 0,
- "PhoneNumber": "001-990-377-8647x21426",
- "PostalCode": "02019",
- "StateProvince": "Idaho"
- }
- ]
+ "description": "Ship to addresses array for Order"
},
"ShippingCarrier": { "description": "Shipping carrier", "type": ["string", "null"] },
"ShippingCost": {
diff --git a/schema/Event/FulfillmentOrder/parts/Shipment.json b/schema/Event/FulfillmentOrder/parts/Shipment.json
index 253f0bf..8270d67 100644
--- a/schema/Event/FulfillmentOrder/parts/Shipment.json
+++ b/schema/Event/FulfillmentOrder/parts/Shipment.json
@@ -12,39 +12,11 @@
"type": ["boolean", "null"]
},
"MasterTrackingNumber": { "type": ["string", "null"] },
- "Packages": {
- "type": ["array", "null"],
- "items": {"$ref": "Package.json"},
- "examples": [
- {
- "IsDeleted": null,
- "PackageNumber": "1",
- "TrackingNumber": "TrackingNumber123123"
- }
- ]
- },
+ "Packages": { "type": ["array", "null"], "items": {"$ref": "Package.json"} },
"PackingSlipNumber": { "type": ["string", "null"] },
"Service": { "type": ["string", "null"] },
"ShipDateUtc": { "type": ["string", "null"] },
- "ShipToAddress": {
- "$ref": "ShipToAddress.json",
- "examples": [
- {
- "Address1": "377 Mireille Causeway",
- "Address2": "Suite 048",
- "Address3": "",
- "City": "North Fridamouth",
- "Company": "Kidde Residential/Commercial Division",
- "Country": "United States",
- "EmailAddress": null,
- "FaxNumber": null,
- "Name": "Amya Kreiger",
- "PhoneNumber": "(984) 633-1221 x3373",
- "PostalCode": "76996",
- "StateProvince": "WA"
- }
- ]
- }
+ "ShipToAddress": {"$ref": "ShipToAddress.json"}
},
"required": ["ShipmentId", "Service", "ShipDateUtc", "Freight"]
}