Rating and booking

Server

Download schema

Create, rate and book in one call, re-rate a changed load, and book the best-value carrier.

Book the best-value carrier

POST

https://tmstest.reconex.io

/api/v1/IntegrationApi/BookBestwayCarrier

apikey (header)

Book the best-value carrier › Request Body

BookLoadCostRequest

loadId

integer · int32

proNumber

string | null

billingId

string | null

poNumber

string | null

isHotShipment

boolean

Book the best-value carrier › Responses

200

BookLoadCostResponse

BookLoadCostInformation

array | null

POST/api/v1/IntegrationApi/BookBestwayCarrier

curl https://tmstest.reconex.io/api/v1/IntegrationApi/BookBestwayCarrier \
  --request POST \
  --header 'Content-Type: application/json-patch+json' \
  --header 'apikey: <api-key>' \
  --data '{
  "loadId": 0,
  "proNumber": "proNumber",
  "billingId": "billingId",
  "poNumber": "poNumber",
  "isHotShipment": true
}'

Example Request Body

{
  "loadId": 0,
  "proNumber": "proNumber",
  "billingId": "billingId",
  "poNumber": "poNumber",
  "isHotShipment": true
}

json

Example Responses

{
  "information": {
    "resultCode": "resultCode",
    "isPROchanged": true,
    "isBooked": true,
    "loadID": "loadID",
    "proNumber": "proNumber",
    "poNumber": "poNumber",
    "billingID": "billingID"
  },
  "errors": [
    {
      "error": "error"
    }
  ],
  "warnings": [
    {
      "warning": "warning"
    }
  ]
}

text

Update and re-rate a load

POST

https://tmstest.reconex.io

/api/v1/IntegrationApi/UpdateAndReRateLoad

apikey (header)

Update and re-rate a load › Request Body

UpdateReRateRequest

mustArriveByDate

string | null · date-time

loadId

integer · int32

BillingReRateInformation

array | null

Update and re-rate a load › Responses

200

QuoteEngineResponse

Information

array | null

POST/api/v1/IntegrationApi/UpdateAndReRateLoad

curl https://tmstest.reconex.io/api/v1/IntegrationApi/UpdateAndReRateLoad \
  --request POST \
  --header 'Content-Type: application/json-patch+json' \
  --header 'apikey: <api-key>' \
  --data '{
  "mustArriveByDate": "2024-08-25T15:00:00Z",
  "loadId": 0,
  "billingInformation": {
    "terms": "terms",
    "role": "role",
    "billingID": "billingID",
    "poNumber": "poNumber",
    "proNumber": "proNumber",
    "customID": "customID",
    "name": "name",
    "street1": "street1",
    "street2": "street2",
    "city": "city",
    "state": "state",
    "zip": "zip",
    "country": "country"
  },
  "originLocation": {
    "contact": "contact",
    "phone": "phone",
    "fax": "fax",
    "email": "email",
    "other": "other",
    "type": "type",
    "notes": "notes",
    "number": "number",
    "dockOpen": "2024-08-25T15:00:00Z",
    "dockClose": "2024-08-25T15:00:00Z",
    "notesNotOnBOL": "notesNotOnBOL",
    "appointment": true,
    "appointmentDate": "2024-08-25T15:00:00Z",
    "freightReadyTime": "2024-08-25T15:00:00Z",
    "name": "name",
    "street": "street",
    "street2": "street2",
    "city": "city",
    "stateProvince": "stateProvince",
    "postalCode": "postalCode",
    "country": "country"
  },
  "destinationLocation": {
    "contact": "contact",
    "phone": "phone",
    "fax": "fax",
    "email": "email",
    "other": "other",
    "type": "type",
    "notes": "notes",
    "number": "number",
    "dockOpen": "2024-08-25T15:00:00Z",
    "dockClose": "2024-08-25T15:00:00Z",
    "notesNotOnBOL": "notesNotOnBOL",
    "appointment": true,
    "appointmentDate": "2024-08-25T15:00:00Z",
    "freightReadyTime": "2024-08-25T15:00:00Z",
    "name": "name",
    "street": "street",
    "street2": "street2",
    "city": "city",
    "stateProvince": "stateProvince",
    "postalCode": "postalCode",
    "country": "country"
  },
  "items": [
    {
      "qty": "qty",
      "packaging": "packaging",
      "freightClass": "freightClass",
      "weight": "weight",
      "nmfCnumber": "nmfCnumber",
      "subClass": "subClass",
      "description": "description",
      "hazMat": {
        "isHazMat": true,
        "unNa": "unNa",
        "unNaNumber": "unNaNumber",
        "hazClass": "hazClass",
        "pgCode": "pgCode",
        "subRisk": 0,
        "vol": 0,
        "limitedQuantity": true
      },
      "itemDimensions": {
        "length": 0,
        "height": 0,
        "width": 0,
        "shipQuantity": 0
      }
    }
  ],
  "accessorials": {
    "doNotFreeze": true,
    "overLength": true,
    "sortAndSegregate": true,
    "blindShipment": true,
    "whiteGloveDelivery": true,
    "expedite": true,
    "insuranceRequired": true,
    "falveyInsValue": 0,
    "volumeLoad": true,
    "guaranteed": true,
    "mabd": true,
    "destinationNotification": true,
    "originInsidePickup": true,
    "originLiftGate": true,
    "destinationInsideDelivery": true,
    "destinationLiftGate": true,
    "inBond": true
  },
  "additionalLoadInfo": {
    "pickedUpDate": "2024-08-25T15:00:00Z",
    "specialInstructions": "specialInstructions",
    "shippingQuantity": 0,
    "loadEquipmentType": "loadEquipmentType",
    "shippingUnits": "shippingUnits",
    "asn": {
      "isASNNeeded": true,
      "asnTemplateName": "asnTemplateName"
    },
    "allStackable": true,
    "loadNotes": "loadNotes"
  },
  "accessories": {
    "blindShipment": true,
    "doNotFreeze": true,
    "guaranteed": true,
    "notification": true,
    "overLength": true,
    "sortAndSegregate": true,
    "volumeLoad": true,
    "whiteGloveDelivery": true,
    "expedite": true,
    "originInsidePickup": true,
    "destinationInsideDelivery": true,
    "originLiftGate": true,
    "destinationLiftGate": true,
    "inBond": true
  }
}'

Example Request Body

{
  "mustArriveByDate": "2024-08-25T15:00:00Z",
  "loadId": 0,
  "billingInformation": {
    "terms": "terms",
    "role": "role",
    "billingID": "billingID",
    "poNumber": "poNumber",
    "proNumber": "proNumber",
    "customID": "customID",
    "name": "name",
    "street1": "street1",
    "street2": "street2",
    "city": "city",
    "state": "state",
    "zip": "zip",
    "country": "country"
  },
  "originLocation": {
    "contact": "contact",
    "phone": "phone",
    "fax": "fax",
    "email": "email",
    "other": "other",
    "type": "type",
    "notes": "notes",
    "number": "number",
    "dockOpen": "2024-08-25T15:00:00Z",
    "dockClose": "2024-08-25T15:00:00Z",
    "notesNotOnBOL": "notesNotOnBOL",
    "appointment": true,
    "appointmentDate": "2024-08-25T15:00:00Z",
    "freightReadyTime": "2024-08-25T15:00:00Z",
    "name": "name",
    "street": "street",
    "street2": "street2",
    "city": "city",
    "stateProvince": "stateProvince",
    "postalCode": "postalCode",
    "country": "country"
  },
  "destinationLocation": {
    "contact": "contact",
    "phone": "phone",
    "fax": "fax",
    "email": "email",
    "other": "other",
    "type": "type",
    "notes": "notes",
    "number": "number",
    "dockOpen": "2024-08-25T15:00:00Z",
    "dockClose": "2024-08-25T15:00:00Z",
    "notesNotOnBOL": "notesNotOnBOL",
    "appointment": true,
    "appointmentDate": "2024-08-25T15:00:00Z",
    "freightReadyTime": "2024-08-25T15:00:00Z",
    "name": "name",
    "street": "street",
    "street2": "street2",
    "city": "city",
    "stateProvince": "stateProvince",
    "postalCode": "postalCode",
    "country": "country"
  },
  "items": [
    {
      "qty": "qty",
      "packaging": "packaging",
      "freightClass": "freightClass",
      "weight": "weight",
      "nmfCnumber": "nmfCnumber",
      "subClass": "subClass",
      "description": "description",
      "hazMat": {
        "isHazMat": true,
        "unNa": "unNa",
        "unNaNumber": "unNaNumber",
        "hazClass": "hazClass",
        "pgCode": "pgCode",
        "subRisk": 0,
        "vol": 0,
        "limitedQuantity": true
      },
      "itemDimensions": {
        "length": 0,
        "height": 0,
        "width": 0,
        "shipQuantity": 0
      }
    }
  ],
  "accessorials": {
    "doNotFreeze": true,
    "overLength": true,
    "sortAndSegregate": true,
    "blindShipment": true,
    "whiteGloveDelivery": true,
    "expedite": true,
    "insuranceRequired": true,
    "falveyInsValue": 0,
    "volumeLoad": true,
    "guaranteed": true,
    "mabd": true,
    "destinationNotification": true,
    "originInsidePickup": true,
    "originLiftGate": true,
    "destinationInsideDelivery": true,
    "destinationLiftGate": true,
    "inBond": true
  },
  "additionalLoadInfo": {
    "pickedUpDate": "2024-08-25T15:00:00Z",
    "specialInstructions": "specialInstructions",
    "shippingQuantity": 0,
    "loadEquipmentType": "loadEquipmentType",
    "shippingUnits": "shippingUnits",
    "asn": {
      "isASNNeeded": true,
      "asnTemplateName": "asnTemplateName"
    },
    "allStackable": true,
    "loadNotes": "loadNotes"
  },
  "accessories": {
    "blindShipment": true,
    "doNotFreeze": true,
    "guaranteed": true,
    "notification": true,
    "overLength": true,
    "sortAndSegregate": true,
    "volumeLoad": true,
    "whiteGloveDelivery": true,
    "expedite": true,
    "originInsidePickup": true,
    "destinationInsideDelivery": true,
    "originLiftGate": true,
    "destinationLiftGate": true,
    "inBond": true
  }
}

json

Example Responses

{
  "information": {
    "resultCode": "resultCode",
    "resultDescription": "resultDescription",
    "originPostalCode": "originPostalCode",
    "destinationPostalCode": "destinationPostalCode",
    "loadID": "loadID",
    "customerLoadID": "customerLoadID",
    "proNumber": "proNumber"
  },
  "quotes": [
    {
      "carrier": "carrier",
      "scac": "scac",
      "customerCharge": "customerCharge",
      "freightCharge": "freightCharge",
      "transitTime": "transitTime",
      "indirect": true,
      "notes": "notes",
      "pricingOwnershipID": 0,
      "access": 0,
      "base": 0,
      "fsc": 0,
      "totalCharge": 0,
      "serviceLevel": "serviceLevel",
      "tenantPricing": true,
      "insuranceFee": 0,
      "mode": "mode",
      "success": true,
      "errorMessage": "errorMessage",
      "performance": "performance",
      "smartSelect": "smartSelect"
    }
  ],
  "warnings": [
    {
      "warning": "warning"
    }
  ],
  "errors": [
    {
      "error": "error"
    }
  ],
  "notifications": [
    {
      "notificationID": 0,
      "emails": "emails",
      "potentialLate": true,
      "loadException": true,
      "rateChange": true,
      "delivery": true,
      "weatherDelay": true,
      "reweigh": true
    }
  ]
}

text

Create, rate or book a load

POST

https://tmstest.reconex.io

/api/v1/IntegrationApi/CreateRateOrBookLoad

apikey (header)

Create, rate or book a load › Request Body

BookLoadRequest

mustArriveByDate

string | null · date-time

array | null

scac

string | null

Create, rate or book a load › Responses

200

QuoteEngineResponse

Information

array | null

POST/api/v1/IntegrationApi/CreateRateOrBookLoad

curl https://tmstest.reconex.io/api/v1/IntegrationApi/CreateRateOrBookLoad \
  --request POST \
  --header 'Content-Type: application/json-patch+json' \
  --header 'apikey: <api-key>' \
  --data '{
  "mustArriveByDate": "2024-08-25T15:00:00Z",
  "loadDetails": {
    "terms": "terms",
    "billingID": "billingID",
    "poNumber": "poNumber",
    "proNumber": "proNumber",
    "customID": "customID",
    "customerBilling": "customerBilling"
  },
  "billingLocation": {
    "name": "name",
    "street": "street",
    "street2": "street2",
    "city": "city",
    "stateProvince": "stateProvince",
    "postalCode": "postalCode",
    "country": "country"
  },
  "originLocation": {
    "contact": "contact",
    "phone": "phone",
    "fax": "fax",
    "email": "email",
    "other": "other",
    "type": "type",
    "notes": "notes",
    "number": "number",
    "dockOpen": "2024-08-25T15:00:00Z",
    "dockClose": "2024-08-25T15:00:00Z",
    "notesNotOnBOL": "notesNotOnBOL",
    "appointment": true,
    "appointmentDate": "2024-08-25T15:00:00Z",
    "freightReadyTime": "2024-08-25T15:00:00Z",
    "name": "name",
    "street": "street",
    "street2": "street2",
    "city": "city",
    "stateProvince": "stateProvince",
    "postalCode": "postalCode",
    "country": "country"
  },
  "destinationLocation": {
    "contact": "contact",
    "phone": "phone",
    "fax": "fax",
    "email": "email",
    "other": "other",
    "type": "type",
    "notes": "notes",
    "number": "number",
    "dockOpen": "2024-08-25T15:00:00Z",
    "dockClose": "2024-08-25T15:00:00Z",
    "notesNotOnBOL": "notesNotOnBOL",
    "appointment": true,
    "appointmentDate": "2024-08-25T15:00:00Z",
    "freightReadyTime": "2024-08-25T15:00:00Z",
    "name": "name",
    "street": "street",
    "street2": "street2",
    "city": "city",
    "stateProvince": "stateProvince",
    "postalCode": "postalCode",
    "country": "country"
  },
  "accessorials": {
    "doNotFreeze": true,
    "overLength": true,
    "sortAndSegregate": true,
    "blindShipment": true,
    "whiteGloveDelivery": true,
    "expedite": true,
    "insuranceRequired": true,
    "falveyInsValue": 0,
    "volumeLoad": true,
    "guaranteed": true,
    "mabd": true,
    "destinationNotification": true,
    "originInsidePickup": true,
    "originLiftGate": true,
    "destinationInsideDelivery": true,
    "destinationLiftGate": true,
    "inBond": true
  },
  "items": [
    {
      "qty": "qty",
      "packaging": "packaging",
      "freightClass": "freightClass",
      "weight": "weight",
      "nmfCnumber": "nmfCnumber",
      "subClass": "subClass",
      "description": "description",
      "hazMat": {
        "isHazMat": true,
        "unNa": "unNa",
        "unNaNumber": "unNaNumber",
        "hazClass": "hazClass",
        "pgCode": "pgCode",
        "subRisk": 0,
        "vol": 0,
        "limitedQuantity": true
      },
      "itemDimensions": {
        "length": 0,
        "height": 0,
        "width": 0,
        "shipQuantity": 0
      }
    }
  ],
  "additionalLoadInfo": {
    "pickedUpDate": "2024-08-25T15:00:00Z",
    "specialInstructions": "specialInstructions",
    "shippingQuantity": 0,
    "loadEquipmentType": "loadEquipmentType",
    "shippingUnits": "shippingUnits",
    "asn": {
      "isASNNeeded": true,
      "asnTemplateName": "asnTemplateName"
    },
    "allStackable": true,
    "loadNotes": "loadNotes"
  },
  "scac": "scac"
}'

Example Request Body

{
  "mustArriveByDate": "2024-08-25T15:00:00Z",
  "loadDetails": {
    "terms": "terms",
    "billingID": "billingID",
    "poNumber": "poNumber",
    "proNumber": "proNumber",
    "customID": "customID",
    "customerBilling": "customerBilling"
  },
  "billingLocation": {
    "name": "name",
    "street": "street",
    "street2": "street2",
    "city": "city",
    "stateProvince": "stateProvince",
    "postalCode": "postalCode",
    "country": "country"
  },
  "originLocation": {
    "contact": "contact",
    "phone": "phone",
    "fax": "fax",
    "email": "email",
    "other": "other",
    "type": "type",
    "notes": "notes",
    "number": "number",
    "dockOpen": "2024-08-25T15:00:00Z",
    "dockClose": "2024-08-25T15:00:00Z",
    "notesNotOnBOL": "notesNotOnBOL",
    "appointment": true,
    "appointmentDate": "2024-08-25T15:00:00Z",
    "freightReadyTime": "2024-08-25T15:00:00Z",
    "name": "name",
    "street": "street",
    "street2": "street2",
    "city": "city",
    "stateProvince": "stateProvince",
    "postalCode": "postalCode",
    "country": "country"
  },
  "destinationLocation": {
    "contact": "contact",
    "phone": "phone",
    "fax": "fax",
    "email": "email",
    "other": "other",
    "type": "type",
    "notes": "notes",
    "number": "number",
    "dockOpen": "2024-08-25T15:00:00Z",
    "dockClose": "2024-08-25T15:00:00Z",
    "notesNotOnBOL": "notesNotOnBOL",
    "appointment": true,
    "appointmentDate": "2024-08-25T15:00:00Z",
    "freightReadyTime": "2024-08-25T15:00:00Z",
    "name": "name",
    "street": "street",
    "street2": "street2",
    "city": "city",
    "stateProvince": "stateProvince",
    "postalCode": "postalCode",
    "country": "country"
  },
  "accessorials": {
    "doNotFreeze": true,
    "overLength": true,
    "sortAndSegregate": true,
    "blindShipment": true,
    "whiteGloveDelivery": true,
    "expedite": true,
    "insuranceRequired": true,
    "falveyInsValue": 0,
    "volumeLoad": true,
    "guaranteed": true,
    "mabd": true,
    "destinationNotification": true,
    "originInsidePickup": true,
    "originLiftGate": true,
    "destinationInsideDelivery": true,
    "destinationLiftGate": true,
    "inBond": true
  },
  "items": [
    {
      "qty": "qty",
      "packaging": "packaging",
      "freightClass": "freightClass",
      "weight": "weight",
      "nmfCnumber": "nmfCnumber",
      "subClass": "subClass",
      "description": "description",
      "hazMat": {
        "isHazMat": true,
        "unNa": "unNa",
        "unNaNumber": "unNaNumber",
        "hazClass": "hazClass",
        "pgCode": "pgCode",
        "subRisk": 0,
        "vol": 0,
        "limitedQuantity": true
      },
      "itemDimensions": {
        "length": 0,
        "height": 0,
        "width": 0,
        "shipQuantity": 0
      }
    }
  ],
  "additionalLoadInfo": {
    "pickedUpDate": "2024-08-25T15:00:00Z",
    "specialInstructions": "specialInstructions",
    "shippingQuantity": 0,
    "loadEquipmentType": "loadEquipmentType",
    "shippingUnits": "shippingUnits",
    "asn": {
      "isASNNeeded": true,
      "asnTemplateName": "asnTemplateName"
    },
    "allStackable": true,
    "loadNotes": "loadNotes"
  },
  "scac": "scac"
}

json

Example Responses

{
  "information": {
    "resultCode": "resultCode",
    "resultDescription": "resultDescription",
    "originPostalCode": "originPostalCode",
    "destinationPostalCode": "destinationPostalCode",
    "loadID": "loadID",
    "customerLoadID": "customerLoadID",
    "proNumber": "proNumber"
  },
  "quotes": [
    {
      "carrier": "carrier",
      "scac": "scac",
      "customerCharge": "customerCharge",
      "freightCharge": "freightCharge",
      "transitTime": "transitTime",
      "indirect": true,
      "notes": "notes",
      "pricingOwnershipID": 0,
      "access": 0,
      "base": 0,
      "fsc": 0,
      "totalCharge": 0,
      "serviceLevel": "serviceLevel",
      "tenantPricing": true,
      "insuranceFee": 0,
      "mode": "mode",
      "success": true,
      "errorMessage": "errorMessage",
      "performance": "performance",
      "smartSelect": "smartSelect"
    }
  ],
  "warnings": [
    {
      "warning": "warning"
    }
  ],
  "errors": [
    {
      "error": "error"
    }
  ],
  "notifications": [
    {
      "notificationID": 0,
      "emails": "emails",
      "potentialLate": true,
      "loadException": true,
      "rateChange": true,
      "delivery": true,
      "weatherDelay": true,
      "reweigh": true
    }
  ]
}

text

Loads and quotes