Skip to main content

Shipper-to-Broker Flow

Introduction​

The SuperDispatch Public API enables you to assign loads to brokers, where the shipper acts as the customer for brokers. This connection type requires setup by SuperDispatch support, and our onboarding success team will assist you with this process. Once configured, you can retrieve your linked brokers list and begin sending orders to brokers.

There are two ways to send an order to a broker:

  • Create and submit a new order directly to a broker
  • Send a load offer to a broker using an existing order

This document explains both approaches in detail.

For comprehensive information about this workflow, please refer to our Shipper-to-Broker Workflow documentation.

Table of Contents​

Main flow​

Get linked brokers list​

Retrieve your list of linked brokers. The endpoint supports pagination using page and size query parameters.

curl  -L 'https://api.shipper.superdispatch.org/v1/public/brokers/linked' \
      -H 'Authorization: Bearer <access_token>'

If you cannot find your broker in the list, please contact your SuperDispatch onboarding success manager or support team. The broker's guid field is the key identifier used in subsequent operations.

Submit order to a broker​

Use this endpoint when you have complete order information and want to assign it directly to a specific broker. This single request creates and submits the order to the broker. Specify your broker's GUID in the broker_guid query parameter.

curl  -L -X POST 'https://api.shipper.superdispatch.org/v1/public/orders/submit_to_broker?broker_guid={your_broker_guid}' \
      -H 'Content-Type: application/json' \
      -H 'Authorization: Bearer <access_token>' \
      -d '{
            "number": "ORDER-4532",
            "inspection_type": "standard",
            "purchase_order_number": "PO 0006",
            "dispatcher_name": "Sherry Turner",
            "sales_representative": "Alma Dubois",
            ...
      }'

For complete payload details, refer to the reference documentation

Send offer to a broker​

You can first create order step-by-step, update it entirely or partially. You may also utilize our APIs to enhance your order details (Pricing API, LoadBoard, Order tags).

Once your order is ready for broker assignment, use the send offer endpoint:

curl  -L -X POST 'https://api.shipper.superdispatch.org/v1/public/orders/{order_guid}/offers' \
      -H 'Content-Type: application/json' \
      -H 'Authorization: Bearer <access_token>' \
      -d '{
            "carrier_guid": "{your_broker_guid}",
            "carrier_type": "BROKER"
      }'

While the process of sending load offers to carriers and brokers is similar, the key difference is that you must specify carrier_type=BROKER in the request body. Additionally, brokers receive these as direct assignments rather than optional offers.

Escalation flow​

This project aims to streamline the vehicle pre-qualification process for enterprise shippers and brokers, ensuring operational efficiency and reducing delays caused by logistical bottlenecks before dispatch. It aligns with strategic goals by enhancing scalability, vendor interoperability, and reducing friction in moving cars.

Brokers can mark an order as escalated when they encounter issues with the order. The shipper can then resolve the escalation issue using the new API endpoint.

Submit Escalation​

As a broker, you can submit an escalation issue by providing reasons for the escalation. Use the following API endpoint to submit the escalation issue:

curl -L -X POST 'https://api.shipper.superdispatch.org/v1/public/escalations/orders/{order-guid}/submit' \
     -H 'Content-Type: application/json' \
     -H 'Authorization: Bearer <access_token>' \
     -d '{
            "reasons": {
                "CHARGES_DUE": "reason",
                "VEHICLE_IS_NOT_AT_LOCATION": "reason"
            }
         }'

Resolve Escalation​

As a shipper, you can resolve an escalation issue by providing reasons for the escalation. Use the following API endpoint to resolve the escalation issue:

curl -L -X POST 'https://api.shipper.superdispatch.org/v1/public/escalations/{guid}/resolve' \
     -H 'Content-Type: application/json' \
     -H 'Authorization: Bearer <access_token>' \
     -d '{
            "reasons": {
                "CHARGES_DUE": "reason",
                "VEHICLE_IS_NOT_AT_LOCATION": "reason"
            }
         }'

Available reasons are:

  • CHARGES_DUE
  • VEHICLE_IS_NOT_AT_LOCATION
  • INCORRECT_PHONE_NUMBER
  • LOCATION_WILL_NOT_RELEASE
  • LOCATION_CHANGED
  • NO_RETURNED_CALLS_OR_EMAILS
  • OTHER