API Reference

Create a load

post deprecated
https://ship.cars/api/shipperlite/posting/v3/integrators/loads

This API creates a new load together with all of its linked entities and posts it on the Load Board where it can be reviewed by different carriers.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Internal ID of the load

string
enum

NEW - (Used by Driveaway Loads), if the driveaway driver decides to decline the load,

the status changes to NEW


PENDING_POSTING - The load’s posting is in progress.


POSTED - The load is posted on the LoadBoard.


PENDING_CLAIM - The load has been dispatched to the carrier or a carrier offer has been accepted.

Upon successful dispatch, the status changes to CARRIER_PENDING.


CARRIER_PENDING - The load is dispatched (through negotiation or directly)

and a carrier is presented with the option to accept or decline it.


DISPATCHED - The load has been dispatched.


ASSIGNED - The load has been assigned to a driver by a carrier.


PICKED_UP - The load has been picked up.


DELIVERED - The load has been delivered.


PENDING_ARCHIVE - The load’s archiving is pending.


ARCHIVED - The load has been archived.

string

Booking Agent (creator) of the load

string

Custom identifying the number or name of the load. Generated in the response if not set on request

route
object
required

Basic details about the route the load is requested to travel.

shippingItems
array of objects
required

Basic details about the items (vehicles and attachments) contained withing the load. Some of them, such as year, make, model and vin, could be set entirely as custom inputs.

shippingItems*
payments
array of objects
required

Payment details concerning the load.

payments*
int64
required
0 to 1000000000

Total price for the load, in USD.

date-time

Creation timestamp

date-time

Modification timestamp

contract
object
required

Contact information about the shipper creating the load.

attachments
array of objects

Details and restrictions regarding any attachments included in the load.

attachments
pickupContact
object
required
deliveryContact
object
required
publicLinkInfo
object

Unique public URL used for tracking the load as it is transported from point A to point B.

string

External platform carrier ID

load
object
required

Load details

carrier
object

Contact information related to the carrier person/company.

contractPricing
object

Shows whether the carrier has contract pricing with all details

driver
object

Contact information related to the driver assigned to the load.

carrierOffers
array of objects

Information about the offer or offers (making up a negotiation) made by the carrier to the shipper regarding the final costs of transporting the load. Appears only after the load is created and a carrier offer for it was accepted.

carrierOffers
boolean
required
Defaults to true

true/false statement indicating whether signature will be required on pickup.

boolean
required
Defaults to true

true/false statement indicating whether signature will be required on delivery.

string

External ID of the rate engine calculation.

Responses

Updated 11 months ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago

Did this page help you?