🆕 Private Loadboard

Introduction

A Private Loadboard is a key component for Shipper and Carrier TMS that allows shippers and brokers to post their available loads selectively to a Private Network of trusted carriers. Here are the key components:

Private Loadboard: Shippers and brokers can instantly post loads that will be visible only to their Private Network, ensuring priority access for trusted carriers.
Private Network: This feature allows you to build a network of trusted carriers. You can even create groups within your network for specific hauling needs. These carriers get exclusive or early access to your orders, making load management more efficient and tailored to your requirements.
Auto-Post to Super Loadboard: If your private network is unavailable or if certain loads remain unbooked for a set amount of time, by default the system automatically posts those loads to the Super Loadboard (Public Loadboard). This ensures that all your loads still get booked and moved as quickly as possible. However, we leave the option for you to disable this setting and always keep your loads only in the private loadboard.

To use a private network from the UI or API, you need to request the access for your shipper account.

Get more familiar with Private Loadboard here

Private network
Private network groups
- Manage groups
- Post a load to the private network group

Private network

To post the load to the private network, you must add at least one approved carrier to it, otherwise, you will get HTTP 400 (Bad Request) response with the error code PRIVATE_NETWORK_IS_EMPTY.

For managing carriers in the private network, you should use an existing endpoint for updating carrier profile: PUT /v1/public/carriers/<carrier_guid>/profile.

Add a carrier to the private network

According to the current rules, only approved carriers (approved: true) can be added to the private network (is_in_private_network: true). Taking this into account, the following cURL command will add a carrier to your private network:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
curl  -L -X PUT 'https://api.shipper.superdispatch.org/v1/public/carriers/<carrier_guid>/profile' \
      -H 'Content-Type: application/json' \
      -H 'Authorization: Bearer <access_token>' \
      -d '{
              "approved": true,
              "preferred": false,
              "in_blacklist": false,
              "insurance_certificate_holder": false,
              "insurance_expires_at": null,
              "custom_external_id": "CARRIER-0001",
              "is_in_private_network": true
      }'

Remove the carrier from the private network

If any of the carriers were added by mistake, or you just want to remove them from the private network, using the same endpoint with is_in_private_network: false, a carrier will be removed from the private network and will lose access to your private loadboard:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
curl  -L -X PUT 'https://api.shipper.superdispatch.org/v1/public/carriers/<carrier_guid>/profile' \
      -H 'Content-Type: application/json' \
      -H 'Authorization: Bearer <access_token>' \
      -d '{
              "approved": true,
              "preferred": false,
              "in_blacklist": false,
              "insurance_certificate_holder": false,
              "insurance_expires_at": null,
              "custom_external_id": "CARRIER-0001",
              "is_in_private_network": false
      }'

Post a load to the private network

After setting up your private network, you can start posting loads to it, using the following API endpoint:

1
2
curl  -L -X POST 'https://api.shipper.superdispatch.org/v1/public/loadboard/orders/<order_guid>/private-network' \
      -H 'Authorization: Bearer <access_token>'

Please keep in mind, that after 2 hours (default), this load will be automatically reposted to the Super Loadboard (Public Loadboard) and become available to all carriers. You can adjust this behaviour in Super Loadboard settings.

Private network groups

Within your private network, you can create groups and post loads directly to them. Currently, you have the option to create up to 10 groups.

Manage groups

List all private network groups

List all groups in the private network (no pagination, since currently only 10 groups are allowed per shipper).

1
2
curl  -L 'https://api.shipper.superdispatch.org/v1/public/private-network/groups' \
      -H 'Authorization: Bearer <access_token>'

Create a private network group

To create a new group, you should provide only name, which should be from 3 to 18 characters:

1
2
3
4
5
6
curl  -L 'https://api.shipper.superdispatch.org/v1/public/private-network/groups' \
      -H 'Content-Type: application/json' \
      -H 'Authorization: Bearer <access_token>' \
      -d '{
          "name": "Can move EVs"
      }'

If the name field is blank or doesn’t have a length in the range between 3 and 18 characters, an HTTP 400 error will occur. Error HTTP 409 will be returned if a number of existing groups is already 10 or a group with the same name already exists.

Update (rename) the private network group

You can rename the existing group by GUID:

1
2
3
4
5
6
curl  -L -g -X PUT 'https://api.shipper.superdispatch.org/v1/public/private-network/groups/<group_guid>' \
      -H 'Content-Type: application/json' \
      -H 'Authorization: Bearer <access_token>' \
      -d '{
          "name": "Can move inoperable"
      }'

The same rules, as for group creation, are applied here.

Delete the private network group

1
2
curl  -L -g -X DELETE 'https://api.shipper.superdispatch.org/v1/public/private-network/groups/<group_guid>' \
      -H 'Authorization: Bearer <access_token>'

A few things to keep in mind:

When deleting a group, all Carriers will be removed from that group, but still remain within the Private Network.
All loads posted to that group will remain posted on the Private Loadboard until they are auto-posted to Super Loadboard / unposted / booked / etc.

Add carrier to the private network group

Once a group has been created, Carriers can be added to it. In order to be added to a group, the Carrier must be Approved and added to the Private Network. The endpoint for updating Carrier profile can set the status to Approved, add the Carrier to the Private Network and the group in a single request:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
curl  -L -X PUT 'https://api.shipper.superdispatch.org/v1/public/carriers/<carrier_guid>/profile' \
      -H 'Content-Type: application/json' \
      -H 'Authorization: Bearer <access_token>' \
      -d '{
              "approved": true,
              "preferred": true,
              "in_blacklist": false,
              "insurance_certificate_holder": false,
              "insurance_expires_at": null,
              "custom_external_id": "CARRIER-0001",
              "is_in_private_network": true,
              "private_network_groups": [
                  {
                      "guid": "<group_guid_1>"
                  },
                  {
                      "guid": "<group_guid_2>"
                  }
            ]
      }'

Please note that you can add a carrier to several groups at once.

Remove carrier from the private network group

To remove a carrier from a group/groups or whole private network, the same endpoint can be used:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
curl  -L -X PUT 'https://api.shipper.superdispatch.org/v1/public/carriers/<carrier_guid>/profile' \
      -H 'Content-Type: application/json' \
      -H 'Authorization: Bearer <access_token>' \
      -d '{
              "approved": true,
              "preferred": false,
              "in_blacklist": false,
              "insurance_certificate_holder": false,
              "insurance_expires_at": null,
              "custom_external_id": "CARRIER-0001",
              "is_in_private_network": true,
              "private_network_groups": [
                  {
                      "guid": "<group_guid_2>"
                  }
            ]
      }'

Post a load to the private network group

After setting up your private network groups, you can start posting loads to them, using the following API endpoint:

1
2
curl  -L -X POST 'https://api.shipper.superdispatch.org/v1/public/loadboard/orders/<order_guid>/private-network/<group_guid>' \
      -H 'Authorization: Bearer <access_token>'

Please note, that you can post the load only to one private network group or the whole private network.

After 2 hours (default), this load will be automatically reposted to the Super Loadboard (Public Loadboard) and become available to all carriers. You can adjust this behaviour in Super Loadboard settings.