Create a new dispatch

Purpose: Use this API to create a new dispatch.

📘

NOTE

This endpoint will only accept a JSON Object as body parameters. The following is the format of the request body:

{
  // 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 Request Body

{
  "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
    }
  ]
}

Response Parameters

dispatches

• Type: Array of Objects
• Description: List of dispatches.

dispatch

• Type: Object
• Description: Information about a specific dispatch.

id

• Type: Integer
• Description: Unique identifier for the dispatch.

vendor_id

• Type: String
• Description: Vendor identifier associated with the dispatch.

vendor_shipper_id

• Type: String
• Description: Vendor shipper identifier.

vendor_consignee_id

• Type: String
• Description: Vendor consignee identifier.

driver_id

• Type: Integer
• Description: Unique identifier for the driver associated with the dispatch.

vehicle_id

• Type: Integer
• Description: Unique identifier for the vehicle associated with the dispatch.

additional_drops

• Type: Integer
• Description: Number of additional drop-off locations.

additional_pickups

• Type: Integer
• Description: Number of additional pickup locations.

consignee_bill_of_lading

• Type: String
• Description: Bill of lading number provided by the consignee.

consignee_comments

• Type: String
• Description: Comments provided by the consignee.

consignee_driver_load

• Type: Boolean
• Description: Indicates if the consignee will load the driver.

consignee_form_ids

• Type: Array of Strings
• Description: List of form IDs associated with the consignee.

consignee_pallets

• Type: Integer
• Description: Number of pallets handled by the consignee.

consignee_pieces

• Type: Integer
• Description: Number of pieces handled by the consignee.

consignee_refno

• Type: String
• Description: Reference number provided by the consignee.

consignee_status

• Type: String
• Description: Status of the consignee (e.g., "departed").

consignee_type

• Type: String
• Description: Type of consignee (e.g., "DROPOFF").

consignee_volume

• Type: Float
• Description: Volume of goods handled by the consignee (if available).

consignee_weight

• Type: Float
• Description: Weight of goods handled by the consignee.

delivery_early_date

• Type: String
• Description: Earliest date for delivery.

delivery_late_date

• Type: String
• Description: Latest date for delivery.

loaded_miles

• Type: Integer
• Description: Loaded miles for the dispatch.

order_pieces

• Type: Integer
• Description: Number of pieces in the order (if available).

order_volume

• Type: Float
• Description: Volume of the order (if available).

order_weight

• Type: Float
• Description: Weight of the order (if available).

pickup_early_date

• Type: String
• Description: Earliest date for pickup.

pickup_late_date

• Type: String
• Description: Latest date for pickup.

pickup_number

• Type: String
• Description: Pickup number for the dispatch.

product

• Type: String
• Description: Product being shipped.

shipper_bill_of_lading

• Type: String
• Description: Bill of lading number provided by the shipper.

shipper_comments

• Type: String
• Description: Comments provided by the shipper.

shipper_driver_load

• Type: Boolean
• Description: Indicates if the shipper will load the driver.

shipper_form_ids

• Type: Array of Strings
• Description: List of form IDs associated with the shipper.

shipper_pallets

• Type: Integer
• Description: Number of pallets handled by the shipper.

shipper_pieces

• Type: Integer
• Description: Number of pieces handled by the shipper.

shipper_status

• Type: String
• Description: Status of the shipper (e.g., "departed").

shipper_type

• Type: String
• Description: Type of shipper (e.g., "PICKUP").

shipper_volume

• Type: Float
• Description: Volume of goods handled by the shipper (if available).

shipper_weight

• Type: Float
• Description: Weight of goods handled by the shipper.

status

• Type: String
• Description: Overall status of the dispatch (e.g., "completed").

temperature_max

• Type: Float
• Description: Maximum temperature for the dispatch.

temperature_min

• Type: Float
• Description: Minimum temperature for the dispatch.

trailer

• Type: String
• Description: Trailer information.

shipper_dispatch_location_id

• Type: Integer
• Description: Unique identifier for the shipper's dispatch location.

consignee_dispatch_location_id

• Type: Integer
• Description: Unique identifier for the consignee's dispatch location.

vendor_shipper_dispatch_location_id

• Type: String
• Description: Vendor's shipper dispatch location identifier.

vendor_consignee_dispatch_location_id

• Type: String
• Description: Vendor's consignee dispatch location identifier.

custom_field1

• Type: Mixed
• Description: Custom field 1 (if available).

dispatch_stops

• Type: Array of Objects
• Description: List of stops associated with the dispatch.

dispatch_stop

• Type: Object
• Description: Information about a specific stop within a dispatch.

id (dispatch_stop)

• Type: Integer
• Description: Unique identifier for the dispatch stop.

vendor_id (dispatch_stop)

• Type: String
• Description: Vendor identifier associated with the dispatch stop.

bill_of_lading

• Type: String
• Description: Bill of lading number for the dispatch stop.

comments

• Type: String
• Description: Comments for the dispatch stop.

driver_load

• Type: Boolean
• Description: Indicates if the driver will load at this stop.

early_date

• Type: String
• Description: Earliest date for the stop.

form_ids

• Type: Array of Strings
• Description: List of form IDs associated with the stop.

late_date

• Type: String
• Description: Latest date for the stop.

number

• Type: Integer
• Description: Stop number in the sequence.

pallets_in

• Type: Integer
• Description: Number of pallets received at this stop.

pallets_out

• Type: Integer
• Description: Number of pallets delivered at this stop.

pieces

• Type: Integer
• Description: Number of pieces handled at this stop.

status (dispatch_stop)

• Type: String
• Description: Status of the dispatch stop (e.g., "available").

type

• Type: String
• Description: Type of stop (e.g., "PU" for pickup).

volume

• Type: Float
• Description: Volume of goods handled at this stop.

weight

• Type: Float
• Description: Weight of goods handled at this stop.

custom_field1 (dispatch_stop)

• Type: Mixed
• Description: Custom field 1 for the stop (if available).

dispatch_location_id

• Type: Integer
• Description: Unique identifier for the dispatch location associated with the stop.

vendor_dispatch_location_id

• Type: String
• Description: Vendor's dispatch location identifier for the stop.