Skip to main content
POST
/
loads
/
sync
Sync a load
curl --request POST \
  --url https://api.cargado.com/loads/sync \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "load": {
    "externalId": "<string>",
    "externalCustomerId": "<string>",
    "status": "ON_HOLD",
    "trailerRequirements": {
      "allowedTypes": [
        "REEFER"
      ],
      "powerOnlyType": "PRE_LOADED",
      "doorType": "SWING",
      "maxAgeYears": 123,
      "highCube": true,
      "spaceSaver": true,
      "suspensionType": "AIR_RIDE",
      "foodGrade": true,
      "wallType": "SHEET_AND_POST",
      "logisticPost": true,
      "eTrackRails": "VERTICAL",
      "eTracksDistance": "TWO_FEET",
      "extendable": true,
      "liftGate": true,
      "minAxles": 123,
      "metalEdgeProtectors": true,
      "airChute": true,
      "ctpatCompliant": true,
      "floorTypes": [
        "HARDWOOD"
      ]
    },
    "carrierRequirements": {
      "ctpatCertified": true,
      "oeaCertified": true,
      "pipCertified": true,
      "fastCertified": true,
      "internationalCarrierBonded": true,
      "internationalCarrierBondedUS": true,
      "internationalCarrierBondedCA": true,
      "internationalCarrierBondedMX": true,
      "has247CustomerService": true,
      "minCargoInsurance": {
        "currencyCode": "USD",
        "amount": 500000000
      }
    },
    "driverRequirements": {
      "twicCard": true,
      "tankerEndorsed": true,
      "cdl": true
    },
    "stops": [
      {
        "type": "PICKUP",
        "externalId": "<string>",
        "location": {
          "place": {
            "type": "ADDRESS",
            "street": "<string>",
            "city": "<string>",
            "state": "<string>",
            "countryCode": "US",
            "neighborhood": "<string>",
            "postalCode": "<string>"
          },
          "coordinates": {
            "latitude": 0,
            "longitude": 0
          },
          "isCtpatCertified": true,
          "isPipCertified": true,
          "isOeaCertified": true,
          "carrierPreapproval": "FIXED_LIST",
          "timezone": "<string>"
        },
        "appointment": {
          "type": "UNSPECIFIED"
        },
        "referenceNumbers": [
          {
            "label": "<string>",
            "value": "<string>"
          }
        ],
        "loadingMethod": "LIVE",
        "inboundTransitRequirements": {
          "maximumExpectedMinutes": 123,
          "securityEscortProvider": "PROVIDER",
          "teamDriverRequired": true,
          "trackingRequired": true
        },
        "dropDurationHours": 1080,
        "fumigation": {
          "requiredBefore": true,
          "requiredAfter": true
        },
        "scaleTicket": {
          "requiredBefore": true,
          "requiredAfter": true
        },
        "driverAssistRequired": true
      }
    ],
    "externalDisplayId": "<string>",
    "externalWorkspaceId": "<string>",
    "referenceNumbers": [
      {
        "label": "<string>",
        "value": "<string>"
      }
    ],
    "commodities": [
      {
        "name": "<string>",
        "hazmatDetails": {
          "isHazmat": true,
          "classification": "CLASS_3_FLAMMABLE_LIQUIDS",
          "unNumber": "1263",
          "packingGroup": "II"
        },
        "dimensions": {
          "length": {
            "value": 123,
            "unit": "FEET"
          },
          "width": {
            "value": 123,
            "unit": "FEET"
          },
          "height": {
            "value": 123,
            "unit": "FEET"
          }
        },
        "weight": {
          "type": "APPROXIMATE",
          "value": 123,
          "unit": "POUNDS"
        },
        "temperatureRequirements": {
          "minimum": 10,
          "maximum": 20,
          "unit": "CELSIUS"
        },
        "pieces": {
          "type": "PALLET",
          "stackable": true,
          "perPieceVolume": {
            "value": 100,
            "unit": "GALLONS"
          },
          "perPieceDimensions": {
            "length": {
              "value": 123,
              "unit": "FEET"
            },
            "width": {
              "value": 123,
              "unit": "FEET"
            },
            "height": {
              "value": 123,
              "unit": "FEET"
            }
          },
          "count": 123
        }
      }
    ],
    "requiredEquipment": [
      {
        "type": "LOAD_BARS",
        "quantity": 500.5
      }
    ],
    "metadata": {
      "tmsOrderId": "1314234",
      "customerName": "Acme Corp"
    },
    "truckload": "FULL",
    "roundTrip": true,
    "linearFeet": 123,
    "maxBuy": {
      "currencyCode": "USD",
      "amount": 500000000
    },
    "targetRate": {
      "currencyCode": "USD",
      "amount": 500000000
    },
    "borderCrossings": [
      {
        "type": "BORDER_CROSSING",
        "externalId": "<string>",
        "referenceNumbers": [
          {
            "label": "<string>",
            "value": "<string>"
          }
        ],
        "usMxBorderCrossing": "LAREDO_INTL_BRIDGE",
        "borderCrossingStrategy": "PRE_ASSIGNED",
        "requiredInspections": [
          "USDA"
        ],
        "expectedDwellTimeMinutes": 123
      }
    ],
    "assignedCarrier": {
      "dotNumber": "<string>",
      "mcNumber": "<string>",
      "mxNumber": "<string>",
      "rfcNumber": "<string>",
      "cvorNumber": "<string>",
      "nirNumber": "<string>",
      "nscNumber": "<string>"
    },
    "schemaVersionNumber": 123
  }
}
'
{
  "load": {
    "externalId": "<string>",
    "externalCustomerId": "<string>",
    "status": "ON_HOLD",
    "trailerRequirements": {
      "allowedTypes": [
        "REEFER"
      ],
      "powerOnlyType": "PRE_LOADED",
      "doorType": "SWING",
      "maxAgeYears": 123,
      "highCube": true,
      "spaceSaver": true,
      "suspensionType": "AIR_RIDE",
      "foodGrade": true,
      "wallType": "SHEET_AND_POST",
      "logisticPost": true,
      "eTrackRails": "VERTICAL",
      "eTracksDistance": "TWO_FEET",
      "extendable": true,
      "liftGate": true,
      "minAxles": 123,
      "metalEdgeProtectors": true,
      "airChute": true,
      "ctpatCompliant": true,
      "floorTypes": [
        "HARDWOOD"
      ]
    },
    "carrierRequirements": {
      "ctpatCertified": true,
      "oeaCertified": true,
      "pipCertified": true,
      "fastCertified": true,
      "internationalCarrierBonded": true,
      "internationalCarrierBondedUS": true,
      "internationalCarrierBondedCA": true,
      "internationalCarrierBondedMX": true,
      "has247CustomerService": true,
      "minCargoInsurance": {
        "currencyCode": "USD",
        "amount": 500000000
      }
    },
    "driverRequirements": {
      "twicCard": true,
      "tankerEndorsed": true,
      "cdl": true
    },
    "id": "<string>",
    "stops": [
      {
        "type": "PICKUP",
        "externalId": "<string>",
        "location": {
          "place": {
            "type": "ADDRESS",
            "street": "<string>",
            "city": "<string>",
            "state": "<string>",
            "countryCode": "US",
            "postalCode": "<string>",
            "neighborhood": "<string>"
          },
          "coordinates": {
            "latitude": 0,
            "longitude": 0
          },
          "isCtpatCertified": true,
          "isPipCertified": true,
          "isOeaCertified": true,
          "carrierPreapproval": "FIXED_LIST",
          "timezone": "<string>"
        },
        "appointment": {
          "type": "UNSPECIFIED"
        },
        "referenceNumbers": [
          {
            "label": "<string>",
            "value": "<string>"
          }
        ],
        "loadingMethod": "LIVE",
        "inboundTransitRequirements": {
          "maximumExpectedMinutes": 123,
          "securityEscortProvider": "PROVIDER",
          "teamDriverRequired": true,
          "trackingRequired": true
        },
        "dropDurationHours": 1080,
        "fumigation": {
          "requiredBefore": true,
          "requiredAfter": true
        },
        "scaleTicket": {
          "requiredBefore": true,
          "requiredAfter": true
        },
        "driverAssistRequired": true
      }
    ],
    "externalDisplayId": "<string>",
    "externalWorkspaceId": "<string>",
    "referenceNumbers": [
      {
        "label": "<string>",
        "value": "<string>"
      }
    ],
    "commodities": [
      {
        "name": "<string>",
        "hazmatDetails": {
          "isHazmat": true,
          "classification": "CLASS_3_FLAMMABLE_LIQUIDS",
          "unNumber": "1263",
          "packingGroup": "II"
        },
        "dimensions": {
          "length": {
            "value": 123,
            "unit": "FEET"
          },
          "width": {
            "value": 123,
            "unit": "FEET"
          },
          "height": {
            "value": 123,
            "unit": "FEET"
          }
        },
        "weight": {
          "type": "APPROXIMATE",
          "value": 123,
          "unit": "POUNDS"
        },
        "temperatureRequirements": {
          "minimum": 10,
          "maximum": 20,
          "unit": "CELSIUS"
        },
        "pieces": {
          "type": "PALLET",
          "stackable": true,
          "perPieceVolume": {
            "value": 100,
            "unit": "GALLONS"
          },
          "perPieceDimensions": {
            "length": {
              "value": 123,
              "unit": "FEET"
            },
            "width": {
              "value": 123,
              "unit": "FEET"
            },
            "height": {
              "value": 123,
              "unit": "FEET"
            }
          },
          "count": 123
        }
      }
    ],
    "requiredEquipment": [
      {
        "type": "LOAD_BARS",
        "quantity": 500.5
      }
    ],
    "metadata": {
      "tmsOrderId": "1314234",
      "customerName": "Acme Corp"
    },
    "truckload": "FULL",
    "roundTrip": true,
    "linearFeet": 123,
    "maxBuy": {
      "currencyCode": "USD",
      "amount": 500000000
    },
    "targetRate": {
      "currencyCode": "USD",
      "amount": 500000000
    }
  }
}

Authorizations

api-key
string
header
required

Body

application/json

Input interface for synchronizing load data.

load
object
required

Input interface for synchronizing load data.

Response

Ok

Output interface for synchronizing load data.

load
object
required

A load in the Cargado system.