Order Workflow Tasks

Order tasks are used to create, update, and delete Orders.

Create Order

task: "Order/Create@1"
name: createOrder
inputs: 
  values:
    billToContactId: "{{ billToContactId }}"
    customValues: "{{ customValues }}"
    divisionId: "{{ divisionId }}"
    employeeContactId: "{{ employeeContactId }}"
    entityTypeId: "{{ entityTypeId }}"
    equipmentTypeId: "{{ equipmentTypeId }}"
    lastOrderStatusModified: "{{ lastOrderStatusModified }}"
    orderNumber: "{{ orderNumber }}"
    orderStatusId: "{{ orderStatusId }}"
    orderType: "{{ orderType }}"
    salespersonContactId: "{{ salespersonContactId }}"
    trackingNumber: "{{ trackingNumber }}"
outputs:
  - name: order
    mapping: "order"

Get Order

task: "Order/Get@1"
name: getOrder
inputs: 
  orderId: "123"

outputs:
  - name: order
    mapping: "order"

Update Order

task: "Order/Update@1"
name: updateOrder
inputs: 
  orderId: "123"
  values: 
    billToContactId: "{{ billToContactId }}"
    customValues: "{{ customValues }}"
    divisionId: "{{ divisionId }}"
    employeeContactId: "{{ employeeContactId }}"
    entityTypeId: "{{ entityTypeId }}"
    equipmentTypeId: "{{ equipmentTypeId }}"
    lastOrderStatusModified: "{{ lastOrderStatusModified }}"
    orderNumber: "{{ orderNumber }}"
    orderStatusId: "{{ orderStatusId }}"
    orderType: "{{ orderType }}"
    salespersonContactId: "{{ salespersonContactId }}"
    trackingNumber: "{{ trackingNumber }}"

Delete Order

task: "Order/Delete@1"
name: deleteOrder
inputs: 
  orderId: "123"

Example Order Workflow

workflow:
  name: "Order / Create Order Example Workflow" 
  description: "Create Order Example Workflow"
  version: "1.0" 
  executionMode: "Sync"

inputs:
  - name: "billToContactId"
    type: "Contact"
    displayName: "Bill to contact id"
    description: "Bill to contact id"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "order.billToContactId"
  - name: "customValues"
    type: "string,string"
    displayName: "Custom values"
    description: "Custom values"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "order.customValues"
  - name: "divisionId"
    type: "Division"
    displayName: "Division id"
    description: "Division id"
    multiple: false
    required: true
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "order.divisionId"
  - name: "employeeContactId"
    type: "Contact"
    displayName: "Employee contact id"
    description: "Employee contact id"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "order.employeeContactId"
  - name: "entityTypeId"
    type: "EntityType"
    displayName: "Entity type id"
    description: "Entity type id"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "order.entityTypeId"
  - name: "equipmentTypeId"
    type: "EquipmentType"
    displayName: "Equipment type id"
    description: "Equipment type id"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "order.equipmentTypeId"
  - name: "lastOrderStatusModified"
    type: "Date"
    displayName: "Last order status modified"
    description: "Last order status modified"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "order.lastOrderStatusModified"
  - name: "orderNumber"
    type: "string"
    displayName: "Order number"
    description: "Order number"
    multiple: false
    required: true
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "order.orderNumber"
  - name: "orderStatusId"
    type: "OrderStatus"
    displayName: "Order status id"
    description: "Order status id"
    multiple: false
    required: true
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "order.orderStatusId"
  - name: "orderType"
    type: "OrderTypes"
    displayName: "Order type"
    description: "Order type"
    multiple: false
    required: true
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "order.orderType"
  - name: "salespersonContactId"
    type: "Contact"
    displayName: "Salesperson contact id"
    description: "Salesperson contact id"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "order.salespersonContactId"
  - name: "trackingNumber"
    type: "string"
    displayName: "Tracking number"
    description: "Tracking number"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "order.trackingNumber"

outputs:
  - name: order
    mapping: "createOrderActivity.createOrder.order"

activities:
  - name: "createOrderActivity"
    description: "Create Order"
    steps:
      - task: "Order/Create@1"
        name: createOrder
        inputs: 
          order:
            billToContactId: "{{ billToContactId }}"
            customValues: "{{ customValues }}"
            divisionId: "{{ divisionId }}"
            employeeContactId: "{{ employeeContactId }}"
            entityTypeId: "{{ entityTypeId }}"
            equipmentTypeId: "{{ equipmentTypeId }}"
            lastOrderStatusModified: "{{ lastOrderStatusModified }}"
            orderNumber: "{{ orderNumber }}"
            orderStatusId: "{{ orderStatusId }}"
            orderType: "{{ orderType }}"
            salespersonContactId: "{{ salespersonContactId }}"
            trackingNumber: "{{ trackingNumber }}"
        outputs:
          - name: order
            mapping: "order"
  - name: "getOrderActivity"
    description: "Get Order"
    steps:
      - task: "Order/Get@1"
        name: getOrder
        inputs: 
          orderId: "{{ createOrderActivity.createOrder.order.orderId }}"
        outputs:
          - name: orderFromGet
            mapping: "order"
  - name: "updateOrderActivity"
    description: "Update Order"
    steps:
      - task: "Order/Update@1"
        name: updateOrder
        inputs: 
          orderId: "{{ getOrderActivity.getOrder.order.orderId }}"
          order:
            billToContactId: "{{ billToContactId }}"
            customValues: "{{ customValues }}"
            divisionId: "{{ divisionId }}"
            employeeContactId: "{{ employeeContactId }}"
            entityTypeId: "{{ entityTypeId }}"
            equipmentTypeId: "{{ equipmentTypeId }}"
            lastOrderStatusModified: "{{ lastOrderStatusModified }}"
            orderNumber: "{{ orderNumber }}"
            orderStatusId: "{{ orderStatusId }}"
            orderType: "{{ orderType }}"
            salespersonContactId: "{{ salespersonContactId }}"
            trackingNumber: "{{ trackingNumber }}"
  - name: "deleteOrderActivity"
    description: "Delete Order"
    steps:
      - task: "Order/Delete@1"
        name: deleteOrder
        inputs: 
          orderId: "{{ getOrderActivity.getOrder.order.orderId }}"