Merge pull request #16 from servicetitan/schema-update-9f597e98caab96fe2914417f9e1e07e01ededf98-30

hill-rob · web-flow · commit 276c483d11ce · 2025-10-30T06:01:13.000-07:00
Update API contract schemas
diff --git a/st-schemas/account/response.json b/st-schemas/account/response.json
@@ -2,7 +2,7 @@
   "$schema": "http://json-schema.org/draft-04/schema#",
   "title": "account.response",
   "type": "object",
-  "description": "Response for activating a customer's vendor account (updated)",
+  "description": "Response for activating a customer's vendor account",
   "additionalProperties": false,
   "properties": {
     "errorCode": {
@@ -164,6 +164,16 @@
           "additionalProperties": {
             "type": "string"
           }
+        },
+        "vendorIdentifiers": {
+          "type": [
+            "null",
+            "object"
+          ],
+          "description": "A map of identifiers specific to the Vendor, which will be passed back to the vendor on subsequent calls",
+          "additionalProperties": {
+            "type": "string"
+          }
         }
       }
     }
diff --git a/st-schemas/account/response.sample.json b/st-schemas/account/response.sample.json
@@ -11,7 +11,8 @@
       "subAccountId": "subAccountId",
       "name": "name",
       "postalCode": "postalCode",
-      "customFields": {}
+      "customFields": {},
+      "vendorIdentifiers": {}
     }
   ],
   "hasMorePages": false,
diff --git a/st-schemas/accounts/response.json b/st-schemas/accounts/response.json
@@ -151,6 +151,16 @@
           "additionalProperties": {
             "type": "string"
           }
+        },
+        "vendorIdentifiers": {
+          "type": [
+            "null",
+            "object"
+          ],
+          "description": "A map of identifiers specific to the Vendor, which will be passed back to the vendor on subsequent calls",
+          "additionalProperties": {
+            "type": "string"
+          }
         }
       }
     }
diff --git a/st-schemas/accounts/response.sample.json b/st-schemas/accounts/response.sample.json
@@ -17,7 +17,8 @@
           "subAccountId": "subAccountId",
           "name": "name",
           "postalCode": "postalCode",
-          "customFields": {}
+          "customFields": {},
+          "vendorIdentifiers": {}
         }
       ],
       "vendorIdentifiers": {}
diff --git a/st-schemas/bulk-pricing/response.sample.json b/st-schemas/bulk-pricing/response.sample.json
@@ -24,7 +24,7 @@
           "disposition": null,
           "status": "status",
           "message": "message",
-          "startingDate": "2025-10-06T18:54:41.1462463+00:00"
+          "startingDate": "2025-10-30T12:58:35.1070012+00:00"
         }
       ]
     }
diff --git a/st-schemas/field-configuration-callbackname/request.sample.json b/st-schemas/field-configuration-callbackname/request.sample.json
@@ -6,7 +6,7 @@
   "callbackName": "callbackName",
   "purchaseOrder": {
     "supplierBranchId": "supplierBranchId",
-    "dateRequired": "2025-10-06T18:54:41.3935852+00:00",
+    "dateRequired": "2025-10-30T12:58:35.3448997+00:00",
     "amount": 0.0,
     "shipTo": null,
     "isVendorCounterPickup": false,
diff --git a/st-schemas/pricing/response.sample.json b/st-schemas/pricing/response.sample.json
@@ -24,7 +24,7 @@
           "disposition": null,
           "status": "status",
           "message": "message",
-          "startingDate": "2025-10-06T18:54:41.1008119+00:00"
+          "startingDate": "2025-10-30T12:58:35.0580453+00:00"
         }
       ]
     }
diff --git a/st-schemas/purchase-history-options/response.json b/st-schemas/purchase-history-options/response.json
@@ -106,7 +106,7 @@
       "properties": {
         "id": {
           "type": "string",
-          "description": "Idenitifer for the sub option to be used in purchase history request in Values Collection. Presented to user in a dropdown\ne.g. templatId, dateRange, etc."
+          "description": "Identifier for the sub option to be used in purchase history request in Values Collection. Presented to user in a dropdown\ne.g. templatId, dateRange, etc."
         },
         "name": {
           "type": "string",
diff --git a/st-schemas/purchaseorder/request.sample.json b/st-schemas/purchaseorder/request.sample.json
@@ -8,8 +8,8 @@
     "accountId": "accountId",
     "number": "number",
     "orderReferenceNumber": "orderReferenceNumber",
-    "requiredOn": "2025-10-06T18:54:41.1828052+00:00",
-    "date": "2025-10-06T18:54:41.1828109+00:00",
+    "requiredOn": "2025-10-30T12:58:35.1454147+00:00",
+    "date": "2025-10-30T12:58:35.1454215+00:00",
     "createdBy": "createdBy",
     "tax": 0.0,
     "shippingAmount": 0.0,
diff --git a/st-schemas/purchaseorderstatus/request.sample.json b/st-schemas/purchaseorderstatus/request.sample.json
@@ -8,8 +8,8 @@
     "accountId": "accountId",
     "number": "number",
     "orderReferenceNumber": "orderReferenceNumber",
-    "requiredOn": "2025-10-06T18:54:41.2262559+00:00",
-    "date": "2025-10-06T18:54:41.2262618+00:00",
+    "requiredOn": "2025-10-30T12:58:35.1848598+00:00",
+    "date": "2025-10-30T12:58:35.1848660+00:00",
     "createdBy": "createdBy",
     "tax": 0.0,
     "shippingAmount": 0.0,
diff --git a/st-schemas/purchaseorderstatus/response.sample.json b/st-schemas/purchaseorderstatus/response.sample.json
@@ -10,7 +10,7 @@
     "requestId": "requestId",
     "confirmationNumber": "confirmationNumber",
     "orderNumber": "orderNumber",
-    "createdBy": "2025-10-06T18:54:41.2590630+00:00",
+    "createdBy": "2025-10-30T12:58:35.2051654+00:00",
     "orderType": "orderType",
     "deliveryService": "deliveryService",
     "orderReferenceNumber": "orderReferenceNumber",
@@ -23,8 +23,8 @@
     {
       "instructionsTypeCode": "instructionsTypeCode",
       "instructions": "instructions",
-      "fromTime": "2025-10-06T18:54:41.2591100+00:00",
-      "toTime": "2025-10-06T18:54:41.2591149+00:00",
+      "fromTime": "2025-10-30T12:58:35.2052170+00:00",
+      "toTime": "2025-10-30T12:58:35.2052215+00:00",
       "timeZoneCode": "timeZoneCode"
     }
   ],
@@ -56,9 +56,9 @@
       "shipmentNumber": "shipmentNumber",
       "status": "status",
       "total": 0.0,
-      "deliveryRequestedOn": "2025-10-06T18:54:41.2592637+00:00",
-      "deliveredOn": "2025-10-06T18:54:41.2592684+00:00",
-      "invoicedOn": "2025-10-06T18:54:41.2592721+00:00",
+      "deliveryRequestedOn": "2025-10-30T12:58:35.2053144+00:00",
+      "deliveredOn": "2025-10-30T12:58:35.2053188+00:00",
+      "invoicedOn": "2025-10-30T12:58:35.2053228+00:00",
       "lines": [
         {
           "id": "id",
diff --git a/st-schemas/register/response.json b/st-schemas/register/response.json
@@ -164,6 +164,16 @@
           "additionalProperties": {
             "type": "string"
           }
+        },
+        "vendorIdentifiers": {
+          "type": [
+            "null",
+            "object"
+          ],
+          "description": "A map of identifiers specific to the Vendor, which will be passed back to the vendor on subsequent calls",
+          "additionalProperties": {
+            "type": "string"
+          }
         }
       }
     }
diff --git a/st-schemas/register/response.sample.json b/st-schemas/register/response.sample.json
@@ -11,7 +11,8 @@
       "subAccountId": "subAccountId",
       "name": "name",
       "postalCode": "postalCode",
-      "customFields": {}
+      "customFields": {},
+      "vendorIdentifiers": {}
     }
   ],
   "hasMorePages": false,
diff --git a/st-schemas/stock-level/response.sample.json b/st-schemas/stock-level/response.sample.json
@@ -17,7 +17,7 @@
           "disposition": null,
           "status": "status",
           "message": "message",
-          "startingDate": "2025-10-06T18:54:41.2801958+00:00"
+          "startingDate": "2025-10-30T12:58:35.2272097+00:00"
         }
       ]
     }
diff --git a/st-schemas/subaccount/response.json b/st-schemas/subaccount/response.json
@@ -101,6 +101,16 @@
           "additionalProperties": {
             "type": "string"
           }
+        },
+        "vendorIdentifiers": {
+          "type": [
+            "null",
+            "object"
+          ],
+          "description": "A map of identifiers specific to the Vendor, which will be passed back to the vendor on subsequent calls",
+          "additionalProperties": {
+            "type": "string"
+          }
         }
       }
     }
diff --git a/st-schemas/subaccount/response.sample.json b/st-schemas/subaccount/response.sample.json
@@ -10,7 +10,8 @@
       "subAccountId": "subAccountId",
       "name": "name",
       "postalCode": "postalCode",
-      "customFields": {}
+      "customFields": {},
+      "vendorIdentifiers": {}
     }
   ],
   "$schema": "./subaccount.response.schema.json"

Original file line number	Diff line number	Diff line change
`@@ -151,6 +151,16 @@`
`151`	`151`	`"additionalProperties": {`
`152`	`152`	`"type": "string"`
`153`	`153`	`}`
	`154`	`+ },`
	`155`	`+ "vendorIdentifiers": {`
	`156`	`+ "type": [`
	`157`	`+ "null",`
	`158`	`+ "object"`
	`159`	`+ ],`
	`160`	`+ "description": "A map of identifiers specific to the Vendor, which will be passed back to the vendor on subsequent calls",`
	`161`	`+ "additionalProperties": {`
	`162`	`+ "type": "string"`
	`163`	`+ }`
`154`	`164`	`}`
`155`	`165`	`}`
`156`	`166`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`	`"disposition": null,`
`25`	`25`	`"status": "status",`
`26`	`26`	`"message": "message",`
`27`		`- "startingDate": "2025-10-06T18:54:41.1462463+00:00"`
	`27`	`+ "startingDate": "2025-10-30T12:58:35.1070012+00:00"`
`28`	`28`	`}`
`29`	`29`	`]`
`30`	`30`	`}`