CRUD Loads Workflows
Overview
Loads are contracts for the transportaion of vehicles. They can be viewed as orders created by shippers and dispatched to carriers – companies responsible for the actual pickup and delivery of the loads. In broader terms, a load is one or more vehicles carried in a truck that takes them from one physical location and leaves them in another.
On this page, you can find descriptions and sample request-response codes for primary load operations available exclusively to shippers and/or shipping companies.
Create load
Loads are created in two ways - either through Load Board postings or as specific carrier dispatches.
The first option makes your load publically accessible and easy to discover by different carriers, each of which can initiate a negotiation with you by sending an offer.
The second option directly links the load to a trusted carrier and proceeds to assigning it to a driver. Keep in mind that a valid USDOT number will be required in this scenario.
In either case, you’ll need the following information:
- Pickup contact data (e.g. name, phone, and address)
- Delivery contact data (e.g. name, phone, and address)
- Estimated pickup date range
- Estimated delivery date range
- Vehicle(s) data (either VIN or custom year, make and model)
- Payment amount, type, term and method
Customer data is optional. If you decide to include it, the customer’s phone number will be required.
To learn more about different enum values used across the page, check out Enum Values.
Create Load to Load Board
This API ensures your load is created in the form of a posting on the Load Board.
Link: POST https://ship.cars/api/shipperlite/posting/v2/integrators/loads/
Create Load to Loadboard Request
{
"carrierPayInCents": 101500,
"extRateCalculationId": "u4mPIiTdP91Ovb9pCjBG",
"load": {
"useEnclosedTrailer": false,
"useM22InspectionGuide": false,
"useGpsTracking": true
},
"contract": {},
"route": {
"pickupDateDetail": {
"estimatedStartDate": "2022-08-16",
"estimatedEndDate": "2022-08-18",
"restriction": "NO_RESTRICTIONS"
},
"deliveryDateDetail": {
"estimatedStartDate": "2022-08-28",
"estimatedEndDate": "2022-08-30",
"restriction": "NO_RESTRICTIONS"
},
"pickupLocation": {
"street": "12493 West 84th Circle",
"city": "Arvada",
"state": "CO",
"zipCode": "80005"
},
"deliveryLocation": {
"street": "12493 West 84th Circle",
"city": "Arvada",
"state": "CO",
"zipCode": "36116"
},
"distanceInMiles": "1445.09"
},
"carrierOffers": [],
"shippingItems": [
{
"attachments": [
{
"fileUrl": "https://media.ship.cars/media/inventory/gate-pass/8EZ58/2022-08-09/ship-cars-inventory-backend-worker-8485b95655-vkwbv_3b9aaa60-81e1-45ae-8bb7-bbfa1854d5d4/dummy.pdf",
"shareWith": "ALL",
"id": "K4MYZ",
"lbExternalId": null,
"loadLegId": null,
"shippingItemId": null,
"creatorType": "SHIPPER",
"originalFileName": "dummy.pdf"
}
],
"vehicle": {
"bodyType": "Car",
"buyerNumber": "",
"stockNumber": "",
"lotNumber": "",
"make": "Acura",
"model": "Legend",
"color": "",
"vin": "JH4KA7660RC001542",
"year": 1994,
"operableType": "OPERABLE"
}
}
],
"payments": [
{
"carrierPayInCents": 101500,
"notes": "",
"paymentType": "COD",
"paymentTransactionType": "CUSTOMER_TO_CARRIER",
"paymentMethod": "CASH"
}
],
"pickupContact": {
"companyName": "Satterfield, Blanda and Gorczany",
"name": "Emeline Swaniawski",
"primaryPhone": "3527204491",
"primaryPhoneNotes": "",
"location": {
"street": "12493 West 84th Circle",
"city": "Arvada",
"state": "CO",
"zipCode": "80005"
},
"type": "PICKUP"
},
"pickupSignatureRequired": true,
"deliverySignatureRequired": true,
"deliveryContact": {
"companyName": "Farrell LLC",
"name": "Elena Hansen",
"primaryPhone": "5749854968",
"primaryPhoneNotes": "",
"location": {
"street": "12493 West 84th Circle",
"city": "Arvada",
"state": "CO",
"zipCode": "36116"
},
"type": "DELIVERY"
},
"attachments": []
}
Create Load Response
{
"id": "861W6",
"status": "PENDING_POSTING",
"shipperLoadId": "861W6",
"externalId": null,
"load": {
"id": "KP093",
"dispatchInstructions": null,
"useEnclosedTrailer": false,
"useM22InspectionGuide": false,
"useGpsTracking": true
},
"route": {
"id": "XRRDO",
"pickupDateDetail": {
"id": "GY7V4",
"estimatedEndDate": "2022-08-18",
"estimatedStartDate": "2022-08-16",
"restriction": "NO_RESTRICTIONS"
},
"deliveryDateDetail": {
"id": "3P741",
"estimatedEndDate": "2022-08-30",
"estimatedStartDate": "2022-08-28",
"restriction": "NO_RESTRICTIONS"
},
"deliveryLocation": {
"id": "6QLYM",
"city": "Arvada",
"state": "CO",
"street": "12493 West 84th Circle",
"zipCode": "36116",
"locationId": null,
"longitude": "-105.1410858",
"latitude": "39.8506645"
},
"pickupLocation": {
"id": "3WMGJ",
"city": "Arvada",
"state": "CO",
"street": "12493 West 84th Circle",
"zipCode": "80005",
"locationId": null,
"longitude": "-105.1410858",
"latitude": "39.8506645"
},
"distanceInMiles": 1445.09,
"transitTime": "4-7 days"
},
"shippingItems": [
{
"id": "X0JDD",
"vehicle": {
"bodyType": "Car",
"buyerNumber": "",
"color": "",
"lotNumber": "",
"stockNumber": "",
"make": "Acura",
"model": "Legend",
"vin": "JH4KA7660RC001542",
"year": 1994,
"id": "X0JDD",
"length": "194.90",
"height": "55.10",
"width": "71.3",
"weight": "3583",
"logo": "https://storage.googleapis.com/ship-cars-make-logos/acura-logo.png",
"operableType": "OPERABLE",
"lbExternalId": null
},
"attachments": [
{
"fileUrl": "https://media.ship.cars/media/inventory/gate-pass/8EZ58/2022-08-09/ship-cars-inventory-backend-worker-8485b95655-vkwbv_3b9aaa60-81e1-45ae-8bb7-bbfa1854d5d4/dummy.pdf",
"shareWith": "ALL",
"id": "K4MYZ",
"lbExternalId": null,
"loadLegId": null,
"shippingItemId": "X0JDD",
"creatorType": "SHIPPER",
"originalFileName": "dummy.pdf"
}
]
}
],
"payments": [
{
"id": "X2ZL1",
"carrierPayInCents": 101500,
"notes": "",
"paymentType": "COD",
"paymentTransactionType": "CUSTOMER_TO_CARRIER",
"paymentMethod": "CASH",
"paymentTermsBeginType": null,
"paymentTermsType": null
}
],
"carrierPayInCents": 101500,
"orderInformation": null,
"contract": {
"id": "861W6",
"shipper": {
"id": "3P10W",
"companyName": "ShipperLite Qr",
"email": "[email protected]",
"name": "Test Shipperts",
"primaryPhone": "1111111111",
"primaryPhoneNotes": null,
"secondaryPhone": null,
"secondaryPhoneNotes": "1111111111",
"thirdPhone": null,
"thirdPhoneNotes": null,
"workingHours": null,
"location": {
"id": "K41ND",
"city": "Chicago",
"state": "IL",
"street": "424 West Diversey Parkway",
"zipCode": "60614",
"locationId": null
},
"type": "CUSTOMER",
"notes": null
}
},
"attachments": [],
"carrierOffers": [],
"pickupContact": {
"id": "MON4G",
"companyName": "Satterfield, Blanda and Gorczany",
"email": null,
"name": "Emeline Swaniawski",
"primaryPhone": "3527204491",
"primaryPhoneNotes": "",
"secondaryPhone": null,
"secondaryPhoneNotes": null,
"thirdPhone": null,
"thirdPhoneNotes": null,
"workingHours": null,
"location": {
"id": "E5P0J",
"city": "Arvada",
"state": "CO",
"street": "12493 West 84th Circle",
"zipCode": "80005",
"locationId": null
},
"type": "PICKUP",
"notes": null
},
"extRateCalculationId": "u4mPIiTdP91Ovb9pCjBG",
"carrier": null,
"driver": null,
"pickupSignatureRequired": true,
"deliverySignatureRequired": true,
"deliveryContact": {
"id": "GY3R2",
"companyName": "Farrell LLC",
"email": null,
"name": "Elena Hansen",
"primaryPhone": "5749854968",
"primaryPhoneNotes": "",
"secondaryPhone": null,
"secondaryPhoneNotes": null,
"thirdPhone": null,
"thirdPhoneNotes": null,
"workingHours": null,
"location": {
"id": "1N3Y4",
"city": "Arvada",
"state": "CO",
"street": "12493 West 84th Circle",
"zipCode": "36116",
"locationId": null
},
"type": "DELIVERY",
"notes": null
},
"publicLinkInfo": {
"id": "KPMP0",
"publicLinkKey": "1008902167340883968",
"publicLink": "https://tracking-qa.ship.cars/loads/1008902167340883968"
}
}
Dispatch Load to Carrier
This API creates and dispatches your load to a trusted carrier, skipping the Load Board posting process entirely. Request and response fields are identical to the previous API, with the exception of carrierDot (USDOT number of the carrier).
Link: POST https://ship.cars/api/shipperlite/posting/v2/integrators/loads/direct-dispatch
Dispatch Load Request
{
"carrierDot": 1673578,
"loadLeg": {
"carrierPayInCents": 26000,
"extRateCalculationId": "EXy3Dh703anSItyUPH4H",
"load": {
"useEnclosedTrailer": false,
"useM22InspectionGuide": false,
"useGpsTracking": true
},
"contract": {
"shipper": {
"companyName": "Pfannerstill-Sipes",
"name": "Colene Bechtelar",
"primaryPhone": "7708313873",
"primaryPhoneNotes": "",
"location": {
"street": "",
"city": "",
"state": "",
"zipCode": ""
},
"type": "CUSTOMER",
"workingHours": "",
"email": ""
}
},
"route": {
"pickupDateDetail": {
"estimatedStartDate": "2022-08-04",
"estimatedEndDate": "2022-08-06",
"restriction": "NO_RESTRICTIONS"
},
"deliveryDateDetail": {
"estimatedStartDate": "2022-08-15",
"estimatedEndDate": "2022-08-19",
"restriction": "NO_RESTRICTIONS"
},
"pickupLocation": {
"street": "549 Elysian Fields Road",
"city": "Nashville",
"state": "TN",
"zipCode": "37211"
},
"deliveryLocation": {
"street": "549 Elysian Fields Road",
"city": "Nashville",
"state": "TN",
"zipCode": "40222"
},
"distanceInMiles": "189.21"
},
"carrierOffers": [],
"shippingItems": [
{
"attachments": [],
"vehicle": {
"bodyType": "Car",
"buyerNumber": "",
"stockNumber": "",
"lotNumber": "",
"make": "Acura",
"model": "Legend",
"color": "",
"vin": "JH4KA4630LC007479",
"year": 1997,
"operableType": "OPERABLE"
}
}
],
"payments": [
{
"carrierPayInCents": 26000,
"notes": "",
"paymentType": "COD",
"paymentTransactionType": "CUSTOMER_TO_CARRIER",
"paymentMethod": "CASH"
}
],
"pickupContact": {
"companyName": "Berge, Krajcik and Labadie",
"name": "Sammie Carroll",
"primaryPhone": "7205033590",
"primaryPhoneNotes": "",
"location": {
"street": "549 Elysian Fields Road",
"city": "Nashville",
"state": "TN",
"zipCode": "37211"
},
"type": "PICKUP"
},
"pickupSignatureRequired": true,
"deliverySignatureRequired": true,
"deliveryContact": {
"companyName": "Schroeder and Sons",
"name": "Garret Herman",
"primaryPhone": "5078088924",
"primaryPhoneNotes": "",
"location": {
"street": "549 Elysian Fields Road",
"city": "Nashville",
"state": "TN",
"zipCode": "40222"
},
"type": "DELIVERY"
},
"attachments": []
}
}
Dispatch Load Response
{
"id": "K9RV0",
"status": "PENDING_CLAIM",
"shipperLoadId": "K9RV0",
"externalId": null,
"load": {
"id": "XVW24",
"dispatchInstructions": null,
"useEnclosedTrailer": false,
"useM22InspectionGuide": false,
"useGpsTracking": true
},
"route": {
"id": "XL541",
"pickupDateDetail": {
"id": "LP621",
"estimatedEndDate": "2022-08-06",
"estimatedStartDate": "2022-08-04",
"restriction": "NO_RESTRICTIONS"
},
"deliveryDateDetail": {
"id": "Z9W0L",
"estimatedEndDate": "2022-08-19",
"estimatedStartDate": "2022-08-15",
"restriction": "NO_RESTRICTIONS"
},
"deliveryLocation": {
"id": "099D9",
"city": "Nashville",
"state": "TN",
"street": "549 Elysian Fields Road",
"zipCode": "40222",
"locationId": null,
"longitude": "-86.7463714",
"latitude": "36.0843293"
},
"pickupLocation": {
"id": "V66WN",
"city": "Nashville",
"state": "TN",
"street": "549 Elysian Fields Road",
"zipCode": "37211",
"locationId": null,
"longitude": "-86.7463714",
"latitude": "36.0843293"
},
"distanceInMiles": 189.21,
"transitTime": "1-4 days"
},
"shippingItems": [
{
"id": "8DW62",
"vehicle": {
"bodyType": "Car",
"buyerNumber": "",
"color": "",
"lotNumber": "",
"stockNumber": "",
"make": "Volvo",
"model": "960",
"vin": null,
"year": 1997,
"id": "8DW62",
"length": "191.40",
"height": "57.60",
"width": "68.9",
"weight": "3547",
"logo": "https://storage.googleapis.com/ship-cars-make-logos/volvo-logo.png",
"operableType": "OPERABLE",
"lbExternalId": null
},
"attachments": []
}
],
"payments": [
{
"id": "87NW7",
"carrierPayInCents": 26000,
"notes": "",
"paymentType": "COD",
"paymentTransactionType": "CUSTOMER_TO_CARRIER",
"paymentMethod": "CASH",
"paymentTermsBeginType": null,
"paymentTermsType": null
}
],
"carrierPayInCents": 26000,
"orderInformation": null,
"contract": {
"id": "K9RV0",
"shipper": {
"id": "0NDYD",
"companyName": "Pfannerstill-Sipes",
"email": "",
"name": "Colene Bechtelar",
"primaryPhone": "7708313873",
"primaryPhoneNotes": "",
"secondaryPhone": null,
"secondaryPhoneNotes": null,
"thirdPhone": null,
"thirdPhoneNotes": null,
"workingHours": "",
"location": {
"id": "2YY59",
"city": "",
"state": null,
"street": "",
"zipCode": null,
"locationId": null
},
"type": "CUSTOMER",
"notes": null
}
},
"attachments": [],
"carrierOffers": [],
"pickupContact": {
"id": "PEMO0",
"companyName": "Berge, Krajcik and Labadie",
"email": null,
"name": "Sammie Carroll",
"primaryPhone": "7205033590",
"primaryPhoneNotes": "",
"secondaryPhone": null,
"secondaryPhoneNotes": null,
"thirdPhone": null,
"thirdPhoneNotes": null,
"workingHours": null,
"location": {
"id": "DJJD0",
"city": "Nashville",
"state": "TN",
"street": "549 Elysian Fields Road",
"zipCode": "37211",
"locationId": null
},
"type": "PICKUP",
"notes": null
},
"extRateCalculationId": "EXy3Dh703anSItyUPH4H",
"carrier": null,
"driver": null,
"pickupSignatureRequired": true,
"deliverySignatureRequired": true,
"deliveryContact": {
"id": "VMWRJ",
"companyName": "Schroeder and Sons",
"email": null,
"name": "Garret Herman",
"primaryPhone": "5078088924",
"primaryPhoneNotes": "",
"secondaryPhone": null,
"secondaryPhoneNotes": null,
"thirdPhone": null,
"thirdPhoneNotes": null,
"workingHours": null,
"location": {
"id": "R22ZE",
"city": "Nashville",
"state": "TN",
"street": "549 Elysian Fields Road",
"zipCode": "40222",
"locationId": null
},
"type": "DELIVERY",
"notes": null
},
"publicLinkInfo": {
"id": "XV7GN",
"publicLinkKey": "1004585460210454528",
"publicLink": "https://tracking-qa.ship.cars/loads/1004585460210454528"
}
}
Retrieve carrier information by USDOT (optional)
This API checks the validity of your USDOT number, which must come from your front-end user input.
If you have a fixed preconfigured USDOT, there’s no need to call this endpoint.
Link: GET https://ship.cars/api/carriers/1673578/
where “1673578” is the USDOT.
Carrier Information Response
"company_owner_id": "38x0",
"company_owner": "https://qa.ship.cars/api/users/38x0/",
"user_management_id": "XVQ4K",
"auto_verified": null,
"type_description": null,
"type": null,
"next_invoice_number": 0,
"invoice_prefix": null,
"hide_user_list": false,
"email_notifications_enabled": true,
"invoice_enabled": true,
"internal_link_format": null,
"update_time": "2019-04-19T08:47:54.148285-05:00",
"create_time": "2019-04-19T08:46:17.569653-05:00",
"cd_uid": null,
"test": false,
"terms_of_service": "T&S.",
"accounting_zip": null,
"accounting_state": null,
"accounting_city": null,
"accounting_address": "4740 North Cumberland Avenue, Chicago, IL, 60656",
"accounting_phone_3_type": null,
"accounting_phone_3_notes": null,
"accounting_phone_3": null,
"accounting_phone_2_type": null,
"accounting_phone_2_notes": null,
"accounting_phone_2": null,
"accounting_phone_1_type": null,
"accounting_phone_1_notes": null,
"accounting_phone_1": null,
"accounting_email": "[email protected]",
"phone_3_type": null,
"phone_3_notes": null,
"phone_3": "(815) 346-5882",
"phone_2_type": "fax",
"phone_2_notes": null,
"phone_2": "(224) 300-5436",
"phone_1_type": null,
"phone_1_notes": null,
"phone_1": "(847) 321-9295",
"email": "[email protected]",
"logo": null,
"zip": "60656",
"state": "IL",
"city": "Chicago",
"address": "4740 N Cumberland Ave, 393",
"mc_number": null,
"dot_number": 1673578,
"is_single_owner_operator": false,
"is_api_integrator": false,
"is_carrier": true,
"is_shipper": false,
"name": "Montway Auto Carriers",
"slug": "montway-auto-carriers",
"compliance_notes": "",
"compliance_link_id": null,
"compliance_instabook": false,
"compliance_status": "not_verified",
"billing": {
"default_to_factoring_company": false,
"customer_message": null,
"factoring_payment_terms_business_days": null,
"factoring_email": null,
"factoring_phone": null,
"factoring_zip": null,
"factoring_state": null,
"factoring_city": null,
"factoring_address": null,
"factoring_name": null,
"accounting_zip": null,
"accounting_state": null,
"accounting_city": null,
"accounting_address": "4740 North Cumberland Avenue, Chicago, IL, 60656",
"accounting_phone_3_type": null,
"accounting_phone_3_notes": null,
"accounting_phone_3": null,
"accounting_phone_2_type": null,
"accounting_phone_2_notes": null,
"accounting_phone_2": null,
"accounting_phone_1_type": null,
"accounting_phone_1_notes": null,
"accounting_phone_1": null,
"accounting_email": "[email protected]",
"invoice_enabled": true,
"invoice_prefix": null,
"next_invoice_number": 1,
"company": 211
},
"inspection_configuration": {
"roof_photo": true,
"odometer_photo": true,
"level": 3
},
"exclusivity_enabled": false,
"is_broker": false,
"mandatory_tac": "By agreeing to the Terms and Conditions you agree to accept the use of electronic documentation, including but not limited to Electronic Bill of Lading (EBOL). If you are not the Customer/Shipper, you are also affirming that you have been expressly authorized to agree on the Customer/Shipper's behalf both to the Terms and Conditions and to the use of electronic documentation, including EBOL for this shipment.",
"labels": {},
"features": [
"driver_order_create_allow",
"create_edit_orders",
"loadboard"
],
"id": "jbxp",
"url": "https://qa.ship.cars/api/companies/jbxp/"
}
Retrieve Suggested Rate (optional)
This API generates an estimated total price owed to the carrier. It’s based on the provided pickup and delivery locations as well as the route and total calculated mile distance.
You can include a suggested rate directly in the Create/Dispatch Load APIs.
Link: POST https://staging.ship.cars/api/shipperlite/posting/v2/integrators/rate-calculations
You’ll need to get the carrierPayInCents and rateId used in the Dispatch/Create Load POST requests.
Suggest Rate Request
{
"useEnclosedTrailer": false,
"route": {
"pickupDateDetail": {
"estimatedStartDate": "2022-08-04",
"estimatedEndDate": "2022-08-06",
"restriction": "NO_RESTRICTIONS"
},
"deliveryDateDetail": {
"estimatedStartDate": "2022-08-14",
"estimatedEndDate": "2022-08-16",
"restriction": "NO_RESTRICTIONS"
},
"pickupLocation": {
"street": "481 East Redbud Lane",
"city": "Fayetteville",
"state": "AR",
"zipCode": "72703"
},
"deliveryLocation": {
"street": "481 East Redbud Lane",
"city": "Fayetteville",
"state": "AR",
"zipCode": "20016"
},
"distanceInMiles": ""
},
"vehicles": [
{
"bodyType": "Car",
"buyerNumber": "",
"lotNumber": "",
"stockNumber": "",
"make": "Acura",
"model": "Legend",
"color": "",
"vin": "JH4KA4630LC007479",
"year": 1990,
"operableType": "OPERABLE"
}
]
}
Suggest Rate Response
{
"rateId": "qabUKVdEIKRSxr8fU8Ew",
"distanceInMiles": "1151.62",
"carrierPayInCents": 75255,
"autoTypeSurchargeInCents": 588,
"enclosedSurchargeInCents": 38807,
"reverseRouteCarrierPayInCents": 90235
}
Get Load
Information about an existing load can be visualized with the help of its ID. This API retrieves load data using the id field of the Create Load request code.
Link: GET https://ship.cars/api/shipperlite/posting/v2/integrators/loads/K9RV0
The response is identical to the respective Create Load response codes.
Update Load
Using retrieved information from the Get Load endpoint, this API allows you to make changes to a specific load - in other words, updating one or more of its fields.
Keep in mind that you cannot update a load if its status is one of the following:
PENDING_POSTING - the Create API load is called but the load itself is not yet posted
to a carrier or the Load Board; pending async operation
DELIVERED - the load is delivered and cannot be changed
PENDING_ARCHIVE - there is a pending archive operation
ARCHIVED - the load is archived
The following statuses support updates:
POSTED - the load is posted on the Load Board but not linked to a carrier
PENDING_CLAIM - the load is pending to be claimed
CARRIER_PENDING - the load is dispatched to a carrier but not yet accepted
DISPATCHED - the load is dispatched
ASSIGNED - the load is assigned to a driver
PICKED_UP - the load is picked up by a carrier
Link: PUT https://ship.cars/api/shipperlite/posting/v2/integrators/loads/K9RV0
The response body is the same as the one you receive on create.
Archive Load
The archiving load will also cancel on the carrier side if it is not picked up.
To archive, use the POST request:
Link: POST https://ship.cars/api/shipperlite/posting/v2/integrators/loads/YK41K/operations
The Archive Payload
{
"type": "ARCHIVE",
"payload": null
}
The response: 204 No content
Get Location Data for a Load
This API returns the location tracking data of a specific load using the externalId field from its Create Load response. To use location history, you must enable location sharing for the load, which should also be approved by its dispatcher/driver.
You can obtain a valid externalId once the load status becomes POSTED.
Link: GET https://ship.cars/api/location_tracking/history/vg9q38/
Location Data Response
[
{
"status": "ongoing",
"timestamp": "2021-07-22T09:41:20.483000+00:00",
"location": {
"longitude": -119.8524937,
"latitude": 37.5945638
}
},
{
"status": "ongoing",
"timestamp": "2021-07-22T10:15:20.483000+00:00",
"location": {
"longitude": -119.2053407,
"latitude": 38.1888124
}
},
{
"status": "ongoing",
"timestamp": "2021-07-22T10:42:20.483000+00:00",
"location": {
"longitude": -119.4643684,
"latitude": 38.5128509
}
},
{
"status": "ongoing",
"timestamp": "2021-07-22T11:02:20.483000+00:00",
"location": {
"longitude": -117.7764446,
"latitude": 38.0186303
}
},
{
"status": "ongoing",
"timestamp": "2021-07-23T11:02:20.483000+00:00",
"location": {
"longitude": -119.1196436,
"latitude": 37.9571971
}
},
{
"status": "ongoing",
"timestamp": "2021-09-24T07:41:20.483000+00:00",
"location": {
"longitude": -118.8517224,
"latitude": 37.5945638
}
}
]
Get the BOL & Images for a Load
This API uses the Get Load response to retrieve a PDF file containing the load’s bill of lading document. Inside, you’ll be able to access a link leading to the BOL’s attachments (images), if applicable.
There can be attachments per load and per specific shipping item such as vehicle.
Each attachment contains a public link with secure URL (check the fileURL from the Json below).
Sample response of attachments on shipping item level:
Shipping Items Attachments
"shippingItems": [
{
"id": "8J5LV",
"vehicle": {
"bodyType": "Car",
"buyerNumber": null,
"color": null,
"lotNumber": null,
"stockNumber": null,
"make": "Acura",
"model": "Legend",
"vin": "JH4KA4540JC050162",
"year": 1988,
"id": "8J5LV",
"length": "190.00",
"height": "52.00",
"width": "68.0",
"weight": "3239",
"logo": "https://storage.googleapis.com/ship-cars-make-logos/acura-logo.png",
"operableType": "OPERABLE",
"lbExternalId": null
},
"attachments": [
{
"fileUrl": "https://media.ship.cars/media/postings/attachments/d93a1ac3-9817-4f96-a6eb-37c6bd6cae38.jpg",
"shareWith": null,
"id": "XWP21",
"lbExternalId": null,
"loadLegId": null,
"shippingItemId": "8J5LV",
"creatorType": "SHIPPER",
"originalFileName": "4mb_image.jpg"
}
]
}
]
Updated over 2 years ago