Skip to main content

Get capacity suggestions​

This end-point is used to get capacity suggestions from within your network. This is a high throughput end-point and can handle thousands of requests per second. It is highly available, fault tolerant, and scalable.

Query Parameters
    originCity string required

    The origin city of the shipment.

    originStateCode string required

    The origin state code of the shipment.

    destinationCity string required

    The destination city of the shipment.

    destinationStateCode string required

    The destination state code of the shipment.

Header Parameters
    Authorization string required

    API Key that a Chaine Admin or Owner creates in their workspace under developer settings.

    Content-Type string required

    The content type of the request. Currently we accept application/json or application/xml.

Responses

Successfully retrieved capacity suggestions

Schema
  • Array [
    • averageRate object

    The average rate of the carrier for the given origin and destination pair

    currency string

    The currency of the rate. i.e. USD or CAD

    value number

    The value of the average rate

    connection object

    The carrier connection on Chaine and the carrier's details

    carrierContractType string

    The type of contract with the carrier. Either "Contract" or "Spot"

    connectionRole string

    The role of the connection. Either "Carrier" or "Broker"

    status string

    The status of the connection. Either "Connected" or "Removed". If the status is "Removed", the carrier is no longer part of your network.

    equipmentTags string[]

    An array of unique equipment types the carrier has done in addition to what is listed in the standard equipment types in truckTypes

    numberOfFalloffs integer

    The number of loads where the carrier felloff

    numberOfTrips integer

    The number of trips the carrier has completed

    truckTypes string[]

    An array of equipment types the carrier has done on this lane. This is an enum of 'Box truck', 'Conestoga', 'Deck', 'Double drop', 'Dry bulk', 'Flatbed', 'Other', 'Power only', 'Reefer', 'Step deck', 'Van'

    workspace object

    The workspace details of the carrier. A workspace is a concept in Chaine of a company. This will have the relevant details of the carrier's workspace along with all members (dispatchers, owners) that are part of the workspace.

    displayName string

    The display name of the workspace

    id string

    The unique ID of the workspace in Chaine

    mcNumber string

    The MC number of the workspace

    dot string

    The DOT number of the workspace

    members object[]

    The members of the workspace. This will include all the dispatchers and owners of the workspace along with their contact details.

  • Array [
    • role string

    The role of the member in the workspace. Either "Dispatcher", "Driver" or "Management"

    status string

    The status of the member in the workspace indicating whether the person is still at the company. Either 'Requested', 'Invited', 'Active', or 'Inactive'

    user object

    The details of the user.

    name string

    The name of the user

    email string

    The email of the user

    phone string

    The phone number of the user

  • ]
  • ]
Loading...