--- updatedAt: 2025-09-10T20:59:58.000Z agentTools: projectIndex: https://shipcars.readme.io/llms.txt --- # /loads/{id}/ Retrieves an identified load. # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "CTMS", "description": "Ship.Cars CTMS", "contact": { "url": "https://ship.cars", "email": "support@ship.cars" }, "version": "1.0.0" }, "components": { "securitySchemes": { "bearerAuth": { "type": "oauth2", "flows": { "password": { "tokenUrl": "https://auth.ship.cars/auth/realms/master/protocol/openid-connect/token", "scopes": {} } } } } }, "servers": [ { "url": "https://ship.cars/api" } ], "paths": { "/loads/{id}/": { "get": { "tags": [ "Loads" ], "description": "Retrieves an identified load.", "operationId": "loads_read", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authenticates API requests with a valid access token.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Unique ID of the load.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "URL of the load resource.", "format": "uri", "readOnly": true }, "id": { "type": "string", "description": "Unique ID of the load.", "readOnly": true }, "vehicles": { "type": "array", "description": "List of vehicles in the load.", "items": { "required": [ "load" ], "type": "object", "properties": { "url": { "type": "string", "description": "URL of the vehicle resource.", "format": "uri", "readOnly": true }, "id": { "type": "string", "description": "Unique ID of the vehicle.", "readOnly": true }, "vehicle_sketch": { "type": "string", "description": "URL of the sketch for the vehicle type (used for noting damages).", "format": "uri", "readOnly": true }, "attachments": { "type": "array", "description": "List of attached files associated with the vehicle.", "readOnly": true, "items": { "required": [ "file", "load", "type", "vehicle" ], "type": "object", "properties": { "file": { "type": "string", "description": "File to be attached to the specified load or vehicle.", "format": "binary" }, "load": { "type": "string", "description": "URL of the load to which the file is attached.", "format": "uri" }, "vehicle": { "type": "string", "description": "URL of the vehicle to which the file is attached.", "format": "uri" }, "type": { "type": "string", "description": "Type of the attached file.", "enum": [ "pickup_signature", "delivery_signature", "pickup_sketch", "delivery_sketch", "pickup_damages_picture", "delivery_damages_picture", "pickup_odometer_picture", "delivery_odometer_picture", "pickup_bol", "delivery_bol", "invoice", "dispatch_sheet", "scanned_document", "other" ] }, "segment": { "type": "string", "description": "Vehicle segment to which the attached file applies.", "enum": [ "front", "back", "left", "right", "top" ] }, "share_with_driver": { "type": "boolean", "description": "Indicates whether driver users can access the attached file.", "default": true }, "location": { "type": "object", "properties": { "coordinates": { "type": "array", "description": "List of coordinates associated with the entry.", "items": { "type": "number", "description": "Longitude and latitude of an individual point.", "format": "float" } }, "type": { "type": "string", "description": "Geometry type of the entry.", "example": "Point" } }, "description": "GeoJSON Geometry object with the GPS coordinates of the location associated with the attached file." }, "comments": { "type": "string", "description": "Additional comments about the attached file." }, "timestamp": { "type": "string", "description": "Date and time when the attached file is originally created.", "format": "date-time" }, "timezone": { "maxLength": 64, "type": "string", "description": "Time zone in which the attached file is originally created." } } } }, "type": { "type": "string", "description": "Internal name of the vehicle type.", "enum": [ "sedan", "van", "suv", "pickup", "motorcycle", "mini-van" ] }, "human_type": { "type": "string", "description": "Human-readable name of the vehicle type.", "readOnly": true, "enum": [ "Sedan", "Van", "SUV", "Pickup", "Motorcycle", "Mini-Van" ] }, "logo": { "type": "string", "description": "URL of the logo of the vehicle manufacturer.", "format": "uri", "readOnly": true }, "m22_damages": { "type": "array", "description": "List of damages noted for the vehicle according to the M-22 standard.", "readOnly": true, "items": { "required": [ "area", "severity", "type" ], "type": "object", "properties": { "url": { "type": "string", "description": "URL of the M22 damage entry resource.", "format": "uri", "readOnly": true }, "id": { "type": "string", "description": "Unique ID of the M22 damage entry.", "readOnly": true }, "area": { "type": "string", "description": "Unique code of the M-22 damage area.", "enum": [ "01", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "20", "21", "22", "24", "25", "26", "27", "30", "31", "35", "36", "37", "38", "39", "42", "45", "52", "53", "56", "57", "59", "63", "64", "65", "72", "73", "74", "75", "76", "77", "78", "79", "80", "81", "82", "83", "84", "86", "89", "90", "91", "92" ] }, "type": { "type": "string", "description": "Unique code of the M-22 damage type.", "enum": [ "01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "18", "19", "20", "21", "22", "23", "24", "25", "29", "30", "34", "36", "37", "38", "39" ] }, "severity": { "type": "string", "description": "Unique code of the M-22 damage severity.", "enum": [ "1", "2", "3", "4", "5", "6" ] }, "inspection_type": { "type": "string", "description": "Vehicle inspection during which the M-22 damage is noted.", "readOnly": true, "enum": [ "pickup", "delivery" ] }, "vehicle": { "type": "string", "description": "URL of the vehicle resource for which the M-22 damage entry is noted.", "format": "uri", "readOnly": true }, "vehicle_id": { "type": "string", "description": "ID of the vehicle for which the M-22 damage entry is noted.", "readOnly": true } }, "description": "List of damage entries noted for the vehicle according to the M-22 standard." } }, "created": { "type": "boolean", "description": "Indicates whether the vehicle is being added to the load.", "readOnly": true }, "deleting": { "type": "boolean", "description": "Indicates whether the vehicle is being removed from the load.", "readOnly": true }, "year": { "maximum": 32767, "minimum": 0, "type": "integer", "description": "Vehicle manufacture year." }, "make": { "maxLength": 64, "type": "string", "description": "Vehicle make." }, "model": { "maxLength": 64, "type": "string", "description": "Vehicle model." }, "color": { "maxLength": 64, "type": "string", "description": "Vehicle color." }, "vin": { "maxLength": 20, "type": "string", "description": "Vehicle VIN number." }, "buyer_number": { "maxLength": 64, "type": "string", "description": "Vehicle buyer number." }, "lot_number": { "maxLength": 64, "type": "string", "description": "Vehicle LOT number." }, "operable": { "type": "boolean", "description": "Indicates whether the vehicle is in operable condition." }, "shipper_vehicle_id": { "maxLength": 256, "type": "string", "description": "Shipper's unique ID of the vehicle." }, "specifications_data": { "type": "object", "properties": { "weight": { "type": "object", "properties": { "min": { "type": "integer", "description": "Minimum weight of the vehicle (in pounds)." }, "max": { "type": "integer", "description": "Maximum weight of the vehicle (in pounds)." } }, "description": "Range of the minimum and the maximum weight of the vehicle (in pounds)." }, "length": { "type": "object", "properties": { "min": { "type": "number", "description": "Minimum length of the vehicle (in inches).", "format": "decimal" }, "max": { "type": "number", "description": "Maximum length of the vehicle (in inches).", "format": "decimal" } }, "description": "Range of the minimum and maximum length of the vehicle (in inches)." }, "height": { "type": "object", "properties": { "min": { "type": "number", "description": "Minimum height of the vehicle (in inches).", "format": "decimal" }, "max": { "type": "number", "description": "Maximum height of the vehicle (in inches).", "format": "decimal" } }, "description": "Range of the minimum and maximum height of the vehicle (in inches)." }, "width": { "type": "object", "properties": { "min": { "type": "number", "description": "Minimum width of the vehicle (in inches).", "format": "decimal" }, "max": { "type": "number", "description": "Maximum width of the vehicle (in inches).", "format": "decimal" } }, "description": "Range of the minimum and maximum width of the vehicle (in inches)." } }, "description": "Specification data of the vehicle weight, length, height, and width as retrieved from the vehicle database based on YMM combination." }, "specifications_year": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Vehicle manufacture year used to retrieve data from the vehicle specification database.", "readOnly": true }, "status": { "type": "string", "description": "Current status of the vehicle.", "readOnly": true, "default": "new", "enum": [ "new", "assigned", "picked-up", "delivered" ] }, "pickup_odometer": { "type": "string", "description": "Vehicle odometer reading as recorded by the driver at the time of pickup.", "format": "decimal", "readOnly": true }, "delivery_odometer": { "type": "string", "description": "Vehicle odometer reading as recorded by the driver at the time of delivery.", "format": "decimal", "readOnly": true }, "pickup_location": { "type": "object", "properties": { "coordinates": { "type": "array", "description": "List of coordinates associated with the entry.", "items": { "type": "number", "description": "Longitude and latitude of an individual point.", "format": "float" } }, "type": { "type": "string", "description": "Geometry type of the entry.", "example": "Point" } }, "description": "GeoJSON Geometry object with the GPS coordinates of the actual pickup location.", "readOnly": true }, "pickup_location_address": { "maxLength": 256, "type": "string", "description": "Full address of the actual pickup location (as retrieved from the GPS coordinates).", "readOnly": true }, "delivery_location": { "type": "object", "properties": { "coordinates": { "type": "array", "description": "List of coordinates associated with the entry.", "items": { "type": "number", "description": "Longitude and latitude of an individual point.", "format": "float" } }, "type": { "type": "string", "description": "Geometry type of the entry.", "example": "Point" } }, "description": "GeoJSON Geometry object with the GPS coordinates of the actual delivery location.", "readOnly": true }, "delivery_location_address": { "maxLength": 256, "type": "string", "description": "Full address of the actual delivery location (as retrieved from the GPS coordinates).", "readOnly": true }, "pickup_night": { "type": "boolean", "description": "Indicates whether it's dark at the time of pickup. This is specified by the driver as an inspection impediment.", "readOnly": true }, "pickup_snow": { "type": "boolean", "description": "Indicates whether it's snowing at the time of pickup. This is specified by the driver as an inspection impediment.", "readOnly": true }, "pickup_rain": { "type": "boolean", "description": "Indicates whether it's raining at the time of pickup. This is specified by the driver as an inspection impediment.", "readOnly": true }, "pickup_dirty": { "type": "boolean", "description": "Indicates whether the vehicle is dirty at the time of pickup. This is specified by the driver as an inspection impediment.", "readOnly": true }, "pickup_full_name": { "maxLength": 64, "type": "string", "description": "Full name of the pickup contact who signed the BOL.", "readOnly": true }, "delivery_full_name": { "maxLength": 64, "type": "string", "description": "Full name of the delivery contact who signed the BOL.", "readOnly": true }, "delivery_exceptions": { "maxLength": 1024, "type": "string", "description": "Additional notes about the exceptions added by the delivery contact.", "readOnly": true }, "delivery_driver_notes": { "maxLength": 1024, "type": "string", "description": "Driver's additional notes about the vehicle at the time of delivery.", "readOnly": true }, "pickup_driver_notes": { "maxLength": 1024, "type": "string", "description": "Driver's additional notes about the vehicle at the time of pickup.", "readOnly": true }, "pickup_date": { "type": "string", "description": "Date of the actual pickup of the vehicle.", "format": "date-time", "readOnly": true }, "pickup_no_damages": { "type": "boolean", "description": "Indicates whether the vehicle is picked up without noting any damages to it.", "readOnly": true }, "delivery_date": { "type": "string", "description": "Date of the actual delivery of the vehicle.", "format": "date-time", "readOnly": true }, "delivery_no_damages": { "type": "boolean", "description": "Indicates whether the vehicle is delivered without noting any damages to it.", "readOnly": true }, "seen_by_driver_time": { "type": "string", "description": "Date and time when the driver first saw the assigned vehicle.", "format": "date-time", "readOnly": true }, "create_time": { "type": "string", "description": "Date and time of the original creation of the vehicle resource.", "format": "date-time", "readOnly": true }, "update_time": { "type": "string", "description": "Date and time of the latest update of the vehicle resource.", "format": "date-time", "readOnly": true }, "active_change": { "type": "string", "description": "URL of the resource for the latest change from an active revision related to the vehicle.", "format": "uri", "readOnly": true }, "active_revision": { "type": "string", "description": "URL of the resource for the active revision related to the vehicle.", "format": "uri", "readOnly": true }, "load": { "type": "string", "description": "URL of the resource for of the load to which the vehicle belongs.", "format": "uri" }, "pickup_signature_decline_reason": { "type": "string", "description": "URL of the resource for the configured reason given by the pickup contact for declining to sign the BOL.", "format": "uri", "readOnly": true }, "delivery_signature_decline_reason": { "type": "string", "description": "URL of the resource for the configured reason given by the delivery contact for declining to sign the BOL.", "format": "uri", "readOnly": true }, "driver": { "type": "string", "description": "URL of the user resource for the driver to whom the vehicle is assigned (as part of the load).", "format": "uri", "readOnly": true }, "active_change_id": { "type": "string", "description": "ID of the latest change from an active revision related to the vehicle.", "readOnly": true }, "active_revision_id": { "type": "string", "description": "ID of the active revision related to the vehicle.", "readOnly": true }, "load_id": { "type": "string", "description": "ID of the load to which the vehicle belongs.", "readOnly": true }, "pickup_signature_decline_reason_id": { "type": "string", "description": "ID of the configured reason given by the pickup contact for declining to sign the BOL.", "readOnly": true }, "delivery_signature_decline_reason_id": { "type": "string", "description": "ID of the configured reason given by the delivery contact for declining to sign the BOL.", "readOnly": true }, "driver_id": { "type": "string", "description": "ID of the driver to whom the vehicle is assigned (as part of the load).", "readOnly": true } } } }, "decline_reason": { "type": "string", "description": "Unique slug of the configured reason for a carrier to decline the dispatched load.", "readOnly": true, "enum": [ "change_of_plans", "inoperable", "does_not_fit", "extreme_weather", "personal_reasons", "mechanical_issues", "route_change" ] }, "cancel_reason": { "type": "string", "description": "Unique slug of the configured reason for a carrier to cancel the accepted load.", "readOnly": true, "enum": [ "change_of_plans", "inoperable", "does_not_fit", "extreme_weather", "personal_reasons", "mechanical_issues", "route_change" ] }, "active_change_values": { "type": "object", "properties": {}, "description": "Modified load attributes from the active load revision with their new values.", "readOnly": true }, "activity_log": { "type": "array", "description": "List of events recorded for the load.", "readOnly": true, "items": { "required": [ "extra_object", "load" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique ID of the entry resource.", "readOnly": true }, "event_type": { "type": "string", "description": "Type of the event.", "readOnly": true, "enum": [ "dispatched", "accepted", "assigned", "seen", "picked_up", "delivered", "uship_code_added", "invoice_generated", "broker_change", "change_accepted", "change_declined", "cancelled", "load_manually_created" ] }, "event_type_category": { "type": "string", "description": "Category of the event type.", "readOnly": true, "enum": [ "general", "broker", "driver", "hidden" ] }, "extra_object": { "type": "object", "properties": { "object_type": { "type": "string", "description": "Resource type of the extra object.", "enum": [ "load", "vehicle", "offer", "user" ] }, "pk": { "type": "string", "description": "ID of the extra object resource." }, "url": { "type": "string", "description": "URL of the extra object resource.", "format": "uri" } }, "description": "Details of the extra resource object affected by the event." }, "actor_company": { "type": "string", "description": "URL of the resource for the company with which the actor user is associated.", "format": "uri", "readOnly": true }, "carrier": { "type": "string", "description": "URL of the resource for the carrier company to which the load is dispatched.", "format": "uri", "readOnly": true }, "shipper": { "type": "string", "description": "URL of the resource for the shipper company that created the load.", "format": "uri", "readOnly": true }, "timestamp": { "type": "string", "description": "Date and time of the notification generation.", "format": "date-time", "readOnly": true }, "load": { "type": "string", "description": "URL of the load resource to which the event is related.", "format": "uri", "readOnly": true }, "actor": { "type": "string", "description": "URL of the resource for the user whose actions lead to the event.", "format": "uri", "readOnly": true }, "actor_company_id": { "type": "string", "description": "ID of the company with which the actor user is associated.", "readOnly": true }, "carrier_id": { "type": "string", "description": "ID of the carrier company to which the load is dispatched.", "readOnly": true }, "shipper_id": { "type": "string", "description": "ID of the shipper company that created the load.", "readOnly": true }, "load_id": { "type": "string", "description": "ID of the load to which the event is related.", "readOnly": true }, "actor_id": { "type": "string", "description": "ID of the user whose actions lead to the event.", "readOnly": true } }, "description": "List of events recorded for the load." } }, "attachments": { "type": "array", "description": "List of attached files associated with the load.", "readOnly": true, "items": { "required": [ "file", "load", "type", "vehicle" ], "type": "object", "properties": { "file": { "type": "string", "description": "File to be attached to the specified load or vehicle.", "format": "binary" }, "load": { "type": "string", "description": "URL of the load to which the file is attached.", "format": "uri" }, "vehicle": { "type": "string", "description": "URL of the vehicle to which the file is attached.", "format": "uri" }, "type": { "type": "string", "description": "Type of the attached file.", "enum": [ "pickup_signature", "delivery_signature", "pickup_sketch", "delivery_sketch", "pickup_damages_picture", "delivery_damages_picture", "pickup_odometer_picture", "delivery_odometer_picture", "pickup_bol", "delivery_bol", "invoice", "dispatch_sheet", "scanned_document", "other" ] }, "segment": { "type": "string", "description": "Vehicle segment to which the attached file applies.", "enum": [ "front", "back", "left", "right", "top" ] }, "share_with_driver": { "type": "boolean", "description": "Indicates whether driver users can access the attached file.", "default": true }, "location": { "type": "object", "properties": { "coordinates": { "type": "array", "description": "List of coordinates associated with the entry.", "items": { "type": "number", "description": "Longitude and latitude of an individual point.", "format": "float" } }, "type": { "type": "string", "description": "Geometry type of the entry.", "example": "Point" } }, "description": "GeoJSON Geometry object with the GPS coordinates of the location associated with the attached file." }, "comments": { "type": "string", "description": "Additional comments about the attached file." }, "timestamp": { "type": "string", "description": "Date and time when the attached file is originally created.", "format": "date-time" }, "timezone": { "maxLength": 64, "type": "string", "description": "Time zone in which the attached file is originally created." } } } }, "distance_imperial": { "type": "integer", "description": "Calculated distance of the recommended route between the pickup and delivery locations (in miles).", "readOnly": true }, "shipper": { "type": "string", "description": "URL of the resource for the shipper company that created the load.", "format": "uri", "readOnly": true }, "payment_to_carrier": { "type": "string", "description": "Amount for which the invoice is generated. It is calculated as the difference between the total payment amount and the payment amounts on pickup and delivery: `payment_to_carrier = total_payment_to_carrier - payment_on_pickup - payment_on_delivery`.", "format": "decimal", "readOnly": true }, "posting": { "title": "Posting", "type": "object", "properties": { "id": { "type": "string", "description": "Unique ID of the posting entry.", "readOnly": true }, "create_time": { "type": "string", "description": "Date and time of the original creation of the posting.", "format": "date-time", "readOnly": true }, "update_time": { "type": "string", "description": "Date and time of the latest update of the posting.", "format": "date-time", "readOnly": true }, "status": { "maxLength": 64, "type": "string", "description": "Current status of the posting.", "enum": [ "active", "inactive", "claimed" ] }, "order": { "type": "string", "description": "URL of the load that is posted on the loadboard.", "format": "uri", "readOnly": true }, "order_id": { "type": "string", "description": "ID of the load that is posted on the loadboard.", "readOnly": true } }, "description": "Details of the loadboard posting. Available only when the load is posted on the loadboard." }, "carrier_dot_number": { "type": "string", "description": "USDOT number of the carrier company.", "readOnly": true }, "shipper_dot_number": { "type": "string", "description": "USDOT number of the shipper company.", "readOnly": true }, "terms_and_conditions": { "type": "string", "description": "Terms of service of the shipper company." }, "invoice_number": { "type": "string", "description": "Reference number of the invoice generated for the load.", "readOnly": true }, "pickup_requested_times": { "maxLength": 256, "type": "string", "description": "Requested time window during the day for the pickup." }, "pickup_name": { "maxLength": 256, "type": "string", "description": "Name of the pickup contact company." }, "pickup_contact": { "maxLength": 256, "type": "string", "description": "Name of the pickup contact person." }, "pickup_address": { "maxLength": 1024, "type": "string", "description": "Street name and number from the pickup location address." }, "pickup_address_location": { "type": "object", "properties": { "coordinates": { "type": "array", "description": "List of coordinates associated with the entry.", "items": { "type": "number", "description": "Longitude and latitude (X and Y coordinates) of an individual point.", "format": "float" } }, "type": { "type": "string", "description": "Geometry type of the entry.", "example": "Point" } }, "description": "GeoJSON Geometry object with the GPS coordinates of the pickup location address.", "readOnly": true }, "pickup_city": { "maxLength": 256, "type": "string", "description": "City name from the pickup location address." }, "pickup_state": { "type": "string", "description": "Abbreviation of the state from the pickup location address.", "enum": [ "AL", "AK", "AS", "AZ", "AR", "AA", "AE", "AP", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "GU", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "MP", "OH", "OK", "OR", "PA", "PR", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VI", "VA", "WA", "WV", "WI", "WY" ] }, "pickup_zip": { "maxLength": 10, "type": "string", "description": "Zip code from the pickup location address." }, "pickup_phone_1": { "maxLength": 20, "type": "string", "description": "First contact number of the pickup contact." }, "pickup_phone_1_notes": { "maxLength": 256, "type": "string", "description": "Additional notes about the first contact number of the pickup contact." }, "pickup_phone_1_type": { "type": "string", "description": "Type of the first contact number of the pickup contact.", "enum": [ "phone", "fax" ] }, "pickup_phone_2": { "maxLength": 20, "type": "string", "description": "Second contact number of the pickup contact." }, "pickup_phone_2_notes": { "maxLength": 256, "type": "string", "description": "Additional notes about the second contact number of the pickup contact." }, "pickup_phone_2_type": { "type": "string", "description": "Type of the second contact number of the pickup contact.", "enum": [ "phone", "fax" ] }, "pickup_phone_3": { "maxLength": 20, "type": "string", "description": "Third contact number of the pickup contact." }, "pickup_phone_3_notes": { "maxLength": 256, "type": "string", "description": "Additional notes about the third contact number of the pickup contact." }, "pickup_phone_3_type": { "type": "string", "description": "Type of the third contact number of the pickup contact.", "enum": [ "phone", "fax" ] }, "pickup_date": { "type": "string", "description": "Date of the actual pickup of the load at the origin location.", "format": "date-time" }, "pickup_no_damages": { "type": "boolean", "description": "Indicates whether the load is picked up without noting any damages to the vehicles." }, "pickup_notes": { "type": "string", "description": "Driver's additional notes at the time of pickup." }, "pickup_customer_not_present": { "type": "boolean", "description": "Indicates whether a contact person is not expected at the time of pickup." }, "pickup_estimate_type": { "type": "string", "description": "Type of the estimated pickup date specified by the carrier in a booking offer.", "enum": [ "estimated", "exactly", "not_earlier", "not_later" ] }, "pickup_estimate_date": { "type": "string", "description": "Estimated pickup date specified by the carrier in a booking offer.", "format": "date" }, "pickup_estimate_end_type": { "type": "string", "description": "Type of the last date of the estimated pickup window specified by the carrier in a booking offer.", "enum": [ "estimated", "not_later" ] }, "pickup_estimate_end_date": { "type": "string", "description": "Last date of the estimated pickup window specified by the carrier in a booking offer.", "format": "date" }, "pickup_requested_date_start": { "type": "string", "description": "First date of the requested pickup window for a load posted on the loadboard.", "format": "date" }, "pickup_requested_date_start_type": { "type": "string", "description": "Type of the first date of the requested pickup window for a load posted on the loadboard.", "enum": [ "estimated", "exactly", "not_earlier", "not_later" ] }, "pickup_requested_date_end": { "type": "string", "description": "Last date of the requested pickup window for a load posted on the loadboard.", "format": "date" }, "pickup_requested_date_end_type": { "type": "string", "description": "Type of the last date of the requested pickup window for a load posted on the loadboard.", "enum": [ "estimated", "not_later" ] }, "pickup_contract_date_start": { "type": "string", "description": "First date of the contract pickup window.", "format": "date" }, "pickup_contract_date_start_type": { "type": "string", "description": "Type of the first date of the contract pickup window.", "enum": [ "estimated", "exactly", "not_earlier", "not_later" ] }, "pickup_contract_date_end": { "type": "string", "description": "Last date of the contract pickup window.", "format": "date" }, "pickup_contract_date_end_type": { "type": "string", "description": "Type of the last date of the contract pickup window.", "enum": [ "estimated", "not_later" ] }, "delivery_requested_times": { "maxLength": 256, "type": "string", "description": "Requested time window during the day for the delivery." }, "delivery_name": { "maxLength": 256, "type": "string", "description": "Name of the delivery contact company." }, "delivery_contact": { "maxLength": 256, "type": "string", "description": "Name of the delivery contact person." }, "delivery_address": { "maxLength": 1024, "type": "string", "description": "Street name and number from the delivery location address." }, "delivery_address_location": { "type": "object", "properties": { "coordinates": { "type": "array", "description": "List of coordinates associated with the entry.", "items": { "type": "number", "description": "Longitude and latitude (X and Y coordinates) of an individual point.", "format": "float" } }, "type": { "type": "string", "description": "Geometry type of the entry.", "example": "Point" } }, "description": "GeoJSON Geometry object with the GPS coordinates of the delivery location address.", "readOnly": true }, "delivery_city": { "maxLength": 256, "type": "string", "description": "City name from the delivery location address." }, "delivery_state": { "type": "string", "description": "Abbreviation of the state from the delivery location address.", "enum": [ "AL", "AK", "AS", "AZ", "AR", "AA", "AE", "AP", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "GU", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "MP", "OH", "OK", "OR", "PA", "PR", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VI", "VA", "WA", "WV", "WI", "WY" ] }, "delivery_zip": { "maxLength": 10, "type": "string", "description": "Zip code from the delivery location address." }, "delivery_phone_1": { "maxLength": 20, "type": "string", "description": "First contact number of the delivery contact." }, "delivery_phone_1_notes": { "maxLength": 256, "type": "string", "description": "Additional notes about the first contact number of the delivery contact." }, "delivery_phone_1_type": { "type": "string", "description": "Type of the first contact number of the delivery contact.", "enum": [ "phone", "fax" ] }, "delivery_phone_2": { "maxLength": 20, "type": "string", "description": "Second contact number of the delivery contact." }, "delivery_phone_2_notes": { "maxLength": 256, "type": "string", "description": "Additional notes about the second contact number of the delivery contact." }, "delivery_phone_2_type": { "type": "string", "description": "Type of the second contact number of the delivery contact.", "enum": [ "phone", "fax" ] }, "delivery_phone_3": { "maxLength": 20, "type": "string", "description": "Third contact number of the delivery contact." }, "delivery_phone_3_notes": { "maxLength": 256, "type": "string", "description": "Additional notes about the third contact number of the delivery contact." }, "delivery_phone_3_type": { "type": "string", "description": "Type of the third contact number of the delivery contact.", "enum": [ "phone", "fax" ] }, "delivery_date": { "type": "string", "description": "Date of the actual delivery of the load at the destination location.", "format": "date-time" }, "delivery_notes": { "type": "string", "description": "Driver's additional notes at the time of delivery." }, "delivery_customer_not_present": { "type": "boolean", "description": "Indicates whether a contact person is not expected at the time of delivery." }, "delivery_no_damages": { "type": "boolean", "description": "Indicates whether the load is delivered without noting any damages to the vehicles." }, "delivery_estimate_type": { "type": "string", "description": "Type of the estimated delivery date specified by the carrier in a booking offer.", "enum": [ "estimated", "exactly", "not_earlier", "not_later" ] }, "delivery_estimate_date": { "type": "string", "description": "Estimated delivery date specified by the carrier in a booking offer.", "format": "date" }, "delivery_estimate_end_type": { "type": "string", "description": "Type of the last date of the estimated delivery window specified by the carrier in a booking offer.", "enum": [ "estimated", "not_later" ] }, "delivery_estimate_end_date": { "type": "string", "description": "Last date of the estimated delivery window specified by the carrier in a booking offer.", "format": "date" }, "delivery_requested_date_start": { "type": "string", "description": "First date of the requested delivery window for a load posted on the loadboard.", "format": "date" }, "delivery_requested_date_start_type": { "type": "string", "description": "Type of the first date of the requested delivery window for a load posted on the loadboard.", "enum": [ "estimated", "exactly", "not_earlier", "not_later" ] }, "delivery_requested_date_end": { "type": "string", "description": "Last date of the requested delivery window for a load posted on the loadboard.", "format": "date" }, "delivery_requested_date_end_type": { "type": "string", "description": "Type of the last date of the requested delivery window for a load posted on the loadboard.", "enum": [ "estimated", "not_later" ] }, "delivery_contract_date_start": { "type": "string", "description": "First date of the contract delivery window.", "format": "date" }, "delivery_contract_date_start_type": { "type": "string", "description": "Type of the first date of the contract delivery window.", "enum": [ "estimated", "exactly", "not_earlier", "not_later" ] }, "delivery_contract_date_end": { "type": "string", "description": "Last date of the contract delivery window.", "format": "date" }, "delivery_contract_date_end_type": { "type": "string", "description": "Type of the last date of the contract delivery window.", "enum": [ "estimated", "not_later" ] }, "transit_time_estimated_min": { "maximum": 32767, "minimum": 0, "type": "integer", "description": "Minimum number of transit days for the load calculated as the difference between the last date of the estimated pickup window and the first date of the estimated delivery window." }, "transit_time_estimated_max": { "maximum": 32767, "minimum": 0, "type": "integer", "description": "Maximum number of transit days for the load calculated as the difference between the first date of the estimated pickup window and the last date of the estimated delivery window." }, "accept_time": { "type": "string", "description": "Date and time of the initial acceptance of the dispatched load.", "format": "date-time", "readOnly": true }, "assign_time": { "type": "string", "description": "Date and time of assigning a driver to the load.", "format": "date-time", "readOnly": true }, "last_change_time": { "type": "string", "description": "Date and time of the latest change to the load.", "format": "date-time", "readOnly": true }, "distance": { "type": "integer", "description": "Calculated distance of the recommended route between the pickup and delivery locations (in meters).", "readOnly": true }, "last_dispatch_generate_time": { "type": "string", "description": "Date and time of the latest dispatch contract generation resulting from the acceptance of the dispatched load or the changes from a load revision.", "format": "date-time", "readOnly": true }, "last_dispatch_generate_user_email": { "type": "string", "description": "The email address of the user who accepted the dispatched load or the changes from a load revision.", "format": "email", "readOnly": true }, "last_dispatch_generate_ip": { "type": "string", "description": "The IP address from which the user accepted the dispatched load or the changes from a load revision.", "readOnly": true }, "listed_price": { "type": "string", "description": "Original payment amount listed in the posting on the loadboard.", "format": "decimal", "readOnly": true }, "payment_on_pickup": { "type": "string", "description": "Payment amount due to the carrier on pickup.", "format": "decimal" }, "payment_on_pickup_method": { "type": "string", "description": "Payment method for the amount due to the carrier on pickup.", "enum": [ "cash", "business_check", "cashiers_check" ] }, "payment_on_delivery": { "type": "string", "description": "Payment amount due to the carrier on delivery.", "format": "decimal" }, "payment_on_delivery_method": { "type": "string", "description": "Payment method for the amount due to the carrier on delivery.", "enum": [ "cash", "business_check", "cashiers_check", "uship" ] }, "total_payment_to_carrier": { "type": "string", "description": "Total payment amount due to the carrier for the load.", "format": "decimal" }, "payment_term_business_days": { "maximum": 32767, "minimum": 0, "type": "integer", "description": "Duration of the payment term period (in business days)." }, "payment_term_begins": { "type": "string", "description": "Event in the load processing flow when the payment term period begins.", "enum": [ "pickup", "delivery", "uship", "bol" ] }, "payment_method": { "type": "string", "description": "Billing payment method for the load.", "enum": [ "ach", "company_check", "wire_transfer", "comchek" ] }, "payment_notes": { "type": "string", "description": "Additional notes about the payment." }, "customer_name": { "maxLength": 256, "type": "string", "description": "Name of the shipper company that created the load." }, "customer_contact": { "maxLength": 256, "type": "string", "description": "Full name of the primary contact for the load at the shipper company." }, "customer_address": { "maxLength": 1024, "type": "string", "description": "Street name and number from the registered address of the shipper company." }, "customer_city": { "maxLength": 256, "type": "string", "description": "City name from the registered address of the shipper company." }, "customer_state": { "type": "string", "description": "Abbreviation of the state from the registered address of the shipper company.", "enum": [ "AL", "AK", "AS", "AZ", "AR", "AA", "AE", "AP", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "GU", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "MP", "OH", "OK", "OR", "PA", "PR", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VI", "VA", "WA", "WV", "WI", "WY" ] }, "customer_zip": { "maxLength": 10, "type": "string", "description": "Zip code from the registered address of the shipper company." }, "customer_email": { "maxLength": 64, "type": "string", "description": "Contact email address of the shipper company.", "format": "email" }, "customer_phone_1": { "maxLength": 20, "type": "string", "description": "First contact number of the shipper company." }, "customer_phone_1_notes": { "maxLength": 256, "type": "string", "description": "Additional notes about the first contact number of the shipper company." }, "customer_phone_1_type": { "type": "string", "description": "Type of the first contact number of the shipper company.", "enum": [ "phone", "fax" ] }, "customer_phone_2": { "maxLength": 20, "type": "string", "description": "Second contact number of the shipper company." }, "customer_phone_2_notes": { "maxLength": 256, "type": "string", "description": "Additional notes about the second contact number of the shipper company." }, "customer_phone_2_type": { "type": "string", "description": "Type of the second contact number of the shipper company.", "enum": [ "phone", "fax" ] }, "customer_phone_3": { "maxLength": 20, "type": "string", "description": "Third contact number of the shipper company." }, "customer_phone_3_notes": { "maxLength": 256, "type": "string", "description": "Additional notes about the third contact number of the shipper company." }, "customer_phone_3_type": { "type": "string", "description": "Type of the third contact number of the shipper company.", "enum": [ "phone", "fax" ] }, "accepted": { "type": "boolean", "description": "Indicates whether the load is accepted by the carrier.", "readOnly": true }, "labels": { "type": "array", "description": "List of labels set to the load.", "items": { "maxLength": 64, "type": "string", "description": "Label set to the load. Each label is represented by a key-value pair." } }, "can_be_booked": { "type": "boolean", "description": "Indicates whether the Instant booking option is enabled for the load.", "default": false }, "uship_code": { "maxLength": 32, "type": "string", "description": "uShip code used for the load." }, "demo": { "type": "boolean", "description": "Indicates whether this is a demo load.", "readOnly": true, "default": false }, "shipper_load_id": { "maxLength": 256, "type": "string", "description": "Shipper's unique ID of the load." }, "instructions": { "maxLength": 16000, "type": "string", "description": "Shipper's dispatch instructions for the load. These are visible to carriers on the loadboard or before they accept the dispatched load." }, "specific_load_requirements": { "maxLength": 4096, "type": "string", "description": "Shipper's instructions and requirements for the load. These are visible to carriers only after they accept the dispatched load." }, "driver_instructions": { "maxLength": 4096, "type": "string", "description": "Carrier's instructions to the driver." }, "status": { "type": "string", "description": "Current status of the load.", "readOnly": true, "enum": [ "new", "accepted", "assigned", "picked-up", "delivered", "archived" ] }, "first_available_date": { "type": "string", "description": "First date on which the load is available for picking up.", "format": "date" }, "enclosed_trailer": { "type": "boolean", "description": "Indicates whether the shipper requires the load to be transported with an enclosed car carrier trailer.", "default": false }, "dispatch_date": { "type": "string", "description": "Date of the load dispatch to the carrier.", "format": "date", "readOnly": true }, "create_time": { "type": "string", "description": "Date and time of the original creation of the load.", "format": "date-time", "readOnly": true }, "update_time": { "type": "string", "description": "Date and time of the latest update of the load.", "format": "date-time", "readOnly": true }, "requested_bol_address_pickup": { "maxLength": 254, "type": "string", "description": "Email address specified by the pickup contact for receiving a copy of the load BOL.", "format": "email", "readOnly": true }, "requested_bol_address_delivery": { "maxLength": 254, "type": "string", "description": "Email address specified by the delivery contact for receiving a copy of the load BOL.", "format": "email", "readOnly": true }, "seen_by_driver_time": { "type": "string", "description": "Date and time when the driver first saw the assigned load.", "format": "date-time", "readOnly": true }, "flags": { "type": "array", "description": "List of flags for major events in the load processing flow.", "readOnly": true, "items": { "maxLength": 64, "type": "string" } }, "resolution": { "type": "string", "description": "Final resolution of the load that specifies the reason for archiving the load.", "readOnly": true, "enum": [ "declined", "expired", "cancelled", "broker_cancelled", "done" ] }, "expiration_time": { "type": "string", "description": "Date and time of the dispatch expiration. The carrier company needs to confirm accepting the dispatched load by this time.", "format": "date-time", "readOnly": true }, "invoice_time": { "type": "string", "description": "Date and time of the invoice generation for the load.", "format": "date-time", "readOnly": true }, "damages_type": { "type": "string", "description": "Type of damage standard used for vehicles in the load.", "default": "standard", "enum": [ "standard", "m-22" ] }, "carrier": { "type": "string", "description": "URL of the resource for the carrier company to which the load is dispatched.", "format": "uri", "readOnly": true }, "demo_owner": { "type": "string", "description": "URL of the resource for the user who created the demo load.", "format": "uri", "readOnly": true }, "active_change": { "type": "string", "description": "URL of the resource for the latest change from the active load revision.", "format": "uri", "readOnly": true }, "active_revision": { "type": "string", "description": "URL of the resource for the active load revision.", "format": "uri", "readOnly": true }, "driver": { "type": "string", "description": "URL of the user resource for the driver to whom the load is assigned.", "format": "uri", "readOnly": true }, "shipper_id": { "type": "string", "description": "ID of the shipper company that created the load.", "readOnly": true }, "carrier_id": { "type": "string", "description": "ID of the carrier company to which the load is dispatched.", "readOnly": true }, "demo_owner_id": { "type": "string", "description": "ID of the user who created the demo load.", "readOnly": true }, "active_change_id": { "type": "string", "description": "ID of the latest change from the active load revision.", "readOnly": true }, "active_revision_id": { "type": "string", "description": "ID of the active load revision.", "readOnly": true }, "driver_id": { "type": "string", "description": "ID of the driver to whom the load is assigned.", "readOnly": true } } }, "example": { "shipper_id": "j4y0", "damages_type": "standard", "force_driver_assignment": false, "flags": [], "update_time": "2018-05-03T14:12:42.551Z", "create_time": "2018-05-03T14:05:18.231Z", "dispatch_date": "2018-05-03T00:00:00.000Z", "enclosed_trailer": false, "status": "new", "shipper_load_id": "201805-01", "demo": false, "can_be_booked": false, "labels": [], "accepted": false, "customer_phone_3_type": "fax", "customer_phone_3": "(555) 674-2292", "customer_phone_2_type": "phone", "customer_phone_2": "(555) 261-5501", "customer_phone_1_type": "phone", "customer_phone_1": "(555) 917-5933", "customer_email": "contact@aztransport.com", "customer_zip": "48226", "customer_state": "MI", "customer_city": "Detroit", "customer_address": "2526 Summit Park Avenue", "customer_name": "A-Z Transport Brokers", "payment_method": "wire_transfer", "payment_term_begins": "delivery", "payment_term_business_days": 15, "total_payment_to_carrier": "1700.00", "distance": 1996832, "delivery_contract_date_end_type": "not_later", "delivery_contract_date_end": "2018-05-28T00:00:00.000Z", "delivery_contract_date_start_type": "estimated", "delivery_contract_date_start": "2018-05-15T00:00:00.000Z", "delivery_requested_date_end_type": "not_later", "delivery_requested_date_end": "2018-05-28T00:00:00.000Z", "delivery_requested_date_start_type": "estimated", "delivery_requested_date_start": "2018-05-15T00:00:00.000Z", "delivery_customer_not_present": false, "delivery_phone_2_type": "phone", "delivery_phone_2": "(555) 284-9831", "delivery_phone_1_type": "phone", "delivery_phone_1": "(555) 595-5022", "delivery_zip": "73501", "delivery_state": "OK", "delivery_city": "Lawton", "delivery_address_location": { "coordinates": [ -98.2427163, 34.5618808 ], "type": "Point" }, "delivery_address": "1344 SE 1st St", "delivery_contact": "Marlene Collins", "delivery_requested_times": "10:00-17:00", "pickup_contract_date_end_type": "not_later", "pickup_contract_date_end": "2018-05-16T00:00:00.000Z", "pickup_contract_date_start_type": "not_earlier", "pickup_contract_date_start": "2018-05-11T00:00:00.000Z", "pickup_requested_date_end_type": "not_later", "pickup_requested_date_end": "2018-05-16T00:00:00.000Z", "pickup_requested_date_start_type": "not_earlier", "pickup_requested_date_start": "2018-05-11T00:00:00.000Z", "pickup_customer_not_present": false, "pickup_phone_2_type": "phone", "pickup_phone_2_notes": "Office hours only", "pickup_phone_2": "(555) 393-2760", "pickup_phone_1_type": "phone", "pickup_phone_1_notes": "Cell", "pickup_phone_1": "(555) 202-0772", "pickup_zip": "16214", "pickup_state": "PA", "pickup_city": "Clarion", "pickup_address_location": { "coordinates": [ -79.38552, 41.214863 ], "type": "Point" }, "pickup_address": "187 S 5th Ave", "pickup_contact": "Warren Smith", "pickup_requested_times": "10:00-16:00", "shipper_dot_number": "9898989", "posting": { "order_id": "dev4v", "order": "https://ship.cars/api/loads/dev4v/", "status": "active", "update_time": "2018-05-03T14:13:24.551Z", "create_time": "2018-05-03T14:13:24.549Z", "id": "05zv" }, "payment_to_carrier": "1700.00", "shipper": "https://ship.cars/api/companies/j4y0/", "distance_imperial": 1240, "attachments": [], "activity_log": [], "vehicles": [ { "load_id": "dev4v", "load": "https://ship.cars/api/loads/dev4v/", "update_time": "2018-05-03T14:05:18.551Z", "create_time": "2018-05-03T14:05:18.551Z", "status": "new", "specifications_year": 2015, "specifications_data": { "weight": { "min": 3186, "max": 3602 }, "length": { "min": 189.2, "max": 192.2 }, "height": { "min": 56.5, "max": 57.7 }, "width": { "min": 72.8, "max": 72.8 } }, "shipper_vehicle_id": "201805-01-A", "operable": true, "vin": "1HRGC3F87FA700239", "color": "Blue", "model": "Accord", "make": "Honda", "year": 2015, "deleting": false, "created": true, "m22_damages": [], "logo": "https://storage.googleapis.com/ship-cars-make-logos/honda-logo.png", "human_type": "Sedan", "type": "sedan", "attachments": [ { "vehicle_id": "4w5e9", "load_id": "dev4v", "vehicle": "https://ship.cars/api/vehicles/4w5e9/", "create_time": "2018-05-03T14:05:26.026Z", "share_with_driver": true, "active": true, "width": 1716, "height": 657, "type": "pickup_sketch", "converted_timestamp": "Thursday, May 3, 2018 at 09:05 AM", "load": "https://ship.cars/api/loads/dev4v/", "damages": [], "image": { "full_size": "https://media.ship.cars/media/2018-05-03T090519.534331.jpg", "thumbnail": "https://media.ship.cars/media/__sized__/2018-05-03T090519.534331-thumbnail-384x216-70.jpg" }, "file": "https://media.ship.cars/media/2018-05-03T090519.534331.jpg", "id": "gvgmx", "url": "https://ship.cars/api/attachments/gvgmx/" } ], "vehicle_sketch": "https://media.ship.cars/media/sedan.png", "id": "4w5e9", "url": "https://ship.cars/api/vehicles/4w5e9/" }, { "load_id": "dev4v", "load": "https://ship.cars/api/loads/dev4v/", "update_time": "2018-05-03T14:05:18.788Z", "create_time": "2018-05-03T14:05:18.787Z", "status": "new", "specifications_year": 2016, "specifications_data": { "weight": { "min": 3240, "max": 3480 }, "length": { "min": 190.9, "max": 190.9 }, "height": { "min": 57.9, "max": 57.9 }, "width": { "min": 71.7, "max": 71.7 } }, "shipper_vehicle_id": "201805-01-B", "operable": true, "vin": "4T1BHK116JU565152", "color": "Black Metallic", "model": "Camry", "make": "Toyota", "year": 2016, "deleting": false, "created": true, "m22_damages": [], "logo": "https://storage.googleapis.com/ship-cars-make-logos/toyota-logo.png", "human_type": "Sedan", "type": "sedan", "attachments": [ { "vehicle_id": "96gnd", "load_id": "dev4v", "vehicle": "https://ship.cars/api/vehicles/96gnd/", "create_time": "2018-05-03T14:05:27.029Z", "share_with_driver": true, "active": true, "width": 1716, "height": 657, "type": "pickup_sketch", "converted_timestamp": "Thursday, May 3, 2018 at 09:05 AM", "load": "https://ship.cars/api/loads/dev4v/", "damages": [], "image": { "full_size": "https://media.ship.cars/media/2018-05-03T090526.700992.jpg", "thumbnail": "https://media.ship.cars/media/__sized__/2018-05-03T090526.700992-thumbnail-384x216-70.jpg" }, "file": "https://media.ship.cars/media/2018-05-03T090526.700992.jpg", "id": "wywng", "url": "https://ship.cars/api/attachments/wywng/" } ], "vehicle_sketch": "https://media.ship.cars/media/sedan.png", "id": "96gnd", "url": "https://ship.cars/api/vehicles/96gnd/" } ], "id": "dev4v", "url": "https://ship.cars/api/loads/dev4v/" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Message giving details about the reason for the error response." } } }, "example": { "detail": "Authentication credentials were not provided." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string", "description": "Message giving details about the reason for the error response." } } }, "example": { "detail": "Not found." } } } } }, "x-code-samples": [ { "lang": "cURL", "source": "curl --request GET \\\n--url 'https://ship.cars/api/loads/dev4v/' \\\n--header 'Authorization: Bearer <>'\n" } ], "security": [ { "bearerAuth": [] } ] } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```