Testing ApproachTest CredentialsIn this section, we will walk you through the details of your test API credentials.
ABC123 Broker - API Credentials - TEST
ClientId: 123456-789-10111213-14151617
ClientSecret: 123456-789-10111213-14151617
-TestMarketplaceId: 100099
API Access: Listings, Fulfillment, Dispatch Documents, Membership,
& Events
-----------------------------------
Test Carrier Account:
CustomerID: abcdefgh-ijk1m-nopq-12345
UserName: testcarrier
Test Broker Account:
CustomerId: aporm-lkji-hgfedeba- 12345
UserName: testbroker
ClientId: 123456-789-10111213-14151617
ClientSecret: 123456-789-10111213-14151617
Use your Client ID & Client Secret to request an access token to call the Central Dispatch APIs.
- The Central Dispatch team does not keep your credentials beyond 15 days. If you lose your credentials, we will need to create new ones for you.
-TestMarketplaceId: 100099
Use the Test Marketplace ID to test your integration without affecting the live public marketplace. This ID is unique to you.
- The Test Marketplace acts as your sandbox environment.
- The user interface in the Test Marketplace is limited. You won't be able to create listings or dispatches through the UI.
- This environment is specifically designed for testing API integrations, not for using the full Central Dispatch UI.
Test Carrier Account:
CustomerID: abcdefgh-ijk1m-nopq-12345
UserName: testcarrier
If you’ve been subscribed to use our Marketplace Data Services APIs (i.e., Fulfillment) you will receive a Test Carrier account.
- When creating a Dispatch using the API, you need to assign it to a Carrier using your Test Carrier Customer ID
- Only your Test Carrier is assigned to your Test Marketplace. If you try to assign a carrier outside of your Test Carrier, you will get an error message.
- If you need to complete a dispatch as a Shipper and act as a Carrier, use the Dispatches page to access limited UI Carrier functions, like accepting or declining the assigned dispatch (https://app.centraldispatch.com/dispatch/shipper).
- To learn how to claim your test account and link it to your email and Central Dispatch account, please refer to the ‘Central Dispatch UI Application Testing’ section of this guide.
Test Broker Account:
CustomerId: aporm-lkji-hgfedeba- 12345
UserName: testbroker
To create your test credentials, we set up a Test Broker account. This account helps ensure that your testing environment is properly configured. You do not need to use this information to test your APIs.
Transitioning to Production
- Once testing is complete, please notify DataSyndicationSupport@centraldispatch.com.
- We will create your PROD API credentials, which will include a new Client ID and Client Secret.
- These credentials will be linked to your live Central Dispatch account.
- Use the Public Marketplace (ID: 10000) with your PROD API credentials.
- Please allow us 3 business days to complete the configuration of your Prod Credentials.
Central Dispatch UI Application TestingCentral Dispatch UI Application Testing
If you wish to log into Central Dispatch as your Test Carrier to complete your dispatching activities during the testing phase, please follow the steps below.
- You will receive an email in your inbox associated with the test accounts. Select 'Accept Invitation.'
- Once you select 'Accept Invitation,' you will be prompted to choose whether to link your test account to your actual Central Dispatch account or create a new account to claim the test account.
- If you select 'No,' you will be prompted to create a new user account.
- If you select 'Yes,' you will be prompted to sign in to your existing Central Dispatch login.
- Note: There is a requirement that your user login email must match the email that the invite was sent to.
- After creating a new account or linking your accounts, please log in.
- If you have linked your accounts, once you log in, you will be directed to the company switcher, which will display all companies your login is linked to.
Test Credentials
In this section, we will walk you through the details of your test API credentials.
ABC123 Broker - API Credentials - TEST
ClientId: 123456-789-10111213-14151617
ClientSecret: 123456-789-10111213-14151617
-TestMarketplaceId: 100099
API Access: Listings, Fulfillment, Dispatch Documents, Membership,
& Events
-----------------------------------
Test Carrier Account:
CustomerID: abcdefgh-ijk1m-nopq-12345
UserName: testcarrier
Test Broker Account:
CustomerId: aporm-lkji-hgfedeba- 12345
UserName: testbroker
ClientId: 123456-789-10111213-14151617
ClientSecret: 123456-789-10111213-14151617
Use your Client ID & Client Secret to request an access token to call the Central Dispatch APIs.
- The Central Dispatch team does not keep your credentials beyond 15 days. If you lose your credentials, we will need to create new ones for you.
-TestMarketplaceId: 100099
Use the Test Marketplace ID to test your integration without affecting the live public marketplace. This ID is unique to you.
- The Test Marketplace acts as your sandbox environment.
- The user interface in the Test Marketplace is limited. You won't be able to create listings or dispatches through the UI.
- This environment is specifically designed for testing API integrations, not for using the full Central Dispatch UI.
Test Carrier Account:
CustomerID: abcdefgh-ijk1m-nopq-12345
UserName: testcarrier
If you’ve been subscribed to use our Marketplace Data Services APIs (i.e., Fulfillment) you will receive a Test Carrier account.
- When creating a Dispatch using the API, you need to assign it to a Carrier using your Test Carrier Customer ID
- Only your Test Carrier is assigned to your Test Marketplace. If you try to assign a carrier outside of your Test Carrier, you will get an error message.
- If you need to complete a dispatch as a Shipper and act as a Carrier, use the Dispatches page to access limited UI Carrier functions, like accepting or declining the assigned dispatch (https://app.centraldispatch.com/dispatch/shipper).
- To learn how to claim your test account and link it to your email and Central Dispatch account, please refer to the ‘Central Dispatch UI Application Testing’ section of this guide.
Test Broker Account:
CustomerId: aporm-lkji-hgfedeba- 12345
UserName: testbroker
To create your test credentials, we set up a Test Broker account. This account helps ensure that your testing environment is properly configured. You do not need to use this information to test your APIs.
Transitioning to Production
Transitioning to Production
- Once testing is complete, please notify DataSyndicationSupport@centraldispatch.com.
- We will create your PROD API credentials, which will include a new Client ID and Client Secret.
- These credentials will be linked to your live Central Dispatch account.
- Use the Public Marketplace (ID: 10000) with your PROD API credentials.
- Please allow us 3 business days to complete the configuration of your Prod Credentials.
Central Dispatch UI Application Testing
Central Dispatch UI Application Testing
If you wish to log into Central Dispatch as your Test Carrier to complete your dispatching activities during the testing phase, please follow the steps below.
- You will receive an email in your inbox associated with the test accounts. Select 'Accept Invitation.'
- Once you select 'Accept Invitation,' you will be prompted to choose whether to link your test account to your actual Central Dispatch account or create a new account to claim the test account.
- If you select 'No,' you will be prompted to create a new user account.
- If you select 'Yes,' you will be prompted to sign in to your existing Central Dispatch login.
- Note: There is a requirement that your user login email must match the email that the invite was sent to.
- After creating a new account or linking your accounts, please log in.
- If you have linked your accounts, once you log in, you will be directed to the company switcher, which will display all companies your login is linked to.
Test GuidesListing API Test GuideFulfillment API Test GuideDispatch Documents API Test GuideAPI Integration Test Guide
Listing API Test Guide
Fulfillment API Test Guide
Dispatch Documents API Test Guide
API Integration Test Guide
User GuidesProcess OverviewUSE CASE: A shipper has a load that needs to be transported from Point A to Point B. The APIs are used to connect the shipper with a carrier, form an agreement, and arrange transportation.
Phase Step Actor API Service Endpoint Action Result Load Creation 1 Shipper Listings API POST /listingsShipper creates a new listing. The listing is posted to the Central Dispatch load board for carrier consumption. 2 Carrier N/A N/A Carrier contacts shipper via phone or email and agrees to transport load. Shipper can now initiate dispatch. Dispatch Setup 3 Shipper Membership API GET /customers?marketplace={marketplaceId}&name={name}&mcnumber={mcnumber}&usdotnumber={usdot}&phonenumber={phonenumber}&email={email}&limit({startingpoint},{numberofresults})Shipper looks up the carrier's information. Carrier Customer ID is retrieved and will be used for dispatch. 4 Shipper Fulfillment API POST /fulfillments/createShipper creates up the dispatch. The dispatch is created and assigned to the chosen carrier. Carrier Acceptance 5 Carrier Fulfillment API POST /fulfillments/searchCarrier retrieves all assigned loads. Assigned dispatches are retrieved by carrier. 6 Carrier Fulfillment API POST /fulfillments/{dispatchId}/respondCarrier accepts the load. The load is confirmed as accepted. Dispatch Updates 7 Shipper Fulfillment API GET /fulfillments/id/{dispatchId}Get the current dispatch details. Etag value is retrieved and may be used for the Update Dispatch request. 8 Shipper Fulfillment API POST /fulfillments/updateMake changes to the dispatch. Your updates are saved to the dispatch. Driver Assignment 9 Carrier Membership API GET /users/mineCarrier gets their driver details. Driver ID is received and will be used for assignment. 10 Carrier Fulfillment API GET /fulfillments/id/{dispatchId}Carrier gets the latest dispatch information. Etag value is retrieved to be used for a Assign Driver request. 11 Carrier Fulfillment API PATCH /fulfillments/{dispatchId}/driversCarrier assigns a driver to the load. Driver is assigned to the dispatch. Load Tracking 12 Carrier N/A N/A Carrier completes pick up inspection using Central Dispatch Mobile App. Shipper is able to track carriers location.
Note: All API endpoints are relative to their respective base URLs. See API Reference for endpoints.Create a ListingWhen you need to transport vehicles, the first step is creating a listing on the Central Dispatch load board. You're letting carriers know you have vehicles that need to be moved from one place to another. Once posted, your listing becomes visible to qualified carriers who can then contact you about transporting the load.
Your listing helps carriers understand:
- What vehicles need to be transported.
- Where they're being picked up and delivered.
- When they need to be moved.
- How much you're willing to pay.
- Any special requirements or instructions.
Listing API
POST /listings
Usage Notes
- Include at least two unique stops (pickup and delivery locations).
- At least one vehicle must be included and no more than twelve.
- Specify payment terms using COD and/or balance payment options.
Success
When your listing is created successfully (status code 201), you'll receive:- A URL to access the new listing in the
Location header. The last segment of the URL will contain the listing ID. - A version identifier
ETag to be used in the If-Match header of future updates.
Create a DispatchCreate a new dispatch to assign a carrier to transport vehicles. You can create a dispatch with or without first creating a listing. When you create a dispatch, you're setting up the transportation agreement between a shipper and carrier. The dispatch includes all necessary details like pickup/delivery locations, vehicle information, and payment terms.
Fulfillment API
POST /api/fulfillments/create
Usage Notes
- Include at least two unique stops (pickup and delivery locations).
- Provide vehicle details with either: a valid VIN number, or complete vehicle specifications (year, make, and model).
- Specify payment terms using COD and/or balance payment options.
- When creating a dispatch from an existing listing, the status is automatically set to
PENDING_PICKUP.
Success
When your dispatch is created successfully (status code 201), you'll receive:- A URL to access the new dispatch in the
Location header. The last segment of the URL will contain the dispatch ID. - A version identifier
ETag to be used in the If-Match header of future updates.
Accept a DispatchAccept an assigned dispatch through the API. This endpoint is exclusively for carriers to accept loads assigned to them.
Fulfillment API
POST /api/fulfillments/{dispatchId}/respond
Manage a DispatchAfter a dispatch is created, you can perform several management operations including updates, accepting loads, and date changes.
Update a Dispatch
Update details of an existing dispatch. You cannot modify a dispatch after it's marked as delivered.
Fulfillment API
POST /api/fulfillments/update
Update Dates
Modify pickup and delivery dates or mark status changes.
Fulfillment API
PUT /api/fulfillments/id/{dispatchId}/dates
Common Use Cases
- Update estimated pickup/delivery times
- Mark a load as picked up
- Mark a load as delivered
- Adjust delivery schedule
Note: Date change reasons are only required when modifying estimated dates, not actual dates.
Cancel a DispatchCancel an existing dispatch that hasn't been delivered yet. Different rules apply for carriers and shippers.
Fulfillment API
POST /api/fulfillments/cancel
Cancellation Rules
For Shippers
- Can cancel at any point in the dispatch lifecycle.
- No cancellation reason required.
- Can cancel any of their dispatches.
For Carriers
- Must provide a valid cancellation reason.
- Cannot cancel after pickup.
- Can only cancel dispatches assigned to them.
Process Overview
- Retrieve the list of valid cancellation reasons (Required for Carriers)
GET /api/fulfillments/loadcancellationreasons
- Cancel the Dispatch
POST /api/fulfillments/cancel
Usage Notes
- A dispatch with status
DELIVERED cannot be canceled. - A dispatch with status
PENDING_DELIVERY can be canceled only if postPickupCancelOverride is set to true. - Cancellation will affect all vehicles in the dispatch.
- Once canceled, a dispatch cannot be reactivated.
Event Notification User Guide
Process Overview
USE CASE: A shipper has a load that needs to be transported from Point A to Point B. The APIs are used to connect the shipper with a carrier, form an agreement, and arrange transportation.
| Phase | Step | Actor | API Service | Endpoint | Action | Result |
|---|---|---|---|---|---|---|
| Load Creation | 1 | Shipper | Listings API | POST /listings | Shipper creates a new listing. | The listing is posted to the Central Dispatch load board for carrier consumption. |
| 2 | Carrier | N/A | N/A | Carrier contacts shipper via phone or email and agrees to transport load. | Shipper can now initiate dispatch. | |
| Dispatch Setup | 3 | Shipper | Membership API | GET /customers?marketplace={marketplaceId}&name={name}&mcnumber={mcnumber}&usdotnumber={usdot}&phonenumber={phonenumber}&email={email}&limit({startingpoint},{numberofresults}) | Shipper looks up the carrier's information. | Carrier Customer ID is retrieved and will be used for dispatch. |
| 4 | Shipper | Fulfillment API | POST /fulfillments/create | Shipper creates up the dispatch. | The dispatch is created and assigned to the chosen carrier. | |
| Carrier Acceptance | 5 | Carrier | Fulfillment API | POST /fulfillments/search | Carrier retrieves all assigned loads. | Assigned dispatches are retrieved by carrier. |
| 6 | Carrier | Fulfillment API | POST /fulfillments/{dispatchId}/respond | Carrier accepts the load. | The load is confirmed as accepted. | |
| Dispatch Updates | 7 | Shipper | Fulfillment API | GET /fulfillments/id/{dispatchId} | Get the current dispatch details. | Etag value is retrieved and may be used for the Update Dispatch request. |
| 8 | Shipper | Fulfillment API | POST /fulfillments/update | Make changes to the dispatch. | Your updates are saved to the dispatch. | |
| Driver Assignment | 9 | Carrier | Membership API | GET /users/mine | Carrier gets their driver details. | Driver ID is received and will be used for assignment. |
| 10 | Carrier | Fulfillment API | GET /fulfillments/id/{dispatchId} | Carrier gets the latest dispatch information. | Etag value is retrieved to be used for a Assign Driver request. | |
| 11 | Carrier | Fulfillment API | PATCH /fulfillments/{dispatchId}/drivers | Carrier assigns a driver to the load. | Driver is assigned to the dispatch. | |
| Load Tracking | 12 | Carrier | N/A | N/A | Carrier completes pick up inspection using Central Dispatch Mobile App. | Shipper is able to track carriers location. |
Create a Listing
When you need to transport vehicles, the first step is creating a listing on the Central Dispatch load board. You're letting carriers know you have vehicles that need to be moved from one place to another. Once posted, your listing becomes visible to qualified carriers who can then contact you about transporting the load.
Your listing helps carriers understand:
- What vehicles need to be transported.
- Where they're being picked up and delivered.
- When they need to be moved.
- How much you're willing to pay.
- Any special requirements or instructions.
Listing API
POST /listings
Usage Notes
- Include at least two unique stops (pickup and delivery locations).
- At least one vehicle must be included and no more than twelve.
- Specify payment terms using COD and/or balance payment options.
Success
When your listing is created successfully (status code 201), you'll receive:- A URL to access the new listing in the
Locationheader. The last segment of the URL will contain the listing ID. - A version identifier
ETagto be used in theIf-Matchheader of future updates.
Create a Dispatch
Create a new dispatch to assign a carrier to transport vehicles. You can create a dispatch with or without first creating a listing. When you create a dispatch, you're setting up the transportation agreement between a shipper and carrier. The dispatch includes all necessary details like pickup/delivery locations, vehicle information, and payment terms.
Fulfillment API
POST /api/fulfillments/create
Usage Notes
- Include at least two unique stops (pickup and delivery locations).
- Provide vehicle details with either: a valid VIN number, or complete vehicle specifications (year, make, and model).
- Specify payment terms using COD and/or balance payment options.
- When creating a dispatch from an existing listing, the status is automatically set to
PENDING_PICKUP.
Success
When your dispatch is created successfully (status code 201), you'll receive:- A URL to access the new dispatch in the
Locationheader. The last segment of the URL will contain the dispatch ID. - A version identifier
ETagto be used in theIf-Matchheader of future updates.
Accept a Dispatch
Accept an assigned dispatch through the API. This endpoint is exclusively for carriers to accept loads assigned to them.
Fulfillment API
POST /api/fulfillments/{dispatchId}/respond
Manage a Dispatch
After a dispatch is created, you can perform several management operations including updates, accepting loads, and date changes.
Update a Dispatch
Update details of an existing dispatch. You cannot modify a dispatch after it's marked as delivered.
Fulfillment API
POST /api/fulfillments/update
Update Dates
Modify pickup and delivery dates or mark status changes.
Fulfillment API
PUT /api/fulfillments/id/{dispatchId}/dates
Common Use Cases
- Update estimated pickup/delivery times
- Mark a load as picked up
- Mark a load as delivered
- Adjust delivery schedule
Note: Date change reasons are only required when modifying estimated dates, not actual dates.
Cancel a Dispatch
Cancel an existing dispatch that hasn't been delivered yet. Different rules apply for carriers and shippers.
Fulfillment API
POST /api/fulfillments/cancel
Cancellation Rules
For Shippers
- Can cancel at any point in the dispatch lifecycle.
- No cancellation reason required.
- Can cancel any of their dispatches.
For Carriers
- Must provide a valid cancellation reason.
- Cannot cancel after pickup.
- Can only cancel dispatches assigned to them.
Process Overview
- Retrieve the list of valid cancellation reasons (Required for Carriers)
GET /api/fulfillments/loadcancellationreasons
- Cancel the Dispatch
POST /api/fulfillments/cancel
Usage Notes
- A dispatch with status
DELIVEREDcannot be canceled. - A dispatch with status
PENDING_DELIVERYcan be canceled only ifpostPickupCancelOverrideis set to true. - Cancellation will affect all vehicles in the dispatch.
- Once canceled, a dispatch cannot be reactivated.
Event Notification User Guide