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.
Show Child Parameters
ShippingSpecsRequest
objectDetails of the shipping specifications of a vehicle.
The height of the vehicle. If the value is not sent it will be completed based on the vehicle information if available.
Default:0
Example:58
The width of the vehicle.
Default:0
Example:62
The length of the vehicle.
Default:0
Example:143
The weight of the vehicle.
Default:0
Example:2246
ShippingSpecsResponse
objectDetails of the shipping specifications of a vehicle.
The height of the vehicle.
Example:58
The width of the vehicle.
Example:62
The length of the vehicle.
Example:143
The weight of the vehicle.
Example:2246
SlaRequest
objectDetails of the service level agreement (SLA) for a listing. Only required for listings in marketplaces allowing digital offers. Currently only applicable to private marketplaces.
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
SlaResponse
objectDetails of the service level agreement (SLA) for a 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.
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})?$
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