The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
createdRequests:
[
{
id: 0,
loadBoardId: 0,
fleetId: 0,
userId: 0,
customerId: 0,
customer:
{
id: 0,
masterId: 0,
quickCode: String,
contact: String,
organisationName: String,
addressLines: String,
city: String,
latitude: 0,
longitude: 0,
email: String,
fax: String,
phone: String,
mobilePhone: String,
otherPhone: String,
notes: String,
stateRegion: String,
zipPostCode: String,
country: String
},
invoiceId: 0,
serviceType: 0,
requestType: 0,
fullLoadBuyNow: 0,
comments: String,
dateCreated: 0001-01-01,
dateExpires: 0001-01-01,
requestStatus: 0,
paymentType: 0,
additionalServiceFee: 0,
driverFuelInclusive: False,
taxInclusive: False,
showBuyNowPrice: False,
allowQuotes: False,
advertiseType: 0,
shipperUserApiKey: String,
shipperScac: String,
loadId: String,
tripId: String,
orderNumber: String,
referenceId: String,
dateAdvertised: 0001-01-01,
subjectToContractFleetId: 0,
requiresEnclosedTransport: False,
requiresDeliveryHandover: False,
requiresLeasePaperwork: False,
requiresMoDel: False,
requiresTracking: False,
requiresEpod: False,
isArchived: False,
shipperPaysFee: False,
vehicleRequests:
[
{
id: 0,
requestId: 0,
allocatedCarrierId: 0,
cdnJobId: 0,
jobNumber: String,
model: String,
variant: String,
numberOfVehicles: 0,
comments: String,
deliveryAddressId: 0,
deliveryAddress:
{
id: 0,
masterId: 0,
quickCode: String,
contact: String,
organisationName: String,
addressLines: String,
city: String,
latitude: 0,
longitude: 0,
email: String,
fax: String,
phone: String,
mobilePhone: String,
otherPhone: String,
notes: String,
stateRegion: String,
zipPostCode: String,
country: String
},
deliveryDate: 0001-01-01,
deliveryType: 0,
deliveryTimeFrame: 0,
inop: False,
pickupAddressId: 0,
pickupAddress:
{
id: 0,
masterId: 0,
quickCode: String,
contact: String,
organisationName: String,
addressLines: String,
city: String,
latitude: 0,
longitude: 0,
email: String,
fax: String,
phone: String,
mobilePhone: String,
otherPhone: String,
notes: String,
stateRegion: String,
zipPostCode: String,
country: String
},
pickupDate: 0001-01-01,
pickupType: 0,
pickupTimeFrame: 0,
estimatedDistance: 0,
estimatedTravelTimeSeconds: 0,
vehicles:
[
{
id: 0,
vin: String,
registration: String,
vehicleRequestId: 0,
notes: String
}
],
make: String
}
],
truckloadTotalEstimatedMileage: 0,
sellPartialLoad: False,
bidUpStartPrice: 0,
enableBidUp: False,
autoSellPrice: 0,
shipperSellPrice: 0,
carrierRateType: False,
shipperMarginType: False,
timeToMaxBuyNow: 0
}
],
updatedJobs:
[
{
createdDate: 0001-01-01,
loadId: String,
cdxExchangeId: 0,
jobNumberSuffix: String,
requestReferenceId: String,
jobNumber: String,
nirNumber: String,
status: Quote,
statusDeviceTime: 0001-01-01,
tripId: String,
jobInitiator: String,
customerReference: String,
notes: String,
serviceRequired: Driven,
mileage: 0,
travelTimeMinutes: 0,
sellPrice: 0,
buyPrice: 0,
driverPay: 0,
paymentTerm: 0,
customer:
{
drivenRateCardId: 0,
transportedRateCardId: 0,
quickCode: String,
internalQuickCode: String,
locationCode: String,
contact: String,
gender: Male,
dateOfBirth: 0001-01-01,
organisationName: String,
organizationName: String,
addressLines: String,
city: String,
stateRegion: String,
zipPostCode: String,
latitude: 0,
longitude: 0,
bestGeoLookupString: String,
email: String,
fax: String,
phone: String,
mobilePhone: String,
otherPhone: String,
notes: String,
openingHours:
[
{
day: String,
open: String,
close: String,
allowAfterHours: False
}
],
countryCode: String,
importDisplayString: "String, String, String, String",
id: 0
},
pickup:
{
destination:
{
quickCode: String,
internalQuickCode: String,
locationCode: String,
contact: String,
gender: Male,
dateOfBirth: 0001-01-01,
organisationName: String,
organizationName: String,
addressLines: String,
city: String,
stateRegion: String,
zipPostCode: String,
latitude: 0,
longitude: 0,
bestGeoLookupString: String,
email: String,
fax: String,
phone: String,
mobilePhone: String,
otherPhone: String,
notes: String,
openingHours:
[
{
day: String,
open: String,
close: String,
allowAfterHours: False
}
],
countryCode: String,
importDisplayString: "String, String, String, String",
id: 0
},
signoff:
{
url: String,
signedBy: String,
comment: String,
time: 0001-01-01,
displayTime: String,
notSignedReason: String,
notSignedReasons:
[
String
]
},
requestedDate: 0001-01-01,
scheduledDate: 0001-01-01,
gateOutCode: String,
eta: 0001-01-01,
requestedDateIsExact: False,
proofDocUrl: String,
documents:
[
{
url: String,
type: Other,
title: String,
comment: String,
friendlyType: Other
}
],
sequenceNumber: 0
},
dropoff:
{
destination:
{
quickCode: String,
internalQuickCode: String,
locationCode: String,
contact: String,
gender: Male,
dateOfBirth: 0001-01-01,
organisationName: String,
organizationName: String,
addressLines: String,
city: String,
stateRegion: String,
zipPostCode: String,
latitude: 0,
longitude: 0,
bestGeoLookupString: String,
email: String,
fax: String,
phone: String,
mobilePhone: String,
otherPhone: String,
notes: String,
openingHours:
[
{
day: String,
open: String,
close: String,
allowAfterHours: False
}
],
countryCode: String,
importDisplayString: "String, String, String, String",
id: 0
},
signoff:
{
url: String,
signedBy: String,
comment: String,
time: 0001-01-01,
displayTime: String,
notSignedReason: String,
notSignedReasons:
[
String
]
},
requestedDate: 0001-01-01,
scheduledDate: 0001-01-01,
gateOutCode: String,
eta: 0001-01-01,
requestedDateIsExact: False,
proofDocUrl: String,
documents:
[
{
url: String,
type: Other,
title: String,
comment: String,
friendlyType: Other
}
],
sequenceNumber: 0
},
tranships:
[
{
destination:
{
quickCode: String,
internalQuickCode: String,
locationCode: String,
contact: String,
gender: Male,
dateOfBirth: 0001-01-01,
organisationName: String,
organizationName: String,
addressLines: String,
city: String,
stateRegion: String,
zipPostCode: String,
latitude: 0,
longitude: 0,
bestGeoLookupString: String,
email: String,
fax: String,
phone: String,
mobilePhone: String,
otherPhone: String,
notes: String,
openingHours:
[
{
day: String,
open: String,
close: String,
allowAfterHours: False
}
],
countryCode: String,
importDisplayString: "String, String, String, String",
id: 0
},
transhipNumber: 0,
requestedDate: 0001-01-01,
scheduledDate: 0001-01-01,
gateOutCode: String,
eta: 0001-01-01,
requestedDateIsExact: False,
proofDocUrl: String,
allocatedCarrierScac: String,
allocatedCarrierId: 0,
tripId: String,
assignedDriverRemoteId: String,
assignedTruckRemoteId: String
}
],
vehicles:
[
{
registration: String,
vin: String,
make: String,
model: String,
variant: String,
color: String,
weight: 0,
loadDirection: NotRecorded,
loadLevel: NotRecorded,
loadPosition: 0,
location: String,
movementNumber: String,
notes: String,
signedBy: String,
signoffComment: String,
signature: String,
damageClaimSignedBy: String,
damageClaimSignoffComment: String,
damageClaimSignature:
{
url: String,
type: Other,
title: String,
comment: String,
friendlyType: Other
},
damageClaimDate: 0001-01-01,
status: PrePickup,
nonCompletionReason: String,
prePickupDamage:
[
{
area:
{
code: String,
description: String
},
type:
{
code: String,
description: String
},
severity:
{
code: String,
description: String
},
description: String,
photoURL:
[
String
],
aiagCode: StringStringString,
id: 0
}
],
damageAtPickup:
[
{
area:
{
code: String,
description: String
},
type:
{
code: String,
description: String
},
severity:
{
code: String,
description: String
},
description: String,
photoURL:
[
String
],
aiagCode: StringStringString,
id: 0
}
],
damageAtDropoff:
[
{
area:
{
code: String,
description: String
},
type:
{
code: String,
description: String
},
severity:
{
code: String,
description: String
},
description: String,
photoURL:
[
String
],
aiagCode: StringStringString,
id: 0
}
],
damageClaims:
[
{
area:
{
code: String,
description: String
},
type:
{
code: String,
description: String
},
severity:
{
code: String,
description: String
},
description: String,
documents:
[
{
url: String,
type: Other,
title: String,
comment: String,
friendlyType: Other
}
],
id: 0
}
],
damageClaimExtras:
[
{
area:
{
code: String,
description: String
},
type:
{
code: String,
description: String
},
severity:
{
code: String,
description: String
},
description: String,
documents:
[
{
url: String,
type: Other,
title: String,
comment: String,
friendlyType: Other
}
],
id: 0
}
],
photos:
[
{
url: String,
type: Other,
title: String,
comment: String,
friendlyType: Other
}
],
dutyOfCare:
{
String: String
},
paperwork:
{
String: String
},
cdxShipmentId: 0,
senderTripId: String,
isPickedUp: False,
isDelivered: False,
id: 0
}
],
history:
[
{
changed: 0001-01-01,
status: Quote,
statusFriendly: String,
notes: String,
positionAtStatus:
{
time: 0001-01-01,
latitude: 0,
longitude: 0,
altitude: 0,
heading: 0,
speed: 0
}
}
],
documents:
[
{
url: String,
type: Other,
title: String,
comment: String,
friendlyType: Other
}
],
shipperScac: String,
shipperId: 0,
contractedCarrierScac: String,
contractedCarrierId: 0,
contractedCarrierDOTNumber: 0,
allocatedCarrierScac: String,
allocatedCarrierId: 0,
allocatedCarrierDOTNumber: 0,
assignedDriverRemoteId: String,
assignedDriverName: String,
assignedDriverId: 0,
lastJourneyId: 0,
assignedTruckRemoteId: String,
assignedAppId: String,
source: VinDeliverOffice,
funderCode: String,
referrerCode: String,
vehicleCount: 1,
vehiclesCollected: 0,
vehiclesDelivered: 0,
invoiceFleetId: 0,
isVinDispatchJob: False,
isArchived: False,
importDisplayString: "String:String",
loadboardLookupId: String,
advertiseType: Quote,
functionalityFlags: 0,
terminalContact:
{
quickCode: String,
internalQuickCode: String,
locationCode: String,
contact: String,
gender: Male,
dateOfBirth: 0001-01-01,
organisationName: String,
organizationName: String,
addressLines: String,
city: String,
stateRegion: String,
zipPostCode: String,
latitude: 0,
longitude: 0,
bestGeoLookupString: String,
email: String,
fax: String,
phone: String,
mobilePhone: String,
otherPhone: String,
notes: String,
openingHours:
[
{
day: String,
open: String,
close: String,
allowAfterHours: False
}
],
countryCode: String,
importDisplayString: "String, String, String, String",
id: 0
},
frequentDamage:
[
String
],
loadSequenceNumber: 0,
isRelay: False,
id: 0
}
]
}