LocationType
stringThe facility type of the stop.
Allowed values:UnspecifiedAirportRentalCenterAuctionAuctionSatelliteLotCommercialBusinessCorporateOfficePlantCrossDockSatelliteStagingLotDealershipImpoundMarshallingYardMilitaryBaseMobileAuctionPortRailYardReconFacilityRentalCarRetailSiteRepoResidenceServiceCenterConsumerMovesTerminalOtherMechanicShopWarehouseParkingLot
Default:Unspecified
MarketplaceRequest
objectDetails of a marketplace.
The ID of the Central Dispatch Marketplace. There are three types of Marketplaces:
- Public: The public Marketplace ID is
10000. - Test: Test Marketplace IDs will be provided to you by Central Dispatch.
- Private: Private Marketplace IDs will be provided to you by Central Dispatch, if necessary.
Example:10000
Indicates whether digital offers are enabled for this Marketplace on this listing. Digital offers functionality is currently only available for select private Marketplaces. When true the following are required:
slais required.stopsaddress is required.vehiclesall vehicles must have VIN.
Default:false
Example:true
Controls whether the listing appears in Marketplace search results. Allows listings to be posted but not publicly searchable. When true: listing is visible and searchable on this Marketplace. When false: listing is hidden from Marketplace search.
Default:false
Example:true
Allows carrriers to digitially accept an offer. The button will be visible for this Marketplace on this listing. Requires digitalOffersEnabled to be true.
Default:false
Automatically creates dispatch when an offer is accepted.
Default:false
Example:true
Provides general preparation instructions for shipments. This should not contain sensitive data as it is made available prior to acceptance of terms by a carrier.
Rules: This information will always be visible to carriers, and it will no longer be editable once the load is dispatched.
<= 500 characters
Example:In order to pick up the keys you will have to walk through a lot with a big dog that protects it, he's chained but will bark at you.
A collection of customer IDs excluded from offers. Maximum count of 200.
Example:d5c62b14-cbd1-11ee-9a0e-0242ac110002, 157a16f0-503d-4256-ba60-a4876e8eb9bb
Allows carriers to make an offer on the listing. The button will be visible for this Marketplace on this listing. Requires digitalOffersEnabled to be true. Defaults to the value of digitalOffersEnabled if null.
Example:true
MarketplaceResponse
objectDetails of the marketplace.
Automatically creates dispatch when an offer is accepted.
Example:true
A collection of customer IDs excluded from offers.
Example:d5c62b14-cbd1-11ee-9a0e-0242ac110002, 157a16f0-503d-4256-ba60-a4876e8eb9bb
Indicates whether digital offers are enabled for this Marketplace on this listing. Digital offers functionality is currently only available for select private Marketplaces.
Example:true
The ID of the Central Dispatch Marketplace. There are three types of Marketplaces:
- Public: The public Marketplace ID is
10000. - Test: Test Marketplace IDs will be provided to you by Central Dispatch.
- Private: Private Marketplace IDs will be provided to you by Central Dispatch, if necessary.
Example:10000
Allows carrriers to digitially accept an offer. The button will be visible for this Marketplace on this listing. Requires digitalOffersEnabled to be true.
Example:true
Provides general preparation instructions for shipments. This should not contain sensitive data as it is made available prior to acceptance of terms by a carrier.
Rules: This information will always be visible to carriers, and it will no longer be editable once the load is dispatched.
Example:In order to pick up the keys you will have to walk through a lot with a big dog that protects it, he's chained but will bark at you.
Controls whether the listing appears in Marketplace search results. Allows listings to be posted but not publicly searchable. When true: listing is visible and searchable on this Marketplace. When false: listing is hidden from Marketplace search.
Example:true
Allows carriers to make an offer on the listing. The button will be visible for this Marketplace on this listing. Requires digitalOffersEnabled to be true.
Example:true
PriceRequest
objectDetails of the price.
The total amount to be paid for completing the dispatch.
>= 0.01
Example:500
The currency of the monetary field.
Allowed values:USD
Default:USD
Example:USD
Details of the cash on delivery or cash on pick-up (COD/COP).
Show Child Parameters
Details of the balance.
Show Child Parameters
PriceResponse
objectDetails of the price.
The total amount to be paid for completing the dispatch.
Example:500
The currency of the monetary field.
Allowed values:USD
Default:USD
Example:USD
Details of cash on delivery or cash on pick up (COD/COP).
Show Child Parameters
Details of the balance.