Skip to main content

Upgrading to v2

Migration Steps​

1. Update API Host​

The Crestline API host has been updated to https://api.crestlineautotransport.com/v2/

Replace https://crestlineautotransport.com/quotes/ with https://api.crestlineautotransport.com/v2/

2. Update API Endpoints​

The Crestline API endpoints have been updated as follows:

Quotes​

ActionOld EnpointNew Endpoint
Get QuotePOST /getShippingQuote.phpPOST /quote
Update QuotePOST /getShippingQuote.phpPUT /quote/{quote_id}
Approve QuotePOST /getShippingQuote.phpPOST /quote/{quote_id}/approve

Shipments​

ActionOld EnpointNew Endpoint
Create ShipmentPOST /createShipment.phpPOST /shipments
Get ShipmentGET /getShipment.phpGET /shipments/{shipment_id}
Update ShipmentPOST /updateShipment.phpPUT /shipments/{shipment_id}
Delete/Cancel ShipmentPOST /deleteShipment.phpDELETE /shipments/{shipment_id}

3. Update Request​

info

To ease the transition to Crestline API v2, the request body used in version 1 will be parsed and handled by the new API. However, we do recommend updating the request body at some point in the future, because as we come out with more features with the API, continuing to use the old request body will limit the access to these new features.

3.1 Quotes​

Old Request​
POST https://crestlineautotransport/quotes/getShippingQuoteWTS.php
Content-Type: application/json
Authorization: Basic BASE64_ENCODED_CREDENTIALS

{
  "ActionName": "Get Rate",
  "ShipmentNumber": "WTS20250216191244",
  "OrderRefNumber": "1FDXE4FN9PDD32477",
  "EquipmentType": "OPEN AUTO" | "ENCLOSED AUTO",
  "PickupCommodityCode": "BOX TRUCK",
  "DeliveryCommodityCode": "BOX TRUCK",
  "LoadReference": "2023 Ford E-450 RWD, Box Van",
  "TempShipFromCountry": "US",
  "TempShipFromStreet1": "TBD",
  "TempShipFromStreet2": "",
  "TempShipFromCity": "Staten Island",
  "TempShipFromState": "NY",
  "TempShipFromPostalCode": "10314",
  "TempShipToCountry": "US",
  "TempShipToStreet1": "TBD",
  "TempShipToCity": "Miami",
  "TempShipToState": "FL",
  "TempShipToPostalCode": "33107",
  "CSR": "Work Truck Solutions",
  "BillToCompany": "",
  "BillToContact": "Contact Name~5551112222~~~contact@email.com",
  "BillToStreet1": "TBD",
  "BillToStreet2": "TBD",
  "BillToCity": "Staten Island",
  "BillToState": "NY",
  "BillToPostalCode": "10314",
  "BillToCountry": "US",
}
New Request​
GET https://api-stage.crestlineautotransport.com/v2/quote \
    ?pickup=75234 \
    &delivery=32905 \
    &vehicle_type=car \
    &transport_type=open
Authorization: Basic BASE64_ENCODED_CREDENTIALS

3.2 Shipments​

Old Request​
POST https://crestlineautotransport.com/ConfirmBooking
Content-Type: application/json
Authorization: Basic BASE64_ENCODED_CREDENTIALS

{
  "ActionName": "MakeBooking",
  "ReferenceNumber": "1092763",
  "PickupAddress" : "3530 Forest Ln Suite 215 ",
  "PickupCity": "Mebourne",
  "PickupState": "FL",
  "PickupZip": "32905",
  "PickupName": "John Doe",
  "PickupPhNo.": "321-982-0918",
  "PickupEmailAddress": "johndoe@gmail.com",
  "DeliveryAddress" : "3101 Parkside St",
  "DeliveryCity": "Wilmington",
  "DeliveryState": "DE",
  "DeliveryZip": "19810",
  "DeliveryName": "Robert Henderson",
  "DeliveryPhNo.": "321-915-0918",
  "DeliveryEmailAddress": "Rhenderson@gmail.com",
  "BillToName": "John Doe",
  "BillToPhNo.": "321-982-0918",
  "BillToEmailAddress": "johndoe@gmail.com",
  "Year": "2018",
  "Make": "Ford",
  "Model": "Expedition",
  "VinNo": "12893720380921",
  "PickupTransportationInstruction": "Call me when you reach the location",
  "DeliveryTransportationInstruction": "Drop off after 6 pm"
}
New Request​
POST https://api-stage.crestlineautotransport.com/v2/shipments
Content-Type: application/json
Authorization: Basic BASE64_ENCODED_CREDENTIALS

{
  "customer": {
    "customer_name": "Basic Enterprise, LLC",
    "customer_type": "DEALER",
    "address": "123 Test Dr",
    "city": "Dallas",
    "state": "TX",
    "zipcode": 75234,
    "email": "jsmith@domain.com",
    "phone": "2145550000",
    "contact_name": "John Smith",
    "contact_email": "jsmith@domain.com",
    "contact_phone": "2145550000"
  },
  "pickup": {
    "location_name": "Pickup Here, LLC",
    "location_type": "DEALER",
    "address": "123 Test Dr",
    "city": "Dallas",
    "state": "TX",
    "zipcode": 75234,
    "contact_name": "John Smith",
    "contact_email": "jsmith@domain.com",
    "contact_phone": "2145550000",
    "notes": "Add any notes or instructions here",
    "available_pickup_dttm": "2024-08-10T08:00:00-0500",
    "scheduled_pickup_dttm": "2024-08-10T08:00:00.000+0000",
    "scheduled_pickup_dttm_end": "2024-08-10T08:00:00.000+0000",
    "pickup_dttm": "2024-08-10T08:00:00-0500"
  },
  "delivery": {
    "location_name": "Pickup Here, LLC",
    "location_type": "DEALER",
    "address": "123 Test Dr",
    "city": "Dallas",
    "state": "TX",
    "zipcode": 75234,
    "contact_name": "John Smith",
    "contact_email": "jsmith@domain.com",
    "contact_phone": "2145550000",
    "notes": "Add any notes or instructions here",
    "preferred_delivery_dttm": "2024-08-18T08:00:00-0500",
    "scheduled_delivery_dttm": "2024-08-18T08:00:00-0500",
    "scheduled_delivery_dttm_end": "2024-08-18T08:00:00-0500",
    "delivery_dttm": "2024-08-18T08:00:00-0500"
  },
  "vehicles": [
    {
      "vin": "1G8AL52F03Z157046",
      "year": 2020,
      "make": "Dodge",
      "model": "RAM ProMaster",
      "trim": "Cargo Van",
      "type": "van",
      "is_modified": false,
      "is_inoperable": false,
      "notes": "Vehicle is rusting underneath"
    }
  ],
  "transport_type": "enclosed",
  "instructions": "Specify any instructions specific to this shipment",
  "external_id": "unique_id"
}

4. Handle New Response​

info

Similar to the request body, to ease the transition to Crestline API v2, the response body used in version 1 will be returned, ONLY when the request body from version 1 is used. However, we do recommend updating your integration to handle the new response body so that you have access to all of the new data points and features we have added and will continue to add in future updates.

4.1 Quotes​

Old Response​
{
  "Cost": "890.00",
  "ShipmentNumber": "19262819"
}
New Response​
{
  "shipment_id": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
  "price": 100
}

4.2 Shipments​

Old Response​
{
  "Message": "Success",
  "TransportationBooked": "Yes"
}
New Response​
{
  "id": "59558b3b-d478-4893-a9c1-2bae97440b70",
  "number": "CL999999",
  "status": "new",
  "price": 100,
  "customer": {
    "customer_name": "Basic Enterprise, LLC",
    "customer_type": "DEALER",
    "address": "123 Test Dr",
    "city": "Dallas",
    "state": "TX",
    "zipcode": 75234,
    "email": "jsmith@domain.com",
    "phone": "2145550000",
    "contact_name": "John Smith",
    "contact_email": "jsmith@domain.com",
    "contact_phone": "2145550000"
  },
  "pickup": {
    "location_name": "Pickup Here, LLC",
    "location_type": "DEALER",
    "address": "123 Test Dr",
    "city": "Dallas",
    "state": "TX",
    "zipcode": 75234,
    "contact_name": "John Smith",
    "contact_email": "jsmith@domain.com",
    "contact_phone": "2145550000",
    "notes": "Add any notes or instructions here",
    "available_pickup_dttm": "2024-08-10T08:00:00-0500",
    "scheduled_pickup_dttm": "2024-08-10T08:00:00.000+0000",
    "scheduled_pickup_dttm_end": "2024-08-10T08:00:00.000+0000",
    "pickup_dttm": "2024-08-10T08:00:00-0500"
  },
  "delivery": {
    "location_name": "Pickup Here, LLC",
    "location_type": "DEALER",
    "address": "123 Test Dr",
    "city": "Dallas",
    "state": "TX",
    "zipcode": 75234,
    "contact_name": "John Smith",
    "contact_email": "jsmith@domain.com",
    "contact_phone": "2145550000",
    "notes": "Add any notes or instructions here",
    "preferred_delivery_dttm": "2024-08-18T08:00:00-0500",
    "scheduled_delivery_dttm": "2024-08-18T08:00:00-0500",
    "scheduled_delivery_dttm_end": "2024-08-18T08:00:00-0500",
    "delivery_dttm": "2024-08-18T08:00:00-0500"
  },
  "vehicles": [
    {
      "id": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
      "vin": "1G8AL52F03Z157046",
      "year": 2020,
      "make": "Dodge",
      "model": "RAM ProMaster",
      "trim": "Cargo Van",
      "type": "van",
      "is_modified": false,
      "is_inoperable": false,
      "notes": "Vehicle is rusting underneath",
      "weight": 6600,
      "height": 72.3,
      "width": 64.5,
      "length": 90.8,
      "photos": [
        {
          "id": "74c1f768-b78a-497e-916b-8fb62be13ef2",
          "type": "pickup",
          "url": "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae.png",
          "latitude": 32.9248531,
          "longitude": -96.8881391,
          "created_dttm": "2024-08-10T08:00:00.000+0000"
        }
      ]
    }
  ],
  "distance": 993.09,
  "distance_meters": 1598223,
  "transport_type": "enclosed",
  "instructions": "Specify any instructions specific to this shipment",
  "documents": [
    {
      "id": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
      "type": "bol",
      "url": "\"https://storage.googleapis.com/.../dispatch-sheet.pdf\""
    }
  ],
  "external_id": "123e4567-e89b-12d3-a456-426614174000"
}

5. Test using the Stage API​

We recommend testing your integration with the new API version using the Stage API url:

https://api-stage.crestlineautotransport.com/

Once you have tested your integration, you are all set to use the version 2 of the Crestline API