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.

Header Parameters
    Authorization string required

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

    Example: 1AbC2DeFgH34IJKlm5N6O7p8QR9s0tU1VWcYZABcDeFg2HIJ
    Content-Type string required

    The content type of the request. Currently we accept application/json or application/xml. If these don't work for you, please reach out to your technical contact at Chaine.

    Example: application/json
Request Body required
    originCity string required

    The origin city of the shipment. Either city and state OR postal code is required.

    originState string required

    The origin state of the shipment. Either city and state OR postal code is required.

    originPostalCode string

    The origin postal code of the shipment. Either city and state OR postal code is required.

    destinationCity string required

    The destination city of the shipment. Either city and state OR postal code is required.

    destinationState string required

    The destination state of the shipment. Either city and state OR postal code is required.

    destinationPostalCode string

    The destination postal code of the shipment. Either city and state OR postal code is required.

    equipmentType string[]

    Possible values: [Box truck, Conestoga, Deck, Double drop, Dry bulk, Flatbed, Power only, Reefer, Step deck, Van]

    The equipment type of the shipment provided as an array. If not provided, all equipment types will be considered.

    paginationKey string

    The pagination key to be used for the next request. If this is not provided, the first page of results is returned. If this is returned as null, there are no more results to be fetched.

    includeTripHistory boolean

    Default value: false

    If true, the trip history of the carriers will be included in the response. If false, the trip history will not be included.

    returnedCarriersLimit integer

    Possible values: >= 1 and <= 100

    Default value: 100

    The number of carriers to be returned in the response. The maximum limit is 100.

Responses

Successfully retrieved capacity suggestions


Schema
    paginationKey string

    The pagination key to be used for the next request. If this is null, there are no more results to be fetched.

    carriers object[]

    The carriers that match the capacity suggestions

  • Array [
  • carrierName string

    The name of the carrier

    dispatchers object[]

    All the dispatchers of the carrier as part of your network

  • Array [
  • id string

    Chaine's unique dispatcher ID for your network

    email string

    The email of the dispatcher

  • ]
  • dotNumber string

    The DOT number of the carrier

    id string

    Chaine's unique carrier ID for your network

    mcNumber string

    The MC number of the carrier

    tripHistory object[]

    The trip history of the carrier

  • Array [
  • loadNumber string

    Your load number of the trip

    originCity string

    The origin city of the trip

    originState string

    The origin state of the trip

    destinationCity string

    The destination city of the trip

    destinationState string

    The destination state of the trip

    numberOfStops integer

    The number of stops in the trip

    rate number

    The carrier freight cost of the trip in USD

    equipmentType array

    Possible values: [Box truck, Conestoga, Deck, Double drop, Dry bulk, Flatbed, Power only, Reefer, Step deck, Van]

    The equipment type of the trip

    deliveryDate date

    The delivery date of the trip

  • ]
  • ]
Loading...