Listings API V2

ListingCollection

object

A collection of listings.

hrefstring

The URL used to query the current collection of the resource.

Example:https://marketplace-api.centraldispatch.com/listings?limit(5,1)

countinteger(int32)

The total count of resources in the collection.

Example:23

itemsarray[object]

Details of a listing.

Show Child Parameters
Example

ListingRequest

object

Details of a listing.

shipperOrderIdstring

The ID of the shipper order.

<= 50 characters

Example:123-abc 900

externalIdstring

An identifier managed by the user. Shippers can use this field to map Central Dispatch dispatch ID to a record (e.g. order, shipment, dispatch) in their local TMS.

<= 50 characters

Example:RND10 CHEV

trailerTypestring

The trailer type.

Allowed values:DRIVEAWAYENCLOSEDOPEN

Default:OPEN

Example:OPEN

hasInOpVehicleboolean

Indicates whether the vehicle is inoperable.

Default:true

loadSpecificTermsstring

These are provisions added to a contract that specify extra obligations, rights, or conditions beyond the standard terms.
Real Life Example: Charging cables need to be picked up with vehicles and if left behind a $200 fee will be applied.
Rules: This information will be visible only to the assigned carrier after the load is dispatched, and it will no longer be editable at that point.

<= 500 characters

Example:Charging cables need to be picked up with vehicles and if left behind a $200 fee will be applied.

requiresInspectionboolean

Indicates the shipper requests for the carrier to use the Central Dispatch Mobile App to perform vehicle inspection at pickup and delivery. If true, the carrier will be asked to acknowledge the request before accepting the load.

Default:false

Example:true

requiresDriverVerificationAtPickupboolean

Indicates if the driver verification process is required. A driver must be assigned to the load before delivery. Information will be emailed to the contact physically present at the pickup location for use in verifying the driver’s identification. The Central Dispatch Mobile App must be used to perform the pickup and delivery inspection. (Only currently applicable to select private Marketplaces).

Default:false

Example:true

availableDatestring(date-time)

The available date of the listing, in UTC/ISO 8601 format. Must not be before today or later than 30 days from today.

Example:2025-02-20T00:00:00Z

expirationDatestring(date-time)

The expiration date of the listing, in UTC/ISO 8601 format. Must not be before today or later than 30 days from today. Will default to after creation date if not supplied.

Example:2025-03-10T00:00:00Z

desiredDeliveryDatestring(date-time)

The desired delivery date of the listing, in UTC/ISO 8601 format. Must be equal or greater than availableDate and not before today or later than 30 days from today (optional).

Example:2025-03-04T00:00:00Z

partnerReferenceIdstring

A user supplied ID used for reference.

<= 50 characters

Example:969175d4-a3f8-4e43-b64f-a95d77475aa0

priceobject

Details of the price.

Show Child Parameters
slaobject

Details of the service level agreement (SLA) for a listing. Only required for listings in marketplaces allowing digital offers. Currently only applicable to private marketplaces.

Show Child Parameters
stopsarray[object]

Details of a stop.

Show Child Parameters
vehiclesarray[object]

Details of a vehicle.

Show Child Parameters
marketplacesarray[object]

Details of a marketplace.

Show Child Parameters
tagsarray[object]

Details of a tag.

Show Child Parameters
transportationReleaseNotesstring

Displayed in Central Dispatch website/app as “Transport Special Instructions”, these are specific guidelines or details for the safe and efficient pick up, delivery, or transportation of a load. This may contain sensitive data and is not available prior to acceptance of terms by a carrier.
Rules: This information is visible only to the assigned carrier after the load is dispatched and remains editable at any time.

Example:You will need special clearance to get in the lot. Call Jean at 303-999-1212.

Example

ListingResponse

object

Details of a listing.

listingIdinteger(int64)

The ID of the listing.

Example:42220470

shipperIdstring(uuid)

The ID of the Central Dispatch customer who is the shipper.

Example:afd2fb59-b89d-4572-8f9a-e57f82a61c68

loadSpecificTermsstring

These are provisions added to a contract that specify extra obligations, rights, or conditions beyond the standard terms.
Real Life Example: Charging cables need to be picked up with vehicles and if left behind a $200 fee will be applied.
Rules: This information will be visible only to the assigned carrier after the load is dispatched, and it will no longer be editable at that point.

Example:Charging cables need to be picked up with vehicles and if left behind a $200 fee will be applied.

archivedDatestring(date-time)

The date and time the listing was archived, in UTC/ISO 8601 format.

Example:2024-08-01T00:00:00Z

availableDatestring(date-time)

The available date of the listing, in UTC/ISO 8601 format.

Example:2025-11-05T00:00:00.000Z

createdOnstring(date-time)

The date and time the listing was created, in UTC/ISO 8601 format.

Example:2024-10-15T00:00:00Z

deletedDatestring(date-time)

The date and time the listing was deleted, in UTC/ISO 8601 format.

Example:2024-09-10T00:00:00Z

desiredDeliveryDatestring(date-time)

The desired delivery date of the listing, in UTC/ISO 8601 format.

Example:2025-03-04T00:00:00Z

expirationDatestring(date-time)

The expiration date of the listing, in UTC/ISO 8601 format.

Example:2025-08-15T00:00:00.000Z

externalIdstring

An identifier managed by the user. Shippers can use this field to map Central Dispatch dispatch ID to a record (e.g. order, shipment, dispatch) in their local TMS.

Example:RND10 CHEV

hasInOpVehicleboolean

Indicates whether the vehicle is inoperable.

hrefstring

The fully qualified URL of the dispatch.

Example:https://marketplace-api.centraldispatch.com/listings/id/42220470

listingStatusstring

The status of the listing.

Allowed values:ACTIVEARCHIVEDDELETED

Example:ACTIVE

partnerIdstring

The Central Dispatch ID of the partner who created or last updated the transaction on behalf of the customer. Will be null if the customer made the API call directly.

Example:b6e8c9e4-989a-4b37-8dd7-99fd34882bd0

clientIdstring

The Central Dispatch ID of the user who created or last updated the resource.

Example:6e93ff07-6ea6-4239-b502-7bf4f68d2600

requiresInspectionboolean

Indicates the shipper requests for the carrier to use the Central Dispatch Mobile App to perform vehicle inspection at pickup and delivery. If true, the carrier will be asked to acknowledge the request before accepting the load.

Example:true

requiresDriverVerificationAtPickupboolean

Indicates if the driver verification process is required. A driver must be assigned to the load before delivery. Information will be emailed to the contact physically present at the pickup location for use in verifying the driver’s identification. The Central Dispatch Mobile App must be used to perform the pickup and delivery inspection. (Only currently applicable to select private Marketplaces).

Example:true

marketplacesarray[object]

Details of the marketplace.

Show Child Parameters
partnerReferenceIdstring

A user supplied ID used for reference.

Example:25-KL8CH6

priceobject

Details of the price.

Show Child Parameters
shipperOrderIdstring

The ID of the shipper order.

Example:123-abc 900

slaobject

Details of the service level agreement (SLA) for a listing.

Show Child Parameters
sourcestring

The source of the listing.

Allowed values:APIUI

Example:API

stopsarray[object]

Details of a stop.

Show Child Parameters
tagsarray[object]

Details of a listing tag.

Show Child Parameters
totalDistanceInMilesinteger(int32)

The total travel distance in miles.

Example:267

trailerTypestring

The trailer type.

Allowed values:DRIVEAWAYENCLOSEDOPEN

Default:OPEN

Example:OPEN

vehiclesarray[object]

Details of a vehicle.

Show Child Parameters
transportationReleaseNotesstring

Displayed in Central Dispatch website/app as “Transport Special Instructions”, these are specific guidelines or details for the safe and efficient pick up, delivery, or transportation of a load. This may contain sensitive data and is not available prior to acceptance of terms by a carrier.
Rules: This information is visible only to the assigned carrier after the load is dispatched and remains editable at any time.

Example:You will need special clearance to get in the lot. Call Jean at 303-999-1212.

Example

ListingStatus

string

The status of the listing.

Allowed values:ACTIVEARCHIVEDDELETED

Example

LocationType

string

The facility type of the stop.

Allowed values:UnspecifiedAirportRentalCenterAuctionAuctionSatelliteLotCommercialBusinessCorporateOfficePlantCrossDockSatelliteStagingLotDealershipImpoundMarshallingYardMilitaryBaseMobileAuctionPortRailYardReconFacilityRentalCarRetailSiteRepoResidenceServiceCenterConsumerMovesTerminalOtherMechanicShopWarehouseParkingLot

Default:Unspecified

Example