Recipe 1 - Job Field Definitions
The following fields are valid when you POST a JOB
If you re-POST a job with the same loadId the server will assume it is an update. Only under certain conditions will fields be updated.
Updates cannot occur after the Picked up status is reached.
| Job | ||
| FIELD NAME | LENGTH | DEFAULT / OPTIONS |
| loadId Identifier for a load of vehicles going from A to B, must be unique as can be used to modify the original Job details (eg change vehicles, driver, carrier etc) |
40 | |
| tripId Identifies that the load belongs to a Truck trip |
20 | |
| serviceRequired Transported for delivery on a truck, driven for drieaway by a driver, |
Transported, Driven | |
| allocatedCarrierScac Carrier who will deliver the vehicle to the destination point |
10 | |
| shipperScac Owner of the shipment |
10 | |
| assignedDriverRemoteId Driver who has been assigned the load, the RemoteId is the Id used in the Allocated Carriers TMS system to uniquely identify their driver |
||
| contractedCarrierScac Carrier who hold the shipment contract with the Shipper |
10 | |
| AssignedTruckRemoteId Person, system or Identifier of who created the Job |
||
| mileage Person, system or Identifier of who created the Job |
||
| jobInitiator Person, system or Identifier of who created the Job |
||
| loadBoardLookupId The RemoteId of theDispatch board setup in vinCARRIER |
15 | |
| sellPrice Your price you sold the service to your customer in cents or pennies |
||
| buyPrice The price you are paying the contracted carrier in cents or pennies |
||
| advertiseType The way carriers can interact with the Job, make Bids(quote), take the Job at the listed price(Claim Now) or can do either (Both) |
0 - Quote 1 - Claim Now 2 - Both |
|
| paymentTerms Terms that shipper will pay |
0 - COD 1 - NET15 2 - NET30 3 - NET60 4 - NET90 |
|
| customerReference A reference number to your customers order |
50 | |
| notes Job notes that you would like your Carrier or driver to see |
300 | |
| dropoff Uses the Location entity to describe the Destination details |
Location | |
| pickup Uses the Location entity to describe the Origin details |
Location | |
| vehicles Uses the Vehicle entity to describe the vehicle details |
Vehicle | |
| tranship Special use case where a Vehicle is delivered by more than one truck to the final destaination |
Tranship |
| Location - pickup{}, dropoff{} | ||
| FIELD NAME | LENGTH | DEFAULT / OPTIONS |
| addressLines Combined address lines of location |
300 | |
| city City location is in |
100 | |
| contact Contact name at the location |
100 | |
| countryCode Contry Code of location |
2 | US / CA / MX, Iso 3166-1 alpha-2 |
| email List of emails "," separated |
300 | |
| locationCode Common location code used for aggregation of locations at a single site |
30 | |
| notes Location specific notes, may include driver instructions or facility requirements |
300 | |
| organizationName Name of the Organization located at the location |
100 | |
| phone Location phone number |
30 | |
| quickCode Quickcode specified by the Shipper for EDI or billing requirements often the ramp or dealer code |
30 | |
| stateRegion State the location is located in |
2 | |
| zipPostCode ZipCode or PostCode of the location |
10 | |
| requestedDate Date that the service is required for the pickup or drop off |
Date | 2019-08-09T07:22Z |
| requestedDateIsExact Indicates if service must be completed on the date specified |
true, false |
| Vehicle - vehicles{} | ||
| FIELD NAME | LENGTH | DEFAULT / OPTIONS |
| vin Vehicle Identification Number |
17 | |
| registration Year vehicle was registered in or Vehicle Registration plate(Uk) |
10 | |
| make OEM Make of the vehicle |
50 | |
| model Model of the vehicle |
50 | US / CA / MX, Iso 3166-1 alpha-2 |
| variant Variant of the model, engine, specs etc |
50 | |
| color Color of the vehicle |
25 | |
| weight Weight in lbs of the vehicle |
int32 | |
| location Location where the vehicle is parked at pickup |
50 | |
| notes Location phone number |
255 | |
| movementNumber Quickcode specified by the Shipper for EDI or billing requirements often the ramp or dealer code |
50 |