DraftMarketplaceRequest
objectDetails of a marketplace on a draft listing.
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
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.
Example:0ca91a43-fbee-4c05-9a6c-aa5c63888f5c, d4efb4d9-2418-4070-b2f9-46317d578a31
Automatically creates a dispatch when a carrier accepts an offer on the listing. If not specified, the value defaults to the configuration of the marketplace the listing is posted to. If explicitly provided, the supplied value takes precedence.
Default:false
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. Defaults to the value of digitalOffersEnabled if null.
Example:true
DraftMarketplaceResponse
objectDetails of a marketplace on a draft listing.
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.
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.
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.
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.
A collection of customer IDs excluded from offers.
Example:d5c62b14-cbd1-11ee-9a0e-0242ac110002, 157a16f0-503d-4256-ba60-a4876e8eb9bb
Automatically creates a dispatch when a carrier accepts an offer on the listing. If not specified, the value defaults to the configuration of the marketplace the listing is posted to. If explicitly provided, the supplied value takes precedence.
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
DraftPriceRequest
objectDetails of the price of a draft listing.
The total amount to be paid for completing the dispatch.
>= 0.01
Example:500
The currency of the monetary field. This list is not exhaustive and additional values may be added at any time.
Allowed values:USD
Default:USD
Example:USD
Details of the cash on delivery portion of a draft listing price.
Show Child Parameters
Details of the balance portion of a draft listing price.
Show Child Parameters
DraftPriceResponse
objectDetails of the price of a draft listing.
The total amount to be paid for completing the dispatch.
Example:500
The currency of the monetary field. This list is not exhaustive and additional values may be added at any time.
Allowed values:USD
Default:USD
Example:USD
Details of the cash on delivery portion of a draft listing price.
Show Child Parameters
Details of the balance portion of a draft listing price.
Show Child Parameters
DraftSlaRequest
objectDetails of the service level agreement of a draft listing.
How many days the customer has to pick up/deliver. The format is ISO 8601 duration format P{duration in days}D where the number of days comes from when the listing becomes available. For example, P2D means 2 days. This sets the deadline for completing the transport.
Example:P2D
Which time zone to use for SLA calculations. For example, -5.00 represents Eastern Time and +0.00 represents UTC/GMT. Can be negative. Acceptable range: -12:00 to +14:00 hours.
Default:00:00:00
Example:-7:00
The time of day the “business day” ends. For example, 17:30 means 5:30 PM. If the load is accepted after this time and available for immediate pickup, the ability for it to be picked up on the same day is determined by includeCurrentDayAfterRollOver.
Match pattern:^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$
Default:00:00:00
Example:19:00:00
Indicates whether the load can be picked up after the rollover time if it is available on the same day the load is accepted. This could be do to the pickup location not being open or reachable after the rollover time. Does not apply to listings with availableDate in the future.
Example with 5:30 PM rollover:
When true: When accepting the load, the carrier can choose to pick it up after 5:30 PM. Sla duration starts tomorrow and ends on day 3.
When false: When accepting the load, the carrier cannot choose to pick it up after 5:30 PM today. It can only be picked up tomorrow as the pickup location has closed at the rollover time. Sla duration starts tomorrow and ends on day 3.
Example:true