Update your load

put

https://app.staging.transportexchangegroup.com/api/v2/load/{loadId}

Enables you to update booked loads. Loads in posted status cannot be updated.

Path Params

loadId

int64

required

load ID

Body Params

acceptanceRequired

boolean

attachmentInfo

array of objects

attachmentInfo

bodyType

string

enum

bookingFooter

string

bookingStatuses

array of objects

bookingStatuses

callbackRequired

boolean

collectBy

date-time

required

commodity

string

createdOn

string

currency

string

enum

Allowed:

customerAgreedRate

double

0 to 999999.99

customerContactId

int64

customerReference

string

length ≤ 30

deliverBy

date-time

required

deliverFrom

date-time

required

deliverTimeRange

string

enum

Allowed:

docInfo

array of objects

docInfo

draft

boolean

enrouteEmail1

string

enrouteEmail2

string

enrouteEmail3

string

eta

object

freightType

string

enum

required

frequencyForEnrouteEmail

int32

from

object

required

fromDisplayAddress

string

fromShortDisplayAddress

string

fromTimeZoneId

string

grossWeight

object

groupId

int64

hiab

boolean

invoiced

boolean

jobDescription

string

required

jobDisplayDescription

string

jobDisplayTypeShort

string

jobType

string

enum

Allowed:

liftgate

boolean

loadFieldsChanges

object

minVehicleSize

string

enum

required

enum specifying the smallest vehicle needed to transport a load

minVehicleSizeApiKey

string

moffetMounty

boolean

notes

string

length ≤ 1000

notificationRadius

int32

numberOfItems

int32

order

object

packaging

string

phoneNumber

string

length ≤ 30

pickupTime

string

pickupTimeRange

string

enum

Allowed:

podHardCopiesRequired

boolean

quotesEnabled

boolean

readyAt

date-time

required

sendEnrouteAccordingGeofence

boolean

sendEnrouteToMyEmailAddress

boolean

showCustomerReferenceToSubcontractor

boolean

showYourReferenceToSubcontractor

boolean

stops

array of objects

stops

tailLift

boolean

object

required

toShortDisplayAddress

string

toTimeZoneId

string

trackedDriverPreferred

boolean

trailer

boolean

twoMan

boolean

ulezCrossed

boolean

vehicleDisplayName

string

via

object

viaCollectBy

string

viaDisplayAddress

string

viaReadyAt

string

viaShortDisplayAddress

string

viaTime

string

viaTimeRange

string

viaTimeZone

object

viaTimeZoneId

string

volume

object

waitAndReturn

boolean

yourReference

string

length ≤ 30

Responses

200

201

Created

401

Not authorized

403

Forbidden

404

Not found

422

Unprocessable Entity

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here!