Skip to main content
POST
/
movements
cURL
curl --request POST \
  --url https://api.vooma.ai/v0/movements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "movement": {
    "cargo": {
      "commodities": [
        {
          "description": "<string>",
          "isStackable": true,
          "itemReference": {
            "type": "ORDER_REFERENCE",
            "value": "<string>"
          },
          "dimensions": {
            "height": {
              "value": 123,
              "units": "IN"
            },
            "width": {
              "value": 123,
              "units": "IN"
            },
            "length": {
              "value": 123,
              "units": "IN"
            }
          },
          "weight": {
            "units": "LB",
            "value": 123
          },
          "hazmat": {
            "classifications": [
              {
                "qualifier": "P",
                "hazardClass": "1"
              }
            ],
            "contact": {
              "carrierId": "<string>",
              "customerId": "<string>",
              "email": "<string>",
              "phone": "<string>",
              "name": "<string>",
              "id": "<string>",
              "reference": {
                "type": "ORDER_REFERENCE",
                "value": "<string>"
              }
            },
            "packingGroup": "<string>",
            "unNumber": "<string>",
            "weight": {
              "units": "LB",
              "value": 123
            }
          },
          "nmfcCode": "<string>",
          "freightClass": "<string>",
          "pieceUnits": "BAGS",
          "pieceQuantity": 123,
          "handlingUnits": "BAGS",
          "handlingQuantity": 123
        }
      ],
      "declaredValue": {
        "uom": "USD",
        "value": 123
      },
      "dimensions": {
        "height": {
          "value": 123,
          "units": "IN"
        },
        "width": {
          "value": 123,
          "units": "IN"
        },
        "length": {
          "value": 123,
          "units": "IN"
        }
      },
      "totalWeight": {
        "units": "LB",
        "value": 123
      }
    },
    "equipmentOptions": [
      {
        "type": "BOX_TRUCK",
        "equipmentLength": {
          "value": 123,
          "units": "IN"
        },
        "temperature": {
          "units": "F",
          "max": 123,
          "min": 123
        },
        "description": "<string>"
      }
    ],
    "customer": {
      "name": "<string>",
      "externalIds": [
        {
          "type": "ALJEX",
          "value": "<string>"
        }
      ],
      "contacts": [
        {
          "carrierId": "<string>",
          "customerId": "<string>",
          "email": "<string>",
          "phone": "<string>",
          "name": "<string>",
          "id": "<string>"
        }
      ],
      "id": "<string>"
    },
    "route": {
      "stops": [
        {
          "location": {
            "externalIds": [
              {
                "type": "CUSTOM",
                "value": "<string>"
              }
            ],
            "address": {
              "country": "<string>",
              "postalCode": "<string>",
              "city": "<string>",
              "state": "<string>",
              "addressTwo": "<string>",
              "addressOne": "<string>"
            },
            "geoCoordinates": {
              "longitude": 123,
              "latitude": 123
            },
            "name": "<string>",
            "id": "<string>"
          },
          "type": "PICKUP",
          "stopReferences": [
            {
              "type": "ORDER_REFERENCE",
              "value": "<string>"
            }
          ],
          "externalNotes": "<string>",
          "internalNotes": "<string>",
          "accessorials": [
            {
              "size": {
                "value": 123,
                "units": "IN"
              },
              "type": "TARPING"
            }
          ],
          "contact": {
            "carrierId": "<string>",
            "customerId": "<string>",
            "email": "<string>",
            "phone": "<string>",
            "name": "<string>",
            "id": "<string>"
          },
          "commodities": [
            {
              "description": "<string>",
              "isStackable": true,
              "itemReference": {
                "type": "ORDER_REFERENCE",
                "value": "<string>"
              },
              "dimensions": {
                "height": {
                  "value": 123,
                  "units": "IN"
                },
                "width": {
                  "value": 123,
                  "units": "IN"
                },
                "length": {
                  "value": 123,
                  "units": "IN"
                }
              },
              "weight": {
                "units": "LB",
                "value": 123
              },
              "hazmat": {
                "classifications": [
                  {
                    "qualifier": "P",
                    "hazardClass": "1"
                  }
                ],
                "contact": {
                  "carrierId": "<string>",
                  "customerId": "<string>",
                  "email": "<string>",
                  "phone": "<string>",
                  "name": "<string>",
                  "id": "<string>",
                  "reference": {
                    "type": "ORDER_REFERENCE",
                    "value": "<string>"
                  }
                },
                "packingGroup": "<string>",
                "unNumber": "<string>",
                "weight": {
                  "units": "LB",
                  "value": 123
                }
              },
              "nmfcCode": "<string>",
              "freightClass": "<string>",
              "pieceUnits": "BAGS",
              "pieceQuantity": 123,
              "handlingUnits": "BAGS",
              "handlingQuantity": 123
            }
          ],
          "weight": {
            "units": "LB",
            "value": 123
          },
          "notes": "<string>",
          "dateTimeRanges": [
            {
              "startDate": "<string>",
              "endDate": "<string>",
              "startTime": "<string>",
              "endTime": "<string>",
              "timezone": "<string>",
              "type": "FACILITY_HOURS"
            }
          ],
          "externalIds": [
            {
              "type": "CUSTOM",
              "value": "<string>"
            }
          ],
          "id": "<string>"
        }
      ],
      "mileage": {
        "uom": "MI",
        "value": 123
      }
    },
    "references": [
      {
        "type": "ORDER_REFERENCE",
        "value": "<string>"
      }
    ],
    "externalIds": [
      {
        "type": "CUSTOM",
        "value": "<string>"
      }
    ],
    "attributes": {},
    "tags": [
      "<string>"
    ],
    "externalNotes": "<string>",
    "internalNotes": "<string>",
    "carrier": {
      "carrier": {
        "name": "<string>",
        "equipment": [
          {
            "equipment": {
              "type": "BOX_TRUCK",
              "equipmentLength": {
                "value": 123,
                "units": "IN"
              },
              "temperature": {
                "units": "F",
                "max": 123,
                "min": 123
              },
              "description": "<string>"
            },
            "trailerNumber": "<string>",
            "truckNumber": "<string>"
          }
        ],
        "contacts": [
          {
            "contact": {
              "carrierId": "<string>",
              "customerId": "<string>",
              "email": "<string>",
              "phone": "<string>",
              "name": "<string>",
              "id": "<string>"
            },
            "type": "DRIVER"
          }
        ],
        "dotNumber": "<string>",
        "mcNumber": "<string>",
        "id": "<string>"
      },
      "assignedDispatch": {
        "contact": {
          "carrierId": "<string>",
          "customerId": "<string>",
          "email": "<string>",
          "phone": "<string>",
          "name": "<string>",
          "id": "<string>"
        },
        "type": "DRIVER"
      },
      "assignedDriver": {
        "contact": {
          "carrierId": "<string>",
          "customerId": "<string>",
          "email": "<string>",
          "phone": "<string>",
          "name": "<string>",
          "id": "<string>"
        },
        "type": "DRIVER"
      },
      "assignedEquipment": {
        "equipment": {
          "type": "BOX_TRUCK",
          "equipmentLength": {
            "value": 123,
            "units": "IN"
          },
          "temperature": {
            "units": "F",
            "max": 123,
            "min": 123
          },
          "description": "<string>"
        },
        "trailerNumber": "<string>",
        "truckNumber": "<string>"
      }
    },
    "financials": {
      "costs": {
        "lineItems": [
          {
            "description": "<string>",
            "amount": {
              "uom": "USD",
              "value": 123
            },
            "type": "FREIGHT_FLAT"
          }
        ]
      },
      "chargesToCustomer": {
        "lineItems": [
          {
            "description": "<string>",
            "amount": {
              "uom": "USD",
              "value": 123
            },
            "type": "FREIGHT_FLAT"
          }
        ]
      },
      "paymentTerms": "PREPAID",
      "costNegotiationGuidance": {
        "maxPrice": {
          "uom": "USD",
          "value": 123
        },
        "startingPrice": {
          "uom": "USD",
          "value": 123
        }
      }
    },
    "accessorials": [
      {
        "size": {
          "value": 123,
          "units": "IN"
        },
        "type": "TARPING"
      }
    ],
    "freightModeDetails": {
      "mode": "TRUCKLOAD",
      "drayageSubtype": "IMPORT"
    },
    "responsibleUser": {
      "externalIds": [
        {
          "type": "CUSTOM",
          "value": "<string>"
        }
      ],
      "id": "<string>"
    }
  }
}
'
{
  "cargo": {
    "commodities": [
      {
        "description": "<string>",
        "isStackable": true,
        "itemReference": {
          "type": "ORDER_REFERENCE",
          "value": "<string>"
        },
        "dimensions": {
          "height": {
            "value": 123,
            "units": "IN"
          },
          "width": {
            "value": 123,
            "units": "IN"
          },
          "length": {
            "value": 123,
            "units": "IN"
          }
        },
        "weight": {
          "units": "LB",
          "value": 123
        },
        "hazmat": {
          "classifications": [
            {
              "qualifier": "P",
              "hazardClass": "1"
            }
          ],
          "contact": {
            "carrierId": "<string>",
            "customerId": "<string>",
            "email": "<string>",
            "phone": "<string>",
            "name": "<string>",
            "id": "<string>",
            "reference": {
              "type": "ORDER_REFERENCE",
              "value": "<string>"
            }
          },
          "packingGroup": "<string>",
          "unNumber": "<string>",
          "weight": {
            "units": "LB",
            "value": 123
          }
        },
        "nmfcCode": "<string>",
        "freightClass": "<string>",
        "pieceUnits": "BAGS",
        "pieceQuantity": 123,
        "handlingUnits": "BAGS",
        "handlingQuantity": 123
      }
    ],
    "declaredValue": {
      "uom": "USD",
      "value": 123
    },
    "dimensions": {
      "height": {
        "value": 123,
        "units": "IN"
      },
      "width": {
        "value": 123,
        "units": "IN"
      },
      "length": {
        "value": 123,
        "units": "IN"
      }
    },
    "totalWeight": {
      "units": "LB",
      "value": 123
    }
  },
  "equipmentOptions": [
    {
      "type": "BOX_TRUCK",
      "equipmentLength": {
        "value": 123,
        "units": "IN"
      },
      "temperature": {
        "units": "F",
        "max": 123,
        "min": 123
      },
      "description": "<string>"
    }
  ],
  "customer": {
    "name": "<string>",
    "externalIds": [
      {
        "type": "ALJEX",
        "value": "<string>"
      }
    ],
    "contacts": [
      {
        "carrierId": "<string>",
        "customerId": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "name": "<string>",
        "id": "<string>"
      }
    ],
    "id": "<string>"
  },
  "route": {
    "stops": [
      {
        "location": {
          "externalIds": [
            {
              "type": "CUSTOM",
              "value": "<string>"
            }
          ],
          "address": {
            "country": "<string>",
            "postalCode": "<string>",
            "city": "<string>",
            "state": "<string>",
            "addressTwo": "<string>",
            "addressOne": "<string>"
          },
          "geoCoordinates": {
            "longitude": 123,
            "latitude": 123
          },
          "name": "<string>",
          "id": "<string>"
        },
        "type": "PICKUP",
        "stopReferences": [
          {
            "type": "ORDER_REFERENCE",
            "value": "<string>"
          }
        ],
        "externalNotes": "<string>",
        "internalNotes": "<string>",
        "accessorials": [
          {
            "size": {
              "value": 123,
              "units": "IN"
            },
            "type": "TARPING"
          }
        ],
        "contact": {
          "carrierId": "<string>",
          "customerId": "<string>",
          "email": "<string>",
          "phone": "<string>",
          "name": "<string>",
          "id": "<string>"
        },
        "commodities": [
          {
            "description": "<string>",
            "isStackable": true,
            "itemReference": {
              "type": "ORDER_REFERENCE",
              "value": "<string>"
            },
            "dimensions": {
              "height": {
                "value": 123,
                "units": "IN"
              },
              "width": {
                "value": 123,
                "units": "IN"
              },
              "length": {
                "value": 123,
                "units": "IN"
              }
            },
            "weight": {
              "units": "LB",
              "value": 123
            },
            "hazmat": {
              "classifications": [
                {
                  "qualifier": "P",
                  "hazardClass": "1"
                }
              ],
              "contact": {
                "carrierId": "<string>",
                "customerId": "<string>",
                "email": "<string>",
                "phone": "<string>",
                "name": "<string>",
                "id": "<string>",
                "reference": {
                  "type": "ORDER_REFERENCE",
                  "value": "<string>"
                }
              },
              "packingGroup": "<string>",
              "unNumber": "<string>",
              "weight": {
                "units": "LB",
                "value": 123
              }
            },
            "nmfcCode": "<string>",
            "freightClass": "<string>",
            "pieceUnits": "BAGS",
            "pieceQuantity": 123,
            "handlingUnits": "BAGS",
            "handlingQuantity": 123
          }
        ],
        "weight": {
          "units": "LB",
          "value": 123
        },
        "notes": "<string>",
        "dateTimeRanges": [
          {
            "startDate": "<string>",
            "endDate": "<string>",
            "startTime": "<string>",
            "endTime": "<string>",
            "timezone": "<string>",
            "type": "FACILITY_HOURS"
          }
        ],
        "externalIds": [
          {
            "type": "CUSTOM",
            "value": "<string>"
          }
        ],
        "id": "<string>"
      }
    ],
    "mileage": {
      "uom": "MI",
      "value": 123
    }
  },
  "references": [
    {
      "type": "ORDER_REFERENCE",
      "value": "<string>"
    }
  ],
  "externalIds": [
    {
      "type": "CUSTOM",
      "value": "<string>"
    }
  ],
  "id": "<string>",
  "attributes": {},
  "tags": [
    "<string>"
  ],
  "externalNotes": "<string>",
  "internalNotes": "<string>",
  "carrier": {
    "carrier": {
      "name": "<string>",
      "equipment": [
        {
          "equipment": {
            "type": "BOX_TRUCK",
            "equipmentLength": {
              "value": 123,
              "units": "IN"
            },
            "temperature": {
              "units": "F",
              "max": 123,
              "min": 123
            },
            "description": "<string>"
          },
          "trailerNumber": "<string>",
          "truckNumber": "<string>"
        }
      ],
      "contacts": [
        {
          "contact": {
            "carrierId": "<string>",
            "customerId": "<string>",
            "email": "<string>",
            "phone": "<string>",
            "name": "<string>",
            "id": "<string>"
          },
          "type": "DRIVER"
        }
      ],
      "dotNumber": "<string>",
      "mcNumber": "<string>",
      "id": "<string>"
    },
    "assignedDispatch": {
      "contact": {
        "carrierId": "<string>",
        "customerId": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "name": "<string>",
        "id": "<string>"
      },
      "type": "DRIVER"
    },
    "assignedDriver": {
      "contact": {
        "carrierId": "<string>",
        "customerId": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "name": "<string>",
        "id": "<string>"
      },
      "type": "DRIVER"
    },
    "assignedEquipment": {
      "equipment": {
        "type": "BOX_TRUCK",
        "equipmentLength": {
          "value": 123,
          "units": "IN"
        },
        "temperature": {
          "units": "F",
          "max": 123,
          "min": 123
        },
        "description": "<string>"
      },
      "trailerNumber": "<string>",
      "truckNumber": "<string>"
    }
  },
  "financials": {
    "costs": {
      "lineItems": [
        {
          "description": "<string>",
          "amount": {
            "uom": "USD",
            "value": 123
          },
          "type": "FREIGHT_FLAT"
        }
      ]
    },
    "chargesToCustomer": {
      "lineItems": [
        {
          "description": "<string>",
          "amount": {
            "uom": "USD",
            "value": 123
          },
          "type": "FREIGHT_FLAT"
        }
      ]
    },
    "paymentTerms": "PREPAID",
    "costNegotiationGuidance": {
      "maxPrice": {
        "uom": "USD",
        "value": 123
      },
      "startingPrice": {
        "uom": "USD",
        "value": 123
      }
    }
  },
  "accessorials": [
    {
      "size": {
        "value": 123,
        "units": "IN"
      },
      "type": "TARPING"
    }
  ],
  "freightModeDetails": {
    "mode": "TRUCKLOAD",
    "drayageSubtype": "IMPORT"
  },
  "responsibleUser": {
    "externalIds": [
      {
        "type": "CUSTOM",
        "value": "<string>"
      }
    ],
    "id": "<string>"
  }
}
Beta Feature: This functionality is currently in beta. You may experience changes or limited support as we continue to improve it.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
movement
object
required

Response

200 - application/json

Ok

​
cargo
object
required
​
equipmentOptions
object[]
required
​
customer
object
required
​
route
object
required
​
references
object[]
required
​
externalIds
object[]
required
​
id
string
required
​
attributes
object

Construct a type with a set of properties K of type T

​
tags
string[]
​
externalNotes
string
​
internalNotes
string
​
carrier
object
​
financials
object
​
accessorials
object[]
  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5
  • Option 6
  • Option 7
  • Option 8
  • Option 9
  • Option 10
  • Option 11
  • Option 12
  • Option 13
  • Option 14
  • Option 15
  • Option 16
  • Option 17
  • Option 18
  • Option 19
  • Option 20
  • Option 21
  • Option 22
  • Option 23
​
freightModeDetails
object
​
responsibleUser
object