Drayage API Documentation

1. Get Available Ports

Endpoint

GET /api/v1/drayage/port

Description

Returns a list of available ports for drayage. If a requested port is not found, contact the operations team.

Parameters

Name	Type	Required	Description
zip_code	string	Yes	Zip code (5 characters). Example: 33122.
city	string	Yes	City name. Example: Miami.
miles	int	No	Radius in miles. Default: 0.

Responses

200 - Success

Path	Field Name	Type	Description
ports	ports	List[object]	List of available ports
ports[].id	id	int	Unique identifier of the port
ports[].name	name	string	Name of the port
ports[].address	address	string	Street address of the port
ports[].city	city	string	City where the port is located
ports[].state	state	string	State where the port is located
ports[].postal_code	postal_code	string	Postal code of the port
ports[].country_code	country_code	string	Country code (e.g., 'US')
ports[].terminal_code	terminal_code	string	Terminal code of the port
ports[].type	type	string	Type of port (e.g., 'IMPORT', 'EXPORT')
ports[].contact_first_name	contact_first_name	string	First name of the contact person
ports[].contact_last_name	contact_last_name	string	Last name of the contact person
ports[].contact_email	contact_email	string	Email of the contact person
ports[].contact_phone	contact_phone	string	Phone number of the contact person
ports[].location_salesforce_id	location_salesforce_id	string	Salesforce location identifier
ports[].contact_salesforce_id	contact_salesforce_id	string	Salesforce contact identifier

{
    "ports": [{
        "id": 1,
        "name": "Test Port",
        "address": "Street Address",
        "city": "Miami",
        "state": "FL",
        "postal_code": "33122",
        "country_code": "US",
        "terminal_code": "UGHD1234",
        "type": "IMPORT",
        "contact_first_name": "Test Name",
        "contact_last_name": "Test Last Name",
        "contact_email": "test@email.com",
        "contact_phone": "1234567890",
        "location_salesforce_id": "test1123",
        "contact_salesforce_id": "test1123"
    }]
}

404 - Ports Not Found

{
    "message": "Ports not found"
}

---

2. Update Port by Load ID

Endpoint

PUT /api/v1/drayage/port/load/{load_id}

Description

Updates the port for a specific drayage load. If the requested port is not found, contact the operations team.

Parameters

Name	Type	Required	Description
port_id	string	Yes	Port ID. Example: 59.
load_id	string	Yes	Load ID (15-18 characters). Example: 001d3000000001ABAAU.

Responses

200 - Success

Path	Field Name	Type	Description
content	content	string	Informational message about the port update and quote removal.
delete	delete	bool	Indicates if the quote was deleted (true/false).
port	port	object	Object with the updated port information.
port.id	id	string	Unique identifier of the port.
port.name	name	string	Name of the port.
port.address	address	string	Address of the port.
port.city	city	string	City where the port is located.
port.state	state	string	State where the port is located.
port.postal_code	postal_code	string	Postal code of the port.
port.country_code	country_code	string	Country code (e.g., 'US').
port.terminal_code	terminal_code	string	Terminal code of the port.
port.type	type	string	Type of port.
port.contact_first_name	contact_first_name	string	First name of the port contact.
port.contact_last_name	contact_last_name	string	Last name of the port contact.
port.contact_email	contact_email	string	Email of the port contact.
port.contact_phone	contact_phone	string	Phone number of the port contact.
port.location_salesforce_id	location_salesforce_id	string	Salesforce location ID.
port.contact_salesforce_id	contact_salesforce_id	string	Salesforce contact ID.

{
    "content": "Due to the port update, the quotation associated with the load has been removed. Please re-quote.",
    "delete": true,
    "port": {
        "id": "59",
        "name": "Port",
        "address": "2500 Test",
        "city": "San Pedro",
        "state": "CA",
        "postal_code": "90731",
        "country_code": "US",
        "terminal_code": "USLAXPTAPMT",
        "type": "Port",
        "contact_first_name": "Test",
        "contact_last_name": "San Pedro",
        "contact_email": "test@gmail.com",
        "contact_phone": "12345678901",
        "location_salesforce_id": "001Ru00000SDiknIhg",
        "contact_salesforce_id": "003Ru00000OPjP7IYU"
    }
}

---

3. Get Rates

Endpoint

POST /api/v1/drayage/quote/rates

Description

Retrieves drayage rates based on the provided details.

Parameters

Name	Type	Required	Description
type	string	Yes	Type of drayage. Possible values: Import (Freight arriving at the port from abroad), Export (Freight leaving the port to another destination).
size	string	Yes	Size of the drayage. Possible values: 20, 40, 45.
hazmat_type	string	No	Type of hazardous material. Possible values: 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.1, 2.2, 2.3, 3, 4.1, 4.2, 4.3, 5.1, 5.2, 6.1, 6.2, 7, 8, 9.

Body

Path	Field Name	Type	Description
cargo_value_for_insurance	cargo_value_for_insurance	Double	The cargo_value_for_insurance field is related to the insurance calculation in the quote; optional, defaults to 0.
miles	miles	Integer	The miles field refers to the distance between the origin/destination and the port.
accessorials	accessorials	List[string]	Enter the IDs of the accessories in Revenova for drayage, in string format. These IDs are obtained from the drayage/accessorials endpoint.
port_id	port_id	string	The port field refers to the drayage port where the load will be delivered. This is the ID from the /ports endpoint.
delivery_stop	delivery_stop	object	Load delivery information.
delivery_stop.city	city	string	The city of origin, e.g., 'Miami'.
delivery_stop.state	state	string	The state of the city of origin, e.g., 'FL'.
delivery_stop.country	country	string	The country of origin, e.g., 'US'.
delivery_stop.zip	zip	string	Zip code (postal code), e.g., '33206'.
line_item	line_item	object	Line item information.
line_item.description	description	string	Brief description of the item's content.
line_item.weight	weight	Double	Weight of the item; must be greater than zero.
line_item.weight_units	weight_units	string	Unit of measurement of the weight, e.g., 'lb'.

Responses

200 - Success

Path	Field Name	Type	Description
load_id	load_id	string	Unique identifier of the load
shp	shp	string	Unique identifier of the load
line_item	line_item	object	Info of item in the load
line_item.id	id	string	Unique identifier of the line item
line_item.description	description	string	Brief description of the item's content
line_item.weight	weight	number	Weight, must be greater than zero
line_item.weight_units	weight_units	string	Unit of measurement (e.g., "lb")
stops	stops	object	Stops information
stops.from	from	object	Origin of the load
stops.from.id	id	string	Unique identifier of the stop
stops.from.city	city	string	City of origin
stops.from.state_province	state_province	string	State of origin
stops.from.country	country	string	Country of origin
stops.from.postal_code	postal_code	string	Postal code of origin
stops.from.name	name	string	Name of the stop
stops.from.location_id	location_id	string/null	Location ID (nullable)
stops.from.contact_info_id	contact_info_id	string/null	Contact info ID (nullable)
stops.from.is_dropoff	is_dropoff	boolean	Is dropoff location
stops.from.is_pickup	is_pickup	boolean	Is pickup location
stops.from.number	number	integer	Stop number
stops.to	to	object	Destination of the load
stops.to.id	id	string	Unique identifier of the stop
stops.to.city	city	string	City of destination
stops.to.state_province	state_province	string	State of destination
stops.to.country	country	string	Country of destination
stops.to.postal_code	postal_code	string	Postal code of destination
stops.to.name	name	string	Name of the stop
stops.to.location_id	location_id	string	Location ID
stops.to.contact_info_id	contact_info_id	string	Contact info ID
stops.to.is_dropoff	is_dropoff	boolean	Is dropoff location
stops.to.is_pickup	is_pickup	boolean	Is pickup location
stops.to.number	number	integer	Stop number
stops.to.first_name	first_name	string	First name of the contact
stops.to.last_name	last_name	string	Last name of the contact
stops.to.email	email	string	Email of the contact
stops.to.phone	phone	string	Phone number of the contact
accessorials	accessorials	List[object]	List of accessories in the load
accessorials[].accessorial_id	accessorial_id	string	Identifier for the accessory
accessorials[].accessorial_name	accessorial_name	string	Name of the accessory
carrier	carrier	object	Carrier details and rate information
carrier._id	_id	string	Unique identifier of the drayage rate in DB
carrier.source	source	string	Source of the drayage rate
carrier.carrier	carrier	string	Name of the carrier
carrier.expirationDate	expirationDate	string (date)	Expiration date for the drayage rate
carrier.drayageAccessorials	drayageAccessorials	List[object]	List of cost of accessories
carrier.drayageAccessorials[].value	value	number	Value of the accessory
carrier.drayageAccessorials[].description	description	string	Description of the accessory
carrier.drayageAccessorials[].unit	unit	string	Unit of the accessory
carrier.fuelSurcharge	fuelSurcharge	number	Price of fuel surcharge
carrier.price	price	number	Price of carrier
carrier.serviceClass	serviceClass	string	Service class
carrier.pickupPerformance	pickupPerformance	number	Performance metric for on-time pickups
carrier.deliveryPerformance	deliveryPerformance	number	Performance metric for on-time deliveries
carrier.chsDailyRental	chsDailyRental	number	Daily rental cost for chassis
carrier.chsMinRentalDays	chsMinRentalDays	number	Minimum number of days for chassis rental
carrier.chsPickup	chsPickup	number	Cost associated with chassis pickup
carrier.chsReturn	chsReturn	number	Cost associated with chassis return
carrier.chsPickupFsc	chsPickupFsc	number	Fuel surcharge cost for chassis pickup
carrier.chsReturnFsc	chsReturnFsc	number	Fuel surcharge cost for chassis return
carrier.chsSubtotal	chsSubtotal	number	Subtotal cost of chassis-related fees
carrier.totalChsRental	totalChsRental	number	Total rental cost for chassis
carrier.terminalSurcharge	terminalSurcharge	number	Additional surcharge applied at the terminal
carrier.fsc	fsc	string/number	Fuel surcharge percent applied
carrier.lineHaul	lineHaul	number	Base transportation cost for moving freight
carrier.toll	toll	number	Toll fees incurred during transportation
carrier.layover	layover	number	Cost incurred when a driver must wait
carrier.overweight	overweight	number	Additional charge for overweight shipments
carrier.hazardous	hazardous	number	Extra fee for transporting hazardous materials
carrier.reefer	reefer	number	Surcharge for temperature-controlled loads
carrier.prepull	prepull	number	fee for pulling the container from the terminal prior day of the delivery
carrier.type	type	string	Category or type of drayage rate
carrier.portalNotes	portalNotes	string	Additional notes or comments from the portal
carrier.size	size	string/number	Container size (e.g., 20, 40, 45)
carrier.terminal	terminal	string	Unique identifier of the terminal
alerts	alerts	List[string]	List of alerts related to the rate

{
    "load_id": "a0jRu000009vLk5IAt",
    "shp": "SHP4933713",
    "line_item": {
        "description": "test",
        "weight": 100,
        "weight_units": "lb",
        "id": "a0gRu000002csr3IAA"
    },
    "stops": {
        "from": {
        "name": "Pickup",
        "location_id": None,
        "contact_info_id": None,
        "is_dropoff": False,
        "is_pickup": True,
        "number": 0,
        "state_province": "FL",
        "postal_code": "33206",
        "country": "US",
        "city": "miami",
        "id": "a0tRu00000EW4N1IAL"
        },
        "to": {
        "name": "Delivery",
        "location_id": "001Ru00000QsmjrIAF",
        "contact_info_id": "003Ru00000NFeRPIA4",
        "is_dropoff": True,
        "is_pickup": False,
        "number": 1,
        "state_province": "FL",
        "postal_code": "33132",
        "country": "US",
        "city": "Miami",
        "id": "a0tRu00000EW4N2fAL",
        "first_name": "Jhon",
        "last_name": "Doe",
        "email": "Jhon.Doe@test.com.co",
        "phone": "1234567890"
        }
    },
    "accessorials": [
        {
        "accessorial_id": "a011I000008yNDMQA2",
        "accessorial_name": "Chassis"
        },
        {
        "accessorial_id": "a011I00000Ue3p4QAB",
        "accessorial_name": "Reefer"
        }
    ],
    "carrier": {
        "_id": "67b379b92ab1d5ffc82618b4",
        "source": "Drayage",
        "carrier": "drayage carrier",
        "expirationDate": "2025-03-19",
        "drayageAccessorials": [
        {
            "value": 150,
            "description": "Detention",
            "unit": "Per Hour"
        },
        {
            "value": 200,
            "description": "Hazardous",
            "unit": "Flat Rate"
        },
        {
            "value": 150,
            "description": "Overweight",
            "unit": "Flat Rate"
        },
        {
            "value": 150,
            "description": "Reefer",
            "unit": "Flat Rate"
        }
        ],
        "fuelSurcharge": 109.32,
        "price": 811.67,
        "serviceClass": "drayage",
        "pickupPerformance": 97,
        "deliveryPerformance": 97,
        "chsDailyRental": 40,
        "chsMinRentalDays": 1,
        "chsPickup": 0,
        "chsReturn": 0,
        "chsPickupFsc": 0,
        "chsReturnFsc": 0,
        "chsSubtotal": 40,
        "totalChsRental": 40,
        "terminalSurcharge": 0,
        "fsc": "35.00%",
        "lineHaul": 312.35,
        "toll": 0,
        "layover": 0,
        "overweight": 0,
        "hazardous": 200,
        "reefer": 150,
        "prepull": 0,
        "type": "import",
        "portalNotes": "test notes",
        "size": "20",
        "terminal": "USMIAPTSFCT"
        },
    "alerts": []
    } 

404 - Rate Not Found

{
    "message": "Rate not found"
}

---

4. Get Rate by Load ID

Endpoint

GET /api/v1/drayage/quote/rates

Description

Retrieves a drayage rate using the provided load ID.

Parameters

Name	Type	Required	Description
load_id	string	Yes	Load ID.

Responses

200 - Success

Path	Field Name	Type	Description
load_id	load_id	string	Unique identifier of the load
shp	shp	string	Unique identifier of the load
line_item	line_item	object	Info of item in the load
line_item.id	id	string	Unique identifier of the line item
line_item.description	description	string	Brief description of the item's content
line_item.weight	weight	number	Weight, must be greater than zero
line_item.weight_units	weight_units	string	Unit of measurement (e.g., "lb")
stops	stops	object	Stops information
stops.from	from	object	Origin of the load
stops.from.id	id	string	Unique identifier of the stop
stops.from.city	city	string	City of origin
stops.from.state_province	state_province	string	State of origin
stops.from.country	country	string	Country of origin
stops.from.postal_code	postal_code	string	Postal code of origin
stops.from.name	name	string	Name of the stop
stops.from.location_id	location_id	string/null	Location ID (nullable)
stops.from.contact_info_id	contact_info_id	string/null	Contact info ID (nullable)
stops.from.is_dropoff	is_dropoff	boolean	Is dropoff location
stops.from.is_pickup	is_pickup	boolean	Is pickup location
stops.from.number	number	integer	Stop number
stops.to	to	object	Destination of the load
stops.to.id	id	string	Unique identifier of the stop
stops.to.city	city	string	City of destination
stops.to.state_province	state_province	string	State of destination
stops.to.country	country	string	Country of destination
stops.to.postal_code	postal_code	string	Postal code of destination
stops.to.name	name	string	Name of the stop
stops.to.location_id	location_id	string	Location ID
stops.to.contact_info_id	contact_info_id	string	Contact info ID
stops.to.is_dropoff	is_dropoff	boolean	Is dropoff location
stops.to.is_pickup	is_pickup	boolean	Is pickup location
stops.to.number	number	integer	Stop number
stops.to.first_name	first_name	string	First name of the contact
stops.to.last_name	last_name	string	Last name of the contact
stops.to.email	email	string	Email of the contact
stops.to.phone	phone	string	Phone number of the contact
accessorials	accessorials	List[object]	List of accessories in the load
accessorials[].accessorial_id	accessorial_id	string	Identifier for the accessory
accessorials[].accessorial_name	accessorial_name	string	Name of the accessory
carrier	carrier	object	Carrier details and rate information
carrier._id	_id	string	Unique identifier of the drayage rate in DB
carrier.source	source	string	Source of the drayage rate
carrier.carrier	carrier	string	Name of the carrier
carrier.expirationDate	expirationDate	string (date)	Expiration date for the drayage rate
carrier.drayageAccessorials	drayageAccessorials	List[object]	List of cost of accessories
carrier.drayageAccessorials[].value	value	number	Value of the accessory
carrier.drayageAccessorials[].description	description	string	Description of the accessory
carrier.drayageAccessorials[].unit	unit	string	Unit of the accessory
carrier.fuelSurcharge	fuelSurcharge	number	Price of fuel surcharge
carrier.price	price	number	Price of carrier
carrier.serviceClass	serviceClass	string	Service class
carrier.pickupPerformance	pickupPerformance	number	Performance metric for on-time pickups
carrier.deliveryPerformance	deliveryPerformance	number	Performance metric for on-time deliveries
carrier.chsDailyRental	chsDailyRental	number	Daily rental cost for chassis
carrier.chsMinRentalDays	chsMinRentalDays	number	Minimum number of days for chassis rental
carrier.chsPickup	chsPickup	number	Cost associated with chassis pickup
carrier.chsReturn	chsReturn	number	Cost associated with chassis return
carrier.chsPickupFsc	chsPickupFsc	number	Fuel surcharge cost for chassis pickup
carrier.chsReturnFsc	chsReturnFsc	number	Fuel surcharge cost for chassis return
carrier.chsSubtotal	chsSubtotal	number	Subtotal cost of chassis-related fees
carrier.totalChsRental	totalChsRental	number	Total rental cost for chassis
carrier.terminalSurcharge	terminalSurcharge	number	Additional surcharge applied at the terminal
carrier.fsc	fsc	string/number	Fuel surcharge percent applied
carrier.lineHaul	lineHaul	number	Base transportation cost for moving freight
carrier.toll	toll	number	Toll fees incurred during transportation
carrier.layover	layover	number	Cost incurred when a driver must wait
carrier.overweight	overweight	number	Additional charge for overweight shipments
carrier.hazardous	hazardous	number	Extra fee for transporting hazardous materials
carrier.reefer	reefer	number	Surcharge for temperature-controlled loads
carrier.prepull	prepull	number	fee for pulling the container from the terminal prior day of the delivery
carrier.type	type	string	Category or type of drayage rate
carrier.portalNotes	portalNotes	string	Additional notes or comments from the portal
carrier.size	size	string/number	Container size (e.g., 20, 40, 45)
carrier.terminal	terminal	string	Unique identifier of the terminal
alerts	alerts	List[string]	List of alerts related to the rate

{
    "load_id": "a0jRu000009vLk5IAt",
    "shp": "SHP4933713",
    "line_item": {
        "description": "test",
        "weight": 100,
        "weight_units": "lb",
        "id": "a0gRu000002csr3IAA"
    },
    "stops": {
        "from": {
        "name": "Pickup",
        "location_id": None,
        "contact_info_id": None,
        "is_dropoff": False,
        "is_pickup": True,
        "number": 0,
        "state_province": "FL",
        "postal_code": "33206",
        "country": "US",
        "city": "miami",
        "id": "a0tRu00000EW4N1IAL"
        },
        "to": {
        "name": "Delivery",
        "location_id": "001Ru00000QsmjrIAF",
        "contact_info_id": "003Ru00000NFeRPIA4",
        "is_dropoff": True,
        "is_pickup": False,
        "number": 1,
        "state_province": "FL",
        "postal_code": "33132",
        "country": "US",
        "city": "Miami",
        "id": "a0tRu00000EW4N2fAL",
        "first_name": "Jhon",
        "last_name": "Doe",
        "email": "Jhon.Doe@test.com.co",
        "phone": "1234567890"
        }
    },
    "accessorials": [
        {
        "accessorial_id": "a011I000008yNDMQA2",
        "accessorial_name": "Chassis"
        },
        {
        "accessorial_id": "a011I00000Ue3p4QAB",
        "accessorial_name": "Reefer"
        }
    ],
    "carrier": {
        "_id": "67b379b92ab1d5ffc82618b4",
        "source": "Drayage",
        "carrier": "drayage carrier",
        "expirationDate": "2025-03-19",
        "drayageAccessorials": [
        {
            "value": 150,
            "description": "Detention",
            "unit": "Per Hour"
        },
        {
            "value": 200,
            "description": "Hazardous",
            "unit": "Flat Rate"
        },
        {
            "value": 150,
            "description": "Overweight",
            "unit": "Flat Rate"
        },
        {
            "value": 150,
            "description": "Reefer",
            "unit": "Flat Rate"
        }
        ],
        "fuelSurcharge": 109.32,
        "price": 811.67,
        "serviceClass": "drayage",
        "pickupPerformance": 97,
        "deliveryPerformance": 97,
        "chsDailyRental": 40,
        "chsMinRentalDays": 1,
        "chsPickup": 0,
        "chsReturn": 0,
        "chsPickupFsc": 0,
        "chsReturnFsc": 0,
        "chsSubtotal": 40,
        "totalChsRental": 40,
        "terminalSurcharge": 0,
        "fsc": "35.00%",
        "lineHaul": 312.35,
        "toll": 0,
        "layover": 0,
        "overweight": 0,
        "hazardous": 200,
        "reefer": 150,
        "prepull": 0,
        "type": "import",
        "portalNotes": "test notes",
        "size": "20",
        "terminal": "USMIAPTSFCT"
        },
    "alerts": []
    } 

404 - Rate Not Found

{
    "message": "Rate not found"
}

---

5. Requote by Load ID

Endpoint

GET /api/v1/drayage/quote/requote

Description

Retrieves a new drayage rate for a given load ID.

Parameters

Name	Type	Required	Description
load_id	string	Yes	Load ID.
type	DrayageType	Yes	Type of drayage.
size	DrayageSize	Yes	Size of drayage.
hazmat_type	HazardClass	No	Type of hazardous material.

Responses

200 - Success

Path	Field Name	Type	Description
load_id	load_id	string	Unique identifier of the load
shp	shp	string	Unique identifier of the load
line_item	line_item	object	Info of item in the load
line_item.id	id	string	Unique identifier of the line item
line_item.description	description	string	Brief description of the item's content
line_item.weight	weight	number	Weight, must be greater than zero
line_item.weight_units	weight_units	string	Unit of measurement (e.g., "lb")
stops	stops	object	Stops information
stops.from	from	object	Origin of the load
stops.from.id	id	string	Unique identifier of the stop
stops.from.city	city	string	City of origin
stops.from.state_province	state_province	string	State of origin
stops.from.country	country	string	Country of origin
stops.from.postal_code	postal_code	string	Postal code of origin
stops.from.name	name	string	Name of the stop
stops.from.location_id	location_id	string/null	Location ID (nullable)
stops.from.contact_info_id	contact_info_id	string/null	Contact info ID (nullable)
stops.from.is_dropoff	is_dropoff	boolean	Is dropoff location
stops.from.is_pickup	is_pickup	boolean	Is pickup location
stops.from.number	number	integer	Stop number
stops.to	to	object	Destination of the load
stops.to.id	id	string	Unique identifier of the stop
stops.to.city	city	string	City of destination
stops.to.state_province	state_province	string	State of destination
stops.to.country	country	string	Country of destination
stops.to.postal_code	postal_code	string	Postal code of destination
stops.to.name	name	string	Name of the stop
stops.to.location_id	location_id	string	Location ID
stops.to.contact_info_id	contact_info_id	string	Contact info ID
stops.to.is_dropoff	is_dropoff	boolean	Is dropoff location
stops.to.is_pickup	is_pickup	boolean	Is pickup location
stops.to.number	number	integer	Stop number
stops.to.first_name	first_name	string	First name of the contact
stops.to.last_name	last_name	string	Last name of the contact
stops.to.email	email	string	Email of the contact
stops.to.phone	phone	string	Phone number of the contact
accessorials	accessorials	List[object]	List of accessories in the load
accessorials[].accessorial_id	accessorial_id	string	Identifier for the accessory
accessorials[].accessorial_name	accessorial_name	string	Name of the accessory
carrier	carrier	object	Carrier details and rate information
carrier._id	_id	string	Unique identifier of the drayage rate in DB
carrier.source	source	string	Source of the drayage rate
carrier.carrier	carrier	string	Name of the carrier
carrier.expirationDate	expirationDate	string (date)	Expiration date for the drayage rate
carrier.drayageAccessorials	drayageAccessorials	List[object]	List of cost of accessories
carrier.drayageAccessorials[].value	value	number	Value of the accessory
carrier.drayageAccessorials[].description	description	string	Description of the accessory
carrier.drayageAccessorials[].unit	unit	string	Unit of the accessory
carrier.fuelSurcharge	fuelSurcharge	number	Price of fuel surcharge
carrier.price	price	number	Price of carrier
carrier.serviceClass	serviceClass	string	Service class
carrier.pickupPerformance	pickupPerformance	number	Performance metric for on-time pickups
carrier.deliveryPerformance	deliveryPerformance	number	Performance metric for on-time deliveries
carrier.chsDailyRental	chsDailyRental	number	Daily rental cost for chassis
carrier.chsMinRentalDays	chsMinRentalDays	number	Minimum number of days for chassis rental
carrier.chsPickup	chsPickup	number	Cost associated with chassis pickup
carrier.chsReturn	chsReturn	number	Cost associated with chassis return
carrier.chsPickupFsc	chsPickupFsc	number	Fuel surcharge cost for chassis pickup
carrier.chsReturnFsc	chsReturnFsc	number	Fuel surcharge cost for chassis return
carrier.chsSubtotal	chsSubtotal	number	Subtotal cost of chassis-related fees
carrier.totalChsRental	totalChsRental	number	Total rental cost for chassis
carrier.terminalSurcharge	terminalSurcharge	number	Additional surcharge applied at the terminal
carrier.fsc	fsc	string/number	Fuel surcharge percent applied
carrier.lineHaul	lineHaul	number	Base transportation cost for moving freight
carrier.toll	toll	number	Toll fees incurred during transportation
carrier.layover	layover	number	Cost incurred when a driver must wait
carrier.overweight	overweight	number	Additional charge for overweight shipments
carrier.hazardous	hazardous	number	Extra fee for transporting hazardous materials
carrier.reefer	reefer	number	Surcharge for temperature-controlled loads
carrier.prepull	prepull	number	fee for pulling the container from the terminal prior day of the delivery
carrier.type	type	string	Category or type of drayage rate
carrier.portalNotes	portalNotes	string	Additional notes or comments from the portal
carrier.size	size	string/number	Container size (e.g., 20, 40, 45)
carrier.terminal	terminal	string	Unique identifier of the terminal
alerts	alerts	List[string]	List of alerts related to the rate

{
    "load_id": "a0jRu000009vLk5IAt",
    "shp": "SHP4933713",
    "line_item": {
        "description": "test",
        "weight": 100,
        "weight_units": "lb",
        "id": "a0gRu000002csr3IAA"
    },
    "stops": {
        "from": {
        "name": "Pickup",
        "location_id": None,
        "contact_info_id": None,
        "is_dropoff": False,
        "is_pickup": True,
        "number": 0,
        "state_province": "FL",
        "postal_code": "33206",
        "country": "US",
        "city": "miami",
        "id": "a0tRu00000EW4N1IAL"
        },
        "to": {
        "name": "Delivery",
        "location_id": "001Ru00000QsmjrIAF",
        "contact_info_id": "003Ru00000NFeRPIA4",
        "is_dropoff": True,
        "is_pickup": False,
        "number": 1,
        "state_province": "FL",
        "postal_code": "33132",
        "country": "US",
        "city": "Miami",
        "id": "a0tRu00000EW4N2fAL",
        "first_name": "Jhon",
        "last_name": "Doe",
        "email": "Jhon.Doe@test.com.co",
        "phone": "1234567890"
        }
    },
    "accessorials": [
        {
        "accessorial_id": "a011I000008yNDMQA2",
        "accessorial_name": "Chassis"
        },
        {
        "accessorial_id": "a011I00000Ue3p4QAB",
        "accessorial_name": "Reefer"
        }
    ],
    "carrier": {
        "_id": "67b379b92ab1d5ffc82618b4",
        "source": "Drayage",
        "carrier": "drayage carrier",
        "expirationDate": "2025-03-19",
        "drayageAccessorials": [
        {
            "value": 150,
            "description": "Detention",
            "unit": "Per Hour"
        },
        {
            "value": 200,
            "description": "Hazardous",
            "unit": "Flat Rate"
        },
        {
            "value": 150,
            "description": "Overweight",
            "unit": "Flat Rate"
        },
        {
            "value": 150,
            "description": "Reefer",
            "unit": "Flat Rate"
        }
        ],
        "fuelSurcharge": 109.32,
        "price": 811.67,
        "serviceClass": "drayage",
        "pickupPerformance": 97,
        "deliveryPerformance": 97,
        "chsDailyRental": 40,
        "chsMinRentalDays": 1,
        "chsPickup": 0,
        "chsReturn": 0,
        "chsPickupFsc": 0,
        "chsReturnFsc": 0,
        "chsSubtotal": 40,
        "totalChsRental": 40,
        "terminalSurcharge": 0,
        "fsc": "35.00%",
        "lineHaul": 312.35,
        "toll": 0,
        "layover": 0,
        "overweight": 0,
        "hazardous": 200,
        "reefer": 150,
        "prepull": 0,
        "type": "import",
        "portalNotes": "test notes",
        "size": "20",
        "terminal": "USMIAPTSFCT"
        },
    "alerts": []
    } 

404 - Rate Not Found

{
    "message": "Rate not found"
}

6. Get Available Accessories

Endpoint

GET /api/v1/drayage/accessorials

Description

This endpoint returns the available accessories for drayage. If the requested accessory is not found, please contact the operations team.

Responses

200 - Success

[
    {"accessorial_id": "1", "name": "accessory 1"},
    {"accessorial_id": "2", "name": "accessory 2"}
]

404 - Accessories Not Found

{
    "message": "accessories not found"
}

---

7. Add Accessory to Load

Endpoint

POST /api/v1/drayage/accessorials/load/{load_id}

Description

This endpoint adds accessories to a drayage load.

Parameters

Name	Type	Required	Description
load_id	string (15-18 characters)	Yes	Load ID.

Body

Name	Type	Description
accessorial_ids	list[string]	Enter the IDs of the accessories in Revenova for drayage, in string format. These IDs are obtained from the drayage/accessorials endpoint.

Responses

200 - Success

Path	Field Name	Type	Description
accessorials	accessorials	List[object]	List of accessories added to the load
accessorials[].name	name	string	Name of the accessory
accessorials[].load_id	load_id	string	Load ID
accessorials[].accessorial_id	accessorial_id	string	Identifier for the accessory
accessorials[].provider	provider	string	Provider of the accessory (e.g., "Carrier")
accessorials[].stop_id	stop_id	string/null	Stop ID (nullable)
accessorials[].id	id	string	Unique identifier of the accessory in the load
content	content	string	Message indicating the need for re-quote
delete	delete	boolean	Indicates if the quotation associated with the load has been removed (true/false)

{
  "accessorials": [
    {
      "name": "Airport Delivery",
      "load_id": "a0jRt00000Bw3e8IAB",
      "accessorial_id": "a011I00000325IdQAI",
      "provider": "Carrier",
      "stop_id": null,
      "id": "a0hRt00000DYMJcIAP"
    },
    {
      "name": "Hazardous Material Handling",
      "load_id": "a0jRt00000Bw3e8IAB",
      "accessorial_id": "a011I00000325ItQAI",
      "provider": "Carrier",
      "stop_id": null,
      "id": "a0hRt00000DYt6WIAT"
    }
  ],
  "content": "due to the update of the accesorials the quotation associated with the load has been removed,please make a re-quote.",
  "delete": true
}

---

8. Delete Accessory from Load

Endpoint

DELETE /api/v1/drayage/accessorials/load/{load_id}

Description

This endpoint deletes accessories from a drayage load.

Parameters

Name	Type	Required	Description
load_id	string (15-18 characters)	Yes	Load ID.

Body

Name	Type	Description
accessorial_ids	list[string]	Enter the IDs of the accessories in Revenova for drayage, in string format. These IDs are obtained from the drayage/accessorials endpoint.

Responses

200 - Success

| Path | Field Name | Type | Description | | content | content | string | Message indicating the need for re-quote | | delete | delete | boolean | Indicates if the quotation associated with the load has been removed (true/false) |

{
  "content": "due to the remove of the accesorials the quotation associated with the load has been removed, please make a re-quote.",
  "delete": true
}

9. Update Line Item by Load ID

Endpoint

PATCH /api/v1/drayage/line-items/load/{load_id}

Description

This endpoint updates a line item associated with a specific load ID. You can update the weight or description of the line item.

Parameters

Parameter	Type	Required	Description
load_id	string	Yes	The ID of the load (must be between 15-18 characters).
weight	float	No	The updated weight of the line item.
description	string	No	A new description for the line item.

Responses

200 - Success

Path	Field Name	Type	Description
line_item	line_item	object	Updated line item details
line_item.id	id	string	Unique identifier of the line item
line_item.description	description	string	Updated description of the line item
line_item.weight	weight	number	Updated weight of the line item
line_item.weight_units	weight_units	string	Unit of measurement (e.g., "lb")
content	content	string	Message indicating the need for re-quote
delete	delete	boolean	Indicates if the quotation associated with the load has been removed (true/false)

{
  "line_item": {
    "id": "a0gRt00000559W2IAI",
    "description": "Updated description",
    "weight": 300,
    "weight_units": "lb"
  },
  "content": "due to the update of the line items the quotation associated with the load has been removed, please make a re-quote.",
  "delete": true
}

---

10. Update Stop Delivery by Load ID

Endpoint

PATCH /api/v1/drayage/stop/delivery

Description

This endpoint updates a stop delivery associated with a specific load ID.

Parameters

Name	Type	Required	Description
load_id	string	Yes	The ID of the load.

Body

Name	Type	Required	Description
location_id	string	No	Unique identifier for the location.
contact_info_id	string	No	Unique identifier for the associated contact information.
country	string	No	Name of the country where the location is situated.
city	string	No	City name of the location.
state_province	string	No	State or province of the location.
postal_code	string	No	Postal or ZIP code of the location.

Responses

200 - Success

Path	Field Name	Type	Description
content	content	string	Message indicating the need for re-quote
delete	delete	boolean	Indicates if the quotation associated with the load has been removed (true/false)

{
  "content": "due to the update of stop pickup the quotation associated with the load has been removed, please make a re-quote.",
  "delete": true
}

---

11. Tender Load

Endpoint

POST /api/v1/drayage/tender

Description

This endpoint is used to tender a drayage load successfully.

Body

Path	Field Name	Type	Description
load_id	load_id	string	Load ID.
insurance	insurance	bool	Indicates whether the load requires insurance (default is False).
from_address	from_address	object	Address details of the origin stop, represented by StopDrayageTender.
from_address.street	street	string	The street address of the stop location.
from_address.contact_first_name	contact_first_name	string	The first name of the contact person at the stop location.
from_address.contact_last_name	contact_last_name	string	The last name of the contact person at the stop location.
from_address.contact_phone	contact_phone	string	The phone number of the contact person at the stop location.
from_address.contact_email	contact_email	string	The email address of the contact person at the stop location.
from_address.references	references	string	Optional field for additional reference details related to the stop.
from_address.instructions	instructions	string	Optional field for specific instructions regarding the stop.
from_address.location_name	location_name	string	The name of the stop location.
billing_reference	billing_reference	string	Optional field for a billing reference associated with the tender.
po_number	po_number	string	Optional field for the purchase order number related to the tender.

Responses

200 - Success

Path	Field Name	Type	Description
load_id	load_id	string	Unique identifier of the load
carrier_id	carrier_id	string	Unique identifier of the carrier
bol	bol	string	Bill of Lading number
shipping_labels	shipping_labels	string	Shipping labels information
pickup_number	pickup_number	string	Pickup number
scac	scac	string/null	Standard Carrier Alpha Code (nullable)
quote_number	quote_number	string/null	Quote number (nullable)
message	message	string	Message regarding the tendering process
billing_information	billing_information	object	Billing information details
billing_information.carrier_billing_state	carrier_billing_state	string
billing_information.carrier_billing_zip_code	carrier_billing_zip_code	string	Zip code of the carrier's billing address
billing_information.carrier_billing_name	carrier_billing_name	string	Name of the carrier for billing purposes
billing_information.carrier_billing_country	carrier_billing_country	string
billing_information.carrier_billing_city		carrier_billing_city	string
billing_information.carrier_billing_address	carrier_billing_address	string	Address of the carrier's billing location

{
  "load_id": "a0jRt00000BwE05IAF",
  "carrier_id": "68dab438cdf64c4f64c4ce9c",
  "bol": "",
  "shipping_labels": "",
  "pickup_number": "",
  "scac": null,
  "quote_number": null,
  "message": "GLT is actively looking for a drayage carrier. Bill of Lading and Labels will be available once we confirm the carrier.",
  "billing_information": {
    "carrier_billing_state": "Florida",
    "carrier_billing_zip_code": "33166",
    "carrier_billing_name": "GLT",
    "carrier_billing_country": "United States",
    "carrier_billing_city": "Miami Springs",
    "carrier_billing_address": "10 Canal Street # 318"
  }
}

12. Clone Rate by Load ID

Endpoint

POST /api/v1/drayage/clone/{load_id}

Description

This endpoint clones a rate for a specific load ID.

Parameters

Name	Type	Required	Description
load_id	string	Yes	The ID of the load to be cloned.

Responses

200 - Success

Path	Field Name	Type	Description
load_id	load_id	string	Unique identifier of the load
shp	shp	string	Unique identifier of the load
line_item	line_item	object	Info of item in the load
line_item.id	id	string	Unique identifier of the line item
line_item.description	description	string	Brief description of the item's content
line_item.weight	weight	number	Weight, must be greater than zero
line_item.weight_units	weight_units	string	Unit of measurement (e.g., "lb")
stops	stops	object	Stops information
stops.from	from	object	Origin of the load
stops.from.id	id	string	Unique identifier of the stop
stops.from.city	city	string	City of origin
stops.from.state_province	state_province	string	State of origin
stops.from.country	country	string	Country of origin
stops.from.postal_code	postal_code	string	Postal code of origin
stops.from.name	name	string	Name of the stop
stops.from.location_id	location_id	string/null	Location ID (nullable)
stops.from.contact_info_id	contact_info_id	string/null	Contact info ID (nullable)
stops.from.is_dropoff	is_dropoff	boolean	Is dropoff location
stops.from.is_pickup	is_pickup	boolean	Is pickup location
stops.from.number	number	integer	Stop number
stops.to	to	object	Destination of the load
stops.to.id	id	string	Unique identifier of the stop
stops.to.city	city	string	City of destination
stops.to.state_province	state_province	string	State of destination
stops.to.country	country	string	Country of destination
stops.to.postal_code	postal_code	string	Postal code of destination
stops.to.name	name	string	Name of the stop
stops.to.location_id	location_id	string	Location ID
stops.to.contact_info_id	contact_info_id	string	Contact info ID
stops.to.is_dropoff	is_dropoff	boolean	Is dropoff location
stops.to.is_pickup	is_pickup	boolean	Is pickup location
stops.to.number	number	integer	Stop number
stops.to.first_name	first_name	string	First name of the contact
stops.to.last_name	last_name	string	Last name of the contact
stops.to.email	email	string	Email of the contact
stops.to.phone	phone	string	Phone number of the contact
accessorials	accessorials	List[object]	List of accessories in the load
accessorials[].accessorial_id	accessorial_id	string	Identifier for the accessory
accessorials[].accessorial_name	accessorial_name	string	Name of the accessory
carrier	carrier	object	Carrier details and rate information
carrier._id	_id	string	Unique identifier of the drayage rate in DB
carrier.source	source	string	Source of the drayage rate
carrier.carrier	carrier	string	Name of the carrier
carrier.expirationDate	expirationDate	string (date)	Expiration date for the drayage rate
carrier.drayageAccessorials	drayageAccessorials	List[object]	List of cost of accessories
carrier.drayageAccessorials[].value	value	number	Value of the accessory
carrier.drayageAccessorials[].description	description	string	Description of the accessory
carrier.drayageAccessorials[].unit	unit	string	Unit of the accessory
carrier.fuelSurcharge	fuelSurcharge	number	Price of fuel surcharge
carrier.price	price	number	Price of carrier
carrier.serviceClass	serviceClass	string	Service class
carrier.pickupPerformance	pickupPerformance	number	Performance metric for on-time pickups
carrier.deliveryPerformance	deliveryPerformance	number	Performance metric for on-time deliveries
carrier.chsDailyRental	chsDailyRental	number	Daily rental cost for chassis
carrier.chsMinRentalDays	chsMinRentalDays	number	Minimum number of days for chassis rental
carrier.chsPickup	chsPickup	number	Cost associated with chassis pickup
carrier.chsReturn	chsReturn	number	Cost associated with chassis return
carrier.chsPickupFsc	chsPickupFsc	number	Fuel surcharge cost for chassis pickup
carrier.chsReturnFsc	chsReturnFsc	number	Fuel surcharge cost for chassis return
carrier.chsSubtotal	chsSubtotal	number	Subtotal cost of chassis-related fees
carrier.totalChsRental	totalChsRental	number	Total rental cost for chassis
carrier.terminalSurcharge	terminalSurcharge	number	Additional surcharge applied at the terminal
carrier.fsc	fsc	string/number	Fuel surcharge percent applied
carrier.lineHaul	lineHaul	number	Base transportation cost for moving freight
carrier.toll	toll	number	Toll fees incurred during transportation
carrier.layover	layover	number	Cost incurred when a driver must wait
carrier.overweight	overweight	number	Additional charge for overweight shipments
carrier.hazardous	hazardous	number	Extra fee for transporting hazardous materials
carrier.reefer	reefer	number	Surcharge for temperature-controlled loads
carrier.prepull	prepull	number	fee for pulling the container from the terminal prior day of the delivery
carrier.type	type	string	Category or type of drayage rate
carrier.portalNotes	portalNotes	string	Additional notes or comments from the portal
carrier.size	size	string/number	Container size (e.g., 20, 40, 45)
carrier.terminal	terminal	string	Unique identifier of the terminal
alerts	alerts	List[string]	List of alerts related to the rate

{
    "load_id": "a0jRu000009vLk5IAt",
    "shp": "SHP4933713",
    "line_item": {
        "description": "test",
        "weight": 100,
        "weight_units": "lb",
        "id": "a0gRu000002csr3IAA"
    },
    "stops": {
        "from": {
        "name": "Pickup",
        "location_id": None,
        "contact_info_id": None,
        "is_dropoff": False,
        "is_pickup": True,
        "number": 0,
        "state_province": "FL",
        "postal_code": "33206",
        "country": "US",
        "city": "miami",
        "id": "a0tRu00000EW4N1IAL"
        },
        "to": {
        "name": "Delivery",
        "location_id": "001Ru00000QsmjrIAF",
        "contact_info_id": "003Ru00000NFeRPIA4",
        "is_dropoff": True,
        "is_pickup": False,
        "number": 1,
        "state_province": "FL",
        "postal_code": "33132",
        "country": "US",
        "city": "Miami",
        "id": "a0tRu00000EW4N2fAL",
        "first_name": "Jhon",
        "last_name": "Doe",
        "email": "Jhon.Doe@test.com.co",
        "phone": "1234567890"
        }
    },
    "accessorials": [
        {
        "accessorial_id": "a011I000008yNDMQA2",
        "accessorial_name": "Chassis"
        },
        {
        "accessorial_id": "a011I00000Ue3p4QAB",
        "accessorial_name": "Reefer"
        }
    ],
    "carrier": {
        "_id": "67b379b92ab1d5ffc82618b4",
        "source": "Drayage",
        "carrier": "drayage carrier",
        "expirationDate": "2025-03-19",
        "drayageAccessorials": [
        {
            "value": 150,
            "description": "Detention",
            "unit": "Per Hour"
        },
        {
            "value": 200,
            "description": "Hazardous",
            "unit": "Flat Rate"
        },
        {
            "value": 150,
            "description": "Overweight",
            "unit": "Flat Rate"
        },
        {
            "value": 150,
            "description": "Reefer",
            "unit": "Flat Rate"
        }
        ],
        "fuelSurcharge": 109.32,
        "price": 811.67,
        "serviceClass": "drayage",
        "pickupPerformance": 97,
        "deliveryPerformance": 97,
        "chsDailyRental": 40,
        "chsMinRentalDays": 1,
        "chsPickup": 0,
        "chsReturn": 0,
        "chsPickupFsc": 0,
        "chsReturnFsc": 0,
        "chsSubtotal": 40,
        "totalChsRental": 40,
        "terminalSurcharge": 0,
        "fsc": "35.00%",
        "lineHaul": 312.35,
        "toll": 0,
        "layover": 0,
        "overweight": 0,
        "hazardous": 200,
        "reefer": 150,
        "prepull": 0,
        "type": "import",
        "portalNotes": "test notes",
        "size": "20",
        "terminal": "USMIAPTSFCT"
        },
    "alerts": []
    } 

404 - Rate Not Found

{
  "message": "Rate not found"
}