/dispatches

Create a dispatch

This API only accepts a JSON object in the body of the request and is used to create a new dispatch. The JSON object should take the following general form.

{
  // All dispatch level information here. Refer to table above to see complete list of attributes for a dispatch.
  "driver_id":"mc-drv",
  "vehicle_id":"mc-veh",
  "status":"active",
  "vendor_shipper_id":"vdi-1",
  "vendor_consignee_id":"vdi-2",
  "shipper_form_ids":[
    "16cbe497-05d5-45c5-ab00-ef0c40e7ddad",
    "386f0eec-87b0-4f80-91ad-75c75a60ff0a"
  ],
  "consignee_form_ids":[
    "074308a4-ed07-4eca-b0fc-4a8920312f8c",
    "bb789f6a-6389-4aa8-b8e5-bf5e1d24b5ab"
  ],
  "vendor_shipper_dispatch_location_id":"da22e8",
  "vendor_consignee_dispatch_location_id":"414ab6",
  "shipper_type":"pickup",
  "consignee_type":"dropoff",

  // Array of dispatch stops. Can be empty or can have any number of additional stops
  "dispatch_stops":[
    {
      // All dispatch stop information here. Refer to table above to see complete list of attributes for a dispatch stop.
      "vendor_id":"ghi-1",
      "type":"PU",
      "number":1,
      "driver_load":true,
      "early_date":"2019-01-13T19:13:00+00:00",
      "late_date":"2019-01-15T19:13:00+00:00",
      "form_ids":[
        "3a3ce3c2-d136-408e-b2c4-06673f7bd1da",
        "a4fa5e12-1252-4248-9508-16f00e6274e3"
      ],
      "vendor_dispatch_location_id":"d67db7",
      "status":"available"
    },
    {
      "vendor_id":"ghi-2",
      "number":2,
      "driver_load":false,
      "early_date":"2019-01-13T19:13:00+00:00",
      "late_date":"2019-01-15T19:13:00+00:00",
      "form_ids":[
        "3a3ce3c2-d136-408e-b2c4-06673f7bd1da",
        "a4fa5e12-1252-4248-9508-16f00e6274e3"
      ],
      "vendor_dispatch_location_id":"c67cb7",
      "status":"available",
      "type":"UL"
    }
  ]
}

Sample Requests

{
  "vendor_id":"VD-1",
  "vendor_shipper_id":"VSS-1",
  "vendor_consignee_id":"VCS-1",
  "driver_id":497583,
  "vehicle_id":24613,
  "vendor_shipper_dispatch_location_id":"VSDL-1",
  "vendor_consignee_dispatch_location_id":"VSDL-2",
  "additional_drops":0,
  "additional_pickups":0,
  "consignee_bill_of_lading":"",
  "consignee_comments":"",
  "consignee_driver_load":false,
  "consignee_form_ids":[
    "972f7a4e-f616-4773-800a-f314f98e9693",
    "1182c274-4e15-43d0-acab-885d261ba404",
    "56f0e29d-0b57-4e60-bab6-1e7493245461"
  ],
  "consignee_pallets":0,
  "consignee_pieces":0,
  "consignee_refno":"",
  "consignee_status":"departed",
  "consignee_type":"DROPOFF",
  "consignee_volume":null,
  "consignee_weight":0,
  "delivery_early_date":"2019-01-13T19:13:00+00:00",
  "delivery_late_date":"2019-01-15T19:13:00+00:00",
  "loaded_miles":0,
  "order_pieces":null,
  "order_volume":null,
  "order_weight":null,
  "pickup_early_date":"2019-01-11T19:13:00+00:00",
  "pickup_late_date":"2019-01-12T19:13:00+00:00",
  "pickup_number":"",
  "product":"",
  "shipper_bill_of_lading":"",
  "shipper_comments":"",
  "shipper_driver_load":false,
  "shipper_form_ids":[
    "0b90adf8-2321-4198-9315-5fb57e155c15",
    "2a00385b-7de3-48b2-9bfc-842eb168e535",
    "fff80dfb-dda9-4502-8ca6-6c69fa6d70d6"
  ],
  "shipper_pallets":0,
  "shipper_pieces":0,
  "shipper_status":"departed",
  "shipper_type":"PICKUP",
  "shipper_volume":null,
  "shipper_weight":0,
  "status":"completed",
  "temperature_max":0,
  "temperature_min":0,
  "trailer":"",
  "dispatch_stops":[]
}
{
  "vendor_id":"VD-1",
  "vendor_shipper_id":"VSS-1",
  "vendor_consignee_id":"VCS-1",
  "driver_id":497583,
  "vehicle_id":24613,
  "vendor_shipper_dispatch_location_id":"VSDL-1",
  "vendor_consignee_dispatch_location_id":"VSDL-2",
  "additional_drops":0,
  "additional_pickups":0,
  "consignee_bill_of_lading":"",
  "consignee_comments":"",
  "consignee_driver_load":false,
  "consignee_form_ids":[
    "972f7a4e-f616-4773-800a-f314f98e9693",
    "1182c274-4e15-43d0-acab-885d261ba404",
    "56f0e29d-0b57-4e60-bab6-1e7493245461"
  ],
  "consignee_pallets":0,
  "consignee_pieces":0,
  "consignee_refno":"",
  "consignee_status":"departed",
  "consignee_type":"DROPOFF",
  "consignee_volume":null,
  "consignee_weight":0,
  "delivery_early_date":"2019-01-13T19:13:00+00:00",
  "delivery_late_date":"2019-01-15T19:13:00+00:00",
  "loaded_miles":0,
  "order_pieces":null,
  "order_volume":null,
  "order_weight":null,
  "pickup_early_date":"2019-01-11T19:13:00+00:00",
  "pickup_late_date":"2019-01-12T19:13:00+00:00",
  "pickup_number":"",
  "product":"",
  "shipper_bill_of_lading":"",
  "shipper_comments":"",
  "shipper_driver_load":false,
  "shipper_form_ids":[
    "0b90adf8-2321-4198-9315-5fb57e155c15",
    "2a00385b-7de3-48b2-9bfc-842eb168e535",
    "fff80dfb-dda9-4502-8ca6-6c69fa6d70d6"
  ],
  "shipper_pallets":0,
  "shipper_pieces":0,
  "shipper_status":"departed",
  "shipper_type":"PICKUP",
  "shipper_volume":null,
  "shipper_weight":0,
  "status":"completed",
  "temperature_max":0,
  "temperature_min":0,
  "trailer":"",
  "dispatch_stops":[
    {
      "vendor_id":"VDS-1",
      "vendor_dispatch_location_id":"VDSL-3",
      "bill_of_lading":null,
      "comments":null,
      "driver_load":false,
      "early_date":"2017-07-13T19:13:00+00:00",
      "form_ids":[
        "0b90adf8-2321-4198-9315-5fb57e155c15",
        "2a00385b-7de3-48b2-9bfc-842eb168e535",
        "fff80dfb-dda9-4502-8ca6-6c69fa6d70d6"
      ],
      "late_date":"2017-07-15T19:13:00+00:00",
      "number":1,
      "pallets_in":null,
      "pallets_out":null,
      "pieces":null,
      "status":"available",
      "type":"PU",
      "volume":null,
      "weight":null
    }
  ]
}

Disclaimer: The above sample request will not work as-is because form ids and dispatch location ids will differ for your fleet. Please change these values appropriately before making a request to the API.

Language
Credentials
Header
Click Try It! to start a request and see the response here!