vinCARRIER

<back to all web services

AdvertiseToLoadboard

Requires Authentication
The following routes are available for this service:
POST/api/vind2/openapi/advertisetoloadboard
AdvertiseToLoadboard Parameters:
NameParameterData TypeRequiredDescription
JobIdsbodyList<int>No
LoadIdsbodyList<string>No
IsTruckLoadbodyboolNo
TripIdbodystringNo
LoadboardLookupIdbodystringNo
NewPricebodyint?No
ShowBuyNowPricebodyboolNo
AllowQuotesbodyboolNo
PaymentTypebodyint?No
AdditionalServiceFeebodydecimal?No
TaxInclusivebodyboolNo
DriverFuelInclusivebodybool?No
RequiresEnclosedTransportbodyboolNo
RequiresDeliveryHandoverbodyboolNo
RequiresLeasePaperworkbodyboolNo
RequiresMoDelbodyboolNo
RequiresTrackingbodyboolNo
RequiresEpodbodyboolNo
TruckloadTotalEstimatedMileagebodyint?No
PostToCentralDispatchbodyboolNo
ExpiryDatebodyDateTime?No
AdvertiseResult Parameters:
NameParameterData TypeRequiredDescription
CreatedRequestsformList<UpdateRequest>No
UpdatedJobsformList<Job>No
UpdateRequest Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
LoadBoardIdformint?No
FleetIdformintNo
UserIdformintNo
CustomerIdformint?No
CustomerformVinDispatchContactDetailsNo
InvoiceIdformint?No
ServiceTypeformintNo
RequestTypeformintNo
FullLoadBuyNowformdecimal?No
CommentsformstringNo
DateCreatedformDateTime?No
DateExpiresformDateTime?No
RequestStatusformintNo
PaymentTypeformint?No
AdditionalServiceFeeformdecimal?No
DriverFuelInclusiveformboolNo
TaxInclusiveformboolNo
ShowBuyNowPriceformboolNo
AllowQuotesformboolNo
AdvertiseTypeformintNo
ShipperUserApiKeyformstringNo
ShipperScacformstringNo
LoadIdformstringNo
TripIdformstringNo
OrderNumberformstringNo
ReferenceIdformstringNo
DateAdvertisedformDateTime?No
SubjectToContractFleetIdformint?No
RequiresEnclosedTransportformboolNo
RequiresDeliveryHandoverformboolNo
RequiresLeasePaperworkformboolNo
RequiresMoDelformboolNo
RequiresTrackingformboolNo
RequiresEpodformboolNo
IsArchivedformboolNo
ShipperPaysFeeformboolNo
VehicleRequestsformList<VinDispatchVehicleRequest>No
TruckloadTotalEstimatedMileageformint?No
SellPartialLoadformboolNo
BidUpStartPriceformdecimal?No
EnableBidUpformboolNo
AutoSellPriceformdecimal?No
ShipperSellPriceformdecimal?No
CarrierRateTypeformboolNo
ShipperMarginTypeformboolNo
TimeToMaxBuyNowformlong?No
VinDispatchContactDetails Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
MasterIdformint?No
QuickCodeformstringNo
ContactformstringNo
OrganisationNameformstringNo
AddressLinesformstringNo
CityformstringNo
LatitudeformdoubleNo
LongitudeformdoubleNo
EmailformstringNo
FaxformstringNo
PhoneformstringNo
MobilePhoneformstringNo
OtherPhoneformstringNo
NotesformstringNo
StateRegionformstringNo
ZipPostCodeformstringNo
CountryformstringNo
VinDispatchVehicleRequest Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
RequestIdformint?No
AllocatedCarrierIdformintNo
CdnJobIdformint?No
JobNumberformstringNo
MakeformstringNo
ModelformstringNo
VariantformstringNo
NumberOfVehiclesformintNo
CommentsformstringNo
DeliveryAddressIdformint?No
DeliveryAddressformVinDispatchContactDetailsNo
DeliveryDateformDateTime?No
DeliveryTypeformintNo
DeliveryTimeFrameformlongNo
InopformboolNo
PickupAddressIdformint?No
PickupAddressformVinDispatchContactDetailsNo
PickupDateformDateTime?No
PickupTypeformintNo
PickupTimeFrameformlongNo
EstimatedDistanceformintNo
EstimatedTravelTimeSecondsformintNo
VehiclesformList<VinDispatchVehicle>No
VinDispatchVehicle Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
VinformstringNo
RegistrationformstringNo
VehicleRequestIdformint?No
NotesformstringNo
Job Parameters:
NameParameterData TypeRequiredDescription
UniqueIdformstringYesThe Id or, when URL param &isloadid=1, LoadId of the target Job resource

To override the Content-type in your clients, use the HTTP Accept Header, append the .x-protobuf suffix or ?format=x-protobuf

HTTP + X-PROTOBUF

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /x-protobuf/reply/AdvertiseToLoadboard HTTP/1.1 
Host: vincarrier.cardeliverynetwork.com 
Content-Type: application/x-protobuf
Content-Length: length

{"jobIds":[0],"loadIds":["String"],"isTruckLoad":false,"tripId":"String","loadboardLookupId":"String","newPrice":0,"showBuyNowPrice":false,"allowQuotes":false,"paymentType":0,"additionalServiceFee":0,"taxInclusive":false,"driverFuelInclusive":false,"requiresEnclosedTransport":false,"requiresDeliveryHandover":false,"requiresLeasePaperwork":false,"requiresMoDel":false,"requiresTracking":false,"requiresEpod":false,"truckloadTotalEstimatedMileage":0,"postToCentralDispatch":false,"expiryDate":"\/Date(-62135596800000-0000)\/"}
HTTP/1.1 200 OK
Content-Type: application/x-protobuf
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":"\/Date(-62135596800000-0000)\/","dateExpires":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","loadId":"String","cdxExchangeId":0,"jobNumberSuffix":"String","requestReferenceId":"String","jobNumber":"String","nirNumber":"String","status":"Quote","statusDeviceTime":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","displayTime":"String","notSignedReason":"String","notSignedReasons":["String"]},"requestedDate":"\/Date(-62135596800000-0000)\/","scheduledDate":"\/Date(-62135596800000-0000)\/","gateOutCode":"String","eta":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","displayTime":"String","notSignedReason":"String","notSignedReasons":["String"]},"requestedDate":"\/Date(-62135596800000-0000)\/","scheduledDate":"\/Date(-62135596800000-0000)\/","gateOutCode":"String","eta":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","scheduledDate":"\/Date(-62135596800000-0000)\/","gateOutCode":"String","eta":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","status":"Quote","statusFriendly":"String","notes":"String","positionAtStatus":{"time":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","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}]}