cxtms 1.9.13

package/schemas/workflows/tasks/order.json

@@ -0,0 +1,139 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Order Tasks",
+  "description": "Order entity CRUD operations",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": [
+        "Order/Create@1",
+        "Order/Update@1",
+        "Order/Update@2",
+        "Order/Delete@1",
+        "Order/Get@1",
+        "Order/Copy@1",
+        "Order/Split@1",
+        "Order/Import@1",
+        "Order/RecalculateCharges@1",
+        "Order/GenerateTrackingNumber@1",
+        "Order/Purge@1",
+        "Order/GetCargoMovementByPalletQuery"
+      ],
+      "description": "Task type identifier"
+    },
+    "name": {
+      "type": "string",
+      "description": "Step name identifier"
+    },
+    "description": {
+      "type": "string",
+      "description": "Step description"
+    },
+    "conditions": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "expression": {
+            "type": "string"
+          }
+        },
+        "required": ["expression"]
+      }
+    },
+    "continueOnError": {
+      "type": "boolean"
+    },
+    "inputs": {
+      "type": "object",
+      "description": "Order operation inputs",
+      "properties": {
+        "orderId": {
+          "type": "string",
+          "description": "Order ID (for update/delete/get operations)"
+        },
+        "orderType": {
+          "type": "string",
+          "description": "Order type (for create operations)"
+        },
+        "entity": {
+          "type": "object",
+          "description": "Order entity data",
+          "additionalProperties": true
+        },
+        "partial": {
+          "type": "boolean",
+          "description": "Partial update (patch)"
+        },
+        "validateOnly": {
+          "type": "boolean",
+          "description": "Only validate, don't persist"
+        },
+        "data": {
+          "description": "Structured import data (for Order/Import@1)",
+          "additionalProperties": true
+        },
+        "options": {
+          "type": "object",
+          "description": "Import options (for Order/Import@1)",
+          "properties": {
+            "orderMatchByFields": {
+              "type": "array",
+              "items": { "type": "string" },
+              "description": "Fields to match existing orders. If null, creates new orders."
+            },
+            "contactMatchByFields": {
+              "type": "array",
+              "items": { "type": "string" },
+              "description": "Fields to match existing contacts for order entities."
+            },
+            "contactAddressMatchByFields": {
+              "type": "array",
+              "items": { "type": "string" },
+              "description": "Fields to match existing contact addresses within order entities."
+            },
+            "inventoryItemMatchByFields": {
+              "type": "array",
+              "items": { "type": "string" },
+              "description": "Fields to match existing inventory items on commodities."
+            },
+            "tagMatchByFields": {
+              "type": "array",
+              "items": { "type": "string" },
+              "description": "Fields to match existing tags."
+            },
+            "commodityMatchByFields": {
+              "type": "array",
+              "items": { "type": "string" },
+              "description": "Fields to match existing commodities."
+            },
+            "linkTrackingEventsToCommodities": {
+              "type": "boolean",
+              "description": "When true, imported tracking events are linked to the order's first-level (non-container) commodities. Default: false."
+            }
+          },
+          "additionalProperties": true
+        }
+      },
+      "additionalProperties": true
+    },
+    "outputs": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "mapping": {
+            "type": "string"
+          }
+        },
+        "required": ["name", "mapping"]
+      }
+    }
+  },
+  "required": ["task"],
+  "additionalProperties": true
+}

package/schemas/workflows/tasks/payment.json

@@ -0,0 +1,85 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Payment Tasks",
+  "description": "Payment processing operations",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": ["Payment/Create", "Payment/Create@1"],
+      "description": "Task type identifier"
+    },
+    "name": {
+      "type": "string",
+      "description": "Step name identifier"
+    },
+    "description": {
+      "type": "string",
+      "description": "Step description"
+    },
+    "conditions": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "expression": {
+            "type": "string"
+          }
+        },
+        "required": ["expression"]
+      }
+    },
+    "continueOnError": {
+      "type": "boolean"
+    },
+    "inputs": {
+      "type": "object",
+      "description": "Payment inputs",
+      "properties": {
+        "paymentId": {
+          "type": "string",
+          "description": "Payment ID"
+        },
+        "amount": {
+          "type": "number",
+          "description": "Payment amount"
+        },
+        "customerId": {
+          "type": "string",
+          "description": "Customer contact ID"
+        },
+        "invoiceId": {
+          "type": "string",
+          "description": "Invoice to apply payment to"
+        },
+        "paymentMethod": {
+          "type": "string",
+          "description": "Payment method"
+        },
+        "entity": {
+          "type": "object",
+          "description": "Payment entity data",
+          "additionalProperties": true
+        }
+      },
+      "additionalProperties": true
+    },
+    "outputs": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "mapping": {
+            "type": "string"
+          }
+        },
+        "required": ["name", "mapping"]
+      }
+    }
+  },
+  "required": ["task"],
+  "additionalProperties": true
+}

package/schemas/workflows/tasks/pdf-document.json

@@ -0,0 +1,60 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "PDF Document Tasks",
+  "description": "PDF document operations",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": [
+        "PdfDocument/Merge@1"
+      ],
+      "description": "Task type identifier"
+    },
+    "name": {
+      "type": "string",
+      "description": "Step name identifier"
+    },
+    "description": {
+      "type": "string",
+      "description": "Step description"
+    },
+    "conditions": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "expression": { "type": "string" }
+        },
+        "required": ["expression"]
+      }
+    },
+    "continueOnError": {
+      "type": "boolean"
+    },
+    "inputs": {
+      "type": "object",
+      "description": "PDF document operation inputs",
+      "properties": {
+        "documents": {
+          "type": "array",
+          "description": "Array of PDF documents to merge"
+        }
+      },
+      "additionalProperties": true
+    },
+    "outputs": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": { "type": "string" },
+          "mapping": { "type": "string" }
+        },
+        "required": ["name", "mapping"]
+      }
+    }
+  },
+  "required": ["task"],
+  "additionalProperties": true
+}

package/schemas/workflows/tasks/postal-codes.json

@@ -0,0 +1,92 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "PostalCodes Import Task",
+  "description": "Import postal codes from file, URL, or direct data",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": ["PostalCodes/Import@1"],
+      "description": "Task type identifier"
+    },
+    "name": {
+      "type": "string",
+      "description": "Step name identifier"
+    },
+    "description": {
+      "type": "string",
+      "description": "Step description"
+    },
+    "conditions": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "expression": {
+            "type": "string"
+          }
+        },
+        "required": ["expression"]
+      }
+    },
+    "continueOnError": {
+      "type": "boolean"
+    },
+    "inputs": {
+      "type": "object",
+      "description": "PostalCodes/Import inputs — provide fileUrl, stream, or postalCodes",
+      "properties": {
+        "fileUrl": {
+          "type": "string",
+          "description": "URL to import file (CSV, XLSX, JSON, XML). File type is auto-detected from URL extension."
+        },
+        "fileType": {
+          "type": "string",
+          "enum": ["Csv", "Xlsx", "Json", "Xml", "Html"],
+          "description": "File format. Required when using stream input; auto-detected from fileUrl otherwise."
+        },
+        "stream": {
+          "description": "Raw stream data (binary). Requires fileType to be set."
+        },
+        "postalCodes": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "Code": { "type": "string" },
+              "CountryCode": { "type": "string" },
+              "PlaceName": { "type": "string" },
+              "StateCode": { "type": "string" },
+              "Latitude": { "type": "number" },
+              "Longitude": { "type": "number" },
+              "TimeZone": { "type": "string" },
+              "CustomValues": { "type": "object", "additionalProperties": true }
+            },
+            "required": ["Code", "CountryCode", "PlaceName"]
+          },
+          "description": "Direct postal code objects for import"
+        },
+        "matchByFields": {
+          "type": "array",
+          "items": { "type": "string" },
+          "description": "Fields to match existing records for upsert (e.g. ['Code', 'CountryCode'])"
+        }
+      },
+      "additionalProperties": true
+    },
+    "outputs": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": { "type": "string" },
+          "mapping": { "type": "string" }
+        },
+        "required": ["name", "mapping"]
+      },
+      "description": "Outputs: result.success (boolean), result.added (int), result.updated (int), result.totalProcessed (int), result.errors (string[]), result.hasErrors (boolean)"
+    }
+  },
+  "required": ["task", "name", "inputs"],
+  "additionalProperties": true
+}

package/schemas/workflows/tasks/resolve-timezone.json

@@ -0,0 +1,65 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "ResolveTimezone Task",
+  "description": "Resolve IANA timezone ID and UTC offset from geographic coordinates",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": ["Utilities/ResolveTimezone@1"],
+      "description": "Task type identifier"
+    },
+    "name": {
+      "type": "string",
+      "description": "Step name identifier"
+    },
+    "description": {
+      "type": "string",
+      "description": "Step description"
+    },
+    "conditions": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "expression": {
+            "type": "string"
+          }
+        },
+        "required": ["expression"]
+      }
+    },
+    "continueOnError": {
+      "type": "boolean"
+    },
+    "inputs": {
+      "type": "object",
+      "description": "ResolveTimezone inputs",
+      "properties": {
+        "latitude": {
+          "type": ["string", "number"],
+          "description": "Latitude coordinate (decimal degrees)"
+        },
+        "longitude": {
+          "type": ["string", "number"],
+          "description": "Longitude coordinate (decimal degrees)"
+        }
+      },
+      "required": ["latitude", "longitude"],
+      "additionalProperties": true
+    },
+    "outputs": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": { "type": "string" },
+          "mapping": { "type": "string" }
+        },
+        "required": ["name", "mapping"]
+      },
+      "description": "Outputs: timezoneId (IANA timezone string, e.g. 'America/Chicago'), utcOffset (number, hours from UTC, e.g. -5)"
+    }
+  },
+  "required": ["task", "name", "inputs"]
+}

package/schemas/workflows/tasks/setVariable.json

@@ -0,0 +1,76 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "SetVariable Task",
+  "description": "Set or update workflow variables",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": ["Utilities/SetVariable", "Utilities/SetVariable@1"],
+      "description": "Task type identifier"
+    },
+    "name": {
+      "type": "string",
+      "description": "Step name identifier"
+    },
+    "description": {
+      "type": "string",
+      "description": "Step description"
+    },
+    "conditions": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "expression": {
+            "type": "string"
+          }
+        },
+        "required": ["expression"]
+      }
+    },
+    "continueOnError": {
+      "type": "boolean"
+    },
+    "inputs": {
+      "type": "object",
+      "description": "SetVariable inputs",
+      "properties": {
+        "variables": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string",
+                "description": "Variable name to set"
+              },
+              "value": {
+                "description": "Value to assign (can be expression, template, or complex object)"
+              }
+            },
+            "required": ["name", "value"]
+          }
+        }
+      },
+      "additionalProperties": true
+    },
+    "outputs": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "mapping": {
+            "type": "string"
+          }
+        },
+        "required": ["name", "mapping"]
+      }
+    }
+  },
+  "required": ["task"],
+  "additionalProperties": true
+}

package/schemas/workflows/tasks/switch.json

@@ -0,0 +1,75 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Switch Task",
+  "description": "Conditional branching with multiple cases",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "const": "switch",
+      "description": "Task type identifier"
+    },
+    "name": {
+      "type": "string",
+      "description": "Step name identifier"
+    },
+    "description": {
+      "type": "string",
+      "description": "Step description"
+    },
+    "conditions": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "expression": {
+            "type": "string"
+          }
+        },
+        "required": ["expression"]
+      },
+      "description": "Conditions for execution"
+    },
+    "continueOnError": {
+      "type": "boolean",
+      "description": "Continue on error"
+    },
+    "cases": {
+      "type": "array",
+      "description": "Switch cases",
+      "items": {
+        "type": "object",
+        "properties": {
+          "when": {
+            "type": "string",
+            "description": "Condition expression for this case"
+          },
+          "steps": {
+            "type": "array",
+            "items": {
+              "$ref": "generic.json"
+            },
+            "minItems": 1
+          }
+        },
+        "required": ["when", "steps"],
+        "additionalProperties": true
+      },
+      "minItems": 1
+    },
+    "default": {
+      "type": "object",
+      "description": "Default case if no conditions match",
+      "properties": {
+        "steps": {
+          "type": "array",
+          "items": {
+            "$ref": "generic.json"
+          }
+        }
+      }
+    }
+  },
+  "required": ["task", "cases"],
+  "additionalProperties": true
+}

package/schemas/workflows/tasks/template.json

@@ -0,0 +1,73 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Template Task",
+  "description": "Render templates using Handlebars",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": ["Utilities/Template@1"],
+      "description": "Task type identifier"
+    },
+    "name": {
+      "type": "string",
+      "description": "Step name identifier"
+    },
+    "description": {
+      "type": "string",
+      "description": "Step description"
+    },
+    "conditions": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "expression": {
+            "type": "string"
+          }
+        },
+        "required": ["expression"]
+      }
+    },
+    "continueOnError": {
+      "type": "boolean"
+    },
+    "inputs": {
+      "type": "object",
+      "description": "Template inputs",
+      "properties": {
+        "template": {
+          "type": "string",
+          "description": "Handlebars template string"
+        },
+        "data": {
+          "description": "Data to pass to template"
+        },
+        "helpers": {
+          "type": "object",
+          "description": "Custom Handlebars helpers",
+          "additionalProperties": true
+        }
+      },
+      "required": ["template"],
+      "additionalProperties": true
+    },
+    "outputs": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "mapping": {
+            "type": "string"
+          }
+        },
+        "required": ["name", "mapping"]
+      }
+    }
+  },
+  "required": ["task"],
+  "additionalProperties": true
+}