Skip to main content

Commodity Workflow Tasks

Commodity tasks are used to create, update, and delete Commoditys.

Create Commodity​

task: "Commodity/Create@1"
name: createCommodity
inputs: 
  values:
    commodityStatusId: "{{ commodityStatusId }}"
    commodityTypeId: "{{ commodityTypeId }}"
    containerCommodityId: "{{ containerCommodityId }}"
    customValues: "{{ customValues }}"
    description: "{{ description }}"
    dimensionsUnit: "{{ dimensionsUnit }}"
    height: "{{ height }}"
    jobId: "{{ jobId }}"
    length: "{{ length }}"
    note: "{{ note }}"
    packageTypeId: "{{ packageTypeId }}"
    pieces: "{{ pieces }}"
    quantity: "{{ quantity }}"
    unit: "{{ unit }}"
    unitaryValue: "{{ unitaryValue }}"
    valueByTotal: "{{ valueByTotal }}"
    volumePiece: "{{ volumePiece }}"
    volumeTotal: "{{ volumeTotal }}"
    volumeUnit: "{{ volumeUnit }}"
    warehouseLocationId: "{{ warehouseLocationId }}"
    weight: "{{ weight }}"
    weightByTotal: "{{ weightByTotal }}"
    weightTotal: "{{ weightTotal }}"
    weightUnit: "{{ weightUnit }}"
    width: "{{ width }}"
outputs:
  - name: commodity
    mapping: "commodity"

Get Commodity​

task: "Commodity/Get@1"
name: getCommodity
inputs: 
  commodityId: "123"

outputs:
  - name: commodity
    mapping: "commodity"

Update Commodity​

task: "Commodity/Update@1"
name: updateCommodity
inputs: 
  commodityId: "123"
  values: 
    commodityStatusId: "{{ commodityStatusId }}"
    commodityTypeId: "{{ commodityTypeId }}"
    containerCommodityId: "{{ containerCommodityId }}"
    customValues: "{{ customValues }}"
    description: "{{ description }}"
    dimensionsUnit: "{{ dimensionsUnit }}"
    height: "{{ height }}"
    jobId: "{{ jobId }}"
    length: "{{ length }}"
    note: "{{ note }}"
    packageTypeId: "{{ packageTypeId }}"
    pieces: "{{ pieces }}"
    quantity: "{{ quantity }}"
    unit: "{{ unit }}"
    unitaryValue: "{{ unitaryValue }}"
    valueByTotal: "{{ valueByTotal }}"
    volumePiece: "{{ volumePiece }}"
    volumeTotal: "{{ volumeTotal }}"
    volumeUnit: "{{ volumeUnit }}"
    warehouseLocationId: "{{ warehouseLocationId }}"
    weight: "{{ weight }}"
    weightByTotal: "{{ weightByTotal }}"
    weightTotal: "{{ weightTotal }}"
    weightUnit: "{{ weightUnit }}"
    width: "{{ width }}"

Delete Commodity​

task: "Commodity/Delete@1"
name: deleteCommodity
inputs: 
  commodityId: "123"

Repack Commodity​

Repack Commodity is used to repack a commodity into a new container.

Parameters:

  • commodityIds - list of commodity ids to repack
  • container - new container values

Options:

  • unwrap - Content Items will be unwrapped and added to new container
  • unwrappedStatus - Unwrapped container status
  • copyContent - copy content items instead of moving them
  • deleteOldContainer - optional, default is false
  • container - new container values

Output:

  • container - new container commodity
task: "Commodity/Repack@1"
name: repackCommodity
inputs: 
  commodityIds: "{{ commodityIds }}" # list of commodity ids to repack
  options:
    unwrap: false # Content Items will be unwrapped and added to new container
    unwrappedStatus: "Repacked" # Unwrapped container status 
    copyContent: false # copy content items instead of moving them
    deleteOldContainer: false # optional, default is false
    copyTrackingNumbers: false # optional, default is false
  container:
      commodityStatusId: "{{ commodityStatusId }}"
      commodityTypeId: "{{ commodityTypeId }}"
      containerCommodityId: "{{ containerCommodityId }}"
      customValues: "{{ customValues }}"
      description: "{{ description }}"
      dimensionsUnit: "{{ dimensionsUnit }}"
      height: "{{ height }}"
      length: "{{ length }}"
      width: "{{ width }}"
      jobId: "{{ jobId }}" 
      note: "{{ note }}"
      packageTypeId: "{{ packageTypeId }}"
      pieces: "{{ pieces }}"
      quantity: "{{ quantity }}"
      unit: "{{ unit }}"
      unitaryValue: "{{ unitaryValue }}"
      valueByTotal: "{{ valueByTotal }}"
      volumePiece: "{{ volumePiece }}"
      volumeTotal: "{{ volumeTotal }}"
      volumeUnit: "{{ volumeUnit }}"
      warehouseLocationId: "{{ warehouseLocationId }}"
      weight: "{{ weight }}"
      weightByTotal: "{{ weightByTotal }}"
      weightTotal: "{{ weightTotal }}"
      weightUnit: "{{ weightUnit }}"     
outputs:
  - name: "containerCommodity"
    mapping: "container"

Example Commodity Workflow​

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

inputs:
  - name: "commodityStatusId"
    type: "CommodityStatus"
    displayName: "Commodity status id"
    description: "Commodity status id"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "commodity.commodityStatusId"
  - name: "commodityTypeId"
    type: "CommodityType"
    displayName: "Commodity type id"
    description: "Commodity type id"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "commodity.commodityTypeId"
  - name: "containerCommodityId"
    type: "Commodity"
    displayName: "Container commodity id"
    description: "Container commodity id"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "commodity.containerCommodityId"
  - name: "customValues"
    type: "string,string"
    displayName: "Custom values"
    description: "Custom values"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "commodity.customValues"
  - name: "description"
    type: "string"
    displayName: "Description"
    description: "Description"
    multiple: false
    required: true
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "commodity.description"
  - name: "dimensionsUnit"
    type: "DimensionsUnit"
    displayName: "Dimensions unit"
    description: "Dimensions unit"
    multiple: false
    required: true
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "commodity.dimensionsUnit"
  - name: "height"
    type: "number"
    displayName: "Height"
    description: "Height"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "commodity.height"
  - name: "width"
    type: "number"
    displayName: "Width"
    description: "Width"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "commodity.width"
  - name: "length"
    type: "number"
    displayName: "Length"
    description: "Length"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "commodity.length"
  - name: "jobId"
    type: "Job"
    displayName: "Job id"
    description: "Job id"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "commodity.jobId"
  - name: "note"
    type: "string"
    displayName: "Note"
    description: "Note"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "commodity.note"
  - name: "packageTypeId"
    type: "PackageType"
    displayName: "Package type id"
    description: "Package type id"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "commodity.packageTypeId"
  - name: "pieces"
    type: "number"
    displayName: "Pieces"
    description: "Pieces"
    multiple: false
    required: true
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "commodity.pieces"
  - name: "quantity"
    type: "number"
    displayName: "Quantity"
    description: "Quantity"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "commodity.quantity"
  - name: "unit"
    type: "string"
    displayName: "Unit"
    description: "Unit"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "commodity.unit"
  - name: "unitaryValue"
    type: "number"
    displayName: "Unitary value"
    description: "Unitary value"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "commodity.unitaryValue"
  - name: "valueByTotal"
    type: "boolean"
    displayName: "Value by total"
    description: "Value by total"
    multiple: false
    required: true
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "commodity.valueByTotal"
  - name: "volumePiece"
    type: "number"
    displayName: "Volume piece"
    description: "Volume piece"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "commodity.volumePiece"
  - name: "volumeTotal"
    type: "number"
    displayName: "Volume total"
    description: "Volume total"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "commodity.volumeTotal"
  - name: "volumeUnit"
    type: "VolumeUnit"
    displayName: "Volume unit"
    description: "Volume unit"
    multiple: false
    required: true
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "commodity.volumeUnit"
  - name: "warehouseLocationId"
    type: "WarehouseLocation"
    displayName: "Warehouse location id"
    description: "Warehouse location id"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "commodity.warehouseLocationId"
  - name: "weight"
    type: "number"
    displayName: "Weight"
    description: "Weight"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "commodity.weight"
  - name: "weightByTotal"
    type: "boolean"
    displayName: "Weight by total"
    description: "Weight by total"
    multiple: false
    required: true
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "commodity.weightByTotal"
  - name: "weightTotal"
    type: "number"
    displayName: "Weight total"
    description: "Weight total"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "commodity.weightTotal"
  - name: "weightUnit"
    type: "WeightUnit"
    displayName: "Weight unit"
    description: "Weight unit"
    multiple: false
    required: true
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "commodity.weightUnit"


outputs:
  - name: commodity
    mapping: "createCommodityActivity.createCommodity.commodity"

activities:
  - name: "createCommodityActivity"
    description: "Create Commodity"
    steps:
      - task: "Commodity/Create@1"
        name: createCommodity
        inputs: 
          commodity:
            commodityStatusId: "{{ commodityStatusId }}"
            commodityTypeId: "{{ commodityTypeId }}"
            containerCommodityId: "{{ containerCommodityId }}"
            customValues: "{{ customValues }}"
            description: "{{ description }}"
            dimensionsUnit: "{{ dimensionsUnit }}"
            height: "{{ height }}"
            jobId: "{{ jobId }}"
            length: "{{ length }}"
            note: "{{ note }}"
            packageTypeId: "{{ packageTypeId }}"
            pieces: "{{ pieces }}"
            quantity: "{{ quantity }}"
            unit: "{{ unit }}"
            unitaryValue: "{{ unitaryValue }}"
            valueByTotal: "{{ valueByTotal }}"
            volumePiece: "{{ volumePiece }}"
            volumeTotal: "{{ volumeTotal }}"
            volumeUnit: "{{ volumeUnit }}"
            warehouseLocationId: "{{ warehouseLocationId }}"
            weight: "{{ weight }}"
            weightByTotal: "{{ weightByTotal }}"
            weightTotal: "{{ weightTotal }}"
            weightUnit: "{{ weightUnit }}"
            width: "{{ width }}"
        outputs:
          - name: commodity
            mapping: "commodity"
  - name: "getCommodityActivity"
    description: "Get Commodity"
    steps:
      - task: "Commodity/Get@1"
        name: getCommodity
        inputs: 
          commodityId: "{{ createCommodityActivity.createCommodity.commodity.commodityId }}"
        outputs:
          - name: commodityFromGet
            mapping: "commodity"
  - name: "updateCommodityActivity"
    description: "Update Commodity"
    steps:
      - task: "Commodity/Update@1"
        name: updateCommodity
        inputs: 
          commodityId: "{{ getCommodityActivity.getCommodity.commodity.commodityId }}"
          commodity:
            commodityStatusId: "{{ commodityStatusId }}"
            commodityTypeId: "{{ commodityTypeId }}"
            containerCommodityId: "{{ containerCommodityId }}"
            customValues: "{{ customValues }}"
            description: "{{ description }}"
            dimensionsUnit: "{{ dimensionsUnit }}"
            height: "{{ height }}"
            jobId: "{{ jobId }}"
            length: "{{ length }}"
            note: "{{ note }}"
            packageTypeId: "{{ packageTypeId }}"
            pieces: "{{ pieces }}"
            quantity: "{{ quantity }}"
            unit: "{{ unit }}"
            unitaryValue: "{{ unitaryValue }}"
            valueByTotal: "{{ valueByTotal }}"
            volumePiece: "{{ volumePiece }}"
            volumeTotal: "{{ volumeTotal }}"
            volumeUnit: "{{ volumeUnit }}"
            warehouseLocationId: "{{ warehouseLocationId }}"
            weight: "{{ weight }}"
            weightByTotal: "{{ weightByTotal }}"
            weightTotal: "{{ weightTotal }}"
            weightUnit: "{{ weightUnit }}"
            width: "{{ width }}"
  - name: "deleteCommodityActivity"
    description: "Delete Commodity"
    steps:
      - task: "Commodity/Delete@1"
        name: deleteCommodity
        inputs: 
          commodityId: "{{ getCommodityActivity.getCommodity.commodity.commodityId }}"