Get Global Settings

SecurityAPIKeyHeader
Responses
200

Successful Response

Response Schema: application/json
enable_book_now
boolean (Enable Book Now)
Default: false

Enable book it now. Request it with True to start syncing the carriers or False to disable it.

use_24_hour_time
boolean (Use 24 Hour Time)
Default: false

Use 24 hour time format.

object (Loadposts)
Default: {"equipment_type":"DRY_VAN","dimensions":{"unit":"FT","length":53},"gross_weight":{"unit":"LB","value":45000},"primary_contact":"PRIMARY_PHONE"}

Loadposts settings.

object (Rating)
Default: {"enable_spot":true,"enable_contract":true,"enable_forecast":true}

Rating settings.

enable_book_now_status
string (EnableBookNowStatus)
Default: "disabled"

Enable book it now status.

Enum: "disabled" "accepted" "initiated" "partial_failed" "failed" "enabled"
get/loadboards/settings
Request samples
Response samples
application/json
{
  • "enable_book_now": false,
  • "use_24_hour_time": false,
  • "loadposts": {
    },
  • "rating": {
    },
  • "enable_book_now_status": "disabled"
}
Copyright © Shipwell 2024. All right reserved.